@centurion_project/universal-router-sdk 5.1.1 → 5.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/README.md +63 -64
  2. package/dist/cjs/src/entities/actions/uniswap.d.ts +9 -0
  3. package/dist/cjs/src/entities/actions/uniswap.js +45 -38
  4. package/dist/cjs/src/entities/actions/uniswap.js.map +1 -1
  5. package/dist/cjs/src/index.d.ts +3 -0
  6. package/dist/cjs/src/index.js +6 -1
  7. package/dist/cjs/src/index.js.map +1 -1
  8. package/dist/cjs/src/swapRouter.d.ts +17 -1
  9. package/dist/cjs/src/swapRouter.js +112 -12
  10. package/dist/cjs/src/swapRouter.js.map +1 -1
  11. package/dist/cjs/src/types/encodeSwaps.d.ts +157 -0
  12. package/dist/cjs/src/types/encodeSwaps.js +3 -0
  13. package/dist/cjs/src/types/encodeSwaps.js.map +1 -0
  14. package/dist/cjs/src/utils/commandParser.d.ts +4 -2
  15. package/dist/cjs/src/utils/commandParser.js +13 -5
  16. package/dist/cjs/src/utils/commandParser.js.map +1 -1
  17. package/dist/cjs/src/utils/computeEncodeSwapsAmounts.d.ts +8 -0
  18. package/dist/cjs/src/utils/computeEncodeSwapsAmounts.js +47 -0
  19. package/dist/cjs/src/utils/computeEncodeSwapsAmounts.js.map +1 -0
  20. package/dist/cjs/src/utils/constants.d.ts +2 -1
  21. package/dist/cjs/src/utils/constants.js +100 -7
  22. package/dist/cjs/src/utils/constants.js.map +1 -1
  23. package/dist/cjs/src/utils/encodeSwapStep.d.ts +4 -0
  24. package/dist/cjs/src/utils/encodeSwapStep.js +62 -0
  25. package/dist/cjs/src/utils/encodeSwapStep.js.map +1 -0
  26. package/dist/cjs/src/utils/encodeV4Action.d.ts +7 -0
  27. package/dist/cjs/src/utils/encodeV4Action.js +84 -0
  28. package/dist/cjs/src/utils/encodeV4Action.js.map +1 -0
  29. package/dist/cjs/src/utils/normalizeEncodeSwapsSpec.d.ts +2 -0
  30. package/dist/cjs/src/utils/normalizeEncodeSwapsSpec.js +18 -0
  31. package/dist/cjs/src/utils/normalizeEncodeSwapsSpec.js.map +1 -0
  32. package/dist/cjs/src/utils/routerCommands.js +6 -6
  33. package/dist/cjs/src/utils/routerCommands.js.map +1 -1
  34. package/dist/cjs/src/utils/toV4URVersion.d.ts +3 -0
  35. package/dist/cjs/src/utils/toV4URVersion.js +17 -0
  36. package/dist/cjs/src/utils/toV4URVersion.js.map +1 -0
  37. package/dist/cjs/src/utils/validateEncodeSwaps.d.ts +2 -0
  38. package/dist/cjs/src/utils/validateEncodeSwaps.js +142 -0
  39. package/dist/cjs/src/utils/validateEncodeSwaps.js.map +1 -0
  40. package/dist/esm/src/entities/actions/uniswap.d.ts +9 -0
  41. package/dist/esm/src/entities/actions/uniswap.js +47 -40
  42. package/dist/esm/src/entities/actions/uniswap.js.map +1 -1
  43. package/dist/esm/src/index.d.ts +3 -0
  44. package/dist/esm/src/index.js +3 -0
  45. package/dist/esm/src/index.js.map +1 -1
  46. package/dist/esm/src/swapRouter.d.ts +17 -1
  47. package/dist/esm/src/swapRouter.js +114 -14
  48. package/dist/esm/src/swapRouter.js.map +1 -1
  49. package/dist/esm/src/types/encodeSwaps.d.ts +157 -0
  50. package/dist/esm/src/types/encodeSwaps.js +2 -0
  51. package/dist/esm/src/types/encodeSwaps.js.map +1 -0
  52. package/dist/esm/src/utils/commandParser.d.ts +4 -2
  53. package/dist/esm/src/utils/commandParser.js +14 -6
  54. package/dist/esm/src/utils/commandParser.js.map +1 -1
  55. package/dist/esm/src/utils/computeEncodeSwapsAmounts.d.ts +8 -0
  56. package/dist/esm/src/utils/computeEncodeSwapsAmounts.js +43 -0
  57. package/dist/esm/src/utils/computeEncodeSwapsAmounts.js.map +1 -0
  58. package/dist/esm/src/utils/constants.d.ts +2 -1
  59. package/dist/esm/src/utils/constants.js +100 -7
  60. package/dist/esm/src/utils/constants.js.map +1 -1
  61. package/dist/esm/src/utils/encodeSwapStep.d.ts +4 -0
  62. package/dist/esm/src/utils/encodeSwapStep.js +58 -0
  63. package/dist/esm/src/utils/encodeSwapStep.js.map +1 -0
  64. package/dist/esm/src/utils/encodeV4Action.d.ts +7 -0
  65. package/dist/esm/src/utils/encodeV4Action.js +80 -0
  66. package/dist/esm/src/utils/encodeV4Action.js.map +1 -0
  67. package/dist/esm/src/utils/normalizeEncodeSwapsSpec.d.ts +2 -0
  68. package/dist/esm/src/utils/normalizeEncodeSwapsSpec.js +14 -0
  69. package/dist/esm/src/utils/normalizeEncodeSwapsSpec.js.map +1 -0
  70. package/dist/esm/src/utils/routerCommands.js +6 -6
  71. package/dist/esm/src/utils/routerCommands.js.map +1 -1
  72. package/dist/esm/src/utils/toV4URVersion.d.ts +3 -0
  73. package/dist/esm/src/utils/toV4URVersion.js +13 -0
  74. package/dist/esm/src/utils/toV4URVersion.js.map +1 -0
  75. package/dist/esm/src/utils/validateEncodeSwaps.d.ts +2 -0
  76. package/dist/esm/src/utils/validateEncodeSwaps.js +137 -0
  77. package/dist/esm/src/utils/validateEncodeSwaps.js.map +1 -0
  78. package/dist/types/src/entities/actions/uniswap.d.ts +9 -0
  79. package/dist/types/src/index.d.ts +3 -0
  80. package/dist/types/src/swapRouter.d.ts +17 -1
  81. package/dist/types/src/types/encodeSwaps.d.ts +157 -0
  82. package/dist/types/src/utils/commandParser.d.ts +4 -2
  83. package/dist/types/src/utils/computeEncodeSwapsAmounts.d.ts +8 -0
  84. package/dist/types/src/utils/constants.d.ts +2 -1
  85. package/dist/types/src/utils/encodeSwapStep.d.ts +4 -0
  86. package/dist/types/src/utils/encodeV4Action.d.ts +7 -0
  87. package/dist/types/src/utils/normalizeEncodeSwapsSpec.d.ts +2 -0
  88. package/dist/types/src/utils/toV4URVersion.d.ts +3 -0
  89. package/dist/types/src/utils/validateEncodeSwaps.d.ts +2 -0
  90. package/package.json +12 -10
  91. package/dist/cjs/src/abis/UniversalRouter.json +0 -747
  92. package/dist/esm/src/abis/UniversalRouter.json +0 -747
