OVM_ETH
OVM_ETH
The ETH predeploy provides an ERC20 interface for ETH deposited to Layer 2. Note that unlike on Layer 1, Layer 2 accounts do not have a balance field.
Methods
allowance
function allowance(address owner, address spender) external view returns (uint256)See {IERC20-allowance}.
Parameters
| Name | Type | Description |
|---|---|---|
| owner | address | undefined |
| spender | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
approve
function approve(address spender, uint256 amount) external nonpayable returns (bool)Sets amount as the allowance of spender over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 Emits an {Approval} event.
Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined |
| amount | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
balanceOf
function balanceOf(address account) external view returns (uint256)See {IERC20-balanceOf}.
Parameters
| Name | Type | Description |
|---|---|---|
| account | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
burn
function burn(address _from, uint256 _amount) external nonpayableParameters
| Name | Type | Description |
|---|---|---|
| _from | address | undefined |
| _amount | uint256 | undefined |
decimals
function decimals() external view returns (uint8)Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint8 | undefined |
decreaseAllowance
function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool)Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined |
| subtractedValue | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
increaseAllowance
function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool)Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined |
| addedValue | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
l1Token
function l1Token() external view returns (address)Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
l2Bridge
function l2Bridge() external view returns (address)Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
mint
function mint(address _to, uint256 _amount) external nonpayableParameters
| Name | Type | Description |
|---|---|---|
| _to | address | undefined |
| _amount | uint256 | undefined |
name
function name() external view returns (string)Returns the name of the token.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined |
supportsInterface
function supportsInterface(bytes4 _interfaceId) external pure returns (bool)Parameters
| Name | Type | Description |
|---|---|---|
| _interfaceId | bytes4 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
symbol
function symbol() external view returns (string)Returns the symbol of the token, usually a shorter version of the name.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined |
totalSupply
function totalSupply() external view returns (uint256)See {IERC20-totalSupply}.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
transfer
function transfer(address recipient, uint256 amount) external nonpayable returns (bool)Moves amount tokens from the caller's account to recipient. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.
Parameters
| Name | Type | Description |
|---|---|---|
| recipient | address | undefined |
| amount | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
transferFrom
function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.
Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined |
| recipient | address | undefined |
| amount | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
Events
Approval
event Approval(address indexed owner, address indexed spender, uint256 value)Parameters
| Name | Type | Description |
|---|---|---|
owner indexed
|
address | undefined |
spender indexed
|
address | undefined |
| value | uint256 | undefined |
Burn
event Burn(address indexed _account, uint256 _amount)Parameters
| Name | Type | Description |
|---|---|---|
_account indexed
|
address | undefined |
| _amount | uint256 | undefined |
Mint
event Mint(address indexed _account, uint256 _amount)Parameters
| Name | Type | Description |
|---|---|---|
_account indexed
|
address | undefined |
| _amount | uint256 | undefined |
Transfer
event Transfer(address indexed from, address indexed to, uint256 value)Parameters
| Name | Type | Description |
|---|---|---|
from indexed
|
address | undefined |
to indexed
|
address | undefined |
| value | uint256 | undefined |