feat(swap-vm): add LimitProgramBuilder for LimitSwapVMRouter

[krboktv]

Summary

LimitSwapVMRouter and LimitSwapVMRouterDebug execute programs against the LimitOpcodes table. Its opcode bytes match the full Opcodes table up to staticBalancesXD (0x11) and differ from 0x12 on. The SDK had no table or builder for these routers, so a program built with RegularProgramBuilder runs different instructions there. For example, limitSwap1D is 0x19 in Opcodes but 0x15 in LimitOpcodes, where 0x19 is dutchAuctionBalanceIn1D.

Changes

• instructions.limitInstructions mirrors LimitOpcodes._opcodes(): 41 slots, bytes 0x00-0x28. LimitOpcodes.sol is identical in the pinned contracts and in v1.0.2.
• LimitProgramBuilder (exported from programs) has a typed method for every instruction in the table and a static decode(). Its FeeExperimental methods are marked experimental. It has no debug helpers.
• README: a "Program builders and target routers" section maps each builder to its opcode table and routers.

Testing

• pnpm nx run-many -t build, pnpm lint, pnpm lint:types and pnpm test pass (swap-vm: 55 files / 690 tests).
• Unit tests:
  • the table matches the contract order;
  • every method encodes with its expected byte and round-trips through decode();
  • a program using every instruction round-trips;
  • limitSwap1D is 0x15 here and 0x19 in RegularProgramBuilder;
  • a limit order built by both builders has identical args but different opcode bytes;
  • instructions outside the table are rejected.
• A local forge test against LimitOpcodes (not committed) passes:
  • LimitProgramBuilder programs execute on it: the 0x150101 limit swap returns the expected amount, as does deadline + limitSwap1D + salt;
  • requireMinRate1D (0x17) passes and reverts as expected;
  • the same order built with RegularProgramBuilder (limitSwap1D = 0x19) reverts on the limit table.

Notes

• Additive: the existing builders and tables are unchanged.
• The methods mirror RegularProgramBuilder on master. When these land, the same changes apply here:
  • fix(swap-vm)!: encode full 20-byte token addresses in balances and jumpIfToken args #108: jumpIfTokenIn / jumpIfTokenOut take token, and balances use token;
  • fix(swap-vm): keep salt instruction args as arbitrary bytes #107: salt takes bigint | HexString;
  • fix(swap-vm): reject instruction args that can never execute on-chain #133: progressiveFeeInXD / progressiveFeeOutXD use ProgressiveFeeArgs;
  • fix(swap-vm): bound BaseFeeAdjusterArgs.maxPriceDecay to (0, 1e18) #102, fix(swap-vm): allow a zero fee provider in DynamicProtocolFeeArgs #103, docs(swap-vm): document extruction and protocol fee caller requirements #111, docs: correct opcode table comments and SDK README examples #109: JSDoc for the same methods.
• The table and its @see link are pinned to v1.0.2, the deployed version. On main of 1inch/swap-vm, the sources moved to contracts/ and LimitOpcodes.sol is a redesigned table with a different instruction set, so routers deployed from main will need a new table. The main/src/... @see links of the other two tables no longer resolve for the same reason.
• LimitOpcodesDebug injects the same debug slots as the other debug routers, so a withDebug() can be added once fix(swap-vm): install debug opcodes in the SwapVM Debug layout #134 settles the debug layout.
• Merges cleanly with fix(swap-vm): install debug opcodes in the SwapVM Debug layout #134 and fix(swap-vm): make program decode strict and lossless #135; the combined tree passes build, lint, type-check and tests.

  

[sonarqubecloud]

Quality Gate failed

Failed conditions
37.3% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud