OptimismMintableERC20 on World Chain — live on-chain contract docs

Overview

Read Functions

Write Functions

Events

Read Functions

BRIDGE() view

Returns

Name	Type	Description
—	address

REMOTE_TOKEN() view

Returns

Name	Type	Description
—	address

allowance(owner: address, spender: address) view

dev: See {IERC20-allowance}.

Parameters

Name	Type	Description
owner	address
spender	address

Returns

Name	Type	Description
—	uint256

balanceOf(account: address) view

dev: See {IERC20-balanceOf}.

Parameters

Name	Type	Description
account	address

Returns

Name	Type	Description
—	uint256

bridge() view

Legacy getter for BRIDGE.

Returns

Name	Type	Description
—	address

decimals() view

dev: 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`). 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
—	uint8

l1Token() view

Legacy getter for the remote token. Use REMOTE_TOKEN going forward.

Returns

Name	Type	Description
—	address

l2Bridge() view

Legacy getter for the bridge. Use BRIDGE going forward.

Returns

Name	Type	Description
—	address

name() view

dev: Returns the name of the token.

Returns

Name	Type	Description
—	string

remoteToken() view

Legacy getter for REMOTE_TOKEN.

Returns

Name	Type	Description
—	address

supportsInterface(_interfaceId: bytes4) pure

ERC165 interface check function.

Parameters

Name	Type	Description
_interfaceId	bytes4	Interface ID to check.

Returns

Name	Type	Description
—	bool	Whether or not the interface is supported by this contract.

symbol() view

dev: Returns the symbol of the token, usually a shorter version of the name.

Returns

Name	Type	Description
—	string

totalSupply() view

dev: See {IERC20-totalSupply}.

Returns

Name	Type	Description
—	uint256

version() view

Getter for the semantic version of the contract. This is not meant to be used onchain but instead meant to be used by offchain tooling.

Returns

Name	Type	Description
—	string	Semver contract version as a string.

Write Functions

approve(spender: address, amount: uint256) nonpayable

dev: See {IERC20-approve}. NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on `transferFrom`. This is semantically equivalent to an infinite approval. Requirements: - `spender` cannot be the zero address.

Parameters

Name	Type	Description
spender	address
amount	uint256

Returns

Name	Type	Description
—	bool

burn(_from: address, _amount: uint256) nonpayable

Allows the StandardBridge on this network to burn tokens.

Parameters

Name	Type	Description
_from	address	Address to burn tokens from.
_amount	uint256	Amount of tokens to burn.

decreaseAllowance(spender: address, subtractedValue: uint256) nonpayable

dev: 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
subtractedValue	uint256

Returns

Name	Type	Description
—	bool

increaseAllowance(spender: address, addedValue: uint256) nonpayable

dev: 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
addedValue	uint256

Returns

Name	Type	Description
—	bool

mint(_to: address, _amount: uint256) nonpayable

Allows the StandardBridge on this network to mint tokens.

Parameters

Name	Type	Description
_to	address	Address to mint tokens to.
_amount	uint256	Amount of tokens to mint.

transfer(to: address, amount: uint256) nonpayable

dev: See {IERC20-transfer}. Requirements: - `to` cannot be the zero address. - the caller must have a balance of at least `amount`.

Parameters

Name	Type	Description
to	address
amount	uint256

Returns

Name	Type	Description
—	bool

transferFrom(from: address, to: address, amount: uint256) nonpayable

dev: See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. NOTE: Does not update the allowance if the current allowance is the maximum `uint256`. Requirements: - `from` and `to` cannot be the zero address. - `from` must have a balance of at least `amount`. - the caller must have allowance for ``from``'s tokens of at least `amount`.

Parameters

Name	Type	Description
from	address
to	address
amount	uint256

Returns

Name	Type	Description
—	bool

Events

Approval(owner: address, spender: address, value: uint256)

Name	Type	Indexed
owner	address	✓
spender	address	✓
value	uint256

Burn(account: address, amount: uint256)

Emitted whenever tokens are burned from an account.

Name	Type	Indexed	Description
account	address	✓	Address of the account tokens are being burned from.
amount	uint256		Amount of tokens burned.

Mint(account: address, amount: uint256)

Emitted whenever tokens are minted for an account.

Name	Type	Indexed	Description
account	address	✓	Address of the account tokens are being minted for.
amount	uint256		Amount of tokens minted.

Transfer(from: address, to: address, value: uint256)

Name	Type	Indexed
from	address	✓
to	address	✓
value	uint256