> For the complete documentation index, see [llms.txt](https://odin.ubiqsmart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://odin.ubiqsmart.com/user-guides/token-guide.md). # Deploy an ERC-20 This guide can be used to deploy your own ERC20 token on the Ubiq network by following step-by-step instructions. Please note that while this guide is written for ERC20 tokens, any of the token standards can be deployed on the Ubiq network. This guide is based on the blog post [here](https://blog.ubiqsmart.com/creating-your-first-ubiq-token-d9f8ff7a4f15). ## Environment Prerequisites * [NodeJS](https://nodejs.org/) * [Truffle](https://www.trufflesuite.com/) * [OpenZeppelin](https://openzeppelin.com/) ## Installing NodeJS Installing NodeJS version **Node.js v14.x** #### On macOS The package installer for macOS can be found [here](https://nodejs.org/en/download/). #### On Debian / Ubuntu Input the install commands by following the instructions for version **Node.js v14.x** found [here](https://github.com/nodesource/distributions/blob/master/README.md#debinstall). ## Installing Truffle With NodeJS version **14.x** installed, use the following command to install Truffle. `npm install -g truffle` If you receive a permissions error, use: `sudo npm install -g truffle` ## Create a directory for your token code Create a directory to work from in an easy-to-find location. As an example, start in a high level directory like; #### Debian / Ubuntu `cd /home/yourusername` And make a directory for your ERC20: `mkdir thenameofyourtoken` and switch to that directory: `cd thenameofyourtoken` #### macOS `cd /Users/home` And make a directory for your ERC20: `mkdir thenameofyourtoken` and switch to that directory: `cd thenameofyourtoken` ## Using Trufflebox to install Modules, Contracts & Libraries Install Truffle's standard tutorial token library to acquire the needed pieces to compile your project. Working within your project's new directory `thenameofyourtoken` run the command; `truffle unbox tutorialtoken` ## Configure truffle This step is optional but highly recommended, it will significantly reduce the size of the bytecode produced when compiling the token later in the guide. Open truffle.js and add the following options. ``` module.exports = { // See // for more about customizing your Truffle configuration! compilers: { solc: { version: "0.6.12", settings: { optimizer: { enabled: true, runs: 200 }, } } } }; ``` ### Install OpenZeppelin We will be using standard token code provided by [OpenZeppelin](https://openzeppelin.org/), install in your local working directory using npm. ``` npm install @openzeppelin/contracts --save ``` ### Fusion Install Fusion if you don’t already have it, you can grab the latest version from the GitHub releases page [here](https://github.com/ubiq/fusion/releases). Get it syncing, it may take up to an hour to do the initial sync depending on connections and hardware. You will also need a small amount of UBQ to deploy the token, 1 UBQ is more than enough. ## The token Now everything is ready to go it’s time to work on the actual token. In the **contracts/** directory (created by the unpacked Truffle Box) create a new file **Blemflarck.sol** and start by adding the follow solidity code. ``` // SPDX-License-Identifier: MIT pragma solidity ^0.6.0; import "@openzeppelin/contracts/presets/ERC20PresetMinterPauser.sol"; contract Blemflarck is ERC20PresetMinterPauser { } ``` * We import ERC20PresetMinterPauser.sol from OpenZeppelin. * We declare the contract **Blemflarck** as a **ERC20PresetMinterPauser**, inheriting all variables and functions from the ERC20PresetMinterPauser.sol imported above. Next we need to set parameters specific to our token; name, symbol, decimals and initial supply. Add the following to the contract object. ``` constructor() public ERC20PresetMinterPauser("Blemflarck", "BLMFLK") { _setupDecimals(2); _mint(msg.sender, 10008 * (10 ** 2)); } ``` * The **name** and **symbol** variables should be self explanatory, these are the equivalent of Ubiq (name) and UBQ (symbol). * The **decimals** variable determines how many decimals places the token has, in this case I have gone with 2 to keep thing familiar (cents) * The **initial supply** defines the number of tokens created when the contract is deployed, this needs to be defined in the smallest unit, in this case cents (1 token = 100 cents). We will create 10,008 tokens when deploying the token. We are now done with the code. You should have something that looks like this. ``` // SPDX-License-Identifier: MIT pragma solidity ^0.6.0; import "@openzeppelin/contracts/presets/ERC20PresetMinterPauser.sol"; contract Blemflarck is ERC20PresetMinterPauser { constructor() public ERC20PresetMinterPauser("Blemflarck", "BLMFLK") { _setupDecimals(2); _mint(msg.sender, 10008 * (10 ** 2)); } } ``` ### Compiling the token Modify contracts/Migrations.sol so that it can compile with the newer version of Solidity. Replace the first line with: ``` pragma solidity >=0.5.16 <0.9.0; ``` We will be using truffle to compile to utilize the solc optimizations we configured earlier. As everything is already set up, we can simply run ``` truffle compile ``` ![Compiling with truffle](https://miro.medium.com/max/732/1*Ajz1G6GNTQui84Qq2ijFTg.png) ### **Deploy with Fusion** Open **build/contracts/Blemflarck.json** and scroll down to the **bytecode** key and copy its value (without the quotes) ![Token bytecode](https://miro.medium.com/max/1256/1*MbiyysTJO6yvtgQOhY9B5A.png) In fusion go to the contracts view, click the **deploy new contract** button, select the address you wish to use to deploy, this address will pay the gas for the deploy transaction and receive the initial token supply. Leave the amount field empty. By default the **solidity contract source code** tab is active, as we have already compiled the byte code, select **contract byte code** and paste the tokens byte code (copied above) into the contract code field. ![Deploying the Contract in Fusion](https://miro.medium.com/max/950/1*vpp2vEKPuEXTJU0vSNDdPw.png) You can leave the fee as default (cheaper) and click **deploy**. You will be prompted to enter the passphrase for the address you are deploying from, do this then **send transaction**. Now you just need to wait until the transaction is included in a valid block, and we can continue to the final step. ![Contract deployed, waiting for confirmation](https://miro.medium.com/max/834/1*DHO11n_JdgnhWiXeQo-TuA.png) ### **Adding your token to Fusion** Once confirmed you will be able to see the tokens contract address ![](https://miro.medium.com/max/828/1*_wy8A1rPfigpzVf7Cgnsxg.png) Copy the contract address. Now head back to the contracts view, scroll to the bottom and click **watch token.** Paste the **token contract address** into the first field, the remaining fields will auto complete. Click **OK**. ![Token being added to Fusion](https://miro.medium.com/max/453/1*cOVe7xbgjdCvuZiSJ5FPTA.png) You will now see your token listed in **custom tokens** on the contracts view. If you select your address on the wallet view, you will also see you have a balance of 10,008 Blemflarck. *As of April 1st 2017, the Blemflarck**,** also known as galactic credits**,** has a value of 0 of itself (*[*thanks Rick*](https://www.youtube.com/watch?v=H0sUMe1Z8-0)*)* We are now done creating your first ERC20 token on Ubiq. It only has basic functionality (transfer, transferFrom, approve, decrease approval, increase approval), in the next guide we will create tokens with additional functionality (burn, mint, timelock), keep your project directory as we will need that later. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://odin.ubiqsmart.com/user-guides/token-guide.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.