TokenClient

The TokenClient is a standard interface for interactions with methods and events described in Token.sol. These interactions are extended from the ERC20 and DSToken standard token interfaces and are generally concerned with managing the native token assigned to a colony. This includes operations such as minting tokens, burning tokens, and transferring tokens.

See Clients for information about initializing TokenClient.

• Callers

  • getAllowance.call({ sourceAddress, user })

    • Arguments
    • Return Values
    • Contract Information

  • getBalanceOf.call({ sourceAddress })

    • Arguments
    • Return Values
    • Contract Information

  • getTokenInfo.call()

    • Return Values
    • Contract Information

  • getTotalSupply.call()

    • Return Values
    • Contract Information

• Senders

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

    • Arguments
    • Response
    • Contract Information

  • burn.send({ user, amount }, options)

    • Arguments
    • Response
    • Contract Information

  • mint.send({ user, amount }, options)

    • Arguments
    • Response
    • Contract Information

  • setAuthority.send({ authority }, options)

    • Arguments
    • Response
    • Contract Information

  • setName.send({ name }, options)

    • Arguments
    • Response
    • Contract Information

  • setOwner.send({ owner }, options)

    • Arguments
    • Response
    • Contract Information

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

    • Arguments
    • Response
    • Contract Information

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

    • Arguments
    • Response
    • Contract Information

• Events

  • 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

  • events.TokenLocked.addListener(({ token, lockCount }) => { /* ... */ })

    • Arguments

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

    • Arguments

Callers

All callers return promises which resolve to an object containing the given return values..

getAllowance.call({ sourceAddress, user })

Get the token allowance of an address. The allowance is the amount of tokens that the spender is authorized to transfer using the transferFrom function.

Arguments

Argument	Type	Description
sourceAddress	address	The address that approved the allowance (the token owner ).
user	address	The address that was approved for the allowance (the token spender ).

Return Values

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

Return Value	Type	Description
amount	big number	The amount of tokens that were approved (the amount allowed ).

Contract Information

Function: allowance

Contract: erc20.sol

getBalanceOf.call({ sourceAddress })

Get the the token balance of an address.

Arguments

Argument	Type	Description
sourceAddress	address	The address that will be checked.

Return Values

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

Return Value	Type	Description
amount	big number	The balance of tokens for the address.

Contract Information

Function: balanceOf

Contract: erc20.sol

getTokenInfo.call()

Get information about the token.

Return Values

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

Return Value	Type	Description
name	string	The name of the token.
symbol	string	The symbol of the token.
decimals	number	The number of decimals.

Contract Information

Contract: Token.sol

getTotalSupply.call()

Get the total supply of the token.

Return Values

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

Return Value	Type	Description
amount	big number	The total supply of the token.

Contract Information

Function: totalSupply

Contract: erc20.sol

Senders

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

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

Approve a token allowance. This function can only be called by the token owner. The allowance is the amount of tokens that the spender is authorized to transfer using the transferFrom function.

Arguments

Argument	Type	Description
user	address	The address that will be approved for the allowance (the token spender ).
amount	big number	The amount of tokens that will be approved (the amount allowed ).

Response

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

Event Data	Type	Description
owner	address	The address that approved the allowance (the token owner ).
spender	address	The address that was approved for the allowance (the token spender ).
value	big number	The amount of tokens that were approved (the amount allowed ).
Approval	object	Contains the data defined in Approval

Contract Information

Contract: erc20.sol

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

Burn tokens. This is a DSToken function that can only be called by the token owner. When a colony contract address is assigned as the token owner, this function can only be called by the user assigned the FOUNDER authority role.

Arguments

Argument	Type	Description
user	address	The address from which the tokens will be burned.
amount	big number	The amount of tokens that will be burned.

Response

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

Event Data	Type	Description
address	address	The address from which the tokens were burned.
amount	big number	The amount of tokens that were burned.
Burn	object	Contains the data defined in Burn

Contract Information

Contract: token.sol

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

Mint new tokens. This is a DSToken function that can only be called by the token owner. When a colony contract address is assigned as the token owner, this function can only be called by the user assigned the FOUNDER authority role.

Arguments

Argument	Type	Description
user	address	The address that will receive the minted tokens.
amount	big number	The amount of tokens that will be minted.

Response

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

Event Data	Type	Description
address	address	The address to which the minted tokens were sent.
amount	big number	The amount of tokens that were minted.
Mint	object	Contains the data defined in Mint

Contract Information

Contract: token.sol

setAuthority.send({ authority }, options)

Assign an account the ADMIN authority role within a colony.

Arguments

Argument	Type	Description
authority	address	The address that will be assigned the ADMIN authority role.

Response

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

Event Data	Type	Description
authority	address	The address that was assigned an authority role.
LogSetAuthority	object	Contains the data defined in LogSetAuthority

Contract Information

Contract: auth.sol

setName.send({ name }, options)

Set the name of a token contract. This function can only be called by the current owner of the contract. In order to call token contract methods from within a colony, the token owner must be the address of the colony contract.

Arguments

Argument	Type	Description
name	string	The name of the token that will be set.

Response

An instance of a ContractResponse

Contract Information

Contract: token.sol

setOwner.send({ owner }, options)

Set the owner of a token contract. This function can only be called by the current owner of the contract. In order to call token contract methods from within a colony, the token owner must be the address of the colony contract.

Arguments

Argument	Type	Description
owner	address	The address that will be assigned as the new owner.

Response

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

Event Data	Type	Description
owner	address	The address that was assigned as the new owner.
LogSetOwner	object	Contains the data defined in LogSetOwner

Contract Information

Contract: auth.sol

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

Transfer tokens from the address calling the function to another address. The current address must have a sufficient token balance.

Arguments

Argument	Type	Description
destinationAddress	address	The address to which tokens will be transferred.
amount	big number	The amount of tokens that will be transferred.

Response

An instance of a ContractResponse

Contract Information

Contract: erc20.sol

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

Transfer tokens from one address to another address. The address the tokens are transferred from must have a sufficient token balance and it must have a sufficient token allowance approved by the token owner.

Arguments

Argument	Type	Description
sourceAddress	address	The address from which tokens will be transferred.
destinationAddress	address	The address to which tokens will be transferred.
amount	big number	The amount of tokens that will be transferred.

Response

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

Event Data	Type	Description
from	address	The address of the account that sent tokens.
to	address	The address of the account that received tokens.
value	big number	The amount of tokens that were transferred.
Transfer	object	Contains the data defined in Transfer

Contract Information

Contract: Token.sol

Events

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

Arguments

Argument	Type	Description
owner	address	The address that approved the allowance (the token owner ).
spender	address	The address that was approved for the allowance (the token spender ).
value	big number	The amount of tokens that were approved (the amount allowed ).

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

Arguments

Argument	Type	Description
address	address	The address from which the tokens were burned.
amount	big number	The amount of tokens that were burned.

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

Arguments

Argument	Type	Description
authority	address	The address that was assigned an authority role.

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

Arguments

Argument	Type	Description
owner	address	The address that was assigned as the new owner.

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

Arguments

Argument	Type	Description
address	address	The address to which the minted tokens were sent.
amount	big number	The amount of tokens that were minted.

events.TokenLocked.addListener(({ token, lockCount }) => { /* ... */ })

Arguments

Argument	Type	Description
token	address	The address of the token contract.
lockCount	number	The total lock count for the token.

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

Arguments

Argument	Type	Description
from	address	The address of the account that sent tokens.
to	address	The address of the account that received tokens.
value	big number	The amount of tokens that were transferred.