@uniswap/universal-router-sdk 4.34.2 → 5.0.0

package/dist/{utils → cjs/src/utils}/inputTokens.d.ts

@@ -1,23 +1,23 @@
-import { BigintIsh } from '@uniswap/sdk-core';
-import { NFTPermitOptions } from '@uniswap/v3-sdk';
-import { PermitSingle } from '@uniswap/permit2-sdk';
-import { RoutePlanner } from './routerCommands';
-export interface Permit2Permit extends PermitSingle {
-    signature: string;
-}
-export declare type ApproveProtocol = {
-    token: string;
-    protocol: string;
-};
-export declare type Permit2TransferFrom = {
-    token: string;
-    amount: string;
-    recipient?: string;
-};
-export declare 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;
+import { BigintIsh } from '@uniswap/sdk-core';
+import { NFTPermitOptions } from '@uniswap/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/cjs/src/utils/inputTokens.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeInputTokenOptions = exports.encodeV3PositionPermit = exports.encodePermit = void 0;
+const tslib_1 = require("tslib");
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const ethers_1 = require("ethers");
+const sdk_core_1 = require("@uniswap/sdk-core");
+const v3_sdk_1 = require("@uniswap/v3-sdk");
+const routerCommands_1 = require("./routerCommands");
+const constants_1 = require("./constants");
+const SIGNATURE_LENGTH = 65;
+const EIP_2098_SIGNATURE_LENGTH = 64;
+function encodePermit(planner, permit2) {
+    let signature = permit2.signature;
+    const length = ethers_1.ethers.utils.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 = ethers_1.ethers.utils.joinSignature(ethers_1.ethers.utils.splitSignature(permit2.signature));
+    }
+    planner.addCommand(routerCommands_1.CommandType.PERMIT2_PERMIT, [permit2, signature]);
+}
+exports.encodePermit = encodePermit;
+function encodeV3PositionPermit(planner, permit, tokenId) {
+    const calldata = v3_sdk_1.NonfungiblePositionManager.INTERFACE.encodeFunctionData('permit', [
+        (0, sdk_core_1.validateAndParseAddress)(permit.spender),
+        tokenId,
+        permit.deadline,
+        permit.v,
+        permit.r,
+        permit.s,
+    ]);
+    planner.addCommand(routerCommands_1.CommandType.V3_POSITION_MANAGER_PERMIT, [calldata]);
+}
+exports.encodeV3PositionPermit = encodeV3PositionPermit;
+// 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
+function encodeInputTokenOptions(planner, options) {
+    // first ensure that all tokens provided for encoding are the same
+    if (!!options.permit2TransferFrom && !!options.permit2Permit)
+        (0, tiny_invariant_1.default)(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(routerCommands_1.CommandType.PERMIT2_TRANSFER_FROM, [
+            options.permit2TransferFrom.token,
+            options.permit2TransferFrom.recipient ? options.permit2TransferFrom.recipient : constants_1.ROUTER_AS_RECIPIENT,
+            options.permit2TransferFrom.amount,
+        ]);
+    }
+}
+exports.encodeInputTokenOptions = encodeInputTokenOptions;
+//# sourceMappingURL=inputTokens.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"inputTokens.js","sourceRoot":"","sources":["../../../../src/utils/inputTokens.ts"],"names":[],"mappings":";;;;AAAA,4EAAsC;AACtC,mCAA+B;AAC/B,gDAAsE;AACtE,4CAA8E;AAE9E,qDAA4D;AAC5D,2CAAiD;AAsBjD,MAAM,gBAAgB,GAAG,EAAE,CAAA;AAC3B,MAAM,yBAAyB,GAAG,EAAE,CAAA;AAEpC,SAAgB,YAAY,CAAC,OAAqB,EAAE,OAAsB;IACxE,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;IAEjC,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAA;IAC9D,sFAAsF;IACtF,IAAI,MAAM,KAAK,gBAAgB,IAAI,MAAM,KAAK,yBAAyB,EAAE;QACvE,+FAA+F;QAC/F,SAAS,GAAG,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,eAAM,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;KACvF;IAED,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;AACtE,CAAC;AAXD,oCAWC;AAED,SAAgB,sBAAsB,CAAC,OAAqB,EAAE,MAAwB,EAAE,OAAkB;IACxG,MAAM,QAAQ,GAAG,mCAA0B,CAAC,SAAS,CAAC,kBAAkB,CAAC,QAAQ,EAAE;QACjF,IAAA,kCAAuB,EAAC,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,4BAAW,CAAC,0BAA0B,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;AACxE,CAAC;AAXD,wDAWC;AAED,6EAA6E;AAC7E,iEAAiE;AACjE,kFAAkF;AAClF,yFAAyF;AACzF,iGAAiG;AACjG,SAAgB,uBAAuB,CAAC,OAAqB,EAAE,OAA0B;IACvF,kEAAkE;IAClE,IAAI,CAAC,CAAC,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAC,OAAO,CAAC,aAAa;QAC1D,IAAA,wBAAS,EAAC,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,4BAAW,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,+BAAmB;YACnG,OAAO,CAAC,mBAAmB,CAAC,MAAM;SACnC,CAAC,CAAA;KACH;AACH,CAAC;AAjBD,0DAiBC"}

package/dist/{utils → cjs/src/utils}/numbers.d.ts

