Improve Fuzz Coverage

.github/workflows/ci.yml

@@ -66,12 +66,13 @@ jobs:
             # to include coverage in all directories, comment out this step. Note that because this
             # filtering applies to the lcov file, the summary table generated in the previous step will
             # still include all files and directories.
+            # Disable branch coverage temporarily due to https://github.com/foundry-rs/foundry/issues/8279
             # The `--rc lcov_branch_coverage=1` part keeps branch info in the filtered report, since lcov
             # defaults to removing branch info.
             - name: Filter directories
               run: |
                   sudo apt update && sudo apt install -y lcov
-                  lcov --remove lcov.info 'test/*' 'script/*' --output-file lcov.info --rc lcov_branch_coverage=1
+                  lcov --remove lcov.info 'test/*' 'script/*' --output-file lcov.info
 
             # This step posts a detailed coverage report as a comment and deletes previous comments on
             # each push. The below step is used to fail coverage if the specified coverage threshold is

.gitignore

@@ -12,4 +12,5 @@ out/
 
 node_modules/
 
-lcov.info
+lcov.info
+coverage

.solhintrc

@@ -3,11 +3,10 @@
         "compiler-version": ["error", ">=0.8.0"],
         "func-visibility": ["error", { "ignoreConstructors": true }],
         "named-parameters-mapping": "warn",
-        "no-console": "off",
         "one-contract-per-file": "off",
     	"no-inline-assembly": "off",
     	"no-empty-blocks": "off",
-    	"var-name-mixedcase": "off",
-    	"no-global-import": "off"
+    	"no-global-import": "off",
+        gas-custom-errors": "off",
     }
 }

README.md

@@ -62,3 +62,4 @@ The contracts are designed to be customizable, with adjustable parameters such a
 1. The total amount of SHU tokens staked in the contract must be equal to the
    total amount of SHU tokens staked by each keyper: `totalStaked = sum(stakes[keyper].amount)`.
 2. On unstake, `keyperStake.timestamp + lockPeriod <= block.timestamp` if global `lockPeriod` is greater or equal to the stake lock period, otherwise `keyperStake.timestamp + keyperStake.lockPeriod <= block.timestamp`.
+3. If `some(keyperStakes(keyper).length()) > 0` then `nextStakeId` != 0;

docs/staking-architecture.md

@@ -22,7 +22,7 @@
 
 ## Immutable Variables
 
--   `STAKING_TOKEN`: the SHU token address
+-   `stakingToken`: the SHU token address
 
 The staking token must be immutable. If the DAO changes the staking token, the
 keypers will not be able to withdrawn their old stakes.

package.json

@@ -17,7 +17,7 @@
         "prettier": "prettier --ignore-path .prettierignore --list-different './**/*'",
         "prettier:write": "prettier --ignore-path .prettierignore --write './**/*'",
         "test": "forge test",
-        "test:coverage": "forge coverage",
-        "test:coverage:report": "forge coverage --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage"
+        "test:coverage": "forge coverage --ir-minimum",
+        "test:coverage:report": "forge coverage --ir-minimum --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage"
     }
 }