Interface: Token

Hierarchy

• BaseContract

  ↳ Token

  ↳↳ LegacyColonyTokenClient

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

BaseContract._deployedPromise

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

BaseContract._runningEvents

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

BaseContract._wrappedEmits

---

address

• Readonly address: string

Inherited from

BaseContract.address

---

callStatic

• callStatic: Object

Type declaration

Name	Type
allowance	(src: PromiseOrValue<string>, guy: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
approve	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
authority	(overrides?: CallOverrides) => Promise<string>
balanceOf	(src: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
burn(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
burn(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
decimals	(overrides?: CallOverrides) => Promise<number>
locked	(overrides?: CallOverrides) => Promise<boolean>
mint(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
mint(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
name	(overrides?: CallOverrides) => Promise<string>
owner	(overrides?: CallOverrides) => Promise<string>
setAuthority	(authority_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setOwner	(owner_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
symbol	(overrides?: CallOverrides) => Promise<string>
totalSupply	(overrides?: CallOverrides) => Promise<BigNumber>
transfer	(dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
transferFrom	(src: PromiseOrValue<string>, dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
unlock	(overrides?: CallOverrides) => Promise<void>

Overrides

BaseContract.callStatic

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

BaseContract.deployTransaction

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
allowance	(src: PromiseOrValue<string>, guy: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
approve	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
authority	(overrides?: CallOverrides) => Promise<BigNumber>
balanceOf	(src: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
burn(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
burn(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
decimals	(overrides?: CallOverrides) => Promise<BigNumber>
locked	(overrides?: CallOverrides) => Promise<BigNumber>
mint(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
mint(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
name	(overrides?: CallOverrides) => Promise<BigNumber>
owner	(overrides?: CallOverrides) => Promise<BigNumber>
setAuthority	(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
setOwner	(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
symbol	(overrides?: CallOverrides) => Promise<BigNumber>
totalSupply	(overrides?: CallOverrides) => Promise<BigNumber>
transfer	(dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
transferFrom	(src: PromiseOrValue<string>, dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
unlock	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

---

filters

• filters: Object

Type declaration

Name	Type
Approval	(src?: null | PromiseOrValue<string>, guy?: null | PromiseOrValue<string>, wad?: null) => ApprovalEventFilter
Approval(address,address,uint256)	(src?: null | PromiseOrValue<string>, guy?: null | PromiseOrValue<string>, wad?: null) => ApprovalEventFilter
Burn	(guy?: null | PromiseOrValue<string>, wad?: null) => BurnEventFilter
Burn(address,uint256)	(guy?: null | PromiseOrValue<string>, wad?: null) => BurnEventFilter
LogSetAuthority	(authority?: null | PromiseOrValue<string>) => LogSetAuthorityEventFilter
LogSetAuthority(address)	(authority?: null | PromiseOrValue<string>) => LogSetAuthorityEventFilter
LogSetOwner	(owner?: null | PromiseOrValue<string>) => LogSetOwnerEventFilter
LogSetOwner(address)	(owner?: null | PromiseOrValue<string>) => LogSetOwnerEventFilter
Mint	(guy?: null | PromiseOrValue<string>, wad?: null) => MintEventFilter
Mint(address,uint256)	(guy?: null | PromiseOrValue<string>, wad?: null) => MintEventFilter
Transfer	(src?: null | PromiseOrValue<string>, dst?: null | PromiseOrValue<string>, wad?: null) => TransferEventFilter
Transfer(address,address,uint256)	(src?: null | PromiseOrValue<string>, dst?: null | PromiseOrValue<string>, wad?: null) => TransferEventFilter

Overrides

BaseContract.filters

---

functions

• functions: Object

Type declaration

Name	Type
allowance	(src: PromiseOrValue<string>, guy: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber]>
approve	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
authority	(overrides?: CallOverrides) => Promise<[string]>
balanceOf	(src: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber]>
burn(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
burn(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
decimals	(overrides?: CallOverrides) => Promise<[number]>
locked	(overrides?: CallOverrides) => Promise<[boolean]>
mint(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
mint(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
name	(overrides?: CallOverrides) => Promise<[string]>
owner	(overrides?: CallOverrides) => Promise<[string]>
setAuthority	(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setOwner	(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
symbol	(overrides?: CallOverrides) => Promise<[string]>
totalSupply	(overrides?: CallOverrides) => Promise<[BigNumber]>
transfer	(dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
transferFrom	(src: PromiseOrValue<string>, dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
unlock	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

---

interface

• interface: TokenInterface

Overrides

BaseContract.interface

---

off

• off: OnEvent<Token>

Overrides

BaseContract.off

---

on

• on: OnEvent<Token>

Overrides

BaseContract.on

---

once

• once: OnEvent<Token>

Overrides

BaseContract.once

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
allowance	(src: PromiseOrValue<string>, guy: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
approve	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
authority	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
balanceOf	(src: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
burn(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
burn(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
decimals	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
locked	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
mint(address,uint256)	(guy: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
mint(uint256)	(wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
name	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority	(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setOwner	(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
symbol	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
totalSupply	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
transfer	(dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
transferFrom	(src: PromiseOrValue<string>, dst: PromiseOrValue<string>, wad: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
unlock	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

---

removeListener

• removeListener: OnEvent<Token>

Overrides

BaseContract.removeListener

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

BaseContract.resolvedAddress

---

signer

• Readonly signer: Signer

Inherited from

BaseContract.signer

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

BaseContract._checkRunningEvents

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

BaseContract._deployed

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

BaseContract._wrapEvent

---

allowance

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

Parameters

Name	Type
src	PromiseOrValue<string>
guy	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

---

approve

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

Parameters

Name	Type
guy	PromiseOrValue<string>
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

attach

▸ attach(addressOrName): Token

Parameters

Name	Type
addressOrName	string

Returns

Token

Overrides

BaseContract.attach

---

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

---

balanceOf

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

Parameters

Name	Type
src	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

---

burn(address,uint256)

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

Parameters

Name	Type
guy	PromiseOrValue<string>
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

burn(uint256)

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

Parameters

Name	Type
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

connect

▸ connect(signerOrProvider): Token

Parameters

Name	Type
signerOrProvider	string | Provider | Signer

Returns

Token

Overrides

BaseContract.connect

---

decimals

▸ decimals(overrides?): Promise<number>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<number>

---

deployed

▸ deployed(): Promise<Token>

Returns

Promise<Token>

Overrides

BaseContract.deployed

---

emit

▸ emit(eventName, ...args): boolean

Parameters

Name	Type
eventName	string | EventFilter
...args	any[]

Returns

boolean

Inherited from

BaseContract.emit

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

BaseContract.fallback

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

BaseContract.listenerCount

---

listeners

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

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter?	TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Overrides

BaseContract.listeners

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

---

locked

▸ locked(overrides?): Promise<boolean>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<boolean>

---

mint(address,uint256)

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

Parameters

Name	Type
guy	PromiseOrValue<string>
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

mint(uint256)

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

Parameters

Name	Type
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

name

▸ name(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

---

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

---

queryFilter

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

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
event	TypedEventFilter<TEvent>
fromBlockOrBlockhash?	string | number
toBlock?	string | number

Returns

Promise<TEvent[]>

Overrides

BaseContract.queryFilter

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): Token

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

Token

Overrides

BaseContract.removeAllListeners

▸ removeAllListeners(eventName?): Token

Parameters

Name	Type
eventName?	string

Returns

Token

Overrides

BaseContract.removeAllListeners

---

setAuthority

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

Parameters

Name	Type
authority_	PromiseOrValue<string>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

setOwner

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

Parameters

Name	Type
owner_	PromiseOrValue<string>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

symbol

▸ symbol(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

---

totalSupply

▸ totalSupply(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

---

transfer

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

Parameters

Name	Type
dst	PromiseOrValue<string>
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

transferFrom

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

Parameters

Name	Type
src	PromiseOrValue<string>
dst	PromiseOrValue<string>
wad	PromiseOrValue<BigNumberish>
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

---

unlock

▸ unlock(overrides?): Promise<ContractTransaction>

Parameters

Name	Type
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>