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

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

@@ -0,0 +1,80 @@
+import { Actions } from '@kittycorn-labs/v4-sdk';
+import { isAtLeastV2_1_1 } from './constants.js';
+const ACTION_NAME_TO_ENUM = Object.fromEntries(Object.entries(Actions).filter(([key]) => isNaN(Number(key))));
+export function encodeV4Action(v4Action, urVersion) {
+    var _a, _b, _c, _d;
+    const action = ACTION_NAME_TO_ENUM[v4Action.action];
+    if (action === undefined)
+        throw new Error(`Unknown V4 action: ${v4Action.action}`);
+    const useV2_1_1 = isAtLeastV2_1_1(urVersion);
+    switch (v4Action.action) {
+        case 'SWAP_EXACT_IN':
+            return {
+                action,
+                params: [
+                    {
+                        currencyIn: v4Action.currencyIn,
+                        path: v4Action.path,
+                        ...(useV2_1_1 && { minHopPriceX36: (_a = v4Action.minHopPriceX36) !== null && _a !== void 0 ? _a : [] }),
+                        amountIn: v4Action.amountIn,
+                        amountOutMinimum: v4Action.amountOutMinimum,
+                    },
+                ],
+            };
+        case 'SWAP_EXACT_IN_SINGLE':
+            return {
+                action,
+                params: [
+                    {
+                        poolKey: v4Action.poolKey,
+                        zeroForOne: v4Action.zeroForOne,
+                        amountIn: v4Action.amountIn,
+                        amountOutMinimum: v4Action.amountOutMinimum,
+                        ...(useV2_1_1 && { minHopPriceX36: (_b = v4Action.minHopPriceX36) !== null && _b !== void 0 ? _b : 0 }),
+                        hookData: v4Action.hookData,
+                    },
+                ],
+            };
+        case 'SWAP_EXACT_OUT':
+            return {
+                action,
+                params: [
+                    {
+                        currencyOut: v4Action.currencyOut,
+                        path: v4Action.path,
+                        ...(useV2_1_1 && { minHopPriceX36: (_c = v4Action.minHopPriceX36) !== null && _c !== void 0 ? _c : [] }),
+                        amountOut: v4Action.amountOut,
+                        amountInMaximum: v4Action.amountInMaximum,
+                    },
+                ],
+            };
+        case 'SWAP_EXACT_OUT_SINGLE':
+            return {
+                action,
+                params: [
+                    {
+                        poolKey: v4Action.poolKey,
+                        zeroForOne: v4Action.zeroForOne,
+                        amountOut: v4Action.amountOut,
+                        amountInMaximum: v4Action.amountInMaximum,
+                        ...(useV2_1_1 && { minHopPriceX36: (_d = v4Action.minHopPriceX36) !== null && _d !== void 0 ? _d : 0 }),
+                        hookData: v4Action.hookData,
+                    },
+                ],
+            };
+        case 'SETTLE':
+            // payerIsUser defaults to false (router custody); validateEncodeSwaps gates when true is allowed
+            return { action, params: [v4Action.currency, v4Action.amount, v4Action.payerIsUser === true] };
+        case 'SETTLE_ALL':
+            return { action, params: [v4Action.currency, v4Action.maxAmount] };
+        case 'TAKE':
+            return { action, params: [v4Action.currency, v4Action.recipient, v4Action.amount] };
+        case 'TAKE_ALL':
+            return { action, params: [v4Action.currency, v4Action.minAmount] };
+        case 'TAKE_PORTION':
+            return { action, params: [v4Action.currency, v4Action.recipient, v4Action.bips] };
+        default:
+            throw new Error(`Unhandled V4 action: ${v4Action.action}`);
+    }
+}
+//# sourceMappingURL=encodeV4Action.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"encodeV4Action.js","sourceRoot":"","sources":["../../../../src/utils/encodeV4Action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAA0B,eAAe,EAAE,MAAM,aAAa,CAAA;AAGrE,MAAM,mBAAmB,GAA+B,MAAM,CAAC,WAAW,CACxE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAChC,CAAA;AAE/B,MAAM,UAAU,cAAc,CAC5B,QAAkB,EAClB,SAAkC;;IAElC,MAAM,MAAM,GAAG,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnD,IAAI,MAAM,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;IAElF,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAA;IAE5C,QAAQ,QAAQ,CAAC,MAAM,EAAE;QACvB,KAAK,eAAe;YAClB,OAAO;gBACL,MAAM;gBACN,MAAM,EAAE;oBACN;wBACE,UAAU,EAAE,QAAQ,CAAC,UAAU;wBAC/B,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,GAAG,CAAC,SAAS,IAAI,EAAE,cAAc,EAAE,MAAA,QAAQ,CAAC,cAAc,mCAAI,EAAE,EAAE,CAAC;wBACnE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;wBAC3B,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;qBAC5C;iBACF;aACF,CAAA;QACH,KAAK,sBAAsB;YACzB,OAAO;gBACL,MAAM;gBACN,MAAM,EAAE;oBACN;wBACE,OAAO,EAAE,QAAQ,CAAC,OAAO;wBACzB,UAAU,EAAE,QAAQ,CAAC,UAAU;wBAC/B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;wBAC3B,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;wBAC3C,GAAG,CAAC,SAAS,IAAI,EAAE,cAAc,EAAE,MAAA,QAAQ,CAAC,cAAc,mCAAI,CAAC,EAAE,CAAC;wBAClE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;qBAC5B;iBACF;aACF,CAAA;QACH,KAAK,gBAAgB;YACnB,OAAO;gBACL,MAAM;gBACN,MAAM,EAAE;oBACN;wBACE,WAAW,EAAE,QAAQ,CAAC,WAAW;wBACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,GAAG,CAAC,SAAS,IAAI,EAAE,cAAc,EAAE,MAAA,QAAQ,CAAC,cAAc,mCAAI,EAAE,EAAE,CAAC;wBACnE,SAAS,EAAE,QAAQ,CAAC,SAAS;wBAC7B,eAAe,EAAE,QAAQ,CAAC,eAAe;qBAC1C;iBACF;aACF,CAAA;QACH,KAAK,uBAAuB;YAC1B,OAAO;gBACL,MAAM;gBACN,MAAM,EAAE;oBACN;wBACE,OAAO,EAAE,QAAQ,CAAC,OAAO;wBACzB,UAAU,EAAE,QAAQ,CAAC,UAAU;wBAC/B,SAAS,EAAE,QAAQ,CAAC,SAAS;wBAC7B,eAAe,EAAE,QAAQ,CAAC,eAAe;wBACzC,GAAG,CAAC,SAAS,IAAI,EAAE,cAAc,EAAE,MAAA,QAAQ,CAAC,cAAc,mCAAI,CAAC,EAAE,CAAC;wBAClE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;qBAC5B;iBACF;aACF,CAAA;QACH,KAAK,QAAQ;YACX,iGAAiG;YACjG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,KAAK,IAAI,CAAC,EAAE,CAAA;QAChG,KAAK,YAAY;YACf,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAA;QACpE,KAAK,MAAM;YACT,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAA;QACrF,KAAK,UAAU;YACb,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAA;QACpE,KAAK,cAAc;YACjB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAA;QACnF;YACE,MAAM,IAAI,KAAK,CAAC,wBAAyB,QAA+B,CAAC,MAAM,EAAE,CAAC,CAAA;KACrF;AACH,CAAC"}

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

