rocketh 0.9.2 → 0.10.1

package/dist/index.cjs

@@ -115,9 +115,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");
@@ -139,7 +139,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}`
         );
       }
     }
@@ -430,7 +430,7 @@ function displayTransaction(transaction) {
   }
 }
 async function createEnvironment(config, providedContext) {
-  const provider = "provider" in config ? config.provider : new import_eip_1193_jsonrpc_provider.JSONRPCHTTPProvider(config.nodeUrl);
+  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();
@@ -442,23 +442,29 @@ async function createEnvironment(config, providedContext) {
   }
   let networkName;
   let saveDeployments;
-  let tags = {};
+  let networkTags = {};
+  for (const networkTag of config.network.tags) {
+    networkTags[networkTag] = true;
+  }
   if ("nodeUrl" in config) {
-    networkName = config.networkName;
+    networkName = config.network.name;
     saveDeployments = true;
   } else {
-    if (config.networkName) {
-      networkName = config.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) {
@@ -538,15 +544,21 @@ async function createEnvironment(config, providedContext) {
     artifacts: providedContext.artifacts,
     network: {
       name: networkName,
+      fork: config.network.fork,
       saveDeployments,
-      tags
+      tags: networkTags
     }
   };
-  const { deployments } = loadDeployments(config.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 = {};
@@ -898,7 +910,72 @@ async function createEnvironment(config, 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, options) {
+  const defaultOptions = {
+    blockCount: 20,
+    newestBlock: "pending",
+    rewardPercentiles: [10, 50, 80]
+  };
+  const optionsResolved = options ? { ...defaultOptions, ...options } : 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, options) {
+  const defaultOptions = {
+    blockCount: 20,
+    newestBlock: "pending",
+    rewardPercentiles: [10, 50, 80]
+  };
+  const optionsResolved = options ? { ...defaultOptions, ...options } : 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();
 }
@@ -909,24 +986,55 @@ function execute(context, callback, options) {
   scriptModule.dependencies = options.dependencies;
   return scriptModule;
 }
-function readConfig(options, extra) {
+function readConfig(options) {
   let configFile;
   try {
     const configString = import_node_fs4.default.readFileSync("./rocketh.json", "utf-8");
     configFile = JSON.parse(configString);
   } catch {
   }
-  let nodeUrl;
+  if (configFile) {
+    if (!options.deployments && configFile.deployments) {
+      options.deployments = configFile.deployments;
+    }
+    if (!options.scripts && configFile.scripts) {
+      options.scripts = configFile.scripts;
+    }
+  }
   const fromEnv = process.env["ETH_NODE_URI_" + options.network];
-  if (typeof fromEnv === "string") {
-    nodeUrl = fromEnv;
-  } else {
-    if (configFile) {
-      const network = configFile.networks && configFile.networks[options.network];
-      if (network) {
-        nodeUrl = network.rpcUrl;
+  const fork = typeof options.network !== "string";
+  let networkName = "memory";
+  if (options.network) {
+    if (typeof options.network === "string") {
+      networkName = options.network;
+    } else if ("fork" in options.network) {
+      networkName = options.network.fork;
+    }
+  }
+  let networkTags = configFile?.networks && configFile?.networks[networkName]?.tags || [];
+  if (!options.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 (options?.ignoreMissingRPC) {
+            nodeUrl = "";
+          } else {
+            if (options.network === "localhost") {
+              nodeUrl = "http://127.0.0.1:8545";
+            } else {
+              logger.error(`network "${options.network}" is not configured. Please add it to the rocketh.json file`);
+              process.exit(1);
+            }
+          }
+        }
       } else {
-        if (extra?.ignoreMissingRPC) {
+        if (options?.ignoreMissingRPC) {
           nodeUrl = "";
         } else {
           if (options.network === "localhost") {
@@ -937,47 +1045,61 @@ function readConfig(options, extra) {
           }
         }
       }
-    } else {
-      if (extra?.ignoreMissingRPC) {
-        nodeUrl = "";
-      } else {
-        if (options.network === "localhost") {
-          nodeUrl = "http://127.0.0.1:8545";
-        } else {
-          logger.error(`network "${options.network}" is not configured. Please add it to the rocketh.json file`);
-          process.exit(1);
-        }
-      }
     }
+    return {
+      network: {
+        nodeUrl,
+        name: networkName,
+        tags: networkTags,
+        fork
+      },
+      deployments: options.deployments,
+      saveDeployments: options.saveDeployments,
+      scripts: options.scripts,
+      tags: typeof options.tags === "undefined" ? void 0 : options.tags.split(","),
+      logLevel: options.logLevel,
+      askBeforeProceeding: options.askBeforeProceeding
+    };
+  } else {
+    return {
+      network: {
+        provider: options.provider,
+        name: networkName,
+        tags: networkTags,
+        fork
+      },
+      deployments: options.deployments,
+      saveDeployments: options.saveDeployments,
+      scripts: options.scripts,
+      tags: typeof options.tags === "undefined" ? void 0 : options.tags.split(","),
+      logLevel: options.logLevel,
+      askBeforeProceeding: options.askBeforeProceeding
+    };
   }
-  return {
-    nodeUrl,
-    networkName: options.network,
-    deployments: options.deployments,
-    scripts: options.scripts,
-    tags: typeof options.tags === "undefined" ? void 0 : options.tags.split(",")
-  };
 }
-function readAndResolveConfig(options, extra) {
-  return resolveConfig(readConfig(options, extra));
+function readAndResolveConfig(options) {
+  return resolveConfig(readConfig(options));
 }
 function resolveConfig(config) {
   const resolvedConfig = {
     ...config,
-    networkName: config.networkName || "memory",
+    network: config.network,
+    // TODO default to || {name: 'memory'....}
     deployments: config.deployments || "deployments",
     scripts: config.scripts || "deploy",
-    tags: config.tags || []
+    tags: config.tags || [],
+    networkTags: config.networkTags || [],
+    saveDeployments: config.saveDeployments
   };
   return resolvedConfig;
 }
-async function loadEnvironment(config, context) {
-  const resolvedConfig = resolveConfig(config);
+async function loadEnvironment(options, context) {
+  const resolvedConfig = readAndResolveConfig(options);
   const { external, internal } = await createEnvironment(resolvedConfig, context);
   return external;
 }
-async function loadAndExecuteDeployments(config, args) {
-  const resolvedConfig = resolveConfig(config);
+async function loadAndExecuteDeployments(options, args) {
+  const resolvedConfig = readAndResolveConfig(options);
   return executeDeployScripts(resolvedConfig, args);
 }
 async function executeDeployScripts(config, args) {
@@ -1096,6 +1218,28 @@ async function executeDeployScripts(config, 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);