LibStargate
Last updated
Last updated
This library is implementing a bridge for cross-chain communication using the Stargate protocol.
The code defines three structs:
contains the chain ID of the recipient on the other chain, the IDs of the source and destination pools, and the amount of fees to be paid.
Field | Type | Description |
---|---|---|
contains the address of the sender's bridge contract, a nonce, and the ID of the sender's chain.
this struct is used to encapsulate the necessary input arguments for executing a bridge operation in the context of a Stargate bridge system. The fields hold relevant information such as network ID, token details, router address, recipient address, and additional bridge-specific data
LibStargate has the below functions:
updates the stargateSettings struct in the contract's AppStorage struct.
Input
decodes the bridgeOutPayload and returns the StargateBridgeOutData.
Input
Output
decodes the bridgeInPayload and returns the StargateBridgeInData.
Input
Output
returns the minimum amount of tokens that can be bridged.
Input
Output
this function is responsible for converting a bytes32
Ethereum address into a 20-byte bytes
representation, suitable for further processing or storage within the contract.
Input
Output
this function is responsible for creating and returning a layerZero transaction object (lzTxObj
) based on the provided sender address.
Input
Output
this function facilitates the bridging of tokens from the caller's network to a recipient network. It sets the necessary parameters, including the recipient address, bridge input data, lazy transaction object, token sequence, amount, network ID, and router address, and then calls the executeBridgeIn
function to execute the bridge operation.
Input
Output
this function is responsible for executing the bridge-in operation by calling the swap
function of the StargateRouter contract with the necessary arguments. It handles the transaction fee, source and destination pool IDs, sender address, amount, minimum acceptable amount, lazy transaction object, recipient address, and payload.
Input
this function is responsible for executing the bridge out operation. It decodes the payload, retrieves the sender address, and calls the withdraw
function of the IMagpieStargateBridge
contract to withdraw tokens based on the provided arguments. The deposited amount for the fromAssetAddress
is reduced accordingly.
Input
Output
It updates the Magpie Stargate bridge addresses for specific network IDs within the application storage.
Input
It updates the Magpie Stargate bridge addresses for specific network IDs within the application storage.
Input
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
This field is an unsigned 16-bit integer that represents the chain ID of the recipient on Layer 0. Layer 0 typically refers to the root blockchain or the main chain.
This field is a uint256
value that represents the ID or identifier of the source pool. The exact meaning and context of the pool ID may depend on the specific implementation or protocol using this struct.
This field is a uint256
value that represents the ID or identifier of the destination pool. Similarly to the source pool ID, the meaning and context of the destination pool ID depend on the specific implementation or protocol.
This field is a uint256
value that represents the fee associated with the bridge operation.
The amount of gas fees one needs to execute the transaction.
This field is of type bytes
and represents the source address.
This field is of type uint256
and represents a nonce value. Nonce is commonly used as a security measure to prevent replay attacks or ensure transaction ordering.
This field is of type uint16
and represents the source chain ID. It identifies the chain from which the bridge-out operation originates.
This field is of type address
and represents the address of the router
This field is of type uint256
and represents the amount being bridged in. It specifies the quantity of tokens or assets involved in the bridge-in operation.
This field is of type bytes
and represents the recipient address. The encoding and interpretation of the recipient address may depend on the specific requirements or format of the bridge system or protocol.
Payload consisting of data necessary for bridging out
Payload consisting of data necessary for bridging in.
The amount that needs to be swapped
The minimum amount out
The recipient address in bytes32
The receipient address in bytes
The address that initiated the transaction.
The network identifier of the destination chain
The amount that needs to be swapped
The final token that needs to be received
The sequence received after a successful bridging in
Payload consisting of data necessary for briding out.
The amount received after bridging out.
An array of unsigned 16-bit integers (uint16
) representing network identifiers.
An array of bytes32
values representing Magpie Stargate Bridge addresses.
An array of unsigned 16-bit integers (uint16
) representing network identifiers.
An array of bytes32
values representing Magpie Stargate Bridge addresses.