scroll/contracts/docs/apis/L1GatewayRouter.md

L1GatewayRouter

L1GatewayRouter

The L1GatewayRouter is the main entry for depositing Ether and ERC20 tokens. All deposited tokens are routed to corresponding gateways.

One can also use this contract to query L1/L2 token address mapping. In the future, ERC-721 and ERC-1155 tokens will be added to the router too.

Methods

ERC20Gateway

function ERC20Gateway(address) external view returns (address)

Mapping from ERC20 token address to corresponding L1ERC20Gateway.

Parameters

Name	Type	Description
_0	address	undefined

Returns

Name	Type	Description
_0	address	undefined

defaultERC20Gateway

function defaultERC20Gateway() external view returns (address)

The addess of default ERC20 gateway, normally the L1StandardERC20Gateway contract.

Returns

Name	Type	Description
_0	address	undefined

depositERC20

function depositERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable

Deposit some token to a caller's account on L2.

Make this function payable to send relayer fee in Ether.

Parameters

Name	Type	Description
_token	address	The address of token in L1.
_amount	uint256	The amount of token to transfer.
_gasLimit	uint256	Gas limit required to complete the deposit on L2.

depositERC20

function depositERC20(address _token, address _to, uint256 _amount, uint256 _gasLimit) external payable

Deposit some token to a recipient's account on L2.

Make this function payable to send relayer fee in Ether.

Parameters

Name	Type	Description
_token	address	The address of token in L1.
_to	address	The address of recipient's account on L2.
_amount	uint256	The amount of token to transfer.
_gasLimit	uint256	Gas limit required to complete the deposit on L2.

depositERC20AndCall

function depositERC20AndCall(address _token, address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable

Deposit some token to a recipient's account on L2 and call.

Make this function payable to send relayer fee in Ether.

Parameters

Name	Type	Description
_token	address	The address of token in L1.
_to	address	The address of recipient's account on L2.
_amount	uint256	The amount of token to transfer.
_data	bytes	Optional data to forward to recipient's account.
_gasLimit	uint256	Gas limit required to complete the deposit on L2.

depositETH

function depositETH(uint256 _amount, uint256 _gasLimit) external payable

Deposit ETH to caller's account in L2.

Parameters

Name	Type	Description
_amount	uint256	undefined
_gasLimit	uint256	undefined

depositETH

function depositETH(address _to, uint256 _amount, uint256 _gasLimit) external payable

Deposit ETH to some recipient's account in L2.

Parameters

Name	Type	Description
_to	address	undefined
_amount	uint256	undefined
_gasLimit	uint256	undefined

depositETHAndCall

function depositETHAndCall(address _to, uint256 _amount, bytes _data, uint256 _gasLimit) external payable

Deposit ETH to some recipient's account in L2 and call the target contract.

Parameters

Name	Type	Description
_to	address	undefined
_amount	uint256	undefined
_data	bytes	undefined
_gasLimit	uint256	undefined

ethGateway

function ethGateway() external view returns (address)

The address of L1ETHGateway.

Returns

Name	Type	Description
_0	address	undefined

finalizeWithdrawERC20

function finalizeWithdrawERC20(address, address, address, address, uint256, bytes) external payable

Complete ERC20 withdraw from L2 to L1 and send fund to recipient's account in L1.

Make this function payable to handle WETH deposit/withdraw. The function should only be called by L1ScrollMessenger. The function should also only be called by L2ERC20Gateway in L2.

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	address	undefined
_3	address	undefined
_4	uint256	undefined
_5	bytes	undefined

finalizeWithdrawETH

function finalizeWithdrawETH(address, address, uint256, bytes) external payable

Complete ETH withdraw from L2 to L1 and send fund to recipient's account in L1.

This function should only be called by L1ScrollMessenger. This function should also only be called by L1ETHGateway in L2.

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256	undefined
_3	bytes	undefined

gatewayInContext

function gatewayInContext() external view returns (address)

The address of gateway in current execution context.

Returns

Name	Type	Description
_0	address	undefined

getERC20Gateway

function getERC20Gateway(address _token) external view returns (address)

Return the corresponding gateway address for given token address.

Parameters

Name	Type	Description
_token	address	The address of token to query.

Returns

Name	Type	Description
_0	address	undefined

getL2ERC20Address

function getL2ERC20Address(address _l1Address) external view returns (address)

Return the corresponding l2 token address given l1 token address.

Parameters

Name	Type	Description
_l1Address	address	undefined

Returns

Name	Type	Description
_0	address	undefined

initialize

function initialize(address _ethGateway, address _defaultERC20Gateway) external nonpayable

Initialize the storage of L1GatewayRouter.

Parameters

Name	Type	Description
_ethGateway	address	The address of L1ETHGateway contract.
_defaultERC20Gateway	address	The address of default ERC20 Gateway contract.

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

renounceOwnership

function renounceOwnership() external nonpayable

Leaves the contract without owner. It will not be possible to call onlyOwner functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.

requestERC20

function requestERC20(address _sender, address _token, uint256 _amount) external nonpayable returns (uint256)

Request ERC20 token transfer from users to gateways.

All the gateways should have reentrancy guard to prevent potential attack though this function.

Parameters

Name	Type	Description
_sender	address	undefined
_token	address	undefined
_amount	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

setDefaultERC20Gateway

function setDefaultERC20Gateway(address _newDefaultERC20Gateway) external nonpayable

Update the address of default ERC20 gateway contract.

This function should only be called by contract owner.

Parameters

Name	Type	Description
_newDefaultERC20Gateway	address	undefined

setERC20Gateway

function setERC20Gateway(address[] _tokens, address[] _gateways) external nonpayable

Update the mapping from token address to gateway address.

This function should only be called by contract owner.

Parameters

Name	Type	Description
_tokens	address[]	The list of addresses of tokens to update.
_gateways	address[]	The list of addresses of gateways to update.

setETHGateway

function setETHGateway(address _newEthGateway) external nonpayable

Update the address of ETH gateway contract.

This function should only be called by contract owner.

Parameters

Name	Type	Description
_newEthGateway	address	undefined

transferOwnership

function transferOwnership(address newOwner) external nonpayable

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

Name	Type	Description
newOwner	address	undefined

Events

DepositERC20

event DepositERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)

