@uniswap/universal-router-sdk 4.1.1 → 4.3.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { SwapRouter } from './swapRouter';
+export { SwapRouter, MigrateV3ToV4Options } from './swapRouter';
 export * from './entities';
 export * from './utils/routerTradeAdapter';
 export { RoutePlanner, CommandType } from './utils/routerCommands';

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

@@ -80,7 +80,7 @@ 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 _COMMAND_ABI_DEFINITI;
+var _COMMAND_DEFINITION;
 (function (CommandType) {
   CommandType[CommandType["V3_SWAP_EXACT_IN"] = 0] = "V3_SWAP_EXACT_IN";
   CommandType[CommandType["V3_SWAP_EXACT_OUT"] = 1] = "V3_SWAP_EXACT_OUT";
@@ -107,165 +107,212 @@ var Subparser;
   Subparser[Subparser["V3PathExactIn"] = 0] = "V3PathExactIn";
   Subparser[Subparser["V3PathExactOut"] = 1] = "V3PathExactOut";
 })(Subparser || (Subparser = {}));
+var Parser;
+(function (Parser) {
+  Parser[Parser["Abi"] = 0] = "Abi";
+  Parser[Parser["V4Actions"] = 1] = "V4Actions";
+  Parser[Parser["V3Actions"] = 2] = "V3Actions";
+})(Parser || (Parser = {}));
 var ALLOW_REVERT_FLAG = 0x80;
 var REVERTIBLE_COMMANDS = /*#__PURE__*/new Set([exports.CommandType.EXECUTE_SUB_PLAN]);
 var PERMIT_STRUCT = '((address token,uint160 amount,uint48 expiration,uint48 nonce) details,address spender,uint256 sigDeadline)';
 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 COMMAND_ABI_DEFINITION = (_COMMAND_ABI_DEFINITI = {}, _COMMAND_ABI_DEFINITI[exports.CommandType.EXECUTE_SUB_PLAN] = [{
-  name: 'commands',
-  type: 'bytes'
-}, {
-  name: 'inputs',
-  type: 'bytes[]'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.PERMIT2_PERMIT] = [{
-  name: 'permit',
-  type: PERMIT_STRUCT
-}, {
-  name: 'signature',
-  type: 'bytes'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.PERMIT2_PERMIT_BATCH] = [{
-  name: 'permit',
-  type: PERMIT_BATCH_STRUCT
-}, {
-  name: 'signature',
-  type: 'bytes'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.PERMIT2_TRANSFER_FROM] = [{
-  name: 'token',
-  type: 'address'
-}, {
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amount',
-  type: 'uint160'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.PERMIT2_TRANSFER_FROM_BATCH] = [{
-  name: 'transferFrom',
-  type: PERMIT2_TRANSFER_FROM_BATCH_STRUCT
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V3_SWAP_EXACT_IN] = [{
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amountIn',
-  type: 'uint256'
-}, {
-  name: 'amountOutMin',
-  type: 'uint256'
-}, {
-  name: 'path',
-  subparser: Subparser.V3PathExactIn,
-  type: 'bytes'
-}, {
-  name: 'payerIsUser',
-  type: 'bool'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V3_SWAP_EXACT_OUT] = [{
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amountOut',
-  type: 'uint256'
-}, {
-  name: 'amountInMax',
-  type: 'uint256'
-}, {
-  name: 'path',
-  subparser: Subparser.V3PathExactOut,
-  type: 'bytes'
-}, {
-  name: 'payerIsUser',
-  type: 'bool'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V2_SWAP_EXACT_IN] = [{
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amountIn',
-  type: 'uint256'
-}, {
-  name: 'amountOutMin',
-  type: 'uint256'
-}, {
-  name: 'path',
-  type: 'address[]'
-}, {
-  name: 'payerIsUser',
-  type: 'bool'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V2_SWAP_EXACT_OUT] = [{
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amountOut',
-  type: 'uint256'
-}, {
-  name: 'amountInMax',
-  type: 'uint256'
-}, {
-  name: 'path',
-  type: 'address[]'
-}, {
-  name: 'payerIsUser',
-  type: 'bool'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V4_SWAP] = [{
-  name: 'command',
-  type: 'bytes'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.WRAP_ETH] = [{
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amount',
-  type: 'uint256'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.UNWRAP_WETH] = [{
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amountMin',
-  type: 'uint256'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.SWEEP] = [{
-  name: 'token',
-  type: 'address'
-}, {
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'amountMin',
-  type: 'uint256'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.TRANSFER] = [{
-  name: 'token',
-  type: 'address'
-}, {
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'value',
-  type: 'uint256'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.PAY_PORTION] = [{
-  name: 'token',
-  type: 'address'
-}, {
-  name: 'recipient',
-  type: 'address'
-}, {
-  name: 'bips',
-  type: 'uint256'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.BALANCE_CHECK_ERC20] = [{
-  name: 'owner',
-  type: 'address'
-}, {
-  name: 'token',
-  type: 'address'
-}, {
-  name: 'minBalance',
-  type: 'uint256'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V3_POSITION_MANAGER_PERMIT] = [{
-  name: 'calldata',
-  type: 'bytes'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V3_POSITION_MANAGER_CALL] = [{
-  name: 'calldata',
-  type: 'bytes'
-}], _COMMAND_ABI_DEFINITI[exports.CommandType.V4_POSITION_CALL] = [{
-  name: 'calldata',
-  type: 'bytes'
-}], _COMMAND_ABI_DEFINITI);
+var COMMAND_DEFINITION = (_COMMAND_DEFINITION = {}, _COMMAND_DEFINITION[exports.CommandType.EXECUTE_SUB_PLAN] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'commands',
+    type: 'bytes'
+  }, {
+    name: 'inputs',
+    type: 'bytes[]'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.PERMIT2_PERMIT] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'permit',
+    type: PERMIT_STRUCT
+  }, {
+    name: 'signature',
+    type: 'bytes'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.PERMIT2_PERMIT_BATCH] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'permit',
+    type: PERMIT_BATCH_STRUCT
+  }, {
+    name: 'signature',
+    type: 'bytes'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.PERMIT2_TRANSFER_FROM] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'token',
+    type: 'address'
+  }, {
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amount',
+    type: 'uint160'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.PERMIT2_TRANSFER_FROM_BATCH] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'transferFrom',
+    type: PERMIT2_TRANSFER_FROM_BATCH_STRUCT
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.V3_SWAP_EXACT_IN] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amountIn',
+    type: 'uint256'
+  }, {
+    name: 'amountOutMin',
+    type: 'uint256'
+  }, {
+    name: 'path',
+    subparser: Subparser.V3PathExactIn,
+    type: 'bytes'
+  }, {
+    name: 'payerIsUser',
+    type: 'bool'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.V3_SWAP_EXACT_OUT] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amountOut',
+    type: 'uint256'
+  }, {
+    name: 'amountInMax',
+    type: 'uint256'
+  }, {
+    name: 'path',
+    subparser: Subparser.V3PathExactOut,
+    type: 'bytes'
+  }, {
+    name: 'payerIsUser',
+    type: 'bool'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.V2_SWAP_EXACT_IN] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amountIn',
+    type: 'uint256'
+  }, {
+    name: 'amountOutMin',
+    type: 'uint256'
+  }, {
+    name: 'path',
+    type: 'address[]'
+  }, {
+    name: 'payerIsUser',
+    type: 'bool'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.V2_SWAP_EXACT_OUT] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amountOut',
+    type: 'uint256'
+  }, {
+    name: 'amountInMax',
+    type: 'uint256'
+  }, {
+    name: 'path',
+    type: 'address[]'
+  }, {
+    name: 'payerIsUser',
+    type: 'bool'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.V4_SWAP] = {
+  parser: Parser.V4Actions
+}, _COMMAND_DEFINITION[exports.CommandType.WRAP_ETH] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amount',
+    type: 'uint256'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.UNWRAP_WETH] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amountMin',
+    type: 'uint256'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.SWEEP] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'token',
+    type: 'address'
+  }, {
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'amountMin',
+    type: 'uint256'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.TRANSFER] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'token',
+    type: 'address'
+  }, {
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'value',
+    type: 'uint256'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.PAY_PORTION] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'token',
+    type: 'address'
+  }, {
+    name: 'recipient',
+    type: 'address'
+  }, {
+    name: 'bips',
+    type: 'uint256'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.BALANCE_CHECK_ERC20] = {
+  parser: Parser.Abi,
+  params: [{
+    name: 'owner',
+    type: 'address'
+  }, {
+    name: 'token',
+    type: 'address'
+  }, {
+    name: 'minBalance',
+    type: 'uint256'
+  }]
+}, _COMMAND_DEFINITION[exports.CommandType.V3_POSITION_MANAGER_PERMIT] = {
+  parser: Parser.V3Actions
+}, _COMMAND_DEFINITION[exports.CommandType.V3_POSITION_MANAGER_CALL] = {
+  parser: Parser.V3Actions
+}, _COMMAND_DEFINITION[exports.CommandType.V4_POSITION_CALL] = {
+  parser: Parser.V4Actions
+}, _COMMAND_DEFINITION);
 var RoutePlanner = /*#__PURE__*/function () {
   function RoutePlanner() {
     this.commands = '0x';
@@ -294,19 +341,29 @@ var RoutePlanner = /*#__PURE__*/function () {
   return RoutePlanner;
 }();
 function createCommand(type, parameters) {
-  if (type === exports.CommandType.V4_SWAP || type === exports.CommandType.V3_POSITION_MANAGER_CALL || type === exports.CommandType.V3_POSITION_MANAGER_PERMIT || type === exports.CommandType.V4_POSITION_CALL) {
-    return {
-      type: type,
-      encodedInput: parameters[0]
-    };
+  var commandDef = COMMAND_DEFINITION[type];
+  switch (commandDef.parser) {
+    case Parser.Abi:
+      var encodedInput = utils.defaultAbiCoder.encode(commandDef.params.map(function (abi) {
+        return abi.type;
+      }), parameters);
+      return {
+        type: type,
+        encodedInput: encodedInput
+      };
+    case Parser.V4Actions:
+      // v4 swap data comes pre-encoded at index 0
+      return {
+        type: type,
+        encodedInput: parameters[0]
+      };
+    case Parser.V3Actions:
+      // v4 swap data comes pre-encoded at index 0
+      return {
+        type: type,
+        encodedInput: parameters[0]
+      };
   }
-  var encodedInput = utils.defaultAbiCoder.encode(COMMAND_ABI_DEFINITION[type].map(function (abi) {
-    return abi.type;
-  }), parameters);
-  return {
-    type: type,
-    encodedInput: encodedInput
-  };
 }
 
 (function (RouterActionType) {
@@ -1046,34 +1103,54 @@ var CommandParser = /*#__PURE__*/function () {
     var commandTypes = CommandParser.getCommands(commands);
     return {
       commands: commandTypes.map(function (commandType, i) {
-        var abiDef = COMMAND_ABI_DEFINITION[commandType];
-        var rawParams = ethers.ethers.utils.defaultAbiCoder.decode(abiDef.map(function (command) {
-          return command.type;
-        }), inputs[i]);
-        var params = rawParams.map(function (param, j) {
-          switch (abiDef[j].subparser) {
-            case Subparser.V3PathExactIn:
-              return {
-                name: abiDef[j].name,
-                value: parseV3PathExactIn(param)
-              };
-            case Subparser.V3PathExactOut:
-              return {
-                name: abiDef[j].name,
-                value: parseV3PathExactOut(param)
-              };
-            default:
-              return {
-                name: abiDef[j].name,
-                value: param
-              };
-          }
-        });
-        return {
-          commandName: exports.CommandType[commandType],
-          commandType: commandType,
-          params: params
-        };
+        var commandDef = COMMAND_DEFINITION[commandType];
+        if (commandDef.parser === Parser.V4Actions) {
+          var _V4BaseActionsParser$ = v4Sdk.V4BaseActionsParser.parseCalldata(inputs[i]),
+            actions = _V4BaseActionsParser$.actions;
+          return {
+            commandName: exports.CommandType[commandType],
+            commandType: commandType,
+            params: v4RouterCallToParams(actions)
+          };
+        } else if (commandDef.parser === Parser.Abi) {
+          var abiDef = commandDef.params;
+          var rawParams = ethers.ethers.utils.defaultAbiCoder.decode(abiDef.map(function (command) {
+            return command.type;
+          }), inputs[i]);
+          var params = rawParams.map(function (param, j) {
+            switch (abiDef[j].subparser) {
+              case Subparser.V3PathExactIn:
+                return {
+                  name: abiDef[j].name,
+                  value: parseV3PathExactIn(param)
+                };
+              case Subparser.V3PathExactOut:
+                return {
+                  name: abiDef[j].name,
+                  value: parseV3PathExactOut(param)
+                };
+              default:
+                return {
+                  name: abiDef[j].name,
+                  value: param
+                };
+            }
+          });
+          return {
+            commandName: exports.CommandType[commandType],
+            commandType: commandType,
+            params: params
+          };
+        } else if (commandDef.parser === Parser.V3Actions) {
+          // TODO: implement better parsing here
+          return {
+            commandName: exports.CommandType[commandType],
+            commandType: commandType,
+            params: inputs
+          };
+        } else {
+          throw new Error("Unsupported parser: " + commandDef);
+        }
       })
     };
   }
@@ -1128,6 +1205,19 @@ function parseV3PathExactOut(path) {
   }
   return res;
 }
+function v4RouterCallToParams(actions) {
+  return actions.map(function (action) {
+    return {
+      name: action.actionName,
+      value: action.params.map(function (param) {
+        return {
+          name: param.name,
+          value: param.value
+        };
+      })
+    };
+  });
+}
 
 exports.CommandParser = CommandParser;
 exports.ROUTER_AS_RECIPIENT = ROUTER_AS_RECIPIENT;