@uniswap/router-sdk 1.0.0-beta.3 → 1.0.0-beta.7

package/README.md

@@ -0,0 +1,10 @@
+# Alpha software
+
+The latest version of the SDK is used in production in the Uniswap Interface,
+but it is considered Alpha software and may contain bugs or change significantly between patch versions.
+If you have questions about how to use the SDK, please reach out in the `#dev-chat` channel of the Discord.
+Pull requests welcome!
+
+# Uniswap Swap Router SDK
+
+This SDK is meant to facilitate interactions with the contracts in [swap-router-contracts](https://github.com/Uniswap/swap-router-contracts).

package/dist/entities/route.d.ts

@@ -2,11 +2,13 @@ import { Route as V2RouteSDK, Pair } from '@uniswap/v2-sdk';
 import { Route as V3RouteSDK, Pool } from '@uniswap/v3-sdk';
 import { Protocol } from './protocol';
 import { Currency, Price, Token } from '@uniswap/sdk-core';
-export interface IRoute<TInput extends Currency, TOutput extends Currency, TPool extends (Pool | Pair)> {
+export interface IRoute<TInput extends Currency, TOutput extends Currency, TPool extends Pool | Pair> {
     protocol: Protocol;
     pools: TPool[];
     path: Token[];
     midPrice: Price<TInput, TOutput>;
+    input: TInput;
+    output: TOutput;
 }
 export declare class RouteV2<TInput extends Currency, TOutput extends Currency> extends V2RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, Pair> {
     readonly protocol: Protocol;

package/dist/entities/trade.d.ts

@@ -1,9 +1,9 @@
 import { Currency, CurrencyAmount, Percent, Price, TradeType } from '@uniswap/sdk-core';
+import { Pair, Route as V2RouteSDK } from '@uniswap/v2-sdk';
+import { Pool, Route as V3RouteSDK } from '@uniswap/v3-sdk';
 import { IRoute } from './route';
-import { Route as V2RouteSDK, Pair } from '@uniswap/v2-sdk';
-import { Route as V3RouteSDK, Pool } from '@uniswap/v3-sdk';
 export declare class Trade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
-    readonly routes: IRoute<TInput, TOutput, (Pair | Pool)>[];
+    readonly routes: IRoute<TInput, TOutput, Pair | Pool>[];
     readonly tradeType: TTradeType;
     private _outputAmount;
     private _inputAmount;
@@ -12,7 +12,7 @@ export declare class Trade<TInput extends Currency, TOutput extends Currency, TT
      * make up the trade. May consist of swaps in v2 or v3.
      */
     readonly swaps: {
-        route: IRoute<TInput, TOutput, (Pair | Pool)>;
+        route: IRoute<TInput, TOutput, Pair | Pool>;
         inputAmount: CurrencyAmount<TInput>;
         outputAmount: CurrencyAmount<TOutput>;
     }[];

package/dist/paymentsExtended.d.ts

@@ -1,15 +1,15 @@
-import JSBI from 'jsbi';
 import { Interface } from '@ethersproject/abi';
-import { FeeOptions } from '@uniswap/v3-sdk';
 import { Token } from '@uniswap/sdk-core';
+import { FeeOptions } from '@uniswap/v3-sdk';
+import JSBI from 'jsbi';
 export declare abstract class PaymentsExtended {
     static INTERFACE: Interface;
     /**
      * Cannot be constructed.
      */
     private constructor();
-    private static encodeFeeBips;
     static encodeUnwrapWETH9(amountMinimum: JSBI, recipient?: string, feeOptions?: FeeOptions): string;
     static encodeSweepToken(token: Token, amountMinimum: JSBI, recipient?: string, feeOptions?: FeeOptions): string;
     static encodePull(token: Token, amount: JSBI): string;
+    static encodeWrapETH(amount: JSBI): string;
 }

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

@@ -6,13 +6,13 @@ function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'defau
 
 var JSBI = _interopDefault(require('jsbi'));
 var abi = require('@ethersproject/abi');
-var v3Sdk = require('@uniswap/v3-sdk');
 var IMulticallExtended_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IMulticallExtended.sol/IMulticallExtended.json');
-var IPeripheryPaymentsWithFeeExtended_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IPeripheryPaymentsWithFeeExtended.sol/IPeripheryPaymentsWithFeeExtended.json');
+var v3Sdk = require('@uniswap/v3-sdk');
 var sdkCore = require('@uniswap/sdk-core');
-var invariant = _interopDefault(require('tiny-invariant'));
+var IPeripheryPaymentsWithFeeExtended_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IPeripheryPaymentsWithFeeExtended.sol/IPeripheryPaymentsWithFeeExtended.json');
 var ISwapRouter02_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/ISwapRouter02.sol/ISwapRouter02.json');
 var v2Sdk = require('@uniswap/v2-sdk');
+var invariant = _interopDefault(require('tiny-invariant'));
 
 var MSG_SENDER = '0x0000000000000000000000000000000000000000';
 var ADDRESS_THIS = '0x0000000000000000000000000000000000000001';
@@ -45,7 +45,7 @@ var MulticallExtended = /*#__PURE__*/function () {
     } // this means the validation value should be a previousBlockhash
 
 
-    if (typeof validation === 'string') {
+    if (typeof validation === 'string' && validation.startsWith('0x')) {
       var previousBlockhash = validateAndParseBytes32(validation);
       return MulticallExtended.INTERFACE.encodeFunctionData('multicall(bytes32,bytes[])', [previousBlockhash, calldatas]);
     } else {
@@ -58,16 +58,16 @@ var MulticallExtended = /*#__PURE__*/function () {
 }();
 MulticallExtended.INTERFACE = /*#__PURE__*/new abi.Interface(IMulticallExtended_json.abi);
 
+function encodeFeeBips(fee) {
+  return v3Sdk.toHex(fee.multiply(10000).quotient);
+}
+
 var PaymentsExtended = /*#__PURE__*/function () {
   /**
    * Cannot be constructed.
    */
   function PaymentsExtended() {}
 
-  PaymentsExtended.encodeFeeBips = function encodeFeeBips(fee) {
-    return v3Sdk.toHex(fee.multiply(10000).quotient);
-  };
-
   PaymentsExtended.encodeUnwrapWETH9 = function encodeUnwrapWETH9(amountMinimum, recipient, feeOptions) {
     // if there's a recipient, just pass it along
     if (typeof recipient === 'string') {
@@ -75,7 +75,7 @@ var PaymentsExtended = /*#__PURE__*/function () {
     }
 
     if (!!feeOptions) {
-      var feeBips = this.encodeFeeBips(feeOptions.fee);
+      var feeBips = encodeFeeBips(feeOptions.fee);
       var feeRecipient = sdkCore.validateAndParseAddress(feeOptions.recipient);
       return PaymentsExtended.INTERFACE.encodeFunctionData('unwrapWETH9WithFee(uint256,uint256,address)', [v3Sdk.toHex(amountMinimum), feeBips, feeRecipient]);
     } else {
@@ -90,7 +90,7 @@ var PaymentsExtended = /*#__PURE__*/function () {
     }
 
     if (!!feeOptions) {
-      var feeBips = this.encodeFeeBips(feeOptions.fee);
+      var feeBips = encodeFeeBips(feeOptions.fee);
       var feeRecipient = sdkCore.validateAndParseAddress(feeOptions.recipient);
       return PaymentsExtended.INTERFACE.encodeFunctionData('sweepTokenWithFee(address,uint256,uint256,address)', [token.address, v3Sdk.toHex(amountMinimum), feeBips, feeRecipient]);
     } else {
@@ -102,6 +102,10 @@ var PaymentsExtended = /*#__PURE__*/function () {
     return PaymentsExtended.INTERFACE.encodeFunctionData('pull', [token.address, v3Sdk.toHex(amount)]);
   };
 
+  PaymentsExtended.encodeWrapETH = function encodeWrapETH(amount) {
+    return PaymentsExtended.INTERFACE.encodeFunctionData('wrapETH', [v3Sdk.toHex(amount)]);
+  };
+
   return PaymentsExtended;
 }();
 PaymentsExtended.INTERFACE = /*#__PURE__*/new abi.Interface(IPeripheryPaymentsWithFeeExtended_json.abi);
@@ -212,6 +216,11 @@ function _createForOfIteratorHelperLoose(o, allowArrayLike) {
   throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
 
+(function (Protocol) {
+  Protocol["V2"] = "V2";
+  Protocol["V3"] = "V3";
+})(exports.Protocol || (exports.Protocol = {}));
+
 function createCommonjsModule(fn, module) {
 	return module = { exports: {} }, fn(module, module.exports), module.exports;
 }
@@ -972,11 +981,6 @@ try {
 }
 });
 
-(function (Protocol) {
-  Protocol["V2"] = "V2";
-  Protocol["V3"] = "V3";
-})(exports.Protocol || (exports.Protocol = {}));
-
 var RouteV2 = /*#__PURE__*/function (_V2RouteSDK) {
   _inheritsLoose(RouteV2, _V2RouteSDK);
 
@@ -1047,7 +1051,43 @@ var Trade = /*#__PURE__*/function () {
       });
     }
 
-    this.tradeType = tradeType;
+    this.tradeType = tradeType; // each route must have the same input and output currency
+
+    var inputCurrency = this.swaps[0].inputAmount.currency;
+    var outputCurrency = this.swaps[0].outputAmount.currency;
+    !this.swaps.every(function (_ref2) {
+      var route = _ref2.route;
+      return inputCurrency.wrapped.equals(route.input.wrapped);
+    }) ?  invariant(false, 'INPUT_CURRENCY_MATCH')  : void 0;
+    !this.swaps.every(function (_ref3) {
+      var route = _ref3.route;
+      return outputCurrency.wrapped.equals(route.output.wrapped);
+    }) ?  invariant(false, 'OUTPUT_CURRENCY_MATCH')  : void 0; // pools must be unique inter protocols
+
+    var numPools = this.swaps.map(function (_ref4) {
+      var route = _ref4.route;
+      return route.pools.length;
+    }).reduce(function (total, cur) {
+      return total + cur;
+    }, 0);
+    var poolAddressSet = new Set();
+
+    for (var _iterator3 = _createForOfIteratorHelperLoose(this.swaps), _step3; !(_step3 = _iterator3()).done;) {
+      var _route2 = _step3.value.route;
+
+      for (var _iterator4 = _createForOfIteratorHelperLoose(_route2.pools), _step4; !(_step4 = _iterator4()).done;) {
+        var pool = _step4.value;
+
+        if (_route2.protocol == exports.Protocol.V3) {
+          poolAddressSet.add(v3Sdk.Pool.getAddress(pool.token0, pool.token1, pool.fee));
+        } else {
+          var pair = pool;
+          poolAddressSet.add(v2Sdk.Pair.getAddress(pair.token0, pair.token1));
+        }
+      }
+    }
+
+    !(numPools == poolAddressSet.size) ?  invariant(false, 'POOLS_DUPLICATED')  : void 0;
   }
 
   var _proto = Trade.prototype;
@@ -1105,7 +1145,7 @@ var Trade = /*#__PURE__*/function () {
 
   Trade.fromRoutes = /*#__PURE__*/function () {
     var _fromRoutes = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(v2Routes, v3Routes, tradeType) {
-      var populatedV2Routes, populatedV3Routes, _iterator3, _step3, _step3$value, routev2, amount, v2Trade, inputAmount, outputAmount, _iterator4, _step4, _step4$value, routev3, _amount, v3Trade, _inputAmount2, _outputAmount2;
+      var populatedV2Routes, populatedV3Routes, _iterator5, _step5, _step5$value, routev2, amount, v2Trade, inputAmount, outputAmount, _iterator6, _step6, _step6$value, routev3, _amount, v3Trade, _inputAmount2, _outputAmount2;
 
       return runtime_1.wrap(function _callee$(_context) {
         while (1) {
@@ -1114,8 +1154,8 @@ var Trade = /*#__PURE__*/function () {
               populatedV2Routes = [];
               populatedV3Routes = [];
 
-              for (_iterator3 = _createForOfIteratorHelperLoose(v2Routes); !(_step3 = _iterator3()).done;) {
-                _step3$value = _step3.value, routev2 = _step3$value.routev2, amount = _step3$value.amount;
+              for (_iterator5 = _createForOfIteratorHelperLoose(v2Routes); !(_step5 = _iterator5()).done;) {
+                _step5$value = _step5.value, routev2 = _step5$value.routev2, amount = _step5$value.amount;
                 v2Trade = new v2Sdk.Trade(routev2, amount, tradeType);
                 inputAmount = v2Trade.inputAmount, outputAmount = v2Trade.outputAmount;
                 populatedV2Routes.push({
@@ -1125,15 +1165,15 @@ var Trade = /*#__PURE__*/function () {
                 });
               }
 
-              _iterator4 = _createForOfIteratorHelperLoose(v3Routes);
+              _iterator6 = _createForOfIteratorHelperLoose(v3Routes);
 
             case 4:
-              if ((_step4 = _iterator4()).done) {
+              if ((_step6 = _iterator6()).done) {
                 _context.next = 13;
                 break;
               }
 
-              _step4$value = _step4.value, routev3 = _step4$value.routev3, _amount = _step4$value.amount;
+              _step6$value = _step6.value, routev3 = _step6$value.routev3, _amount = _step6$value.amount;
               _context.next = 8;
               return v3Sdk.Trade.fromRoute(routev3, _amount, tradeType);
 
@@ -1240,8 +1280,8 @@ var Trade = /*#__PURE__*/function () {
       }
 
       var inputCurrency = this.swaps[0].inputAmount.currency;
-      var totalInputFromRoutes = this.swaps.map(function (_ref2) {
-        var inputAmount = _ref2.inputAmount;
+      var totalInputFromRoutes = this.swaps.map(function (_ref5) {
+        var inputAmount = _ref5.inputAmount;
         return inputAmount;
       }).reduce(function (total, cur) {
         return total.add(cur);
@@ -1257,8 +1297,8 @@ var Trade = /*#__PURE__*/function () {
       }
 
       var outputCurrency = this.swaps[0].outputAmount.currency;
-      var totalOutputFromRoutes = this.swaps.map(function (_ref3) {
-        var outputAmount = _ref3.outputAmount;
+      var totalOutputFromRoutes = this.swaps.map(function (_ref6) {
+        var outputAmount = _ref6.outputAmount;
         return outputAmount;
       }).reduce(function (total, cur) {
         return total.add(cur);
@@ -1290,10 +1330,10 @@ var Trade = /*#__PURE__*/function () {
 
       var spotOutputAmount = sdkCore.CurrencyAmount.fromRawAmount(this.outputAmount.currency, 0);
 
-      for (var _iterator5 = _createForOfIteratorHelperLoose(this.swaps), _step5; !(_step5 = _iterator5()).done;) {
-        var _step5$value = _step5.value,
-            route = _step5$value.route,
-            inputAmount = _step5$value.inputAmount;
+      for (var _iterator7 = _createForOfIteratorHelperLoose(this.swaps), _step7; !(_step7 = _iterator7()).done;) {
+        var _step7$value = _step7.value,
+            route = _step7$value.route,
+            inputAmount = _step7$value.inputAmount;
         var midPrice = route.midPrice;
         spotOutputAmount = spotOutputAmount.add(midPrice.quote(inputAmount));
       }
@@ -1307,7 +1347,6 @@ var Trade = /*#__PURE__*/function () {
   return Trade;
 }();
 
-var ZERO$1 = /*#__PURE__*/JSBI.BigInt(0);
 /**
  * Represents the Uniswap V2 + V3 SwapRouter02, and has static methods for helping execute trades.
  */
@@ -1318,18 +1357,16 @@ var SwapRouter = /*#__PURE__*/function () {
    */
   function SwapRouter() {}
 
-  SwapRouter.encodeV2Swap = function encodeV2Swap(trade, options, routerMustCustody) {
+  SwapRouter.encodeV2Swap = function encodeV2Swap(trade, options, routerMustCustody, performAggregatedSlippageCheck) {
     var amountIn = v3Sdk.toHex(trade.maximumAmountIn(options.slippageTolerance).quotient);
     var amountOut = v3Sdk.toHex(trade.minimumAmountOut(options.slippageTolerance).quotient);
     var path = trade.route.path.map(function (token) {
       return token.address;
     });
-    var recipient = routerMustCustody ? ADDRESS_THIS : options.recipient ? sdkCore.validateAndParseAddress(options.recipient) : MSG_SENDER;
+    var recipient = routerMustCustody ? ADDRESS_THIS : typeof options.recipient === 'undefined' ? MSG_SENDER : sdkCore.validateAndParseAddress(options.recipient);
 
     if (trade.tradeType === sdkCore.TradeType.EXACT_INPUT) {
-      var exactInputParams = [amountIn, // save gas by only passing slippage check if we can't check it later
-      // not a pure win, as sometimes this will cost us more when it would have caused an earlier failure
-      routerMustCustody ? 0 : amountOut, path, recipient];
+      var exactInputParams = [amountIn, performAggregatedSlippageCheck ? 0 : amountOut, path, recipient];
       return SwapRouter.INTERFACE.encodeFunctionData('swapExactTokensForTokens', exactInputParams);
     } else {
       var exactOutputParams = [amountOut, amountIn, path, recipient];
@@ -1337,7 +1374,7 @@ var SwapRouter = /*#__PURE__*/function () {
     }
   };
 
-  SwapRouter.encodeV3Swap = function encodeV3Swap(trade, options, routerMustCustody) {
+  SwapRouter.encodeV3Swap = function encodeV3Swap(trade, options, routerMustCustody, performAggregatedSlippageCheck) {
     var calldatas = [];
 
     for (var _iterator = _createForOfIteratorHelperLoose(trade.swaps), _step; !(_step = _iterator()).done;) {
@@ -1349,7 +1386,7 @@ var SwapRouter = /*#__PURE__*/function () {
       var amountOut = v3Sdk.toHex(trade.minimumAmountOut(options.slippageTolerance, outputAmount).quotient); // flag for whether the trade is single hop or not
 
       var singleHop = route.pools.length === 1;
-      var recipient = routerMustCustody ? ADDRESS_THIS : options.recipient ? sdkCore.validateAndParseAddress(options.recipient) : MSG_SENDER;
+      var recipient = routerMustCustody ? ADDRESS_THIS : typeof options.recipient === 'undefined' ? MSG_SENDER : sdkCore.validateAndParseAddress(options.recipient);
 
       if (singleHop) {
         if (trade.tradeType === sdkCore.TradeType.EXACT_INPUT) {
@@ -1359,7 +1396,7 @@ var SwapRouter = /*#__PURE__*/function () {
             fee: route.pools[0].fee,
             recipient: recipient,
             amountIn: amountIn,
-            amountOutMinimum: amountOut,
+            amountOutMinimum: performAggregatedSlippageCheck ? 0 : amountOut,
             sqrtPriceLimitX96: 0
           };
           calldatas.push(SwapRouter.INTERFACE.encodeFunctionData('exactInputSingle', [exactInputSingleParams]));
@@ -1383,7 +1420,7 @@ var SwapRouter = /*#__PURE__*/function () {
             path: path,
             recipient: recipient,
             amountIn: amountIn,
-            amountOutMinimum: amountOut
+            amountOutMinimum: performAggregatedSlippageCheck ? 0 : amountOut
           };
           calldatas.push(SwapRouter.INTERFACE.encodeFunctionData('exactInput', [exactInputParams]));
         } else {
@@ -1440,6 +1477,9 @@ var SwapRouter = /*#__PURE__*/function () {
       trades = [trades];
     }
 
+    var numberOfTrades = trades.reduce(function (numberOfTrades, trade) {
+      return numberOfTrades + (trade instanceof v3Sdk.Trade ? trade.swaps.length : 1);
+    }, 0);
     var sampleTrade = trades[0]; // All trades should have the same starting/ending currency and trade type
 
     !trades.every(function (trade) {
@@ -1461,13 +1501,17 @@ var SwapRouter = /*#__PURE__*/function () {
     var outputIsNative = sampleTrade.outputAmount.currency.isNative; // flag for whether a refund needs to happen
     //   1. when paying in ETH, but with an uncertain input amount
 
-    var mustRefund = inputIsNative && sampleTrade.tradeType === sdkCore.TradeType.EXACT_OUTPUT; // flag for whether funds should be send first to the router
+    var mustRefund = inputIsNative && sampleTrade.tradeType === sdkCore.TradeType.EXACT_OUTPUT; // flag for whether we want to perform an aggregated slippage check
+    //   1. when there are >2 exact input trades. this is only a heuristic,
+    //      as it's still more gas-expensive even in this case, but has benefits
+    //      in that the reversion probability is lower
+
+    var performAggregatedSlippageCheck = sampleTrade.tradeType === sdkCore.TradeType.EXACT_INPUT && numberOfTrades > 2; // flag for whether funds should be send first to the router
     //   1. when receiving ETH (which much be unwrapped from WETH)
     //   2. when a fee on the output is being taken
-    //   3. when there are >1 exact input trades. this one isn't strictly necessary,
-    //      but typically we want to perform an aggregated slippage check
+    //   3. when performing an aggregated slippage check
 
-    var routerMustCustody = outputIsNative || !!options.fee || trades.length > 1 && sampleTrade.tradeType === sdkCore.TradeType.EXACT_INPUT;
+    var routerMustCustody = outputIsNative || !!options.fee || performAggregatedSlippageCheck;
     var totalValue = inputIsNative ? trades.reduce(function (sum, trade) {
       return sum.add(trade.maximumAmountIn(options.slippageTolerance));
     }, ZERO_IN) : ZERO_IN; // encode permit if necessary
@@ -1481,25 +1525,21 @@ var SwapRouter = /*#__PURE__*/function () {
       var trade = _step3.value;
 
       if (trade instanceof v2Sdk.Trade) {
-        calldatas.push(SwapRouter.encodeV2Swap(trade, options, routerMustCustody));
+        calldatas.push(SwapRouter.encodeV2Swap(trade, options, routerMustCustody, performAggregatedSlippageCheck));
       } else {
-        for (var _iterator4 = _createForOfIteratorHelperLoose(SwapRouter.encodeV3Swap(trade, options, routerMustCustody)), _step4; !(_step4 = _iterator4()).done;) {
+        for (var _iterator4 = _createForOfIteratorHelperLoose(SwapRouter.encodeV3Swap(trade, options, routerMustCustody, performAggregatedSlippageCheck)), _step4; !(_step4 = _iterator4()).done;) {
           var calldata = _step4.value;
           calldatas.push(calldata);
         }
       }
-    } // unwrap
+    } // unwrap or sweep
 
 
     if (routerMustCustody) {
-      // if all trades are exact output, we can save gas by not passing a slippage check
-      var canOmitSlippageCheck = sampleTrade.tradeType === sdkCore.TradeType.EXACT_OUTPUT;
-      var amountNecessary = canOmitSlippageCheck ? ZERO$1 : totalAmountOut.quotient;
-
       if (outputIsNative) {
-        calldatas.push(PaymentsExtended.encodeUnwrapWETH9(amountNecessary, options.recipient, options.fee));
+        calldatas.push(PaymentsExtended.encodeUnwrapWETH9(totalAmountOut.quotient, options.recipient, options.fee));
       } else {
-        calldatas.push(PaymentsExtended.encodeSweepToken(sampleTrade.outputAmount.currency.wrapped, amountNecessary, options.recipient, options.fee));
+        calldatas.push(PaymentsExtended.encodeSweepToken(sampleTrade.outputAmount.currency.wrapped, totalAmountOut.quotient, options.recipient, options.fee));
       }
     } // refund