@zoralabs/limit-orders 0.2.0 → 0.2.1

package/.turbo/turbo-build$colon$js.log

@@ -1,17 +1,17 @@
 
-> @zoralabs/limit-orders@0.2.0 build:js /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
+> @zoralabs/limit-orders@0.2.1 build:js /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
 > pnpm run wagmi:generate && pnpm run copy-abis && pnpm run prettier:write && tsup
 
 
-> @zoralabs/limit-orders@0.2.0 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
+> @zoralabs/limit-orders@0.2.1 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
 > pnpm run build:contracts:minimal && wagmi generate && pnpm exec rename-generated-abi-casing ./package/wagmiGenerated.ts
 
 
-> @zoralabs/limit-orders@0.2.0 build:contracts:minimal /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
+> @zoralabs/limit-orders@0.2.1 build:contracts:minimal /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
 > forge build src/ --no-metadata
 
-Compiling 90 files with Solc 0.8.28
-Solc 0.8.28 finished in 7.62s
+Compiling 92 files with Solc 0.8.28
+Solc 0.8.28 finished in 8.26s
 Compiler run successful!
 - Validating plugins
 ✔ Validating plugins
@@ -26,48 +26,50 @@ Compiler run successful!
 ✅ Updated ./package/wagmiGenerated.ts (3 replacements)
 ✨ All files processed successfully!
 
-> @zoralabs/limit-orders@0.2.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
+> @zoralabs/limit-orders@0.2.1 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
 > pnpm exec bundle-abis
 
 
-> @zoralabs/limit-orders@0.2.0 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
+> @zoralabs/limit-orders@0.2.1 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/limit-orders
 > prettier --write 'src/**/*.sol' 'test/**/*.sol'
 
-src/access/SimpleAccessManaged.sol 357ms (unchanged)
-src/access/SimpleAccessManager.sol 269ms (unchanged)
-src/IZoraLimitOrderBook.sol 59ms (unchanged)
-src/libs/LimitOrderBitmap.sol 153ms (unchanged)
-src/libs/LimitOrderCommon.sol 171ms (unchanged)
-src/libs/LimitOrderCreate.sol 359ms (unchanged)
-src/libs/LimitOrderFill.sol 360ms (unchanged)
-src/libs/LimitOrderLiquidity.sol 224ms (unchanged)
-src/libs/LimitOrderQueues.sol 44ms (unchanged)
-src/libs/LimitOrderStorage.sol 15ms (unchanged)
+src/access/SimpleAccessManaged.sol 345ms (unchanged)
+src/access/SimpleAccessManager.sol 253ms (unchanged)
+src/IZoraLimitOrderBook.sol 62ms (unchanged)
+src/libs/LimitOrderBitmap.sol 66ms (unchanged)
+src/libs/LimitOrderCommon.sol 207ms (unchanged)
+src/libs/LimitOrderCreate.sol 482ms (unchanged)
+src/libs/LimitOrderFill.sol 243ms (unchanged)
+src/libs/LimitOrderLiquidity.sol 232ms (unchanged)
+src/libs/LimitOrderQueues.sol 37ms (unchanged)
+src/libs/LimitOrderStorage.sol 16ms (unchanged)
 src/libs/LimitOrderTypes.sol 2ms (unchanged)
-src/libs/LimitOrderWithdraw.sol 100ms (unchanged)
-src/libs/Permit2Payments.sol 23ms (unchanged)
-src/libs/SwapLimitOrders.sol 151ms (unchanged)
-src/router/SwapWithLimitOrders.sol 265ms (unchanged)
-src/ZoraLimitOrderBook.sol 121ms (unchanged)
-test/gas/LimitOrderFillGas.t.sol 821ms (unchanged)
-test/gas/LimitOrderSwapGas.t.sol 318ms (unchanged)
-test/LimitOrderAccessControl.t.sol 390ms (unchanged)
+src/libs/LimitOrderViews.sol 132ms (unchanged)
+src/libs/LimitOrderWithdraw.sol 91ms (unchanged)
+src/libs/Permit2Payments.sol 32ms (unchanged)
+src/libs/SwapLimitOrders.sol 161ms (unchanged)
+src/router/SwapWithLimitOrders.sol 269ms (unchanged)
+src/ZoraLimitOrderBook.sol 136ms (unchanged)
+test/gas/LimitOrderFillGas.t.sol 851ms (unchanged)
+test/gas/LimitOrderSwapGas.t.sol 310ms (unchanged)
+test/LimitOrderAccessControl.t.sol 402ms (unchanged)
 test/LimitOrderBitmap.t.sol 217ms (unchanged)
