@uniswap/universal-router-sdk 1.5.6 → 1.5.8

package/dist/entities/protocols/uniswap.d.ts

@@ -3,8 +3,14 @@ import { Trade as RouterTrade, SwapOptions as RouterSwapOptions } from '@uniswap
 import { Permit2Permit } from '../../utils/inputTokens';
 import { Currency, TradeType } from '@uniswap/sdk-core';
 import { Command, RouterTradeType, TradeConfig } from '../Command';
+import { BigNumberish } from 'ethers';
+export declare type FlatFeeOptions = {
+    amount: BigNumberish;
+    recipient: string;
+};
 export declare type SwapOptions = Omit<RouterSwapOptions, 'inputTokenPermit'> & {
     inputTokenPermit?: Permit2Permit;
+    flatFee?: FlatFeeOptions;
 };
 export declare class UniswapTrade implements Command {
     trade: RouterTrade<Currency, Currency, TradeType>;

package/dist/test/utils/addresses.d.ts

@@ -3,5 +3,6 @@ export declare const FORGE_ROUTER_ADDRESS = "0xe808c1cfeebb6cb36b537b82fa7c9eef3
 export declare const FORGE_PERMIT2_ADDRESS = "0x4a873bdd49f7f9cc0a5458416a12973fab208f8d";
 export declare const FORGE_SENDER_ADDRESS = "0xcf03dd0a894ef79cb5b601a43c4b25e3ae4c67ed";
 export declare const TEST_RECIPIENT_ADDRESS = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
+export declare const TEST_FEE_RECIPIENT_ADDRESS = "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
 export declare const PERMIT2_ADDRESS: string;
 export declare const ROUTER_ADDRESS: string;

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

@@ -8,12 +8,13 @@ var invariant = _interopDefault(require('tiny-invariant'));
 var UniversalRouter_json = require('@uniswap/universal-router/artifacts/contracts/UniversalRouter.sol/UniversalRouter.json');
 var abi$7 = require('@ethersproject/abi');
 var ethers = require('ethers');
-var JSBI = _interopDefault(require('jsbi'));
 var utils = require('ethers/lib/utils');
 var v2Sdk = require('@uniswap/v2-sdk');
 var v3Sdk = require('@uniswap/v3-sdk');
 var routerSdk = require('@uniswap/router-sdk');
 var sdkCore = require('@uniswap/sdk-core');
+require('jsbi');
+require('bignumber.js');
 
 function _extends() {
   _extends = Object.assign ? Object.assign.bind() : function (target) {
@@ -199,53 +200,53 @@ var CHAIN_CONFIGS = (_CHAIN_CONFIGS = {}, _CHAIN_CONFIGS[1] = {
   weth: '0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14',
   creationBlock: 3543575
 }, _CHAIN_CONFIGS[137] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0x643770E279d5D0733F21d6DC03A8efbABf3255B4',
   weth: '0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270',
-  creationBlock: 42294741
+  creationBlock: 46866777
 }, _CHAIN_CONFIGS[80001] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0x9c3C9283D3e44854697Cd22D3Faa240Cfb032889',
   creationBlock: 35176052
 }, _CHAIN_CONFIGS[10] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0x4200000000000000000000000000000000000006',
-  creationBlock: 96333990
+  creationBlock: 108825869
 }, _CHAIN_CONFIGS[420] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0x4200000000000000000000000000000000000006',
   creationBlock: 8887728
 }, _CHAIN_CONFIGS[42161] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0x82aF49447D8a07e3bd95BD0d56f35241523fBab1',
-  creationBlock: 87206402
+  creationBlock: 125861718
 }, _CHAIN_CONFIGS[421613] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0xe39Ab88f8A4777030A534146A9Ca3B52bd5D43A3',
   creationBlock: 18815277
 }, _CHAIN_CONFIGS[42220] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0x88a3ED7F21A3fCF6adb86b6F878C5B7a02D20e9b',
   weth: WETH_NOT_SUPPORTED_ON_CHAIN,