@@ -0,0 +1,2 @@
+import { Currency } from '@kittycorn-labs/sdk-core';
+export declare function getCurrencyAddress(currency: Currency): string;

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

@@ -0,0 +1,5 @@
+import { ETH_ADDRESS } from './constants.js';
+export function getCurrencyAddress(currency) {
+    return currency.isNative ? ETH_ADDRESS : currency.wrapped.address;
+}
+//# sourceMappingURL=getCurrencyAddress.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrencyAddress.js","sourceRoot":"","sources":["../../../../src/utils/getCurrencyAddress.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEzC,MAAM,UAAU,kBAAkB,CAAC,QAAkB;IACnD,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAA;AACnE,CAAC"}

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

@@ -0,0 +1,23 @@
+import { BigintIsh } from '@kittycorn-labs/sdk-core';
+import { NFTPermitOptions } from '@kittycorn-labs/v3-sdk';
+import { PermitSingle } from '@uniswap/permit2-sdk';
+import { RoutePlanner } from './routerCommands';
+export interface Permit2Permit extends PermitSingle {
+    signature: string;
+}
+export type ApproveProtocol = {
+    token: string;
+    protocol: string;
+};
+export type Permit2TransferFrom = {
+    token: string;
+    amount: string;
+    recipient?: string;
+};
+export type InputTokenOptions = {
+    permit2Permit?: Permit2Permit;
+    permit2TransferFrom?: Permit2TransferFrom;
+};
+export declare function encodePermit(planner: RoutePlanner, permit2: Permit2Permit): void;
+export declare function encodeV3PositionPermit(planner: RoutePlanner, permit: NFTPermitOptions, tokenId: BigintIsh): void;
+export declare function encodeInputTokenOptions(planner: RoutePlanner, options: InputTokenOptions): void;

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

