@uniswap/router-sdk 1.0.0-beta.5 → 1.0.0-beta.6

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,7 +2,7 @@ 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[];

package/dist/entities/trade.d.ts

@@ -3,7 +3,7 @@ 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

@@ -8,11 +8,11 @@ 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 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';
@@ -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);
 
@@ -1324,12 +1328,12 @@ var SwapRouter = /*#__PURE__*/function () {
     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];
+      routerMustCustody ? 0 : amountOut, path, recipient, false];
       return SwapRouter.INTERFACE.encodeFunctionData('swapExactTokensForTokens', exactInputParams);
     } else {
       var exactOutputParams = [amountOut, amountIn, path, recipient];
@@ -1349,7 +1353,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) {
@@ -1360,7 +1364,8 @@ var SwapRouter = /*#__PURE__*/function () {
             recipient: recipient,
             amountIn: amountIn,
             amountOutMinimum: amountOut,
-            sqrtPriceLimitX96: 0
+            sqrtPriceLimitX96: 0,
+            hasAlreadyPaid: false
           };
           calldatas.push(SwapRouter.INTERFACE.encodeFunctionData('exactInputSingle', [exactInputSingleParams]));
         } else {
@@ -1383,7 +1388,8 @@ var SwapRouter = /*#__PURE__*/function () {
             path: path,
             recipient: recipient,
             amountIn: amountIn,
-            amountOutMinimum: amountOut
+            amountOutMinimum: amountOut,
+            hasAlreadyPaid: false
           };
           calldatas.push(SwapRouter.INTERFACE.encodeFunctionData('exactInput', [exactInputParams]));
         } else {