How To Create and Deploy an XRC20 Token Using Truffle
Use Truffle to deploy an XRC20 Token.
🧭 Table of contents
📰 Overview
Truffle is a blockchain development environment that you can use to create and test smart contracts by levering an Ethereum Virtual Machine.
What you will learn
In this tutorial, you will learn how to set up Truffle and use it to build, test, and deploy a XRC20 Token on both the XDC Network mainnet and XDC Apothem testnet.
What you will do
Install and setup Truffle
Create an XRC20 token
Compile the XRC20 token
Deploy the XRC20 token
Interact with the XRC20 token
Check the deployment status on xinfin.network
📰 About XRC20 Tokens
XRC20 is a set of rules to standardize assets on the XDC network. Every XRC20 token must be able to execute the following methods:
totalSupply()
balanceOf(address account)
allowance(address owner, address spender)
transfer(address recipient, uint amount)
approve(address spender, uint amount)
transferFrom(address sender, address recipient, uint amount)
These are the minimum required methods that allow an asset on the XDC Network to be called an XRC20 token. An XRC20 token must be able to emit the following Events
on the blockchain:
Approval(address indexed tokenOwner, address indexed spender, uint tokens)
Transfer(address indexed from, address indexed to, uint tokens)
Events are help with the process of indexing state changes, and they are essential to allowing off-chain applications to find relevant data on the blockchain. By mapping all Transfer
events, for example, we can fetch all the historic data on token transfers more easily.
Several contract constants are public and very important to have:
name
symbol
decimals
Without these public constants, it would be impossible to label tokens on block explorers, for example. In this tutorial, we will deploy a XRC20 token that have all the Methods
, Events
and Constants
mentioned above.
🚀 Setting up the development environment
Here are several technical requirements before you get started. Please install the following:
Node.js v8+ LTS and npm (comes with Node)
Once you have installed those, you only need one command to install Truffle:
To verify that Truffle is installed properly, type truffle version
on a terminal. You should see something like:
If you see an error instead, make sure that your npm modules are added to your path.
⚒ Starting a new Truffle Project
Start by setting up our folder. As we are creating a project called XRC20
, create a new XRC20
folder by running on terminal:
Next, run truffle init
. If truffle is correctly installed on your local environment, you should see the following message:
Your folder files will look like this:
⚒ Configuring XDC Mainnet and Apothem Testnet on Truffle
In order to get started deploying new contracts on the XDC Mainnet and/or Apothem, we need to install two new dependencies that will be used in the truffle-config.js
file. These dependencies are @truffle/hdwallet-provider
and dotenv
. First choose your preferred package manager. In this example we are using yarn
but you can also use npm
.
If you never used yarn
before, you will likely need to install it first.
‼️You can skip this step if you already have yarn installed‼️
Initialize your package manager on your folder and install the required dependencies:
You will also need a 24-Word Mnemonic Phrase. To configure your wallet, create a new .env
file and write your mnemonic by running:
Remember to change the 24-Word Mnemonic above for your own mnemonic. The contents of your .env
file should read as follow:
🚨 Do not use the mnemonic in the example above in production or you can risk losing your assets and/or the ownership of your smart contracts! 🚨
Finally, you can configure the truffle-config.js
file for both Apothem and XinFin Networks by writting:
⚒ Adding Testnet XDC to Development Wallet
It is possible to list all XDC addresses bound to your mnemonic on truffle by accessing the truffle console:
Once the truffle console CLI opens, you can run:
And the console should log all accounts bound to your mnemonic phrase as follow:
These accounts are on the Ethereum standard format starting with 0x
, but we can simply switch 0x
for xdc
. By default, the deployment account is the first account from the list above: xdcA4e66f4Cc17752f331eaC6A20C00756156719519
.
With this account, you can head to the Apothem Faucet and claim some TXDC for development purposes:
💵 Writing our first XRC20 Token
The source code for the XRC20 Token used in this tutorial is available here: XRC20 Contract Folder. But we will address all Events
, Methods
and Constants
mentioned in the section 📰 About XRC20 Tokens.
You can start by creating the XRC20.sol
file:
Next, write the shell of our smart contract by writing:
💵 Constants
Inside your contract XRC20Token
, you will need to instantiate name
, symbol
and decimals
as public variables as well as a private _totalSupply
that will be used on our totalSupply()
method later on. You'll also have two mapping variables, balances
and allowances
, that are key/value variables that maps user balances and approved spending allowances to other users:
💵 Events
As mentioned in 📰 About XRC20 Tokens, events are very important part of a smart contract logic. Events have indexed
variables that are variables that can be filtered by off-chain interfaces. You might be tempted to index all the variables tied to an on-chain event, however Solidity has a maximum of 3 indexed variable limitation for events. You should write both Approval
and Transfer
events:
💵 Methods
We need to create the six methods mentioned in 📰 About XRC20 Tokens (totalSupply
, balanceOf
, allowance
, transfer
, approve
and transferFrom
), as well as a constructor
that is a function called only once when the contract is deployed. In the latter, we can attatch information such as the token name, decimals and/or initial token supply:
Now you have implemented everything we needed to make our token compliant with the XRC20 standard. Of course there are more features we can implement to this contract, such as the SafeMath library that replace naive mathematical operations for methods that will avoid underflows
and overflows
, and supply management methods such as mint
and burn
.
💵 Compiling and Deploying
We can compile our MyToken.sol
by running:
If everything is correctly configured and there are no errors, you will see the following message on your console:
Your folder should look like this:
In order to deploy our newly compiled contract artifacts to the blockchain, you'll need to create a deployment script into the migrations folder:
Next, write the following migration script to the 1_token_migration.js
file:
If the migration script have no errors, you can run the following command for deployment on the XDC mainnet:
Or the following commard for deployment on the XDC Apothem Testnet:
In either case, you'll need to have enough funds to pay for gas fees on the address that is being used for development.
If the deployment is sucessful, the console will log the following message after migrations complete processing:
🔍 Veryfing Contracts on the Block Explorer
Once you have successfully deployed your smart contract to the blockchain, it might be interesting to verify yout contract on XinFin Block Explorer.
You can check the address that your contract is deployed to by running:
If you have a contract deployed, the console should log something like this:
In this example, we have a XRC20Token
contract deployed on XDC Mainnet at the 0x53bA8Cb12EaF09E6B0b671F39ac4798A6DA7d660
. This address is in the Ethereum standard but we can simply swap the 0x
prefix for xdc
and search for our newly deployed contract on XinFin Block Explorer:
And click in the Verify And Publish
Option.
You will be redirected to the contract verification page where you have to fill out:
Contract Name: XRC20Token
Compiler: Check your
truffle-config.js
file for Compiler VersionContract Code: Just paste everything from your
MyToken.sol
file
Once everything is filled out, press Submit!
If everything is correctly filled out, your contract page on the block explorer will display a new tab called Contract
:
🔍 Interacting with your contract on the Block Explorer
With your XDCPay wallet, it is possible to interact with verified smart sontracts on the XinFin Network Block Explorer. You can read from, write to, or simply read the information tied to your smart contract on the blockchain.
Lets head to the Contract
tab on the explorer. Choose Write Contract
and click in Connect to Web3
to connect your XDCPay wallet.
You can try transfering 500 MTK
tokens that we have just created to a new wallet xdc0431d52fe37f3839895018272dfa3ba189fce07e
. Lets fill out the recipient
field with the new wallet address, and fill out the amout
field with 500 * 10^18
. Remember that our token has 18 decimals, and when you write numbers with decimals to the blockchain you must to account for the decimals as the virtual machine does not understand floating numbers like we humans do:
After clicking Write
, you need to confirm the transaction on the XDCPay wallet:
You can check your successful transaction on the Block Explorer!
For more information about Truffle Suite, Please Visit Truffle Suite Documentation. For more information about XinFin Network, Please Visit XDC Network Documentation on GitBook. Resources used during the deployment of the XRC20 Token can be found at XRC20 Contract Folder.
Last updated