Merge pull request #8 from clober-dex/perf/debruijn

perf: use `DEBRUIJN_SEQ`
clober-dex · Jan 17, 2024 · 9ce159e · 9ce159e
2 parents 42d3796 + c685924
commit 9ce159e
Show file tree

Hide file tree

Showing 36 changed files with 12,701 additions and 21,306 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
diff --git a/.github/workflows/deployer.yaml b/.github/workflows/deployer.yaml
@@ -10,7 +10,7 @@ jobs:
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
+          node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm install --ignore-scripts
       - run: npm publish --access public

diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ '18.10' ]
+        node-version: [ '20.9' ]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ '18.10' ]
+        node-version: [ '20.9' ]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -55,17 +55,21 @@ jobs:
         run: forge test -vv
 
   hardhat-coverage:
-    name: Hardhat Coverage CI
+    name: Forge Coverage CI
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ '18.10' ]
+        node-version: [ '20.9' ]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
       - name: Cache node modules
         id: cache-npm
         uses: actions/cache@v3
@@ -85,8 +89,12 @@ jobs:
         run: npm list
       - name: Install Dependencies
         run: npm install --ignore-scripts
+      - name: Install Forge
+        run: forge install
+      - name: Foundry Forge test
+        run: forge test -vv
       - name: Hardhat coverage
-        run: npm run hardhat:coverage
+        run: npm run coverage:forge
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v18.10.0
+v20.9.0
diff --git a/.prettierrc b/.prettierrc
@@ -1,18 +1,8 @@
 {
+  "semi": false,
   "singleQuote": true,
+  "printWidth": 120,
   "trailingComma": "all",
-  "semi": false,
   "arrowParens": "always",
-  "endOfLine": "auto",
-  "overrides": [
-    {
-      "files": "*.sol",
-      "options": {
-        "singleQuote": false,
-        "semi": true,
-        "printWidth": 120,
-        "explicitTypes": "always"
-      }
-    }
-  ]
-}
+  "endOfLine": "auto"
+}
diff --git a/.solhint.json b/.solhint.json
diff --git a/.solhintignore b/.solhintignore
diff --git a/contracts/DirtyUint64.sol b/contracts/DirtyUint64.sol
@@ -5,6 +5,7 @@ pragma solidity ^0.8.0;
 
 library DirtyUint64 {
     error DirtyUint64Error(uint256 errorCode);
+
     uint256 private constant _OVERFLOW_ERROR = 0;
     uint256 private constant _UNDERFLOW_ERROR = 1;
 
@@ -69,11 +70,7 @@ library DirtyUint64 {
         }
     }
 
