TokenVault

This vault holds all ERC20 tokens (but not Ether) that users have deposited. It also manages the mapping between canonical ERC20 tokens and their bridged tokens.

Ether is held by Bridges on L1 and by the EtherVault on L2, not TokenVaults.

CanonicalERC20

struct CanonicalERC20 {
  uint256 chainId;
  address addr;
  uint8 decimals;
  string symbol;
  string name;
}

MessageDeposit

struct MessageDeposit {
  address token;
  uint256 amount;
}

isBridgedToken

mapping(address => bool) isBridgedToken

bridgedToCanonical

mapping(address => struct TokenVault.CanonicalERC20) bridgedToCanonical

canonicalToBridged

mapping(uint256 => mapping(address => address)) canonicalToBridged

messageDeposits

mapping(bytes32 => struct TokenVault.MessageDeposit) messageDeposits

BridgedERC20Deployed

event BridgedERC20Deployed(uint256 srcChainId, address canonicalToken, address bridgedToken, string canonicalTokenSymbol, string canonicalTokenName, uint8 canonicalTokenDecimal)

EtherSent

event EtherSent(bytes32 msgHash, address from, address to, uint256 destChainId, uint256 amount)

ERC20Sent

event ERC20Sent(bytes32 msgHash, address from, address to, uint256 destChainId, address token, uint256 amount)

ERC20Released

event ERC20Released(bytes32 msgHash, address from, address token, uint256 amount)

ERC20Received

event ERC20Received(bytes32 msgHash, address from, address to, uint256 srcChainId, address token, uint256 amount)

TOKENVAULT_INVALID_TO

error TOKENVAULT_INVALID_TO()

Thrown when the to address in an operation is invalid. This can happen if it's zero address or the address of the token vault.

TOKENVAULT_INVALID_VALUE

error TOKENVAULT_INVALID_VALUE()

Thrown when the value in a transaction is invalid. The value can be an Ether amount or the amount of a token being transferred.

TOKENVAULT_INVALID_TOKEN

error TOKENVAULT_INVALID_TOKEN()

Thrown when the token address in a transaction is invalid. This could happen if the token address is zero or doesn't conform to the ERC20 standard.

TOKENVAULT_INVALID_AMOUNT

error TOKENVAULT_INVALID_AMOUNT()

Thrown when the amount in a transaction is invalid. This could happen if the amount is zero or exceeds the sender's balance.

TOKENVAULT_CANONICAL_TOKEN_NOT_FOUND

error TOKENVAULT_CANONICAL_TOKEN_NOT_FOUND()

Thrown when a canonical token address could not be found for a bridged token. This could happen when trying to send a bridged token back to its original chain.

TOKENVAULT_INVALID_OWNER

error TOKENVAULT_INVALID_OWNER()

Thrown when the owner address in a message is invalid. This could happen if the owner address is zero or doesn't match the expected owner.

TOKENVAULT_INVALID_SRC_CHAIN_ID

error TOKENVAULT_INVALID_SRC_CHAIN_ID()

Thrown when the source chain ID in a message is invalid. This could happen if the source chain ID doesn't match the current chain's ID.

TOKENVAULT_MESSAGE_NOT_FAILED

error TOKENVAULT_MESSAGE_NOT_FAILED()

Thrown when a message has not failed. This could happen if trying to release a message deposit without proof of failure.

TOKENVAULT_INVALID_SENDER

error TOKENVAULT_INVALID_SENDER()

Thrown when the sender in a message context is invalid. This could happen if the sender isn't the expected token vault on the source chain.

init

function init(address addressManager) external

sendERC20

function sendERC20(uint256 destChainId, address to, address token, uint256 amount, uint256 gasLimit, uint256 processingFee, address refundAddress, string memo) external payable

Transfers ERC20 tokens to this vault and sends a message to the destination chain so the user can receive the same amount of tokens by invoking the message call.

Parameters

releaseERC20

function releaseERC20(struct IBridge.Message message, bytes proof) external

Release deposited ERC20 back to the owner on the source TokenVault with a proof that the message processing on the destination Bridge has failed.

Parameters

receiveERC20

function receiveERC20(struct TokenVault.CanonicalERC20 canonicalToken, address from, address to, uint256 amount) external

This function can only be called by the bridge contract while invoking a message call. See sendERC20, which sets the data to invoke this function.

Parameters

title: ProxiedTokenVault

ProxiedTokenVault