@zoralabs/limit-orders 0.2.0

package/test/gas/LimitOrderSwapGas.t.sol

@@ -0,0 +1,403 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {BaseTest} from "../utils/BaseTest.sol";
+import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
+import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
+import {LimitOrderCommon} from "../../src/libs/LimitOrderCommon.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SwapWithLimitOrders} from "../../src/router/SwapWithLimitOrders.sol";
+import {AddressConstants} from "@zoralabs/coins/test/utils/hookmate/constants/AddressConstants.sol";
+import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
+
+/**
+ * @title LimitOrderSwapGasTest
+ * @notice Forked gas benchmarks for a single swap that fills existing orders and creates 5 new ones.
+ */
+contract LimitOrderSwapGasTest is BaseTest {
+    uint256 internal constant FORK_BLOCK = 38_875_958;
+    uint256 internal constant DEFAULT_MAX_FILL_COUNT = 50;
+
+    uint256 private gasStart;
+    uint256 private gasUsed;
+
+    function setUp() public override {
+        setUpWithBlockNumber(FORK_BLOCK);
+        limitOrderBook.setMaxFillCount(DEFAULT_MAX_FILL_COUNT);
+    }
+
+    function test_gas_hop2_swap_create5_fill5() public {
+        _runHop2Swap(5);
+    }
+
+    function test_gas_hop2_swap_create5_fill10() public {
+        _runHop2Swap(10);
+    }
+
+    function test_gas_hop2_swap_create5_fill25() public {
+        _runHop2Swap(25);
+    }
+
+    function test_gas_hop2_swap_create5_fill50() public {
+        _runHop2Swap(50);
+    }
+
+    function test_gas_hop3_swap_create5_fill5() public {
+        _runHop3Swap(5);
+    }
+
+    function test_gas_hop3_swap_create5_fill10() public {
+        _runHop3Swap(10);
+    }
+
+    function test_gas_hop3_swap_create5_fill25() public {
+        _runHop3Swap(25);
+    }
+
+    function test_gas_hop3_swap_create5_fill50() public {
+        _runHop3Swap(50);
+    }
+
+    function test_gas_hop4_swap_create5_fill5() public {
+        _runHop4Swap(5);
+    }
+
+    function test_gas_hop4_swap_create5_fill10() public {
+        _runHop4Swap(10);
+    }
+
+    function test_gas_hop4_swap_create5_fill25() public {
+        _runHop4Swap(25);
+    }
+
+    function test_gas_hop4_swap_create5_fill50() public {
+        _runHop4Swap(50);
+    }
+
+    function test_gas_hop1_swap_create5_fill5() public {
+        _runHop1Swap(5);
+    }
+
+    function test_gas_hop1_swap_create5_fill10() public {
+        _runHop1Swap(10);
+    }
+
+    function test_gas_hop1_swap_create5_fill25() public {
+        _runHop1Swap(25);
+    }
+
+    function test_gas_hop1_swap_create5_fill50() public {
+        _runHop1Swap(50);
+    }
+
+    function test_gas_hop3_swap_create5_fill0() public {
+        _runHop3NoFill();
+    }
+
+    function test_gas_hop4_swap_create5_fill0() public {
+        _runHop4NoFill();
+    }
+
+    // ---------------- helpers ----------------
+
+    function _runHop1Swap(uint256 existingOrders) internal {
+        PoolKey memory creatorKey = creatorCoin.getPoolKey();
+        bool isCurrency0 = Currency.unwrap(creatorKey.currency0) == address(creatorCoin);
+
+        CreatedOrderLog[] memory preloaded = existingOrders > 0 ? _preloadOrders(creatorKey, isCurrency0, existingOrders) : new CreatedOrderLog[](0);
+        emit log_named_uint("PRELOADED_ORDERS", preloaded.length);
+
+        vm.prank(users.factoryOwner);
+        limitOrderBook.setMaxFillCount(existingOrders + 10);
+
+        PoolKey[] memory v4Route = new PoolKey[](1);
+        v4Route[0] = creatorKey;
+        bytes memory v3Route = bytes("");
+
+        uint256 amountIn = 1_000e18;
+        _fundAndApprove(address(zoraToken), amountIn, users.buyer);
+
+        SwapWithLimitOrders.SwapWithLimitOrdersParams memory params = SwapWithLimitOrders.SwapWithLimitOrdersParams({
+            recipient: users.buyer,
+            limitOrderConfig: _prepareLimitOrderParams(users.buyer, _defaultMultiples(), _defaultPercentages()),
+            inputCurrency: address(zoraToken),
+            inputAmount: amountIn,
+            v3Route: v3Route,
+            v4Route: v4Route,
+            minAmountOut: 0
+        });
+
+        vm.recordLogs();
+        gasStart = gasleft();
+        vm.prank(users.buyer);
+        swapWithLimitOrders.swapWithLimitOrders(params);
+        gasUsed = gasStart - gasleft();
+
+        FilledOrderLog[] memory fills = _decodeFilledLogs(vm.getRecordedLogs());
+        CreatedOrderLog[] memory created = _decodeCreatedLogs(vm.getRecordedLogs());
+
+        emit log_named_uint("ROUTER_CREATED_ORDERS", created.length);
+        emit log_named_uint("SWAP_FILLED_ORDERS", fills.length);
+        emit log_named_uint("SINGLE_SWAP_CREATE_AND_FILL_GAS", gasUsed);
+
+        address orderCoin = LimitOrderCommon.getOrderCoin(creatorKey, isCurrency0);
+        emit log_named_uint("MAKER_BALANCE_AFTER", limitOrderBook.balanceOf(users.buyer, orderCoin));
+    }
+
+    function _runHop2Swap(uint256 existingOrders) internal {
+        PoolKey memory contentKey = contentCoin.getPoolKey();
+        bool isCurrency0 = Currency.unwrap(contentKey.currency0) == address(contentCoin);
+
+        CreatedOrderLog[] memory preloaded = existingOrders > 0 ? _preloadOrders(contentKey, isCurrency0, existingOrders) : new CreatedOrderLog[](0);
+        emit log_named_uint("PRELOADED_ORDERS", preloaded.length);
+
+        // allow enough fills (existing + some headroom for newly in-range orders)
+        vm.prank(users.factoryOwner);
+        limitOrderBook.setMaxFillCount(existingOrders + 10);
+
+        // build router params (hop2: ZORA -> creator -> content)
+        PoolKey[] memory v4Route = new PoolKey[](2);
+        v4Route[0] = creatorCoin.getPoolKey();
+        v4Route[1] = contentCoin.getPoolKey();
+        bytes memory v3Route = bytes("");
+
+        uint256 amountIn = 1_000e18; // large enough to cross ticks
+        _fundAndApprove(address(zoraToken), amountIn, users.buyer);
+
+        SwapWithLimitOrders.SwapWithLimitOrdersParams memory params = SwapWithLimitOrders.SwapWithLimitOrdersParams({
+            recipient: users.buyer,
+            limitOrderConfig: _prepareLimitOrderParams(users.buyer, _defaultMultiples(), _defaultPercentages()),
+            inputCurrency: address(zoraToken),
+            inputAmount: amountIn,
+            v3Route: v3Route,
+            v4Route: v4Route,
+            minAmountOut: 0
+        });
+
+        vm.recordLogs();
+        gasStart = gasleft();
+        vm.prank(users.buyer);
+        swapWithLimitOrders.swapWithLimitOrders(params);
+        gasUsed = gasStart - gasleft();
+
+        FilledOrderLog[] memory fills = _decodeFilledLogs(vm.getRecordedLogs());
+        CreatedOrderLog[] memory created = _decodeCreatedLogs(vm.getRecordedLogs());
+
+        emit log_named_uint("ROUTER_CREATED_ORDERS", created.length);
+        emit log_named_uint("SWAP_FILLED_ORDERS", fills.length);
+        emit log_named_uint("SINGLE_SWAP_CREATE_AND_FILL_GAS", gasUsed);
+
+        address orderCoin = LimitOrderCommon.getOrderCoin(contentKey, isCurrency0);
+        emit log_named_uint("MAKER_BALANCE_AFTER", limitOrderBook.balanceOf(users.buyer, orderCoin));
+    }
+
+    function _runHop3Swap(uint256 existingOrders) internal {
+        PoolKey memory contentKey = contentCoin.getPoolKey();
+        bool isCurrency0 = Currency.unwrap(contentKey.currency0) == address(contentCoin);
+
+        CreatedOrderLog[] memory preloaded = existingOrders > 0 ? _preloadOrders(contentKey, isCurrency0, existingOrders) : new CreatedOrderLog[](0);
+        emit log_named_uint("PRELOADED_ORDERS", preloaded.length);
+
+        vm.prank(users.factoryOwner);
+        limitOrderBook.setMaxFillCount(existingOrders + 10);
+
+        PoolKey[] memory v4Route = new PoolKey[](2);
+        v4Route[0] = creatorCoin.getPoolKey();
+        v4Route[1] = contentCoin.getPoolKey();
+        bytes memory v3Route = abi.encodePacked(USDC_ADDRESS, uint24(10000), ZORA_TOKEN_ADDRESS);
+
+        uint256 amountIn = 20_000e6;
+        _fundAndApprove(USDC_ADDRESS, amountIn, users.buyer);
+
+        SwapWithLimitOrders.SwapWithLimitOrdersParams memory params = SwapWithLimitOrders.SwapWithLimitOrdersParams({
+            recipient: users.buyer,
+            limitOrderConfig: _prepareLimitOrderParams(users.buyer, _defaultMultiples(), _defaultPercentages()),
+            inputCurrency: USDC_ADDRESS,
+            inputAmount: amountIn,
+            v3Route: v3Route,
+            v4Route: v4Route,
+            minAmountOut: 0
+        });
+
+        vm.recordLogs();
+        gasStart = gasleft();
+        vm.prank(users.buyer);
+        swapWithLimitOrders.swapWithLimitOrders(params);
+        gasUsed = gasStart - gasleft();
+
+        FilledOrderLog[] memory fills = _decodeFilledLogs(vm.getRecordedLogs());
+        CreatedOrderLog[] memory created = _decodeCreatedLogs(vm.getRecordedLogs());
+
+        emit log_named_uint("ROUTER_CREATED_ORDERS", created.length);
+        emit log_named_uint("SWAP_FILLED_ORDERS", fills.length);
+        emit log_named_uint("SINGLE_SWAP_CREATE_AND_FILL_GAS", gasUsed);
+
+        address orderCoin = LimitOrderCommon.getOrderCoin(contentKey, isCurrency0);
+        emit log_named_uint("MAKER_BALANCE_AFTER", limitOrderBook.balanceOf(users.buyer, orderCoin));
+    }
+
+    function _runHop4Swap(uint256 existingOrders) internal {
+        PoolKey memory contentKey = contentCoin.getPoolKey();
+        bool isCurrency0 = Currency.unwrap(contentKey.currency0) == address(contentCoin);
+
+        CreatedOrderLog[] memory preloaded = existingOrders > 0 ? _preloadOrders(contentKey, isCurrency0, existingOrders) : new CreatedOrderLog[](0);
+        emit log_named_uint("PRELOADED_ORDERS", preloaded.length);
+
+        vm.prank(users.factoryOwner);
+        limitOrderBook.setMaxFillCount(existingOrders + 10);
+
+        PoolKey[] memory v4Route = new PoolKey[](2);
+        v4Route[0] = creatorCoin.getPoolKey();
+        v4Route[1] = contentCoin.getPoolKey();
+        bytes memory v3Route = abi.encodePacked(WETH_ADDRESS, uint24(500), USDC_ADDRESS, uint24(10000), ZORA_TOKEN_ADDRESS);
+
+        uint256 amountIn = 10 ether;
+        _fundAndApprove(WETH_ADDRESS, amountIn, users.buyer);
+
+        SwapWithLimitOrders.SwapWithLimitOrdersParams memory params = SwapWithLimitOrders.SwapWithLimitOrdersParams({
+            recipient: users.buyer,
+            limitOrderConfig: _prepareLimitOrderParams(users.buyer, _defaultMultiples(), _defaultPercentages()),
+            inputCurrency: WETH_ADDRESS,
+            inputAmount: amountIn,
+            v3Route: v3Route,
+            v4Route: v4Route,
+            minAmountOut: 0
+        });
+
+        vm.recordLogs();
+        gasStart = gasleft();
+        vm.prank(users.buyer);
+        swapWithLimitOrders.swapWithLimitOrders(params);
+        gasUsed = gasStart - gasleft();
+
+        FilledOrderLog[] memory fills = _decodeFilledLogs(vm.getRecordedLogs());
+        CreatedOrderLog[] memory created = _decodeCreatedLogs(vm.getRecordedLogs());
+
+        emit log_named_uint("ROUTER_CREATED_ORDERS", created.length);
+        emit log_named_uint("SWAP_FILLED_ORDERS", fills.length);
+        emit log_named_uint("SINGLE_SWAP_CREATE_AND_FILL_GAS", gasUsed);
+
+        address orderCoin = LimitOrderCommon.getOrderCoin(contentKey, isCurrency0);
+        emit log_named_uint("MAKER_BALANCE_AFTER", limitOrderBook.balanceOf(users.buyer, orderCoin));
+    }
+
+    function _runHop3NoFill() internal {
+        PoolKey memory creatorKey = creatorCoin.getPoolKey();
+        bool isCurrency0 = Currency.unwrap(creatorKey.currency0) == address(creatorCoin);
+
+        vm.prank(users.factoryOwner);
+        limitOrderBook.setMaxFillCount(10);
+
+        PoolKey[] memory v4Route = new PoolKey[](1);
+        v4Route[0] = creatorKey;
+        bytes memory v3Route = abi.encodePacked(USDC_ADDRESS, uint24(10000), ZORA_TOKEN_ADDRESS);
+
+        uint256 amountIn = 10_000e6;
+        _fundAndApprove(USDC_ADDRESS, amountIn, users.buyer);
+
+        SwapWithLimitOrders.SwapWithLimitOrdersParams memory params = SwapWithLimitOrders.SwapWithLimitOrdersParams({
+            recipient: users.buyer,
+            limitOrderConfig: _prepareLimitOrderParams(users.buyer, _defaultMultiples(), _defaultPercentages()),
+            inputCurrency: USDC_ADDRESS,
+            inputAmount: amountIn,
+            v3Route: v3Route,
+            v4Route: v4Route,
+            minAmountOut: 0
+        });
+
+        vm.recordLogs();
+        gasStart = gasleft();
+        vm.prank(users.buyer);
+        swapWithLimitOrders.swapWithLimitOrders(params);
+        gasUsed = gasStart - gasleft();
+
+        FilledOrderLog[] memory fills = _decodeFilledLogs(vm.getRecordedLogs());
+        CreatedOrderLog[] memory created = _decodeCreatedLogs(vm.getRecordedLogs());
+
+        emit log_named_uint("ROUTER_CREATED_ORDERS", created.length);
+        emit log_named_uint("SWAP_FILLED_ORDERS", fills.length);
+        emit log_named_uint("SINGLE_SWAP_CREATE_AND_FILL_GAS", gasUsed);
+
+        address orderCoin = LimitOrderCommon.getOrderCoin(creatorKey, isCurrency0);
+        emit log_named_uint("MAKER_BALANCE_AFTER", limitOrderBook.balanceOf(users.buyer, orderCoin));
+    }
+
+    function _runHop4NoFill() internal {
+        PoolKey memory creatorKey = creatorCoin.getPoolKey();
+        bool isCurrency0 = Currency.unwrap(creatorKey.currency0) == address(creatorCoin);
+
+        vm.prank(users.factoryOwner);
+        limitOrderBook.setMaxFillCount(10);
+
+        PoolKey[] memory v4Route = new PoolKey[](1);
+        v4Route[0] = creatorKey;
+        bytes memory v3Route = abi.encodePacked(WETH_ADDRESS, uint24(500), USDC_ADDRESS, uint24(10000), ZORA_TOKEN_ADDRESS);
+
+        uint256 amountIn = 5 ether;
+        _fundAndApprove(WETH_ADDRESS, amountIn, users.buyer);
+
+        SwapWithLimitOrders.SwapWithLimitOrdersParams memory params = SwapWithLimitOrders.SwapWithLimitOrdersParams({
+            recipient: users.buyer,
+            limitOrderConfig: _prepareLimitOrderParams(users.buyer, _defaultMultiples(), _defaultPercentages()),
+            inputCurrency: WETH_ADDRESS,
+            inputAmount: amountIn,
+            v3Route: v3Route,
+            v4Route: v4Route,
+            minAmountOut: 0
+        });
+
+        vm.recordLogs();
+        gasStart = gasleft();
+        vm.prank(users.buyer);
+        swapWithLimitOrders.swapWithLimitOrders(params);
+        gasUsed = gasStart - gasleft();
+
+        FilledOrderLog[] memory fills = _decodeFilledLogs(vm.getRecordedLogs());
+        CreatedOrderLog[] memory created = _decodeCreatedLogs(vm.getRecordedLogs());
+
+        emit log_named_uint("ROUTER_CREATED_ORDERS", created.length);
+        emit log_named_uint("SWAP_FILLED_ORDERS", fills.length);
+        emit log_named_uint("SINGLE_SWAP_CREATE_AND_FILL_GAS", gasUsed);
+
+        address orderCoin = LimitOrderCommon.getOrderCoin(creatorKey, isCurrency0);
+        emit log_named_uint("MAKER_BALANCE_AFTER", limitOrderBook.balanceOf(users.buyer, orderCoin));
+    }
+
+    function _fundAndApprove(address token, uint256 amount, address trader) internal {
+        if (token == address(0)) {
+            vm.deal(trader, amount);
+            return;
+        }
+        deal(token, trader, amount);
+        address permit2 = AddressConstants.getPermit2Address();
+        vm.startPrank(trader);
+        IERC20(token).approve(permit2, type(uint256).max);
+        IAllowanceTransfer(permit2).approve(token, address(swapWithLimitOrders), type(uint160).max, type(uint48).max);
+        vm.stopPrank();
+    }
+
+    function _preloadOrders(PoolKey memory key, bool isCurrency0, uint256 count) internal returns (CreatedOrderLog[] memory created) {
+        address orderCoin = LimitOrderCommon.getOrderCoin(key, isCurrency0);
+
+        uint256 orderSize = 25e18;
+        (uint256[] memory sizes, int24[] memory ticks) = _buildDeterministicOrders(key, isCurrency0, count, orderSize);
+
+        uint256 totalSize;
+        for (uint256 i; i < sizes.length; ++i) {
+            totalSize += sizes[i];
+        }
+
+        if (orderCoin == address(0)) {
+            vm.deal(users.seller, totalSize);
+        } else {
+            deal(orderCoin, users.seller, totalSize);
+            vm.prank(users.seller);
+            IERC20(orderCoin).approve(address(limitOrderBook), totalSize);
+        }
+
+        vm.recordLogs();
+        vm.prank(users.seller);
+        limitOrderBook.create{value: orderCoin == address(0) ? totalSize : 0}(key, isCurrency0, sizes, ticks, users.seller);
+        created = _decodeCreatedLogs(vm.getRecordedLogs());
+    }
+}

