Dai Token Guide for Developers
Estimated Time: 30 - 60 minutes
Dai is a decentralized stablecoin currently live on the Ethereum network. The Dai Credit System incentivizes users to increase or decrease the token supply based on supply and demand for Dai and also ensures its value stays pegged to 1 USD. The token contract conforms to the ERC20 token standard which allows wallets, exchanges, and other applications to easily integrate with minimal effort. This guide will be useful to developers integrating Dai in applications like wallets, exchanges, and smart contracts to get a better understanding of the token contract and its functionality.
- You will learn basic information about the token.
- Understand the additional functions supported by the token contract.
- Deploying your own token to an Ethereum testnet.
- Integrate the Dai token effectively with your application.
- Knowledge of the ERC20 token standard.
- Ability to send ethereum transactions from your preferred dev environment.
- Token Info
- Getting Dai
- Token contract
- Deploy a DSToken
The symbol field is set to 'DAI' and the name field is currently set to 'Dai Stablecoin v1.0'. A key difference to note between Dai and most other popular ERC20 tokens is that both these fields use 'bytes32' instead of the 'string' type.
Token precision field decimals is set to 18 like most other ERC20 tokens.
Dai has been live on the Ethereum mainnet since December 17, 2017 and its current total supply can be viewed on MakerScan. Supply varies constantly as new tokens are generated or removed every time a user creates new debt or pays their existing debt off on their Collateralized Debt Position(CDP). You can also see additional stats of the token updated real-time on mkr.tools. Note that MakerScan or mkr.tools are websites maintained by the community and may not always produce accurate data.
The system internally uses 1 USD as the target price of Dai when it issues new debt or removes existing debt from a CDP but the market price of the token could vary based on a variety of conditions like exchange liquidity, trading pair etc.
Care should be taken before using the price of Dai directly reported by sources like CoinMarketCap, because exchange bugs may produce unreasonable price data. In many scenarios, such as displaying the value of Dai in a wallet, it is perfectly fine to hard code the price of a token to 1 USD.
Dai can be purchased with Ether on many popular exchanges, https://coinmarketcap.com/currencies/dai/#markets. It is also available on many decentralized exchanges like Eth2Dai, Kyber, and Uniswap.
You can also create your own Dai by opening a CDP with https://cdp.makerdao.com.
The best method to get Kovan Dai is to open a testnet CDP using Kovan ETH and create your required amount of Dai from it. The lowest collateralization ratio will give you the most bang for the buck! Another option is to buy Kovan Dai using Kovan ETH on Eth2Dai.io if there is sufficient liquidity available.
Dai token is deployed using the DSToken codebase from Dappsys. It implements all functions and events as defined in the ERC20 token standard. The codebase at commit e637e3f was used for deployments on both networks.
Binary approval can be given to addresses by token holders using approve(address) which sets the approved token amount to MAX_UINT.
DSToken implements additional mint and burn functions to increase/decrease the total token supply under certain conditions. Permission checks are delegated to an authority contract which checks whether the caller is authorized to execute these protected functions or not.
Tokens are created when a user adds collateral to their CDP and creates new Dai from it. Tokens are destroyed when the same user pays back the same amount of Dai they've previously issued for the system to remove them from the supply and return their locked collateral back.
Tub and Tap contracts in the Dai Credit System process calls to the Dai token which can increase or decrease the total supply. Tub contract stores all CDP records and has ownership over all the active collateral in the system. Tap contract facilitates liquidation by taking ownership over collateral ceased from an unsafe CDP, creates a negative debt record on the _sin _token, and allows external Keeper interactions to buy collateral and pay off the debt that an unsafe CDP owed to the system.
Mint has the function signature: mint(address guy, uint wad). It increases the total supply of the token as well as the guy's token balance by the wad amount. This generates an event with the signature: Mint(address indexed guy, uint wad). All calls to mint( ) originate from the draw( ) function on the Tub contract.
Burn has the function signature: burn(address guy, uint wad). It decreases the total supply of the token as well as the guy's token balance by the _wad _amount. It also generates an event with the signature: Burn(address indexed guy, uint wad).
There are few other functions which can call mint and burn but we can safely ignore discussing them here for the purposes of this document.
Owner variable in the contract has been set to the 0x0 address after deployment. Token holder functions like transferFrom(), and approve() are fully open for existing token holders to call.
The entire Dai Credit system comprises of a modular set of contracts that each perform one specific action. They use a common DSGuard authority, which has been instantiated during the initial deployment, with an access control list(ACL) to track contracts that are permitted to call functions on others. Permissions on this ACL cannot be updated, as both its owner and authority are also set to 0x0.
On the Dai token contract, Tub is permitted to both mint and burn Dai balance of any token holder. Tap is allowed to mint and burn Dai balance of a token holder, and also burn its own Dai balance.
Even though a stop modifier is present on all functions: Transfers, Approvals, Mint, and Burn, no address is permitted by the authority to call it which means that these functions cannot be stopped by anyone.[confirm?]
MKR holders through their governance contract can vote to shut down the system by executing the cage() function on the Top contract. Under normal conditions, this is only intended to be used after a majority of the CDP and Dai users have migrated to a new version, like Multi-Collateral Dai. It is a last layer of protection that sacrifices the stability of the Dai token to preserve its value for its holders.
After emergency shutdown, all DAI holders are allowed to claim collateral for each token at the last price reported by price feed oracles. Two functions- cash() and mock(), are activated in Tap. Cash() allows token holders to redeem Dai for ETH at the exchange ratio set at emergency shutdown. Mock() allows users to create Dai at the fixed ETH exchange ratio to avoid a supply crunch if other contracts and applications still need volatile Dai for their operations.
The transferFrom function has a few aliases available: push, pull, and move, both mint and burn functions also have aliases that automatically create or remove Dai of the msg.sender.
Deploy a DSToken
You will need to install dapptools to finish this section. Installation instructions can be found here, https://dapp.tools/ Your
.sethrc file should be initialized with the right values for the env variables SETHCHAIN and ETHFROM as mentioned here. Seth will automatically search the default folder paths for Geth and Parity keystores, or your Ledger hardware wallet, for the address.
Clone a local copy of the DSToken repo from this link, https://github.com/dapphub/ds-token.git
dapp update command will initialize all the git submodules present in the repo.
dapp build will build the codebase and generate the files required to deploy the token contract.
dapp create DSTokenFactory will deploy the DSTokenFactory contract first which we will use to create a new token next. Make a note of the address of the factory to use in our next command.
We can use seth to call_ make()_ on the factory contract with symbol and name data as input to deploy a new DSToken. Since we are deploying a new Dai token contract, we can use the bytes32 values to set the value of symbol to 'DAI' and name to 'Dai Stablecoin v1.0'.
seth send 0xAddressOfDeployedFactory 'make(bytes32,bytes32)' 0x4441490000000000000000000000000000000000000000000000000000000000 0x44616920537461626c65636f696e2076312e3000000000000000000000000000
This will deploy a new DSToken and set the address that deployed it as the owner.
In this guide, we briefly discussed the technical details of the Dai token contract as well as a quick summary of its role in the Dai Credit System. Please refer to the links embedded in the document as well as the additional resources section for more information. The Dai token itself is a small part of a rich set of tools and services built by a large group of partners around it and we urge you to explore this broader ecosystem too.
- MKR Token guide
- CDP Integration guide
- Contact integrations team - firstname.lastname@example.org
- Rocket chat - #dev channel