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

package/dist/esm/src/types/encodeSwaps.d.ts

@@ -0,0 +1,197 @@
+import { BigNumberish } from '@ethersproject/bignumber';
+import { Currency, CurrencyAmount, Percent, TradeType } from '@kittycorn-labs/sdk-core';
+import { type PathKey, type PoolKey } from '@kittycorn-labs/v4-sdk';
+import { RouterBalanceInput, TokenTransferMode } from '../entities/actions/uniswap';
+import { Permit2Permit } from '../utils/inputTokens';
+import { UniversalRouterVersion } from '../utils/constants';
+export type { PathKey, PoolKey };
+export type Fee = {
+    kind: 'portion';
+    recipient: string;
+    fee: Percent;
+} | {
+    kind: 'flat';
+    recipient: string;
+    amount: BigNumberish;
+};
+export type PortionFee = Extract<Fee, {
+    kind: 'portion';
+}>;
+export type FlatFee = Extract<Fee, {
+    kind: 'flat';
+}>;
+/** A bare `Fee` encodes as it always has; an array pays one recipient per entry (at most MAX_FEE_RECIPIENTS), each a fraction of GROSS output, all the same `kind`, and >1 portion needs urVersion >= 2.1.1. */
+export type FeeSpecification = Fee | Fee[];
+export type SwapSpecification = {
+    tradeType: TradeType;
+    routing: {
+        inputToken: Currency;
+        outputToken: Currency;
+        amount: CurrencyAmount<Currency>;
+        quote: CurrencyAmount<Currency>;
+    };
+    slippageTolerance: Percent;
+    recipient?: string;
+    fee?: FeeSpecification;
+    tokenTransferMode?: TokenTransferMode;
+    permit?: Permit2Permit;
+    chainId?: number;
+    deadline?: BigNumberish;
+    urVersion?: UniversalRouterVersion;
+    safeMode?: boolean;
+    /**
+     * The input Token is the chain's native gas token exposed via an ERC20 predeploy whose balance
+     * mirrors the native balance (e.g. USDC on Arc). The swap is funded by attaching
+     * msg.value = exactOrMaxAmountIn * 10^(18 - token.decimals) instead of pulling via Permit2:
+     * the PERMIT2_TRANSFER_FROM ingress is skipped and no ERC20 approval or permit is ever needed.
+     * Incompatible with native input, permit, and TokenTransferMode.ApproveProxy.
+     */
+    nativeErc20Input?: boolean;
+    /**
+     * Lets steps pull input straight from the user and pay output straight to `recipient`
+     * (instead of router custody), still validated so the user never pays more than
+     * `exactOrMaxAmountIn` or receives less than the minimum output. Default false.
+     * See `SwapRouter.encodeSwaps`.
+     */
+    allowDirectTransfers?: boolean;
+    /**
+     * Omit the zero-floor settlement SWEEP when no step can leave the output token on the router.
+     * Default false. Needs `allowDirectTransfers`. Assumes the router starts with no output balance
+     * and token transfers do not credit it; see the README "Direct Transfers" section.
+     */
+    omitRedundantSettlementSweep?: boolean;
+    /**
+     * Fund the swap from the Universal Router's own balance of the input token: no Permit2
+     * ingress is emitted, the first hop spends the CONTRACT_BALANCE sentinel, and an optional
+     * `minimumAmount` emits a BALANCE_CHECK_ERC20 (requires `chainId` to resolve the router
+     * address). A native input is funded by attaching msg.value to execute() (raw transfers
+     * to the router revert): the plan must lead with a WRAP_ETH, which is resized to wrap the
+     * whole balance, the floor is asserted post-wrap as WETH, ETH dust is always swept to the
+     * recipient, and the encoded value is 0. Same semantics and guards as
+     * `SwapOptions.routerBalanceInput`: explicit `recipient`, EXACT_INPUT, exactly one step
+     * spending the (wrapped) input token (no splits); incompatible with `permit`,
+     * `nativeErc20Input`, `allowDirectTransfers`, and ApproveProxy.
+     */
+    routerBalanceInput?: RouterBalanceInput;
+};
+export type NormalizedSwapSpecification = Omit<SwapSpecification, 'recipient' | 'tokenTransferMode' | 'urVersion' | 'safeMode' | 'allowDirectTransfers'> & {
+    recipient: string;
+    tokenTransferMode: TokenTransferMode;
+    urVersion: UniversalRouterVersion;
+    safeMode: boolean;
+    allowDirectTransfers: boolean;
+};
+export type V2SwapExactIn = {
+    type: 'V2_SWAP_EXACT_IN';
+    recipient: string;
+    amountIn: BigNumberish;
+    amountOutMin: BigNumberish;
+    path: string[];
+    minHopPriceX36?: BigNumberish[];
+    payerIsUser?: boolean;
+};
+export type V2SwapExactOut = {
+    type: 'V2_SWAP_EXACT_OUT';
+    recipient: string;
+    amountOut: BigNumberish;
+    amountInMax: BigNumberish;
+    path: string[];
+    minHopPriceX36?: BigNumberish[];
+    payerIsUser?: boolean;
+};
+export type V3SwapExactIn = {
+    type: 'V3_SWAP_EXACT_IN';
+    recipient: string;
+    amountIn: BigNumberish;
+    amountOutMin: BigNumberish;
+    path: string;
+    minHopPriceX36?: BigNumberish[];
+    payerIsUser?: boolean;
+};
+export type V3SwapExactOut = {
+    type: 'V3_SWAP_EXACT_OUT';
+    recipient: string;
+    amountOut: BigNumberish;
+    amountInMax: BigNumberish;
+    path: string;
+    minHopPriceX36?: BigNumberish[];
+    payerIsUser?: boolean;
+};
+export type V4Swap = {
+    type: 'V4_SWAP';
+    v4Actions: V4Action[];
+};
+export type WrapEth = {
+    type: 'WRAP_ETH';
+    recipient: string;
+    amount: BigNumberish;
+};
+export type UnwrapWeth = {
+    type: 'UNWRAP_WETH';
+    recipient: string;
+    amountMin: BigNumberish;
+};
+export type SwapStep = V2SwapExactIn | V2SwapExactOut | V3SwapExactIn | V3SwapExactOut | V4Swap | WrapEth | UnwrapWeth;
+export type V4SwapExactIn = {
+    action: 'SWAP_EXACT_IN';
+    currencyIn: string;
+    path: PathKey[];
+    amountIn: BigNumberish;
+    amountOutMinimum: BigNumberish;
+    minHopPriceX36?: BigNumberish[];
+};
+export type V4SwapExactInSingle = {
+    action: 'SWAP_EXACT_IN_SINGLE';
+    poolKey: PoolKey;
+    zeroForOne: boolean;
+    amountIn: BigNumberish;
+    amountOutMinimum: BigNumberish;
+    minHopPriceX36?: BigNumberish;
+    hookData: string;
+};
+export type V4SwapExactOut = {
+    action: 'SWAP_EXACT_OUT';
+    currencyOut: string;
+    path: PathKey[];
+    amountOut: BigNumberish;
+    amountInMaximum: BigNumberish;
+    minHopPriceX36?: BigNumberish[];
+};
+export type V4SwapExactOutSingle = {
+    action: 'SWAP_EXACT_OUT_SINGLE';
+    poolKey: PoolKey;
+    zeroForOne: boolean;
+    amountOut: BigNumberish;
+    amountInMaximum: BigNumberish;
+    minHopPriceX36?: BigNumberish;
+    hookData: string;
+};
+export type V4Settle = {
+    action: 'SETTLE';
+    currency: string;
+    amount: BigNumberish;
+    payerIsUser?: boolean;
+};
+export type V4SettleAll = {
+    action: 'SETTLE_ALL';
+    currency: string;
+    maxAmount: BigNumberish;
+};
+export type V4Take = {
+    action: 'TAKE';
+    currency: string;
+    recipient: string;
+    amount: BigNumberish;
+};
+export type V4TakeAll = {
+    action: 'TAKE_ALL';
+    currency: string;
+    minAmount: BigNumberish;
+};
+export type V4TakePortion = {
+    action: 'TAKE_PORTION';
+    currency: string;
+    recipient: string;
+    bips: BigNumberish;
+};
+export type V4Action = V4SwapExactIn | V4SwapExactInSingle | V4SwapExactOut | V4SwapExactOutSingle | V4Settle | V4SettleAll | V4Take | V4TakeAll | V4TakePortion;

