@gearbox-protocol/deploy-tools 4.19.2 → 4.20.0

package/dist/index.mjs

@@ -47,9 +47,9 @@ var __toESM = (mod2, isNodeMode, target) => (target = mod2 != null ? __create(__
 ));
 var __toCommonJS = (mod2) => __copyProps(__defProp({}, "__esModule", { value: true }), mod2);
 
-// node_modules/commander/lib/error.js
+// ../../node_modules/commander/lib/error.js
 var require_error = __commonJS({
-  "node_modules/commander/lib/error.js"(exports2) {
+  "../../node_modules/commander/lib/error.js"(exports2) {
     var CommanderError2 = class extends Error {
       /**
        * Constructs the CommanderError class
@@ -84,9 +84,9 @@ var require_error = __commonJS({
   }
 });
 
-// node_modules/commander/lib/argument.js
+// ../../node_modules/commander/lib/argument.js
 var require_argument = __commonJS({
-  "node_modules/commander/lib/argument.js"(exports2) {
+  "../../node_modules/commander/lib/argument.js"(exports2) {
     var { InvalidArgumentError: InvalidArgumentError2 } = require_error();
     var Argument2 = class {
       /**
@@ -205,9 +205,9 @@ var require_argument = __commonJS({
   }
 });
 
-// node_modules/commander/lib/help.js
+// ../../node_modules/commander/lib/help.js
 var require_help = __commonJS({
-  "node_modules/commander/lib/help.js"(exports2) {
+  "../../node_modules/commander/lib/help.js"(exports2) {
     var { humanReadableArgName } = require_argument();
     var Help2 = class {
       constructor() {
@@ -587,9 +587,9 @@ var require_help = __commonJS({
   }
 });
 
-// node_modules/commander/lib/option.js
+// ../../node_modules/commander/lib/option.js
 var require_option = __commonJS({
-  "node_modules/commander/lib/option.js"(exports2) {
+  "../../node_modules/commander/lib/option.js"(exports2) {
     var { InvalidArgumentError: InvalidArgumentError2 } = require_error();
     var Option2 = class {
       /**
@@ -858,9 +858,9 @@ var require_option = __commonJS({
   }
 });
 
-// node_modules/commander/lib/suggestSimilar.js
+// ../../node_modules/commander/lib/suggestSimilar.js
 var require_suggestSimilar = __commonJS({
-  "node_modules/commander/lib/suggestSimilar.js"(exports2) {
+  "../../node_modules/commander/lib/suggestSimilar.js"(exports2) {
     var maxDistance = 3;
     function editDistance(a, b3) {
       if (Math.abs(a.length - b3.length) > maxDistance)
@@ -940,9 +940,9 @@ var require_suggestSimilar = __commonJS({
   }
 });
 
-// node_modules/commander/lib/command.js
+// ../../node_modules/commander/lib/command.js
 var require_command = __commonJS({
-  "node_modules/commander/lib/command.js"(exports2) {
+  "../../node_modules/commander/lib/command.js"(exports2) {
     var EventEmitter = __require("events").EventEmitter;
     var childProcess = __require("child_process");
     var path8 = __require("path");
@@ -2905,9 +2905,9 @@ Expecting one of '${allowedValues.join("', '")}'`);
   }
 });
 
-// node_modules/commander/index.js
+// ../../node_modules/commander/index.js
 var require_commander = __commonJS({
-  "node_modules/commander/index.js"(exports2) {
+  "../../node_modules/commander/index.js"(exports2) {
     var { Argument: Argument2 } = require_argument();
     var { Command: Command2 } = require_command();
     var { CommanderError: CommanderError2, InvalidArgumentError: InvalidArgumentError2 } = require_error();
@@ -2927,6 +2927,25 @@ var require_commander = __commonJS({
   }
 });
 
+// ../../node_modules/@commander-js/extra-typings/index.js
+var require_extra_typings = __commonJS({
+  "../../node_modules/@commander-js/extra-typings/index.js"(exports2, module2) {
+    var commander = require_commander();
+    exports2 = module2.exports = {};
+    exports2.program = new commander.Command();
+    exports2.Argument = commander.Argument;
+    exports2.Command = commander.Command;
+    exports2.CommanderError = commander.CommanderError;
+    exports2.Help = commander.Help;
+    exports2.InvalidArgumentError = commander.InvalidArgumentError;
+    exports2.InvalidOptionArgumentError = commander.InvalidArgumentError;
+    exports2.Option = commander.Option;
+    exports2.createCommand = (name) => new commander.Command(name);
+    exports2.createOption = (flags, description) => new commander.Option(flags, description);
+    exports2.createArgument = (name, description) => new commander.Argument(name, description);
+  }
+});
+
 // ../../node_modules/ws/lib/stream.js
 var require_stream = __commonJS({
   "../../node_modules/ws/lib/stream.js"(exports2, module2) {
@@ -296252,8 +296271,8 @@ var require_server_node = __commonJS({
   }
 });
 
-// node_modules/commander/esm.mjs
-var import_index = __toESM(require_commander(), 1);
+// ../../node_modules/@commander-js/extra-typings/esm.mjs
+var import_index = __toESM(require_extra_typings(), 1);
 var {
   program,
   createCommand,
@@ -352478,9 +352497,52 @@ var ZeroLT = class extends ProviderBase {
   }
 };
 
+// src/commands/new-command.ts
+function newCommand() {
+  return new Command().addOption(
+    new Option(
+      "--cache-policy <policy>",
+      "never use cache or use cache only"
+    ).choices(["never", "only"])
+  ).addOption(
+    new Option(
+      "--sandbox-dir <dir>",
+      "directory for intermediate results and cache"
+    ).default("./sandbox")
+  ).addOption(new Option("--log-level <info>", "log level")).addOption(
+    new Option("--out-file <json>", "save output as json").env("OUT_FILE")
+  ).addOption(
+    new Option("--pretty", "pretty-print output event when saving to json")
+  ).addOption(
+    new Option("--etherscan-api-key <key>", "etherscan api key").env(
+      "ETHERSCAN_API_KEY"
+    )
+  ).addOption(
+    new Option(
+      "--etherscan-optimism <key>",
+      "etherscan api key for Optimism"
+    ).env("ETHERSCAN_OPTIMISM")
+  ).addOption(
+    new Option(
+      "--etherscan-arbitrum <key>",
+      "etherscan api key for Arbitrum"
+    ).env("ETHERSCAN_ARBITRUM")
+  ).addOption(
+    new Option(
+      "--governance-json <file>",
+      "file with addresses for governance contract overrides"
+    )
+  ).addOption(
+    new Option(
+      "--address-provider-json <file>",
+      "file with address provider address override"
+    )
+  );
+}
+
 // src/commands/address-tree.ts
 function addressTree() {
-  return new Command().name("address-tree").description("builds gearbox addresses tree").addOption(
+  return newCommand().name("address-tree").description("builds gearbox addresses tree").addOption(
     new Option("--rpc-url <url>", "rpc provider url").default("https://rpc.ankr.com/eth").env("RPC_URL")
   ).action(async (opts) => {
     await new GearboxAddressTree(opts).build();
@@ -353484,7 +353546,7 @@ function getTldr({ transactions }) {
 
 // src/commands/audit.ts
 function audit() {
-  return new Command().name("audit").description("prints verification + audit info for gearbox address").addArgument(new Argument("<address>", "address to check")).addOption(
+  return newCommand().name("audit").description("prints verification + audit info for gearbox address").addArgument(new Argument("<address>", "address to check")).addOption(
     new Option("--rpc-url <url>", "rpc provider url").default("https://rpc.ankr.com/eth").env("RPC_URL")
   ).action(async (address, opts) => {
     const verifier = new EtherscanVerifier(opts);
@@ -353512,19 +353574,24 @@ function audit() {
 import { readFile as readFile7 } from "node:fs/promises";
 import { request } from "node:https";
 function launchForks() {
-  return new Command().name("launch-forks").description("launches anvil-manager test forks from template json file").addOption(
+  return newCommand().name("launch-forks").description("launches anvil-manager test forks from template json file").addOption(
     new Option(
       "--endpoint <url>",
       "Endpoint to call for fork creation"
     ).default("https://anvil.gearbox.foundation/api/forks")
-  ).addOption(new Option("--no-wait", "Ignore response")).addOption(new Option("--api-key <key>", "anvil-manager api key")).addOption(
+  ).addOption(new Option("--no-wait", "Ignore response")).addOption(
+    new Option(
+      "--api-key <key>",
+      "anvil-manager api key"
+    ).makeOptionMandatory()
+  ).addOption(
     new Option(
       "--template <json_file>",
       "Json file with POST requests payloads"
-    )
+    ).makeOptionMandatory()
   ).addOption(
     new Option(
-      "--release [version]",
+      "--release <version>",
       "release name to interpolate inside json files"
     ).default("")
   ).action(async (opts) => {
@@ -353619,20 +353686,20 @@ function getRenderer(opts) {
 }
 
 // package.json
-var version3 = "4.19.2";
+var version3 = "4.20.0";
 
 // src/version.ts
 var version_default = version3;
 
 // src/commands/parse.ts
 function parse() {
-  return new Command().name("parse").description(
+  return newCommand().name("parse").description(
     "displays protocol updates from safe multisig or from batch json files"
   ).addOption(
     new Option("--rpc-url <url>", "rpc provider url").default("https://rpc.ankr.com/eth").env("RPC_URL")
   ).addOption(
     new Option(
-      "--batch-dir [dir]",
+      "--batch-dir <dir>",
       "Directory (can be recursive) with batch and meta jsons"
     )
   ).addOption(
@@ -353646,33 +353713,43 @@ function parse() {
       // TODO: remove me when we fix audits in meta
       "Load meta from repo even when parsing batches from json"
     )
-  ).addOption(new Option("--renderer [cli|html]", "cli or html")).addOption(
+  ).addOption(
+    new Option("--renderer <renderer>", "cli or html").choices([
+      "cli",
+      "html"
+    ])
+  ).addOption(
     new Option(
       "-i, --interactive",
       "Interactive navigation for pretty-print"
     )
-  ).addOption(new Option("--html-file [file]", "output html file")).action(
-    async (opts) => {
-      container.auditor = new Auditor(opts);
-      await container.auditor.setup();
-      container.addressTree = new GearboxAddressTree(opts);
-      await container.addressTree.build();
-      const parser = new UpdateParser(opts, version_default);
-      const result = await parser.parse(opts);
-      if (opts.outFile) {
-        await writeFile4(opts.outFile, json_stringify(result), "utf-8");
-      }
-      const renderer = getRenderer(opts);
-      return renderer?.render(result);
-    }
-  );
+  ).addOption(
+    new Option(
+      "--html-file <file>",
+      "output html file"
+    ).makeOptionMandatory()
+  ).action(async (opts) => {
+    container.auditor = new Auditor(opts);
+    await container.auditor.setup();
+    container.addressTree = new GearboxAddressTree(opts);
+    await container.addressTree.build();
+    const parser = new UpdateParser(opts, version_default);
+    const result = await parser.parse(opts);
+    if (opts.outFile) {
+      await writeFile4(opts.outFile, json_stringify(result), "utf-8");
+    }
+    const renderer = getRenderer(opts);
+    return renderer?.render(result);
+  });
 }
 
 // src/commands/print-safe-tx.ts
 var Printer = class extends ProviderBase {
 };
 function printSafeTx() {
-  return new Command().name("print-safe-tx").description("Gets transaction from Safe API and prints json").addArgument(new Argument("<safeTxHash>", "Safe tx hash")).action(async (safeTxHash, options) => {
+  return newCommand().name("print-safe-tx").description("Gets transaction from Safe API and prints json").addArgument(new Argument("<safeTxHash>", "Safe tx hash")).addOption(
+    new Option("--rpc-url <url>", "rpc provider url").default("https://rpc.ankr.com/eth").env("RPC_URL")
+  ).action(async (safeTxHash, options) => {
     const printer = new Printer(options);
     const txs = await printer.getSafeTransactions([safeTxHash]);
     console.log(json_stringify(txs[0]));
@@ -353682,16 +353759,16 @@ function printSafeTx() {
 // src/commands/verify-etherscan.ts
 import { readFile as readFile8 } from "node:fs/promises";
 function verifyEtherscan() {
-  return new Command().name("verify-etherscan").description(
+  return newCommand().name("verify-etherscan").description(
     "performs bulk verification of gearbox contracts using etherscan"
   ).addOption(
     new Option("--rpc-url <url>", "rpc provider url").default("https://rpc.ankr.com/eth").env("RPC_URL")
   ).addOption(
     new Option(
-      "--addresses-file [json]",
+      "--addresses-file <json>",
       "json file where keys are addresses to verify, e.g. gearbox contracts tree"
     )
-  ).addOption(new Option("--addresses [addr...]", "addresses to verify")).action(async (opts) => {
+  ).addOption(new Option("--addresses <addr...>", "addresses to verify")).action(async (opts) => {
     if (!opts.addresses?.length && !opts.addressesFile) {
       throw new Error("please specify addresses or addresses file");
     }
@@ -353711,10 +353788,10 @@ function verifyEtherscan() {
 
 // src/commands/zero-lt.ts
 function zeroLT() {
-  return new Command().name("zero-lt").description("sets LTs to zero on credit managers").addOption(
+  return newCommand().name("zero-lt").description("sets LTs to zero on credit managers").addOption(
     new Option("--anvil-url <url>", "anvil rpc url").default("http://127.0.0.1:8545").env("ANVIL_URL")
-  ).addOption(new Option("--cm [address]", "Single credit manager option")).action(async (opts) => {
-    const zlt = new ZeroLT(opts);
+  ).addOption(new Option("--cm <address>", "Single credit manager option")).action(async ({ anvilUrl, ...opts }) => {
+    const zlt = new ZeroLT({ ...opts, rpcUrl: anvilUrl });
     await zlt.setLtZero(opts);
   });
 }
@@ -353729,47 +353806,6 @@ program2.addCommand(parse());
 program2.addCommand(printSafeTx());
 program2.addCommand(verifyEtherscan());
 program2.addCommand(zeroLT());
-program2.commands.forEach((cmd) => {
-  cmd.addOption(
-    new Option(
-      "--cache-policy [never|only]",
-      "never use cache or use cache only"
-    )
-  ).addOption(
-    new Option(
-      "--sandbox-dir <dir>",
-      "directory for intermediate results and cache"
-    ).default("./sandbox")
-  ).addOption(new Option("--log-level [info]", "log level")).addOption(
-    new Option("--out-file [json]", "save output as json").env("OUT_FILE")
-  ).addOption(
-    new Option("--pretty", "pretty-print output event when saving to json")
-  ).addOption(
-    new Option("--etherscan-api-key [key]", "etherscan api key").env(
-      "ETHERSCAN_API_KEY"
-    )
-  ).addOption(
-    new Option(
-      "--etherscan-optimism [key]",
-      "etherscan api key for Optimism"
-    ).env("ETHERSCAN_OPTIMISM")
-  ).addOption(
-    new Option(
-      "--etherscan-arbitrum [key]",
-      "etherscan api key for Arbitrum"
-    ).env("ETHERSCAN_ARBITRUM")
-  ).addOption(
-    new Option(
-      "--governance-json [file]",
-      "file with addresses for governance contract overrides"
-    )
-  ).addOption(
-    new Option(
-      "--address-provider-json [file]",
-      "file with address provider address override"
-    )
-  );
-});
 program2.parse();
 /*! Bundled license information:
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/deploy-tools",
   "description": "Gearbox deploy tools",
-  "version": "4.19.2",
+  "version": "4.20.0",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"
@@ -37,6 +37,7 @@
   "devDependencies": {
     "@actions/core": "^1.10.1",
     "@chialab/esbuild-plugin-commonjs": "^0.18.0",
+    "@commander-js/extra-typings": "^12.0.1",
     "@ethereum-sourcify/bytecode-utils": "^1.2.1",
     "@ethereum-sourcify/lib-sourcify": "^1.4.1",
     "@gearbox-protocol/deploy-tools-node": "0.0.0",