PayloadHelper
Introduction
PayloadHelper
facilitates the decoding of various types of payload data Superform sends between chains. This helper is not called in Superform core contracts, and doesn't serve a purpose in the protocol, but it enriches data hosted in Subgraphs and verifies off-chain processing by Keepers. Third party integrators can use PayloadHelper to extract and understanding payload information.
Core Concepts
There are 3 kinds of payloads associated with Superform at the moment:
CoreStateRegistryPayload
: payloads that originated from the chain's CoreStateRegistryStateSyncerPayload
: payloads associated with the transaction history on any SuperformRouter implementationTimeLockPayload:
payloads that originated from the chain's TimelockStateRegistry. Timelock payloads which have either failed or have yet to be processed
CoreStateRegistryPayloads
decodeCoreStateRegistryPayload
This function decodes payloads that arrived to the source chain's CoreStateRegistry.
decodeCoreStateRegistryPayloadLiqData
This function decodes the associated Liquidity Request associated with any given payload that arrived to the chain's CoreStateRegistry.
StateSyncerPayloads
decodePayloadHistory
Decodes basic transaction information for transactions that left SuperformRouter.
TimeLockPayloads
decodeTimeLockPayload
This function decodes payloads where the timelock was successfully sent from source to destination.
decodeTimeLockFailedPayload
This function decodes payloads where the timelock failed and was messaged back to the source chain.
Last updated