@@ -0,0 +1,51 @@
+import invariant from 'tiny-invariant';
+import { arrayify, joinSignature, splitSignature } from '@ethersproject/bytes';
+import { validateAndParseAddress } from '@kittycorn-labs/sdk-core';
+import { NonfungiblePositionManager } from '@kittycorn-labs/v3-sdk';
+import { CommandType } from './routerCommands.js';
+import { ROUTER_AS_RECIPIENT } from './constants.js';
+const SIGNATURE_LENGTH = 65;
+const EIP_2098_SIGNATURE_LENGTH = 64;
+export function encodePermit(planner, permit2) {
+    let signature = permit2.signature;
+    const length = arrayify(permit2.signature).length;
+    // signature data provided for EIP-1271 may have length different from ECDSA signature
+    if (length === SIGNATURE_LENGTH || length === EIP_2098_SIGNATURE_LENGTH) {
+        // sanitizes signature to cover edge cases of malformed EIP-2098 sigs and v used as recovery id
+        signature = joinSignature(splitSignature(permit2.signature));
+    }
+    planner.addCommand(CommandType.PERMIT2_PERMIT, [permit2, signature]);
+}
+export function encodeV3PositionPermit(planner, permit, tokenId) {
+    const calldata = NonfungiblePositionManager.INTERFACE.encodeFunctionData('permit', [
+        validateAndParseAddress(permit.spender),
+        tokenId,
+        permit.deadline,
+        permit.v,
+        permit.r,
+        permit.s,
+    ]);
+    planner.addCommand(CommandType.V3_POSITION_MANAGER_PERMIT, [calldata]);
+}
+// Handles the encoding of commands needed to gather input tokens for a trade
+// Approval: The router approving another address to take tokens.
+//   note: Only seaport and sudoswap support this action. Approvals are left open.
+// Permit: A Permit2 signature-based Permit to allow the router to access a user's tokens
+// Transfer: A Permit2 TransferFrom of tokens from a user to either the router or another address
+export function encodeInputTokenOptions(planner, options) {
+    // first ensure that all tokens provided for encoding are the same
+    if (!!options.permit2TransferFrom && !!options.permit2Permit)
+        invariant(options.permit2TransferFrom.token === options.permit2Permit.details.token, `inconsistent token`);
+    // if this order has a options.permit2Permit, encode it
+    if (!!options.permit2Permit) {
+        encodePermit(planner, options.permit2Permit);
+    }
+    if (!!options.permit2TransferFrom) {
+        planner.addCommand(CommandType.PERMIT2_TRANSFER_FROM, [
+            options.permit2TransferFrom.token,
+            options.permit2TransferFrom.recipient ? options.permit2TransferFrom.recipient : ROUTER_AS_RECIPIENT,
+            options.permit2TransferFrom.amount,
+        ]);
+    }
+}
+//# sourceMappingURL=inputTokens.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"inputTokens.js","sourceRoot":"","sources":["../../../../src/utils/inputTokens.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC9E,OAAO,EAAE,uBAAuB,EAAa,MAAM,0BAA0B,CAAA;AAC7E,OAAO,EAAoB,0BAA0B,EAAE,MAAM,wBAAwB,CAAA;AAErF,OAAO,EAAE,WAAW,EAAgB,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAsBjD,MAAM,gBAAgB,GAAG,EAAE,CAAA;AAC3B,MAAM,yBAAyB,GAAG,EAAE,CAAA;AAEpC,MAAM,UAAU,YAAY,CAAC,OAAqB,EAAE,OAAsB;IACxE,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;IAEjC,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAA;IACjD,sFAAsF;IACtF,IAAI,MAAM,KAAK,gBAAgB,IAAI,MAAM,KAAK,yBAAyB,EAAE;QACvE,+FAA+F;QAC/F,SAAS,GAAG,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;KAC7D;IAED,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;AACtE,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,OAAqB,EAAE,MAAwB,EAAE,OAAkB;IACxG,MAAM,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAAC,kBAAkB,CAAC,QAAQ,EAAE;QACjF,uBAAuB,CAAC,MAAM,CAAC,OAAO,CAAC;QACvC,OAAO;QACP,MAAM,CAAC,QAAQ;QACf,MAAM,CAAC,CAAC;QACR,MAAM,CAAC,CAAC;QACR,MAAM,CAAC,CAAC;KACT,CAAC,CAAA;IAEF,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,0BAA0B,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;AACxE,CAAC;AAED,6EAA6E;AAC7E,iEAAiE;AACjE,kFAAkF;AAClF,yFAAyF;AACzF,iGAAiG;AACjG,MAAM,UAAU,uBAAuB,CAAC,OAAqB,EAAE,OAA0B;IACvF,kEAAkE;IAClE,IAAI,CAAC,CAAC,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAC,OAAO,CAAC,aAAa;QAC1D,SAAS,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,KAAK,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAA;IAE5G,uDAAuD;IACvD,IAAI,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE;QAC3B,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;KAC7C;IAED,IAAI,CAAC,CAAC,OAAO,CAAC,mBAAmB,EAAE;QACjC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,qBAAqB,EAAE;YACpD,OAAO,CAAC,mBAAmB,CAAC,KAAK;YACjC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB;YACnG,OAAO,CAAC,mBAAmB,CAAC,MAAM;SACnC,CAAC,CAAA;KACH;AACH,CAAC"}

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