-  creationBlock: 19106929
+  creationBlock: 21116361
 }, _CHAIN_CONFIGS[44787] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: WETH_NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 17566658
 }, _CHAIN_CONFIGS[56] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c',
-  creationBlock: 27915533
+  creationBlock: 31254967
 }, _CHAIN_CONFIGS[43114] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0x82635AF6146972cD6601161c4472ffe97237D292',
   weth: '0xB31f66AA3C1e785363F0875A1B74E27b85FD66c7',
-  creationBlock: 31583684
+  creationBlock: 34491144
 }, _CHAIN_CONFIGS[84531] = {
   router: '0xd0872d928672ae2ff74bdb2f5130ac12229cafaf',
   weth: '0x4200000000000000000000000000000000000006',
   creationBlock: 6915289
 }, _CHAIN_CONFIGS[8453] = {
-  router: '0x198EF79F1F515F02dFE9e3115eD9fC07183f02fC',
+  router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0x4200000000000000000000000000000000000006',
-  creationBlock: 1452376
+  creationBlock: 3229053
 }, _CHAIN_CONFIGS);
 var UNIVERSAL_ROUTER_ADDRESS = function UNIVERSAL_ROUTER_ADDRESS(chainId) {
   if (!(chainId in CHAIN_CONFIGS)) throw new Error("Universal Router not deployed on chain " + chainId);
@@ -269,7 +270,11 @@ var ROUTER_AS_RECIPIENT = '0x0000000000000000000000000000000000000002';
 var OPENSEA_CONDUIT_SPENDER_ID = 0;
 var SUDOSWAP_SPENDER_ID = 1;
 
-var REFUND_ETH_PRICE_IMPACT_THRESHOLD = /*#__PURE__*/new sdkCore.Percent( /*#__PURE__*/JSBI.BigInt(50), /*#__PURE__*/JSBI.BigInt(100));
+function encodeFeeBips(fee) {
+  return v3Sdk.toHex(fee.multiply(10000).quotient);
+}
+
+var REFUND_ETH_PRICE_IMPACT_THRESHOLD = /*#__PURE__*/new sdkCore.Percent(50, 100);
 // Wrapper for uniswap router-sdk trade entity to encode swaps for Universal Router
 // also translates trade objects from previous (v2, v3) SDKs
 var UniswapTrade = /*#__PURE__*/function () {
@@ -277,17 +282,20 @@ var UniswapTrade = /*#__PURE__*/function () {
     this.trade = trade;
     this.options = options;
     this.tradeType = exports.RouterTradeType.UniswapTrade;
+    if (!!options.fee && !!options.flatFee) throw new Error('Only one fee option permitted');
   }
   var _proto = UniswapTrade.prototype;
   _proto.encode = function encode(planner, _config) {
     var _this$options$recipie;
     var payerIsUser = true;
+    // If the input currency is the native currency, we need to wrap it with the router as the recipient
     if (this.trade.inputAmount.currency.isNative) {
       // TODO: optimize if only one v2 pool we can directly send this to the pool
       planner.addCommand(CommandType.WRAP_ETH, [ROUTER_AS_RECIPIENT, this.trade.maximumAmountIn(this.options.slippageTolerance).quotient.toString()]);
       // since WETH is now owned by the router, the router pays for inputs
       payerIsUser = false;
     }
+    // The overall recipient at the end of the trade, SENDER_AS_RECIPIENT uses the msg.sender
     this.options.recipient = (_this$options$recipie = this.options.recipient) != null ? _this$options$recipie : SENDER_AS_RECIPIENT;
     // flag for whether we want to perform slippage check on aggregate output of multiple routes
     //   1. when there are >2 exact input trades. this is only a heuristic,
@@ -296,7 +304,7 @@ var UniswapTrade = /*#__PURE__*/function () {
     var performAggregatedSlippageCheck = this.trade.tradeType === sdkCore.TradeType.EXACT_INPUT && this.trade.routes.length > 2;
     var outputIsNative = this.trade.outputAmount.currency.isNative;
     var inputIsNative = this.trade.inputAmount.currency.isNative;
-    var routerMustCustody = performAggregatedSlippageCheck || outputIsNative;
+    var routerMustCustody = performAggregatedSlippageCheck || outputIsNative || hasFeeOption(this.options);
     for (var _iterator = _createForOfIteratorHelperLoose(this.trade.swaps), _step; !(_step = _iterator()).done;) {
       var swap = _step.value;
       switch (swap.route.protocol) {
@@ -313,11 +321,38 @@ var UniswapTrade = /*#__PURE__*/function () {
           throw new Error('UNSUPPORTED_TRADE_PROTOCOL');
       }
     }
+    var minimumAmountOut = ethers.BigNumber.from(this.trade.minimumAmountOut(this.options.slippageTolerance).quotient.toString());
+    // The router custodies for 3 reasons: to unwrap, to take a fee, and/or to do a slippage check
     if (routerMustCustody) {
+      // If there is a fee, that percentage is sent to the fee recipient
+      // In the case where ETH is the output currency, the fee is taken in WETH (for gas reasons)
+      if (!!this.options.fee) {
+        var feeBips = encodeFeeBips(this.options.fee.fee);
+        planner.addCommand(CommandType.PAY_PORTION, [this.trade.outputAmount.currency.wrapped.address, this.options.fee.recipient, feeBips]);
+        // If the trade is exact output, and a fee was taken, we must adjust the amount out to be the amount after the fee
+        // Otherwise we continue as expected with the trade's normal expected output
+        if (this.trade.tradeType === sdkCore.TradeType.EXACT_OUTPUT) {
+          minimumAmountOut = minimumAmountOut.sub(minimumAmountOut.mul(feeBips).div(10000));
+        }
+      }
+      // If there is a flat fee, that absolute amount is sent to the fee recipient
+      // In the case where ETH is the output currency, the fee is taken in WETH (for gas reasons)
+      if (!!this.options.flatFee) {
+        var feeAmount = this.options.flatFee.amount;
+        if (minimumAmountOut.lt(feeAmount)) throw new Error('Flat fee amount greater than minimumAmountOut');
+        planner.addCommand(CommandType.TRANSFER, [this.trade.outputAmount.currency.wrapped.address, this.options.flatFee.recipient, feeAmount]);
+        // If the trade is exact output, and a fee was taken, we must adjust the amount out to be the amount after the fee
+        // Otherwise we continue as expected with the trade's normal expected output
+        if (this.trade.tradeType === sdkCore.TradeType.EXACT_OUTPUT) {
+          minimumAmountOut = minimumAmountOut.sub(feeAmount);
+        }
+      }
+      // The remaining tokens that need to be sent to the user after the fee is taken will be caught
+      // by this if-else clause.
       if (outputIsNative) {
-        planner.addCommand(CommandType.UNWRAP_WETH, [this.options.recipient, this.trade.minimumAmountOut(this.options.slippageTolerance).quotient.toString()]);
+        planner.addCommand(CommandType.UNWRAP_WETH, [this.options.recipient, minimumAmountOut]);
       } else {
-        planner.addCommand(CommandType.SWEEP, [this.trade.outputAmount.currency.wrapped.address, this.options.recipient, this.trade.minimumAmountOut(this.options.slippageTolerance).quotient.toString()]);
+        planner.addCommand(CommandType.SWEEP, [this.trade.outputAmount.currency.wrapped.address, this.options.recipient, minimumAmountOut]);
       }
     }
     if (inputIsNative && (this.trade.tradeType === sdkCore.TradeType.EXACT_OUTPUT || riskOfPartialFill(this.trade))) {
@@ -426,6 +461,9 @@ function addMixedSwap(planner, swap, tradeType, options, payerIsUser, routerMust
 function riskOfPartialFill(trade) {
   return trade.priceImpact.greaterThan(REFUND_ETH_PRICE_IMPACT_THRESHOLD);
 }
+function hasFeeOption(swapOptions) {
+  return !!swapOptions.fee || !!swapOptions.flatFee;
+}
 
 var SIGNATURE_LENGTH = 65;
 var EIP_2098_SIGNATURE_LENGTH = 64;