Calls
This section contains a full API reference of all public functions & events related to making and tracking xchain calls.
Events
XCalled
Emitted when xcall
is called on the origin domain of a transfer.
Parameters
ExternalCalldataExecuted
Emitted when a transfer has its external data executed
Parameters
Executed
Emitted when execute
is called on the destination domain of a transfer.
execute
may be called when providing fast liquidity or when processing a reconciled (slow) transfer.
Parameters
TransferRelayerFeesIncreased
Emitted when _bumpTransfer
is called by an user on the origin domain both in xcall
and bumpTransfer
Parameters
SlippageUpdated
Emitted when forceUpdateSlippage
is called by an user on the destination domain
Parameters
Getters
routedTransfers
Gets a list of routers that routed a transfer by transferId
.
Parameters
Return Values
transferStatus
Gets a transfer's status by transferId
. Note - this function MUST be called on the destination chain.
Parameters
Return Values
domain
Gets the domain
identifier of the chain.
Parameters
Return Values
Functions
xcall
Initiates a cross-chain transfer of funds, calldata, and/or various named properties.
For ERC20 transfers, this contract must have approval to transfer the input (transacting) assets. The adopted assets will be swapped for their local (connext-flavored) asset counterparts (i.e. bridgeable tokens) via the configured AMM if necessary. In the event that the adopted assets are local assets, no swap is needed. The local tokens will then be sent via the bridge router. If the local assets are representational for an asset on another chain, we will burn the tokens here. If the local assets are canonical (meaning that the adopted to local asset pairing is native to this chain), we will custody the tokens here.
Parameters
Return Values
xcallIntoLocal
Helper function that xcalls as normal but forces the receipt of the local (Connext-flavored) asset at destination. This function is used typically to generate nextAssets that can be used to LP into the destination chain stableswap. Params and returned data function exactly the same way as xcall
.
execute
Called on a destination domain to disburse correct assets to end recipient and execute any included calldata.
Can be called before or after handle
[reconcile] is called (regarding the same transfer), depending on whether the fast liquidity route (i.e. funds provided by routers) is being used for this transfer. As a result, executed calldata (including properties like originSender
) may or may not be verified depending on whether the reconcile has been completed (i.e. the optimistic confirmation period has elapsed).
Parameters
Return Values
bumpTransfer (native asset)
Anyone can call this function on the origin domain to increase the relayer fee for a transfer. MUST be called on the origin domain.
Parameters
bumpTransfer (transacting asset)
Anyone can call this function to increase the relayer fee for a transfer (using the _relayerFeeAsset specified). MUST be called on the origin domain.
Parameters
forceUpdateSlippage
Allows a user-specified account (delegate
in xcall
) to update the slippage they are willing to take on destination transfers. MUST be called on the destination chain.
Parameters
Interfaces
xReceive
Interface that the Connext contracts call into on the _to
address specified during xcall
. Developers MUST implement this on the destination chain to receive incoming calldata.
Parameters
Last updated