package/dist/esm/src/types/encodeSwaps.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=encodeSwaps.js.map

package/dist/esm/src/types/encodeSwaps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodeSwaps.js","sourceRoot":"","sources":["../../../../src/types/encodeSwaps.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,36 @@
+import { Interface } from '@ethersproject/abi';
+import { CommandType, CommandDefinition } from '../utils/routerCommands';
+import { UniversalRouterVersion } from '../utils/constants';
+export type Param = {
+    readonly name: string;
+    readonly value: any;
+};
+export type UniversalRouterCommand = {
+    readonly commandName: string;
+    readonly commandType: CommandType;
+    readonly params: readonly Param[];
+};
+export type UniversalRouterCall = {
+    readonly commands: readonly UniversalRouterCommand[];
+};
+export type V3PathItem = {
+    readonly tokenIn: string;
+    readonly tokenOut: string;
+    readonly fee: number;
+};
+export interface CommandsDefinition {
+    [key: number]: CommandDefinition;
+}
+export declare abstract class CommandParser {
+    static INTERFACE: Interface;
+    static parseCalldata(calldata: string, urVersion?: UniversalRouterVersion): UniversalRouterCall;
+}
+export declare class GenericCommandParser {
+    private readonly commandDefinition;
+    private readonly urVersion;
+    constructor(commandDefinition: CommandsDefinition, urVersion?: UniversalRouterVersion);
+    parse(commands: string, inputs: string[]): UniversalRouterCall;
+    private static getCommands;
+}
+export declare function parseV3PathExactIn(path: string): readonly V3PathItem[];
+export declare function parseV3PathExactOut(path: string): readonly V3PathItem[];

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

