@uniswap/router-sdk 1.2.0 → 1.3.0

package/dist/swapRouter.d.ts

@@ -5,6 +5,7 @@ import { FeeOptions, MethodParameters, PermitOptions, Position, Trade as V3Trade
 import { ApprovalTypes, CondensedAddLiquidityOptions } from './approveAndCall';
 import { Trade } from './entities/trade';
 import { Validation } from './multicallExtended';
+import { MixedRouteTrade } from './entities/mixedRoute/trade';
 /**
  * Options for producing the arguments to send calls to the router.
  */
@@ -36,7 +37,7 @@ export interface SwapAndAddOptions extends SwapOptions {
      */
     outputTokenPermit?: PermitOptions;
 }
-declare type AnyTradeType = Trade<Currency, Currency, TradeType> | V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType> | (V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType>)[];
+declare type AnyTradeType = Trade<Currency, Currency, TradeType> | V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType> | MixedRouteTrade<Currency, Currency, TradeType> | (V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType> | MixedRouteTrade<Currency, Currency, TradeType>)[];
 /**
  * Represents the Uniswap V2 + V3 SwapRouter02, and has static methods for helping execute trades.
  */
@@ -46,18 +47,44 @@ export declare abstract class SwapRouter {
      * Cannot be constructed.
      */
     private constructor();
+    /**
+     * @notice Generates the calldata for a Swap with a V2 Route.
+     * @param trade The V2Trade to encode.
+     * @param options SwapOptions to use for the trade.
+     * @param routerMustCustody Flag for whether funds should be sent to the router
+     * @param performAggregatedSlippageCheck Flag for whether we want to perform an aggregated slippage check
+     * @returns A string array of calldatas for the trade.
+     */
     private static encodeV2Swap;
+    /**
+     * @notice Generates the calldata for a Swap with a V3 Route.
+     * @param trade The V3Trade to encode.
+     * @param options SwapOptions to use for the trade.
+     * @param routerMustCustody Flag for whether funds should be sent to the router
+     * @param performAggregatedSlippageCheck Flag for whether we want to perform an aggregated slippage check
+     * @returns A string array of calldatas for the trade.
+     */
     private static encodeV3Swap;
+    /**
+     * @notice Generates the calldata for a MixedRouteSwap. Since single hop routes are not MixedRoutes, we will instead generate
+     *         them via the existing encodeV3Swap and encodeV2Swap methods.
+     * @param trade The MixedRouteTrade to encode.
+     * @param options SwapOptions to use for the trade.
+     * @param routerMustCustody Flag for whether funds should be sent to the router
+     * @param performAggregatedSlippageCheck Flag for whether we want to perform an aggregated slippage check
+     * @returns A string array of calldatas for the trade.
+     */
+    private static encodeMixedRouteSwap;
     private static encodeSwaps;
     /**
      * Produces the on-chain method name to call and the hex encoded parameters to pass as arguments for a given trade.
-     * @param trade to produce call parameters for
+     * @param trades to produce call parameters for
      * @param options options for the call parameters
      */
-    static swapCallParameters(trades: Trade<Currency, Currency, TradeType> | V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType> | (V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType>)[], options: SwapOptions): MethodParameters;
+    static swapCallParameters(trades: Trade<Currency, Currency, TradeType> | V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType> | MixedRouteTrade<Currency, Currency, TradeType> | (V2Trade<Currency, Currency, TradeType> | V3Trade<Currency, Currency, TradeType> | MixedRouteTrade<Currency, Currency, TradeType>)[], options: SwapOptions): MethodParameters;
     /**
      * Produces the on-chain method name to call and the hex encoded parameters to pass as arguments for a given trade.
-     * @param trade to produce call parameters for
+     * @param trades to produce call parameters for
      * @param options options for the call parameters
      */
     static swapAndAddCallParameters(trades: AnyTradeType, options: SwapAndAddOptions, position: Position, addLiquidityOptions: CondensedAddLiquidityOptions, tokenInApprovalType: ApprovalTypes, tokenOutApprovalType: ApprovalTypes): MethodParameters;

package/dist/utils/encodeMixedRouteToPath.d.ts

@@ -0,0 +1,9 @@
+import { Currency } from '@uniswap/sdk-core';
+import { MixedRouteSDK } from '../entities/mixedRoute/route';
+/**
+ * Converts a route to a hex encoded path
+ * @notice only supports exactIn route encodings
+ * @param route the mixed path to convert to an encoded path
+ * @returns the exactIn encoded path
+ */
+export declare function encodeMixedRouteToPath(route: MixedRouteSDK<Currency, Currency>): string;

package/dist/utils/index.d.ts

@@ -0,0 +1,17 @@
+import { Currency, Token } from '@uniswap/sdk-core';
+import { Pair } from '@uniswap/v2-sdk';
+import { Pool } from '@uniswap/v3-sdk';
+import { MixedRouteSDK } from '../entities/mixedRoute/route';
+/**
+ * Utility function to return each consecutive section of Pools or Pairs in a MixedRoute
+ * @param route
+ * @returns a nested array of Pools or Pairs in the order of the route
+ */
+export declare const partitionMixedRouteByProtocol: (route: MixedRouteSDK<Currency, Currency>) => (Pool | Pair)[][];
+/**
+ * Simple utility function to get the output of an array of Pools or Pairs
+ * @param pools
+ * @param firstInputToken
+ * @returns the output token of the last pool in the array
+ */
+export declare const getOutputOfPools: (pools: (Pool | Pair)[], firstInputToken: Token) => Token;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniswap/router-sdk",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "An sdk for routing swaps using Uniswap v2 and Uniswap v3.",
   "publishConfig": {
     "access": "public"