@uniswap/router-sdk 1.6.0 → 1.7.1

package/dist/constants.d.ts

@@ -1,6 +1,9 @@
+import { Percent } from '@uniswap/sdk-core';
 import JSBI from 'jsbi';
 export declare const MSG_SENDER = "0x0000000000000000000000000000000000000001";
 export declare const ADDRESS_THIS = "0x0000000000000000000000000000000000000002";
 export declare const ZERO: JSBI;
 export declare const ONE: JSBI;
 export declare const V2_FEE_PATH_PLACEHOLDER = 8388608;
+export declare const ZERO_PERCENT: Percent;
+export declare const ONE_HUNDRED_PERCENT: Percent;

package/dist/entities/trade.d.ts

@@ -42,13 +42,23 @@ export declare class Trade<TInput extends Currency, TOutput extends Currency, TT
      * The price expressed in terms of output amount/input amount.
      */
     get executionPrice(): Price<TInput, TOutput>;
+    /**
+     * Returns the sell tax of the input token
+     */
+    get inputTax(): Percent;
+    /**
+     * Returns the buy tax of the output token
+     */
+    get outputTax(): Percent;
     /**
      * The cached result of the price impact computation
      * @private
      */
     private _priceImpact;
     /**
-     * Returns the percent difference between the route's mid price and the price impact
+     * Returns the percent difference between the route's mid price and the expected execution price
+     * In order to exclude token taxes from the price impact calculation, the spot price is calculated
+     * using a ratio of values that go into the pools, which are the post-tax input amount and pre-tax output amount.
      */
     get priceImpact(): Percent;
     /**

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

@@ -4,13 +4,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
 
+var sdkCore = require('@uniswap/sdk-core');
 var JSBI = _interopDefault(require('jsbi'));
 var abi = require('@ethersproject/abi');
 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');
@@ -22,6 +22,8 @@ var ZERO = /*#__PURE__*/JSBI.BigInt(0);
 var ONE = /*#__PURE__*/JSBI.BigInt(1); // = 1 << 23 or 100000000000000000000000
 
 var V2_FEE_PATH_PLACEHOLDER = 8388608;
+var ZERO_PERCENT = /*#__PURE__*/new sdkCore.Percent(ZERO);
+var ONE_HUNDRED_PERCENT = /*#__PURE__*/new sdkCore.Percent(100, 100);
 
 (function (ApprovalTypes) {
   ApprovalTypes[ApprovalTypes["NOT_REQUIRED"] = 0] = "NOT_REQUIRED";
@@ -1904,6 +1906,10 @@ var Trade = /*#__PURE__*/function () {
       }
     }
 
+    if (this.swaps.length === 0) {
+      throw new Error('No routes provided when calling Trade constructor');
+    }
+
     this.tradeType = tradeType; // each route must have the same input and output currency
 
     var inputCurrency = this.swaps[0].inputAmount.currency;
@@ -2239,7 +2245,31 @@ var Trade = /*#__PURE__*/function () {
       return (_this$_executionPrice = this._executionPrice) != null ? _this$_executionPrice : this._executionPrice = new sdkCore.Price(this.inputAmount.currency, this.outputAmount.currency, this.inputAmount.quotient, this.outputAmount.quotient);
     }
     /**
-     * Returns the percent difference between the route's mid price and the price impact
+     * Returns the sell tax of the input token
+     */
+
+  }, {
+    key: "inputTax",
+    get: function get() {
+      var inputCurrency = this.inputAmount.currency;
+      if (inputCurrency.isNative || !inputCurrency.wrapped.sellFeeBps) return ZERO_PERCENT;
+      return new sdkCore.Percent(inputCurrency.wrapped.sellFeeBps.toNumber(), 10000);
+    }
+    /**
+     * Returns the buy tax of the output token
+     */
+
+  }, {
+    key: "outputTax",
+    get: function get() {
+      var outputCurrency = this.outputAmount.currency;
+      if (outputCurrency.isNative || !outputCurrency.wrapped.buyFeeBps) return ZERO_PERCENT;
+      return new sdkCore.Percent(outputCurrency.wrapped.buyFeeBps.toNumber(), 10000);
+    }
+    /**
+     * Returns the percent difference between the route's mid price and the expected execution price
+     * In order to exclude token taxes from the price impact calculation, the spot price is calculated
+     * using a ratio of values that go into the pools, which are the post-tax input amount and pre-tax output amount.
      */
 
   }, {
@@ -2247,8 +2277,11 @@ var Trade = /*#__PURE__*/function () {
     get: function get() {
       if (this._priceImpact) {
         return this._priceImpact;
-      }
+      } // returns 0% price impact even though this may be inaccurate as a swap may have occured.
+      // because we're unable to derive the pre-buy-tax amount, use 0% as a placeholder.
 
+
+      if (this.outputTax.equalTo(ONE_HUNDRED_PERCENT)) return ZERO_PERCENT;
       var spotOutputAmount = sdkCore.CurrencyAmount.fromRawAmount(this.outputAmount.currency, 0);
 
       for (var _iterator9 = _createForOfIteratorHelperLoose(this.swaps), _step9; !(_step9 = _iterator9()).done;) {
@@ -2256,10 +2289,15 @@ var Trade = /*#__PURE__*/function () {
             route = _step9$value.route,
             inputAmount = _step9$value.inputAmount;
         var midPrice = route.midPrice;
-        spotOutputAmount = spotOutputAmount.add(midPrice.quote(inputAmount));
-      }
+        var postTaxInputAmount = inputAmount.multiply(new sdkCore.Fraction(ONE).subtract(this.inputTax));
+        spotOutputAmount = spotOutputAmount.add(midPrice.quote(postTaxInputAmount));
+      } // if the total output of this trade is 0, then most likely the post-tax input was also 0, and therefore this swap
+      // does not move the pools' market price
 
-      var priceImpact = spotOutputAmount.subtract(this.outputAmount).divide(spotOutputAmount);
+
+      if (spotOutputAmount.equalTo(ZERO)) return ZERO_PERCENT;
+      var preTaxOutputAmount = this.outputAmount.divide(new sdkCore.Fraction(ONE).subtract(this.outputTax));
+      var priceImpact = spotOutputAmount.subtract(preTaxOutputAmount).divide(spotOutputAmount);
       this._priceImpact = new sdkCore.Percent(priceImpact.numerator, priceImpact.denominator);
       return this._priceImpact;
     }
@@ -2847,6 +2885,7 @@ exports.MixedRouteSDK = MixedRouteSDK;
 exports.MixedRouteTrade = MixedRouteTrade;
 exports.MulticallExtended = MulticallExtended;
 exports.ONE = ONE;
+exports.ONE_HUNDRED_PERCENT = ONE_HUNDRED_PERCENT;
 exports.PaymentsExtended = PaymentsExtended;
 exports.RouteV2 = RouteV2;
 exports.RouteV3 = RouteV3;
@@ -2854,6 +2893,7 @@ exports.SwapRouter = SwapRouter;
 exports.Trade = Trade;
 exports.V2_FEE_PATH_PLACEHOLDER = V2_FEE_PATH_PLACEHOLDER;
 exports.ZERO = ZERO;
+exports.ZERO_PERCENT = ZERO_PERCENT;
 exports.encodeMixedRouteToPath = encodeMixedRouteToPath;
 exports.getOutputOfPools = getOutputOfPools;
 exports.isMint = isMint;