FastBridgeRouterV2

Git Source

Inherits: DefaultRouter, Ownable, IFastBridgeRouter

State Variables

GAS_REBATE_FLAG

Magic value that indicates that the user wants to receive gas rebate on the destination chain. This is the answer to the ultimate question of life, the universe, and everything.

bytes1 public constant GAS_REBATE_FLAG = 0x2A;

fastBridge

Address of the FastBridge contract, used to initiate cross-chain RFQ swaps.

address public fastBridge;

swapQuoter

Address of the SwapQuoter contract, used to fetch quotes for the origin swap.

address public swapQuoter;

Functions

constructor

constructor(address owner_);

setFastBridge

Sets the address of the FastBridge contract

This function is only callable by the owner

function setFastBridge(address fastBridge_) external onlyOwner;

Parameters

setSwapQuoter

Sets the address of the SwapQuoter contract

This function is only callable by the owner

function setSwapQuoter(address swapQuoter_) external onlyOwner;

Parameters

bridge

Initiate an RFQ transaction with an optional swap on origin chain, and an optional gas rebate on destination chain.

*Note that method is payable. If token is ETH_ADDRESS, this method should be invoked with msg.value = amountIn. If token is ERC20, the tokens will be pulled from msg.sender (use msg.value = 0). Make sure to approve this contract for spending token beforehand. originQuery is supposed to be fetched using FastBridgeRouter.getOriginAmountOut(). Alternatively one could use an external adapter for more complex swaps on the origin chain. destQuery.rawParams signals whether the user wants to receive a gas rebate on the destination chain:

• If the first byte of destQuery.rawParams is GAS_REBATE_FLAG, the user wants to receive a gas rebate.
• Otherwise, the user does not want to receive a gas rebate. Cross-chain RFQ swap will be performed between tokens: originQuery.tokenOut and destQuery.tokenOut. Note: both tokens could be ETH_ADDRESS or ERC20. Full proceeds of the origin swap are considered the bid for the cross-chain swap. destQuery.minAmountOut is considered the ask for the cross-chain swap. Note: applying slippage to destQuery.minAmountOut will result in a worse price for the user, the full Relayer quote should be used instead.*

function bridge(
    address recipient,
    uint256 chainId,
    address token,
    uint256 amount,
    SwapQuery memory originQuery,
    SwapQuery memory destQuery
)
    external
    payable;

Parameters

getOriginAmountOut

Finds the best path between tokenIn and every RFQ token from the given list, treating the swap as "origin swap", without putting any restrictions on the swap.

Check (query.minAmountOut != 0): this is true only if the swap is possible. The returned queries with minAmountOut != 0 could be used as originQuery with FastBridgeRouter. Note: it is possible to form a SwapQuery off-chain using alternative SwapAdapter for the origin swap.

function getOriginAmountOut(
    address tokenIn,
    address[] memory rfqTokens,
    uint256 amountIn
)
    external
    view
    returns (SwapQuery[] memory originQueries);

Parameters

Returns

_getOriginSender

Retrieves the origin sender from the raw params. Note: falls back to msg.sender if origin sender is not specified in the raw params, but msg.sender is an EOA.

function _getOriginSender(bytes memory rawParams) internal view returns (address originSender);

_chainGasRequested

Checks if the explicit instruction to send gas to the destination chain was provided.

function _chainGasRequested(bytes memory rawParams) internal pure returns (bool);

Events

SwapQuoterSet

Emitted when the swap quoter is set.

event SwapQuoterSet(address newSwapQuoter);

FastBridgeSet

Emitted when the new FastBridge contract is set.

event FastBridgeSet(address newFastBridge);

Errors

FastBridgeRouterV2__OriginSenderNotSpecified

error FastBridgeRouterV2__OriginSenderNotSpecified();