@@ -0,0 +1,146 @@
+import { defaultAbiCoder } from '@ethersproject/abi';
+import { getAddress } from '@ethersproject/address';
+import UniversalRouter from '../abis/UniversalRouter.json' with { type: "json" };
+import { Interface } from '@ethersproject/abi';
+import { V4BaseActionsParser } from '@kittycorn-labs/v4-sdk';
+import { CommandType, COMMAND_DEFINITION, V2V3_SWAP_COMMANDS_V2_1_1, Subparser, Parser, } from '../utils/routerCommands.js';
+import { UniversalRouterVersion, isAtLeastV2_1_1 } from '../utils/constants.js';
+// Parses UniversalRouter V2 commands
+export class CommandParser {
+    static parseCalldata(calldata, urVersion = UniversalRouterVersion.V2_0) {
+        // From V2.1.1 onwards the V2/V3 swap commands carry an extra minHopPriceX36 array,
+        // so the matching command definitions must be used to decode them correctly.
+        const commandDefinition = isAtLeastV2_1_1(urVersion)
+            ? { ...COMMAND_DEFINITION, ...V2V3_SWAP_COMMANDS_V2_1_1 }
+            : COMMAND_DEFINITION;
+        const genericParser = new GenericCommandParser(commandDefinition, urVersion);
+        const txDescription = CommandParser.INTERFACE.parseTransaction({ data: calldata });
+        const { commands, inputs } = txDescription.args;
+        return genericParser.parse(commands, inputs);
+    }
+}
+CommandParser.INTERFACE = new Interface(UniversalRouter.abi);
+// Parses commands based on given command definition
+export class GenericCommandParser {
+    constructor(commandDefinition, urVersion = UniversalRouterVersion.V2_0) {
+        this.commandDefinition = commandDefinition;
+        this.urVersion = urVersion;
+    }
+    parse(commands, inputs) {
+        const commandTypes = GenericCommandParser.getCommands(commands);
+        return {
+            commands: commandTypes.map((commandType, i) => {
+                const commandDef = this.commandDefinition[commandType];
+                if (commandDef.parser === Parser.V4Actions) {
+                    // UniversalRouterVersion and URVersion share identical string values; cast across the SDK boundary
+                    const { actions } = V4BaseActionsParser.parseCalldata(inputs[i], this.urVersion);
+                    return {
+                        commandName: CommandType[commandType],
+                        commandType,
+                        params: v4RouterCallToParams(actions),
+                    };
+                }
+                else if (commandDef.parser === Parser.Abi) {
+                    const abiDef = commandDef.params;
+                    const rawParams = defaultAbiCoder.decode(abiDef.map((command) => command.type), inputs[i]);
+                    const params = rawParams.map((param, j) => {
+                        switch (abiDef[j].subparser) {
+                            case Subparser.V3PathExactIn:
+                                return {
+                                    name: abiDef[j].name,
+                                    value: parseV3PathExactIn(param),
+                                };
+                            case Subparser.V3PathExactOut:
+                                return {
+                                    name: abiDef[j].name,
+                                    value: parseV3PathExactOut(param),
+                                };
+                            default:
+                                return {
+                                    name: abiDef[j].name,
+                                    value: param,
+                                };
+                        }
+                    });
+                    return {
+                        commandName: CommandType[commandType],
+                        commandType,
+                        params,
+                    };
+                }
+                else if (commandDef.parser === Parser.V3Actions) {
+                    // TODO: implement better parsing here
+                    return {
+                        commandName: CommandType[commandType],
+                        commandType,
+                        params: inputs.map((input) => ({ name: 'command', value: input })),
+                    };
+                }
+                else {
+                    throw new Error(`Unsupported parser: ${commandDef}`);
+                }
+            }),
+        };
+    }
+    // parse command types from bytes string
+    static getCommands(commands) {
+        const commandTypes = [];
+        for (let i = 2; i < commands.length; i += 2) {
+            const byte = commands.substring(i, i + 2);
+            commandTypes.push(parseInt(byte, 16));
+        }
+        return commandTypes;
+    }
+}
+export function parseV3PathExactIn(path) {
+    const strippedPath = path.replace('0x', '');
+    let tokenIn = getAddress(strippedPath.substring(0, 40));
+    let loc = 40;
+    const res = [];
+    while (loc < strippedPath.length) {
+        const feeAndTokenOut = strippedPath.substring(loc, loc + 46);
+        const fee = parseInt(feeAndTokenOut.substring(0, 6), 16);
+        const tokenOut = getAddress(feeAndTokenOut.substring(6, 46));
+        res.push({
+            tokenIn,
+            tokenOut,
+            fee,
+        });
+        tokenIn = tokenOut;
+        loc += 46;
+    }
+    return res;
+}
+export function parseV3PathExactOut(path) {
+    const strippedPath = path.replace('0x', '');
+    let tokenIn = getAddress(strippedPath.substring(strippedPath.length - 40));
+    let loc = strippedPath.length - 86; // 86 = (20 addr + 3 fee + 20 addr) * 2 (for hex characters)
+    const res = [];
+    while (loc >= 0) {
+        const feeAndTokenOut = strippedPath.substring(loc, loc + 46);
+        const tokenOut = getAddress(feeAndTokenOut.substring(0, 40));
+        const fee = parseInt(feeAndTokenOut.substring(40, 46), 16);
+        res.push({
+            tokenIn,
+            tokenOut,
+            fee,
+        });
+        tokenIn = tokenOut;
+        loc -= 46;
+    }
+    return res;
+}
+function v4RouterCallToParams(actions) {
+    return actions.map((action) => {
+        return {
+            name: action.actionName,
+            value: action.params.map((param) => {
+                return {
+                    name: param.name,
+                    value: param.value,
+                };
+            }),
+        };
+    });
+}
+//# sourceMappingURL=commandParser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commandParser.js","sourceRoot":"","sources":["../../../../src/utils/commandParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,eAAe,MAAM,8BAA8B,CAAA;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAa,mBAAmB,EAAkB,MAAM,wBAAwB,CAAA;AACvF,OAAO,EACL,WAAW,EAEX,kBAAkB,EAClB,yBAAyB,EACzB,SAAS,EACT,MAAM,GACP,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AA2B5E,qCAAqC;AACrC,MAAM,OAAgB,aAAa;IAG1B,MAAM,CAAC,aAAa,CACzB,QAAgB,EAChB,YAAoC,sBAAsB,CAAC,IAAI;QAE/D,mFAAmF;QACnF,6EAA6E;QAC7E,MAAM,iBAAiB,GAAG,eAAe,CAAC,SAAS,CAAC;YAClD,CAAC,CAAC,EAAE,GAAG,kBAAkB,EAAE,GAAG,yBAAyB,EAAE;YACzD,CAAC,CAAC,kBAAkB,CAAA;QACtB,MAAM,aAAa,GAAG,IAAI,oBAAoB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAA;QAC5E,MAAM,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAA;QAClF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAA;QAC/C,OAAO,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC9C,CAAC;;AAfa,uBAAS,GAAc,IAAI,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;AAkBzE,oDAAoD;AACpD,MAAM,OAAO,oBAAoB;IAC/B,YACmB,iBAAqC,EACrC,YAAoC,sBAAsB,CAAC,IAAI;QAD/D,sBAAiB,GAAjB,iBAAiB,CAAoB;QACrC,cAAS,GAAT,SAAS,CAAsD;IAC/E,CAAC;IAEG,KAAK,CAAC,QAAgB,EAAE,MAAgB;QAC7C,MAAM,YAAY,GAAG,oBAAoB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QAE/D,OAAO;YACL,QAAQ,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,WAAwB,EAAE,CAAS,EAAE,EAAE;gBACjE,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAA;gBAEtD,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,SAAS,EAAE;oBAC1C,mGAAmG;oBACnG,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAiC,CAAC,CAAA;oBACxG,OAAO;wBACL,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC;wBACrC,WAAW;wBACX,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;qBACtC,CAAA;iBACF;qBAAM,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,GAAG,EAAE;oBAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;oBAChC,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CACtC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EACrC,MAAM,CAAC,CAAC,CAAC,CACV,CAAA;oBAED,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,CAAS,EAAE,EAAE;wBACrD,QAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE;4BAC3B,KAAK,SAAS,CAAC,aAAa;gCAC1B,OAAO;oCACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oCACpB,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;iCACjC,CAAA;4BACH,KAAK,SAAS,CAAC,cAAc;gCAC3B,OAAO;oCACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oCACpB,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC;iCAClC,CAAA;4BACH;gCACE,OAAO;oCACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oCACpB,KAAK,EAAE,KAAK;iCACb,CAAA;yBACJ;oBACH,CAAC,CAAC,CAAA;oBACF,OAAO;wBACL,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC;wBACrC,WAAW;wBACX,MAAM;qBACP,CAAA;iBACF;qBAAM,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,SAAS,EAAE;oBACjD,sCAAsC;oBACtC,OAAO;wBACL,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC;wBACrC,WAAW;wBACX,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;qBACnE,CAAA;iBACF;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAA;iBACrD;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC;IAED,wCAAwC;IAChC,MAAM,CAAC,WAAW,CAAC,QAAgB;QACzC,MAAM,YAAY,GAAkB,EAAE,CAAA;QAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC3C,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;YACzC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAgB,CAAC,CAAA;SACrD;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC3C,IAAI,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IACvD,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,MAAM,GAAG,GAAiB,EAAE,CAAA;IAC5B,OAAO,GAAG,GAAG,YAAY,CAAC,MAAM,EAAE;QAChC,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;QAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACxD,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;QAE5D,GAAG,CAAC,IAAI,CAAC;YACP,OAAO;YACP,QAAQ;YACR,GAAG;SACJ,CAAC,CAAA;QACF,OAAO,GAAG,QAAQ,CAAA;QAClB,GAAG,IAAI,EAAE,CAAA;KACV;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC3C,IAAI,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAA;IAC1E,IAAI,GAAG,GAAG,YAAY,CAAC,MAAM,GAAG,EAAE,CAAA,CAAC,4DAA4D;IAC/F,MAAM,GAAG,GAAiB,EAAE,CAAA;IAC5B,OAAO,GAAG,IAAI,CAAC,EAAE;QACf,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;QAC5D,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;QAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;QAE1D,GAAG,CAAC,IAAI,CAAC;YACP,OAAO;YACP,QAAQ;YACR,GAAG;SACJ,CAAC,CAAA;QACF,OAAO,GAAG,QAAQ,CAAA;QAElB,GAAG,IAAI,EAAE,CAAA;KACV;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAkC;IAC9D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC5B,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,UAAU;YACvB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjC,OAAO;oBACL,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,KAAK,EAAE,KAAK,CAAC,KAAK;iBACnB,CAAA;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

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

