L2BridgeZap
Methods
WETH_ADDRESS
Returns
_0
address payable
undefined
calculateSwap
Calculate amount of tokens you receive on swap
Parameters
token
contract IERC20
undefined
tokenIndexFrom
uint8
the token the user wants to sell
tokenIndexTo
uint8
the token the user wants to buy
dx
uint256
the amount of tokens the user wants to sell. If the token charges a fee on transfers, use the amount that gets transferred after the fee.
Returns
_0
uint256
amount of tokens the user will receive
deposit
wraps SynapseBridge redeem()
Parameters
to
address
address on other chain to redeem underlying assets to
chainId
uint256
which underlying chain to bridge assets onto
token
contract IERC20
ERC20 compatible token to deposit into the bridge
amount
uint256
Amount in native token decimals to transfer cross-chain pre-fees*
depositETH
Wraps SynapseBridge deposit() function to make it compatible w/ ETH -> WETH conversions
Parameters
to
address
address on other chain to bridge assets to
chainId
uint256
which chain to bridge assets onto
amount
uint256
Amount in native token decimals to transfer cross-chain pre-fees*
depositETHAndSwap
Wraps SynapseBridge depositAndSwap() function to make it compatible w/ ETH -> WETH conversions
Parameters
to
address
address on other chain to bridge assets to
chainId
uint256
which chain to bridge assets onto
amount
uint256
Amount in native token decimals to transfer cross-chain pre-fees
tokenIndexFrom
uint8
the token the user wants to swap from
tokenIndexTo
uint8
the token the user wants to swap to
minDy
uint256
the min amount the user would like to receive, or revert to only minting the SynERC20 token crosschain.
deadline
uint256
latest timestamp to accept this transaction*
redeem
wraps SynapseBridge redeem()
Parameters
to
address
address on other chain to redeem underlying assets to
chainId
uint256
which underlying chain to bridge assets onto
token
contract IERC20
ERC20 compatible token to deposit into the bridge
amount
uint256
Amount in native token decimals to transfer cross-chain pre-fees*
redeemAndRemove
Wraps redeemAndRemove on SynapseBridge Relays to nodes that (typically) a wrapped synAsset ERC20 token has been burned and the underlying needs to be redeeemed on the native chain. This function indicates to the nodes that they should attempt to redeem the LP token for the underlying assets (E.g "swap" out of the LP token)
Parameters
to
address
address on other chain to redeem underlying assets to
chainId
uint256
which underlying chain to bridge assets onto
token
contract IERC20
ERC20 compatible token to deposit into the bridge
amount
uint256
Amount of (typically) LP token to pass to the nodes to attempt to removeLiquidity() with to redeem for the underlying assets of the LP token
liqTokenIndex
uint8
Specifies which of the underlying LP assets the nodes should attempt to redeem for
liqMinAmount
uint256
Specifies the minimum amount of the underlying asset needed for the nodes to execute the redeem/swap
liqDeadline
uint256
Specificies the deadline that the nodes are allowed to try to redeem/swap the LP token*
redeemAndSwap
Wraps redeemAndSwap on SynapseBridge.sol Relays to nodes that (typically) a wrapped synAsset ERC20 token has been burned and the underlying needs to be redeeemed on the native chain. This function indicates to the nodes that they should attempt to redeem the LP token for the underlying assets (E.g "swap" out of the LP token)
Parameters
to
address
address on other chain to redeem underlying assets to
chainId
uint256
which underlying chain to bridge assets onto
token
contract IERC20
ERC20 compatible token to deposit into the bridge
amount
uint256
Amount in native token decimals to transfer cross-chain pre-fees
tokenIndexFrom
uint8
the token the user wants to swap from
tokenIndexTo
uint8
the token the user wants to swap to
minDy
uint256
the min amount the user would like to receive, or revert to only minting the SynERC20 token crosschain.
deadline
uint256
latest timestamp to accept this transaction*
redeemv2
Wraps SynapseBridge redeemv2() function
Parameters
to
bytes32
address on other chain to bridge assets to
chainId
uint256
which chain to bridge assets onto
token
contract IERC20
ERC20 compatible token to redeem into the bridge
amount
uint256
Amount in native token decimals to transfer cross-chain pre-fees*
swapAndRedeem
Parameters
to
address
undefined
chainId
uint256
undefined
token
contract IERC20
undefined
tokenIndexFrom
uint8
undefined
tokenIndexTo
uint8
undefined
dx
uint256
undefined
minDy
uint256
undefined
deadline
uint256
undefined
swapAndRedeemAndRemove
Parameters
to
address
undefined
chainId
uint256
undefined
token
contract IERC20
undefined
tokenIndexFrom
uint8
undefined
tokenIndexTo
uint8
undefined
dx
uint256
undefined
minDy
uint256
undefined
deadline
uint256
undefined
liqTokenIndex
uint8
undefined
liqMinAmount
uint256
undefined
liqDeadline
uint256
undefined
swapAndRedeemAndSwap
Parameters
to
address
undefined
chainId
uint256
undefined
token
contract IERC20
undefined
tokenIndexFrom
uint8
undefined
tokenIndexTo
uint8
undefined
dx
uint256
undefined
minDy
uint256
undefined
deadline
uint256
undefined
swapTokenIndexFrom
uint8
undefined
swapTokenIndexTo
uint8
undefined
swapMinDy
uint256
undefined
swapDeadline
uint256
undefined
swapETHAndRedeem
Parameters
to
address
undefined
chainId
uint256
undefined
token
contract IERC20
undefined
tokenIndexFrom
uint8
undefined
tokenIndexTo
uint8
undefined
dx
uint256
undefined
minDy
uint256
undefined
deadline
uint256
undefined
swapETHAndRedeemAndSwap
Parameters
to
address
undefined
chainId
uint256
undefined
token
contract IERC20
undefined
tokenIndexFrom
uint8
undefined
tokenIndexTo
uint8
undefined
dx
uint256
undefined
minDy
uint256
undefined
deadline
uint256
undefined
swapTokenIndexFrom
uint8
undefined
swapTokenIndexTo
uint8
undefined
swapMinDy
uint256
undefined
swapDeadline
uint256
undefined
swapMap
Parameters
_0
address
undefined
Returns
_0
address
undefined
swapTokensMap
Parameters
_0
address
undefined
_1
uint256
undefined
Returns
_0
contract IERC20
undefined
Last updated