Merge pull request #43 from 1inch/feature/dynamic-fees

added dynamic fees

Author: galekseev

.gas-snapshot

@@ -37,6 +37,12 @@ jobs:
           git config --global url."https://x-access-token:${{ steps.app-token.outputs.token }}@github.com/".insteadOf "https://github.com/"
           git config --global url."https://x-access-token:${{ steps.app-token.outputs.token }}@github.com/".insteadOf "git@github.com:"
           git config --global url."https://x-access-token:${{ steps.app-token.outputs.token }}@github.com/".insteadOf "ssh://git@github.com/"
+
+      - name: Setup npm authentication for GitHub Packages
+        run: |
+          echo "@1inch:registry=https://npm.pkg.github.com" >> .npmrc
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
+
       - name: Install node modules
         run: npm install
 

.github/workflows/ci.yml

@@ -2,7 +2,7 @@
 
 [![Github Release](https://img.shields.io/github/v/tag/1inch/swap-vm?sort=semver&label=github)](https://github.com/1inch/swap-vm/releases/latest)
 [![CI](https://github.com/1inch/swap-vm/actions/workflows/ci.yml/badge.svg)](https://github.com/1inch/swap-vm/actions/workflows/ci.yml)
-[![Coverage](https://img.shields.io/badge/Coverage-50.46%25-yellow)](https://github.com/1inch/swap-vm)
+[![Coverage](https://img.shields.io/badge/Coverage-85%25-green)](https://github.com/1inch/swap-vm)
 [![Tests](https://img.shields.io/github/actions/workflow/status/1inch/swap-vm/ci.yml?branch=main&label=tests)](https://github.com/1inch/swap-vm/actions)
 [![npm](https://img.shields.io/npm/v/@1inch/swap-vm.svg)](https://www.npmjs.com/package/@1inch/swap-vm)
 [![License](https://img.shields.io/badge/License-Degensoft--SwapVM--1.1-orange)](LICENSE)
@@ -123,7 +123,9 @@ The execution flow shows all available instructions and strategies for each bala
 │    ├─ _progressiveFeeInXD → Size-based dynamic fee (input)│
 │    ├─ _progressiveFeeOutXD → Size-based dynamic fee (output)│
 │    ├─ _protocolFeeAmountOutXD → Protocol revenue (ERC20) │
-│    └─ _aquaProtocolFeeAmountOutXD → Protocol revenue (Aqua)│
+│    ├─ _aquaProtocolFeeAmountOutXD → Protocol revenue (Aqua)│
+│    ├─ _dynamicProtocolFeeAmountInXD → Dynamic fee via provider│
+│    └─ _aquaDynamicProtocolFeeAmountInXD → Dynamic Aqua fee│
 │                                                          │
 │ 6. Advanced Strategies (Optional)                        │
 │    ├─ _requireMinRate1D → Enforce minimum exchange rate  │
@@ -174,6 +176,7 @@ The execution flow shows all available instructions and strategies for each bala
 │                                                            │
 │ 2. AMM Logic (Choose Primary Strategy)                     │
 │    ├─ _xycSwapXD → Classic x*y=k constant product          │
+│    ├─ _peggedSwapGrowPriceRange2D → Curve for pegged assets│
 │    └─ _xycConcentrateGrowLiquidityXD/2D → CLMM ranges      │
 │                                                            │
 │ 3. Fee Mechanisms (Optional, Combinable)                   │
@@ -182,7 +185,9 @@ The execution flow shows all available instructions and strategies for each bala
 │    ├─ _progressiveFeeInXD → Size-based dynamic fee (input) │
 │    ├─ _progressiveFeeOutXD → Size-based dynamic fee (output)│
 │    ├─ _protocolFeeAmountOutXD → Protocol revenue (ERC20)   │
-│    └─ _aquaProtocolFeeAmountOutXD → Protocol revenue (Aqua)│
+│    ├─ _aquaProtocolFeeAmountOutXD → Protocol revenue (Aqua)│
+│    ├─ _dynamicProtocolFeeAmountInXD → Dynamic fee via provider│
+│    └─ _aquaDynamicProtocolFeeAmountInXD → Dynamic Aqua fee │
 │                                                            │
 │ 4. MEV Protection (Optional)                               │
 │    └─ _decayXD → Virtual reserves (Mooniswap-style)        │
@@ -410,21 +415,28 @@ bytes memory program = bytes.concat(
 );
 
 // 2. Configure order parameters
-MakerTraits makerTraits = MakerTraitsLib.build(MakerTraitsLib.Args({
+ISwapVM.Order memory order = MakerTraitsLib.build(MakerTraitsLib.Args({
+    maker: yourAddress,              // Your address
+    receiver: address(0),            // You receive the tokens (0 = maker)
     shouldUnwrapWeth: false,         // Keep WETH (don't unwrap to ETH)
-    expiration: block.timestamp + 1 days,  // Order expires in 24h
-    receiver: address(0),             // You receive the tokens
-    useAquaInsteadOfSignature: false // Use standard EIP-712 signing
+    useAquaInsteadOfSignature: false, // Use standard EIP-712 signing
+    allowZeroAmountIn: false,        // Require non-zero input
+    hasPreTransferInHook: false,
+    hasPostTransferInHook: false,
+    hasPreTransferOutHook: false,
+    hasPostTransferOutHook: false,
+    preTransferInTarget: address(0),
+    preTransferInData: "",
+    postTransferInTarget: address(0),
+    postTransferInData: "",
+    preTransferOutTarget: address(0),
+    preTransferOutData: "",
+    postTransferOutTarget: address(0),
+    postTransferOutData: "",
+    program: program                 // Your swap program
 }));
 
-// 3. Create order (completely off-chain)
-ISwapVM.Order memory order = ISwapVM.Order({
-    maker: yourAddress,
-    traits: makerTraits,
-    program: program
-});
-
-// 4. Sign order off-chain (gasless)
+// 3. Sign order off-chain (gasless)
 bytes32 orderHash = swapVM.hash(order);
 bytes memory signature = signEIP712(orderHash);
 ```
@@ -499,7 +511,7 @@ MakerTraits makerTraits = MakerTraitsLib.build({
 **Use Case:** Share liquidity across multiple strategies  
 **Key Difference:** Unlike isolated dynamic balances, Aqua enables shared liquidity
 
-See [Aqua Protocol](https://github.com/1inch/aqua-protocol) for details
+See [Aqua Protocol](https://github.com/1inch/aqua) for details
 
 ### Maker Security
 
@@ -657,45 +669,51 @@ Context
 
 ```
 MakerTraits (256-bit packed)
-├── Token Handling
-│   └── shouldUnwrapWeth ────────── Unwrap WETH to ETH on output
-│
-├── Order Lifecycle  
-│   └── expiration (40 bits) ────── Unix timestamp when order expires
-│
-├── Balance Management
-│   ├── useAquaInsteadOfSignature ─ Use Aqua balance instead of signature
-│   └── allowZeroAmountIn ─── Skip Aqua for input transfers
+├── Bit Flags (bits 245-255)
+│   ├── shouldUnwrapWeth (255) ──── Unwrap WETH to ETH on output
+│   ├── useAquaInsteadOfSignature (254) ─ Use Aqua balance instead of signature
+│   ├── allowZeroAmountIn (253) ── Allow zero amountIn (skip validation)
+│   ├── hasPreTransferInHook (252) ── Call maker before input transfer
+│   ├── hasPostTransferInHook (251) ── Call maker after input transfer
+│   ├── hasPreTransferOutHook (250) ── Call maker before output transfer
+│   ├── hasPostTransferOutHook (249) ── Call maker after output transfer
+│   ├── preTransferInHookHasTarget (248) ── Hook has custom target
+│   ├── postTransferInHookHasTarget (247)
+│   ├── preTransferOutHookHasTarget (246)
+│   └── postTransferOutHookHasTarget (245)
 │
-├── Recipient Control
-│   └── receiver ─────────────────── Custom recipient (0 = maker)
+├── Data Slices Indexes (bits 160-223, 64 bits)
+│   └── Packed 4x uint16 offsets for hook data slices
 │
-└── Hooks (Callbacks)
-    ├── hasPreTransferOutHook ────── Call maker before output transfer
-    ├── hasPostTransferInHook ────── Call maker after input transfer
-    ├── preTransferOutData ────────── Data for pre-transfer hook
-    └── postTransferInData ────────── Data for post-transfer hook
+└── Receiver (bits 0-159, 160 bits)
+    └── Custom recipient address (0 = maker)
 ```
 
 ```
-TakerTraits (Variable-length)
-├── Swap Direction
-│   └── isExactIn ────────────────── true = specify input, false = output
+TakerTraits (Variable-length with 176-bit header)
+├── Header (22 bytes packed)
+│   ├── Slices Indexes (160 bits) ── 10x uint16 offsets for data slices
+│   └── Bit Flags (16 bits)
+│       ├── isExactIn (0) ────────── true = specify input, false = output
+│       ├── shouldUnwrapWeth (1) ── Unwrap WETH to ETH on output
+│       ├── hasPreTransferInCallback (2) ── Call taker before input transfer
+│       ├── hasPreTransferOutCallback (3) ── Call taker before output transfer
+│       ├── isStrictThresholdAmount (4) ── true = exact, false = min/max
+│       ├── isFirstTransferFromTaker (5) ── Who transfers first
+│       └── useTransferFromAndAquaPush (6) ── SwapVM does transferFrom + Aqua push
 │
-├── Amount Validation
-│   ├── threshold ────────────────── Min output or max input
-│   └── isStrictThresholdAmount ─── true = exact, false = min/max
-│
-├── Token Handling
-│   ├── shouldUnwrapWeth ─────────── Unwrap WETH to ETH on output
-│   └── to ───────────────────────── Custom recipient (0 = taker)
-│
-├── Transfer Mechanics
-│   ├── isFirstTransferFromTaker ── Who transfers first
-│   └── useTransferFromAndAquaPush ─ SwapVM does transferFrom + Aqua push (vs taker pushes in callback)
-│
-└── Hooks (Callbacks)
-    └── hasPreTransferInHook ─────── Call taker before input transfer
+└── Variable-length Data Slices
+    ├── threshold (0 or 32 bytes) ── Min output or max input
+    ├── to (0 or 20 bytes) ───────── Custom recipient
+    ├── deadline (0 or 5 bytes) ──── Unix timestamp (uint40)
+    ├── preTransferInHookData ────── Data for maker pre-in hook
+    ├── postTransferInHookData ───── Data for maker post-in hook
+    ├── preTransferOutHookData ──── Data for maker pre-out hook
+    ├── postTransferOutHookData ─── Data for maker post-out hook
+    ├── preTransferInCallbackData ─ Data for taker pre-in callback
+    ├── preTransferOutCallbackData ─ Data for taker pre-out callback
+    ├── instructionsArgs ──────────── Data consumed by VM instructions
+    └── signature ─────────────────── EIP-712 signature for order
 ```
 
 ### Instruction Capabilities
@@ -879,7 +897,7 @@ if (useAquaInsteadOfSignature) {
 | Feature | Description | Implementation |
 |---------|-------------|----------------|
 | **Signature Control** | Orders cannot be modified | EIP-712 signatures |
-| **Expiration** | Time-limited orders | `expiration` in MakerTraits |
+| **Expiration** | Time-limited orders | `_deadline` instruction or TakerTraits deadline |
 | **Balance Limits** | Cannot exceed specified amounts | Register bounds checking |
 | **One-time Execution** | Prevent replay | `_invalidateBit1D` instruction |
 | **Custom Logic** | Hooks for validation | Pre/post transfer hooks |
@@ -890,8 +908,10 @@ if (useAquaInsteadOfSignature) {
 // Limit order exposure
 p.build(Invalidators._invalidateBit1D, bitIndex);
 
-// Add expiration
-traits.expiration = block.timestamp + 1 hours;
+// Add expiration via _deadline instruction in program
+p.build(Controls._deadline, ControlsArgsBuilder.buildDeadline(block.timestamp + 1 hours));
+
+// Or via TakerTraits deadline field
 
 // MEV protection
 p.build(Decay._decayXD, DecayArgsBuilder.build(30));

README.md

@@ -24,7 +24,7 @@ License: /LICENSES/MIT-OpenZeppelin.txt
 
 Component: @1inch/solidity-utils
 Repo: https://github.com/1inch/solidity-utils
-Version: v6.8.0
+Version: v6.9.0
 License: MIT
 Copyright: © 2019, 1inch
 License: /LICENSES/MIT-1inch.txt
@@ -33,7 +33,7 @@ License: /LICENSES/MIT-1inch.txt
 
 Component: @1inch/aqua
 Repo: https://github.com/1inch/aqua
-Version: 0.0.7
+Version: 0.0.8
 License: LicenseRef-Degensoft-Aqua-Source-1.1
 Copyright: © 2025 Degensoft Ltd
 License: /LICENSES/Aqua-Source-1.1.txt

THIRD_PARTY_NOTICES

@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: LicenseRef-Degensoft-SwapVM-1.1
+pragma solidity 0.8.30;
+
+/// @custom:license-url https://github.com/1inch/swap-vm/blob/main/LICENSES/SwapVM-1.1.txt
+/// @custom:copyright © 2025 Degensoft Ltd
+
+import "@openzeppelin/contracts/access/Ownable.sol";
+
+import "../src/instructions/interfaces/IProtocolFeeProvider.sol";
+
+/**
+ * @title ProtocolFeeProviderMock
+ * @notice Mock implementation of IProtocolFeeProvider for testing dynamic protocol fees
+ * @dev This contract is used with `_dynamicProtocolFeeAmountInXD`
+ *      instructions in SwapVM programs to provide configurable protocol fee parameters.
+ *
+ * ## Usage in SwapVM Programs
+ *
+ * Protocol fee instructions must be placed BEFORE balances for correct operation:
+ * ```solidity
+ * bytes memory bytecode = bytes.concat(
+ *     // Dynamic protocol fee BEFORE balances
+ *     program.build(_dynamicProtocolFeeAmountInXD, abi.encodePacked(address(feeProvider))),
+ *     // Balances instruction
+ *     program.build(_dynamicBalancesXD, BalancesArgsBuilder.build(...)),
+ *     // Other fees AFTER balances (flat, progressive)
+ *     program.build(_flatFeeAmountInXD, FeeArgsBuilder.buildFlatFee(feeBps)),
+ *     // Swap instruction
+ *     program.build(_xycSwapXD)
+ * );
+ * ```
+ *
+ * ## Fee Calculation
+ *
+ * The fee is calculated as: `feeAmount = amount * feeBps / 1e9`
+ * where feeBps is in basis points with 9 decimal precision (0.001e9 = 0.1%)
+ *
+ * ## Example
+ *
+ * ```solidity
+ * // Create fee provider with 0.2% fee
+ * ProtocolFeeProviderMock feeProvider = new ProtocolFeeProviderMock(
+ *     0.002e9,           // feeBps: 0.2% in 1e9 scale
+ *     feeRecipient,      // address to receive fees
+ *     owner              // owner who can update settings
+ * );
+ * ```
+ *
+ * @custom:security This is a mock contract for testing only.
+ *                  Production implementations should include access control and validation.
+ */
+contract ProtocolFeeProviderMock is IProtocolFeeProvider, Ownable {
+    /// @notice Fee rate in basis points (1e9 scale, e.g., 0.002e9 = 0.2%)
+    uint32 private _feeBps;
+
+    /// @notice Address that receives protocol fees
+    address private _to;
+
+    /**
+     * @notice Creates a new ProtocolFeeProviderMock
+     * @param feeBps Fee rate in basis points (1e9 scale)
+     *               Examples: 0.001e9 = 0.1%, 0.002e9 = 0.2%, 0.01e9 = 1%
+     * @param to Address to receive collected protocol fees
+     * @param owner Address with permission to update fee settings
+     */
+    constructor(uint32 feeBps, address to, address owner) Ownable(owner) {
+        _feeBps = feeBps;
+        _to = to;
+    }
+
+    /**
+     * @notice Updates fee rate and recipient address
+     * @dev Can be called by anyone (no access control in mock)
+     *      Production implementation should restrict to owner
+     * @param feeBps New fee rate in basis points (1e9 scale)
+     * @param to New address to receive protocol fees
+     */
+    function setFeeBpsAndRecipient(uint32 feeBps, address to) onlyOwner external {
+        _feeBps = feeBps;
+        _to = to;
+    }
+
+    /// @inheritdoc IProtocolFeeProvider
+    function getFeeBpsAndRecipient(
+        bytes32 /* orderHash */,
+        address /* maker */,
+        address /* taker */,
+        address /* tokenIn */,
+        address /* tokenOut */,
+        bool /* isExactIn */
+    ) external view override returns (uint32 feeBps, address to) {
+        return (_feeBps, _to);
+    }
+}

mocks/ProtocolFeeProviderMock.sol

@@ -1,15 +1,15 @@
 {
   "name": "@1inch/swap-vm",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Swap Virtual Machine protocol to build token swap strategies with programmable instruction sequences",
   "main": "index.js",
   "directories": {
     "lib": "lib",
     "test": "test"
   },
   "dependencies": {
-    "@1inch/aqua": "github:1inch/aqua#0.0.7",
-    "@1inch/solidity-utils": "6.8.0",
+    "@1inch/aqua": "github:1inch/aqua#0.0.8",
+    "@1inch/solidity-utils": "6.9.0",
     "@openzeppelin/contracts": "5.4.0",
     "forge-std": "github:foundry-rs/forge-std#v1.11.0"
   },

package.json

@@ -1,24 +1,24 @@
 {
-  "ConcentrateGrowLiquidity_XYCSwap_quote_exactIn": "45881",
-  "ConcentrateGrowLiquidity_XYCSwap_quote_exactOut": "46586",
-  "ConcentrateGrowLiquidity_XYCSwap_swap_exactIn": "171299",
-  "ConcentrateGrowLiquidity_XYCSwap_swap_exactOut": "172002",
-  "ConcentrateGrowPriceRange_XYCSwap_quote_exactIn": "42165",
-  "ConcentrateGrowPriceRange_XYCSwap_swap_exactIn": "143515",
-  "Concentrate_Decay_XYCSwap_quote_exactIn": "55409",
-  "Concentrate_Decay_XYCSwap_swap_exactIn": "228143",
-  "Decay_XYCSwap_quote_exactIn": "48159",
-  "Decay_XYCSwap_quote_exactOut": "48864",
-  "Decay_XYCSwap_swap_exactIn": "196825",
-  "Decay_XYCSwap_swap_exactOut": "197529",
-  "FullAMM_quote_exactIn": "58858",
-  "FullAMM_swap_exactIn": "231592",
-  "XYCSwap_FlatFeeIn_quote_exactIn": "42077",
-  "XYCSwap_FlatFeeIn_swap_exactIn": "143426",
-  "XYCSwap_FlatFeeOut_quote_exactIn": "42066",
-  "XYCSwap_FlatFeeOut_swap_exactIn": "143415",
-  "XYCSwap_quote_exactIn": "38632",
-  "XYCSwap_quote_exactOut": "39424",
-  "XYCSwap_swap_exactIn": "139981",
-  "XYCSwap_swap_exactOut": "140772"
+  "ConcentrateGrowLiquidity_XYCSwap_quote_exactIn": "46003",
+  "ConcentrateGrowLiquidity_XYCSwap_quote_exactOut": "46708",
+  "ConcentrateGrowLiquidity_XYCSwap_swap_exactIn": "171421",
+  "ConcentrateGrowLiquidity_XYCSwap_swap_exactOut": "172125",
+  "ConcentrateGrowPriceRange_XYCSwap_quote_exactIn": "42287",
+  "ConcentrateGrowPriceRange_XYCSwap_swap_exactIn": "143637",
+  "Concentrate_Decay_XYCSwap_quote_exactIn": "55530",
+  "Concentrate_Decay_XYCSwap_swap_exactIn": "228265",
+  "Decay_XYCSwap_quote_exactIn": "48280",
+  "Decay_XYCSwap_quote_exactOut": "48986",
+  "Decay_XYCSwap_swap_exactIn": "196947",
+  "Decay_XYCSwap_swap_exactOut": "197652",
+  "FullAMM_quote_exactIn": "58979",
+  "FullAMM_swap_exactIn": "231714",
+  "XYCSwap_FlatFeeIn_quote_exactIn": "42198",
+  "XYCSwap_FlatFeeIn_swap_exactIn": "143548",
+  "XYCSwap_FlatFeeOut_quote_exactIn": "42187",
+  "XYCSwap_FlatFeeOut_swap_exactIn": "143537",
+  "XYCSwap_quote_exactIn": "38753",
+  "XYCSwap_quote_exactOut": "39545",
+  "XYCSwap_swap_exactIn": "140103",
+  "XYCSwap_swap_exactOut": "140894"
 }