test: bPool unit tests scaffolding (#8)

* test: wip initial test structure

* test: complete scaffolding

* test: add happy path for joinPool

* test: wip

* test: tweak assume

* test: wip, improve fuzzing

* test: improve assume

* test: assumes are working now

* test: increase tokens to 8

* test: finish happyPath for joinPool

* fix: lint

* test: improve happyPath

* fix: avoid empty tests from running

* test: small improvements

* fix: small compilation error

* test: create Utils library

* fix: moving happy path to specific test contract (#11)

* fix: moving happy path to specific test contract

* fix: linter errors

* feat: adding smock package (#10)

* feat: adding smock package

* fix: moving happy path to specific test contract

* fix: linter errors

* feat: implementing smock to unit test

* fix: adding smock to ci

* fix: ci

* fix: addressing comments in pr

---------

Co-authored-by: Weißer Hase <[email protected]>
Co-authored-by: Weißer Hase <[email protected]>

.github/workflows/ci.yml

@@ -31,6 +31,9 @@ jobs:
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
 
+      - name: Create mock files with smock
+        run: yarn smock
+
       - name: Precompile using 0.8.14 and via-ir=false
         run: yarn build
 
@@ -58,6 +61,9 @@ jobs:
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
 
+      - name: Create mock files with smock
+        run: yarn smock
+
       - name: Precompile using 0.8.14 and via-ir=false
         run: yarn build
 

.gitignore

@@ -19,3 +19,6 @@ broadcast/*/*/*
 
 # Out dir
 out
+
+# Smock dir
+test/smock

.solhint.json

@@ -13,6 +13,9 @@
     "immutable-name-snakecase": "warn",
     "avoid-low-level-calls": "off",
     "no-console": "off",
-    "max-line-length": ["warn", 120]
+    "max-line-length": ["warn", 120],
+    "TODO": "REMOVE_TEMPORARY_LINTER_SETTINGS_BELOW",
+    "custom-errors": "warn",
+    "definition-name-capwords": "warn"
   }
 }

foundry.toml

@@ -26,6 +26,7 @@ src = 'src/interfaces/'
 
 [fuzz]
 runs = 1000
+max_test_rejects = 500000
 
 [rpc_endpoints]
 mainnet = "${MAINNET_RPC}"

package.json

@@ -24,6 +24,7 @@
     "lint:sol-logic": "solhint -c .solhint.json 'src/**/*.sol' 'script/**/*.sol'",
     "lint:sol-tests": "solhint -c .solhint.tests.json 'test/**/*.sol'",
     "prepare": "husky install",
+    "smock": "smock-foundry --contracts src/contracts",
     "test": "forge test -vvv",
     "test:integration": "forge test --match-contract Integration -vvv",
     "test:unit": "forge test --match-contract Unit -vvv",
@@ -36,12 +37,13 @@
     "package.json": "sort-package-json"
   },
   "dependencies": {
-    "solmate": "github:transmissions11/solmate#a9e3ea2"
+    "solmate": "github:transmissions11/solmate#c892309"
   },
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-conventional": "19.2.2",
     "@defi-wonderland/natspec-smells": "1.1.1",
+    "@defi-wonderland/smock-foundry": "1.5.0",
     "forge-std": "github:foundry-rs/forge-std#5475f85",
     "husky": ">=8",
     "lint-staged": ">=10",

src/contracts/BFactory.sol

@@ -22,7 +22,7 @@ contract BFactory is BBronze {
 
   event LOG_BLABS(address indexed caller, address indexed blabs);
 
-  mapping(address => bool) private _isBPool;
+  mapping(address => bool) internal _isBPool;
 
   function isBPool(address b) external view returns (bool) {
     return _isBPool[b];
@@ -36,7 +36,7 @@ contract BFactory is BBronze {
     return bpool;
   }
 
-  address private _blabs;
+  address internal _blabs;
 
   constructor() {
     _blabs = msg.sender;

src/contracts/BPool.sol

@@ -19,7 +19,7 @@ import './BToken.sol';
 contract BPool is BBronze, BToken, BMath {
   struct Record {
     bool bound; // is token bound to pool
-    uint256 index; // private
+    uint256 index; // internal
     uint256 denorm; // denormalized weight
     uint256 balance;
   }
@@ -55,20 +55,20 @@ contract BPool is BBronze, BToken, BMath {
     _;
   }
 
-  bool private _mutex;
+  bool internal _mutex;
 
-  address private _factory; // BFactory address to push token exitFee to
-  address private _controller; // has CONTROL role
-  bool private _publicSwap; // true if PUBLIC can call SWAP functions
+  address internal _factory; // BFactory address to push token exitFee to
+  address internal _controller; // has CONTROL role
+  bool internal _publicSwap; // true if PUBLIC can call SWAP functions
 
   // `setSwapFee` and `finalize` require CONTROL
   // `finalize` sets `PUBLIC can SWAP`, `PUBLIC can JOIN`
-  uint256 private _swapFee;
-  bool private _finalized;
+  uint256 internal _swapFee;
+  bool internal _finalized;
 
-  address[] private _tokens;
-  mapping(address => Record) private _records;
-  uint256 private _totalWeight;
+  address[] internal _tokens;
+  mapping(address => Record) internal _records;
+  uint256 internal _totalWeight;
 
   constructor() {
     _controller = msg.sender;

src/contracts/BToken.sol

@@ -65,9 +65,9 @@ abstract contract BTokenBase is BNum, IERC20 {
 }
 
 contract BToken is BTokenBase {
-  string private _name = 'Balancer Pool Token';
-  string private _symbol = 'BPT';
-  uint8 private _decimals = 18;
+  string internal _name = 'Balancer Pool Token';
+  string internal _symbol = 'BPT';
+  uint8 internal _decimals = 18;
 
   function name() public view returns (string memory) {
     return _name;