@@ -0,0 +1,8 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { NormalizedSwapSpecification } from '../types/encodeSwaps';
+export type EncodeSwapsAmounts = {
+    exactOrMaxAmountIn: BigNumber;
+    grossMinOrExactAmountOut: BigNumber;
+    netMinOrExactAmountOut: BigNumber;
+};
+export declare function computeEncodeSwapsAmounts(spec: NormalizedSwapSpecification): EncodeSwapsAmounts;

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

@@ -0,0 +1,41 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import invariant from 'tiny-invariant';
+import { TradeType } from '@kittycorn-labs/sdk-core';
+import { isAtLeastV2_1_1 } from './constants.js';
+import { toFlatFeeList, toPortionFeeList } from './normalizeEncodeSwapsSpec.js';
+import { scalePortionFees, simulatePortionFeeDeduction } from './portionFees.js';
+// Slippage is applied to the quote: scaled down to a floor for exact-input output,
+// scaled up to a ceiling for exact-output input. The unscaled side is the user's exact value.
+// Portion fees are fractions of the gross output; flat fees pair with exact-output.
+export function computeEncodeSwapsAmounts(spec) {
+    const routingAmount = BigNumber.from(spec.routing.amount.quotient.toString());
+    const routingQuote = BigNumber.from(spec.routing.quote.quotient.toString());
+    const slippageNumerator = BigNumber.from(spec.slippageTolerance.numerator.toString());
+    const slippageDenominator = BigNumber.from(spec.slippageTolerance.denominator.toString());
+    if (spec.tradeType === TradeType.EXACT_INPUT) {
+        const grossMinOrExactAmountOut = routingQuote
+            .mul(slippageDenominator.sub(slippageNumerator))
+            .div(slippageDenominator);
+        // Replays the encoded cascade at the gross minimum, so the sweep floor expects exactly what the commands leave behind.
+        const feeAmount = simulatePortionFeeDeduction(grossMinOrExactAmountOut, scalePortionFees(toPortionFeeList(spec.fee)), isAtLeastV2_1_1(spec.urVersion));
+        return {
+            exactOrMaxAmountIn: routingAmount,
+            grossMinOrExactAmountOut,
+            netMinOrExactAmountOut: grossMinOrExactAmountOut.sub(feeAmount),
+        };
+    }
+    const exactOrMaxAmountIn = routingQuote.mul(slippageDenominator.add(slippageNumerator)).div(slippageDenominator);
+    const grossMinOrExactAmountOut = routingAmount;
+    // Flat fees are absolute TRANSFERs, so the router must hold every one on top of the settled amount.
+    let flatFeeTotal = BigNumber.from(0);
+    for (const flatFee of toFlatFeeList(spec.fee)) {
+        flatFeeTotal = flatFeeTotal.add(BigNumber.from(flatFee.amount));
+    }
+    invariant(flatFeeTotal.lte(grossMinOrExactAmountOut), 'FEE_TOTAL_GT_AMOUNT_OUT');
+    return {
+        exactOrMaxAmountIn,
+        grossMinOrExactAmountOut,
+        netMinOrExactAmountOut: grossMinOrExactAmountOut.sub(flatFeeTotal),
+    };
+}
+//# sourceMappingURL=computeEncodeSwapsAmounts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"computeEncodeSwapsAmounts.js","sourceRoot":"","sources":["../../../../src/utils/computeEncodeSwapsAmounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC5E,OAAO,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAU7E,mFAAmF;AACnF,8FAA8F;AAC9F,oFAAoF;AACpF,MAAM,UAAU,yBAAyB,CAAC,IAAiC;IACzE,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7E,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC3E,MAAM,iBAAiB,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;IACrF,MAAM,mBAAmB,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEzF,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE;QAC5C,MAAM,wBAAwB,GAAG,YAAY;aAC1C,GAAG,CAAC,mBAAmB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;aAC/C,GAAG,CAAC,mBAAmB,CAAC,CAAA;QAE3B,uHAAuH;QACvH,MAAM,SAAS,GAAG,2BAA2B,CAC3C,wBAAwB,EACxB,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAC5C,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAChC,CAAA;QAED,OAAO;YACL,kBAAkB,EAAE,aAAa;YACjC,wBAAwB;YACxB,sBAAsB,EAAE,wBAAwB,CAAC,GAAG,CAAC,SAAS,CAAC;SAChE,CAAA;KACF;IAED,MAAM,kBAAkB,GAAG,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;IAChH,MAAM,wBAAwB,GAAG,aAAa,CAAA;IAE9C,oGAAoG;IACpG,IAAI,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACpC,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC7C,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;KAChE;IACD,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,wBAAwB,CAAC,EAAE,yBAAyB,CAAC,CAAA;IAEhF,OAAO;QACL,kBAAkB;QAClB,wBAAwB;QACxB,sBAAsB,EAAE,wBAAwB,CAAC,GAAG,CAAC,YAAY,CAAC;KACnE,CAAA;AACH,CAAC"}

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

