Porini's ERC-20 Smart Contract

This is Porini's ERC-20 smart contract, whose tokens can activate communities to support conservation activities and learn about blockchain technology.

Note 1: Upon customer's request, the token smart contract does not include pausable token transfers. Additionally, no mint and burn, burnFrom functions are included. Eventually, the token has 18 decimal digits and has a fixed minted supply of 21'000'000 (technically, this is achieved by calling the internal function _mint in the constructor).

Note 2: It is important to understand that decimals is only used for display purposes. All arithmetic inside the contract is still performed on integers, and it is the different user interfaces (wallets, exchanges, etc.) that must adjust the displayed values according to decimals.

Changelog

See the created CHANGELOG file in this repository.

Installation

1. Install the Truffle Framework

We use the Truffle framework for the compilation, testing, and deployment. Please follow their guide to install the framework on your computer.

2. Getting Started

Run npm i in order to install the necessary OpenZeppelin node modules as well as further required dependencies.

Compilation

To compile the contract, it is important that you have installed the project correctly, as we use external dependencies and contracts. Use the following command to compile the contracts:

truffle compile

Unit Tests

Since we build the ERC-20 smart contract on top of the audited OpenZeppelin node modules, there is no further requirement to write dedicated tests for these modules. Nonetheless, due to the fact that we integrate the non-standard permit method, unit tests have been written for this specific extension.

You can run the tests with

npx hardhat test

Furthermore, if you need to test the permit method on one of the live test networks, run the following command to generate the function parameters (assuming Node.js is installed):

node .\scripts\sign-data.js

Deployment

Local Deployment With Ganache

To deploy the contract on your local Ganache blockchain, you must first install the software on your computer. Follow the installation guide.

Once you installed the local blockchain, you can create a workspace. This is described here.

Note: We have observed that Truffle and Ganache do not use the same default RPC configuration. The easiest way to align is to adjust Ganache's server hostname, port, and network ID with Truffle's configurations (check the file truffle-config.js).

Once you are setup, just run:

truffle migrate --network development

Rinkeby

To deploy the smart contract to Rinkeby, you need to preconfigure first some things:

Create a secrets.json file.
Create a MetaMask Wallet and paste the respective seedphrase into secrets.json. Make sure you got some ETH. You can get some here.
Create a new Infura project and copy the project key into secrets.json.
Create a Etherscan account and copy the API key to secrets.json. The file will look like the following (make sure to always .gitignore it!):

{
    "seedPhrase": "drip voice crush ...",
    "privateKey": "0c7342ea3cdcc0...",
    "owner": "0x3854Ca47Abc6...",
    "projectId": "a657e3934de84d...",
    "etherscanKey": "RQFAFV4DE1H75P..."
}

Now run the following command:

truffle migrate --network rinkeby

If the deployment was successful, you will get the final deployment result:

Copy the contract address and verify the contract right away so that you can interact with it. Run the following command:

truffle run verify PoriniCommunityToken@<CONTRACTADDRESS> --network rinkeby

If the verification was successful, you will see a similar result as follows:

PoriniCommunityToken@0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C
Pass - Verified: https://rinkeby.etherscan.io/address/0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C#contracts
Successfully verified 1 contract(s).

For more information, see here.

Note: The smart contract PoriniCommunityToken.sol does include the permit method, which can be used to change an account's ERC20 allowance (see IERC20.allowance) by presenting a message signed by the account. By not relying on IERC20.approve, the token holder account doesn't need to send a transaction, and thus is not required to hold Ether at all.

Interaction

If you deployed the smart contract succefully, you are now able to interact with it.

Local Interaction With the Truffle CLI

To start the Truffle JavaScript console, please run:

truffle develop

In the console, you can create an instance of the provided contract by typing:

let i = await PoriniCommunityToken.deployed()

You can use the instance variable to call functions like symbol:

i.symbol()

Rinkeby

Go to the corresponding Etherscan link, e.g. https://rinkeby.etherscan.io/address/CONTRACTADDRESS#code. You are able to invoke READ and WRITE functions on the contract.

Test Deployments

The smart contract PoriniCommunityToken.sol has been deployed across all the major test networks:

Rinkeby: 0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C
Ropsten: 0xeb8647302b2F97653452Ce1582E046e205D515bc
Kovan: 0xbB5C47840930Af779042b6209c064B8Ac9247848
Goerli: 0x667483ec1078c64f8D7e35B49152C3c2C87cCB56

Production Deployments on SustainabilityChain

The smart contract PoriniCommunityToken.sol has been deployed to the SustainabilityChain network with Remix^* and signed with the PoriniCommunityToken hardware wallet (Ledger Nano S):

Contract creation transaction hash: 0xcbca637e085f83a84c6b0ec557de96868df4cf68e82a8737f5dff3db74f79788
Contract address: 0x62DAE5fD87368F56aF3D576D4837523429DcE2b1
Contract admin: 0xc4d8b0D2436D0E317958330E179A1787C8e38202
Contract Application Binary Interface (ABI): Can be downloaded from the snippet. This file was copied from Remix after compilation.

Note 1: Make sure that you always copy the full smart contract ABI and not just one of the inherited interfaces!

Note 2: Remix uses checksummed addresses for the At Address button and if it's invalid the button is disabled. Always use checksummed addresses with Remix! One way to handle this is by using EthSum. The checksum algorithm is laid out in full detail here.

^* Remix deployment configuration:

Compiler: 0.8.6+commit.11564f7e;
Language: Solidity;
EVM Version: compiler default;
Enable optimization: 200;
Only the smart contract PoriniCommunityToken.sol was used for compilation and deployment. Remix imported the dependencies successfully (see here how this works in the background with the .deps folder);