@uniswap/universal-router-sdk 1.5.8 → 2.0.1

package/dist/universal-router-sdk.esm.js

@@ -73,6 +73,8 @@ var RouterTradeType;
   RouterTradeType["UniswapTrade"] = "UniswapTrade";
   RouterTradeType["NFTTrade"] = "NFTTrade";
   RouterTradeType["UnwrapWETH"] = "UnwrapWETH";
+  RouterTradeType["WrapSTETH"] = "WrapSTETH";
+  RouterTradeType["UnwrapSTETH"] = "UnwrapSTETH";
 })(RouterTradeType || (RouterTradeType = {}));
 
 var NFTTrade = function NFTTrade(market, orders) {
@@ -141,6 +143,8 @@ var CommandType;
   CommandType[CommandType["SEAPORT_V1_4"] = 32] = "SEAPORT_V1_4";
   CommandType[CommandType["EXECUTE_SUB_PLAN"] = 33] = "EXECUTE_SUB_PLAN";
   CommandType[CommandType["APPROVE_ERC20"] = 34] = "APPROVE_ERC20";
+  CommandType[CommandType["WRAP_STETH"] = 35] = "WRAP_STETH";
+  CommandType[CommandType["UNWRAP_STETH"] = 36] = "UNWRAP_STETH";
 })(CommandType || (CommandType = {}));
 var ALLOW_REVERT_FLAG = 0x80;
 var REVERTIBLE_COMMANDS = /*#__PURE__*/new Set([CommandType.SEAPORT_V1_5, CommandType.SEAPORT_V1_4, CommandType.NFTX, CommandType.LOOKS_RARE_V2, CommandType.X2Y2_721, CommandType.X2Y2_1155, CommandType.FOUNDATION, CommandType.SUDOSWAP, CommandType.NFT20, CommandType.EXECUTE_SUB_PLAN, CommandType.CRYPTOPUNKS, CommandType.ELEMENT_MARKET]);
@@ -148,7 +152,7 @@ var PERMIT_STRUCT = '((address token,uint160 amount,uint48 expiration,uint48 non
 var PERMIT_BATCH_STRUCT = '((address token,uint160 amount,uint48 expiration,uint48 nonce)[] details,address spender,uint256 sigDeadline)';
 var PERMIT2_TRANSFER_FROM_STRUCT = '(address from,address to,uint160 amount,address token)';
 var PERMIT2_TRANSFER_FROM_BATCH_STRUCT = PERMIT2_TRANSFER_FROM_STRUCT + '[]';
