@uniswap/router-sdk 1.21.4 → 1.22.0

package/dist/entities/route.d.ts

@@ -4,6 +4,7 @@ import { Route as V4RouteSDK, Pool as V4Pool } from '@uniswap/v4-sdk';
 import { Protocol } from './protocol';
 import { Currency, Price, Token } from '@uniswap/sdk-core';
 import { MixedRouteSDK } from './mixedRoute/route';
+export declare function getPathToken(currency: Currency, pool: Pair | V3Pool): Token;
 export interface IRoute<TInput extends Currency, TOutput extends Currency, TPool extends Pair | V3Pool | V4Pool> {
     protocol: Protocol;
     pools: TPool[];
@@ -11,15 +12,21 @@ export interface IRoute<TInput extends Currency, TOutput extends Currency, TPool
     midPrice: Price<TInput, TOutput>;
     input: TInput;
     output: TOutput;
+    pathInput: Currency;
+    pathOutput: Currency;
 }
 export declare class RouteV2<TInput extends Currency, TOutput extends Currency> extends V2RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, Pair> {
     readonly protocol: Protocol;
     readonly pools: Pair[];
+    pathInput: Currency;
+    pathOutput: Currency;
     constructor(v2Route: V2RouteSDK<TInput, TOutput>);
 }
 export declare class RouteV3<TInput extends Currency, TOutput extends Currency> extends V3RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, V3Pool> {
     readonly protocol: Protocol;
     readonly path: Token[];
+    pathInput: Currency;
+    pathOutput: Currency;
     constructor(v3Route: V3RouteSDK<TInput, TOutput>);
 }
 export declare class RouteV4<TInput extends Currency, TOutput extends Currency> extends V4RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, V4Pool> {

package/dist/entities/trade.d.ts

@@ -43,6 +43,24 @@ export declare class Trade<TInput extends Currency, TOutput extends Currency, TT
     });
     get inputAmount(): CurrencyAmount<TInput>;
     get outputAmount(): CurrencyAmount<TOutput>;
+    /**
+     * Returns the sum of all swaps within the trade
+     * @returns
+     * inputAmount: total input amount
+     * inputAmountNative: total amount of native currency required for ETH input paths
+     *  - 0 if inputAmount is native but no native input paths
+     *  - undefined if inputAmount is not native
+     * outputAmount: total output amount
+     * outputAmountNative: total amount of native currency returned from ETH output paths
+     *  - 0 if outputAmount is native but no native output paths
+     *  - undefined if outputAmount is not native
+     */
+    get amounts(): {
+        inputAmount: CurrencyAmount<TInput>;
+        inputAmountNative: CurrencyAmount<TInput> | undefined;
+        outputAmount: CurrencyAmount<TOutput>;
+        outputAmountNative: CurrencyAmount<TOutput> | undefined;
+    };
     private _executionPrice;
     /**
      * The price expressed in terms of output amount/input amount.

package/dist/router-sdk.cjs.development.js

@@ -1285,6 +1285,17 @@ var MixedRouteTrade = /*#__PURE__*/function () {
   Protocol["MIXED"] = "MIXED";
 })(exports.Protocol || (exports.Protocol = {}));
 
+// Helper function to get the pathInput and pathOutput for a V2 / V3 route
+// currency could be native so we check against the wrapped version as they don't support native ETH in path
+function getPathToken(currency, pool) {
+  if (pool.token0.wrapped.equals(currency.wrapped)) {
+    return pool.token0;
+  } else if (pool.token1.wrapped.equals(currency.wrapped)) {
+    return pool.token1;
+  } else {
+    throw new Error("Expected token " + currency.symbol + " to be either " + pool.token0.symbol + " or " + pool.token1.symbol);
+  }
+}
 // V2 route wrapper
 var RouteV2 = /*#__PURE__*/function (_V2RouteSDK) {
   _inheritsLoose(RouteV2, _V2RouteSDK);
@@ -1293,6 +1304,8 @@ var RouteV2 = /*#__PURE__*/function (_V2RouteSDK) {
     _this = _V2RouteSDK.call(this, v2Route.pairs, v2Route.input, v2Route.output) || this;
     _this.protocol = exports.Protocol.V2;
     _this.pools = _this.pairs;
+    _this.pathInput = getPathToken(v2Route.input, _this.pairs[0]);
+    _this.pathOutput = getPathToken(v2Route.output, _this.pairs[_this.pairs.length - 1]);
     return _this;
   }
   return RouteV2;
@@ -1305,6 +1318,8 @@ var RouteV3 = /*#__PURE__*/function (_V3RouteSDK) {
     _this2 = _V3RouteSDK.call(this, v3Route.pools, v3Route.input, v3Route.output) || this;
     _this2.protocol = exports.Protocol.V3;
     _this2.path = v3Route.tokenPath;
+    _this2.pathInput = getPathToken(v3Route.input, _this2.pools[0]);
+    _this2.pathOutput = getPathToken(v3Route.output, _this2.pools[_this2.pools.length - 1]);
     return _this2;
   }
   return RouteV3;
@@ -1696,13 +1711,13 @@ var Trade = /*#__PURE__*/function () {
       if (this._inputAmount) {
         return this._inputAmount;
       }
-      var inputCurrency = this.swaps[0].inputAmount.currency;
+      var inputAmountCurrency = this.swaps[0].inputAmount.currency;
       var totalInputFromRoutes = this.swaps.map(function (_ref5) {
-        var inputAmount = _ref5.inputAmount;
-        return inputAmount;
+        var routeInputAmount = _ref5.inputAmount;
+        return routeInputAmount;
       }).reduce(function (total, cur) {
         return total.add(cur);
-      }, sdkCore.CurrencyAmount.fromRawAmount(inputCurrency, 0));
+      }, sdkCore.CurrencyAmount.fromRawAmount(inputAmountCurrency, 0));
       this._inputAmount = totalInputFromRoutes;
       return this._inputAmount;
     }
