TokenClient

The TokenClient is a standard interface for interactions with functions and events described in Token.sol.

Upon creation, new colonies can either create or import existing token contracts. These contracts are expected to conform to the ERC20 or ERC20Extended token standard interface, the latter allowing for mint and burn functions. The token client is intended to help keep interactions with a colony's token straightforward.

Most functions are fairly self-explanatory and mirror their on-chain counterparts, but in some cases the function will return values passed from event data, rather than simple boolean expressions (which are returned from the contract on-chain).

• Create an instance

• Callers

  • getTokenInfo.call()
  • getTotalSupply.call()
  • getBalanceOf.call({ sourceAddress })
  • getAllowance.call({ sourceAddress, user })

• Senders

  • transfer.send({ destinationAddress, amount }, options)
  • transferFrom.send({ sourceAddress, destinationAddress, amount }, options)
  • approve.send({ user, amount }, options)
  • mint.send({ amount }, options)
  • burn.send({ amount }, options)
  • setOwner.send({ owner }, options)
  • setAuthority.send({ authority }, options)

• Events

  • events.Transfer.addListener(({ from, to, value }) => { /* ... */ })
  • events.Approval.addListener(({ owner, spender, value }) => { /* ... */ })
  • events.Burn.addListener(({ address, amount }) => { /* ... */ })
  • events.LogSetAuthority.addListener(({ authority }) => { /* ... */ })
  • events.LogSetOwner.addListener(({ owner }) => { /* ... */ })
  • events.Mint.addListener(({ address, amount }) => { /* ... */ })

Create an instance

The TokenClient is initialized for you when you ask the ColonyNetworkClient for a new instance of ColonyClient:

const tokenClient = colonyClient.token;

You could create an instance of TokenClient by providing an adapter and a query:

const tokenClient = new TokenClient({ adapter, query });

await tokenClient.init();

Callers

All callers return promises which resolve to an object containing the given return values. For a reference please check here.

getTokenInfo.call()

Get information about the ERC20 token itself

Returns

A promise which resolves to an object containing the following properties:

getTotalSupply.call()

Get the total token supply.

Returns

A promise which resolves to an object containing the following properties:

getBalanceOf.call({ sourceAddress })

Returns the token balance of a given address.

Arguments

Returns

A promise which resolves to an object containing the following properties:

getAllowance.call({ sourceAddress, user })

Given a token owner address and a spender, will return the amount of tokens approved by the owner that can be transferred to the spender's account.

Arguments

Returns

A promise which resolves to an object containing the following properties:

Senders

All senders return an instance of a ContractResponse. Every send() method takes an options object as the second argument. For a reference please check here.

transfer.send({ destinationAddress, amount }, options)

Transfer an amount of tokens from a token owner's account to a specified destination address.

Arguments

Returns

An instance of a ContractResponse

transferFrom.send({ sourceAddress, destinationAddress, amount }, options)

Transfer tokens from a specified account to a destination account. Token transfer must have a sufficient balance and allowance set by the source account for the destination address.

Arguments

Returns

An instance of a ContractResponse which will eventually receive the following event data:

approve.send({ user, amount }, options)

The owner of a token can approve an allowance that a spender is authorized to transfer using the transferFrom function.

Arguments

Returns

An instance of a ContractResponse which will eventually receive the following event data:

mint.send({ amount }, options)

ERC20Extended functionality to mint new tokens and add to the total supply. In colony these functions are subject to authority restrictions.

Arguments

Returns

An instance of a ContractResponse which will eventually receive the following event data:

burn.send({ amount }, options)

ERC20Extended functionality to burn un-owned tokens and subtract from the total token supply. In colony these functions are subject to authority restrictions.

Arguments

Returns

An instance of a ContractResponse which will eventually receive the following event data:

setOwner.send({ owner }, options)

Sets the owner of a given token contract. In most situations this should be the colony's own address.

Arguments

Returns

An instance of a ContractResponse which will eventually receive the following event data:

setAuthority.send({ authority }, options)

Give a particular account special authority (admin) within a colony.

Arguments

Returns

An instance of a ContractResponse which will eventually receive the following event data:

Events

Refer to the ContractEvent class here to interact with these events.

events.Transfer.addListener(({ from, to, value }) => { /* ... */ })

Arguments

events.Approval.addListener(({ owner, spender, value }) => { /* ... */ })

Arguments

events.Burn.addListener(({ address, amount }) => { /* ... */ })

Arguments

events.LogSetAuthority.addListener(({ authority }) => { /* ... */ })

Arguments

events.LogSetOwner.addListener(({ owner }) => { /* ... */ })

Arguments

events.Mint.addListener(({ address, amount }) => { /* ... */ })

Arguments