@@ -1,6 +1,7 @@
-import { BigNumber } from 'ethers';
-import JSBI from 'jsbi';
-import { Percent } from '@uniswap/sdk-core';
-export declare function expandTo18DecimalsBN(n: number): BigNumber;
-export declare function expandTo18Decimals(n: number): JSBI;
-export declare function encodeFeeBips(fee: Percent): string;
+import { BigNumber } from 'ethers';
+import JSBI from 'jsbi';
+import { Percent } from '@uniswap/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/cjs/src/utils/numbers.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeFee1e18 = exports.encodeFeeBips = exports.expandTo18Decimals = exports.expandTo18DecimalsBN = void 0;
+const tslib_1 = require("tslib");
+const ethers_1 = require("ethers");
+const jsbi_1 = tslib_1.__importDefault(require("jsbi"));
+const bignumber_js_1 = tslib_1.__importDefault(require("bignumber.js"));
+const v3_sdk_1 = require("@uniswap/v3-sdk");
+function expandTo18DecimalsBN(n) {
+    // use bn intermediately to allow decimals in intermediate calculations
+    return ethers_1.BigNumber.from(new bignumber_js_1.default(n).times(new bignumber_js_1.default(10).pow(18)).toFixed());
+}
+exports.expandTo18DecimalsBN = expandTo18DecimalsBN;
+function expandTo18Decimals(n) {
+    return jsbi_1.default.BigInt(ethers_1.BigNumber.from(n).mul(ethers_1.BigNumber.from(10).pow(18)).toString());
+}
+exports.expandTo18Decimals = expandTo18Decimals;
+function encodeFeeBips(fee) {
+    return (0, v3_sdk_1.toHex)(fee.multiply(10000).quotient);
+}
+exports.encodeFeeBips = encodeFeeBips;
+const FULL_PORTION_PRECISION = jsbi_1.default.exponentiate(jsbi_1.default.BigInt(10), jsbi_1.default.BigInt(18));
+function encodeFee1e18(fee) {
+    return (0, v3_sdk_1.toHex)(fee.multiply(FULL_PORTION_PRECISION).quotient);
+}
+exports.encodeFee1e18 = encodeFee1e18;
+//# sourceMappingURL=numbers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../../src/utils/numbers.ts"],"names":[],"mappings":";;;;AAAA,mCAAkC;AAClC,wDAAuB;AACvB,wEAA6B;AAE7B,4CAAuC;AAEvC,SAAgB,oBAAoB,CAAC,CAAS;IAC5C,uEAAuE;IACvE,OAAO,kBAAS,CAAC,IAAI,CAAC,IAAI,sBAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,sBAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;AACtE,CAAC;AAHD,oDAGC;AAED,SAAgB,kBAAkB,CAAC,CAAS;IAC1C,OAAO,cAAI,CAAC,MAAM,CAAC,kBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;AAClF,CAAC;AAFD,gDAEC;AAED,SAAgB,aAAa,CAAC,GAAY;IACxC,OAAO,IAAA,cAAK,EAAC,GAAG,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,QAAQ,CAAC,CAAA;AAC7C,CAAC;AAFD,sCAEC;AAED,MAAM,sBAAsB,GAAG,cAAI,CAAC,YAAY,CAAC,cAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,cAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;AAElF,SAAgB,aAAa,CAAC,GAAY;IACxC,OAAO,IAAA,cAAK,EAAC,GAAG,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,QAAQ,CAAC,CAAA;AAC7D,CAAC;AAFD,sCAEC"}

package/dist/{utils → cjs/src/utils}/pathCurrency.d.ts

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

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

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPathCurrency = void 0;
+const v4_sdk_1 = require("@uniswap/v4-sdk");
+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 v4_sdk_1.Pool && pool.token0.wrapped.equals(currency)) {
+        return pool.token0;
+    }
+    else if (pool instanceof v4_sdk_1.Pool && 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
+}
+exports.getPathCurrency = getPathCurrency;
+//# sourceMappingURL=pathCurrency.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pathCurrency.js","sourceRoot":"","sources":["../../../../src/utils/pathCurrency.ts"],"names":[],"mappings":";;;AACA,4CAAgD;AAGhD,SAAgB,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,aAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;QACzE,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;SAAM,IAAI,IAAI,YAAY,aAAM,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;AAnBD,0CAmBC"}

package/dist/{utils → cjs/src/utils}/routerCommands.d.ts

@@ -1,72 +1,77 @@
-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,
-    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 declare type ParamType = {
-    readonly name: string;
-    readonly type: string;
-    readonly subparser?: Subparser;
-};
-export declare type CommandDefinition = {
-    parser: Parser.Abi;
-    params: ParamType[];
-} | {
-    parser: Parser.V4Actions;
-} | {
-    parser: Parser.V3Actions;
-};
-export declare const COMMAND_DEFINITION: {
-    [key in CommandType]: CommandDefinition;
-};
-export declare class RoutePlanner {
-    commands: string;
-    inputs: string[];
-    constructor();
-    addSubPlan(subplan: RoutePlanner): RoutePlanner;
-    addCommand(type: CommandType, parameters: any[], allowRevert?: boolean): 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 declare type RouterCommand = {
-    type: CommandType;
-    encodedInput: string;
-};
-export declare function createCommand(type: CommandType, parameters: any[]): RouterCommand;
+import { URVersion } from '@uniswap/v4-sdk';
+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?: URVersion): 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?: URVersion): RouterCommand;