-var ABI_DEFINITION = (_ABI_DEFINITION = {}, _ABI_DEFINITION[CommandType.EXECUTE_SUB_PLAN] = ['bytes', 'bytes[]'], _ABI_DEFINITION[CommandType.PERMIT2_PERMIT] = [PERMIT_STRUCT, 'bytes'], _ABI_DEFINITION[CommandType.PERMIT2_PERMIT_BATCH] = [PERMIT_BATCH_STRUCT, 'bytes'], _ABI_DEFINITION[CommandType.PERMIT2_TRANSFER_FROM] = ['address', 'address', 'uint160'], _ABI_DEFINITION[CommandType.PERMIT2_TRANSFER_FROM_BATCH] = [PERMIT2_TRANSFER_FROM_BATCH_STRUCT], _ABI_DEFINITION[CommandType.V3_SWAP_EXACT_IN] = ['address', 'uint256', 'uint256', 'bytes', 'bool'], _ABI_DEFINITION[CommandType.V3_SWAP_EXACT_OUT] = ['address', 'uint256', 'uint256', 'bytes', 'bool'], _ABI_DEFINITION[CommandType.V2_SWAP_EXACT_IN] = ['address', 'uint256', 'uint256', 'address[]', 'bool'], _ABI_DEFINITION[CommandType.V2_SWAP_EXACT_OUT] = ['address', 'uint256', 'uint256', 'address[]', 'bool'], _ABI_DEFINITION[CommandType.WRAP_ETH] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.UNWRAP_WETH] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.SWEEP] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.SWEEP_ERC721] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.SWEEP_ERC1155] = ['address', 'address', 'uint256', 'uint256'], _ABI_DEFINITION[CommandType.TRANSFER] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.PAY_PORTION] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.BALANCE_CHECK_ERC20] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.OWNER_CHECK_721] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.OWNER_CHECK_1155] = ['address', 'address', 'uint256', 'uint256'], _ABI_DEFINITION[CommandType.APPROVE_ERC20] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.SEAPORT_V1_5] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.SEAPORT_V1_4] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.NFTX] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.LOOKS_RARE_V2] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.X2Y2_721] = ['uint256', 'bytes', 'address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.X2Y2_1155] = ['uint256', 'bytes', 'address', 'address', 'uint256', 'uint256'], _ABI_DEFINITION[CommandType.FOUNDATION] = ['uint256', 'bytes', 'address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.SUDOSWAP] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.NFT20] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.CRYPTOPUNKS] = ['uint256', 'address', 'uint256'], _ABI_DEFINITION[CommandType.ELEMENT_MARKET] = ['uint256', 'bytes'], _ABI_DEFINITION);
+var ABI_DEFINITION = (_ABI_DEFINITION = {}, _ABI_DEFINITION[CommandType.EXECUTE_SUB_PLAN] = ['bytes', 'bytes[]'], _ABI_DEFINITION[CommandType.PERMIT2_PERMIT] = [PERMIT_STRUCT, 'bytes'], _ABI_DEFINITION[CommandType.PERMIT2_PERMIT_BATCH] = [PERMIT_BATCH_STRUCT, 'bytes'], _ABI_DEFINITION[CommandType.PERMIT2_TRANSFER_FROM] = ['address', 'address', 'uint160'], _ABI_DEFINITION[CommandType.PERMIT2_TRANSFER_FROM_BATCH] = [PERMIT2_TRANSFER_FROM_BATCH_STRUCT], _ABI_DEFINITION[CommandType.V3_SWAP_EXACT_IN] = ['address', 'uint256', 'uint256', 'bytes', 'bool'], _ABI_DEFINITION[CommandType.V3_SWAP_EXACT_OUT] = ['address', 'uint256', 'uint256', 'bytes', 'bool'], _ABI_DEFINITION[CommandType.V2_SWAP_EXACT_IN] = ['address', 'uint256', 'uint256', 'address[]', 'bool'], _ABI_DEFINITION[CommandType.V2_SWAP_EXACT_OUT] = ['address', 'uint256', 'uint256', 'address[]', 'bool'], _ABI_DEFINITION[CommandType.WRAP_ETH] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.UNWRAP_WETH] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.SWEEP] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.SWEEP_ERC721] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.SWEEP_ERC1155] = ['address', 'address', 'uint256', 'uint256'], _ABI_DEFINITION[CommandType.TRANSFER] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.PAY_PORTION] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.BALANCE_CHECK_ERC20] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.OWNER_CHECK_721] = ['address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.OWNER_CHECK_1155] = ['address', 'address', 'uint256', 'uint256'], _ABI_DEFINITION[CommandType.APPROVE_ERC20] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.WRAP_STETH] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.UNWRAP_STETH] = ['address', 'uint256'], _ABI_DEFINITION[CommandType.SEAPORT_V1_5] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.SEAPORT_V1_4] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.NFTX] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.LOOKS_RARE_V2] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.X2Y2_721] = ['uint256', 'bytes', 'address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.X2Y2_1155] = ['uint256', 'bytes', 'address', 'address', 'uint256', 'uint256'], _ABI_DEFINITION[CommandType.FOUNDATION] = ['uint256', 'bytes', 'address', 'address', 'uint256'], _ABI_DEFINITION[CommandType.SUDOSWAP] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.NFT20] = ['uint256', 'bytes'], _ABI_DEFINITION[CommandType.CRYPTOPUNKS] = ['uint256', 'address', 'uint256'], _ABI_DEFINITION[CommandType.ELEMENT_MARKET] = ['uint256', 'bytes'], _ABI_DEFINITION);
 var RoutePlanner = /*#__PURE__*/function () {
   function RoutePlanner() {
     this.commands = '0x';
@@ -183,66 +187,96 @@ function createCommand(type, parameters) {
 }
 
 var _CHAIN_CONFIGS;
-var WETH_NOT_SUPPORTED_ON_CHAIN = '0x0000000000000000000000000000000000000000';
+var NOT_SUPPORTED_ON_CHAIN = '0x0000000000000000000000000000000000000000';
 var CHAIN_CONFIGS = (_CHAIN_CONFIGS = {}, _CHAIN_CONFIGS[1] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0x3F6328669a86bef431Dc6F9201A5B90F7975a023',
   weth: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+  steth: '0xae7ab96520de3a18e5e111b5eaab095312d7fe84',
+  wsteth: '0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0',
   creationBlock: 17143817
 }, _CHAIN_CONFIGS[5] = {
-  router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
+  router: '0x3F6328669a86bef431Dc6F9201A5B90F7975a023',
   weth: '0xb4fbf271143f4fbf7b91a5ded31805e42b2208d6',
+  steth: '0x1643E812aE58766192Cf7D2Cf9567dF2C37e9B7F',
+  wsteth: '0x6320cD32aA674d2898A68ec82e869385Fc5f7E2f',
   creationBlock: 8940568
 }, _CHAIN_CONFIGS[11155111] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 3543575
 }, _CHAIN_CONFIGS[137] = {
   router: '0x643770E279d5D0733F21d6DC03A8efbABf3255B4',
   weth: '0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 46866777
 }, _CHAIN_CONFIGS[80001] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0x9c3C9283D3e44854697Cd22D3Faa240Cfb032889',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 35176052
 }, _CHAIN_CONFIGS[10] = {
   router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0x4200000000000000000000000000000000000006',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 108825869
 }, _CHAIN_CONFIGS[420] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0x4200000000000000000000000000000000000006',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 8887728
 }, _CHAIN_CONFIGS[42161] = {
   router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0x82aF49447D8a07e3bd95BD0d56f35241523fBab1',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 125861718
 }, _CHAIN_CONFIGS[421613] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
   weth: '0xe39Ab88f8A4777030A534146A9Ca3B52bd5D43A3',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 18815277
 }, _CHAIN_CONFIGS[42220] = {
   router: '0x88a3ED7F21A3fCF6adb86b6F878C5B7a02D20e9b',
-  weth: WETH_NOT_SUPPORTED_ON_CHAIN,
+  weth: NOT_SUPPORTED_ON_CHAIN,
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 21116361
 }, _CHAIN_CONFIGS[44787] = {
   router: '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD',
-  weth: WETH_NOT_SUPPORTED_ON_CHAIN,
+  weth: NOT_SUPPORTED_ON_CHAIN,
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 17566658
 }, _CHAIN_CONFIGS[56] = {
   router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 31254967
 }, _CHAIN_CONFIGS[43114] = {
   router: '0x82635AF6146972cD6601161c4472ffe97237D292',
   weth: '0xB31f66AA3C1e785363F0875A1B74E27b85FD66c7',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 34491144
 }, _CHAIN_CONFIGS[84531] = {
   router: '0xd0872d928672ae2ff74bdb2f5130ac12229cafaf',
   weth: '0x4200000000000000000000000000000000000006',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 6915289
 }, _CHAIN_CONFIGS[8453] = {
   router: '0xeC8B0F7Ffe3ae75d7FfAb09429e3675bb63503e4',
   weth: '0x4200000000000000000000000000000000000006',
+  steth: NOT_SUPPORTED_ON_CHAIN,
+  wsteth: NOT_SUPPORTED_ON_CHAIN,
   creationBlock: 3229053
 }, _CHAIN_CONFIGS);
 var UNIVERSAL_ROUTER_ADDRESS = function UNIVERSAL_ROUTER_ADDRESS(chainId) {
@@ -255,9 +289,14 @@ var UNIVERSAL_ROUTER_CREATION_BLOCK = function UNIVERSAL_ROUTER_CREATION_BLOCK(c
 };
 var WETH_ADDRESS = function WETH_ADDRESS(chainId) {
   if (!(chainId in CHAIN_CONFIGS)) throw new Error("Universal Router not deployed on chain " + chainId);
-  if (CHAIN_CONFIGS[chainId].weth == WETH_NOT_SUPPORTED_ON_CHAIN) throw new Error("Chain " + chainId + " does not have WETH");
+  if (CHAIN_CONFIGS[chainId].weth == NOT_SUPPORTED_ON_CHAIN) throw new Error("Chain " + chainId + " does not have WETH");
   return CHAIN_CONFIGS[chainId].weth;
 };
+var STETH_ADDRESS = function STETH_ADDRESS(chainId) {
+  if (!(chainId in CHAIN_CONFIGS)) throw new Error("Universal Router not deployed on chain " + chainId);
+  if (CHAIN_CONFIGS[chainId].steth == NOT_SUPPORTED_ON_CHAIN) throw new Error("Chain " + chainId + " does not have STETH support");
+  return CHAIN_CONFIGS[chainId].steth;
+};
 var PERMIT2_ADDRESS = '0x000000000022D473030F116dDEE9F6B43aC78BA3';
 var CONTRACT_BALANCE = /*#__PURE__*/BigNumber.from(2).pow(255);
 var ETH_ADDRESS = '0x0000000000000000000000000000000000000000';
@@ -284,7 +323,7 @@ var UniswapTrade = /*#__PURE__*/function () {
   var _proto = UniswapTrade.prototype;
   _proto.encode = function encode(planner, _config) {
     var _this$options$recipie;
-    var payerIsUser = true;
+    var payerIsUser = !this.options.payerIsRouter;
     // 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
@@ -587,11 +626,18 @@ var SwapRouter = /*#__PURE__*/function () {
           allowRevert: false
         });
         currentNativeValueInRouter = currentNativeValueInRouter.add(UnwrapWETH.amount);
+        /**
+         * is (Un)WrapSTETH
+         */
+      } else if (trade.tradeType == RouterTradeType.WrapSTETH || trade.tradeType == RouterTradeType.UnwrapSTETH) {
+        trade.encode(planner, {
+          allowRevert: false
+        });
         /**
          * else
          */
       } else {
-        throw 'trade must be of instance: UniswapTrade or NFTTrade';
+        throw 'trade must be of instance: UniswapTrade, NFTTrade, UnwrapWETH, WrapSTETH';
       }
     }
     // TODO: matches current logic for now, but should eventually only sweep for multiple NFT trades
