[WIP]: Adding foundry fuzzer for libraries processing bitmaps

.gitignore

@@ -18,4 +18,6 @@ coverage
 .coverage_cache
 .coverage_contracts
 coverage.json
-deployments/
+deployments/
+
+out/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/ds-test"]
+	path = lib/ds-test
+	url = https://github.com/dapphub/ds-test

foundry.toml

@@ -0,0 +1,9 @@
+[default]
+src = 'src'
+out = 'out'
+libs = ['lib']
+remappings = ['ds-test/=lib/ds-test/src/']
+fuzz_runs = 10000
+optimizer = false
+
+# See more config options https://github.com/gakonst/foundry/tree/master/config

package.json

@@ -11,6 +11,8 @@
     "node": ">=16.0.0"
   },
   "scripts": {
+    "setup:foundry": "foundryup && git submodule update --init",
+    "install:foundry": "curl -L https://foundry.paradigm.xyz | bash",
     "size": "npm run compile && npm run hardhat size-contracts",
     "auth-registry": "npx dotenv-cli -- bash -c 'npm config set //npm.pkg.github.com/:_authToken \"$NODE_AUTH_TOKEN\"'",
     "run-env": "npm run auth-registry && npm i && tail -f /dev/null",
@@ -22,6 +24,7 @@
     "prettier:write": "prettier --write 'tasks/**/*.ts' 'contracts/**/*.sol' 'helpers/**/*.ts'  'test-suites/**/*.ts' 'market-config/**/*.ts'",
     "coverage": ". ./setup-test-env.sh && COVERAGE=true npx hardhat coverage --temp temp-artifacts --testfiles test-suites/emptyrun.coverage.ts && rm -rf coverage.json coverage/ && COVERAGE=true npx hardhat coverage --temp temp-artifacts --testfiles 'test-suites/*.spec.ts'",
     "test": ". ./setup-test-env.sh && TS_NODE_TRANSPILE_ONLY=1 hardhat test test-suites/*.spec.ts",
+    "test-fuzz": "forge test",
     "test-scenarios": ". ./setup-test-env.sh && npx hardhat test test-suites/__setup.spec.ts test-suites/scenario.spec.ts",
     "test-l2pool": ". ./setup-test-env.sh && npx hardhat test test-suites/__setup.spec.ts test-suites/pool-l2.spec.ts",
     "test-subgraph:scenarios": ". ./setup-test-env.sh  && hardhat --network hardhatevm_docker test test-suites/__setup.spec.ts test-suites/subgraph-scenarios.spec.ts",

src/Vm.sol

@@ -0,0 +1,105 @@
+// SPDX-License-Identifier: Unlicense
+pragma solidity ^0.8.0;
+
+interface Vm {
+  // Set block.timestamp
+  function warp(uint256) external;
+
+  // Set block.number
+  function roll(uint256) external;
+
+  // Set block.basefee
+  function fee(uint256) external;
+
+  // Loads a storage slot from an address
+  function load(address account, bytes32 slot) external returns (bytes32);
+
+  // Stores a value to an address' storage slot
+  function store(
+    address account,
+    bytes32 slot,
+    bytes32 value
+  ) external;
+
+  // Signs data
+  function sign(uint256 privateKey, bytes32 digest)
+    external
+    returns (
+      uint8 v,
+      bytes32 r,
+      bytes32 s
+    );
+
+  // Computes address for a given private key
+  function addr(uint256 privateKey) external returns (address);
+
+  // Performs a foreign function call via terminal
+  function ffi(string[] calldata) external returns (bytes memory);
+
+  // Sets the *next* call's msg.sender to be the input address
+  function prank(address) external;
+
+  // Sets all subsequent calls' msg.sender to be the input address until `stopPrank` is called
+  function startPrank(address) external;
+
+  // Sets the *next* call's msg.sender to be the input address, and the tx.origin to be the second input
+  function prank(address, address) external;
+
+  // Sets all subsequent calls' msg.sender to be the input address until `stopPrank` is called, and the tx.origin to be the second input
+  function startPrank(address, address) external;
+
+  // Resets subsequent calls' msg.sender to be `address(this)`
+  function stopPrank() external;
+
+  // Sets an address' balance
+  function deal(address who, uint256 newBalance) external;
+
+  // Sets an address' code
+  function etch(address who, bytes calldata code) external;
+
+  // Expects an error on next call
+  function expectRevert(bytes calldata) external;
+
+  function expectRevert(bytes4) external;
+
+  // Record all storage reads and writes
+  function record() external;
+
+  // Gets all accessed reads and write slot from a recording session, for a given address
+  function accesses(address) external returns (bytes32[] memory reads, bytes32[] memory writes);
+
+  // Prepare an expected log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData).
+  // Call this function, then emit an event, then call a function. Internally after the call, we check if
+  // logs were emitted in the expected order with the expected topics and data (as specified by the booleans)
+  function expectEmit(
+    bool,
+    bool,
+    bool,
+    bool
+  ) external;
+
+  // Mocks a call to an address, returning specified data.
+  // Calldata can either be strict or a partial match, e.g. if you only
+  // pass a Solidity selector to the expected calldata, then the entire Solidity
+  // function will be mocked.
+  function mockCall(
+    address,
+    bytes calldata,
+    bytes calldata
+  ) external;
+
+  // Clears all mocked calls
+  function clearMockedCalls() external;
+
+  // Expect a call to an address with the specified calldata.
+  // Calldata can either be strict or a partial match
+  function expectCall(address, bytes calldata) external;
+
+  function getCode(string calldata) external returns (bytes memory);
+
+  // Label an address in test traces
+  function label(address addr, string memory label) external;
+
+  // When fuzzing, generate new inputs if conditional not met
+  function assume(bool) external;
+}