@uniswap/router-sdk 1.0.1 → 1.0.5

package/dist/approveAndCall.d.ts

@@ -1,5 +1,7 @@
 import { Interface } from '@ethersproject/abi';
-import { Currency, Token } from '@uniswap/sdk-core';
+import { Currency, Percent, Token } from '@uniswap/sdk-core';
+import { MintSpecificOptions, IncreaseSpecificOptions, Position } from '@uniswap/v3-sdk';
+export declare type CondensedAddLiquidityOptions = Omit<MintSpecificOptions, 'createPool'> | IncreaseSpecificOptions;
 export declare enum ApprovalTypes {
     NOT_REQUIRED = 0,
     MAX = 1,
@@ -7,6 +9,7 @@ export declare enum ApprovalTypes {
     ZERO_THEN_MAX = 3,
     ZERO_THEN_MAX_MINUS_ONE = 4
 }
+export declare function isMint(options: CondensedAddLiquidityOptions): options is Omit<MintSpecificOptions, 'createPool'>;
 export declare abstract class ApproveAndCall {
     static INTERFACE: Interface;
     /**
@@ -18,5 +21,13 @@ export declare abstract class ApproveAndCall {
     static encodeApproveZeroThenMax(token: Token): string;
     static encodeApproveZeroThenMaxMinusOne(token: Token): string;
     static encodeCallPositionManager(calldatas: string[]): string;
+    /**
+     * Encode adding liquidity to a position in the nft manager contract
+     * @param position Forcasted position with expected amount out from swap
+     * @param minimalPosition Forcasted position with custom minimal token amounts
+     * @param addLiquidityOptions Options for adding liquidity
+     * @param slippageTolerance Defines maximum slippage
+     */
+    static encodeAddLiquidity(position: Position, minimalPosition: Position, addLiquidityOptions: CondensedAddLiquidityOptions, slippageTolerance: Percent): string;
     static encodeApprove(token: Currency, approvalType: ApprovalTypes): string;
 }

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './constants';
+export * from './approveAndCall';
 export * from './multicallExtended';
 export * from './paymentsExtended';
 export * from './swapRouter';

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

@@ -6,20 +6,136 @@ function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'defau
 
 var JSBI = _interopDefault(require('jsbi'));
 var abi = require('@ethersproject/abi');
-var IMulticallExtended_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IMulticallExtended.sol/IMulticallExtended.json');
+var invariant = _interopDefault(require('tiny-invariant'));
+var IApproveAndCall_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IApproveAndCall.sol/IApproveAndCall.json');
 var v3Sdk = require('@uniswap/v3-sdk');
+var IMulticallExtended_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IMulticallExtended.sol/IMulticallExtended.json');
 var sdkCore = require('@uniswap/sdk-core');
 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 IApproveAndCall_json = require('@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IApproveAndCall.sol/IApproveAndCall.json');
 
 var MSG_SENDER = '0x0000000000000000000000000000000000000001';
 var ADDRESS_THIS = '0x0000000000000000000000000000000000000002';
 var ZERO = /*#__PURE__*/JSBI.BigInt(0);
 var ONE = /*#__PURE__*/JSBI.BigInt(1);
 
+(function (ApprovalTypes) {
+  ApprovalTypes[ApprovalTypes["NOT_REQUIRED"] = 0] = "NOT_REQUIRED";
+  ApprovalTypes[ApprovalTypes["MAX"] = 1] = "MAX";
+  ApprovalTypes[ApprovalTypes["MAX_MINUS_ONE"] = 2] = "MAX_MINUS_ONE";
+  ApprovalTypes[ApprovalTypes["ZERO_THEN_MAX"] = 3] = "ZERO_THEN_MAX";
+  ApprovalTypes[ApprovalTypes["ZERO_THEN_MAX_MINUS_ONE"] = 4] = "ZERO_THEN_MAX_MINUS_ONE";
+})(exports.ApprovalTypes || (exports.ApprovalTypes = {})); // type guard
+
+
+function isMint(options) {
+  return Object.keys(options).some(function (k) {
+    return k === 'recipient';
+  });
+}
+var ApproveAndCall = /*#__PURE__*/function () {
+  /**
+   * Cannot be constructed.
+   */
+  function ApproveAndCall() {}
+
+  ApproveAndCall.encodeApproveMax = function encodeApproveMax(token) {
+    return ApproveAndCall.INTERFACE.encodeFunctionData('approveMax', [token.address]);
+  };
+
+  ApproveAndCall.encodeApproveMaxMinusOne = function encodeApproveMaxMinusOne(token) {
+    return ApproveAndCall.INTERFACE.encodeFunctionData('approveMaxMinusOne', [token.address]);
+  };
+
+  ApproveAndCall.encodeApproveZeroThenMax = function encodeApproveZeroThenMax(token) {
+    return ApproveAndCall.INTERFACE.encodeFunctionData('approveZeroThenMax', [token.address]);
+  };
+
+  ApproveAndCall.encodeApproveZeroThenMaxMinusOne = function encodeApproveZeroThenMaxMinusOne(token) {
+    return ApproveAndCall.INTERFACE.encodeFunctionData('approveZeroThenMaxMinusOne', [token.address]);
+  };
+
+  ApproveAndCall.encodeCallPositionManager = function encodeCallPositionManager(calldatas) {
+    !(calldatas.length > 0) ?  invariant(false, 'NULL_CALLDATA')  : void 0;
+
+    if (calldatas.length == 1) {
+      return ApproveAndCall.INTERFACE.encodeFunctionData('callPositionManager', calldatas);
+    } else {
+      var encodedMulticall = v3Sdk.NonfungiblePositionManager.INTERFACE.encodeFunctionData('multicall', [calldatas]);
+      return ApproveAndCall.INTERFACE.encodeFunctionData('callPositionManager', [encodedMulticall]);
+    }
+  }
+  /**
+   * Encode adding liquidity to a position in the nft manager contract
+   * @param position Forcasted position with expected amount out from swap
+   * @param minimalPosition Forcasted position with custom minimal token amounts
+   * @param addLiquidityOptions Options for adding liquidity
+   * @param slippageTolerance Defines maximum slippage
+   */
+  ;
+
+  ApproveAndCall.encodeAddLiquidity = function encodeAddLiquidity(position, minimalPosition, addLiquidityOptions, slippageTolerance) {
+    var _position$mintAmounts = position.mintAmountsWithSlippage(slippageTolerance),
+        amount0Min = _position$mintAmounts.amount0,
+        amount1Min = _position$mintAmounts.amount1; // position.mintAmountsWithSlippage() can create amounts not dependenable in scenarios
+    // such as range orders. Allow the option to provide a position with custom minimum amounts
+    // for these scenarios
+
+
+    if (JSBI.lessThan(minimalPosition.amount0.quotient, amount0Min)) {
+      amount0Min = minimalPosition.amount0.quotient;
+    }
+
+    if (JSBI.lessThan(minimalPosition.amount1.quotient, amount1Min)) {
+      amount1Min = minimalPosition.amount1.quotient;
+    }
+
+    if (isMint(addLiquidityOptions)) {
+      return ApproveAndCall.INTERFACE.encodeFunctionData('mint', [{
+        token0: position.pool.token0.address,
+        token1: position.pool.token1.address,
+        fee: position.pool.fee,
+        tickLower: position.tickLower,
+        tickUpper: position.tickUpper,
+        amount0Min: v3Sdk.toHex(amount0Min),
+        amount1Min: v3Sdk.toHex(amount1Min),
+        recipient: addLiquidityOptions.recipient
+      }]);
+    } else {
+      return ApproveAndCall.INTERFACE.encodeFunctionData('increaseLiquidity', [{
+        token0: position.pool.token0.address,
+        token1: position.pool.token1.address,
+        amount0Min: v3Sdk.toHex(amount0Min),
+        amount1Min: v3Sdk.toHex(amount1Min),
+        tokenId: v3Sdk.toHex(addLiquidityOptions.tokenId)
+      }]);
+    }
+  };
+
+  ApproveAndCall.encodeApprove = function encodeApprove(token, approvalType) {
+    switch (approvalType) {
+      case exports.ApprovalTypes.MAX:
+        return ApproveAndCall.encodeApproveMax(token.wrapped);
+
+      case exports.ApprovalTypes.MAX_MINUS_ONE:
+        return ApproveAndCall.encodeApproveMaxMinusOne(token.wrapped);
+
+      case exports.ApprovalTypes.ZERO_THEN_MAX:
+        return ApproveAndCall.encodeApproveZeroThenMax(token.wrapped);
+
+      case exports.ApprovalTypes.ZERO_THEN_MAX_MINUS_ONE:
+        return ApproveAndCall.encodeApproveZeroThenMaxMinusOne(token.wrapped);
+
+      default:
+        throw 'Error: invalid ApprovalType';
+    }
+  };
+
+  return ApproveAndCall;
+}();
+ApproveAndCall.INTERFACE = /*#__PURE__*/new abi.Interface(IApproveAndCall_json.abi);
+
 function validateAndParseBytes32(bytes32) {
   if (!bytes32.match(/^0x[0-9a-fA-F]{64}$/)) {
     throw new Error(bytes32 + " is not valid bytes32.");
@@ -217,72 +333,6 @@ 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.");
 }
 
-var ApprovalTypes;
-
-(function (ApprovalTypes) {
-  ApprovalTypes[ApprovalTypes["NOT_REQUIRED"] = 0] = "NOT_REQUIRED";
-  ApprovalTypes[ApprovalTypes["MAX"] = 1] = "MAX";
-  ApprovalTypes[ApprovalTypes["MAX_MINUS_ONE"] = 2] = "MAX_MINUS_ONE";
-  ApprovalTypes[ApprovalTypes["ZERO_THEN_MAX"] = 3] = "ZERO_THEN_MAX";
-  ApprovalTypes[ApprovalTypes["ZERO_THEN_MAX_MINUS_ONE"] = 4] = "ZERO_THEN_MAX_MINUS_ONE";
-})(ApprovalTypes || (ApprovalTypes = {}));
-
-var ApproveAndCall = /*#__PURE__*/function () {
-  /**
-   * Cannot be constructed.
-   */
-  function ApproveAndCall() {}
-
-  ApproveAndCall.encodeApproveMax = function encodeApproveMax(token) {
-    return ApproveAndCall.INTERFACE.encodeFunctionData('approveMax', [token.address]);
-  };
-
-  ApproveAndCall.encodeApproveMaxMinusOne = function encodeApproveMaxMinusOne(token) {
-    return ApproveAndCall.INTERFACE.encodeFunctionData('approveMaxMinusOne', [token.address]);
-  };
-
-  ApproveAndCall.encodeApproveZeroThenMax = function encodeApproveZeroThenMax(token) {
-    return ApproveAndCall.INTERFACE.encodeFunctionData('approveZeroThenMax', [token.address]);
-  };
-
-  ApproveAndCall.encodeApproveZeroThenMaxMinusOne = function encodeApproveZeroThenMaxMinusOne(token) {
-    return ApproveAndCall.INTERFACE.encodeFunctionData('approveZeroThenMaxMinusOne', [token.address]);
-  };
-
-  ApproveAndCall.encodeCallPositionManager = function encodeCallPositionManager(calldatas) {
-    !(calldatas.length > 0) ?  invariant(false, 'NULL_CALLDATA')  : void 0;
-
-    if (calldatas.length == 1) {
-      return ApproveAndCall.INTERFACE.encodeFunctionData('callPositionManager', calldatas);
-    } else {
-      var encodedMulticall = v3Sdk.NonfungiblePositionManager.INTERFACE.encodeFunctionData('multicall', [calldatas]);
-      return ApproveAndCall.INTERFACE.encodeFunctionData('callPositionManager', [encodedMulticall]);
-    }
-  };
-
-  ApproveAndCall.encodeApprove = function encodeApprove(token, approvalType) {
-    switch (approvalType) {
-      case ApprovalTypes.MAX:
-        return ApproveAndCall.encodeApproveMax(token.wrapped);
-
-      case ApprovalTypes.MAX_MINUS_ONE:
-        return ApproveAndCall.encodeApproveMaxMinusOne(token.wrapped);
-
-      case ApprovalTypes.ZERO_THEN_MAX:
-        return ApproveAndCall.encodeApproveZeroThenMax(token.wrapped);
-
-      case ApprovalTypes.ZERO_THEN_MAX_MINUS_ONE:
-        return ApproveAndCall.encodeApproveZeroThenMaxMinusOne(token.wrapped);
-
-      default:
-        throw 'Error: invalid ApprovalType';
-    }
-  };
-
-  return ApproveAndCall;
-}();
-ApproveAndCall.INTERFACE = /*#__PURE__*/new abi.Interface(IApproveAndCall_json.abi);
-
 function createCommonjsModule(fn, module) {
 	return module = { exports: {} }, fn(module, module.exports), module.exports;
 }
@@ -1588,9 +1638,12 @@ var SwapRouter = /*#__PURE__*/function () {
 
     var ZERO_IN = sdkCore.CurrencyAmount.fromRawAmount(sampleTrade.inputAmount.currency, 0);
     var ZERO_OUT = sdkCore.CurrencyAmount.fromRawAmount(sampleTrade.outputAmount.currency, 0);
-    var totalAmountOut = trades.reduce(function (sum, trade) {
+    var minimumAmountOut = trades.reduce(function (sum, trade) {
       return sum.add(trade.minimumAmountOut(options.slippageTolerance));
     }, ZERO_OUT);
+    var quoteAmountOut = trades.reduce(function (sum, trade) {
+      return sum.add(trade.outputAmount);
+    }, ZERO_OUT);
     var totalAmountIn = trades.reduce(function (sum, trade) {
       return sum.add(trade.maximumAmountIn(options.slippageTolerance));
     }, ZERO_IN);
@@ -1601,7 +1654,8 @@ var SwapRouter = /*#__PURE__*/function () {
       inputIsNative: inputIsNative,
       outputIsNative: outputIsNative,
       totalAmountIn: totalAmountIn,
-      totalAmountOut: totalAmountOut
+      minimumAmountOut: minimumAmountOut,
+      quoteAmountOut: quoteAmountOut
     };
   }
   /**
@@ -1619,14 +1673,14 @@ var SwapRouter = /*#__PURE__*/function () {
         inputIsNative = _SwapRouter$encodeSwa.inputIsNative,
         outputIsNative = _SwapRouter$encodeSwa.outputIsNative,
         totalAmountIn = _SwapRouter$encodeSwa.totalAmountIn,
-        totalAmountOut = _SwapRouter$encodeSwa.totalAmountOut; // unwrap or sweep
+        minimumAmountOut = _SwapRouter$encodeSwa.minimumAmountOut; // unwrap or sweep
 
 
     if (routerMustCustody) {
       if (outputIsNative) {
-        calldatas.push(PaymentsExtended.encodeUnwrapWETH9(totalAmountOut.quotient, options.recipient, options.fee));
+        calldatas.push(PaymentsExtended.encodeUnwrapWETH9(minimumAmountOut.quotient, options.recipient, options.fee));
       } else {
-        calldatas.push(PaymentsExtended.encodeSweepToken(sampleTrade.outputAmount.currency.wrapped, totalAmountOut.quotient, options.recipient, options.fee));
+        calldatas.push(PaymentsExtended.encodeSweepToken(sampleTrade.outputAmount.currency.wrapped, minimumAmountOut.quotient, options.recipient, options.fee));
       }
     } // must refund when paying in ETH, but with an uncertain input amount
 
@@ -1654,10 +1708,17 @@ var SwapRouter = /*#__PURE__*/function () {
         outputIsNative = _SwapRouter$encodeSwa2.outputIsNative,
         sampleTrade = _SwapRouter$encodeSwa2.sampleTrade,
         totalAmountSwapped = _SwapRouter$encodeSwa2.totalAmountIn,
-        totalAmountOut = _SwapRouter$encodeSwa2.totalAmountOut;
+        quoteAmountOut = _SwapRouter$encodeSwa2.quoteAmountOut,
+        minimumAmountOut = _SwapRouter$encodeSwa2.minimumAmountOut; // encode output token permit if necessary
+
+
+    if (options.outputTokenPermit) {
+      !quoteAmountOut.currency.isToken ?  invariant(false, 'NON_TOKEN_PERMIT_OUTPUT')  : void 0;
+      calldatas.push(v3Sdk.SelfPermit.encodePermit(quoteAmountOut.currency, options.outputTokenPermit));
+    }
 
     var chainId = sampleTrade.route.chainId;
-    var zeroForOne = position.pool.token0 === totalAmountSwapped.currency.wrapped;
+    var zeroForOne = position.pool.token0.wrapped.address === totalAmountSwapped.currency.wrapped.address;
 
     var _SwapRouter$getPositi = SwapRouter.getPositionAmounts(position, zeroForOne),
         positionAmountIn = _SwapRouter$getPositi.positionAmountIn,
@@ -1667,7 +1728,7 @@ var SwapRouter = /*#__PURE__*/function () {
     var tokenIn = inputIsNative ? sdkCore.WETH9[chainId] : positionAmountIn.currency.wrapped;
     var tokenOut = outputIsNative ? sdkCore.WETH9[chainId] : positionAmountOut.currency.wrapped; // if swap output does not make up whole outputTokenBalanceDesired, pull in remaining tokens for adding liquidity
 
-    var amountOutRemaining = positionAmountOut.subtract(totalAmountOut.wrapped);
+    var amountOutRemaining = positionAmountOut.subtract(quoteAmountOut.wrapped);
 
     if (amountOutRemaining.greaterThan(sdkCore.CurrencyAmount.fromRawAmount(positionAmountOut.currency, 0))) {
       // if output is native, this means the remaining portion is included as native value in the transaction
@@ -1678,10 +1739,20 @@ var SwapRouter = /*#__PURE__*/function () {
 
     inputIsNative ? calldatas.push(PaymentsExtended.encodeWrapETH(positionAmountIn.quotient)) : calldatas.push(PaymentsExtended.encodePull(tokenIn, positionAmountIn.quotient)); // approve token balances to NFTManager
 
-    if (tokenInApprovalType !== ApprovalTypes.NOT_REQUIRED) calldatas.push(ApproveAndCall.encodeApprove(tokenIn, tokenInApprovalType));
-    if (tokenOutApprovalType !== ApprovalTypes.NOT_REQUIRED) calldatas.push(ApproveAndCall.encodeApprove(tokenOut, tokenOutApprovalType)); // encode NFTManager add liquidity
+    if (tokenInApprovalType !== exports.ApprovalTypes.NOT_REQUIRED) calldatas.push(ApproveAndCall.encodeApprove(tokenIn, tokenInApprovalType));
+    if (tokenOutApprovalType !== exports.ApprovalTypes.NOT_REQUIRED) calldatas.push(ApproveAndCall.encodeApprove(tokenOut, tokenOutApprovalType)); // represents a position with token amounts resulting from a swap with maximum slippage
+    // hence the minimal amount out possible.
+
+    var minimalPosition = v3Sdk.Position.fromAmounts({
+      pool: position.pool,
+      tickLower: position.tickLower,
+      tickUpper: position.tickUpper,
+      amount0: zeroForOne ? position.amount0.quotient.toString() : minimumAmountOut.quotient.toString(),
+      amount1: zeroForOne ? minimumAmountOut.quotient.toString() : position.amount1.quotient.toString(),
+      useFullPrecision: false
+    }); // encode NFTManager add liquidity
 
-    calldatas.push(ApproveAndCall.encodeCallPositionManager([v3Sdk.NonfungiblePositionManager.addCallParameters(position, addLiquidityOptions).calldata])); // sweep remaining tokens
+    calldatas.push(ApproveAndCall.encodeAddLiquidity(position, minimalPosition, addLiquidityOptions, options.slippageTolerance)); // sweep remaining tokens
 
     inputIsNative ? calldatas.push(PaymentsExtended.encodeUnwrapWETH9(ZERO$1)) : calldatas.push(PaymentsExtended.encodeSweepToken(tokenIn, ZERO$1));
     outputIsNative ? calldatas.push(PaymentsExtended.encodeUnwrapWETH9(ZERO$1)) : calldatas.push(PaymentsExtended.encodeSweepToken(tokenOut, ZERO$1));
@@ -1723,6 +1794,7 @@ var SwapRouter = /*#__PURE__*/function () {
 SwapRouter.INTERFACE = /*#__PURE__*/new abi.Interface(ISwapRouter02_json.abi);
 
 exports.ADDRESS_THIS = ADDRESS_THIS;
+exports.ApproveAndCall = ApproveAndCall;
 exports.MSG_SENDER = MSG_SENDER;
 exports.MulticallExtended = MulticallExtended;
 exports.ONE = ONE;
@@ -1732,4 +1804,5 @@ exports.RouteV3 = RouteV3;
 exports.SwapRouter = SwapRouter;
 exports.Trade = Trade;
 exports.ZERO = ZERO;
+exports.isMint = isMint;
 //# sourceMappingURL=router-sdk.cjs.development.js.map