Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ColonyTokenClient

The TokenClient is a good client that does awesome things

Hierarchy

  • Token
    • ColonyTokenClient

Indexable

[name: string]: ContractFunction | any

The TokenClient is a good client that does awesome things

Index

Constructors

constructor

  • new ColonyTokenClient(addressOrName: string, contractInterface: Array<string | FunctionFragment | EventFragment | ParamType> | string | Interface, signerOrProvider: Signer | Provider): ColonyTokenClient
  • Parameters

    • addressOrName: string
    • contractInterface: Array<string | FunctionFragment | EventFragment | ParamType> | string | Interface
    • signerOrProvider: Signer | Provider

    Returns ColonyTokenClient

Properties

address

address: string

addressPromise

addressPromise: Promise<string>

clientType

clientType: TokenClient

deployTransaction

deployTransaction: TransactionResponse

estimate

estimate: { allowance: any; approve: any; authority: any; balanceOf: any; burn: any; decimals: any; locked: any; mint: any; name: any; owner: any; setAuthority: any; setOwner: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any; unlock: any }

Type declaration

filters

filters: { Approval: any; Burn: any; LogSetAuthority: any; LogSetOwner: any; Mint: any; Transfer: any }

Type declaration

  • Approval: function
    • Approval(src: string | null, guy: string | null, wad: null): EventFilter
  • Burn: function
    • Burn(guy: string | null, wad: null): EventFilter
  • LogSetAuthority: function
    • LogSetAuthority(authority: string | null): EventFilter
  • LogSetOwner: function
    • LogSetOwner(owner: string | null): EventFilter
  • Mint: function
    • Mint(guy: string | null, wad: null): EventFilter
  • Transfer: function
    • Transfer(src: string | null, dst: string | null, wad: null): EventFilter

functions

functions: { allowance: any; approve: any; authority: any; balanceOf: any; burn(address,uint256): any; burn(uint256): any; decimals: any; locked: any; mint(address,uint256): any; mint(uint256): any; name: any; owner: any; setAuthority: any; setOwner: any; symbol: any; totalSupply: any; transfer: any; transferFrom: any; unlock: any }

Type declaration

interface

interface: TokenInterface

provider

provider: Provider

signer

signer: Signer

tokenClientType

tokenClientType: Colony

Methods

_deployed

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

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

addListener

  • addListener(eventName: EventFilter | string, listener: Listener): Token

allowance

  • allowance(src: string, guy: string): Promise<BigNumber>

approve

  • approve(guy: string, wad: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

attach

  • attach(addressOrName: string): Token

authority

  • authority(): Promise<string>

balanceOf

  • balanceOf(src: string): Promise<BigNumber>

burn(address,uint256)

  • burn(address,uint256)(guy: string, wad: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

burn(uint256)

connect

  • connect(signerOrProvider: Signer | Provider | string): Token

decimals

  • decimals(): Promise<number>

deployed

  • deployed(): Promise<Token>

emit

  • emit(eventName: EventFilter | string, ...args: Array<any>): boolean
  • Parameters

    • eventName: EventFilter | string
    • Rest ...args: Array<any>

    Returns boolean

fallback

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

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

getTokenInfo

  • getTokenInfo(): Promise<TokenInfo>

listenerCount

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

    • Optional eventName: EventFilter | string

    Returns number

listeners

  • listeners(eventName: EventFilter | string): Array<Listener>
  • Parameters

    • eventName: EventFilter | string

    Returns Array<Listener>

locked

  • locked(): Promise<boolean>

mint(address,uint256)

  • mint(address,uint256)(guy: string, wad: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

mint(uint256)

name

  • name(): Promise<string>

on

  • on(event: EventFilter | string, listener: Listener): Token

once

  • once(event: EventFilter | string, listener: Listener): Token

owner

  • owner(): Promise<string>

removeAllListeners

  • removeAllListeners(eventName: EventFilter | string): Token

removeListener

  • removeListener(eventName: any, listener: Listener): Token

setAuthority

setOwner

symbol

  • symbol(): Promise<string>

totalSupply

  • totalSupply(): Promise<BigNumber>

transfer

  • transfer(dst: string, wad: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

transferFrom

  • transferFrom(src: string, dst: string, wad: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

unlock

Static isIndexed

  • isIndexed(value: any): value is Indexed
  • Parameters

    • value: any

    Returns value is Indexed

Generated using TypeDoc