Interface IERC20Metadata

Interface that represents a smart contract, which implements EIP20 with the optional Metadata extension

interface

Hierarchy

IERC20
- IERC20Metadata
  - ERC20

Implemented by

Embers

Index

Methods

Methods

allowance

allowance(owner: string, spender: string): Promise<bigint>

Inherited from IERC20.allowance
- Defined in mrx/interface/IERC20.ts:18
Returns the remaining number of tokens that spender will be allowed to spend on behalf of owner through transferFrom. This is zero by default. This value changes when approve or transferFrom are called.

Parameters
- owner: string
- spender: string
Returns Promise<bigint>

approve

approve(spender: string, amount: bigint): Promise<Transaction>

Inherited from IERC20.approve
- Defined in mrx/interface/IERC20.ts:28
Sets amount as the allowance of spender over the caller's tokens.

Emits an {Approval} event.

Parameters
- spender: string
- amount: bigint
Returns Promise<Transaction>

balanceOf

balanceOf(account: string): Promise<bigint>

Inherited from IERC20.balanceOf
- Defined in mrx/interface/IERC20.ts:34
Returns the amount of tokens owned by account.

Parameters
- account: string
Returns Promise<bigint>

decimals

decimals(): Promise<number>

- Defined in mrx/interface/IERC20Metadata.ts:22
Returns the decimals places of the token.

Returns Promise<number>

name

name(): Promise<string>

- Defined in mrx/interface/IERC20Metadata.ts:12
Returns the name of the token.

Returns Promise<string>

symbol

symbol(): Promise<string>

- Defined in mrx/interface/IERC20Metadata.ts:17
Returns the symbol of the token.

Returns Promise<string>

totalSupply

totalSupply(): Promise<bigint>

Inherited from IERC20.totalSupply
- Defined in mrx/interface/IERC20.ts:39
Returns the amount of tokens in existence.

Returns Promise<bigint>

transfer

transfer(recipient: string, amount: bigint): Promise<Transaction>

Inherited from IERC20.transfer
- Defined in mrx/interface/IERC20.ts:49
Moves amount tokens from the caller's account to recipient.

Emits a {Transfer} event.

Parameters
- recipient: string
- amount: bigint
Returns Promise<Transaction>

transferFrom

transferFrom(sender: string, recipient: string, amount: bigint): Promise<Transaction>

Inherited from IERC20.transferFrom
- Defined in mrx/interface/IERC20.ts:62
Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance.

Emits a {Transfer} event.

Parameters
- sender: string
- recipient: string
- amount: bigint
Returns Promise<Transaction>

Generated using TypeDoc