-test/LimitOrderCreate.t.sol 395ms (unchanged)
-test/LimitOrderFill.t.sol 1038ms (unchanged)
-test/LimitOrderLibraries.t.sol 393ms (unchanged)
-test/LimitOrderLiquidityPayouts.t.sol 264ms (unchanged)
-test/LimitOrderV4Pools.t.sol 149ms (unchanged)
-test/LimitOrderWithdraw.t.sol 639ms (unchanged)
-test/SimpleAccessManager.t.sol 328ms (unchanged)
+test/LimitOrderCreate.t.sol 392ms (unchanged)
+test/LimitOrderFill.t.sol 1071ms (unchanged)
+test/LimitOrderLibraries.t.sol 381ms (unchanged)
+test/LimitOrderLiquidityPayouts.t.sol 436ms (unchanged)
+test/LimitOrderV4Pools.t.sol 147ms (unchanged)
+test/LimitOrderWithdraw.t.sol 677ms (unchanged)
+test/SimpleAccessManager.t.sol 303ms (unchanged)
 test/SwapWithLimitOrders.t.sol 125ms (unchanged)
-test/SwapWithLimitOrdersRouter.t.sol 554ms (unchanged)
-test/unit/LimitOrderBitmapUnit.t.sol 176ms (unchanged)
-test/unit/LimitOrderCreateUnit.t.sol 151ms (unchanged)
-test/unit/SwapLimitOrdersUnit.t.sol 525ms (unchanged)
-test/unit/SwapLimitOrdersValidation.t.sol 253ms (unchanged)
-test/unit/SwapWithLimitOrdersUnit.t.sol 96ms (unchanged)
-test/utils/BaseTest.sol 606ms (unchanged)
+test/SwapWithLimitOrdersRouter.t.sol 636ms (unchanged)
+test/unit/LimitOrderBitmapUnit.t.sol 86ms
+test/unit/LimitOrderCreateUnit.t.sol 172ms (unchanged)
+test/unit/SwapLimitOrdersUnit.t.sol 637ms (unchanged)
+test/unit/SwapLimitOrdersValidation.t.sol 229ms (unchanged)
+test/unit/SwapWithLimitOrdersUnit.t.sol 69ms (unchanged)
+test/utils/BaseTest.sol 635ms (unchanged)
+test/utils/MockWETH.sol 33ms (unchanged)
 test/utils/TestableZoraLimitOrderBook.sol 37ms (unchanged)
 CLI Building entry: package/index.ts
 CLI Using tsconfig: tsconfig.json
@@ -77,9 +79,9 @@ test/utils/TestableZoraLimitOrderBook.sol 37ms (unchanged)
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     20.36 KB
-ESM dist/index.js.map 36.51 KB
-ESM ⚡️ Build success in 34ms
-CJS dist/index.cjs     21.52 KB
-CJS dist/index.cjs.map 36.63 KB
-CJS ⚡️ Build success in 38ms
+CJS dist/index.cjs     22.04 KB
+CJS dist/index.cjs.map 37.57 KB
+CJS ⚡️ Build success in 24ms
+ESM dist/index.js     20.87 KB
+ESM dist/index.js.map 37.45 KB
+ESM ⚡️ Build success in 25ms

package/CHANGELOG.md

@@ -1,5 +1,66 @@
 # @zoralabs/limit-orders
 