@@ -0,0 +1,6 @@
+import { Fee, FlatFee, NormalizedSwapSpecification, PortionFee, SwapSpecification } from '../types/encodeSwaps';
+export declare function normalizeEncodeSwapsSpec(spec: SwapSpecification): NormalizedSwapSpecification;
+/** A lone `Fee` becomes a one-element list, so every read site handles multiple recipients by construction. */
+export declare function toFeeList(fee: SwapSpecification['fee']): Fee[];
+export declare function toPortionFeeList(fee: SwapSpecification['fee']): PortionFee[];
+export declare function toFlatFeeList(fee: SwapSpecification['fee']): FlatFee[];

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

@@ -0,0 +1,27 @@
+import { TokenTransferMode } from '../entities/actions/uniswap.js';
+import { DEFAULT_UR_VERSION, SENDER_AS_RECIPIENT } from './constants.js';
+// Fills the five optional fields that `validateEncodeSwaps` and `computeEncodeSwapsAmounts` require.
+export function normalizeEncodeSwapsSpec(spec) {
+    var _a, _b, _c, _d, _e;
+    return {
+        ...spec,
+        recipient: (_a = spec.recipient) !== null && _a !== void 0 ? _a : SENDER_AS_RECIPIENT,
+        tokenTransferMode: (_b = spec.tokenTransferMode) !== null && _b !== void 0 ? _b : TokenTransferMode.Permit2,
+        urVersion: (_c = spec.urVersion) !== null && _c !== void 0 ? _c : DEFAULT_UR_VERSION,
+        safeMode: (_d = spec.safeMode) !== null && _d !== void 0 ? _d : false,
+        allowDirectTransfers: (_e = spec.allowDirectTransfers) !== null && _e !== void 0 ? _e : false,
+    };
+}
+/** A lone `Fee` becomes a one-element list, so every read site handles multiple recipients by construction. */
+export function toFeeList(fee) {
+    if (!fee)
+        return [];
+    return Array.isArray(fee) ? fee : [fee];
+}
+export function toPortionFeeList(fee) {
+    return toFeeList(fee).filter((entry) => entry.kind === 'portion');
+}
+export function toFlatFeeList(fee) {
+    return toFeeList(fee).filter((entry) => entry.kind === 'flat');
+}
+//# sourceMappingURL=normalizeEncodeSwapsSpec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"normalizeEncodeSwapsSpec.js","sourceRoot":"","sources":["../../../../src/utils/normalizeEncodeSwapsSpec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAErE,qGAAqG;AACrG,MAAM,UAAU,wBAAwB,CAAC,IAAuB;;IAC9D,OAAO;QACL,GAAG,IAAI;QACP,SAAS,EAAE,MAAA,IAAI,CAAC,SAAS,mCAAI,mBAAmB;QAChD,iBAAiB,EAAE,MAAA,IAAI,CAAC,iBAAiB,mCAAI,iBAAiB,CAAC,OAAO;QACtE,SAAS,EAAE,MAAA,IAAI,CAAC,SAAS,mCAAI,kBAAkB;QAC/C,QAAQ,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,KAAK;QAChC,oBAAoB,EAAE,MAAA,IAAI,CAAC,oBAAoB,mCAAI,KAAK;KACzD,CAAA;AACH,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,SAAS,CAAC,GAA6B;IACrD,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAA;IACnB,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACzC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,GAA6B;IAC5D,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAuB,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;AACxF,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAA6B;IACzD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAoB,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAA;AAClF,CAAC"}

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