Emitted when someone deposit ERC20 token from L1 to L2.

Parameters

Name	Type	Description
l1Token indexed	address	The address of the token in L1.
l2Token indexed	address	The address of the token in L2.
from indexed	address	The address of sender in L1.
to	address	The address of recipient in L2.
amount	uint256	The amount of token will be deposited from L1 to L2.
data	bytes	The optional calldata passed to recipient in L2.

DepositETH

event DepositETH(address indexed from, address indexed to, uint256 amount, bytes data)

Emitted when someone deposit ETH from L1 to L2.

Parameters

Name	Type	Description
from indexed	address	The address of sender in L1.
to indexed	address	The address of recipient in L2.
amount	uint256	The amount of ETH will be deposited from L1 to L2.
data	bytes	The optional calldata passed to recipient in L2.

FinalizeWithdrawERC20

event FinalizeWithdrawERC20(address indexed l1Token, address indexed l2Token, address indexed from, address to, uint256 amount, bytes data)

Emitted when ERC20 token is withdrawn from L2 to L1 and transfer to recipient.

Parameters

Name	Type	Description
l1Token indexed	address	The address of the token in L1.
l2Token indexed	address	The address of the token in L2.
from indexed	address	The address of sender in L2.
to	address	The address of recipient in L1.
amount	uint256	The amount of token withdrawn from L2 to L1.
data	bytes	The optional calldata passed to recipient in L1.

FinalizeWithdrawETH

event FinalizeWithdrawETH(address indexed from, address indexed to, uint256 amount, bytes data)

Emitted when ETH is withdrawn from L2 to L1 and transfer to recipient.

Parameters

Name	Type	Description
from indexed	address	The address of sender in L2.
to indexed	address	The address of recipient in L1.
amount	uint256	The amount of ETH withdrawn from L2 to L1.
data	bytes	The optional calldata passed to recipient in L1.

Initialized

event Initialized(uint8 version)

Triggered when the contract has been initialized or reinitialized.

Parameters

Name	Type	Description
version	uint8	undefined

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	undefined

RefundERC20

event RefundERC20(address indexed token, address indexed recipient, uint256 amount)

Emitted when some ERC20 token is refunded.

Parameters

Name	Type	Description
token indexed	address	The address of the token in L1.
recipient indexed	address	The address of receiver in L1.
amount	uint256	The amount of token refunded to receiver.

RefundETH

event RefundETH(address indexed recipient, uint256 amount)

Emitted when some ETH is refunded.

Parameters

Name	Type	Description
recipient indexed	address	The address of receiver in L1.
amount	uint256	The amount of ETH refunded to receiver.

SetDefaultERC20Gateway

event SetDefaultERC20Gateway(address indexed oldDefaultERC20Gateway, address indexed newDefaultERC20Gateway)

Emitted when the address of default ERC20 Gateway is updated.

Parameters

Name	Type	Description
oldDefaultERC20Gateway indexed	address	The address of the old default ERC20 Gateway.
newDefaultERC20Gateway indexed	address	The address of the new default ERC20 Gateway.

SetERC20Gateway

event SetERC20Gateway(address indexed token, address indexed oldGateway, address indexed newGateway)

Emitted when the gateway for token is updated.

Parameters

Name	Type	Description
token indexed	address	The address of token updated.
oldGateway indexed	address	The corresponding address of the old gateway.
newGateway indexed	address	The corresponding address of the new gateway.

SetETHGateway

event SetETHGateway(address indexed oldETHGateway, address indexed newEthGateway)

Emitted when the address of ETH Gateway is updated.

Parameters

Name	Type	Description
oldETHGateway indexed	address	The address of the old ETH Gateway.
newEthGateway indexed	address	The address of the new ETH Gateway.