Merge pull request #2 from XIO-Network/dev

flashmit unit test added

Author: shakeib98

.gitignore

@@ -19,3 +19,4 @@ coverage.json
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+pre-commit.sh

.huskyrc

@@ -1,7 +1,21 @@
-# WTFPL
+MIT License
 
-by Paul Razvan Berg (@PaulRBerg)
+Copyright (c) 2020 Xord
 
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-0. You just DO WHAT THE FUCK YOU WANT TO.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.md

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity 0.6.12;
 
 interface IFlashMinter {

.commitlintrc.js renamed to commitlint.config.js

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.6.12;
+
+interface IFlashMint {
+    function flashMint(uint256 value,bytes calldata data) external;
+}

contracts/interfaces/IFlashMinter.sol

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.6.12;
+
+import "../interfaces/tests/IFlashMint.sol";
+import "../interfaces/IFlashMinter.sol";
+import "../interfaces/IERC20.sol";
+
+contract FlashMinter is IFlashMinter {
+
+    address FLASH_CONTRACT;
+
+    constructor(address _token) public{
+        FLASH_CONTRACT = _token;
+    }
+
+    function flashMint(uint256 _value, bytes calldata _data) public {
+        IFlashMint(FLASH_CONTRACT).flashMint(_value,_data);
+    }
+
+    function executeOnFlashMint(bytes calldata data) public override {
+         (bool flag, uint256 value,address sender) = abi.decode(data, (bool, uint256,address));
+         
+         if(flag){
+             IERC20(FLASH_CONTRACT).transfer(sender,value);
+         }
+    }
+}

contracts/interfaces/tests/IFlashMint.sol

@@ -64,7 +64,7 @@ const config: HardhatUserConfig = {
   paths: {
     artifacts: "./artifacts",
     cache: "./cache",
-    sources: "./contracts",
+    sources: "./contracts/",
     tests: "./test",
   },
   solidity: {

contracts/tests/FlashMinter.sol

@@ -1,11 +1,7 @@
 {
-  "name": "@XORD-one/xio-flash-token",
+  "name": "@XIO-Network/xio-flash-token",
   "description": "xio flash token smart contract repo",
   "version": "1.0.0",
-  "author": {
-    "name": "XORD.ONE",
-    "url": "https://xord.com"
-  },
   "devDependencies": {
     "@commitlint/config-conventional": "^9.1.2",
     "@ethersproject/abstract-signer": "^5.0.6",
@@ -53,10 +49,17 @@
     "smart-contracts",
     "solidity"
   ],
-  "license": "WTFPL",
+  "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "sh ./pre-commit.sh",
+      "pre-push": "yarn test"
+    }
+  },
   "scripts": {
     "clean": "hardhat clean",
     "commit": "git-cz",
@@ -69,9 +72,10 @@
     "prettier:list-different": "prettier --config .prettierrc --list-different \"**/*.{js,json,md,sol,ts}\"",
     "test": "hardhat test",
     "typechain": "hardhat typechain",
-    "deploy":"hardhat run ./scripts/deploy.ts"
+    "deploy": "hardhat run ./scripts/deploy.ts"
   },
   "dependencies": {
+    "@commitlint/cli": "^11.0.0",
     "ethereumjs-util": "^7.0.7"
   }
 }

hardhat.config.ts

@@ -5,10 +5,11 @@ import {
   toUtf8Bytes,
   solidityPack
 } from "ethers/lib/utils";
-import { expect, use} from "chai";
+import { expect, use } from "chai";
 import { deployContract, MockProvider, solidity } from "ethereum-waffle";
-import BasicToken from "../artifacts/contracts/FlashToken.sol/FlashToken.json";
-import { constants } from "ethers";
+import FlashTokenArtifact from "../artifacts/contracts/FlashToken.sol/FlashToken.json";
+import MinterContractArtifact from "../artifacts/contracts/tests/FlashMinter.sol/FlashMinter.json";
+import { constants, ethers } from "ethers";
 import { ecsign } from "ethereumjs-util";
 import { mintTokens } from './utils/functions'
 
@@ -27,33 +28,33 @@ describe("Flash token", async () => {
     "0xc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc6";
 
   beforeEach(async () => {
-    FlashToken = await deployContract(wallet, BasicToken, [wallet.address, wallet.address]);
+    FlashToken = await deployContract(wallet, FlashTokenArtifact, [wallet.address, wallet.address]);
   });
-  
+
 
   it("name", async () => {
     const name = await FlashToken.name();
     expect(name).to.be.equal("Flash Token");
   });
-  
-  
+
+
   it("symbol", async () => {
     expect(await FlashToken.symbol()).to.be.equal("FLASH");
   });
 
-  
+
   it("decimals", async () => {
     expect(await FlashToken.decimals()).to.be.equal(18);
   });
 
-  
+
   it("name hash", async () => {
     expect(keccak256(toUtf8Bytes("FLASH"))).to.be.equal(
       "0x345b72c36b14f1cee01efb8ac4b299dc7b8d873e28b4796034548a3d371a4d2f"
     );
   });
 
-  
+
   it("version hash", async () => {
     expect(keccak256(toUtf8Bytes("1"))).to.be.equal(
       "0xc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc6"
@@ -91,7 +92,7 @@ describe("Flash token", async () => {
 
   it("transfer", async () => {
 
-    let AMOUNT = await mintTokens(FlashToken,wallet.address);
+    let AMOUNT = await mintTokens(FlashToken, wallet.address);
 
     await expect(FlashToken.transfer(walletTo.address, AMOUNT))
       .to.emit(FlashToken, "Transfer")
@@ -104,11 +105,11 @@ describe("Flash token", async () => {
 
   it("transfer fail -> this token address", async () => {
 
-    let AMOUNT = await mintTokens(FlashToken,wallet.address);
+    let AMOUNT = await mintTokens(FlashToken, wallet.address);
 
     await expect(FlashToken.transfer(FlashToken.address, AMOUNT))
       .to.be.revertedWith("FlashToken:: RECEIVER_IS_TOKEN_OR_ZERO");
- 
+
   });
 
 
@@ -120,39 +121,39 @@ describe("Flash token", async () => {
 
   it("transfer fail -> zero address", async () => {
 
-    let AMOUNT = await mintTokens(FlashToken,wallet.address);
-    
+    let AMOUNT = await mintTokens(FlashToken, wallet.address);
+
     await expect(FlashToken.transfer(constants.AddressZero, AMOUNT))
-    .to.be.revertedWith("FlashToken:: RECEIVER_IS_TOKEN_OR_ZERO");
- 
+      .to.be.revertedWith("FlashToken:: RECEIVER_IS_TOKEN_OR_ZERO");
+
   });
 
 
   it("transferFrom", async () => {
 
-    let AMOUNT = await mintTokens(FlashToken,wallet.address);
-    
+    let AMOUNT = await mintTokens(FlashToken, wallet.address);
+
     await FlashToken.approve(walletTo.address, AMOUNT);
     const Another = FlashToken.connect(walletTo);
-    
+
     await expect(Another.transferFrom(wallet.address, walletTo.address, AMOUNT))
       .to.emit(FlashToken, "Transfer")
       .withArgs(wallet.address, walletTo.address, AMOUNT);
-    
-      expect(
+
+    expect(
       await FlashToken.allowance(wallet.address, walletTo.address)
     ).to.equal(0);
-    
+
     expect(await FlashToken.balanceOf(wallet.address)).to.equal(0);
-    
+
     expect(await FlashToken.balanceOf(walletTo.address)).to.equal(AMOUNT);
   });
 
 
   it("permit", async () => {
 
-    let AMOUNT = await mintTokens(FlashToken,wallet.address);
-    
+    let AMOUNT = await mintTokens(FlashToken, wallet.address);
+
     const deadline: any = constants.MaxUint256;
     const nonces = await FlashToken.nonces(wallet.address);
 
@@ -193,12 +194,21 @@ describe("Flash token", async () => {
         hexlify(s)
       )
     ).to.emit(FlashToken, "Approval");
-    
-    expect(
-      await FlashToken.allowance(wallet.address, walletTo.address)
-    ).to.equal(AMOUNT);
-    
-    expect(await FlashToken.nonces(wallet.address)).to.equal(1);
-  
+
   });
+
+  it("flashmint", async () => {
+    let MinterContract: any = await deployContract(wallet, MinterContractArtifact, [FlashToken.address]);
+    let encode = ethers.utils.defaultAbiCoder.encode(['bool', 'uint256', 'address'], [false, '1000000000000000000', wallet.address]);
+    await expect(MinterContract.flashMint("1000000000000000000", encode)
+    ).to.emit(FlashToken, "Transfer");
+    expect(await FlashToken.flashSupply()).to.equal(0);
+  })
+
+  it("flashmint fail", async () => {
+    let MinterContract: any = await deployContract(wallet, MinterContractArtifact, [FlashToken.address]);
+    let encode = ethers.utils.defaultAbiCoder.encode(['bool', 'uint256', 'address'], [true, '1000000000000000000', wallet.address]);
+    await expect(MinterContract.flashMint("1000000000000000000", encode))
+      .to.be.revertedWith("FlashToken:: TRANSFER_EXCEED_BALANCE");
+  })
 });