@@ -0,0 +1,7 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import JSBI from 'jsbi';
+import { Percent } from '@kittycorn-labs/sdk-core';
+export declare function expandTo18DecimalsBN(n: number): BigNumber;
+export declare function expandTo18Decimals(n: number): JSBI;
+export declare function encodeFeeBips(fee: Percent): string;
+export declare function encodeFee1e18(fee: Percent): string;

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

@@ -0,0 +1,19 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import JSBI from 'jsbi';
+import bn from 'bignumber.js';
+import { toHex } from '@kittycorn-labs/v3-sdk';
+export function expandTo18DecimalsBN(n) {
+    // use bn intermediately to allow decimals in intermediate calculations
+    return BigNumber.from(new bn(n).times(new bn(10).pow(18)).toFixed());
+}
+export function expandTo18Decimals(n) {
+    return JSBI.BigInt(BigNumber.from(n).mul(BigNumber.from(10).pow(18)).toString());
+}
+export function encodeFeeBips(fee) {
+    return toHex(fee.multiply(10000).quotient);
+}
+const FULL_PORTION_PRECISION = JSBI.exponentiate(JSBI.BigInt(10), JSBI.BigInt(18));
+export function encodeFee1e18(fee) {
+    return toHex(fee.multiply(FULL_PORTION_PRECISION).quotient);
+}
+//# sourceMappingURL=numbers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../../src/utils/numbers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,MAAM,cAAc,CAAA;AAE7B,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAE9C,MAAM,UAAU,oBAAoB,CAAC,CAAS;IAC5C,uEAAuE;IACvE,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;AACtE,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,CAAS;IAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;AAClF,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,QAAQ,CAAC,CAAA;AAC7C,CAAC;AAED,MAAM,sBAAsB,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;AAElF,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,QAAQ,CAAC,CAAA;AAC7D,CAAC"}

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

