Merge pull request #60 from FastLane-Labs/add-storage-test

Add Storage test

DEVELOPING.md

@@ -0,0 +1,37 @@
+# Environment Setup
+
+You will need to make sure you have these packages installed:
+
+* foundry
+
+The you need to ensure your environment has these variables set:
+
+```
+MAINNET_RPC_URL=
+```
+
+
+# Project Initialization
+
+```
+foundryup
+```
+
+# Running a build
+
+```
+forge build
+```
+
+# Running the tests
+
+```
+forge test
+```
+
+# Generating a coverage report
+
+```
+forge coverage --ir-minimum --report lcov
+```
+

test/Storage.t.sol

@@ -0,0 +1,84 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.21;
+
+import "forge-std/Test.sol";
+
+import { Storage } from "src/contracts/atlas/Storage.sol";
+
+using stdStorage for StdStorage;
+
+contract StorageTest is Test {
+    function testNewStorage() public {
+        MockStorageTests s = new MockStorageTests(
+            1, // _escrowDuration
+            address(1), // _factory
+            address(2), // _verification
+            address(3), // _gasAccLib
+            address(4), // _safetyLocksLib
+            address(5) // _simulator
+        );
+
+        assertEq(s.ESCROW_DURATION(), 1);
+        assertEq(s.FACTORY(), address(1));
+        assertEq(s.VERIFICATION(), address(2));
+        assertEq(s.GAS_ACC_LIB(), address(3));
+        assertEq(s.SAFETY_LOCKS_LIB(), address(4));
+        assertEq(s.SIMULATOR(), address(5));
+        assertEq(s.getInitialChainId(), block.chainid);
+        assertEq(s.getInitialDomainSeparator(), bytes32("SEPARATOR"));
+    }
+
+    function testStorageSlotsDontChange() public {
+        Storage s = new Storage(
+            1, // _escrowDuration
+            address(1), // _factory
+            address(2), // _verification
+            address(3), // _gasAccLib
+            address(4), // _safetyLocksLib
+            address(5) // _simulator
+        );
+
+        // look up the storage slots so that we can make sure they don't change by accident
+
+        uint256 totalSupplySlot = stdstore.target(address(s)).sig("totalSupply()").find();
+        uint256 noncesSlot = stdstore.target(address(s)).sig("nonces(address)").with_key(address(this)).find();
+        uint256 lockSlot = stdstore.target(address(s)).sig("lock()").find();
+
+        // TODO: figure out how to check the allowance and ledger slots, haven't been able to make these work yet
+
+        // if you're getting an error from one of these assertions, it means that the storage slot has changed
+        // and you either need to update the slot number or revert the change
+
+        assertEq(totalSupplySlot, 0);
+        assertEq(
+            noncesSlot,
+            49_784_443_915_320_261_189_887_103_614_045_882_155_521_089_248_264_299_114_442_679_287_293_484_801_912
+        );
+        assertEq(lockSlot, 4);
+    }
+}
+
+contract MockStorageTests is Storage {
+    constructor(
+        uint256 _escrowDuration,
+        address _factory,
+        address _verification,
+        address _gasAccLib,
+        address _safetyLocksLib,
+        address _simulator
+    )
+        Storage(_escrowDuration, _factory, _verification, _gasAccLib, _safetyLocksLib, _simulator)
+    { }
+
+    function getInitialChainId() public view returns (uint256) {
+        return INITIAL_CHAIN_ID;
+    }
+
+    function getInitialDomainSeparator() public view returns (bytes32) {
+        return INITIAL_DOMAIN_SEPARATOR;
+    }
+
+    function _computeDomainSeparator() internal view virtual override returns (bytes32) {
+        return bytes32("SEPARATOR");
+    }
+}