@@ -1714,14 +1729,50 @@ var Trade = /*#__PURE__*/function () {
       }
       var outputCurrency = this.swaps[0].outputAmount.currency;
       var totalOutputFromRoutes = this.swaps.map(function (_ref6) {
-        var outputAmount = _ref6.outputAmount;
-        return outputAmount;
+        var routeOutputAmount = _ref6.outputAmount;
+        return routeOutputAmount;
       }).reduce(function (total, cur) {
         return total.add(cur);
       }, sdkCore.CurrencyAmount.fromRawAmount(outputCurrency, 0));
       this._outputAmount = totalOutputFromRoutes;
       return this._outputAmount;
     }
+    /**
+     * Returns the sum of all swaps within the trade
+     * @returns
+     * inputAmount: total input amount
+     * inputAmountNative: total amount of native currency required for ETH input paths
+     *  - 0 if inputAmount is native but no native input paths
+     *  - undefined if inputAmount is not native
+     * outputAmount: total output amount
+     * outputAmountNative: total amount of native currency returned from ETH output paths
+     *  - 0 if outputAmount is native but no native output paths
+     *  - undefined if outputAmount is not native
+     */
+  }, {
+    key: "amounts",
+    get: function get() {
+      var _this$swaps$find, _this$swaps$find2;
+      // Find native currencies for reduce below
+      var inputNativeCurrency = (_this$swaps$find = this.swaps.find(function (_ref7) {
+        var inputAmount = _ref7.inputAmount;
+        return inputAmount.currency.isNative;
+      })) == null ? void 0 : _this$swaps$find.inputAmount.currency;
+      var outputNativeCurrency = (_this$swaps$find2 = this.swaps.find(function (_ref8) {
+        var outputAmount = _ref8.outputAmount;
+        return outputAmount.currency.isNative;
+      })) == null ? void 0 : _this$swaps$find2.outputAmount.currency;
+      return {
+        inputAmount: this.inputAmount,
+        inputAmountNative: inputNativeCurrency ? this.swaps.reduce(function (total, swap) {
+          return swap.route.pathInput.isNative ? total.add(swap.inputAmount) : total;
+        }, sdkCore.CurrencyAmount.fromRawAmount(inputNativeCurrency, 0)) : undefined,
+        outputAmount: this.outputAmount,
+        outputAmountNative: outputNativeCurrency ? this.swaps.reduce(function (total, swap) {
+          return swap.route.pathOutput.isNative ? total.add(swap.outputAmount) : total;
+        }, sdkCore.CurrencyAmount.fromRawAmount(outputNativeCurrency, 0)) : undefined
+      };
+    }
     /**
      * The price expressed in terms of output amount/input amount.
      */
@@ -2368,6 +2419,7 @@ exports.amountWithPathCurrency = amountWithPathCurrency;
 exports.encodeMixedRouteToPath = encodeMixedRouteToPath;
 exports.getOutputOfPools = getOutputOfPools;
 exports.getPathCurrency = getPathCurrency;
+exports.getPathToken = getPathToken;
 exports.isMint = isMint;
 exports.isValidTokenPath = isValidTokenPath;
 exports.partitionMixedRouteByProtocol = partitionMixedRouteByProtocol;