Bridge()
function bridge(uint256 amount) external payable override nonReentrant returns (uint256) {
This function allows anyone to trigger a bridge transaction where the consolidated fees (typically in the finalTargetToken
format) will be sent to the Ethereum blockchain.
Function Arguments
amount
uint256
This value represents the amount of tokens to bridge over from the contract on the selected chain to Ethereum
bridge
uint256
This value represents the bridge fee in native gas token units
This function requires 2 values to successfully work:
Amount
This value represents the amount of
finalTargetToken
you would like to bridge over. When passing the value 0, it will try to bridge the entire available amount. How to identify the available amount?Visit the CarbonVortex contract (follow the address in the relevant chain)
Read
finalTargetToken
to find the address of the token to bridge over (if the address is null, checktargetToken
address instead)Check the contract balance for the token address
Bridge
This value represents the bridge fee required in order for the transaction to completely deliver the tokens on the Ethereum blockchain. How to identify the required bridge fee?
Visit StarGate interface
Connect wallet
Attempt to bridge any amount of tokens (you want to see the transaction details on your wallet signed page DO NOT SIGN THE TRANSACTION)
In the wallet confirmation popup, find the value under "Param #2" as outlined in the image (you can "Cancel" the wallet popup after coping the required value)
Copy the indicated value and paste it into the
bridge
field of the transaction. Make sure you normalize the decimal correctly to the gas token of the chain. For example, on Base, the input value should be in "ETH" units i.e. 0.000666588492010473 and not as indicated in WEI.
Example
bridge(
0, //zero will try to bridge the full available amount
0.000666588492010473 //bridge fee (some bridge require this value in WEI)
Last updated