Class ERC777

Basic representation of an ERC777 compatible contract. If additional functionality is required, this contract can be extended via inheritance

Hierarchy

Constructors

constructor

Accessors

address contract

Methods

allowance approve authorizeOperator balanceOf balanceOfBatch burn call connect decimals defaultOperators granularity isOperatorFor name operatorBurn operatorSend retryCall revokeOperator send supportsInterface symbol tokenMetadata totalSupply transfer transferFrom

Constructors

constructor

Accessors

address

  • get address(): string

  • Returns the contract address

    Returns string

contract

  • get contract(): Contract

  • Returns the underlying contract interface

    Returns Contract

Methods

allowance

  • Returns the amount which spender is still allowed to withdraw from owner.

    Parameters

    • owner: string
    • spender: string

    Returns Promise<BigNumber>

approve

  • Allows spender to withdraw from your account multiple times, up to the value amount

    Parameters

    • spender: string
    • value: BigNumberish = MaxApproval
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

authorizeOperator

  • Set a third party operator address as an operator of msg.sender to send and burn tokens on its behalf.

    Parameters

    • operator: string
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

balanceOf

  • Returns the account balance of another account with address owner.

    Parameters

    • owner: string

    Returns Promise<BigNumber>

balanceOfBatch

  • Returns the balances for each of the provided accounts

    Parameters

    • owners: string[]

    Returns Promise<{
        balance: BigNumber;
        owner: string;
    }[]>

burn

  • Burn the amount of tokens from the address msg.sender.

    Parameters

    • amount: BigNumberish
    • data: string
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

call

  • Returns an interface allowing for us with the multicall method of a provider

    Parameters

    • name: string
    • Rest ...params: any[]

    Returns ContractCall

connect

decimals

  • Returns the number of decimals the token uses - e.g. 8, means to divide the token amount by 100000000 to get its user representation.

    Returns Promise<number>

defaultOperators

  • Get the list of default operators as defined by the token contract.

    Returns Promise<string[]>

granularity

  • Get the smallest part of the token that’s not divisible.

    In other words, the granularity is the smallest amount of tokens (in the internal denomination) which MAY be minted, sent or burned at any time.

    Returns Promise<BigNumber>

isOperatorFor

  • Indicate whether the operator address is an operator of the holder address.

    Parameters

    • operator: string
    • holder: string

    Returns Promise<boolean>

name

  • Returns the name of the token - e.g. "MyToken".

    Returns Promise<string>

operatorBurn

  • Burn the amount of tokens on behalf of the address from.

    Parameters

    • from: string
    • amount: BigNumberish
    • data: string
    • operatorData: string
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

operatorSend

  • Send the amount of tokens on behalf of the address from to the address to.

    Reminder: If the operator address is not an authorized operator of the from address, then the send process MUST revert.

    Parameters

    • from: string
    • to: string
    • amount: BigNumberish
    • data: string
    • operatorData: string
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

Protected retryCall

  • Protected

    Automatically keeps trying the call unless we get a revert exception

    Type Parameters

    • T

    Parameters

    • func: ((...args) => Promise<T>)
        • (...args): Promise<T>

        • Parameters

          • Rest ...args: any[]

          Returns Promise<T>

    • Rest ...params: any[]

    Returns Promise<T>

revokeOperator

  • Remove the right of the operator address to be an operator for msg.sender and to send and burn tokens on its behalf.

    Parameters

    • operator: string
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

send

  • Send the amount of tokens from the address msg.sender to the address to.

    Parameters

    • to: string
    • amount: BigNumberish
    • data: string
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

supportsInterface

  • Returns whether the specified interface is supported by the contract

    Parameters

    • interfaceId: string

    Returns Promise<boolean>

symbol

  • Returns the symbol of the token. E.g. “HIX”.

    Returns Promise<string>

tokenMetadata

  • Return the metadata of the token

    Returns Promise<{
        address: string;
        decimals: number;
        name: string;
        symbol: string;
        totalSupply: BigNumber;
    }>

totalSupply

  • Returns the total token supply

    Returns Promise<BigNumber>

transfer

  • Transfers value amount of tokens to address to

    Parameters

    • to: string
    • value: BigNumberish
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

transferFrom

  • Transfers value amount of tokens from address from to address to

    Parameters

    • from: string
    • to: string
    • value: BigNumberish
    • overrides: CallOverrides = {}

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page