@uniswap/universal-router-sdk 5.2.0 → 5.3.0

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

@@ -0,0 +1,149 @@
+import { BigNumberish } from 'ethers';
+import { Currency, CurrencyAmount, Percent, TradeType } from '@uniswap/sdk-core';
+import { type PathKey, type PoolKey } from '@uniswap/v4-sdk';
+import { 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 SwapSpecification = {
+    tradeType: TradeType;
+    routing: {
+        inputToken: Currency;
+        outputToken: Currency;
+        amount: CurrencyAmount<Currency>;
+        quote: CurrencyAmount<Currency>;
+    };
+    slippageTolerance: Percent;
+    recipient?: string;
+    fee?: Fee;
+    tokenTransferMode?: TokenTransferMode;
+    permit?: Permit2Permit;
+    chainId?: number;
+    deadline?: BigNumberish;
+    urVersion?: UniversalRouterVersion;
+    safeMode?: boolean;
+};
+export type NormalizedSwapSpecification = Omit<SwapSpecification, 'recipient' | 'tokenTransferMode' | 'urVersion' | 'safeMode'> & {
+    recipient: string;
+    tokenTransferMode: TokenTransferMode;
+    urVersion: UniversalRouterVersion;
+    safeMode: boolean;
+};
+export type V2SwapExactIn = {
+    type: 'V2_SWAP_EXACT_IN';
+    recipient: string;
+    amountIn: BigNumberish;
+    amountOutMin: BigNumberish;
+    path: string[];
+    minHopPriceX36?: BigNumberish[];
+};
+export type V2SwapExactOut = {
+    type: 'V2_SWAP_EXACT_OUT';
+    recipient: string;
+    amountOut: BigNumberish;
+    amountInMax: BigNumberish;
+    path: string[];
+    minHopPriceX36?: BigNumberish[];
+};
+export type V3SwapExactIn = {
+    type: 'V3_SWAP_EXACT_IN';
+    recipient: string;
+    amountIn: BigNumberish;
+    amountOutMin: BigNumberish;
+    path: string;
+    minHopPriceX36?: BigNumberish[];
+};
+export type V3SwapExactOut = {
+    type: 'V3_SWAP_EXACT_OUT';
+    recipient: string;
+    amountOut: BigNumberish;
+    amountInMax: BigNumberish;
+    path: string;
+    minHopPriceX36?: BigNumberish[];
+};
+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;
+};
+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/types/src/utils/computeEncodeSwapsAmounts.d.ts

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

package/dist/types/src/utils/encodeSwapStep.d.ts

@@ -0,0 +1,4 @@
+import { UniversalRouterVersion } from './constants';
+import { RoutePlanner } from './routerCommands';
+import { SwapStep } from '../types/encodeSwaps';
+export declare function encodeSwapStep(planner: RoutePlanner, step: SwapStep, urVersion?: UniversalRouterVersion): void;

package/dist/types/src/utils/encodeV4Action.d.ts

@@ -0,0 +1,8 @@
+import { Actions, URVersion } from '@uniswap/v4-sdk';
+import { UniversalRouterVersion } from './constants';
+import { V4Action } from '../types/encodeSwaps';
+export declare function toV4URVersion(version?: UniversalRouterVersion): URVersion;
+export declare function encodeV4Action(v4Action: V4Action, urVersion?: UniversalRouterVersion): {
+    action: Actions;
+    params: any[];
+};

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

@@ -0,0 +1,2 @@
+import { NormalizedSwapSpecification, SwapSpecification } from '../types/encodeSwaps';
+export declare function normalizeEncodeSwapsSpec(spec: SwapSpecification): NormalizedSwapSpecification;

package/dist/types/src/utils/validateEncodeSwaps.d.ts

@@ -0,0 +1,2 @@
+import { NormalizedSwapSpecification, SwapStep } from '../types/encodeSwaps';
+export declare function validateEncodeSwaps(spec: NormalizedSwapSpecification, swapSteps: SwapStep[]): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniswap/universal-router-sdk",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "sdk for integrating with the Universal Router contracts",
   "repository": "https://github.com/Uniswap/sdks.git",
   "keywords": [