Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pcaversaccio/porini-community-token-contract
This is Porini's ERC-20 smart contract, whose tokens can activate communities to support conservation activities and learn about blockchain technology.
https://github.com/pcaversaccio/porini-community-token-contract
blockchain erc20 ethereum openzeppelin smart-contracts solidity
Last synced: 15 days ago
JSON representation
This is Porini's ERC-20 smart contract, whose tokens can activate communities to support conservation activities and learn about blockchain technology.
- Host: GitHub
- URL: https://github.com/pcaversaccio/porini-community-token-contract
- Owner: pcaversaccio
- License: mit
- Created: 2021-07-09T08:59:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T11:32:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T23:06:12.735Z (about 1 month ago)
- Topics: blockchain, erc20, ethereum, openzeppelin, smart-contracts, solidity
- Language: JavaScript
- Homepage:
- Size: 299 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Porini's ERC-20 Smart Contract
This is Porini's [ERC-20](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20) 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](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Pausable) token transfers. Additionally, no [`mint`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20-_mint-address-uint256-) and [`burn`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Burnable), [`burnFrom`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Burnable) 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`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20-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`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20-decimals--).
## Changelog
See the created [`CHANGELOG`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/CHANGELOG.md) 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](https://www.trufflesuite.com/truffle) to install the framework on your computer.
### 2. Getting Started
Run `npm i` in order to install the necessary [OpenZeppelin node modules](https://www.npmjs.com/package/@openzeppelin/contracts) 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](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20) smart contract on top of the audited [OpenZeppelin node modules](https://www.npmjs.com/package/@openzeppelin/contracts), there is no further requirement to write dedicated tests for these modules. Nonetheless, due to the fact that we integrate the non-standard [`permit`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Permit-permit-address-address-uint256-uint256-uint8-bytes32-bytes32-) 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`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Permit-permit-address-address-uint256-uint256-uint8-bytes32-bytes32-) method on one of the live test networks, run the following command to generate the function parameters (assuming [Node.js](https://nodejs.org/en) 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](https://www.trufflesuite.com/ganache).
Once you installed the local blockchain, you can create a workspace. This is described [here](https://www.trufflesuite.com/docs/ganache/workspaces/creating-workspaces).
> **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`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/truffle-config.js)).
Once you are setup, just run:
```
truffle migrate --network development
```
### Rinkeby
To deploy the smart contract to [Rinkeby](https://rinkeby.etherscan.io), you need to preconfigure first some things:
1. Create a `secrets.json` file.
2. Create a [MetaMask Wallet](https://metamask.io) and paste the respective seedphrase into `secrets.json`. Make sure you got some ETH. You can get some [here](https://faucet.rinkeby.io).
3. Create a new [Infura project](https://infura.io) and copy the project key into `secrets.json`.
4. Create a [Etherscan](https://etherscan.io) account and copy the API key to `secrets.json`.
The file will look like the following (make sure to always [`.gitignore`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/.gitignore) it!):
```json
{
"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@ --network rinkeby
```
If the verification was successful, you will see a similar result as follows:
```bash
PoriniCommunityToken@0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C
Pass - Verified: https://rinkeby.etherscan.io/address/0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C#contracts
Successfully verified 1 contract(s).
```
For more information, see [here](https://github.com/rkalis/truffle-plugin-verify).
> **Note:** The smart contract [`PoriniCommunityToken.sol`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/contracts/PoriniCommunityToken.sol) does include the [`permit`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Permit-permit-address-address-uint256-uint256-uint8-bytes32-bytes32-) method, which can be used to change an account's ERC20 allowance (see [`IERC20.allowance`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#IERC20-allowance-address-address-)) by presenting a message signed by the account. By not relying on [`IERC20.approve`](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#IERC20-approve-address-uint256-), 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:
```javascript
let i = await PoriniCommunityToken.deployed()
```
You can use the instance variable to call functions like symbol:
```javascript
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`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/contracts/PoriniCommunityToken.sol) has been deployed across all the major test networks:
- **Rinkeby:** [0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C](https://rinkeby.etherscan.io/address/0x67A64D9F71AAa0bE4a7D3DEef91c2707F691983C)
- **Ropsten:** [0xeb8647302b2F97653452Ce1582E046e205D515bc](https://ropsten.etherscan.io/address/0xeb8647302b2F97653452Ce1582E046e205D515bc)
- **Kovan:** [0xbB5C47840930Af779042b6209c064B8Ac9247848](https://kovan.etherscan.io/address/0xbB5C47840930Af779042b6209c064B8Ac9247848)
- **Goerli:** [0x667483ec1078c64f8D7e35B49152C3c2C87cCB56](https://goerli.etherscan.io/address/0x667483ec1078c64f8D7e35B49152C3c2C87cCB56)
## Production Deployments on SustainabilityChain
The smart contract [`PoriniCommunityToken.sol`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/contracts/PoriniCommunityToken.sol) has been deployed to the SustainabilityChain network with [Remix* ](http://remix.ethereum.org) and signed with the PoriniCommunityToken hardware wallet (Ledger Nano S):
- Contract creation transaction hash: [0xcbca637e085f83a84c6b0ec557de96868df4cf68e82a8737f5dff3db74f79788](https://expedition.dev/tx/0xcbca637e085f83a84c6b0ec557de96868df4cf68e82a8737f5dff3db74f79788?network=Porini)
- **Contract address:** [0x62DAE5fD87368F56aF3D576D4837523429DcE2b1](https://expedition.dev/address/0x62DAE5fD87368F56aF3D576D4837523429DcE2b1?network=Porini)
- **Contract admin:** [0xc4d8b0D2436D0E317958330E179A1787C8e38202](https://expedition.dev/address/0xc4d8b0D2436D0E317958330E179A1787C8e38202?network=Porini)
- Contract Application Binary Interface (ABI): Can be downloaded from the [snippet](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/snippets/19). 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](https://ethsum.netlify.app). The checksum algorithm is laid out in full detail [here](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-55.md).
* Remix deployment configuration:
- Compiler: `0.8.6+commit.11564f7e`;
- Language: `Solidity`;
- EVM Version: `compiler default`;
- Enable optimization: `200`;
- Only the smart contract [`PoriniCommunityToken.sol`](https://gitlab.appswithlove.net/green_list_market/porini-community-token-contract/-/blob/main/contracts/PoriniCommunityToken.sol) was used for compilation and deployment. Remix imported the dependencies successfully (see [here](https://remix-ide.readthedocs.io/en/latest/import.html) how this works in the background with the `.deps` folder);
## Further References
[1] https://docs.openzeppelin.com/contracts/4.x/erc20
[2] https://github.com/rkalis/truffle-plugin-verify
[3] https://www.trufflesuite.com/ganache
[4] https://www.trufflesuite.com/truffle