Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenLockingClient

Hierarchy

  • TokenLocking
    • TokenLockingClient

Indexable

[name: string]: ContractFunction | any

Index

Constructors

constructor

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

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

    Returns TokenLockingClient

Properties

address

address: string

addressPromise

addressPromise: Promise<string>

clientType

clientType: TokenLockingClient

deployTransaction

deployTransaction: TransactionResponse

estimate

estimate: { authority: any; deposit: any; getColonyNetwork: any; getTotalLockCount: any; getUserLock: any; incrementLockCounterTo: any; lockToken: any; owner: any; punishStakers: any; setAuthority: any; setColonyNetwork: any; setOwner: any; unlockTokenForUser: any; withdraw: any }

Type declaration

  • authority: function
    • authority(): Promise<BigNumber>
  • deposit: function
    • deposit(_token: string, _amount: BigNumberish): Promise<BigNumber>
  • getColonyNetwork: function
    • getColonyNetwork(): Promise<BigNumber>
  • getTotalLockCount: function
    • getTotalLockCount(_token: string): Promise<BigNumber>
  • getUserLock: function
    • getUserLock(_token: string, _user: string): Promise<BigNumber>
  • incrementLockCounterTo: function
    • incrementLockCounterTo(_token: string, _lockId: BigNumberish): Promise<BigNumber>
  • lockToken: function
    • lockToken(_token: string): Promise<BigNumber>
  • owner: function
    • owner(): Promise<BigNumber>
  • punishStakers: function
    • punishStakers(_stakers: string[], _beneficiary: string, _amount: BigNumberish): Promise<BigNumber>
  • setAuthority: function
    • setAuthority(authority_: string): Promise<BigNumber>
  • setColonyNetwork: function
    • setColonyNetwork(_colonyNetwork: string): Promise<BigNumber>
  • setOwner: function
    • setOwner(owner_: string): Promise<BigNumber>
  • unlockTokenForUser: function
    • unlockTokenForUser(_token: string, _user: string, _lockId: BigNumberish): Promise<BigNumber>
  • withdraw: function
    • withdraw(_token: string, _amount: BigNumberish): Promise<BigNumber>

filters

filters: { ColonyNetworkSet: any; LogSetAuthority: any; LogSetOwner: any; ReputationMinerPenalised: any; TokenLocked: any; UserTokenDeposited: any; UserTokenUnlocked: any; UserTokenWithdrawn: any }

Type declaration

  • ColonyNetworkSet: function
    • ColonyNetworkSet(colonyNetwork: null): EventFilter
  • LogSetAuthority: function
    • LogSetAuthority(authority: string | null): EventFilter
  • LogSetOwner: function
    • LogSetOwner(owner: string | null): EventFilter
  • ReputationMinerPenalised: function
    • ReputationMinerPenalised(miner: null, beneficiary: null, tokensLost: null): EventFilter
  • TokenLocked: function
    • TokenLocked(token: null, lockCount: null): EventFilter
  • UserTokenDeposited: function
    • UserTokenDeposited(token: null, user: null, amount: null, timestamp: null): EventFilter
  • UserTokenUnlocked: function
    • UserTokenUnlocked(token: null, user: null, lockId: null): EventFilter
  • UserTokenWithdrawn: function
    • UserTokenWithdrawn(token: null, user: null, amount: null): EventFilter

functions

functions: { authority: any; deposit: any; getColonyNetwork: any; getTotalLockCount: any; getUserLock: any; incrementLockCounterTo: any; lockToken: any; owner: any; punishStakers: any; setAuthority: any; setColonyNetwork: any; setOwner: any; unlockTokenForUser: any; withdraw: any }

Type declaration

interface

interface: TokenLockingInterface

provider

provider: Provider

signer

signer: Signer

Methods

_deployed

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

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

addListener

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

attach

  • attach(addressOrName: string): TokenLocking

authority

  • authority(): Promise<string>

connect

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

deployed

  • deployed(): Promise<TokenLocking>

deposit

  • deposit(_token: string, _amount: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

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>

getColonyNetwork

  • getColonyNetwork(): Promise<string>

getTotalLockCount

  • getTotalLockCount(_token: string): Promise<BigNumber>

getUserLock

  • getUserLock(_token: string, _user: string): Promise<{ 0: BigNumber; 1: BigNumber; 2: BigNumber; balance: BigNumber; lockCount: BigNumber; timestamp: BigNumber }>

incrementLockCounterTo

  • incrementLockCounterTo(_token: string, _lockId: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

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>

lockToken

on

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

once

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

owner

  • owner(): Promise<string>

punishStakers

  • punishStakers(_stakers: string[], _beneficiary: string, _amount: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

removeAllListeners

  • removeAllListeners(eventName: EventFilter | string): TokenLocking

removeListener

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

setAuthority

setColonyNetwork

  • setColonyNetwork(_colonyNetwork: string, overrides?: TransactionOverrides): Promise<ContractTransaction>

setOwner

unlockTokenForUser

  • unlockTokenForUser(_token: string, _user: string, _lockId: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

withdraw

  • withdraw(_token: string, _amount: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

Static isIndexed

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

    • value: any

    Returns value is Indexed

Generated using TypeDoc