The Consumer Contract Wallet - Version 3.4.1
This repository contains the Smart Contracts needed to power the Monolith App, written in Solidity, for execution in the EVM.
We are committed to building a non-custodial banking alternative on Ethereum and these contracts define our relationship with our users.
The Monolith Card is the world's first non-custodial position to VISA debit card. The Consumer Contract Wallet allows people to hold their own assets, whilst being able to seamlessly move funds to a VISA debit card. 1% of all loads to the Monolith Cards are sent, by the user themselves, to the TKN Holder contract. This is used to back the Community Chest (aka the Asset Contract). The purpose of this on-chain infrastructure is provide the most seamless user experience when it comes to using crypto in the real-world, whilst maintaining a decentralised position.
|High Level Architecture||Security Features||Solidity Code||Running Contract Tests||Resources|
The functionality encoded in the Smart Contracts found in this repository have been designed to help users protect their tokens, by holding them within their own contract wallet that implements the logic defined in our Consumer Contract Wallet. Users of the contract wallet need to configure their wallet's to their own liking. The logic defined within the Consumer Contract Wallet has been created to limit a user's exposure to loss of tokens in the event that a user has had their Private Key compromised.
We believe there are three major problems facing the adoption and use of decentralised finances:
- The issue that users with compromised private keys could end up losing all of their assets.
- The issue that people are generally not good at keeping digital secrets safe, the potential loss of private keys.
- The UX of decentralised finances and how they interplay into real-world payments.
This, version 3.3.1, of the Consumer Contract Wallet utilises the library/proxy pattern for the deployment of this smart contract. This pattern is mainly employed by (upgradeable smart contracts) but can also be adopted to provide effeciencies on chain. All users get given a proxy contract that outsources the logic to a central library contract. The Consumer Contract Wallet uses the proxy contracts developed by OpenZeppelin in their suite of (upgradeable contracts). It should be noted that the Consumer Contract Wallet builds on top of the Proxy contract used by developers wanting to build upgradeable smart contracts, this version of the contract wallet itself isn't upgradeable. Users will still need to migrate between versions of the contract wallet to get the benefit of new features.
The Consumer Contract Wallet protects users by limiting their exposure to theft in the event that their private key becoming compromised. This version also brings 'batched meta-transactions' to the list of features of the contract wallet. Batched meta-transactions are flexible to the point where gas can be removed from equation or can be approximately paid for in any ERC20 token. By batching up meta-transactions we will be able to build a more compelling user experience, by utilising the composability of Smart Contract calls on Ethereum.
Each user deploys their own proxy contract, i.e. their contract wallet, that uses the logic defined in (wallet.sol) that in turn interacts with the TokenWhitelist (tokenWhitelist.sol) to get token exchange rates to enforce a user-defined daily spend limit. The exchange rates in the TokenWhitelist contract are periodically updated using an exchange rate Oracle (oracle.sol) that builds upon CryptoCompare's APIs.
Service discovery in the Consumer Contract Wallet is performed via the use of the Ethereum Name Service (ENS). For example, ENS is used to resolve the location of the TokenWhitelist contract, as well as to resolve the location of the Controller (controller.sol) contract. The TokenWhitelist is a list of tokens and their exchange rates that defines the set of tokens that are protected within a user's wallet. It also determines which tokens can be used to load fiat on to a user's Monolith card. Card load transactions are peformed by sending assets to the (licence.sol) contract that in turn takes a 1% fee and adds it to the (holder.sol) contract. The tokens sent to the holder contract are "cash 'n' burnable" by the (TKN ERC-20 Contract) in conjunction with the TKN Holder Contract. This Controller contract is used for administrative purposes only, rest assured this has no access to user's funds. The controllers are used to perform 2FA functionality as well as administrative tasks on the Oracle and on the TokenWhitelist.
- Every user will have their own Public and Private key pair, aka the
- Users SHOULD NEVER have to share the Private Key of their
Owner Addresswith anyone.
- There are a number of different "pots of tokens" for a given user:
- The user’s entire ETH and ERC20 token assets stored within the Consumer Contract Wallet.
- An amount of ETH used to pay for the gas - Gas Tank. The Gas Tank is a representation of the ETH on the user's
Owner Address. It should be noted that this ETH is NOT protected by the security features in the Consumer Contract Wallet as it resides outside of the Smart Contract. Note: in the current version (v3) meta-transactions are also supported i.e. the users can send trasnactions without having to top-up their Gas Tank. The way it works is the following: they sign the transsaction with their private key, a controller broadcasts it, the signature is validated by their contract and the original transaction is executed consecutively. The Gas Tank has been kept mainly for convenience and is gonna be removed entirely in the upcoming version.
Owner Addresswill own all of the user’s Smart Contracts and will be referred to as the Owner, this is sometimes referred to as an Externally Owned Address (EOA)
- The Controller - Is a key hierarchy of administrative addresses, owned and operated by Token Group Ltd. These are used to provide convenience to our users.
- The Consumer Contract Wallet needs to allow its Owner to configure how they wish to secure their tokens in their wallet.
- There needs to be a convenient way to "top-up" the amount of ETH that lives on our user’s
Owner Addressaka Gas Tank via the Smart Contracts
- The wallet's design is intended to be as decentralised as possible. This will be achieved by eliminating access to user assets by third-parties and minimising reliance of third-party infrastructure in running the Consumer Contract Wallet.
- Must help user protect their funds by minimising the risk in the event of their
Owner Address's private key being compromised.
- Provide the best UX possible.
In order to help users protect their tokens in the event that their Private Key gets compromised, we present the following security features:
- A Whitelist of Addresses - akin to a whitelist of payees in a banking application, this whitelist should be configured with a list of trusted addresses for each Owner of the Consumer Contract Wallet.
- Daily Spending Limit - denominated in ETH. This is used to define how much can a user transfer in a given day if transferring assets to addresses outside their Whitelist.
- Daily Gas Tank Top-up Limit - (Gas Tank) top-up daily limit denominated in ETH. This is used to define the daily limit of ETH that can be sent from a user's Consumer Contract Wallet to their
Address; this ETH is what is used to pay the network for gas.
- Daily Card Load Limit - (Card Load Limit) card loading daily limit denominated in USD (technically speaking in a stablecoin like USDC). This is used to define the daily limit of tokens or ETH that can be sent from a user's Consumer Contract Wallet for loading of the user's TokenCard. This is currently set to 10K USD.
There are three ways to configure a Consumer Contract Wallet:
- via Constructor: Upon deployment of a new Consumer Contract Wallet the above security features are configured: a) by passing the desired value for the Daily Spending Limit to the constructor b2) by setting default values for the Daily Gas Tank Top-up Limit and Daily Card Load Limit, when deploying the Consumer Contract Wallet smart contract the to the Ethereum network. This is how the values are set when deploying a new instance of the Consumer Contract Wallet.
- via a 1-time write pattern: Aside from default values and values passed in via the Constructor the user may do a 1-time write to the aforementioned
Security Features. These allow the
Addressto change the values that power the security features. It is advised that users of the Consumer Contract Wallet set their security settings so that they can not longer be tampered with in the event that a user's private key is compromised. Users should set these values once, otherwise an attacker would be able to configure their Smart Contract.
- via a 2FA pattern: Where a user can submitChange a new value for one of the Security Features, then one of the
Controlleraddresses needs to either OK the value change or not. It should be noted that due to the nature of the user AddressWhitelist where a user may add or remove items from their whitelist via the 2FA pattern, only one pending change to the user's address whitelist can be in flight at a given point in time.
This section details the naming convention adopted in this codebase:
- Contracts - should be Nouns
- Functions - should be Verbs
- Ables - Smart Contracts that are meant to be inherited and not standalone, i.e. they are Mixins, Snippets, Decorators ...
- Private contract scoped variables - all start with an underscore
- Private / internal functions - all start with an underscore
- Constructor parameters - all start with an underscore
_and end in one too, e.g.
_ens_this is to avoid shadowing
- Function parameters - all start with an underscore
- Local variables - to functions should start without an underscore
- Public contract scoped variables - should start without an underscore
- Public functions - should start without an underscore
- Crud functions - when there exist multiple actions on the same variable we will use the suffix to illustrate the action, for example :
Solidity code in the
It should be noted that this codebase makes heavy use of inheritance.
wallet.sol is the library contract that defines the business logic of the Consumer Contract Wallet. This library is used to secure user funds. The Wallet communicates with the TokenWhitelist, the Controller, the TKN licence, and other ERC20 contracts. It should noted that the Consumer Contract Wallet only protects the ERC20 tokens supported by the TokenWhitelist in its Security Features, tokens not listed as
available by the TokenWhitelist will not be secured by the Consumer Contract Wallet's daily spend limit; see(wallet inheritance digram).
controller.sol the Controller is used to perform tasks on behalf of Token Group Ltd. These tasks range from operational tasks, such as updating the token exchange rates via the Oracle, adding/removing tokens from the TokenWhitelist to signing 2FA functions on behalf of our users. The Controller contract implements a key hierarchy of:
controllers used for operational tasks,
admin used for administrative tasks, and the
owner which is used to change out the
admins; see(controller inheritance diagram).
gasProxy.sol the GasProxy can be used as a Controller to redeem gasTokens (e.g. GST2 or CHI) when executing Controller transactions. The depoloyed GasProxy contract should be added to the list of controllers in the Controller contract.
holder.sol is the TKN Holder contract, this is the
Asset Contract as defined in the TokenCard whitepaper. This contract is used to hold 1% of all loads made onto TokenCards. The TokenWhitelist is used to define the set of tokens that are cash 'n' burnable (aka redeemable) by TKN holders who wish to burn their TKN. Users may burn their TKN on the TKN ERC20 contract which will call out to the
burn method on the TKN Holder contract; see(holder inheritance diagram).
licence.sol is the TKN Licence contract, and it is used to take a 1% fee of all loads of the user's TokenCard so that it can be sent to the TKN Holder contract. This contract is aware of the CryptoFloat where the remaining tokens are to be kept for Token Group Ltd for the loading of the TokenCards. It is also aware of the address of the TKN Holder contract that is used to back TKN. The TKN Licence contract has been created in a way to allow for a DAO to change some of its configured features, this is there to future proof the implementation; see (licence inheritance diagram).
oracle.sol is an exchange rate Oracle contract that gets exchange rates for a set of supported ERC20 tokens. Exchange rates are updated periodically by using the signed Crypto Compare API. The list of tokens is managed by the TokenWhitelist, the Oracle merely updates exchange rates; see (oracle inheritance diagram).
tokenWhitelist.sol The list of tokens used in this system is managed in the TokenWhitelist. The Controller can be used to add and remove tokens from the TokenWhitelist, they also have the ability to set flags on the specific tokens, e.g.
loadable (means that a token is loadable on the TokenCard) or
redeemable (means that a token is redeemable in the TKN Holder contract); see (tokenWhitelist inheritance diagram).
walletCache.sol The WalletCache is a factory contract that is used to pre-deploy and cache the proxy contracts that make up the user's Consumer Contract Wallets when network prices are low; see (walletCache inheritance diagram).
walletDeployer.sol The WalletDeployer contract accesses the WalletCache via ENS and allows the pre-cached wallets to be assigned new owners in a single contract call in order to satisfy requests for new Consumer Contract Wallets. This contract also has the ability to configure a contract with set security features, this will be used to migrate users between versions of the contract wallets; see (walletDeployer inheritance diagram).
Solidity code in the
balanceable.sol is an inheritable contract that checks the ETH or ERC20 balance of an address.
burner.sol defines the Burner interface used for burning TKN for the cash n' burn functionality.
bytesUtils.sol includes a set of utils for parsing bytes to things like ints and addresses.
controllable.sol is an inheritable contract that integrates with the list of controllers and provides control functionality to the child contract.
date.sol is a simple date parsing contract with a single method, used to parse out a comparable number from the date in an HTTP header.
ensResolvable.sol implements a inheritable contract that allows contracts to looked up others via ENS.
ownable.sol is an inheritable contract that provides owner authentication functionality to the owned contract.
parseIntScientific.sol provides floating point in scientific notation (e.g. e-5) parsing functionality. This has been built to support floating point scientific notation returned in JSON.
tokenWhitelistable.sol is an inheritable contract that interfaces with the tokenWhitelist.
transferrable.sol is an inheritable contract that allows for tokens or ETH to be transferred.
Solidity code in the
base64Exporter.sol is a mocked out version of a contract that pulls in the base64 encoder for unit testing purposes.
burnerToken.sol is version of the TKN contract used for testing the Cash n' Burn functionality.
bytesUtilsExporter.sol used to export methods on the bytesUtils contract for testing purposes.
isValidSignatureExporter.sol used to export valid signatures for meta transaction testing.
nonCompliantToken.sol a version of a non-compliant ERC20 token, used to test the SafeERC20 stuff.
oraclize.sol is a mocked out version of the oraclize, this is for testing purposes only.
parseIntScientific-exporter.sol is a mocked out version of a contract that pulls in the parseIntScientific contract used to parse floating points that include scientific notation out of JSON.
token.sol is a partial compliant implementation of the ERC20 token standard used for testing and development purposes.
tokenWhitelistableExporter.sol exports the tokenWhitelist for testing purposes.
walletMock.sol exports the wallet that is now used by the proxy/library pattern so that it can be used for testing purposes.
Solidity code in the
All of the third-party code we rely on can be found in this folder. The below table details the third-party code used and their licenses.
|ENS Pubic Resolver||BSD2|
Deploying the contracts
We have an instance of the wallet-deployer, which is a factory contract, that is the official way of deploying a new instance of the Consumer Contract Wallet. The production instance of the wallet deployer factory contract can be found at the following ENS address: (wallet-deployer.v3.tokencard.eth) this works in conjunction with the wallet cache, which can be found at the following ENS address (wallet-cache.v3.tokencard.eth).
It should be noted that when creating a new instance of the Consumer Contract Wallet particular attention must be given to ensuring that the wallet is properly configured. It is particularly important that the wallet's owner is no longer transaferable before the wallet is used in anger: arguements
To build all contracts and generate corresponding Go bindings:
Running contract unit tests
- go version >1.11 is required.
- go modules (experimental in go 1.11) are needed.
go modules download
To test the contracts using the
go command run:
go test -v ./test/...
To test the contracts using the
ginkgo command run:
SILENT=true ginkgo -nodes=16 -r -p ./test/...
Running validation tools
To run all validation tools locally using Docker run:
To run a specific validation tool, use the provided scripts:
./tools/prettier/format.sh ./tools/slither/flatten.sh ./tools/slither/slither.sh ./tools/echidna/echidna.sh ./tools/mythril/mythril.sh ./tools/manticore/manticore.sh
To generate the inheritance graphs
docker run -v /path/contracts:/contracts -it trailofbits/eth-security-toolbox:latest solc-select 0.5.17 cd /contracts sudo apt-get update sudo apt install xdot slither contracts/wallet.sol --print inheritance-graph dot contracts.dot -Tpng -o ./wallet.inheritance.png