INativeTokenVault

Author: Matter Labs

The NTV is an Asset Handler for the L1AssetRouter to handle native tokens

Note: security-contact: security@matterlabs.dev

Functions

The Weth token address

function WETH_TOKEN() external view returns (address);

The AssetRouter contract

function ASSET_ROUTER() external view returns (IAssetRouterBase);

The chain ID of the L1 chain

function L1_CHAIN_ID() external view returns (uint256);

Returns the chain ID of the origin chain for a given asset ID

function originChainId(bytes32 assetId) external view returns (uint256);

Registers tokens within the NTV.

Allows the bridge to register a token address for the vault.

No access control is ok, since the bridging of tokens should be permissionless. This requires permissionless registration.

The goal is to allow bridging native tokens automatically, by registering them on the fly.

function registerToken(address _l1Token) external;

Ensures that the native token is registered with the NTV.

This function is used to ensure that the token is registered with the NTV.

function ensureTokenIsRegistered(address _nativeToken)
  external
  returns (bytes32);

Used to get the the ERC20 data for a token

function getERC20Getters(address _token, uint256 _originChainId)
  external
  view
  returns (bytes memory);

Used to get the token address of an assetId

function tokenAddress(bytes32 assetId) external view returns (address);

Used to get the assetId of a token

function assetId(address token) external view returns (bytes32);

Used to get the expected bridged token address corresponding to its native counterpart

function calculateCreate2TokenAddress(
  uint256 _originChainId,
  address _originToken
) external view returns (address);

Tries to register a token from the provided _burnData and reverts if it is not possible.

function tryRegisterTokenFromBurnData(
  bytes calldata _burnData,
  bytes32 _expectedAssetId
) external;

event BridgedTokenBeaconUpdated(
  address bridgedTokenBeacon, bytes32 bridgedTokenProxyBytecodeHash
);