rocketh 0.9.2 → 0.10.1

package/dist/cli.cjs

@@ -95,9 +95,9 @@ function stringToJSON(str) {
 // src/environment/deployments.ts
 var import_node_path2 = __toESM(require("path"), 1);
 var import_node_fs2 = __toESM(require("fs"), 1);
-function loadDeployments(deploymentsPath, subPath, onlyABIAndAddress, expectedChain) {
+function loadDeployments(deploymentsPath, networkName, onlyABIAndAddress, expectedChain) {
   const deploymentsFound = {};
-  const deployPath = import_node_path2.default.join(deploymentsPath, subPath);
+  const deployPath = import_node_path2.default.join(deploymentsPath, networkName);
   let filesStats;
   try {
     filesStats = traverse(deployPath, void 0, void 0, (name) => !name.startsWith(".") && name !== "solcInputs");
@@ -119,7 +119,7 @@ function loadDeployments(deploymentsPath, subPath, onlyABIAndAddress, expectedCh
         genesisHash = chainData.genesisHash;
       } else {
         throw new Error(
-          `A '.chain' or '.chainId' file is expected to be present in the deployment folder for network ${subPath}`
+          `A '.chain' or '.chainId' file is expected to be present in the deployment folder for network ${networkName}`
         );
       }
     }
@@ -401,8 +401,8 @@ function displayTransaction(transaction) {
     return `(gasPrice: ${BigInt(transaction.gasPrice).toString()})`;
   }
 }
-async function createEnvironment(config2, providedContext) {
-  const provider = "provider" in config2 ? config2.provider : new import_eip_1193_jsonrpc_provider.JSONRPCHTTPProvider(config2.nodeUrl);
+async function createEnvironment(config, providedContext) {
+  const provider = "provider" in config.network ? config.network.provider : new import_eip_1193_jsonrpc_provider.JSONRPCHTTPProvider(config.network.nodeUrl);
   const transport = (0, import_viem.custom)(provider);
   const viemClient = (0, import_viem.createPublicClient)({ transport });
   const chainId = (await viemClient.getChainId()).toString();
@@ -414,23 +414,29 @@ async function createEnvironment(config2, providedContext) {
   }
   let networkName;
   let saveDeployments;
-  let tags = {};
-  if ("nodeUrl" in config2) {
-    networkName = config2.networkName;
+  let networkTags = {};
+  for (const networkTag of config.network.tags) {
+    networkTags[networkTag] = true;
+  }
+  if ("nodeUrl" in config) {
+    networkName = config.network.name;
     saveDeployments = true;
   } else {
-    if (config2.networkName) {
-      networkName = config2.networkName;
+    if (config.network.name) {
+      networkName = config.network.name;
     } else {
       networkName = "memory";
     }
     if (networkName === "memory" || networkName === "hardhat") {
-      tags["memory"] = true;
+      networkTags["memory"] = true;
       saveDeployments = false;
     } else {
       saveDeployments = true;
     }
   }
+  if (config.saveDeployments !== void 0) {
+    saveDeployments = config.saveDeployments;
+  }
   const resolvedAccounts = {};
   const accountCache = {};
   async function getAccount(name, accounts, accountDef) {
@@ -510,15 +516,21 @@ async function createEnvironment(config2, providedContext) {
     artifacts: providedContext.artifacts,
     network: {
       name: networkName,
+      fork: config.network.fork,
       saveDeployments,
-      tags
+      tags: networkTags
     }
   };
-  const { deployments } = loadDeployments(config2.deployments, context.network.name, false, {
-    chainId,
-    genesisHash,
-    deleteDeploymentsIfDifferentGenesisHash: true
-  });
+  const { deployments } = loadDeployments(
+    config.deployments,
+    context.network.name,
+    false,
+    context.network.fork ? void 0 : {
+      chainId,
+      genesisHash,
+      deleteDeploymentsIfDifferentGenesisHash: true
+    }
+  );
   const namedAccounts = {};
   const namedSigners = {};
   const addressSigners = {};
@@ -530,7 +542,7 @@ async function createEnvironment(config2, providedContext) {
     namedSigners[name] = namedSigner;
   }
   const perliminaryEnvironment = {
-    config: config2,
+    config,
     deployments,
     accounts: namedAccounts,
     signers: namedSigners,
@@ -544,7 +556,7 @@ async function createEnvironment(config2, providedContext) {
     }
   };
   function ensureDeploymentFolder() {
-    const folderPath = import_node_path3.default.join(config2.deployments, context.network.name);
+    const folderPath = import_node_path3.default.join(config.deployments, context.network.name);
     import_node_fs3.default.mkdirSync(folderPath, { recursive: true });
     const chainFilepath = import_node_path3.default.join(folderPath, ".chain");
     if (!import_node_fs3.default.existsSync(chainFilepath)) {
@@ -870,28 +882,124 @@ async function createEnvironment(config2, providedContext) {
   };
 }
 
+// src/utils/eth.ts
+function avg(arr) {
+  const sum = arr.reduce((a, v) => a + v);
+  return sum / BigInt(arr.length);
+}
+async function getGasPriceEstimate(provider, options2) {
+  const defaultOptions = {
+    blockCount: 20,
+    newestBlock: "pending",
+    rewardPercentiles: [10, 50, 80]
+  };
+  const optionsResolved = options2 ? { ...defaultOptions, ...options2 } : defaultOptions;
+  const historicalBlocks = optionsResolved.blockCount;
+  const rawFeeHistory = await provider.request({
+    method: "eth_feeHistory",
+    params: [`0x${historicalBlocks.toString(16)}`, optionsResolved.newestBlock, optionsResolved.rewardPercentiles]
+  });
+  let blockNum = Number(rawFeeHistory.oldestBlock);
+  const lastBlock = blockNum + rawFeeHistory.reward.length;
+  let index = 0;
+  const blocksHistory = [];
+  while (blockNum < lastBlock) {
+    blocksHistory.push({
+      number: blockNum,
+      baseFeePerGas: BigInt(rawFeeHistory.baseFeePerGas[index]),
+      gasUsedRatio: Number(rawFeeHistory.gasUsedRatio[index]),
+      priorityFeePerGas: rawFeeHistory.reward[index].map((x) => BigInt(x))
+    });
+    blockNum += 1;
+    index += 1;
+  }
+  const percentilePriorityFeeAverages = [];
+  for (let i = 0; i < optionsResolved.rewardPercentiles.length; i++) {
+    percentilePriorityFeeAverages.push(avg(blocksHistory.map((b) => b.priorityFeePerGas[i])));
+  }
+  const baseFeePerGas = BigInt(rawFeeHistory.baseFeePerGas[rawFeeHistory.baseFeePerGas.length - 1]);
+  const result = [];
+  for (let i = 0; i < optionsResolved.rewardPercentiles.length; i++) {
+    result.push({
+      maxFeePerGas: percentilePriorityFeeAverages[i] + baseFeePerGas,
+      maxPriorityFeePerGas: percentilePriorityFeeAverages[i]
+    });
+  }
+  return result;
+}
+async function getRoughGasPriceEstimate(provider, options2) {
+  const defaultOptions = {
+    blockCount: 20,
+    newestBlock: "pending",
+    rewardPercentiles: [10, 50, 80]
+  };
+  const optionsResolved = options2 ? { ...defaultOptions, ...options2 } : defaultOptions;
+  if (optionsResolved.rewardPercentiles.length !== 3) {
+    throw new Error(`rough gas estimate require 3 percentile, it defaults to [10,50,80]`);
+  }
+  const result = await getGasPriceEstimate(provider, optionsResolved);
+  return {
+    slow: result[0],
+    average: result[1],
+    fast: result[2]
+  };
+}
+
 // src/executor/index.ts
+var import_prompts = __toESM(require("prompts"), 1);
+var import_viem2 = require("viem");
 if (!process.env["ROCKETH_SKIP_ESBUILD"]) {
   require("esbuild-register/dist/node").register();
 }
-function readConfig(options2, extra) {
+function readConfig(options2) {
   let configFile;
   try {
     const configString = import_node_fs4.default.readFileSync("./rocketh.json", "utf-8");
     configFile = JSON.parse(configString);
   } catch {
   }
-  let nodeUrl;
+  if (configFile) {
+    if (!options2.deployments && configFile.deployments) {
+      options2.deployments = configFile.deployments;
+    }
+    if (!options2.scripts && configFile.scripts) {
+      options2.scripts = configFile.scripts;
+    }
+  }
   const fromEnv = process.env["ETH_NODE_URI_" + options2.network];
-  if (typeof fromEnv === "string") {
-    nodeUrl = fromEnv;
-  } else {
-    if (configFile) {
-      const network = configFile.networks && configFile.networks[options2.network];
-      if (network) {
-        nodeUrl = network.rpcUrl;
+  const fork = typeof options2.network !== "string";
+  let networkName = "memory";
+  if (options2.network) {
+    if (typeof options2.network === "string") {
+      networkName = options2.network;
+    } else if ("fork" in options2.network) {
+      networkName = options2.network.fork;
+    }
+  }
+  let networkTags = configFile?.networks && configFile?.networks[networkName]?.tags || [];
+  if (!options2.provider) {
+    let nodeUrl;
+    if (typeof fromEnv === "string") {
+      nodeUrl = fromEnv;
+    } else {
+      if (configFile) {
+        const network = configFile.networks && configFile.networks[networkName];
+        if (network && network.rpcUrl) {
+          nodeUrl = network.rpcUrl;
+        } else {
+          if (options2?.ignoreMissingRPC) {
+            nodeUrl = "";
+          } else {
+            if (options2.network === "localhost") {
+              nodeUrl = "http://127.0.0.1:8545";
+            } else {
+              logger.error(`network "${options2.network}" is not configured. Please add it to the rocketh.json file`);
+              process.exit(1);
+            }
+          }
+        }
       } else {
-        if (extra?.ignoreMissingRPC) {
+        if (options2?.ignoreMissingRPC) {
           nodeUrl = "";
         } else {
           if (options2.network === "localhost") {
@@ -902,45 +1010,62 @@ function readConfig(options2, extra) {
           }
         }
       }
-    } else {
-      if (extra?.ignoreMissingRPC) {
-        nodeUrl = "";
-      } else {
-        if (options2.network === "localhost") {
-          nodeUrl = "http://127.0.0.1:8545";
-        } else {
-          logger.error(`network "${options2.network}" is not configured. Please add it to the rocketh.json file`);
-          process.exit(1);
-        }
-      }
     }
+    return {
+      network: {
+        nodeUrl,
+        name: networkName,
+        tags: networkTags,
+        fork
+      },
+      deployments: options2.deployments,
+      saveDeployments: options2.saveDeployments,
+      scripts: options2.scripts,
+      tags: typeof options2.tags === "undefined" ? void 0 : options2.tags.split(","),
+      logLevel: options2.logLevel,
+      askBeforeProceeding: options2.askBeforeProceeding
+    };
+  } else {
+    return {
+      network: {
+        provider: options2.provider,
+        name: networkName,
+        tags: networkTags,
+        fork
+      },
+      deployments: options2.deployments,
+      saveDeployments: options2.saveDeployments,
+      scripts: options2.scripts,
+      tags: typeof options2.tags === "undefined" ? void 0 : options2.tags.split(","),
+      logLevel: options2.logLevel,
+      askBeforeProceeding: options2.askBeforeProceeding
+    };
   }
-  return {
-    nodeUrl,
-    networkName: options2.network,
-    deployments: options2.deployments,
-    scripts: options2.scripts,
-    tags: typeof options2.tags === "undefined" ? void 0 : options2.tags.split(",")
-  };
 }
-function resolveConfig(config2) {
+function readAndResolveConfig(options2) {
+  return resolveConfig(readConfig(options2));
+}
+function resolveConfig(config) {
   const resolvedConfig = {
-    ...config2,
-    networkName: config2.networkName || "memory",
-    deployments: config2.deployments || "deployments",
-    scripts: config2.scripts || "deploy",
-    tags: config2.tags || []
+    ...config,
+    network: config.network,
+    // TODO default to || {name: 'memory'....}
+    deployments: config.deployments || "deployments",
+    scripts: config.scripts || "deploy",
+    tags: config.tags || [],
+    networkTags: config.networkTags || [],
+    saveDeployments: config.saveDeployments
   };
   return resolvedConfig;
 }
-async function loadAndExecuteDeployments(config2, args) {
-  const resolvedConfig = resolveConfig(config2);
+async function loadAndExecuteDeployments(options2, args) {
+  const resolvedConfig = readAndResolveConfig(options2);
   return executeDeployScripts(resolvedConfig, args);
 }
-async function executeDeployScripts(config2, args) {
-  setLogLevel(typeof config2.logLevel === "undefined" ? 0 : config2.logLevel);
+async function executeDeployScripts(config, args) {
+  setLogLevel(typeof config.logLevel === "undefined" ? 0 : config.logLevel);
   let filepaths;
-  filepaths = traverseMultipleDirectory([config2.scripts]);
+  filepaths = traverseMultipleDirectory([config.scripts]);
   filepaths = filepaths.filter((v) => !import_node_path4.default.basename(v).startsWith("_")).sort((a, b) => {
     if (a < b) {
       return -1;
@@ -992,10 +1117,10 @@ async function executeDeployScripts(config2, args) {
         bag.push(scriptFilePath);
       }
     }
-    if (config2.tags !== void 0 && config2.tags.length > 0) {
+    if (config.tags !== void 0 && config.tags.length > 0) {
       let found = false;
       if (scriptTags !== void 0) {
-        for (const tagToFind of config2.tags) {
+        for (const tagToFind of config.tags) {
           for (const tag of scriptTags) {
             if (tag === tagToFind) {
               scriptFilePaths.push(scriptFilePath);
@@ -1015,7 +1140,7 @@ async function executeDeployScripts(config2, args) {
   if (!providedContext) {
     throw new Error(`no context loaded`);
   }
-  const { internal, external } = await createEnvironment(config2, providedContext);
+  const { internal, external } = await createEnvironment(config, providedContext);
   await internal.recoverTransactionsIfAny();
   const scriptsRegisteredToRun = {};
   const scriptsToRun = [];
@@ -1053,6 +1178,28 @@ async function executeDeployScripts(config2, args) {
   for (const scriptFilePath of scriptFilePaths) {
     recurseDependencies(scriptFilePath);
   }
+  if (config.askBeforeProceeding) {
+    const gasPriceEstimate = await getRoughGasPriceEstimate(external.network.provider);
+    const prompt = await (0, import_prompts.default)({
+      type: "confirm",
+      name: "proceed",
+      message: `gas price is currently in this range:
+slow: ${(0, import_viem2.formatEther)(gasPriceEstimate.slow.maxFeePerGas)} (priority: ${(0, import_viem2.formatEther)(
+        gasPriceEstimate.slow.maxPriorityFeePerGas
+      )})
+average: ${(0, import_viem2.formatEther)(gasPriceEstimate.average.maxFeePerGas)} (priority: ${(0, import_viem2.formatEther)(
+        gasPriceEstimate.average.maxPriorityFeePerGas
+      )})
+fast: ${(0, import_viem2.formatEther)(gasPriceEstimate.fast.maxFeePerGas)} (priority: ${(0, import_viem2.formatEther)(
+        gasPriceEstimate.fast.maxPriorityFeePerGas
+      )})
+ 
+Do you want to proceed (note that gas price can change for each tx)`
+    });
+    if (!prompt.proceed) {
+      process.exit();
+    }
+  }
   for (const deployScript of scriptsToRun.concat(scriptsToRunAtTheEnd)) {
     const filename = import_node_path4.default.basename(deployScript.filePath);
     const relativeFilepath = import_node_path4.default.relative(".", deployScript.filePath);
@@ -1079,7 +1226,7 @@ async function executeDeployScripts(config2, args) {
         throw e;
       }
       if (result && typeof result === "boolean") {
-        const deploymentFolderPath = config2.deployments;
+        const deploymentFolderPath = config.deployments;
       }
     }
   }
@@ -1092,7 +1239,7 @@ var import_commander = require("commander");
 // package.json
 var package_default = {
   name: "rocketh",
-  version: "0.9.1",
+  version: "0.10.1",
   description: "deploy smart contract on ethereum-compatible networks",
   publishConfig: {
     access: "public"
@@ -1107,8 +1254,9 @@ var package_default = {
   devDependencies: {
     "@types/figlet": "^1.5.8",
     "@types/node": "^20.11.19",
+    "@types/prompts": "^2.4.9",
     abitype: "^1.0.0",
-    "eip-1193": "^0.4.7",
+    "eip-1193": "^0.5.0",
     "ipfs-gateway-emulator": "4.2.1-ipfs.2",
     rimraf: "^5.0.5",
     tsup: "^8.0.2",
@@ -1125,6 +1273,7 @@ var package_default = {
     ldenv: "^0.3.9",
     "named-logs": "^0.2.2",
     "named-logs-console": "^0.3.0",
+    prompts: "^2.4.2",
     viem: "^2.7.11"
   },
   scripts: {
@@ -1142,6 +1291,5 @@ var commandName = package_default.name;
 var program = new import_commander.Command();
 program.name(commandName).version(package_default.version).usage(`${commandName}`).description("execute deploy scripts and store the deployments").option("-s, --scripts <value>", "path the folder containing the deploy scripts to execute").option("-t, --tags <value>", "comma separated list of tags to execute").option("-d, --deployments <value>", "folder where deployments are saved").requiredOption("-n, --network <value>", "network context to use").parse(process.argv);
 var options = program.opts();
-var config = readConfig(options);
-loadAndExecuteDeployments({ ...config, logLevel: 1 });
+loadAndExecuteDeployments({ ...options, logLevel: 1, askBeforeProceeding: true });
 //# sourceMappingURL=cli.cjs.map