@@ -0,0 +1,3 @@
+import { Currency } from '@kittycorn-labs/sdk-core';
+import { TPool } from '@kittycorn-labs/router-sdk';
+export declare function getPathCurrency(currency: Currency, pool: TPool): Currency;

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

@@ -0,0 +1,23 @@
+import { Pool as V4Pool } from '@kittycorn-labs/v4-sdk';
+export function getPathCurrency(currency, pool) {
+    // return currency if the currency matches a currency of the pool
+    if (pool.involvesToken(currency)) {
+        return currency;
+        // return if currency.wrapped if pool involves wrapped currency
+    }
+    else if (pool.involvesToken(currency.wrapped)) {
+        return currency.wrapped;
+        // return native currency if pool involves native version of wrapped currency (only applies to V4)
+    }
+    else if (pool instanceof V4Pool && pool.token0.wrapped.equals(currency)) {
+        return pool.token0;
+    }
+    else if (pool instanceof V4Pool && pool.token1.wrapped.equals(currency)) {
+        return pool.token1;
+    }
+    else {
+        throw new Error(`Expected currency ${currency.symbol} to be either ${pool.token0.symbol} or ${pool.token1.symbol}`);
+    }
+    return currency; // this line needed for typescript to compile
+}
+//# sourceMappingURL=pathCurrency.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pathCurrency.js","sourceRoot":"","sources":["../../../../src/utils/pathCurrency.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,wBAAwB,CAAA;AAGvD,MAAM,UAAU,eAAe,CAAC,QAAkB,EAAE,IAAW;IAC7D,iEAAiE;IACjE,IAAI,IAAI,CAAC,aAAa,CAAC,QAAiB,CAAC,EAAE;QACzC,OAAO,QAAQ,CAAA;QAEf,+DAA+D;KAChE;SAAM,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAgB,CAAC,EAAE;QACxD,OAAO,QAAQ,CAAC,OAAO,CAAA;QAEvB,kGAAkG;KACnG;SAAM,IAAI,IAAI,YAAY,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;QACzE,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;SAAM,IAAI,IAAI,YAAY,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;QACzE,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,CAAC,MAAM,iBAAiB,IAAI,CAAC,MAAM,CAAC,MAAM,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;KACpH;IAED,OAAO,QAAQ,CAAA,CAAC,6CAA6C;AAC/D,CAAC"}

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

@@ -0,0 +1,14 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { Percent } from '@kittycorn-labs/sdk-core';
+import { FeeOptions } from '@kittycorn-labs/v3-sdk';
+export interface ScaledPortionFee {
+    recipient: string;
+    /** The caller-supplied fee, read as a fraction of the gross swap output. */
+    grossFee: Percent;
+    /** Rescaled against the balance remaining when its PAY_PORTION executes, so the recipient still gets `grossFee` of gross. */
+    scaledFee: Percent;
+}
+/** Gross fractions to remaining-balance fractions: scaled_i = f_i / (1 - sum(f_0..f_{i-1})), in exact Fraction arithmetic; throws at or past 100%, since a 100% total encodes a swap that pays the swapper nothing. */
+export declare function scalePortionFees(fees: FeeOptions[]): ScaledPortionFee[];
+/** Replays the cascade with the ENCODED portions, which is exact where sum(floor(gross * f_i)) is off by dust either way; reduces to the legacy quantized deduction for a single fee, never exceeds grossAmount, and holds for larger fills. */
+export declare function simulatePortionFeeDeduction(grossAmount: BigNumber, scaledFees: ScaledPortionFee[], useFullPrecision: boolean): BigNumber;

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