+## 0.2.1
+
+### Patch Changes
+
+- dd012477: Add swap price data fields to SwapWithLimitOrdersExecuted event. The event now includes actual swap amounts (amount0 and amount1) and final sqrt price (sqrtPriceX96), while removing the redundant delta field. This breaking change provides more detailed swap information for indexers and frontends to track swaps with limit orders without requiring additional RPC calls.
+- 517d3f74: Fix security vulnerability that allowed withdrawal of fillable limit orders. When a limit order becomes fillable due to market price crossing the limit price, users are now prevented from withdrawing the order and must execute it instead. This enforces proper market behavior and prevents users from backing out of orders that should be filled based on current market conditions.
+- 0b183d5e: Improve payout swap path validation in limit order fulfillment. The `_resolvePayoutPath` function now validates that multi-hop swap paths from coins have their first hop matching the expected payout currency. If validation fails, the system automatically falls back to constructing a simple single-hop path, ensuring correct payouts regardless of the coin's swap path configuration.
+- e84a6902: Fix CEI violation in limit order filling by moving order removal before external liquidity calls to prevent potential reentrancy issues
+- 17bf2b5e: Fix limit order fill direction to derive from actual tick movement
+
+  Fixed limit order filling in `ZoraV4CoinHook` by deriving the fill direction from actual tick movement instead of using the swap direction parameter. The hook now only attempts to fill limit orders when there's an actual tick change, and determines the currency direction based on the comparison between before and after swap ticks. This ensures orders are filled correctly regardless of swap direction.
+
+- 928b4f65: Fix limit order execution logic for correct tick queue placement
+
+  Fixed critical bug where limit orders were being enqueued at incorrect ticks, preventing proper execution. Currency0 orders now correctly execute when price rises to the upper tick, and Currency1 orders execute when price falls to the lower tick.
+
+- 3d0bb73c: Fix router-based limit order fills to use correct currency direction
+
+  Fixed bug in SwapWithLimitOrders where router fallback incorrectly inverted the currency direction parameter when calling `_fillOrders`. This caused orders to be skipped when the hook doesn't support limit order fills. The router now correctly passes `isCoinCurrency0` instead of `!isCoinCurrency0`, ensuring fills occur in the proper direction.
+
+- a61e0250: Remove duplicate validateOrderInputs call in handleCreateCallback
+
+  Eliminates redundant validation that was occurring in both \_prepareCreateData and handleCreateCallback functions, reducing gas costs while maintaining input validation security.
+
+- 14f1314a: Fix tick misalignment in minAway calculation
+
+  Align baseTick to tick spacing before calculating minAway in \_tickForMultiple(). This prevents order creation from reverting when the current pool tick is not aligned to the pool's tick spacing.
+
+- d2703bab: Fix stack too deep compilation error with internal refactoring of limit order creation.
+- 851ca567: Fix router to fill pre-existing limit orders even when no new orders are created in the current swap
+
+  Previously, the router would skip filling crossed limit orders if `orders.length == 0` (no new orders created in current transaction). This prevented legitimate fills of pre-existing orders that were crossed by the swap. The fix removes this incorrect condition, allowing the router to properly fill any orders crossed during the swap, regardless of whether new orders were also created.
+
+- 4ce5e4b6: Fix maxFillCount bounds checking to always cap it at the default max fill count, event if a higher value is passed.
+- 9486742f: Rename liqDelta to callerDelta for clearer naming fixes #19
+- 2cb9cb30: Remove fixed MIN_LIMIT_ORDER_SIZE threshold that made many tokens unusable. Limit orders now accept any positive amount instead of requiring at least 1e18 tokens, fixing compatibility issues with tokens using different decimal configurations.
+- eec53af3: Remove unnecessary Permit2Payments inheritance and use direct PERMIT2 immutable reference instead. This simplifies the contract structure by eliminating unused inherited functions while maintaining identical functionality.
+- 83726a0e: Remove unused settle negative deltas logic
+
+  - Remove redundant `_settleNegativeDeltas` function that was never executed
+  - Simplify limit order closure logic by removing unnecessary delta settlement
+
+- 0a104aa2: Fix potential hash collision in order ID generation
+
+  Changed order ID derivation from `abi.encodePacked` to `abi.encode` to prevent potential hash collisions and ensure consistent hashing behavior. This security fix addresses audit finding MKT-47.
+
+- b718117b: Fix limit order fulfillment to use correct currency when resolving payout paths
+
+  Limit order fulfillment now correctly consults the output currency's payout path configuration instead of the input currency's configuration. This ensures orders receive payouts based on the token being purchased rather than the token being sold, preventing potential currency mismatches when both tokens in a pair have different custom payout paths configured.
+
+- d6323749: Simplify limit order filling logic by deriving fill direction from tick movement. The system now automatically determines the correct currency direction based on tick changes (increasing tick = currency0, decreasing tick = currency1) instead of using complex tick sorting logic. This fix resolves issues where limit orders would revert when ticks were in unexpected order.
+- 2b054307: Fix limit order payout handling for dual positive deltas. Previously, when limit order positions accumulated fees in both tokens (dual positive deltas), the payout would revert with a `CurrencyNotSettled` error because only one currency was withdrawn from the pool manager. The fix swaps the non-payout currency to the payout currency and pays out the combined amount, properly settling both deltas.
+- 05579fbc: Refetch pool tick before filling each order to ensure accurate tick validation
+
+  Improved the limit order filling logic to prevent orders from being filled with stale tick data. The fix adds a current tick refresh before checking if an order has crossed the current tick price during the execution loop. This ensures that orders are only filled when they have actually crossed the current tick price, preventing incorrect fills due to price movements during the fill operation.
+
+- 5303b406: Fix native ETH settlement to prevent potential DoS by synchronizing pool manager state before settlement. This ensures accurate ETH balance tracking and prevents transaction failures when processing limit orders with native ETH.
+- 16b3146c: Add WETH support for native ETH payouts in limit orders. When limit orders are filled or withdrawn with native ETH as the payout currency, the system now automatically wraps ETH into WETH before sending to recipients. This ensures compatibility with wallets and smart contracts that cannot receive native ETH directly, preventing transaction failures.
+
+  **Breaking Change**: The `ZoraLimitOrderBook` constructor now requires an additional `weth` parameter. This affects deployment scripts and deterministic address computation.
+
 ## 0.2.0
 
 ### Minor Changes

