@uniswap/universal-router-sdk 3.3.0 → 3.4.0

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './entities';
 export * from './utils/routerTradeAdapter';
 export { RoutePlanner, CommandType } from './utils/routerCommands';
 export { UNIVERSAL_ROUTER_CREATION_BLOCK, UNIVERSAL_ROUTER_ADDRESS, PERMIT2_ADDRESS, ROUTER_AS_RECIPIENT, WETH_ADDRESS, UniversalRouterVersion, } from './utils/constants';
+export { CommandParser, UniversalRouterCommand, UniversalRouterCall, Param } from './utils/commandParser';

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 _ABI_DEFINITION;
+var _COMMAND_ABI_DEFINITI;
 (function (CommandType) {
   CommandType[CommandType["V3_SWAP_EXACT_IN"] = 0] = "V3_SWAP_EXACT_IN";
   CommandType[CommandType["V3_SWAP_EXACT_OUT"] = 1] = "V3_SWAP_EXACT_OUT";
@@ -102,13 +102,170 @@ var _ABI_DEFINITION;
   CommandType[CommandType["V4_POSITION_CALL"] = 19] = "V4_POSITION_CALL";
   CommandType[CommandType["EXECUTE_SUB_PLAN"] = 33] = "EXECUTE_SUB_PLAN";
 })(exports.CommandType || (exports.CommandType = {}));
+var Subparser;
+(function (Subparser) {
+  Subparser[Subparser["V3PathExactIn"] = 0] = "V3PathExactIn";
+  Subparser[Subparser["V3PathExactOut"] = 1] = "V3PathExactOut";
+})(Subparser || (Subparser = {}));
 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 ABI_DEFINITION = (_ABI_DEFINITION = {}, _ABI_DEFINITION[exports.CommandType.EXECUTE_SUB_PLAN] = ['bytes', 'bytes[]'], _ABI_DEFINITION[exports.CommandType.PERMIT2_PERMIT] = [PERMIT_STRUCT, 'bytes'], _ABI_DEFINITION[exports.CommandType.PERMIT2_PERMIT_BATCH] = [PERMIT_BATCH_STRUCT, 'bytes'], _ABI_DEFINITION[exports.CommandType.PERMIT2_TRANSFER_FROM] = ['address', 'address', 'uint160'], _ABI_DEFINITION[exports.CommandType.PERMIT2_TRANSFER_FROM_BATCH] = [PERMIT2_TRANSFER_FROM_BATCH_STRUCT], _ABI_DEFINITION[exports.CommandType.V3_SWAP_EXACT_IN] = ['address', 'uint256', 'uint256', 'bytes', 'bool'], _ABI_DEFINITION[exports.CommandType.V3_SWAP_EXACT_OUT] = ['address', 'uint256', 'uint256', 'bytes', 'bool'], _ABI_DEFINITION[exports.CommandType.V2_SWAP_EXACT_IN] = ['address', 'uint256', 'uint256', 'address[]', 'bool'], _ABI_DEFINITION[exports.CommandType.V2_SWAP_EXACT_OUT] = ['address', 'uint256', 'uint256', 'address[]', 'bool'], _ABI_DEFINITION[exports.CommandType.V4_SWAP] = ['bytes'], _ABI_DEFINITION[exports.CommandType.WRAP_ETH] = ['address', 'uint256'], _ABI_DEFINITION[exports.CommandType.UNWRAP_WETH] = ['address', 'uint256'], _ABI_DEFINITION[exports.CommandType.SWEEP] = ['address', 'address', 'uint256'], _ABI_DEFINITION[exports.CommandType.TRANSFER] = ['address', 'address', 'uint256'], _ABI_DEFINITION[exports.CommandType.PAY_PORTION] = ['address', 'address', 'uint256'], _ABI_DEFINITION[exports.CommandType.BALANCE_CHECK_ERC20] = ['address', 'address', 'uint256'], _ABI_DEFINITION[exports.CommandType.V3_POSITION_MANAGER_PERMIT] = ['bytes'], _ABI_DEFINITION[exports.CommandType.V3_POSITION_MANAGER_CALL] = ['bytes'], _ABI_DEFINITION[exports.CommandType.V4_POSITION_CALL] = ['bytes'], _ABI_DEFINITION);
