Class MRC20

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

Hierarchy (view full)

MetrixContract
- MRC20

Implements

IERC20Metadata

Index

Constructors

constructor

new MRC20(address, provider): MRC20
Parameters
- address: string
- provider: Provider
Returns MRC20
Overrides MetrixContract.constructor
- Defined in src/metriverse/token/MRC/MRC20.ts:8

Properties

abi

abi: any[]

address

address: string

bytecode

bytecode: undefined | string

provider

provider: Provider

Methods

allowance

allowance(owner, spender): Promise<bigint>
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>
Implementation of IERC20Metadata.allowance
- Defined in src/metriverse/token/MRC/MRC20.ts:29

approve

approve(spender, amount): Promise<Transaction>
Sets amount as the allowance of spender over the caller's tokens.

Emits an Approval event.
Parameters
- spender: string
- amount: bigint
Returns Promise<Transaction>
Implementation of IERC20Metadata.approve
- Defined in src/metriverse/token/MRC/MRC20.ts:39

balance

balance(): Promise<bigint>
Get this contract balance

Returns Promise<bigint>
the satoshi balance of this contract
Inherited from MetrixContract.balance
- Defined in src/mrx/MetrixContract.ts:30

balanceOf

balanceOf(owner): Promise<bigint>
Returns the amount of tokens owned by account.
Parameters
- owner: string
Returns Promise<bigint>
Implementation of IERC20Metadata.balanceOf
- Defined in src/metriverse/token/MRC/MRC20.ts:51

call

call(method, args): Promise<undefined | Result>
Perform calltocontract
Parameters
- method: string
  The contract method to call
- args: any[]
  The arguments
Returns Promise<undefined | Result>
see Result
Inherited from MetrixContract.call
- Defined in src/mrx/MetrixContract.ts:44

decimals

decimals(): Promise<number>
Returns the decimals places of the token.

Returns Promise<number>
Implementation of IERC20Metadata.decimals
- Defined in src/metriverse/token/MRC/MRC20.ts:22

getEventLogs

getEventLogs(): Promise<EventLogs>
Get receipts from a transaction

Returns Promise<EventLogs>
an EventLogs object
Inherited from MetrixContract.getEventLogs
- Defined in src/mrx/MetrixContract.ts:94

name

name(): Promise<string>
Returns the name of the token.

Returns Promise<string>
Implementation of IERC20Metadata.name
- Defined in src/metriverse/token/MRC/MRC20.ts:12

send

send(method, args, value?, gasLimit?, gasPrice?): Promise<{
    hash160: string;
    sender: string;
    txid: string;
}>
Perform sendtocontract
Parameters
- method: string
  The contract method to send to
- args: any[]
  The arguments to use
- value: undefined | string = '0'
  The amount to send to the contract
- gasLimit: undefined | number = 250000
  The amount of gas units allowed
- gasPrice: undefined | number = 5000
  The satoshi price per gas
Returns Promise<{
    hash160: string;
    sender: string;
    txid: string;
}>
see Result
Inherited from MetrixContract.send
- Defined in src/mrx/MetrixContract.ts:66

symbol

symbol(): Promise<string>
Returns the symbol of the token.

Returns Promise<string>
Implementation of IERC20Metadata.symbol
- Defined in src/metriverse/token/MRC/MRC20.ts:17

totalSupply

totalSupply(): Promise<bigint>
Returns the amount of tokens in existence.

Returns Promise<bigint>
Implementation of IERC20Metadata.totalSupply
- Defined in src/metriverse/token/MRC/MRC20.ts:58

transfer

transfer(recipient, amount): Promise<Transaction>
Moves amount tokens from the caller's account to recipient.

Emits a Transfer event.
Parameters
- recipient: string
- amount: bigint
Returns Promise<Transaction>
Implementation of IERC20Metadata.transfer
- Defined in src/metriverse/token/MRC/MRC20.ts:65

transferFrom

transferFrom(sender, recipient, amount): Promise<Transaction>
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>
Implementation of IERC20Metadata.transferFrom
- Defined in src/metriverse/token/MRC/MRC20.ts:77

Class MRC20

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MRC20

Properties

abi

address

bytecode

provider

Methods

allowance

Parameters

Returns Promise<bigint>

approve

Parameters

Returns Promise<Transaction>

balance

Returns Promise<bigint>

balanceOf

Parameters

Returns Promise<bigint>

call

Parameters

Returns Promise<undefined | Result>

decimals

Returns Promise<number>

getEventLogs

Returns Promise<EventLogs>

name

Returns Promise<string>

send

Parameters

Returns Promise<{ hash160: string; sender: string; txid: string; }>

symbol

Returns Promise<string>

totalSupply

Returns Promise<bigint>

transfer

Parameters

Returns Promise<Transaction>

transferFrom

Parameters

Returns Promise<Transaction>

Settings

On This Page

Returns Promise<{
hash160: string;
sender: string;
txid: string;
}>