Add initial tests and CI checks

Author: ernestognw

.github/workflows/checks.yml

@@ -38,6 +38,26 @@ jobs:
       - name: Run tests and generate gas report
         run: npm run test
 
+  tests-foundry:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Run tests
+        run: forge test -vv
+
+  slither:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - run: rm foundry.toml
+      - uses: crytic/[email protected]
+
   codespell:
     runs-on: ubuntu-latest
     steps:

contracts/access/AccessManagerLight.sol renamed to contracts/access/manager/AccessManagerLight.sol

@@ -3,7 +3,7 @@
 pragma solidity ^0.8.20;
 
 import {IAuthority} from "@openzeppelin/contracts/access/manager/IAuthority.sol";
-import {Masks} from "../utils/Masks.sol";
+import {Masks} from "../../utils/Masks.sol";
 
 contract AccessManagerLight is IAuthority {
     using Masks for *;

contracts/utils/Masks.sol

@@ -2,15 +2,18 @@
 
 pragma solidity ^0.8.20;
 
+/// @dev Library for handling bit masks
 library Masks {
     using Masks for *;
 
     type Mask is bytes32;
 
+    /// @dev Returns a new mask with the bit at `group` index set to 1.
     function toMask(uint8 group) internal pure returns (Mask) {
         return Mask.wrap(bytes32(1 << group));
     }
 
+    /// @dev Returns a new mask with the bits at `groups` indices set to 1.
     function toMask(uint8[] memory groups) internal pure returns (Mask) {
         Masks.Mask set = Mask.wrap(0);
         for (uint256 i = 0; i < groups.length; ++i) {
@@ -19,31 +22,38 @@ library Masks {
         return set;
     }
 
+    /// @dev Get value of the mask at `group` index
     function get(Mask self, uint8 group) internal pure returns (bool) {
         return !group.toMask().intersection(self).isEmpty();
     }
 
+    /// @dev Whether the mask is `bytes32(0)`
     function isEmpty(Mask self) internal pure returns (bool) {
         return Mask.unwrap(self) == bytes32(0);
     }
 
+    /// @dev Invert the bits of a mask
     function complement(Mask m1) internal pure returns (Mask) {
         return Mask.wrap(~Mask.unwrap(m1));
     }
 
+    /// @dev Perform a bitwise OR operation on two masks
     function union(Mask m1, Mask m2) internal pure returns (Mask) {
         return Mask.wrap(Mask.unwrap(m1) | Mask.unwrap(m2));
     }
 
+    /// @dev Perform a bitwise AND operation on two masks
     function intersection(Mask m1, Mask m2) internal pure returns (Mask) {
         return Mask.wrap(Mask.unwrap(m1) & Mask.unwrap(m2));
     }
 
+    /// @dev Perform a bitwise difference operation on two masks (m1 - m2)
     function difference(Mask m1, Mask m2) internal pure returns (Mask) {
         return m1.intersection(m2.complement());
     }
 
-    function symetric_difference(Mask m1, Mask m2) internal pure returns (Mask) {
+    /// @dev Returns the symmetric difference (∆) of two masks, also known as disjunctive union or exclusive OR (XOR)
+    function symmetric_difference(Mask m1, Mask m2) internal pure returns (Mask) {
         return m1.union(m2).difference(m1.intersection(m2));
     }
 }

foundry.toml

@@ -5,7 +5,7 @@ src = 'contracts'
 out = 'out'
 libs = ['node_modules', 'lib']
 test = 'test'
-cache_path  = 'cache_forge'
+cache_path = 'cache_forge'
 
 [fuzz]
 runs = 5000

hardhat.config.js

@@ -13,6 +13,7 @@ const { argv } = require('yargs/yargs')()
 
 require('@nomicfoundation/hardhat-chai-matchers');
 require('@nomicfoundation/hardhat-ethers');
+require('hardhat-exposed');
 require('./hardhat/remappings');
 
 module.exports = {