package/test/gas/logs/gas_benchmarks_fill_20251201.log

@@ -0,0 +1,30 @@
+No files changed, compilation skipped
+
+Ran 23 tests for test/gas/LimitOrderFillGas.t.sol:LimitOrderFillGasTest
+[PASS] test_gas_0hop_single_order_direct_payout() (gas: 3256179)
+[PASS] test_gas_1hop_single_order_fill() (gas: 3256779)
+[PASS] test_gas_1hop_user_swap_autofill_40_orders() (gas: 16707751)
+[PASS] test_gas_1hop_user_swap_autofill_50_orders() (gas: 20375584)
+[PASS] test_gas_2hop_five_orders_fill() (gas: 7792758)
+[PASS] test_gas_2hop_single_order_fill() (gas: 6143613)
+[PASS] test_gas_2hop_ten_orders_fill() (gas: 9872756)
+[PASS] test_gas_2hop_user_swap_triggers_autofill() (gas: 6776579)
+[PASS] test_gas_backend_manual_fill_100_orders() (gas: 47656019)
+[PASS] test_gas_backend_manual_fill_150_orders() (gas: 68957450)
+[PASS] test_gas_backend_manual_fill_50_orders() (gas: 26598104)
+[PASS] test_gas_baseline_swap_no_limit_orders() (gas: 1778873)
+[PASS] test_gas_empty_fill() (gas: 143268)
+[PASS] test_gas_large_swap_with_fee_conversion() (gas: 2008446)
+[PASS] test_gas_max_fillcount_stress_test() (gas: 16128877)
+[PASS] test_gas_mixed_order_sizes() (gas: 7793945)
+[PASS] test_gas_same_tick_orders() (gas: 7444207)
+[PASS] test_gas_user_swap_autofill_100_orders() (gas: 42545248)
+[PASS] test_gas_user_swap_autofill_10_orders() (gas: 8700941)
+[PASS] test_gas_user_swap_autofill_25_orders() (gas: 14201062)
+[PASS] test_gas_user_swap_autofill_40_orders() (gas: 19625345)
+[PASS] test_gas_user_swap_autofill_50_orders() (gas: 23168604)
+[PASS] test_gas_user_swap_autofill_75_orders() (gas: 32899292)
+Suite result: ok. 23 passed; 0 failed; 0 skipped; finished in 926.81ms (462.22ms CPU time)
+
+
+Ran 1 test suite in 956.61ms (926.81ms CPU time): 23 tests passed, 0 failed, 0 skipped (23 total tests)