+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 RoutePlanner = /*#__PURE__*/function () {
   function RoutePlanner() {
     this.commands = '0x';
@@ -117,6 +274,7 @@ var RoutePlanner = /*#__PURE__*/function () {
   var _proto = RoutePlanner.prototype;
   _proto.addSubPlan = function addSubPlan(subplan) {
     this.addCommand(exports.CommandType.EXECUTE_SUB_PLAN, [subplan.commands, subplan.inputs], true);
+    return this;
   };
   _proto.addCommand = function addCommand(type, parameters, allowRevert) {
     if (allowRevert === void 0) {
@@ -131,6 +289,7 @@ var RoutePlanner = /*#__PURE__*/function () {
       command.type = command.type | ALLOW_REVERT_FLAG;
     }
     this.commands = this.commands.concat(command.type.toString(16).padStart(2, '0'));
+    return this;
   };
   return RoutePlanner;
 }();
@@ -141,7 +300,9 @@ function createCommand(type, parameters) {
       encodedInput: parameters[0]
     };
   }
-  var encodedInput = utils.defaultAbiCoder.encode(ABI_DEFINITION[type], parameters);
+  var encodedInput = utils.defaultAbiCoder.encode(COMMAND_ABI_DEFINITION[type].map(function (abi) {
+    return abi.type;
+  }), parameters);
   return {
     type: type,
     encodedInput: encodedInput
@@ -827,6 +988,103 @@ RouterTradeAdapter.toPair = function (_ref2) {
   return new v2Sdk.Pair(sdkCore.CurrencyAmount.fromRawAmount(RouterTradeAdapter.toToken(reserve0.token), reserve0.quotient), sdkCore.CurrencyAmount.fromRawAmount(RouterTradeAdapter.toToken(reserve1.token), reserve1.quotient));
 };
 
+// Parses UniversalRouter commands
+var CommandParser = /*#__PURE__*/function () {
+  function CommandParser() {}
+  CommandParser.parseCalldata = function parseCalldata(calldata) {
+    var txDescription = CommandParser.INTERFACE.parseTransaction({
+      data: calldata
+    });
+    var _txDescription$args = txDescription.args,
+      commands = _txDescription$args.commands,
+      inputs = _txDescription$args.inputs;
+    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
+        };
+      })
+    };
+  }
+  // parse command types from bytes string
+  ;
+  CommandParser.getCommands = function getCommands(commands) {
+    var commandTypes = [];
+    for (var i = 2; i < commands.length; i += 2) {
+      var _byte = commands.substring(i, i + 2);
+      commandTypes.push(parseInt(_byte, 16));
+    }
+    return commandTypes;
+  };
+  return CommandParser;
+}();
+CommandParser.INTERFACE = /*#__PURE__*/new abi.Interface(UniversalRouter_json.abi);
+function parseV3PathExactIn(path) {
+  var strippedPath = path.replace('0x', '');
+  var tokenIn = ethers.ethers.utils.getAddress(strippedPath.substring(0, 40));
+  var loc = 40;
+  var res = [];
+  while (loc < strippedPath.length) {
+    var feeAndTokenOut = strippedPath.substring(loc, loc + 46);
+    var fee = parseInt(feeAndTokenOut.substring(0, 6), 16);
+    var tokenOut = ethers.ethers.utils.getAddress(feeAndTokenOut.substring(6, 46));
+    res.push({
+      tokenIn: tokenIn,
+      tokenOut: tokenOut,
+      fee: fee
+    });
+    tokenIn = tokenOut;
+    loc += 46;
+  }
+  return res;
+}
+function parseV3PathExactOut(path) {
+  var strippedPath = path.replace('0x', '');
+  var tokenIn = ethers.ethers.utils.getAddress(strippedPath.substring(strippedPath.length - 40));
+  var loc = strippedPath.length - 86; // 86 = (20 addr + 3 fee + 20 addr) * 2 (for hex characters)
+  var res = [];
+  while (loc >= 0) {
+    var feeAndTokenOut = strippedPath.substring(loc, loc + 46);
+    var tokenOut = ethers.ethers.utils.getAddress(feeAndTokenOut.substring(0, 40));
+    var fee = parseInt(feeAndTokenOut.substring(40, 46), 16);
+    res.push({
+      tokenIn: tokenIn,
+      tokenOut: tokenOut,
+      fee: fee
+    });
+    tokenIn = tokenOut;
+    loc -= 46;
+  }
+  return res;
+}
+
+exports.CommandParser = CommandParser;
 exports.PERMIT2_ADDRESS = PERMIT2_ADDRESS;
 exports.ROUTER_AS_RECIPIENT = ROUTER_AS_RECIPIENT;
 exports.RoutePlanner = RoutePlanner;