DataTransferFacet

This is a Solidity contract implementing the IDataTransfer interface. It contains several functions related to updating settings and receiving data transfers.

updateLayerZeroSettings

allows the contract owner to update the LayerZeroSettings struct, which contains settings for Layer 0 networks.

Input

Field	Type	Description
layerZeroSettings	LayerZeroSettings	struct LayerZeroSettings { address routerAddress; }

addLayerZeroChainIds

allow the contract owner to add LayerZero chain IDs.

Input

Field	Type	Description
networkIds	uint16[]	An array of network identifier for each blockchain. These are defined by the magpie team.
chainIds	uint16[]	An array of blockchain identifiers

addLayerZeroNetworkIds

allows the contract owner to add LayerZero network IDs.

Input

Field	Type	Description
chainIds	uint16[]	An array of blockchain identifiers
networkIds	uint16[]	An array of network identifier for each blockchain. These are defined by the layerzero team.

updateWormholeSettings

allows the contract owner to update the WormholeSettings struct, which contains settings for the Wormhole bridge.

Input

Field	Type	Description
wormholeSettings	WormholeSettings	struct WormholeSettings { address bridgeAddress; uint8 consistencyLevel; }

addWormholeNetworkIds

allows the contract owner to add mappings between Wormhole chain IDs and network IDs.

Input

Field	Type	Description
chainIds	uint16[]	An array of blockchain identifiers
networkIds	uint16[]	An array of network identifier for each blockchain. These are defined by the wormhole team.

getWormholeCoreSequence

this function provides a way to obtain the core sequence from a transfer key's core sequence by calling the getCoreSequence function from the LibWormhole library. It allows external callers to retrieve the core sequence without modifying the contract's state.

Input

Field	Type	Description
transferKeyCoreSequence	uint64	The sequence provide by magpie team for the data transfer

lzReceive

called by LayerZero to initiate a data transfer. It enforces that the function is called by a LayerZero contract and then calls the lzReceive function in the LibLayerZero library, which handles the actual data transfer.

Input

Field	Type	Description
senderChainId	uint16	The chain id of the source chain
localAndRemoteAddresses	bytes	The address which will receive the data
nonce	uint64	random or pseudo-random number that is used only once.
extendedPayload	bytes	Payload + extra information like which data transfer type has been used

dataTransferIn():

It calls the dataTransfer function from the LibDataTransfer library, passing the dataTransferInArgs as an argument.

Input:

Field	Type	Description
dataTransferInArgs	DataTransferInArgs	struct DataTransferInArgs { DataTransferInProtocol protocol; TransferKey transferKey; bytes payload; }

dataTransferOut():

It calls the getPayload function from the LibDataTransfer library, passing the dataTransferOutArgs as an argument.

Input:

Field	Type	Description
dataTransferOutArgs	DataTransferOutArgs	struct DataTransferOutArgs { DataTransferType dataTransferType; bytes payload; }