-    function sumPackedUnsafe(
-        uint256 packed,
-        uint256 from,
-        uint256 to
-    ) internal pure returns (uint64 ret) {
+    function sumPackedUnsafe(uint256 packed, uint256 from, uint256 to) internal pure returns (uint64 ret) {
         packed = packed >> (from << 6);
         unchecked {
             for (uint256 i = from; i < to; ++i) {

diff --git a/contracts/OctopusHeap.sol b/contracts/OctopusHeap.sol
@@ -7,35 +7,35 @@ import "./PackedUint256.sol";
 import "./SignificantBit.sol";
 
 /**
-🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙
-
-            Octopus Heap
-               by Clober
-
-      ⢀⣀⣠⣀⣀⡀
-    ⣠⣾⣿⣿⣿⣿⣿⣿⣷⣦⡀
-   ⢠⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡀   ⣠⣶⣾⣷⣶⣄
-   ⢸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣧  ⢰⣿⠟⠉⠻⣿⣿⣷
-   ⠈⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠿⢷⣄⠘⠿   ⢸⣿⣿⡆
-    ⠈⠿⣿⣿⣿⣿⣿⣀⣸⣿⣷⣤⣴⠟    ⢀⣼⣿⣿⠁
-      ⠈⠙⣛⣿⣿⣿⣿⣿⣿⣿⣿⣦⣀⣀⣀⣴⣾⣿⣿⡟
-   ⢀⣠⣴⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠟⠋⣠⣤⣀
-  ⣴⣿⣿⣿⠿⠟⠛⠛⢛⣿⣿⣿⣿⣿⣿⣧⡈⠉⠁   ⠈⠉⢻⣿⣧
- ⣼⣿⣿⠋    ⢠⣾⣿⣿⠟⠉⠻⣿⣿⣿⣦⣄     ⣸⣿⣿⠃
- ⣿⣿⡇     ⣿⣿⡿⠃   ⠈⠛⢿⣿⣿⣿⣿⣶⣿⣿⣿⡿⠋
- ⢿⣿⣧⡀ ⣶⣄⠘⣿⣿⡇  ⠠⠶⣿⣶⡄⠈⠙⠛⠻⠟⠛⠛⠁
- ⠈⠻⣿⣿⣿⣿⠏ ⢻⣿⣿⣄    ⣸⣿⡇
-           ⠻⣿⣿⣿⣶⣾⣿⣿⠃
-            ⠈⠙⠛⠛⠛⠋
-
-🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙
-*/
-
+ * 🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙
+ *
+ *             Octopus Heap
+ *                by Clober
+ *
+ *       ⢀⣀⣠⣀⣀⡀
+ *     ⣠⣾⣿⣿⣿⣿⣿⣿⣷⣦⡀
+ *    ⢠⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡀   ⣠⣶⣾⣷⣶⣄
+ *    ⢸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣧  ⢰⣿⠟⠉⠻⣿⣿⣷
+ *    ⠈⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠿⢷⣄⠘⠿   ⢸⣿⣿⡆
+ *     ⠈⠿⣿⣿⣿⣿⣿⣀⣸⣿⣷⣤⣴⠟    ⢀⣼⣿⣿⠁
+ *       ⠈⠙⣛⣿⣿⣿⣿⣿⣿⣿⣿⣦⣀⣀⣀⣴⣾⣿⣿⡟
+ *    ⢀⣠⣴⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠟⠋⣠⣤⣀
+ *   ⣴⣿⣿⣿⠿⠟⠛⠛⢛⣿⣿⣿⣿⣿⣿⣧⡈⠉⠁   ⠈⠉⢻⣿⣧
+ *  ⣼⣿⣿⠋    ⢠⣾⣿⣿⠟⠉⠻⣿⣿⣿⣦⣄     ⣸⣿⣿⠃
+ *  ⣿⣿⡇     ⣿⣿⡿⠃   ⠈⠛⢿⣿⣿⣿⣿⣶⣿⣿⣿⡿⠋
+ *  ⢿⣿⣧⡀ ⣶⣄⠘⣿⣿⡇  ⠠⠶⣿⣶⡄⠈⠙⠛⠻⠟⠛⠛⠁
+ *  ⠈⠻⣿⣿⣿⣿⠏ ⢻⣿⣿⣄    ⣸⣿⡇
+ *            ⠻⣿⣿⣿⣶⣾⣿⣿⠃
+ *             ⠈⠙⠛⠛⠛⠋
+ *
+ * 🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙🐙
+ */
 library OctopusHeap {
     using PackedUint256 for uint256;
     using SignificantBit for uint256;
 
     error OctopusHeapError(uint256 errorCode);
+
     uint256 private constant _ALREADY_INITIALIZED_ERROR = 0;
     uint256 private constant _HEAP_EMPTY_ERROR = 1;
     uint256 private constant _ALREADY_EXISTS_ERROR = 2;
@@ -92,24 +92,19 @@ library OctopusHeap {
         return core.heap[heapIndex >> _HEAD_SIZE_P].get8Unsafe(heapIndex & _HEAD_SIZE);
     }
 
-    function _getWordIndex(
-        uint256 head,
-        uint256 arm,
-        uint16 heapIndex
-    ) private pure returns (uint8) {
+    function _getWordIndex(uint256 head, uint256 arm, uint16 heapIndex) private pure returns (uint8) {
         if (heapIndex <= _HEAD_SIZE) {
             return head.get8Unsafe(heapIndex);
         }
         return arm.get8Unsafe(heapIndex & _HEAD_SIZE);
     }
 
     // returns new values for the part of the heap affected by updating value at heapIndex to new value
-    function _updateWordIndex(
-        uint256 head,
-        uint256 arm,
-        uint16 heapIndex,
-        uint8 newWordIndex
-    ) private pure returns (uint256, uint256) {
+    function _updateWordIndex(uint256 head, uint256 arm, uint16 heapIndex, uint8 newWordIndex)
+        private
+        pure
+        returns (uint256, uint256)
+    {
         if (heapIndex <= _HEAD_SIZE) {
             return (head.update8Unsafe(heapIndex, newWordIndex), arm);
         } else {
@@ -233,18 +228,10 @@ library OctopusHeap {
         core.bitmap[wordIndex] = word | mask;
     }
 
-    function _pop(
-        Core storage core,
-        uint256 head,
-        uint256[] memory arms
-    )
+    function _pop(Core storage core, uint256 head, uint256[] memory arms)
         private
         view
-        returns (
-            uint256,
-            uint16,
-            uint256
-        )
+        returns (uint256, uint16, uint256)
     {
         uint8 newLength;
         uint256 arm;
@@ -296,11 +283,11 @@ library OctopusHeap {
         return (head, bodyPartIndex, arm);
     }
 
-    function popInMemory(
-        Core storage core,
-        uint256 word,
-        uint256[] memory heap
-    ) internal view returns (uint256, uint256[] memory) {
+    function popInMemory(Core storage core, uint256 word, uint256[] memory heap)
+        internal
+        view
+        returns (uint256, uint256[] memory)
+    {
         uint8 rootBitIndex = word.leastSignificantBit();
         uint256 mask = 1 << rootBitIndex;
         if (word != mask) return (word & (~mask), heap);