Skip to main content

Interface: ColonyTokenClient

A ColonyToken has special abilities that go beyond the capabilities of an ERC20 token

Extends​

Properties​

_deployedPromise​

_deployedPromise: Promise\<Contract>

Inherited from​

ColonyToken._deployedPromise

_runningEvents​

_runningEvents: object

Index Signature​

[eventTag: string]: RunningEvent

Inherited from​

ColonyToken._runningEvents

_wrappedEmits​

_wrappedEmits: object

Index Signature​

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

Inherited from​

ColonyToken._wrappedEmits

address​

readonly address: string

Inherited from​

ColonyToken.address

callStatic​

callStatic: object

allowance()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

allowance(address,address)()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

approve()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

approve(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

authority()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

authority()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

balanceOf()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

balanceOf(address)()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

burn(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<void>

burn(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<void>

decimals()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<number>

decimals()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<number>

DOMAIN_SEPARATOR()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

DOMAIN_SEPARATOR()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

executeMetaTransaction()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<string>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<string>

getMetatransactionNonce()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

getMetatransactionNonce(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

locked()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<boolean>

locked()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<boolean>

mint(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<void>

mint(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<void>

name()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

name()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

nonces()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

nonces(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

owner()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

owner()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

permit()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

CallOverrides

Returns​

Promise\<void>

PERMIT_TYPEHASH()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

PERMIT_TYPEHASH()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

CallOverrides

Returns​

Promise\<void>

setAuthority()​

Parameters​
authority_​

string

overrides?​

CallOverrides

Returns​

Promise\<void>

setAuthority(address)()​

Parameters​
authority_​

string

overrides?​

CallOverrides

Returns​

Promise\<void>

setOwner()​

Parameters​
owner_​

string

overrides?​

CallOverrides

Returns​

Promise\<void>

setOwner(address)()​

Parameters​
owner_​

string

overrides?​

CallOverrides

Returns​

Promise\<void>

symbol()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

symbol()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<string>

totalSupply()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

totalSupply()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

transfer()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

transfer(address,uint256)()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

transferFrom()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

transferFrom(address,address,uint256)()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

unlock()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<void>

unlock()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<void>

verify()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

Inherited from​

ColonyToken.callStatic

clientType​

clientType: TokenClient

deployTransaction​

readonly deployTransaction: TransactionResponse

Inherited from​

ColonyToken.deployTransaction

estimateGas​

estimateGas: object

allowance()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

allowance(address,address)()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

approve()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

approve(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

authority()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

authority()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

balanceOf()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

balanceOf(address)()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

burn(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

burn(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

decimals()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

decimals()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

DOMAIN_SEPARATOR()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

DOMAIN_SEPARATOR()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

executeMetaTransaction()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<BigNumber>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<BigNumber>

getMetatransactionNonce()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

getMetatransactionNonce(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

locked()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

locked()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

mint(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

mint(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

name()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

name()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

nonces()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

nonces(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

owner()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

owner()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

permit()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

PERMIT_TYPEHASH()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

PERMIT_TYPEHASH()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

setAuthority()​

Parameters​
authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

setAuthority(address)()​

Parameters​
authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

setOwner()​

Parameters​
owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

setOwner(address)()​

Parameters​
owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

symbol()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

symbol()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

totalSupply()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

totalSupply()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

transfer()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

transfer(address,uint256)()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

transferFrom()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

transferFrom(address,address,uint256)()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

unlock()​

Parameters​
overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

unlock()()​

Parameters​
overrides?​

Overrides & object

Returns​

Promise\<BigNumber>

verify()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.estimateGas

filters​

filters: object

Approval()​

Parameters​
src?​

null | string

guy?​

null | string

wad?​

null

Returns​

ApprovalEventFilter

Approval(address,address,uint256)()​

Parameters​
src?​

null | string

guy?​

null | string

wad?​

null

Returns​

ApprovalEventFilter

Burn()​

Parameters​
guy?​

null | string

wad?​

null

Returns​

BurnEventFilter

Burn(address,uint256)()​

Parameters​
guy?​

null | string

wad?​

null

Returns​

BurnEventFilter

LogSetAuthority()​

Parameters​
authority?​

null | string

Returns​

LogSetAuthorityEventFilter

LogSetAuthority(address)()​

Parameters​
authority?​

null | string

Returns​

LogSetAuthorityEventFilter

LogSetOwner()​

Parameters​
owner?​

null | string

Returns​

LogSetOwnerEventFilter

LogSetOwner(address)()​

Parameters​
owner?​

null | string

Returns​

LogSetOwnerEventFilter

MetaTransactionExecuted()​

Parameters​
userAddress?​

null

relayerAddress?​

null

payload?​

null

Returns​

MetaTransactionExecutedEventFilter

MetaTransactionExecuted(address,address,bytes)()​

Parameters​
userAddress?​

null

relayerAddress?​

null

payload?​

null

Returns​

MetaTransactionExecutedEventFilter

Mint()​

Parameters​
guy?​

null | string

wad?​

null

Returns​

MintEventFilter

Mint(address,uint256)()​

Parameters​
guy?​

null | string

wad?​

null

Returns​

MintEventFilter

Transfer()​

Parameters​
src?​

null | string

dst?​

null | string

wad?​

null

Returns​

TransferEventFilter

Transfer(address,address,uint256)()​

Parameters​
src?​

null | string

dst?​

null | string

wad?​

null

Returns​

TransferEventFilter

Inherited from​

ColonyToken.filters

functions​

functions: object

allowance()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber]>

allowance(address,address)()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber]>

approve()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

approve(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

authority()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

authority()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

balanceOf()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber]>

balanceOf(address)()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber]>

burn(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

burn(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

decimals()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[number]>

decimals()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[number]>

DOMAIN_SEPARATOR()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

DOMAIN_SEPARATOR()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

executeMetaTransaction()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<ContractTransaction>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<ContractTransaction>

getMetatransactionNonce()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber] & object>

getMetatransactionNonce(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber] & object>

locked()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[boolean]>

locked()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[boolean]>

mint(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

mint(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

name()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

name()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

nonces()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber] & object>

nonces(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<[BigNumber] & object>

owner()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

owner()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

permit()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

PERMIT_TYPEHASH()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

PERMIT_TYPEHASH()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

setAuthority()​

Parameters​
authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

setAuthority(address)()​

Parameters​
authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

setOwner()​

Parameters​
owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

setOwner(address)()​

Parameters​
owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

symbol()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

symbol()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[string]>

totalSupply()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[BigNumber]>

totalSupply()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<[BigNumber]>

transfer()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

transfer(address,uint256)()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

transferFrom()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

transferFrom(address,address,uint256)()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

unlock()​

Parameters​
overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

unlock()()​

Parameters​
overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

verify()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<[boolean]>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<[boolean]>

Inherited from​

ColonyToken.functions

interface​

interface: MetaTxTokenInterface

Inherited from​

ColonyToken.interface

off​

off: OnEvent\<ColonyTokenClient>

Inherited from​

ColonyToken.off

on​

on: OnEvent\<ColonyTokenClient>

Inherited from​

ColonyToken.on

once​

once: OnEvent\<ColonyTokenClient>

Inherited from​

ColonyToken.once

populateTransaction​

populateTransaction: object

allowance()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

allowance(address,address)()​

Parameters​
src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

approve()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

approve(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

authority()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

authority()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

balanceOf()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

balanceOf(address)()​

Parameters​
src​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

burn(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

burn(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

decimals()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

decimals()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

DOMAIN_SEPARATOR()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

DOMAIN_SEPARATOR()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

executeMetaTransaction()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<PopulatedTransaction>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<PopulatedTransaction>

getMetatransactionNonce()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

getMetatransactionNonce(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

locked()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

locked()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

mint(address,uint256)()​

Parameters​
guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

mint(uint256)()​

Parameters​
wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

name()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

name()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

nonces()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

nonces(address)()​

Parameters​
_user​

string

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

owner()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

owner()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

permit()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

PERMIT_TYPEHASH()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

PERMIT_TYPEHASH()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)()​

Parameters​
owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

setAuthority()​

Parameters​
authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

setAuthority(address)()​

Parameters​
authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

setOwner()​

Parameters​
owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

setOwner(address)()​

Parameters​
owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

symbol()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

symbol()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

totalSupply()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

totalSupply()()​

Parameters​
overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

transfer()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

transfer(address,uint256)()​

Parameters​
dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

transferFrom()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

transferFrom(address,address,uint256)()​

Parameters​
src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

unlock()​

Parameters​
overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

unlock()()​

Parameters​
overrides?​

Overrides & object

Returns​

Promise\<PopulatedTransaction>

verify()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()​

Parameters​
_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<PopulatedTransaction>

Inherited from​

ColonyToken.populateTransaction

provider​

readonly provider: Provider

Inherited from​

ColonyToken.provider

removeListener​

removeListener: OnEvent\<ColonyTokenClient>

Inherited from​

ColonyToken.removeListener

resolvedAddress​

readonly resolvedAddress: Promise\<string>

Inherited from​

ColonyToken.resolvedAddress

signer​

readonly signer: Signer

Inherited from​

ColonyToken.signer

tokenClientType​

tokenClientType: Colony

Methods​

_checkRunningEvents()​

_checkRunningEvents(runningEvent): void

Parameters​

runningEvent​

RunningEvent

Returns​

void

Inherited from​

ColonyToken._checkRunningEvents

_deployed()​

_deployed(blockTag?): Promise\<Contract>

Parameters​

blockTag?​

BlockTag

Returns​

Promise\<Contract>

Inherited from​

ColonyToken._deployed

_wrapEvent()​

_wrapEvent(runningEvent, log, listener): Event

Parameters​

runningEvent​

RunningEvent

log​

Log

listener​

Listener

Returns​

Event

Inherited from​

ColonyToken._wrapEvent

allowance()​

allowance(src, guy, overrides?): Promise\<BigNumber>

Parameters​

src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.allowance

allowance(address,address)()​

allowance(address,address)(src, guy, overrides?): Promise\<BigNumber>

Parameters​

src​

string

guy​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.allowance(address,address)

approve()​

approve(guy, wad, overrides?): Promise\<ContractTransaction>

Parameters​

guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.approve

approve(address,uint256)()​

approve(address,uint256)(guy, wad, overrides?): Promise\<ContractTransaction>

Parameters​

guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.approve(address,uint256)

attach()​

attach(addressOrName): this

Parameters​

addressOrName​

string

Returns​

this

Inherited from​

ColonyToken.attach

authority()​

authority(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.authority

authority()()​

authority()(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.authority()

balanceOf()​

balanceOf(src, overrides?): Promise\<BigNumber>

Parameters​

src​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.balanceOf

balanceOf(address)()​

balanceOf(address)(src, overrides?): Promise\<BigNumber>

Parameters​

src​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.balanceOf(address)

burn(address,uint256)()​

burn(address,uint256)(guy, wad, overrides?): Promise\<ContractTransaction>

Parameters​

guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.burn(address,uint256)

burn(uint256)()​

burn(uint256)(wad, overrides?): Promise\<ContractTransaction>

Parameters​

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.burn(uint256)

connect()​

connect(signerOrProvider): this

Parameters​

signerOrProvider​

string | Signer | Provider

Returns​

this

Inherited from​

ColonyToken.connect

decimals()​

decimals(overrides?): Promise\<number>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<number>

Inherited from​

ColonyToken.decimals

decimals()()​

decimals()(overrides?): Promise\<number>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<number>

Inherited from​

ColonyToken.decimals()

deployed()​

deployed(): Promise\<ColonyTokenClient>

Returns​

Promise\<ColonyTokenClient>

Inherited from​

ColonyToken.deployed

DOMAIN_SEPARATOR()​

DOMAIN_SEPARATOR(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.DOMAIN_SEPARATOR

DOMAIN_SEPARATOR()()​

DOMAIN_SEPARATOR()(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.DOMAIN_SEPARATOR()

emit()​

emit(eventName, ...args): boolean

Parameters​

eventName​

string | EventFilter

args​

...any[]

Returns​

boolean

Inherited from​

ColonyToken.emit

executeMetaTransaction()​

executeMetaTransaction(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<ContractTransaction>

Parameters​

_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.executeMetaTransaction

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()​

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<ContractTransaction>

Parameters​

_user​

string

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

PayableOverrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)

fallback()​

fallback(overrides?): Promise\<TransactionResponse>

Parameters​

overrides?​

TransactionRequest

Returns​

Promise\<TransactionResponse>

Inherited from​

ColonyToken.fallback

getMetatransactionNonce()​

getMetatransactionNonce(_user, overrides?): Promise\<BigNumber>

Parameters​

_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.getMetatransactionNonce

getMetatransactionNonce(address)()​

getMetatransactionNonce(address)(_user, overrides?): Promise\<BigNumber>

Parameters​

_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.getMetatransactionNonce(address)

listenerCount()​

listenerCount(eventName?): number

Parameters​

eventName?​

string | EventFilter

Returns​

number

Inherited from​

ColonyToken.listenerCount

listeners()​

Call Signature​

listeners\<TEvent>(eventFilter?): TypedListener\<TEvent>[]

Type Parameters​

• TEvent extends TypedEvent

Parameters​
eventFilter?​

TypedEventFilter\<TEvent>

Returns​

TypedListener\<TEvent>[]

Inherited from​

ColonyToken.listeners

Call Signature​

listeners(eventName?): Listener[]

Parameters​
eventName?​

string

Returns​

Listener[]

Inherited from​

ColonyToken.listeners

locked()​

locked(overrides?): Promise\<boolean>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<boolean>

Inherited from​

ColonyToken.locked

locked()()​

locked()(overrides?): Promise\<boolean>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<boolean>

Inherited from​

ColonyToken.locked()

mint(address,uint256)()​

mint(address,uint256)(guy, wad, overrides?): Promise\<ContractTransaction>

Parameters​

guy​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.mint(address,uint256)

mint(uint256)()​

mint(uint256)(wad, overrides?): Promise\<ContractTransaction>

Parameters​

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.mint(uint256)

name()​

name(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.name

name()()​

name()(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.name()

nonces()​

nonces(_user, overrides?): Promise\<BigNumber>

Parameters​

_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.nonces

nonces(address)()​

nonces(address)(_user, overrides?): Promise\<BigNumber>

Parameters​

_user​

string

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.nonces(address)

owner()​

owner(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.owner

owner()()​

owner()(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.owner()

permit()​

permit(owner, spender, value, deadline, v, r, s, overrides?): Promise\<ContractTransaction>

Parameters​

owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.permit

PERMIT_TYPEHASH()​

PERMIT_TYPEHASH(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.PERMIT_TYPEHASH

PERMIT_TYPEHASH()()​

PERMIT_TYPEHASH()(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.PERMIT_TYPEHASH()

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)()​

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)(owner, spender, value, deadline, v, r, s, overrides?): Promise\<ContractTransaction>

Parameters​

owner​

string

spender​

string

value​

BigNumberish

deadline​

BigNumberish

v​

BigNumberish

r​

BytesLike

s​

BytesLike

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.permit(address,address,uint256,uint256,uint8,bytes32,bytes32)

queryFilter()​

queryFilter\<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise\<TEvent[]>

Type Parameters​

• TEvent extends TypedEvent

Parameters​

event​

TypedEventFilter\<TEvent>

fromBlockOrBlockhash?​

string | number

toBlock?​

string | number

Returns​

Promise\<TEvent[]>

Inherited from​

ColonyToken.queryFilter

removeAllListeners()​

Call Signature​

removeAllListeners\<TEvent>(eventFilter): this

Type Parameters​

• TEvent extends TypedEvent

Parameters​
eventFilter​

TypedEventFilter\<TEvent>

Returns​

this

Inherited from​

ColonyToken.removeAllListeners

Call Signature​

removeAllListeners(eventName?): this

Parameters​
eventName?​

string

Returns​

this

Inherited from​

ColonyToken.removeAllListeners

setAuthority()​

setAuthority(authority_, overrides?): Promise\<ContractTransaction>

Parameters​

authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.setAuthority

setAuthority(address)()​

setAuthority(address)(authority_, overrides?): Promise\<ContractTransaction>

Parameters​

authority_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.setAuthority(address)

setOwner()​

setOwner(owner_, overrides?): Promise\<ContractTransaction>

Parameters​

owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.setOwner

setOwner(address)()​

setOwner(address)(owner_, overrides?): Promise\<ContractTransaction>

Parameters​

owner_​

string

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.setOwner(address)

symbol()​

symbol(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.symbol

symbol()()​

symbol()(overrides?): Promise\<string>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<string>

Inherited from​

ColonyToken.symbol()

totalSupply()​

totalSupply(overrides?): Promise\<BigNumber>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.totalSupply

totalSupply()()​

totalSupply()(overrides?): Promise\<BigNumber>

Parameters​

overrides?​

CallOverrides

Returns​

Promise\<BigNumber>

Inherited from​

ColonyToken.totalSupply()

transfer()​

transfer(dst, wad, overrides?): Promise\<ContractTransaction>

Parameters​

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.transfer

transfer(address,uint256)()​

transfer(address,uint256)(dst, wad, overrides?): Promise\<ContractTransaction>

Parameters​

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.transfer(address,uint256)

transferFrom()​

transferFrom(src, dst, wad, overrides?): Promise\<ContractTransaction>

Parameters​

src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.transferFrom

transferFrom(address,address,uint256)()​

transferFrom(address,address,uint256)(src, dst, wad, overrides?): Promise\<ContractTransaction>

Parameters​

src​

string

dst​

string

wad​

BigNumberish

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.transferFrom(address,address,uint256)

unlock()​

unlock(overrides?): Promise\<ContractTransaction>

Parameters​

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.unlock

unlock()()​

unlock()(overrides?): Promise\<ContractTransaction>

Parameters​

overrides?​

Overrides & object

Returns​

Promise\<ContractTransaction>

Inherited from​

ColonyToken.unlock()

verify()​

verify(_user, _nonce, _chainId, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<boolean>

Parameters​

_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

Inherited from​

ColonyToken.verify

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()​

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)(_user, _nonce, _chainId, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<boolean>

Parameters​

_user​

string

_nonce​

BigNumberish

_chainId​

BigNumberish

_payload​

BytesLike

_sigR​

BytesLike

_sigS​

BytesLike

_sigV​

BigNumberish

overrides?​

CallOverrides

Returns​

Promise\<boolean>

Inherited from​

ColonyToken.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)