Skip to content

Latest commit

 

History

History
206 lines (162 loc) · 9.06 KB

README.md

File metadata and controls

206 lines (162 loc) · 9.06 KB

Setup

Our development environment uses Truffle and Solidity. We require vyper as a dependency for uniswap.

Develop

git submodule update --init --recursive
yarn install

## The following lines are required to run vyper compiler natively.
## They can be skipped, in which case vyper will be compiled using docker (running docker daemon will be required) 
brew install python3
brew install gmp leveldb
pip3 install virtualenv
python3 -m venv ~/vyper-env
source ~/vyper-env/bin/activate
pip install vyper
## Vyper setup end

./test.sh

Build

For more efficient compilation and deployment, we use waffle (https://getwaffle.io/).

npm run-script build
ts-node scripts/deploy_testnet.ts

Deployments

For all of our deployments, the address is the same between mainnet and testnet. Our source code is verified on Etherscan.

Tokens

Contract Token Address Controller Address Mainnet Rinkeby Kovan
TrueUSD 0x0000000000085d4780B73119b644AE5ecd22b376 0x0000000000075EfBeE23fe2de1bd0b7690883cc9
TrueGBP 0x00000000441378008EA67F4284A57932B1c000a5 0x00000000BbcF7700A1b403C9EB666f350707b900 🚫
TrueAUD 0x00006100f7090010005f1bd7ae6122c3c2cf0090 0x0000109a8344DE9c00465264006C0000769A2770 🚫
TrueCAD 0x00000100F2A2bd000715001920eB70D229700085 0x00005cAD001e0900002979f7314D00Fc480a29bD
TrueHKD 0x0000852600CEB001E08e00bC008be620d60031F2 0x0000107d120000E00095Cf06b787a0a900B1F8Bd 🚫

Getting Testnet Tokens

For the testnet tokens, the controller is a TokenFaucet, so anybody can mint as many test tokens as they want. Send faucet(uint256) (0x5c3976a8) to the appropriate controller to obtain funds. Here is an example. Note that the tokens have 18 decimal places of precision. You can mint up to 1,000,000,000,000 tokens per transaction.

Utilities

Contract Address Mainnet Rinkeby Kovan
Registry 0x0000000000013949F288172bD7E36837bDdC7211
Autosweep Registrar 0x00000000000Da14C27C155Bb7C1Ac9Bd7519eB3b

Registering for Autosweep

Sending any transaction to the Autosweep Registrar registers your deposit address for all of our tokens. See the section on Autosweep.

Tokenized Currencies

This repository contains the smart contracts for TrueUSD and TrueGBP, as well as the contracts that support them. This section contains a high-level overview of the contracts. For specifics, see the relevant .sol files.

Proxy/...

We use DELEGATECALL proxies so that we can upgrade our contracts without changing their addresses. We always seek a security audit before upgrading, in order to mitigate risk.

ProxyStorage.sol

All of the tokens use the storage laid out in ProxyStorage.sol. Solidity storage variables for tokens should not be declared in any other file. This mitigates the risk of the storage layout shifting between upgrades.

modularERC20/...

These contracts are inspired by and roughly equivalent to the corresponding ERC20 token contracts from OpenZeppelin. Work is separated into internal functions that can be overridden for storage migrations.

Admin/...

TokenController.sol

TokenController is the owner for each of our tokens. Power is separated between the Owner key, Mint Pause Keys, the Mint Key, and Mint Ratifier Keys, which protect the mint process. Risk is configurable in the mint limits.

MultiSigOwner.sol

This contract can be the owner of a TokenController. It turns every TokenController owner function into a multisig function that requires 2/3 approvals.

HasOwner.sol

Our own implementation of Claimable Contract, formerly part of OpenZeppelin.

BurnableTokenWithBounds.sol

This limits the minimum and maximum number of tokens that can be redeemed per-transaction.

CompliantDepositTokenWithHook.sol

This file processes attributes synced from the Registry.

Autosweep

Registering a wallet creates a million deposit addresses that automatically forward their True Currency balances. The created deposit addresses share the first 35 characters of their address with the registering wallet. You can register your deposit address using the Autosweep Registrar.

Transfers to any of your deposit addresses will forward to your wallet in the same transaction. Such transactions will emit two Transfer events. The first event documents the expected value transfer from the sender to the deposit address. The second event documents the automatic sweep from the deposit address to the wallet.

Exchanges should register deposit addresses to reduce their operating overhead.

Redemption addresses

You can redeem these tokens for fiat by transfering them to your redemption address, which starts with at least thirty-five zeroes. Sign up for your redemption address by creating a TrustToken account.

Blacklisted addresses

TrustToken prevents you from sending our tokens to blacklisted addresses. We blacklist our own contracts so that you cannot send them tokens by mistake. TrustToken also reserves the right to blacklist accounts that violate the TrueCoin Terms of Use.

Registered contracts

By contacting us, you can register a contract to receive a callback when it receives tokens.

GasRefundToken.sol

We reduce the amount of gas you pay by refunding gas during your transfer.

TrueUSD.sol, TrueGBP.sol, etc.

These are the top-level ERC20 contracts. They inherit the aforementioned functionality.

True Rewards contracts

Contract Mainnet Address Ropsten Address
TrueUSD 0x0000000000085d4780B73119b644AE5ecd22b376 0xa2EA00Df6d8594DBc76b79beFe22db9043b8896F
Token Controller 0x0000000000075EfBeE23fe2de1bd0b7690883cc9 0x47106c72DE9144d43Bb026d848806Ab29e2A0227
Assured Financial Opportunity 0xffe7361B401AF1954641732AFc28811ac701e7e1 0xFadBBfFe15F25c64a4C06b6251357351e2def278
Aave Financial Opportunity 0x3146fA2f055d18Ea39188a7863f095A2a3DAdB1C 0xe1a91cca64b34e47a92d3ef0d422481a5872cfa9
TrustToken 0x4C19596f5aAfF459fA38B0f7eD92F11AE6543784 0x711161BaF6fA362Fa41F80aD2295F1f601b44f3F
Staked Token 0x9499e8D5a56bB9ECf1B7C6A95e1c4f5331805A2e 0xE510468dAD975bC77F0B81fADdE2f9DdF4231cf4
Liquidator 0x1dfB7700E67e6046898c2FEfe160FB53fEC3A27c 0xe06dabc0fef1dc05cf07c167422be985d0cbbd4d
Registry 0x0000000000013949F288172bD7E36837bDdC7211 0xe24c8f14295da7f308B73B94C72197e8Ee73A484

Contributing

Before creating a pull request, please run the tests, the profiler, and the flattener.

Setup

Initialize the registry submodule in the root directory.

git submodule init && git submodule update

Testing

yarn install
yarn test # runs ./test.sh

Profiling

To run the profiler and update GasProfile.json, run the profile script in the root directory.

yarn profile # runs ./profile.sh

Flattening

Run the flattener in the root directory.

yarn flatten # runs ./flatten-all

Links

Description URL
Purchase and Redeem https://app.trusttoken.com/
Terms of Use https://www.trusttoken.com/terms-of-use/
Etherscan: TUSD https://etherscan.io/token/0x0000000000085d4780B73119b644AE5ecd22b376
Etherscan: TGBP https://etherscan.io/token/0x00000000441378008EA67F4284A57932B1c000a5
Etherscan: TAUD https://etherscan.io/token/0x00006100F7090010005F1bd7aE6122c3C2CF0090
Etherscan: TCAD https://etherscan.io/token/0x00000100F2A2bd000715001920eB70D229700085
Etherscan: THKD https://etherscan.io/token/0x0000852600CEB001E08e00bC008be620d60031F2
CoinMarketCap: TUSD https://coinmarketcap.com/currencies/trueusd/

Social

Pages URL
Website https://www.trueusd.com/
Facebook https://www.facebook.com/TrustToken/
Twitter https://twitter.com/TrustToken
Telegram https://t.me/joinchat/HihkMkTja1gIyBRM1J1_vg

Exchanges where TrueUSD is Traded

Exchanges URL
Uniswap https://www.uniswap.org/
Binance https://www.binance.com/
Huobi https://www.huobi.com/
Okex https://www.okex.com/
Bittrex https://bittrex.com
CoinTiger https://www.cointiger.pro
Upbit https://upbit.com/
HBUS https://www.hbus.com/