LibAggregator
The purpose of this library is to provide the core functionality for aggregating swap transactions and managing related operations within the Aggregator contract. The library has three structs.
SwapInArgs
swapArgs
bytes memory
bridgeArgs
BridgeArgs
struct BridgeArgs {
BridgeType bridgeType;
bytes payload;
}
dataTransferInProtocol
DataTransferInProtocol
struct DataTransferInProtocol {
uint16 networkId;
DataTransferType dataTransferType;
bytes payload;
}
transactionValidation
TransactionValidation
struct TransactionValidation {
bytes32 fromAssetAddress;
bytes32 toAssetAddress;
bytes32 toAddress;
uint256 amountOutMin;
uint256 swapOutGasFee;
}
SwapOutArgs
swapArgs
bytes memory
bridgeArgs
BridgeArgs
struct BridgeArgs {
BridgeType bridgeType;
bytes payload;
}
dataTransferOutArgs
DataTransferOutArgs
struct DataTransferOutArgs {
DataTransferType dataTransferType;
bytes payload;
}
SwapOutVariables
fromAssetAddress
address
The address of the asset being swapped out.
toAssetAddress
address
The address of the asset to which the swap is being performed.
toAddress
address
The address to which the swapped asset will be transferred.
transactionToAddress
address
The address to which any transaction fee associated with the swap will be sent.
bridgeAmount
uint256
The amount of the asset being swapped out.
amountIn
uint256
The amount of the asset being swapped out.
updateWeth()
The purpose of this function is to allow the contract owner to update the address of the WETH token used in the aggregator contract.
Input
weth
address
Address of the Wrapped Ether (WETH) contract.
updateMagpieRouterAddress()
This function is responsible for updating the magpieRouterAddress
variable within the contract's storage, allowing changes to be made to the address associated with the Magpie Router. Only contract owner can call this function.
Input
magpieRouterAddress
address
The address of the magpie router.
updateNetworkId()
The purpose of this function is to allow the contract owner to update the network ID used in the aggregator contract. Only contract owner can call this function.
Input
networkId
uint16
The network ID associated with the application.
addMagpieAggregatorAddresses()
The purpose of this function is to allow the contract owner to add Magpie aggregator addresses for multiple network IDs in the aggregator contract.
Input
networkIds
uint16[]
The network ID associated with the application.
magpieAggregatorAddresses
bytes32[]
The Magpie Diamond contract addresses for each of the networkIDs
swapIn()
This function allows for swapping assets into the contract using a bridge-in transaction. It facilitates interoperability between different networks and allows users to transfer assets from one network to another through the contract.
Input
swapInArgs
SwapInArgs
struct SwapInArgs {
SwapArgs swapArgs;
BridgeArgs bridgeArgs;
DataTransferInProtocol dataTransferInProtocol;
TransactionValidation transactionValidation;
}
Output
amountOut
uint256
The amount received after swapping
swapOut()
This function allows for swapping out assets from the contract using a bridge-out transaction. It facilitates interoperability between different networks and allows users to transfer assets from the contract to another network through the bridge-out mechanism.
Input
swapOutArgs
SwapOutArgs
struct SwapOutArgs {
SwapArgs swapArgs;
BridgeArgs bridgeArgs;
DataTransferOutArgs dataTransferOutArgs;
}
Output
amountOut
uint256
The amount received after swapping
getDeposit()
The purpose of this function is to allow external callers to retrieve the deposit amount for a specific asset in the aggregator contract.
Input
assetAddress
address
Address of the asset that will be deposited
Output
s.deposits[assetAddress]
uint256
The deposited amount
withdraw()
This function provides a way for users to withdraw their deposited assets from the contract, ensuring that only the rightful owner can withdraw their funds.
Input
assetAddress
address
The asset that will be withdrawn
getDepositByUser()
The purpose of this function is to allow external callers to retrieve the deposit amount for a specific asset deposited by a specific user in the aggregator contract.
Input
assetAddress
address
Address of the asset that will be deposited
senderAddress
address
Address of the user who has deposited the asset
Output
s.depositsByUser[assetAddress][senderAddress]
uint256
Deposited amount
isTransferKeyUsed()
The purpose of this function is to allow external callers to check if a specific transfer key has been used in the aggregator contract.
Input
networkId
uint16
networkId of the current chain in Magpie protocol, it is different from the actual networkId ethereum: 1 polygon: 2 bsc: 3 avalanche: 4 arbitrum: 5 optimism: 6
senderAddress
bytes32
The address who initiated the transfer.
coreSequence
uint64
The magpie sequence for the current swap.
Output
s.usedTransferKeys[networkId][senderAddress][swapSequence]
bool
Flag used to identify if the transfer key has been used for swapping or not.
bridgeIn():
This function is responsible for executing a delegatecall to a specific facet in the Diamond contract, passing the bridgeInArgs
data as the input. The specific functionality and behavior of the called facet would depend on the implementation details defined in the facet contract associated with the given selector.
Input:
bridgeInArgs
BridgeInArgs
struct BridgeInArgs {
uint16 recipientNetworkId;
BridgeArgs bridgeArgs;
uint256 amount;
address toAssetAddress;
TransferKey transferKey;
}
bridgeOut():
his function is responsible for executing a delegatecall to a specific facet in the Diamond contract, passing the bridgeOutArgs
data as the input. The specific functionality and behavior of the called facet would depend on the implementation details defined in the facet contract associated with the given selector. The function expects the delegatecall to return a single uint256
value, which is then returned by the function itself.
Input:
bridgeOutArgs
BridgeOutArgs
struct BridgeOutArgs {
BridgeArgs bridgeArgs;
Transaction transaction;
TransferKey transferKey;
}
dataTransferIn():
This function is responsible for executing a delegatecall to a specific facet in the Diamond contract, passing the dataTransferInArgs
data as the input. The specific functionality and behavior of the called facet would depend on the implementation details defined in the facet contract associated with the given selector.
Input:
dataTransferInArgs
DataTransferInArgs
struct DataTransferInArgs {
DataTransferInProtocol protocol;
TransferKey transferKey;
bytes payload;
}
dataTransferOut():
Input:
dataTransferOutArgs
DataTransferOutArgs
struct DataTransferOutArgs {
DataTransferType dataTransferType;
bytes payload;
}
Output:
transferKey
TransferKey
struct TransferKey {
uint16 networkId;
bytes32 senderAddress;
uint64 swapSequence;
}
payload
bytes
A string of bytes that contains transactional data.
Events:
event UpdateWeth(address indexed sender, address weth);
event UpdateMagpieRouterAddress(address indexed sender, address weth);
event UpdateNetworkId(address indexed sender, uint16 networkId);
event AddMagpieAggregatorAddresses(
address indexed sender,
uint16[] networkIds,
bytes32[] magpieAggregatorAddresses
);
event SwapIn(
address indexed fromAddress,
bytes32 indexed toAddress,
address fromAssetAddress,
address toAssetAddress,
uint256 amountIn,
uint256 amountOut,
TransferKey transferKey,
Transaction transaction
);
event SwapOut(
address indexed fromAddress,
address indexed toAddress,
address fromAssetAddress,
address toAssetAddress,
uint256 amountIn,
uint256 amountOut,
TransferKey transferKey,
Transaction transaction
);
event Withdraw(address indexed sender, address indexed assetAddress, uint256 amount);
Last updated