Merge pull request #1 from rsksmart/DAO-384

DAO-384 Added RIF-Token contract

Author: jessgusclark

.github/workflows/ci.yml

@@ -17,6 +17,9 @@ jobs:
     - name: Install dependencies
       run: yarn
 
+    - name: Compile contracts
+      run: yarn compile
+
     - name: Test and Lint
       run: |
         yarn test

.gitignore

@@ -15,3 +15,6 @@ node_modules
 
 # Hardhat Ignition default folder for deployments against a local node
 ignition/deployments/chain-31337
+
+# PHPStorm
+.idea

.solhintignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+contracts/RIFTokenTest.sol

README.md

@@ -11,3 +11,28 @@ REPORT_GAS=true npx hardhat test
 npx hardhat node
 npx hardhat ignition deploy ./ignition/modules/Lock.ts
 ```
+## RIF Token
+
+The first contract that has been brought to the project is the RIF Token contract [RIFLabs RIF-Token](https://github.com/riflabs/RIF-Token)
+
+A few simple tests have been created to make sure that the token works.
+
+Refer to ```test/RIFToken.ts```
+
+What is tested:
+
+- That the contract has the initial balance defined in the RIFToken.sol
+- That the function ```.validAddress(address)``` works
+- That the ```transferAll()``` function works by using ```.setAuthorizedManagerContract```
+- That we can transfer token between accounts
+- That it emits a Transfer event
+
+## Note
+
+We will be using RIF-Token from the repository [RIFLabs RIF-Token](https://github.com/riflabs/RIF-Token)
+
+The repository does not contain a package.json, causing hardhat to error when running ```yarn compile```
+
+We decided (in the meantime) to fork the repository and add it there [Forked Repository](https://github.com/Freshenext/RIF-Token)
+
+**In the future we must add a package.json to the main repository, and remove the forked repository.**

contracts/RIFTokenTest.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.4.24;
+
+import "rif-token-contracts/contracts/RIF/RIFToken.sol";
+// File must exist, else test/RIFTokenTest.ts will fail
+contract RIFTokenTest is RIFToken {
+    constructor () RIFToken () {
+        
+    }
+}

hardhat.config.ts

@@ -2,7 +2,12 @@ import { HardhatUserConfig } from "hardhat/config";
 import "@nomicfoundation/hardhat-toolbox";
 
 const config: HardhatUserConfig = {
-  solidity: "0.8.24",
+  solidity: {
+    compilers: [
+      { version: '0.8.24' }, 
+      { version: '0.4.24' }
+    ]
+  },
 };
 
 export default config;

package.json

@@ -43,5 +43,8 @@
     "typechain": "^8.3.0",
     "typescript": "^5.4.5",
     "typescript-eslint": "^7.11.0"
+  },
+  "dependencies": {
+    "rif-token-contracts": "https://github.com/Freshenext/RIF-Token"
   }
 }

test/RIFToken.test.ts

@@ -0,0 +1,88 @@
+import { expect } from 'chai';
+import { ethers } from 'hardhat';
+import { loadFixture } from '@nomicfoundation/hardhat-toolbox/network-helpers';
+
+describe("RIFToken Contract", function () {
+
+  async function deployRif() {
+    const [owner, addr1, addr2, ...addrs] = await ethers.getSigners();
+
+    // Deploy AddressHelper library
+    const addressHelper = await ethers.deployContract("AddressHelper");
+    // Deploy AddressLinker library
+    const addressLinker = await ethers.deployContract("AddressLinker", { libraries: { AddressHelper: addressHelper }});
+
+    // Link libraries
+    const rifToken = await ethers.deployContract("RIFToken", {
+      libraries: {
+        AddressLinker: addressLinker,
+        AddressHelper: addressHelper,
+      },
+    });
+    
+    return {
+      rifToken,
+      owner,
+      addr1,
+      addr2,
+      addrs
+    }
+  }
+  
+  it("Should assign the initial balance to the contract itself", async function () {
+    const { rifToken } = await loadFixture(deployRif)
+    const contractBalance = await rifToken.balanceOf(rifToken);
+    expect(contractBalance).to.equal(ethers.parseUnits("1000000000", 18));
+  });
+
+  it("Should use validAddress", async function () {
+    const { rifToken, addr1 } = await loadFixture(deployRif)
+    const addressOne = await addr1.getAddress();
+    const isAddressOneValid = await rifToken.validAddress(addressOne)
+    expect(isAddressOneValid).to.be.true;
+    
+  });
+  
+  // Single block to test the entire Transfer flow
+  
+  let rifFixture: Awaited<ReturnType<typeof deployRif>>
+  
+  it("Should transfer all the tokens to deployer/owner using setAuthorizedManagerContract", async function() {
+    rifFixture = await loadFixture(deployRif)
+    const { rifToken, owner } = rifFixture
+    await rifToken.setAuthorizedManagerContract(owner)
+    
+    expect(await rifToken.balanceOf(owner)).to.be.equal(ethers.parseUnits('1000000000', 'ether'))
+  })
+
+  it("Should transfer tokens between accounts", async function () {
+    const { rifToken, addr1, addr2 } = rifFixture
+    // Close distribution
+    const latestBlock = await ethers.provider.getBlock('latest')
+    
+    if (latestBlock) {
+      // We must close tokenDistribution to send transactions
+      await rifToken.closeTokenDistribution(latestBlock.timestamp)
+
+      // Transfer 50 RIF Tokens to address 1
+      await rifToken.transfer(addr1, ethers.parseUnits("50", 'ether'));
+      const addr1Balance = await rifToken.balanceOf(addr1);
+      expect(addr1Balance).to.equal(ethers.parseUnits("50", 'ether'));
+
+      // Transfer 10 RIF Tokens from address 1 to address 2
+      await rifToken.connect(addr1).transfer(addr2, ethers.parseUnits("10", 'ether'));
+      const addr2Balance = await rifToken.balanceOf(addr2);
+      expect(addr2Balance).to.equal(ethers.parseUnits("10", 'ether'));
+    }
+  });
+  
+  it('Should make sure that the "Transfer" event is emitted', async () => {
+    // Also check that the event "Transfer" is emitted
+    const { rifToken, addr1, owner } = rifFixture
+    
+    await expect(
+      rifToken.transfer(addr1, 1)
+    ).to.emit(rifToken, 'Transfer(address,address,uint256)')
+      .withArgs(owner, addr1, 1)
+  })
+});

yarn.lock

@@ -3967,6 +3967,10 @@ reusify@^1.0.4:
   resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76"
   integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==
 
+"rif-token-contracts@https://github.com/Freshenext/RIF-Token":
+  version "1.0.0"
+  resolved "https://github.com/Freshenext/RIF-Token#c45fac79ec19c02d832e098140d17820d0c99192"
+
 rimraf@^2.2.8:
   version "2.7.1"
   resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.7.1.tgz#35797f13a7fdadc566142c29d4f07ccad483e3ec"