@@ -0,0 +1,35 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { Fraction, Percent } from '@kittycorn-labs/sdk-core';
+import { encodeFee1e18, encodeFeeBips } from './numbers.js';
+const ONE = new Fraction(1);
+/** Gross fractions to remaining-balance fractions: scaled_i = f_i / (1 - sum(f_0..f_{i-1})), in exact Fraction arithmetic; throws at or past 100%, since a 100% total encodes a swap that pays the swapper nothing. */
+export function scalePortionFees(fees) {
+    let remaining = ONE;
+    return fees.map(({ fee, recipient }) => {
+        if (fee.lessThan(0))
+            throw new Error('Portion fees cannot be negative');
+        // Strictly less: remaining stays positive, so the swapper's sweep is always non-empty.
+        if (!fee.lessThan(remaining))
+            throw new Error('Portion fees together exceed 100% of the swap output');
+        const scaled = fee.divide(remaining);
+        remaining = remaining.subtract(fee);
+        return {
+            recipient,
+            grossFee: new Percent(fee.numerator, fee.denominator),
+            scaledFee: new Percent(scaled.numerator, scaled.denominator),
+        };
+    });
+}
+const FEE_1E18_DENOMINATOR = BigNumber.from(10).pow(18);
+const FEE_BIPS_DENOMINATOR = BigNumber.from(10000);
+/** Replays the cascade with the ENCODED portions, which is exact where sum(floor(gross * f_i)) is off by dust either way; reduces to the legacy quantized deduction for a single fee, never exceeds grossAmount, and holds for larger fills. */
+export function simulatePortionFeeDeduction(grossAmount, scaledFees, useFullPrecision) {
+    let remainingBalance = grossAmount;
+    for (const { scaledFee } of scaledFees) {
+        const encodedPortion = BigNumber.from(useFullPrecision ? encodeFee1e18(scaledFee) : encodeFeeBips(scaledFee));
+        const portionDenominator = useFullPrecision ? FEE_1E18_DENOMINATOR : FEE_BIPS_DENOMINATOR;
+        remainingBalance = remainingBalance.sub(remainingBalance.mul(encodedPortion).div(portionDenominator));
+    }
+    return grossAmount.sub(remainingBalance);
+}
+//# sourceMappingURL=portionFees.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"portionFees.js","sourceRoot":"","sources":["../../../../src/utils/portionFees.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAE5D,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAUxD,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAA;AAE3B,uNAAuN;AACvN,MAAM,UAAU,gBAAgB,CAAC,IAAkB;IACjD,IAAI,SAAS,GAAa,GAAG,CAAA;IAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACvE,uFAAuF;QACvF,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACrG,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACpC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QACnC,OAAO;YACL,SAAS;YACT,QAAQ,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,WAAW,CAAC;YACrD,SAAS,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC;SAC7D,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,oBAAoB,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;AACvD,MAAM,oBAAoB,GAAG,SAAS,CAAC,IAAI,CAAC,KAAM,CAAC,CAAA;AAEnD,gPAAgP;AAChP,MAAM,UAAU,2BAA2B,CACzC,WAAsB,EACtB,UAA8B,EAC9B,gBAAyB;IAEzB,IAAI,gBAAgB,GAAG,WAAW,CAAA;IAClC,KAAK,MAAM,EAAE,SAAS,EAAE,IAAI,UAAU,EAAE;QACtC,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAA;QAC7G,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAA;QACzF,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAA;KACtG;IACD,OAAO,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;AAC1C,CAAC"}

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

@@ -0,0 +1,31 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { SwapStep, V4Action } from '../types/encodeSwaps';
+export declare function stepSpendsToken(step: SwapStep, inputTokenAddress: string): boolean;
+export declare function isInputSettle(action: V4Action, tokenAddress: string): boolean;
+export declare function isInputSwap(action: V4Action, tokenAddress: string): boolean;
+export declare function v4SwapAmountIn(action: V4Action): BigNumber;
+export declare function stepSpendAmount(step: SwapStep, tokenAddress: string): BigNumber;
+/**
+ * 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 declare function applyRouterBalanceInputToSteps(swapSteps: SwapStep[], inputTokenAddress: string, wrappedNativeAddress?: string): SwapStep[];
+/**
+ * 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 declare function applyNativeRouterBalanceInputToSteps(swapSteps: SwapStep[], wrappedTokenAddress: string): SwapStep[];