Class WrappedMetrix

Hierarchy

  • default
    • WrappedMetrix

Implements

  • IERC20Metadata

Constructors

constructor

Properties

abi address bytecode provider

Methods

allowance approve balance balanceOf burn burnFrom call decimals deposit getEventLogs name send symbol totalSupply transfer transferFrom withdraw

Constructors

constructor

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>

approve

  • approve(spender, amount, gasLimit?): Promise<Transaction>

  • Sets amount as the allowance of spender over the caller's tokens.

    Emits an Approval event.

    Parameters

    • spender: string
    • amount: bigint
    • gasLimit: undefined | number = 48690

    Returns Promise<Transaction>

balance

  • balance(): Promise<bigint>

  • Get this contract balance

    Returns Promise<bigint>

    the satoshi balance of this contract

balanceOf

  • balanceOf(owner): Promise<bigint>

  • Returns the amount of tokens owned by account.

    Parameters

    • owner: string

    Returns Promise<bigint>

burn

  • burn(amount, gasLimit?): Promise<Transaction>

  • Destroys amount tokens from the caller.

    Parameters

    • amount: bigint

      the uint256 id of the token

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

burnFrom

  • burnFrom(account, amount, gasLimit?): Promise<Transaction>

  • Destroys amount tokens from account, deducting from the caller's allowance.

    Parameters

    • account: string
    • amount: bigint
    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

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

decimals

  • decimals(): Promise<number>

  • Returns the decimals places of the token.

    Returns Promise<number>

deposit

  • deposit(amount?, gasLimit?): Promise<Transaction>

  • Deposits MRX to wrap into wMRX

    Parameters

    • amount: undefined | string = '0'
    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

getEventLogs

  • getEventLogs(): Promise<EventLogs>

  • Get receipts from a transaction

    Returns Promise<EventLogs>

    an EventLogs object

name

  • name(): Promise<string>

  • Returns the name of the token.

    Returns Promise<string>

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

    • Optionalvalue: string

      The amount to send to the contract

    • OptionalgasLimit: number

      The amount of gas units allowed

    • OptionalgasPrice: number

      The satoshi price per gas

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

    see Result

symbol

  • symbol(): Promise<string>

  • Returns the symbol of the token.

    Returns Promise<string>

totalSupply

  • totalSupply(): Promise<bigint>

  • Returns the amount of tokens in existence.

    Returns Promise<bigint>

transfer

  • transfer(recipient, amount, gasLimit?): Promise<Transaction>

  • Moves amount tokens from the caller's account to recipient.

    Emits a Transfer event.

    Parameters

    • recipient: string
    • amount: bigint
    • gasLimit: undefined | number = 250000

    Returns Promise<Transaction>

transferFrom

  • transferFrom(sender, recipient, amount, gasLimit?): 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
    • gasLimit: undefined | number = 250000

    Returns Promise<Transaction>

withdraw

  • withdraw(amount, gasLimit?): Promise<Transaction>

  • Destroys amount tokens from the caller witdrawing the amount from the contract's MRX balance.

    Parameters

    • amount: bigint
    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

Settings

Member Visibility

On This Page

Constructors
Properties
Methods