Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ERC20

Hierarchy

  • BaseContract
    • ERC20

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ERC20(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): Contracts.ERC20

  • Parameters

    • addressOrName: string
    • contractInterface: ContractInterface
    • Optional signerOrProvider: Signer | Provider

    Returns Contracts.ERC20

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

  • [eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

  • [eventTag: string]: (...args: any[]) => void
      • (...args: any[]): void

      • Parameters

        • Rest ...args: any[]

        Returns void

Readonly address

address: string

callStatic

callStatic: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<number>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • name:function
    • name(overrides?: CallOverrides): Promise<string>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<string>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<BigNumber>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>
  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<BigNumber>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • spender: string
      • addedValue: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • name:function
    • name(overrides?: CallOverrides): Promise<BigNumber>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<BigNumber>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<BigNumber>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • recipient: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Parameters

      • sender: string
      • recipient: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

filters

filters: { Approval: any; Approval(address,address,uint256): any; Transfer: any; Transfer(address,address,uint256): any }

Type declaration

  • Approval:function
    • Approval(owner?: string, spender?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

    • Parameters

      • Optional owner: string
      • Optional spender: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

  • Approval(address,address,uint256):function
    • Approval(address,address,uint256)(owner?: string, spender?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

    • Parameters

      • Optional owner: string
      • Optional spender: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { owner: string; spender: string; value: BigNumber }>

  • Transfer:function
    • Transfer(from?: string, to?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

    • Parameters

      • Optional from: string
      • Optional to: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

  • Transfer(address,address,uint256):function
    • Transfer(address,address,uint256)(from?: string, to?: string, value?: null): TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

    • Parameters

      • Optional from: string
      • Optional to: string
      • Optional value: null

      Returns TypedEventFilter<[string, string, BigNumber], { from: string; to: string; value: BigNumber }>

functions

functions: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<[BigNumber]>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<[BigNumber]>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<[number]>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • spender: string
      • addedValue: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • name:function
    • name(overrides?: CallOverrides): Promise<[string]>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<[string]>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<[BigNumber]>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • recipient: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Parameters

      • sender: string
      • recipient: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

interface

interface: ERC20Interface

populateTransaction

populateTransaction: { allowance: any; approve: any; balanceOf: any; decimals: any; decreaseAllowance: any; increaseAllowance: any; name: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any }

Type declaration

  • allowance:function
    • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • approve:function
    • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • balanceOf:function
    • balanceOf(account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
  • decimals:function
    • decimals(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • decreaseAllowance:function
    • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • increaseAllowance:function
    • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • spender: string
      • addedValue: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • name:function
    • name(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • symbol:function
    • symbol(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • totalSupply:function
    • totalSupply(overrides?: CallOverrides): Promise<PopulatedTransaction>
  • transfer:function
    • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • recipient: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • transferFrom:function
    • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Parameters

      • sender: string
      • recipient: string
      • amount: BigNumberish
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

  • _checkRunningEvents(runningEvent: RunningEvent): void

  • Parameters

    • runningEvent: RunningEvent

    Returns void

_deployed

  • _deployed(blockTag?: BlockTag): Promise<Contract>

  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

_wrapEvent

  • _wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

  • Parameters

    • runningEvent: RunningEvent
    • log: Log
    • listener: Listener

    Returns Event

allowance

  • allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>

approve

  • approve(spender: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

attach

balanceOf

  • balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>

connect

  • connect(signerOrProvider: string | Signer | Provider): Contracts.ERC20

decimals

  • decimals(overrides?: CallOverrides): Promise<number>

decreaseAllowance

  • decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • subtractedValue: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

deployed

emit

  • emit(eventName: string | EventFilter, ...args: any[]): boolean

  • Parameters

    • eventName: string | EventFilter
    • Rest ...args: any[]

    Returns boolean

fallback

  • fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

increaseAllowance

  • increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • addedValue: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

listenerCount

  • listenerCount(eventName?: string | EventFilter): number

  • Parameters

    • Optional eventName: string | EventFilter

    Returns number

listeners

  • listeners<EventArgsArray, EventArgsObject>(eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>): TypedListener<EventArgsArray, EventArgsObject>[]
  • listeners(eventName?: string): Listener[]

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • Optional eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>

    Returns TypedListener<EventArgsArray, EventArgsObject>[]

  • Parameters

    • Optional eventName: string

    Returns Listener[]

name

  • name(overrides?: CallOverrides): Promise<string>

off

  • off<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Contracts.ERC20
  • off(eventName: string, listener: Listener): Contracts.ERC20

on

  • on<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Contracts.ERC20
  • on(eventName: string, listener: Listener): Contracts.ERC20

once

  • once<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Contracts.ERC20
  • once(eventName: string, listener: Listener): Contracts.ERC20

queryFilter

  • queryFilter<EventArgsArray, EventArgsObject>(event: TypedEventFilter<EventArgsArray, EventArgsObject>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • event: TypedEventFilter<EventArgsArray, EventArgsObject>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

removeAllListeners

  • removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>): Contracts.ERC20
  • removeAllListeners(eventName?: string): Contracts.ERC20

removeListener

  • removeListener<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Contracts.ERC20
  • removeListener(eventName: string, listener: Listener): Contracts.ERC20

symbol

  • symbol(overrides?: CallOverrides): Promise<string>

totalSupply

  • totalSupply(overrides?: CallOverrides): Promise<BigNumber>

transfer

  • transfer(recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • recipient: string
    • amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

transferFrom

  • transferFrom(sender: string, recipient: string, amount: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Parameters

    • sender: string
    • recipient: string
    • amount: BigNumberish
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

Static getContractAddress

  • getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

  • Parameters

    • transaction: { from: string; nonce: BigNumberish }
      • from: string
      • nonce: BigNumberish

    Returns string

Static getInterface

  • getInterface(contractInterface: ContractInterface): Interface

  • Parameters

    • contractInterface: ContractInterface

    Returns Interface

Static isIndexed

  • isIndexed(value: any): value is Indexed

  • Parameters

    • value: any

    Returns value is Indexed

Generated using TypeDoc