@@ -10544,5 +10590,45 @@ var UnwrapWETH = /*#__PURE__*/function () {
   return UnwrapWETH;
 }();
 
-export { CryptopunkTrade, FoundationTrade, LooksRareV2Trade, Market, NFT20Trade, NFTTrade, NFTXTrade, PERMIT2_ADDRESS, ROUTER_AS_RECIPIENT, RouterTradeType, SeaportTrade, SudoswapTrade, SwapRouter, TokenType, UNIVERSAL_ROUTER_ADDRESS, UNIVERSAL_ROUTER_CREATION_BLOCK, UniswapTrade, UnwrapWETH, WETH_ADDRESS, X2Y2Trade };
+var WrapSTETH = /*#__PURE__*/function () {
+  function WrapSTETH(amount, chainId, permit2, wrapAmount) {
+    this.tradeType = RouterTradeType.WrapSTETH;
+    this.stethAddress = STETH_ADDRESS(chainId);
+    this.amount = amount;
+    this.wrapAmount = wrapAmount != null ? wrapAmount : CONTRACT_BALANCE;
+    if (!!permit2) {
+      !(permit2.details.token.toLowerCase() === this.stethAddress.toLowerCase()) ? process.env.NODE_ENV !== "production" ? invariant(false, "must be permitting STETH address: " + this.stethAddress) : invariant(false) : void 0;
+      !(permit2.details.amount >= amount) ? process.env.NODE_ENV !== "production" ? invariant(false, "Did not permit enough STETH for unwrapSTETH transaction") : invariant(false) : void 0;
+      this.permit2Data = permit2;
+    }
+  }
+  var _proto = WrapSTETH.prototype;
+  _proto.encode = function encode(planner, _) {
+    encodeInputTokenOptions(planner, {
+      permit2Permit: this.permit2Data,
+      permit2TransferFrom: {
+        token: this.stethAddress,
+        amount: this.amount.toString()
+      }
+    });
+    planner.addCommand(CommandType.WRAP_STETH, [ROUTER_AS_RECIPIENT, this.wrapAmount]);
+  };
+  return WrapSTETH;
+}();
+
+var UnwrapSTETH = /*#__PURE__*/function () {
+  function UnwrapSTETH(recipient, amountMinimum, chainId) {
+    this.tradeType = RouterTradeType.UnwrapSTETH;
+    this.recipient = recipient;
+    this.amountMinimum = amountMinimum;
+    !(STETH_ADDRESS(chainId) != NOT_SUPPORTED_ON_CHAIN) ? process.env.NODE_ENV !== "production" ? invariant(false, "STETH not supported on chain " + chainId) : invariant(false) : void 0;
+  }
+  var _proto = UnwrapSTETH.prototype;
+  _proto.encode = function encode(planner, _) {
+    planner.addCommand(CommandType.UNWRAP_STETH, [this.recipient, this.amountMinimum]);
+  };
+  return UnwrapSTETH;
+}();
+
+export { CommandType, CryptopunkTrade, FoundationTrade, LooksRareV2Trade, Market, NFT20Trade, NFTTrade, NFTXTrade, PERMIT2_ADDRESS, ROUTER_AS_RECIPIENT, RoutePlanner, RouterTradeType, SeaportTrade, SudoswapTrade, SwapRouter, TokenType, UNIVERSAL_ROUTER_ADDRESS, UNIVERSAL_ROUTER_CREATION_BLOCK, UniswapTrade, UnwrapSTETH, UnwrapWETH, WETH_ADDRESS, WrapSTETH, X2Y2Trade };
 //# sourceMappingURL=universal-router-sdk.esm.js.map