package/test/gas/logs/gas_benchmarks_swap_20251201.log

@@ -0,0 +1,27 @@
+Compiling 1 files with Solc 0.8.28
+Solc 0.8.28 finished in 28.29s
+Compiler run successful!
+
+Ran 18 tests for test/gas/LimitOrderSwapGas.t.sol:LimitOrderSwapGasTest
+[PASS] test_gas_hop1_swap_create5_fill10() (gas: 8103292)
+[PASS] test_gas_hop1_swap_create5_fill25() (gas: 13364745)
+[PASS] test_gas_hop1_swap_create5_fill5() (gas: 6372150)
+[PASS] test_gas_hop1_swap_create5_fill50() (gas: 23312531)
+[PASS] test_gas_hop2_swap_create5_fill10() (gas: 11385994)
+[PASS] test_gas_hop2_swap_create5_fill25() (gas: 17144425)
+[PASS] test_gas_hop2_swap_create5_fill5() (gas: 9485181)
+[PASS] test_gas_hop2_swap_create5_fill50() (gas: 26916911)
+[PASS] test_gas_hop3_swap_create5_fill0() (gas: 5932665)
+[PASS] test_gas_hop3_swap_create5_fill10() (gas: 14088859)
+[PASS] test_gas_hop3_swap_create5_fill25() (gas: 19866108)
+[PASS] test_gas_hop3_swap_create5_fill5() (gas: 12182264)
+[PASS] test_gas_hop3_swap_create5_fill50() (gas: 29670228)
+[PASS] test_gas_hop4_swap_create5_fill0() (gas: 5963338)
+[PASS] test_gas_hop4_swap_create5_fill10() (gas: 14303856)
+[PASS] test_gas_hop4_swap_create5_fill25() (gas: 20082719)
+[PASS] test_gas_hop4_swap_create5_fill5() (gas: 12396378)
+[PASS] test_gas_hop4_swap_create5_fill50() (gas: 29889559)
+Suite result: ok. 18 passed; 0 failed; 0 skipped; finished in 32.68s (143.80s CPU time)
+
+
+Ran 1 test suite in 32.71s (32.68s CPU time): 18 tests passed, 0 failed, 0 skipped (18 total tests)