@kittycorn-labs/universal-router-sdk 1.4.43 → 2.0.0

package/dist/esm/src/utils/routerBalanceSteps.js

@@ -0,0 +1,282 @@
+import invariant from 'tiny-invariant';
+import { BigNumber } from '@ethersproject/bignumber';
+import { CONTRACT_BALANCE, ETH_ADDRESS } from './constants.js';
+function v4ActionSpendsToken(action, tokenAddress) {
+    switch (action.action) {
+        case 'SETTLE':
+        case 'SETTLE_ALL':
+            return action.currency.toLowerCase() === tokenAddress;
+        case 'SWAP_EXACT_IN':
+            return action.currencyIn.toLowerCase() === tokenAddress;
+        case 'SWAP_EXACT_IN_SINGLE': {
+            const spent = action.zeroForOne ? action.poolKey.currency0 : action.poolKey.currency1;
+            return spent.toLowerCase() === tokenAddress;
+        }
+        default:
+            return false;
+    }
+}
+// Whether a step draws the trade's input token, i.e. is a candidate first hop.
+export function stepSpendsToken(step, inputTokenAddress) {
+    var _a;
+    const tokenAddress = inputTokenAddress.toLowerCase();
+    switch (step.type) {
+        case 'V2_SWAP_EXACT_IN':
+            return ((_a = step.path[0]) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === tokenAddress;
+        case 'V3_SWAP_EXACT_IN':
+            // v3 exact-in paths are encoded input-first: the first 20 bytes are the input token
+            return step.path.slice(0, 42).toLowerCase() === tokenAddress;
+        case 'V4_SWAP':
+            return step.v4Actions.some((action) => v4ActionSpendsToken(action, tokenAddress));
+        default:
+            return false;
+    }
+}
+// The SETTLE that funds a v4 step's input-token swaps (SETTLE_ALL is refused upstream).
+export function isInputSettle(action, tokenAddress) {
+    return action.action === 'SETTLE' && action.currency.toLowerCase() === tokenAddress;
+}
+export function isInputSwap(action, tokenAddress) {
+    return ((action.action === 'SWAP_EXACT_IN' && action.currencyIn.toLowerCase() === tokenAddress) ||
+        (action.action === 'SWAP_EXACT_IN_SINGLE' && v4ActionSpendsToken(action, tokenAddress)));
+}
+export function v4SwapAmountIn(action) {
+    return action.action === 'SWAP_EXACT_IN' || action.action === 'SWAP_EXACT_IN_SINGLE'
+        ? BigNumber.from(action.amountIn)
+        : BigNumber.from(0);
+}
+// Sum of the fixed amounts the input-spending swaps take, or the settle amount when the
+// plan funds them with a single concrete settle. Zero when nothing concrete is present
+// (sentinels / open-delta), which the split logic treats as "not comparable".
+function v4StepSpendAmount(actions, tokenAddress) {
+    const settle = actions.find((action) => isInputSettle(action, tokenAddress));
+    if (settle && settle.action === 'SETTLE') {
+        const amount = BigNumber.from(settle.amount);
+        if (amount.gt(0) && !amount.eq(CONTRACT_BALANCE)) {
+            return amount;
+        }
+    }
+    return actions
+        .filter((action) => isInputSwap(action, tokenAddress))
+        .reduce((total, action) => total.add(v4SwapAmountIn(action)), BigNumber.from(0));
+}
+function applyToV4Actions(actions, tokenAddress) {
+    var _a;
+    const hasInputSettle = actions.some((action) => isInputSettle(action, tokenAddress));
+    // The settle that funds the swaps now takes the router's whole balance. Caller order is
+    // preserved, so validateEncodeSwaps requires that settle to precede the input swaps.
+    const settled = actions.map((action) => isInputSettle(action, tokenAddress)
+        ? { ...action, amount: CONTRACT_BALANCE.toString(), payerIsUser: false }
+        : action);
+    // Exactly one input swap may consume the open delta (amountIn 0). With several input
+    // swaps (a split inside the step) the others keep their quoted slices and the remainder
+    // moves after them, so it absorbs the delivery variance and the fixed slices are never
+    // starved. A plan that already nominates its remainder (GuideStar writes intermediate
+    // steps that way) keeps that one rather than gaining a second.
+    const swapIndexes = settled
+        .map((action, index) => (isInputSwap(action, tokenAddress) ? index : -1))
+        .filter((index) => index >= 0);
+    const openDeltaIndexes = swapIndexes.filter((index) => v4SwapAmountIn(settled[index]).isZero());
+    invariant(openDeltaIndexes.length <= 1, 'ROUTER_BALANCE_INPUT_MULTIPLE_OPEN_DELTA_SWAPS');
+    let transformed = settled;
+    if (swapIndexes.length === 1) {
+        transformed = settled.map((action, index) => (index === swapIndexes[0] ? { ...action, amountIn: 0 } : action));
+    }
+    else if (swapIndexes.length > 1) {
+        let remainderIndex = (_a = openDeltaIndexes[0]) !== null && _a !== void 0 ? _a : swapIndexes[0];
+        if (openDeltaIndexes.length === 0) {
+            for (const index of swapIndexes) {
+                if (v4SwapAmountIn(settled[index]).gt(v4SwapAmountIn(settled[remainderIndex]))) {
+                    remainderIndex = index;
+                }
+            }
+        }
+        const remainder = { ...settled[remainderIndex], amountIn: 0 };
+        const lastSwapIndex = swapIndexes[swapIndexes.length - 1];
+        const reordered = [];
+        settled.forEach((action, index) => {
+            if (index === remainderIndex) {
+                return;
+            }
+            reordered.push(action);
+            if (index === lastSwapIndex ||
+                (lastSwapIndex === remainderIndex && index === swapIndexes[swapIndexes.length - 2])) {
+                reordered.push(remainder);
+            }
+        });
+        transformed = reordered;
+    }
+    const result = hasInputSettle
+        ? transformed
+        : // No settle in the plan (addTrade-style shapes): fund the open delta explicitly.
+            [
+                {
+                    action: 'SETTLE',
+                    currency: tokenAddress,
+                    amount: CONTRACT_BALANCE.toString(),
+                    payerIsUser: false,
+                },
+                ...transformed,
+            ];
+    // Two swaps consuming the same open delta means the first takes it all and the second
+    // gets nothing, which encodes cleanly and reverts on chain.
+    invariant(result.filter((action) => isInputSwap(action, tokenAddress) && v4SwapAmountIn(action).isZero()).length === 1, 'ROUTER_BALANCE_INPUT_OPEN_DELTA_NOT_UNIQUE');
+    return result;
+}
+// The router holds the funds, so no leg of a spender step may pull from the user: a
+// payerIsUser flag left over from a wallet-mode plan would encode as
+// permit2.transferFrom(msg.sender) on-chain, and on this arm msg.sender is the filler,
+// not the swapper. EVERY settle in the step is cleared, not just the one funding the
+// input token: a v4 step can carry a second settle in an unrelated currency, which is
+// not the input token and so was previously left holding its flag while the step-level
+// validator waiver excused the whole step. Amounts are left untouched; this is used for
+// the fixed legs of a split.
+function clearPayerIsUser(step) {
+    switch (step.type) {
+        case 'V2_SWAP_EXACT_IN':
+        case 'V3_SWAP_EXACT_IN':
+            return { ...step, payerIsUser: false };
+        case 'V4_SWAP':
+            return {
+                ...step,
+                v4Actions: step.v4Actions.map((action) => action.action === 'SETTLE' ? { ...action, payerIsUser: false } : action),
+            };
+        default:
+            // validateEncodeSwaps refuses exact-out and unexpected shapes before this runs
+            invariant(false, 'ROUTER_BALANCE_INPUT_UNSUPPORTED_STEP');
+    }
+}
+function rewriteSpendingStep(step, tokenAddress) {
+    const cleared = clearPayerIsUser(step);
+    switch (cleared.type) {
+        case 'V2_SWAP_EXACT_IN':
+        case 'V3_SWAP_EXACT_IN':
+            return { ...cleared, amountIn: CONTRACT_BALANCE.toString() };
+        case 'V4_SWAP':
+            return { ...cleared, v4Actions: applyToV4Actions(cleared.v4Actions, tokenAddress) };
+        default:
+            invariant(false, 'ROUTER_BALANCE_INPUT_UNSUPPORTED_STEP');
+    }
+}
+// The remainder leg of a split: the largest spender by input amount, which absorbs all
+// delivery variance. A v4 leg's spend is read from its input settle (or the sum of its
+// input swaps); a leg with no concrete amount cannot be compared and is refused.
+export function stepSpendAmount(step, tokenAddress) {
+    switch (step.type) {
+        case 'V2_SWAP_EXACT_IN':
+        case 'V3_SWAP_EXACT_IN':
+            return BigNumber.from(step.amountIn);
+        case 'V4_SWAP':
+            return v4StepSpendAmount(step.v4Actions, tokenAddress);
+        default:
+            return BigNumber.from(0);
+    }
+}
+function pickRemainderIndex(swapSteps, spenderIndexes, tokenAddress) {
+    let remainderIndex = spenderIndexes[0];
+    let remainderAmount = BigNumber.from(-1);
+    for (const index of spenderIndexes) {
+        const amount = stepSpendAmount(swapSteps[index], tokenAddress);
+        invariant(amount.gt(0) && !amount.eq(CONTRACT_BALANCE), 'ROUTER_BALANCE_INPUT_SPLIT_LEG_AMOUNT_UNKNOWN');
+        if (amount.gt(remainderAmount)) {
+            remainderAmount = amount;
+            remainderIndex = index;
+        }
+    }
+    return remainderIndex;
+}
+// The unwrap converts the delivered pot to ETH, so the greedy claim moves to the leg
+// spending that ETH; the WETH legs keep their quoted amounts from router custody.
+function applyUnwrapBoundaryRemainder(swapSteps, unwrapIndex, tokenAddress) {
+    const nativeSpenders = swapSteps
+        .map((step, index) => (index > unwrapIndex && stepSpendsToken(step, ETH_ADDRESS) ? index : -1))
+        .filter((index) => index >= 0);
+    invariant(nativeSpenders.length > 0, 'ROUTER_BALANCE_INPUT_UNWRAP_WITHOUT_NATIVE_LEG');
+    invariant(nativeSpenders.length === 1, 'ROUTER_BALANCE_INPUT_UNWRAP_MULTIPLE_NATIVE_LEGS');
+    return swapSteps.map((step, index) => {
+        if (index === nativeSpenders[0]) {
+            return rewriteSpendingStep(step, ETH_ADDRESS);
+        }
+        return stepSpendsToken(step, tokenAddress) ? clearPayerIsUser(step) : step;
+    });
+}
+/**
+ * Rewrites a step plan to spend the router's entire input-token balance.
+ *
+ * Single spender: its v2/v3 exact-in amount becomes the CONTRACT_BALANCE
+ * sentinel (a v4 spender settles CONTRACT_BALANCE; one of its input swaps
+ * consumes the open delta while any others keep their quoted slices).
+ *
+ * Split routes (multiple spenders of the input token): every spender but the
+ * largest keeps its quoted amount, funded from router custody; the largest is
+ * rewritten to CONTRACT_BALANCE and MOVED after the other spenders, so it
+ * absorbs all delivery variance and the fill only reverts when delivery
+ * cannot cover the fixed legs.
+ */
+export function applyRouterBalanceInputToSteps(swapSteps, inputTokenAddress, wrappedNativeAddress) {
+    var _a;
+    const tokenAddress = inputTokenAddress.toLowerCase();
+    // UNWRAP_WETH takes the router's whole WETH balance, so with WETH delivered it is
+    // already the greedy claim and the legs before it stay fixed.
+    const unwrapIndex = swapSteps.findIndex((step) => step.type === 'UNWRAP_WETH');
+    if (unwrapIndex >= 0 && tokenAddress === (wrappedNativeAddress === null || wrappedNativeAddress === void 0 ? void 0 : wrappedNativeAddress.toLowerCase())) {
+        return applyUnwrapBoundaryRemainder(swapSteps, unwrapIndex, tokenAddress);
+    }
+    const spenderIndexes = swapSteps
+        .map((step, index) => (stepSpendsToken(step, tokenAddress) ? index : -1))
+        .filter((index) => index >= 0);
+    invariant(spenderIndexes.length > 0, 'ROUTER_BALANCE_INPUT_FIRST_STEP');
+    if (spenderIndexes.length === 1) {
+        return swapSteps.map((step, index) => index === spenderIndexes[0] ? rewriteSpendingStep(step, tokenAddress) : step);
+    }
+    const remainderIndex = pickRemainderIndex(swapSteps, spenderIndexes, tokenAddress);
+    const remainder = rewriteSpendingStep(swapSteps[remainderIndex], tokenAddress);
+    const lastSpenderIndex = spenderIndexes[spenderIndexes.length - 1];
+    const fixLeg = (step, index) => spenderIndexes.includes(index) ? clearPayerIsUser(step) : step;
+    // Already the last spender: nothing to move, and moving it would drag the
+    // trailing output-side steps along with it.
+    if (remainderIndex === lastSpenderIndex) {
+        return swapSteps.map((step, index) => (index === remainderIndex ? remainder : fixLeg(step, index)));
+    }
+    // A remainder that carries its own continuation hops cannot be placed by
+    // position: routers order steps either leg-by-leg or by token (every first hop,
+    // then everything downstream), and the two orderings want opposite insertion
+    // points. Refuse rather than guess and emit a fill that reverts.
+    const nextSpenderIndex = (_a = spenderIndexes.find((index) => index > remainderIndex)) !== null && _a !== void 0 ? _a : swapSteps.length;
+    invariant(nextSpenderIndex === remainderIndex + 1, 'ROUTER_BALANCE_INPUT_REMAINDER_LEG_NOT_REORDERABLE');
+    // So the remainder is a single step, and it moves to just after the last other
+    // spender: late enough to absorb delivery variance, early enough that the
+    // steps consuming what it produces still follow it.
+    const reordered = [];
+    swapSteps.forEach((step, index) => {
+        if (index === remainderIndex) {
+            return;
+        }
+        // fixed legs keep their quoted amounts but are funded from router custody too
+        reordered.push(fixLeg(step, index));
+        if (index === lastSpenderIndex) {
+            reordered.push(remainder);
+        }
+    });
+    return reordered;
+}
+/**
+ * Native-input variant: the plan leads with the route's WRAP_ETH, which is resized to wrap
+ * the router's entire native balance (attached msg.value plus any stray ETH, so no value
+ * is left behind — UR never refunds msg.value); the wrapped-token hop that follows then
+ * spends CONTRACT_BALANCE like an ERC20 balance swap.
+ *
+ * `validateEncodeSwaps` guarantees steps[0] is a router-recipient WRAP_ETH and exactly one
+ * later step spends the wrapped token.
+ */
+export function applyNativeRouterBalanceInputToSteps(swapSteps, wrappedTokenAddress) {
+    const wrap = swapSteps[0];
+    invariant(wrap !== undefined && wrap.type === 'WRAP_ETH', 'ROUTER_BALANCE_INPUT_NATIVE_REQUIRES_WRAP');
+    // After the full wrap, the plan is an ordinary (possibly split) balance swap
+    // of the wrapped token.
+    return [
+        { ...wrap, amount: CONTRACT_BALANCE.toString() },
+        ...applyRouterBalanceInputToSteps(swapSteps.slice(1), wrappedTokenAddress),
+    ];
+}
+//# sourceMappingURL=routerBalanceSteps.js.map

package/dist/esm/src/utils/routerBalanceSteps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routerBalanceSteps.js","sourceRoot":"","sources":["../../../../src/utils/routerBalanceSteps.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAG3D,SAAS,mBAAmB,CAAC,MAAgB,EAAE,YAAoB;IACjE,QAAQ,MAAM,CAAC,MAAM,EAAE;QACrB,KAAK,QAAQ,CAAC;QACd,KAAK,YAAY;YACf,OAAO,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAA;QACvD,KAAK,eAAe;YAClB,OAAO,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,YAAY,CAAA;QACzD,KAAK,sBAAsB,CAAC,CAAC;YAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAA;YACrF,OAAO,KAAK,CAAC,WAAW,EAAE,KAAK,YAAY,CAAA;SAC5C;QACD;YACE,OAAO,KAAK,CAAA;KACf;AACH,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,eAAe,CAAC,IAAc,EAAE,iBAAyB;;IACvE,MAAM,YAAY,GAAG,iBAAiB,CAAC,WAAW,EAAE,CAAA;IACpD,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,kBAAkB;YACrB,OAAO,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,0CAAE,WAAW,EAAE,MAAK,YAAY,CAAA;QACrD,KAAK,kBAAkB;YACrB,oFAAoF;YACpF,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,YAAY,CAAA;QAC9D,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;QACnF;YACE,OAAO,KAAK,CAAA;KACf;AACH,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,aAAa,CAAC,MAAgB,EAAE,YAAoB;IAClE,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAA;AACrF,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAgB,EAAE,YAAoB;IAChE,OAAO,CACL,CAAC,MAAM,CAAC,MAAM,KAAK,eAAe,IAAI,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC;QACvF,CAAC,MAAM,CAAC,MAAM,KAAK,sBAAsB,IAAI,mBAAmB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CACxF,CAAA;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAAgB;IAC7C,OAAO,MAAM,CAAC,MAAM,KAAK,eAAe,IAAI,MAAM,CAAC,MAAM,KAAK,sBAAsB;QAClF,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACjC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACvB,CAAC;AAED,wFAAwF;AACxF,uFAAuF;AACvF,8EAA8E;AAC9E,SAAS,iBAAiB,CAAC,OAAmB,EAAE,YAAoB;IAClE,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAC5E,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE;QACxC,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC5C,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE;YAChD,OAAO,MAAM,CAAA;SACd;KACF;IACD,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;SACrD,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;AACpF,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAmB,EAAE,YAAoB;;IACjE,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAEpF,wFAAwF;IACxF,qFAAqF;IACrF,MAAM,OAAO,GAAe,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACjD,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC;QACjC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;QACxE,CAAC,CAAC,MAAM,CACX,CAAA;IAED,qFAAqF;IACrF,wFAAwF;IACxF,uFAAuF;IACvF,sFAAsF;IACtF,+DAA+D;IAC/D,MAAM,WAAW,GAAG,OAAO;SACxB,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAA;IAChC,MAAM,gBAAgB,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/F,SAAS,CAAC,gBAAgB,CAAC,MAAM,IAAI,CAAC,EAAE,gDAAgD,CAAC,CAAA;IAEzF,IAAI,WAAW,GAAe,OAAO,CAAA;IACrC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;KAC/G;SAAM,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,IAAI,cAAc,GAAG,MAAA,gBAAgB,CAAC,CAAC,CAAC,mCAAI,WAAW,CAAC,CAAC,CAAC,CAAA;QAC1D,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE;gBAC/B,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE;oBAC9E,cAAc,GAAG,KAAK,CAAA;iBACvB;aACF;SACF;QACD,MAAM,SAAS,GAAa,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAc,CAAA;QACnF,MAAM,aAAa,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACzD,MAAM,SAAS,GAAe,EAAE,CAAA;QAChC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAChC,IAAI,KAAK,KAAK,cAAc,EAAE;gBAC5B,OAAM;aACP;YACD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACtB,IACE,KAAK,KAAK,aAAa;gBACvB,CAAC,aAAa,KAAK,cAAc,IAAI,KAAK,KAAK,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACnF;gBACA,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;aAC1B;QACH,CAAC,CAAC,CAAA;QACF,WAAW,GAAG,SAAS,CAAA;KACxB;IAED,MAAM,MAAM,GAAG,cAAc;QAC3B,CAAC,CAAC,WAAW;QACb,CAAC,CAAC,iFAAiF;YACjF;gBACE;oBACE,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,YAAY;oBACtB,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE;oBACnC,WAAW,EAAE,KAAK;iBACP;gBACb,GAAG,WAAW;aACf,CAAA;IAEL,sFAAsF;IACtF,4DAA4D;IAC5D,SAAS,CACP,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,EAC5G,4CAA4C,CAC7C,CAAA;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,oFAAoF;AACpF,qEAAqE;AACrE,uFAAuF;AACvF,qFAAqF;AACrF,sFAAsF;AACtF,uFAAuF;AACvF,wFAAwF;AACxF,6BAA6B;AAC7B,SAAS,gBAAgB,CAAC,IAAc;IACtC,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,kBAAkB,CAAC;QACxB,KAAK,kBAAkB;YACrB,OAAO,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;QACxC,KAAK,SAAS;YACZ,OAAO;gBACL,GAAG,IAAI;gBACP,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACvC,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CACxE;aACF,CAAA;QACH;YACE,+EAA+E;YAC/E,SAAS,CAAC,KAAK,EAAE,uCAAuC,CAAC,CAAA;KAC5D;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAc,EAAE,YAAoB;IAC/D,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACtC,QAAQ,OAAO,CAAC,IAAI,EAAE;QACpB,KAAK,kBAAkB,CAAC;QACxB,KAAK,kBAAkB;YACrB,OAAO,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAA;QAC9D,KAAK,SAAS;YACZ,OAAO,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAA;QACrF;YACE,SAAS,CAAC,KAAK,EAAE,uCAAuC,CAAC,CAAA;KAC5D;AACH,CAAC;AAED,uFAAuF;AACvF,uFAAuF;AACvF,iFAAiF;AACjF,MAAM,UAAU,eAAe,CAAC,IAAc,EAAE,YAAoB;IAClE,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,kBAAkB,CAAC;QACxB,KAAK,kBAAkB;YACrB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtC,KAAK,SAAS;YACZ,OAAO,iBAAiB,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;QACxD;YACE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KAC3B;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAqB,EAAE,cAAwB,EAAE,YAAoB;IAC/F,IAAI,cAAc,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;IACtC,IAAI,eAAe,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE;QAClC,MAAM,MAAM,GAAG,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,CAAA;QAC9D,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE,+CAA+C,CAAC,CAAA;QACxG,IAAI,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,EAAE;YAC9B,eAAe,GAAG,MAAM,CAAA;YACxB,cAAc,GAAG,KAAK,CAAA;SACvB;KACF;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAED,qFAAqF;AACrF,kFAAkF;AAClF,SAAS,4BAA4B,CAAC,SAAqB,EAAE,WAAmB,EAAE,YAAoB;IACpG,MAAM,cAAc,GAAG,SAAS;SAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,WAAW,IAAI,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9F,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAA;IAChC,SAAS,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,gDAAgD,CAAC,CAAA;IACtF,SAAS,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,kDAAkD,CAAC,CAAA;IAE1F,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACnC,IAAI,KAAK,KAAK,cAAc,CAAC,CAAC,CAAC,EAAE;YAC/B,OAAO,mBAAmB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;SAC9C;QACD,OAAO,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC5E,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,8BAA8B,CAC5C,SAAqB,EACrB,iBAAyB,EACzB,oBAA6B;;IAE7B,MAAM,YAAY,GAAG,iBAAiB,CAAC,WAAW,EAAE,CAAA;IAEpD,kFAAkF;IAClF,8DAA8D;IAC9D,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAA;IAC9E,IAAI,WAAW,IAAI,CAAC,IAAI,YAAY,MAAK,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,WAAW,EAAE,CAAA,EAAE;QAC5E,OAAO,4BAA4B,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,CAAA;KAC1E;IAED,MAAM,cAAc,GAAG,SAAS;SAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACxE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAA;IAChC,SAAS,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,iCAAiC,CAAC,CAAA;IAEvE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACnC,KAAK,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAC7E,CAAA;KACF;IAED,MAAM,cAAc,GAAG,kBAAkB,CAAC,SAAS,EAAE,cAAc,EAAE,YAAY,CAAC,CAAA;IAClF,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,CAAA;IAC9E,MAAM,gBAAgB,GAAG,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAElE,MAAM,MAAM,GAAG,CAAC,IAAc,EAAE,KAAa,EAAY,EAAE,CACzD,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAEhE,0EAA0E;IAC1E,4CAA4C;IAC5C,IAAI,cAAc,KAAK,gBAAgB,EAAE;QACvC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;KACpG;IAED,yEAAyE;IACzE,gFAAgF;IAChF,6EAA6E;IAC7E,iEAAiE;IACjE,MAAM,gBAAgB,GAAG,MAAA,cAAc,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,cAAc,CAAC,mCAAI,SAAS,CAAC,MAAM,CAAA;IACnG,SAAS,CAAC,gBAAgB,KAAK,cAAc,GAAG,CAAC,EAAE,oDAAoD,CAAC,CAAA;IAExG,+EAA+E;IAC/E,0EAA0E;IAC1E,oDAAoD;IACpD,MAAM,SAAS,GAAe,EAAE,CAAA;IAChC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAChC,IAAI,KAAK,KAAK,cAAc,EAAE;YAC5B,OAAM;SACP;QACD,8EAA8E;QAC9E,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QACnC,IAAI,KAAK,KAAK,gBAAgB,EAAE;YAC9B,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;SAC1B;IACH,CAAC,CAAC,CAAA;IACF,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oCAAoC,CAAC,SAAqB,EAAE,mBAA2B;IACrG,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;IACzB,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,2CAA2C,CAAC,CAAA;IAEtG,6EAA6E;IAC7E,wBAAwB;IACxB,OAAO;QACL,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,EAAE;QAChD,GAAG,8BAA8B,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC;KAC3E,CAAA;AACH,CAAC"}

package/dist/esm/src/utils/routerCommands.d.ts

@@ -0,0 +1,77 @@
+import { UniversalRouterVersion } from './constants';
+import { AcrossV4DepositV3Params } from '../entities/actions/across';
+/**
+ * CommandTypes
+ * @description Flags that modify a command's execution
+ * @enum {number}
+ */
+export declare enum CommandType {
+    V3_SWAP_EXACT_IN = 0,
+    V3_SWAP_EXACT_OUT = 1,
+    PERMIT2_TRANSFER_FROM = 2,
+    PERMIT2_PERMIT_BATCH = 3,
+    SWEEP = 4,
+    TRANSFER = 5,
+    PAY_PORTION = 6,
+    PAY_PORTION_FULL_PRECISION = 7,
+    V2_SWAP_EXACT_IN = 8,
+    V2_SWAP_EXACT_OUT = 9,
+    PERMIT2_PERMIT = 10,
+    WRAP_ETH = 11,
+    UNWRAP_WETH = 12,
+    PERMIT2_TRANSFER_FROM_BATCH = 13,
+    BALANCE_CHECK_ERC20 = 14,
+    V4_SWAP = 16,
+    V3_POSITION_MANAGER_PERMIT = 17,
+    V3_POSITION_MANAGER_CALL = 18,
+    V4_INITIALIZE_POOL = 19,
+    V4_POSITION_MANAGER_CALL = 20,
+    EXECUTE_SUB_PLAN = 33,
+    ACROSS_V4_DEPOSIT_V3 = 64
+}
+export declare enum Subparser {
+    V3PathExactIn = 0,
+    V3PathExactOut = 1
+}
+export declare enum Parser {
+    Abi = 0,
+    V4Actions = 1,
+    V3Actions = 2
+}
+export type ParamType = {
+    readonly name: string;
+    readonly type: string;
+    readonly subparser?: Subparser;
+};
+export type CommandDefinition = {
+    parser: Parser.Abi;
+    params: ParamType[];
+} | {
+    parser: Parser.V4Actions;
+} | {
+    parser: Parser.V3Actions;
+};
+export declare const COMMAND_DEFINITION: {
+    [key in CommandType]: CommandDefinition;
+};
+export declare const V2V3_SWAP_COMMANDS_V2_1_1: {
+    [key: number]: CommandDefinition;
+};
+export declare class RoutePlanner {
+    commands: string;
+    inputs: string[];
+    constructor();
+    addSubPlan(subplan: RoutePlanner): RoutePlanner;
+    addCommand(type: CommandType, parameters: any[], allowRevert?: boolean, urVersion?: UniversalRouterVersion): RoutePlanner;
+    /**
+     * Add Across bridge deposit command for cross-chain bridging
+     * @param params AcrossV4DepositV3Params containing bridge parameters
+     * @returns RoutePlanner instance for chaining
+     */
+    addAcrossBridge(params: AcrossV4DepositV3Params): RoutePlanner;
+}
+export type RouterCommand = {
+    type: CommandType;
+    encodedInput: string;
+};
+export declare function createCommand(type: CommandType, parameters: any[], urVersion?: UniversalRouterVersion): RouterCommand;