@@ -0,0 +1,137 @@
1
+ import { BigNumber } from 'ethers';
2
+ import invariant from 'tiny-invariant';
3
+ import { TradeType } from '@centurion_project/sdk-core';
4
+ import { TokenTransferMode } from '../entities/actions/uniswap';
5
+ import { ROUTER_AS_RECIPIENT, SENDER_AS_RECIPIENT, UniversalRouterVersion, ZERO_ADDRESS } from './constants';
6
+ // V3 path: 20-byte address + N × (3-byte fee + 20-byte address); minimum is 43 bytes (single hop, N=1)
7
+ // Returns N or undefined if malformed
8
+ function getV3HopCount(path) {
9
+ if (!path.startsWith('0x'))
10
+ return undefined;
11
+ const byteLength = (path.length - 2) / 2;
12
+ if (byteLength < 43)
13
+ return undefined;
14
+ const variableSegmentLength = byteLength - 20;
15
+ if (variableSegmentLength < 23 || variableSegmentLength % 23 !== 0)
16
+ return undefined;
17
+ return variableSegmentLength / 23;
18
+ }
19
+ function hasV4MinHopPriceX36(action) {
20
+ switch (action.action) {
21
+ case 'SWAP_EXACT_IN':
22
+ case 'SWAP_EXACT_OUT':
23
+ case 'SWAP_EXACT_IN_SINGLE':
24
+ case 'SWAP_EXACT_OUT_SINGLE':
25
+ return action.minHopPriceX36 !== undefined;
26
+ default:
27
+ return false;
28
+ }
29
+ }
30
+ function validateV4HopCounts(actions) {
31
+ for (const action of actions) {
32
+ switch (action.action) {
33
+ case 'SWAP_EXACT_IN':
34
+ case 'SWAP_EXACT_OUT':
35
+ invariant(!action.minHopPriceX36 || action.minHopPriceX36.length === action.path.length, 'V4_MIN_HOP_PRICE_X36_LENGTH_MISMATCH');
36
+ break;
37
+ default:
38
+ break;
39
+ }
40
+ }
41
+ }
42
+ function assertRouterRecipient(recipient) {
43
+ invariant(recipient === ROUTER_AS_RECIPIENT, 'STEP_RECIPIENT_MUST_BE_ROUTER');
44
+ }
45
+ function assertRouterActionRecipient(recipient) {
46
+ invariant(recipient === ROUTER_AS_RECIPIENT, 'V4_ACTION_RECIPIENT_MUST_BE_ROUTER');
47
+ }
48
+ // V4 actions that take a recipient must use router custody so the SDK's settlement sweeps see the funds
49
+ function validateV4Recipients(actions) {
50
+ for (const action of actions) {
51
+ switch (action.action) {
52
+ case 'TAKE':
53
+ case 'TAKE_PORTION':
54
+ assertRouterActionRecipient(action.recipient);
55
+ break;
56
+ default:
57
+ break;
58
+ }
59
+ }
60
+ }
61
+ export function validateEncodeSwaps(spec, swapSteps) {
62
+ var _a, _b, _c, _d;
63
+ invariant(swapSteps.length > 0, 'EMPTY_SWAP_STEPS');
64
+ const amountCurrency = spec.routing.amount.currency.wrapped;
65
+ const quoteCurrency = spec.routing.quote.currency.wrapped;
66
+ const inputCurrency = spec.routing.inputToken.wrapped;
67
+ const outputCurrency = spec.routing.outputToken.wrapped;
68
+ invariant(!spec.slippageTolerance.lessThan(0), 'SLIPPAGE_TOLERANCE');
69
+ invariant(spec.recipient !== ZERO_ADDRESS, 'RECIPIENT_CANNOT_BE_ZERO');
70
+ invariant(spec.recipient !== ROUTER_AS_RECIPIENT, 'RECIPIENT_CANNOT_BE_ROUTER');
71
+ // routing.amount is on the exact side of the trade; routing.quote is on the slippage side
72
+ if (spec.tradeType === TradeType.EXACT_INPUT) {
73
+ invariant(amountCurrency.equals(inputCurrency), 'INVALID_ROUTING_AMOUNT_CURRENCY');
74
+ invariant(quoteCurrency.equals(outputCurrency), 'INVALID_ROUTING_QUOTE_CURRENCY');
75
+ }
76
+ else {
77
+ invariant(amountCurrency.equals(outputCurrency), 'INVALID_ROUTING_AMOUNT_CURRENCY');
78
+ invariant(quoteCurrency.equals(inputCurrency), 'INVALID_ROUTING_QUOTE_CURRENCY');
79
+ }
80
+ // ApproveProxy ingress lives upstream in the proxy contract: needs chain id, ERC20 input, no permit2, explicit recipient
81
+ if (spec.tokenTransferMode === TokenTransferMode.ApproveProxy) {
82
+ invariant(!!spec.chainId, 'PROXY_MISSING_CHAIN_ID');
83
+ invariant(!spec.routing.inputToken.isNative, 'PROXY_NATIVE_INPUT');
84
+ invariant(!spec.permit, 'PROXY_PERMIT_CONFLICT');
85
+ invariant(spec.recipient !== SENDER_AS_RECIPIENT, 'PROXY_EXPLICIT_RECIPIENT_REQUIRED');
86
+ }
87
+ // permit2 is ERC20-only; native input pays via msg.value
88
+ invariant(!(spec.routing.inputToken.isNative && spec.permit), 'NATIVE_INPUT_PERMIT');
89
+ // native-ERC20 gas-token input (e.g. Arc USDC): funded via msg.value, never via Permit2
90
+ if (spec.nativeErc20Input) {
91
+ invariant(!spec.routing.inputToken.isNative, 'NATIVE_ERC20_INPUT_NATIVE_TOKEN');
92
+ invariant(!spec.permit, 'NATIVE_ERC20_INPUT_PERMIT_CONFLICT');
93
+ invariant(spec.tokenTransferMode !== TokenTransferMode.ApproveProxy, 'NATIVE_ERC20_INPUT_PROXY_CONFLICT');
94
+ invariant(spec.routing.inputToken.decimals <= 18, 'NATIVE_ERC20_INPUT_DECIMALS');
95
+ }
96
+ // portion fees pair with exact-input (% of variable output); flat fees pair with exact-output (fixed deduction from the target)
97
+ invariant(!(((_a = spec.fee) === null || _a === void 0 ? void 0 : _a.kind) === 'portion' && spec.tradeType !== TradeType.EXACT_INPUT), 'INVALID_PORTION_FEE_TRADE_TYPE');
98
+ invariant(!(((_b = spec.fee) === null || _b === void 0 ? void 0 : _b.kind) === 'flat' && spec.tradeType !== TradeType.EXACT_OUTPUT), 'INVALID_FLAT_FEE_TRADE_TYPE');
99
+ invariant(!(((_c = spec.fee) === null || _c === void 0 ? void 0 : _c.kind) === 'flat' &&
100
+ BigNumber.from(spec.fee.amount).gt(BigNumber.from(spec.routing.amount.quotient.toString()))), 'FLAT_FEE_GT_AMOUNT');
101
+ // v2.0 PAY_PORTION takes whole bps; fractional bps need >=v2.1.1's PAY_PORTION_FULL_PRECISION
102
+ invariant(!(((_d = spec.fee) === null || _d === void 0 ? void 0 : _d.kind) === 'portion' &&
103
+ spec.urVersion === UniversalRouterVersion.V2_0 &&
104
+ !spec.fee.fee.multiply(10000).remainder.equalTo(0)), 'FRACTIONAL_BPS_PORTION_FEE_UNSUPPORTED_ON_V2_0');
105
+ // per-step: capability-gate by UR version, recipients must be router custody, per-hop arrays must match hop counts
106
+ for (const step of swapSteps) {
107
+ if (spec.urVersion === UniversalRouterVersion.V2_0) {
108
+ invariant(!('minHopPriceX36' in step) || step.minHopPriceX36 === undefined, 'MIN_HOP_PRICE_X36_UNSUPPORTED_ON_V2_0');
109
+ invariant(!(step.type === 'V4_SWAP' && step.v4Actions.some(hasV4MinHopPriceX36)), 'MIN_HOP_PRICE_X36_UNSUPPORTED_ON_V2_0');
110
+ }
111
+ switch (step.type) {
112
+ case 'V2_SWAP_EXACT_IN':
113
+ case 'V2_SWAP_EXACT_OUT':
114
+ assertRouterRecipient(step.recipient);
115
+ invariant(!step.minHopPriceX36 || step.minHopPriceX36.length === step.path.length - 1, 'V2_MIN_HOP_PRICE_X36_LENGTH_MISMATCH');
116
+ break;
117
+ case 'V3_SWAP_EXACT_IN':
118
+ case 'V3_SWAP_EXACT_OUT': {
119
+ assertRouterRecipient(step.recipient);
120
+ const hopCount = getV3HopCount(step.path);
121
+ invariant(hopCount === undefined || !step.minHopPriceX36 || step.minHopPriceX36.length === hopCount, 'V3_MIN_HOP_PRICE_X36_LENGTH_MISMATCH');
122
+ break;
123
+ }
124
+ case 'WRAP_ETH':
125
+ case 'UNWRAP_WETH':
126
+ assertRouterRecipient(step.recipient);
127
+ break;
128
+ case 'V4_SWAP':
129
+ validateV4HopCounts(step.v4Actions);
130
+ validateV4Recipients(step.v4Actions);
131
+ break;
132
+ default:
133
+ break;
134
+ }
135
+ }
136
+ }
137
+ //# sourceMappingURL=validateEncodeSwaps.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validateEncodeSwaps.js","sourceRoot":"","sources":["../../../../src/utils/validateEncodeSwaps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG5G,uGAAuG;AACvG,sCAAsC;AACtC,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAA;IAE5C,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,UAAU,GAAG,EAAE;QAAE,OAAO,SAAS,CAAA;IAErC,MAAM,qBAAqB,GAAG,UAAU,GAAG,EAAE,CAAA;IAC7C,IAAI,qBAAqB,GAAG,EAAE,IAAI,qBAAqB,GAAG,EAAE,KAAK,CAAC;QAAE,OAAO,SAAS,CAAA;IAEpF,OAAO,qBAAqB,GAAG,EAAE,CAAA;AACnC,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAgB;IAC3C,QAAQ,MAAM,CAAC,MAAM,EAAE;QACrB,KAAK,eAAe,CAAC;QACrB,KAAK,gBAAgB,CAAC;QACtB,KAAK,sBAAsB,CAAC;QAC5B,KAAK,uBAAuB;YAC1B,OAAO,MAAM,CAAC,cAAc,KAAK,SAAS,CAAA;QAC5C;YACE,OAAO,KAAK,CAAA;KACf;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAmB;IAC9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,QAAQ,MAAM,CAAC,MAAM,EAAE;YACrB,KAAK,eAAe,CAAC;YACrB,KAAK,gBAAgB;gBACnB,SAAS,CACP,CAAC,MAAM,CAAC,cAAc,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,EAC7E,sCAAsC,CACvC,CAAA;gBACD,MAAK;YACP;gBACE,MAAK;SACR;KACF;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,SAAiB;IAC9C,SAAS,CAAC,SAAS,KAAK,mBAAmB,EAAE,+BAA+B,CAAC,CAAA;AAC/E,CAAC;AAED,SAAS,2BAA2B,CAAC,SAAiB;IACpD,SAAS,CAAC,SAAS,KAAK,mBAAmB,EAAE,oCAAoC,CAAC,CAAA;AACpF,CAAC;AAED,wGAAwG;AACxG,SAAS,oBAAoB,CAAC,OAAmB;IAC/C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,QAAQ,MAAM,CAAC,MAAM,EAAE;YACrB,KAAK,MAAM,CAAC;YACZ,KAAK,cAAc;gBACjB,2BAA2B,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;gBAC7C,MAAK;YACP;gBACE,MAAK;SACR;KACF;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAiC,EAAE,SAAqB;;IAC1F,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,kBAAkB,CAAC,CAAA;IAEnD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAA;IAC3D,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAA;IACzD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAA;IACrD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAA;IAEvD,SAAS,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAA;IACpE,SAAS,CAAC,IAAI,CAAC,SAAS,KAAK,YAAY,EAAE,0BAA0B,CAAC,CAAA;IACtE,SAAS,CAAC,IAAI,CAAC,SAAS,KAAK,mBAAmB,EAAE,4BAA4B,CAAC,CAAA;IAE/E,0FAA0F;IAC1F,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE;QAC5C,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,iCAAiC,CAAC,CAAA;QAClF,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,gCAAgC,CAAC,CAAA;KAClF;SAAM;QACL,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,iCAAiC,CAAC,CAAA;QACnF,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,gCAAgC,CAAC,CAAA;KACjF;IAED,yHAAyH;IACzH,IAAI,IAAI,CAAC,iBAAiB,KAAK,iBAAiB,CAAC,YAAY,EAAE;QAC7D,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAA;QACnD,SAAS,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAA;QAClE,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;QAChD,SAAS,CAAC,IAAI,CAAC,SAAS,KAAK,mBAAmB,EAAE,mCAAmC,CAAC,CAAA;KACvF;IACD,yDAAyD;IACzD,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAA;IAEpF,wFAAwF;IACxF,IAAI,IAAI,CAAC,gBAAgB,EAAE;QACzB,SAAS,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,iCAAiC,CAAC,CAAA;QAC/E,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAA;QAC7D,SAAS,CAAC,IAAI,CAAC,iBAAiB,KAAK,iBAAiB,CAAC,YAAY,EAAE,mCAAmC,CAAC,CAAA;QACzG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE,EAAE,6BAA6B,CAAC,CAAA;KACjF;IAED,gIAAgI;IAChI,SAAS,CACP,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,IAAI,MAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,WAAW,CAAC,EAC3E,gCAAgC,CACjC,CAAA;IACD,SAAS,CAAC,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,IAAI,MAAK,MAAM,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,YAAY,CAAC,EAAE,6BAA6B,CAAC,CAAA;IACnH,SAAS,CACP,CAAC,CACC,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,IAAI,MAAK,MAAM;QACzB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAC5F,EACD,oBAAoB,CACrB,CAAA;IAED,8FAA8F;IAC9F,SAAS,CACP,CAAC,CACC,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,IAAI,MAAK,SAAS;QAC5B,IAAI,CAAC,SAAS,KAAK,sBAAsB,CAAC,IAAI;QAC9C,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CACpD,EACD,gDAAgD,CACjD,CAAA;IAED,mHAAmH;IACnH,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;QAC5B,IAAI,IAAI,CAAC,SAAS,KAAK,sBAAsB,CAAC,IAAI,EAAE;YAClD,SAAS,CACP,CAAC,CAAC,gBAAgB,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAChE,uCAAuC,CACxC,CAAA;YACD,SAAS,CACP,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,EACtE,uCAAuC,CACxC,CAAA;SACF;QAED,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,kBAAkB,CAAC;YACxB,KAAK,mBAAmB;gBACtB,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACrC,SAAS,CACP,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAC3E,sCAAsC,CACvC,CAAA;gBACD,MAAK;YACP,KAAK,kBAAkB,CAAC;YACxB,KAAK,mBAAmB,CAAC,CAAC;gBACxB,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACrC,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACzC,SAAS,CACP,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,QAAQ,EACzF,sCAAsC,CACvC,CAAA;gBACD,MAAK;aACN;YACD,KAAK,UAAU,CAAC;YAChB,KAAK,aAAa;gBAChB,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACrC,MAAK;YACP,KAAK,SAAS;gBACZ,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACnC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACpC,MAAK;YACP;gBACE,MAAK;SACR;KACF;AACH,CAAC"}
@@ -15,6 +15,15 @@ export declare enum TokenTransferMode {
15
15
  }
