contracts

README

Smart contracts

This repository contains Token smart contracts.

wallet.sol is the primary TokenWallet contract which holds user's funds and offers additional security features (e.g. whitelist, daily spend/gas limit). The wallet contract is composed of multiple contracts, one of which is the Vault, which offers the same security features as the Wallet, but without the gas top up functionality.

oracle.sol is an oracle contract which stores token/wei exchange rates for each of the supported tokens. Exchange rates have to be updated periodically by calling the Crypto Compare API through the Oraclize contract when the exchange rate increases/decreases beyond a certain threshold, relative to what is stored in the contract.

internal/resolver.sol is a resolver contract that provides dynamic address resolution for the oracle and oraclize smart contracts.

internal/ownable.sol is an inheritable contract that provides owner authentication functionality to the child contract.

internal/controller.sol is a storage contract that stores a list of controller addresses which can be used for together with the 'controllable.sol' contract.

internal/controllable.sol is an inheritable contract that integrates with the list of controllers and provides control functionality to the child contract.

mocks/token.sol is a partial implementation of the ERC20 token standard used for development purposes.

Contract communication

                              ┌──────────────────┐ 
  ┌────────────────┐          │                  │ 
┌─┤                │          │                  │ 
│ │                │    ┌─────▶    Oracle.sol    │ 
│ │                │    │     │                  │ 
│ │                │    │     │                  │ 
│ │   Wallet.sol   ├────┘     └──────────────────┘ 
│ │                ├─────┐                         
│ │                │     │     ┌───────────────┐   
│ │                │     │     │               │   
│ │                │     │     │               │   
│ └──────────────┬─┘     └─────▶   Token.sol   │   
└────────────────┘             │               │   
                               │               │   
                               └───────────────┘   
                                                                          

Running contract tests

Get dependencies:

go mod vendor

Run tests:

go test -v ./test/...

Building contracts

To build all contracts and generate corresponding Go bindings:

./build.sh