chore: Switch to Foundry (SC-4852) (#14)

* feat: switched to forge

* added EOF lines

* remove circle ci

* adjust slither file

* adjust PR issues

* fix: update test.sh

* fix: update runs, test.sh

* formatting: rm extra line

Co-authored-by: Lucas Manuel <[email protected]>

Author: JGcarv

.circleci/config.yml

@@ -0,0 +1,20 @@
+name: Basic PR Tests
+
+on: [pull_request]
+
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Pull library deps
+        run: forge update
+
+      - name: Run forge tests
+        run: ./test.sh -p deep

.github/workflows/pull-request.yml

@@ -0,0 +1,23 @@
+name: 50k fuzz run test on push to main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Pull library deps
+        run: forge update
+
+      - name: Run forge tests
+        run: ./test.sh -p super_deep

.github/workflows/push-to-main.yml

@@ -0,0 +1,54 @@
+name: Static Analysis
+on:
+  push:
+    branches: "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          sudo snap install solc
+          python -m pip install --upgrade pip
+          pip install slither-analyzer==0.8.2 solc-select==0.2.1
+          solc-select install 0.8.7
+          solc-select use 0.8.7
+
+      - name: Install submodules
+        run: |
+          git config --global url."https://github.com/".insteadOf "[email protected]:"
+          git submodule update --init --recursive
+
+      - name: Summary of static analysis
+        run: |
+          slither contracts --print human-summary
+
+      - name: Contract summary of static analysis
+        run: |
+          slither contracts --print contract-summary
+
+      - name: Function summary
+        run: |
+          slither contracts --print function-summary
+
+      - name: Inheritance
+        run: |
+          slither contracts --print inheritance
+
+      - name: Data dependency
+        run: |
+          slither contracts --print data-dependency
+
+      - name: Static Analysis
+        run: |
+          slither contracts
+        continue-on-error: true

.github/workflows/slither.yaml

@@ -4,3 +4,5 @@ hevm*
 artifacts/*
 docs/*
 metadata.json
+/out
+/cache

.gitignore

@@ -17,7 +17,7 @@ This was intentional, as this ERC-20 was intended to have the minimum functional
 To clone, set up and run tests:
 ```
 git clone [email protected]:maple-labs/ERC20.git
-dapp update
+forge update
 make test
 ```
 

README.md

@@ -5,10 +5,16 @@ import { DSTest } from "../../modules/ds-test/src/test.sol";
 
 import { ERC20User }     from "./accounts/ERC20User.sol";
 import { MockERC20 }     from "./mocks/MockERC20.sol";
+
 import { InvariantTest } from "./utils/InvariantTest.sol";
+import { Vm }            from "./utils/Vm.sol";
 
 contract ERC20Test is DSTest {
 
+    Vm vm = Vm(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);
+
+    bytes constant ARITHMETIC_ERROR = abi.encodeWithSignature("Panic(uint256)", 0x11);
+
     MockERC20 token;
 
     address internal immutable self = address(this);
@@ -31,14 +37,14 @@ contract ERC20Test is DSTest {
         assertEq(mockToken.decimals(), decimals);
     }
 
-    function prove_mint(address account, uint256 amount) public {
+    function test_mint(address account, uint256 amount) public {
         token.mint(account, amount);
 
         assertEq(token.totalSupply(),      amount);
         assertEq(token.balanceOf(account), amount);
     }
 
-    function prove_burn(address account, uint256 amount0, uint256 amount1) public {
+    function test_burn(address account, uint256 amount0, uint256 amount1) public {
         if (amount1 > amount0) return;  // Mint amount must exceed burn amount.
 
         token.mint(account, amount0);
@@ -48,13 +54,13 @@ contract ERC20Test is DSTest {
         assertEq(token.balanceOf(account), amount0 - amount1);
     }
 
-    function prove_approve(address account, uint256 amount) public {
+    function test_approve(address account, uint256 amount) public {
         assertTrue(token.approve(account, amount));
 
         assertEq(token.allowance(self, account), amount);
     }
 
-    function prove_transfer(address account, uint256 amount) public {
+    function test_transfer(address account, uint256 amount) public {
         token.mint(self, amount);
 
         assertTrue(token.transfer(account, amount));
@@ -69,7 +75,7 @@ contract ERC20Test is DSTest {
         }
     }
 
-    function prove_transferFrom(address to, uint256 approval, uint256 amount) public {
+    function test_transferFrom(address to, uint256 approval, uint256 amount) public {
         if (amount > approval) return;  // Owner must approve for more than amount.
 
         ERC20User owner = new ERC20User();
@@ -93,33 +99,55 @@ contract ERC20Test is DSTest {
         }
     }
 
-    function proveFail_transfer_insufficientBalance(address to, uint256 mintAmount, uint256 sendAmount) public {
-        require(mintAmount < sendAmount);
+    function test_transfer_insufficientBalance(address to, uint256 amount) public {
+        amount = amount == 0 ? 1 : amount;
 
         ERC20User account = new ERC20User();
 
-        token.mint(address(account), mintAmount);
-        account.erc20_transfer(address(token), to, sendAmount);
+        token.mint(address(account), amount - 1);
+
+        vm.expectRevert(ARITHMETIC_ERROR);
+        account.erc20_transfer(address(token), to, amount);
+
+        token.mint(address(account), 1);
+        account.erc20_transfer(address(token), to, amount);
+
+        assertEq(token.balanceOf(to), amount);
     }
 
-    function proveFail_transferFrom_insufficientAllowance(address to, uint256 approval, uint256 amount) public {
-        require(approval < amount);
+    function test_transferFrom_insufficientAllowance(address to, uint256 amount) public {
+        amount = amount == 0 ? 1 : amount;
 
         ERC20User owner = new ERC20User();
 
         token.mint(address(owner), amount);
-        owner.erc20_approve(address(token), self, approval);
+
+        owner.erc20_approve(address(token), self, amount - 1);
+
+        vm.expectRevert(ARITHMETIC_ERROR);
         token.transferFrom(address(owner), to, amount);
+
+        owner.erc20_approve(address(token), self, amount);
+        token.transferFrom(address(owner), to, amount);
+
+        assertEq(token.balanceOf(to), amount);
     }
 
-    function proveFail_transferFrom_insufficientBalance(address to, uint256 mintAmount, uint256 sendAmount) public {
-        require(mintAmount < sendAmount);
+    function test_transferFrom_insufficientBalance(address to, uint256 amount) public {
+        amount = amount == 0 ? 1 : amount;
 
         ERC20User owner = new ERC20User();
 
-        token.mint(address(owner), mintAmount);
-        owner.erc20_approve(address(token), self, sendAmount);
-        token.transferFrom(address(owner), to, sendAmount);
+        token.mint(address(owner), amount - 1);
+        owner.erc20_approve(address(token), self, amount);
+
+        vm.expectRevert(ARITHMETIC_ERROR);
+        token.transferFrom(address(owner), to, amount);
+
+        token.mint(address(owner), 1);
+        token.transferFrom(address(owner), to, amount);
+
+        assertEq(token.balanceOf(to), amount);
     }
 
 }