16
16
  export type SwapOptions = Omit<RouterSwapOptions, 'inputTokenPermit'> & {
17
17
  useRouterBalance?: boolean;
18
+ /**
19
+ * The input Token is the chain's native gas token exposed via an ERC20 predeploy whose balance
20
+ * mirrors the native balance (e.g. USDC on Arc). The swap is funded by attaching
21
+ * msg.value = maximumAmountIn * 10^(18 - token.decimals) instead of pulling via Permit2:
22
+ * the router self-funds (payerIsUser = false) and unused input is swept back to the recipient
23
+ * on exact-output / partial-fill-risk trades. No ERC20 approval or permit is ever needed.
24
+ * Incompatible with native input, inputTokenPermit, and TokenTransferMode.ApproveProxy.
25
+ */
26
+ nativeErc20Input?: boolean;
18
27
  inputTokenPermit?: Permit2Permit;
19
28
  flatFee?: FlatFeeOptions;
20
29
  safeMode?: boolean;
@@ -1,5 +1,6 @@
1
1
  export { SwapRouter } from './swapRouter';
2
2
  export type { MigrateV3ToV4Options, SignedRouteOptions, EIP712Payload } from './swapRouter';
3
+ export * from './types/encodeSwaps';
3
4
  export * from './entities';
4
5
  export * from './utils/routerTradeAdapter';
5
6
  export { RoutePlanner, CommandType, COMMAND_DEFINITION, Parser, Subparser } from './utils/routerCommands';
@@ -8,4 +9,6 @@ export { UNIVERSAL_ROUTER_CREATION_BLOCK, UNIVERSAL_ROUTER_ADDRESS, SWAP_PROXY_A
8
9
  export { CommandParser, GenericCommandParser } from './utils/commandParser';
9
10
  export type { UniversalRouterCommand, UniversalRouterCall, Param, CommandsDefinition } from './utils/commandParser';
10
11
  export type { Permit2Permit } from './utils/inputTokens';
12
+ export { normalizeEncodeSwapsSpec } from './utils/normalizeEncodeSwapsSpec';
13
+ export { validateEncodeSwaps } from './utils/validateEncodeSwaps';
11
14
  export { NONCE_SKIP_CHECK, generateNonce, EXECUTE_SIGNED_TYPES, getUniversalRouterDomain } from './utils/eip712';
@@ -6,6 +6,7 @@ import { Trade as RouterTrade } from '@centurion_project/router-sdk';
6
6
  import { Currency, TradeType } from '@centurion_project/sdk-core';
7
7
  import { SwapOptions } from './entities/actions/uniswap';
8
8
  import { AcrossV4DepositV3Params } from './entities/actions/across';
9
+ import { SwapSpecification, SwapStep } from './types/encodeSwaps';
9
10
  import { TypedDataDomain, TypedDataField } from '@ethersproject/abstract-signer';
10
11
  export type SwapRouterConfig = {
11
12
  sender?: string;
@@ -40,6 +41,20 @@ export declare abstract class SwapRouter {
40
41
  static INTERFACE: Interface;
41
42
  static PROXY_INTERFACE: Interface;
42
43
  static swapCallParameters(trades: RouterTrade<Currency, Currency, TradeType>, options: SwapOptions, bridgeOptions?: AcrossV4DepositV3Params[]): MethodParameters;
44
+ /**
45
+ * Encodes router-provided swap steps inside the SDK safety envelope.
46
+ *
47
+ * Routers own `swapSteps` (V2/V3/V4 swaps, plus any `WRAP_ETH` / `UNWRAP_WETH` required by the route).
48
+ * The SDK owns ingress, fees, final settlement, exact-output refund, and optional `safeMode`.
49
+ *
50
+ * Router contract: end with final output in `spec.routing.outputToken`; for `EXACT_OUTPUT`, unused input
51
+ * must end in `spec.routing.inputToken`. Don't include a top-level `SWEEP` — the SDK appends settlement,
52
+ * refund, and safeMode sweeps itself.
53
+ *
54
+ * Router custody with `payerIsUser = false` is deliberate for safety, even if it costs an extra command
55
+ * or transfer; the SDK does not infer route topology on behalf of routers.
56
+ */
57
+ static encodeSwaps(spec: SwapSpecification, swapSteps: SwapStep[]): MethodParameters;
43
58
  /**
44
59
  * Generate EIP712 payload for signed execution (no signing performed)
45
60
  * Decodes existing execute() calldata and prepares it for signing
@@ -80,8 +95,9 @@ export declare abstract class SwapRouter {
80
95
  */
81
96
  private static encodePlan;
82
97
  /**
83
- * Encodes a planned route into calldata targeting the SwapProxy contract.
98
+ * Wraps an inner UR plan in calldata targeting the SwapProxy contract.
84
99
  * The proxy pulls ERC20 tokens from the user into the UR, then executes commands.
85
100
  */
86
101
  private static encodeProxyPlan;
102
+ private static encodeProxyCall;
87
103
  }
@@ -0,0 +1,157 @@
1
+ import { BigNumberish } from 'ethers';
2
+ import { Currency, CurrencyAmount, Percent, TradeType } from '@centurion_project/sdk-core';
3
+ import { type PathKey, type PoolKey } from '@centurion_project/v4-sdk';
4
+ import { TokenTransferMode } from '../entities/actions/uniswap';
5
+ import { Permit2Permit } from '../utils/inputTokens';
6
+ import { UniversalRouterVersion } from '../utils/constants';
7
+ export type { PathKey, PoolKey };
8
+ export type Fee = {
9
+ kind: 'portion';
10
+ recipient: string;
11
+ fee: Percent;
12
+ } | {
13
+ kind: 'flat';
14
+ recipient: string;
15
+ amount: BigNumberish;
16
+ };
17
+ export type SwapSpecification = {
18
+ tradeType: TradeType;
19
+ routing: {
20
+ inputToken: Currency;
21
+ outputToken: Currency;
22
+ amount: CurrencyAmount<Currency>;
23
+ quote: CurrencyAmount<Currency>;
24
+ };
25
+ slippageTolerance: Percent;
26
+ recipient?: string;
27
+ fee?: Fee;
28
+ tokenTransferMode?: TokenTransferMode;
29
+ permit?: Permit2Permit;
30
+ chainId?: number;
31
+ deadline?: BigNumberish;
32
+ urVersion?: UniversalRouterVersion;
33
+ safeMode?: boolean;
34
+ /**
35
+ * The input Token is the chain's native gas token exposed via an ERC20 predeploy whose balance
36
+ * mirrors the native balance (e.g. USDC on Arc). The swap is funded by attaching
37
+ * msg.value = exactOrMaxAmountIn * 10^(18 - token.decimals) instead of pulling via Permit2:
38
+ * the PERMIT2_TRANSFER_FROM ingress is skipped and no ERC20 approval or permit is ever needed.
39
+ * Incompatible with native input, permit, and TokenTransferMode.ApproveProxy.
40
+ */
41
+ nativeErc20Input?: boolean;
42
+ };
43
+ export type NormalizedSwapSpecification = Omit<SwapSpecification, 'recipient' | 'tokenTransferMode' | 'urVersion' | 'safeMode'> & {
44
+ recipient: string;
45
+ tokenTransferMode: TokenTransferMode;
46
+ urVersion: UniversalRouterVersion;
47
+ safeMode: boolean;
48
+ };
49
+ export type V2SwapExactIn = {
50
+ type: 'V2_SWAP_EXACT_IN';
51
+ recipient: string;
52
+ amountIn: BigNumberish;
53
+ amountOutMin: BigNumberish;
54
+ path: string[];
55
+ minHopPriceX36?: BigNumberish[];
56
+ };
57
+ export type V2SwapExactOut = {
58
+ type: 'V2_SWAP_EXACT_OUT';
59
+ recipient: string;
60
+ amountOut: BigNumberish;
61
+ amountInMax: BigNumberish;
62
+ path: string[];
63
+ minHopPriceX36?: BigNumberish[];
64
+ };
65
+ export type V3SwapExactIn = {
66
+ type: 'V3_SWAP_EXACT_IN';
67
+ recipient: string;
68
+ amountIn: BigNumberish;
69
+ amountOutMin: BigNumberish;
70
+ path: string;
71
+ minHopPriceX36?: BigNumberish[];
72
+ };
73
+ export type V3SwapExactOut = {
74
+ type: 'V3_SWAP_EXACT_OUT';
75
+ recipient: string;
76
+ amountOut: BigNumberish;
77
+ amountInMax: BigNumberish;
78
+ path: string;
79
+ minHopPriceX36?: BigNumberish[];
80
+ };
81
+ export type V4Swap = {
82
+ type: 'V4_SWAP';
83
+ v4Actions: V4Action[];
84
+ };
85
+ export type WrapEth = {
86
+ type: 'WRAP_ETH';
87
+ recipient: string;
88
+ amount: BigNumberish;
89
+ };
90
+ export type UnwrapWeth = {
91
+ type: 'UNWRAP_WETH';
92
+ recipient: string;
93
+ amountMin: BigNumberish;
94
+ };
95
+ export type SwapStep = V2SwapExactIn | V2SwapExactOut | V3SwapExactIn | V3SwapExactOut | V4Swap | WrapEth | UnwrapWeth;
96
+ export type V4SwapExactIn = {
97
+ action: 'SWAP_EXACT_IN';
98
+ currencyIn: string;
99
+ path: PathKey[];
100
+ amountIn: BigNumberish;
101
+ amountOutMinimum: BigNumberish;
102
+ minHopPriceX36?: BigNumberish[];
103
+ };
104
+ export type V4SwapExactInSingle = {
105
+ action: 'SWAP_EXACT_IN_SINGLE';
106
+ poolKey: PoolKey;
107
+ zeroForOne: boolean;
108
+ amountIn: BigNumberish;
109
+ amountOutMinimum: BigNumberish;
110
+ minHopPriceX36?: BigNumberish;
111
+ hookData: string;
112
+ };
113
+ export type V4SwapExactOut = {
114
+ action: 'SWAP_EXACT_OUT';
115
+ currencyOut: string;
116
+ path: PathKey[];
117
+ amountOut: BigNumberish;
118
+ amountInMaximum: BigNumberish;
119
+ minHopPriceX36?: BigNumberish[];
120
+ };
121
+ export type V4SwapExactOutSingle = {
122
+ action: 'SWAP_EXACT_OUT_SINGLE';
123
+ poolKey: PoolKey;
124
+ zeroForOne: boolean;
125
+ amountOut: BigNumberish;
126
+ amountInMaximum: BigNumberish;
127
+ minHopPriceX36?: BigNumberish;
128
+ hookData: string;
129
+ };
130
+ export type V4Settle = {
131
+ action: 'SETTLE';
132
+ currency: string;
133
+ amount: BigNumberish;
134
+ };
135
+ export type V4SettleAll = {
136
+ action: 'SETTLE_ALL';
137
+ currency: string;
138
+ maxAmount: BigNumberish;
139
+ };
140
+ export type V4Take = {
141
+ action: 'TAKE';
142
+ currency: string;
143
+ recipient: string;
144
+ amount: BigNumberish;
145
+ };
146
+ export type V4TakeAll = {
147
+ action: 'TAKE_ALL';
148
+ currency: string;
149
+ minAmount: BigNumberish;
150
+ };
151
+ export type V4TakePortion = {
152
+ action: 'TAKE_PORTION';
153
+ currency: string;
154
+ recipient: string;
155
+ bips: BigNumberish;
156
+ };
157
+ export type V4Action = V4SwapExactIn | V4SwapExactInSingle | V4SwapExactOut | V4SwapExactOutSingle | V4Settle | V4SettleAll | V4Take | V4TakeAll | V4TakePortion;
@@ -1,5 +1,6 @@
1
1
  import { Interface } from '@ethersproject/abi';
2
2
  import { CommandType, CommandDefinition } from '../utils/routerCommands';
3
+ import { UniversalRouterVersion } from '../utils/constants';
3
4
  export type Param = {
4
5
  readonly name: string;
5
6
  readonly value: any;
@@ -22,11 +23,12 @@ export interface CommandsDefinition {
22
23
  }
23
24
  export declare abstract class CommandParser {
24
25
  static INTERFACE: Interface;
25
- static parseCalldata(calldata: string): UniversalRouterCall;
26
+ static parseCalldata(calldata: string, urVersion?: UniversalRouterVersion): UniversalRouterCall;
26
27
  }
27
28
  export declare class GenericCommandParser {
28
29
  private readonly commandDefinition;
29
- constructor(commandDefinition: CommandsDefinition);
30
+ private readonly urVersion;
31
+ constructor(commandDefinition: CommandsDefinition, urVersion?: UniversalRouterVersion);
30
32
  parse(commands: string, inputs: string[]): UniversalRouterCall;
31
33
  private static getCommands;
32
34
  }
@@ -0,0 +1,8 @@
1
+ import { BigNumber } from 'ethers';
2
+ import { NormalizedSwapSpecification } from '../types/encodeSwaps';
3
+ export type EncodeSwapsAmounts = {
4
+ exactOrMaxAmountIn: BigNumber;
5
+ grossMinOrExactAmountOut: BigNumber;
6
+ netMinOrExactAmountOut: BigNumber;
7
+ };
8
+ export declare function computeEncodeSwapsAmounts(spec: NormalizedSwapSpecification): EncodeSwapsAmounts;
@@ -2,7 +2,8 @@ import { BigNumber } from 'ethers';
2
2
  export declare enum UniversalRouterVersion {
3
3
  V1_2 = "1.2",
4
4
  V2_0 = "2.0",
5
- V2_1_1 = "2.1.1"
5
+ V2_1_1 = "2.1.1",
6
+ V2_2_0 = "2.2.0"
6
7
  }
7
8
  /**
8
9
  * Check if a UniversalRouterVersion is at least V2_1_1.
@@ -0,0 +1,4 @@
1
+ import { UniversalRouterVersion } from './constants';
2
+ import { RoutePlanner } from './routerCommands';
3
+ import { SwapStep } from '../types/encodeSwaps';
4
+ export declare function encodeSwapStep(planner: RoutePlanner, step: SwapStep, urVersion?: UniversalRouterVersion): void;
@@ -0,0 +1,7 @@
1
+ import { Actions } from '@centurion_project/v4-sdk';
2
+ import { UniversalRouterVersion } from './constants';
3
+ import { V4Action } from '../types/encodeSwaps';
4
+ export declare function encodeV4Action(v4Action: V4Action, urVersion?: UniversalRouterVersion): {
5
+ action: Actions;
6
+ params: any[];
7
+ };
@@ -0,0 +1,2 @@
1
+ import { NormalizedSwapSpecification, SwapSpecification } from '../types/encodeSwaps';
2
+ export declare function normalizeEncodeSwapsSpec(spec: SwapSpecification): NormalizedSwapSpecification;
@@ -0,0 +1,3 @@
1
+ import { URVersion } from '@centurion_project/v4-sdk';
2
+ import { UniversalRouterVersion } from './constants';
3
+ export declare function toV4URVersion(version?: UniversalRouterVersion): URVersion;
@@ -0,0 +1,2 @@
1
+ import { NormalizedSwapSpecification, SwapStep } from '../types/encodeSwaps';
2
+ export declare function validateEncodeSwaps(spec: NormalizedSwapSpecification, swapSteps: SwapStep[]): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@centurion_project/universal-router-sdk",
3
- "version": "5.1.1",
3
+ "version": "5.9.1",
4
4
  "description": "Centurion Universal Router SDK",
5
5
  "repository": "https://github.com/CenturionDEX/centurion-dex-sdks",
6
6
  "keywords": [
@@ -44,17 +44,20 @@
44
44
  "@ethersproject/abi": "^5.5.0",
45
45
  "@ethersproject/abstract-signer": "^5.7.0",
46
46
  "@openzeppelin/contracts": "4.7.0",
47
+ "@centurion_project/permit2-sdk": "^1.4.3",
48
+ "@centurion_project/router-sdk": "^2.11.1",
49
+ "@centurion_project/sdk-core": "^7.18.1",
50
+ "@uniswap/universal-router": "2.1.0",
51
+ "@uniswap/v2-core": "^1.0.1",
52
+ "@centurion_project/v2-sdk": "^4.21.1",
53
+ "@uniswap/v3-core": "1.0.0",
54
+ "@centurion_project/v3-sdk": "^3.31.1",
55
+ "@centurion_project/v4-sdk": "^2.0.0",
47
56
  "bignumber.js": "^9.0.2",
48
57
  "ethers": "^5.7.0",
49
58
  "jsbi": "^3.1.4",
50
59
  "tiny-invariant": "^1.1.0",
51
- "tslib": "^2.3.0",
52
- "@centurion_project/sdk-core": "^7.13.1",
53
- "@centurion_project/v2-sdk": "^4.20.3",
54
- "@centurion_project/v3-sdk": "^3.30.3",
55
- "@centurion_project/router-sdk": "^2.9.1",
56
- "@centurion_project/permit2-sdk": "^1.4.1",
57
- "@centurion_project/v4-sdk": "^2.0.0"
60
+ "tslib": "^2.3.0"
58
61
  },
59
62
  "devDependencies": {
60
63
  "@types/chai": "^4.3.3",
@@ -77,7 +80,6 @@
77
80
  "trailingComma": "es5"
78
81
  },
79
82
  "publishConfig": {
80
- "access": "public",
81
- "provenance": true
83
+ "access": "public"
82
84
  }
83
85
  }