@@ -0,0 +1,46 @@
+import { BigNumber } from '@ethersproject/bignumber';
+export declare enum UniversalRouterVersion {
+    V1_2 = "1.2",
+    V2_0 = "2.0",
+    V2_1_1 = "2.1.1",
+    V2_1_2 = "2.1.2",
+    V2_2_0 = "2.2.0"
+}
+/** Version assumed when a caller does not pass `urVersion`; kept at V2_0 for backward compatibility. */
+export declare const DEFAULT_UR_VERSION = UniversalRouterVersion.V2_0;
+/**
+ * Check if a UniversalRouterVersion is at least V2_1_1.
+ * Duplicated from @kittycorn-labs/v4-sdk's isAtLeastV2_1_1 (which operates on URVersion)
+ * to avoid coupling universal-router-sdk's version logic to v4-sdk.
+ */
+export declare function isAtLeastV2_1_1(version?: UniversalRouterVersion): boolean;
+/** Check if a UniversalRouterVersion is at least V2_0, the first router with the position-manager commands. */
+export declare function isAtLeastV2_0(version?: UniversalRouterVersion): boolean;
+export type RouterConfig = {
+    address: string;
+    creationBlock: number;
+};
+type ChainConfig = {
+    weth: string;
+    nativeErc20BalanceAlias: boolean;
+    routerConfigs: {
+        [key in UniversalRouterVersion]?: RouterConfig;
+    };
+    swapProxy?: string;
+};
+export declare const CHAIN_CONFIGS: {
+    [key: number]: ChainConfig;
+};
+export declare const UNIVERSAL_ROUTER_ADDRESS: (version: UniversalRouterVersion, chainId: number) => string;
+export declare const SWAP_PROXY_ADDRESS: (chainId: number) => string;
+export declare const UNIVERSAL_ROUTER_CREATION_BLOCK: (version: UniversalRouterVersion, chainId: number) => number;
+export declare const WETH_ADDRESS: (chainId: number) => string;
+export declare const CONTRACT_BALANCE: BigNumber;
+export declare const ETH_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const E_ETH_ADDRESS = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
+export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const MAX_UINT256: BigNumber;
+export declare const MAX_UINT160: BigNumber;
+export declare const SENDER_AS_RECIPIENT = "0x0000000000000000000000000000000000000001";
+export declare const ROUTER_AS_RECIPIENT = "0x0000000000000000000000000000000000000002";
+export {};