package/abis/IWETH.json

@@ -0,0 +1,118 @@
+[
+  {
+    "type": "function",
+    "name": "approve",
+    "inputs": [
+      {
+        "name": "guy",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "wad",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "balanceOf",
+    "inputs": [
+      {
+        "name": "guy",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "deposit",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "payable"
+  },
+  {
+    "type": "function",
+    "name": "transfer",
+    "inputs": [
+      {
+        "name": "dst",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "wad",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "transferFrom",
+    "inputs": [
+      {
+        "name": "src",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "dst",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "wad",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "withdraw",
+    "inputs": [
+      {
+        "name": "wad",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  }
+]

package/abis/IZoraLimitOrderBook.json

@@ -585,6 +585,11 @@
     "name": "OrderClosed",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "OrderFillable",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "OrderNotMaker",

package/abis/LimitOrderLiquidity.json

@@ -0,0 +1,7 @@
+[
+  {
+    "type": "error",
+    "name": "WethTransferFailed",
+    "inputs": []
+  }
+]

package/abis/LimitOrderViews.json

@@ -0,0 +1,62 @@
+[
+  {
+    "type": "function",
+    "name": "liquidityForOrder",
+    "inputs": [
+      {
+        "name": "isCurrency0",
+        "type": "bool",
+        "internalType": "bool"
+      },
+      {
+        "name": "size",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "tickLower",
+        "type": "int24",
+        "internalType": "int24"
+      },
+      {
+        "name": "tickUpper",
+        "type": "int24",
+        "internalType": "int24"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint128",
+        "internalType": "uint128"
+      }
+    ],
+    "stateMutability": "pure"
+  },
+  {
+    "type": "error",
+    "name": "InvalidFillWindow",
+    "inputs": [
+      {
+        "name": "startTick",
+        "type": "int24",
+        "internalType": "int24"
+      },
+      {
+        "name": "endTick",
+        "type": "int24",
+        "internalType": "int24"
+      },
+      {
+        "name": "isCurrency0",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "InvalidPoolKey",
+    "inputs": []
+  }
+]

package/abis/SwapWithLimitOrders.json

@@ -313,12 +313,6 @@
           }
         ]
       },
-      {
-        "name": "delta",
-        "type": "int256",
-        "indexed": false,
-        "internalType": "BalanceDelta"
-      },
       {
         "name": "tickBeforeSwap",
         "type": "int24",
@@ -331,6 +325,24 @@
         "indexed": false,
         "internalType": "int24"
       },
+      {
+        "name": "amount0",
+        "type": "int128",
+        "indexed": false,
+        "internalType": "int128"
+      },
+      {
+        "name": "amount1",
+        "type": "int128",
+        "indexed": false,
+        "internalType": "int128"
+      },
+      {
+        "name": "sqrtPriceX96",
+        "type": "uint160",
+        "indexed": false,
+        "internalType": "uint160"
+      },
       {
         "name": "orders",
         "type": "tuple[]",
@@ -362,11 +374,6 @@
     "name": "EmptyV4Route",
     "inputs": []
   },
-  {
-    "type": "error",
-    "name": "FromAddressIsNotOwner",
-    "inputs": []
-  },
   {
     "type": "error",
     "name": "InsufficientInputCurrency",

package/abis/ZoraLimitOrderBook.json

@@ -21,6 +21,11 @@
         "name": "authority_",
         "type": "address",
         "internalType": "address"
+      },
+      {
+        "name": "weth_",
+        "type": "address",
+        "internalType": "address"
       }
     ],
     "stateMutability": "nonpayable"
@@ -330,6 +335,19 @@
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "weth",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "withdraw",
@@ -728,6 +746,11 @@
     "name": "OrderClosed",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "OrderFillable",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "OrderNotMaker",
@@ -753,6 +776,11 @@
     "name": "UnlockedFillNotAllowed",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "WethTransferFailed",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "ZeroMaker",