rocketh 0.9.1 → 0.10.0

package/dist/index.cjs

@@ -30,13 +30,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  chainById: () => chainById,
   execute: () => execute,
   executeDeployScripts: () => executeDeployScripts,
   extendEnvironment: () => extendEnvironment,
+  getChain: () => getChain,
   handleSignerProtocol: () => handleSignerProtocol,
   loadAndExecuteDeployments: () => loadAndExecuteDeployments,
   loadDeployments: () => loadDeployments,
   loadEnvironment: () => loadEnvironment,
+  mergeArtifacts: () => mergeArtifacts,
   readAndResolveConfig: () => readAndResolveConfig,
   readConfig: () => readConfig,
   resolveConfig: () => resolveConfig
@@ -112,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");
@@ -136,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}`
         );
       }
     }
@@ -283,6 +286,124 @@ function getChain(id) {
   return chain;
 }
 
+// src/environment/utils/artifacts.ts
+var import_ethers = require("ethers");
+function deepEqual(obj1, obj2) {
+  function isObject(obj) {
+    if (typeof obj === "object" && obj != null) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+  if (obj1 === obj2) {
+    return true;
+  } else if (isObject(obj1) && isObject(obj2)) {
+    if (Object.keys(obj1).length !== Object.keys(obj2).length) {
+      return false;
+    }
+    for (var prop in obj1) {
+      if (!deepEqual(obj1[prop], obj2[prop])) {
+        return false;
+      }
+    }
+    return true;
+  }
+  return false;
+}
+function mergeDoc(values, mergedDevDocs, field) {
+  if (values[field]) {
+    const mergedEventDocs = mergedDevDocs[field] = mergedDevDocs[field] || {};
+    for (const signature of Object.keys(values[field])) {
+      if (mergedEventDocs[signature] && !deepEqual(mergedEventDocs[signature], values[field][signature])) {
+        throw new Error(`Doc ${field} conflict: "${signature}" `);
+      }
+      mergedEventDocs[signature] = values[field][signature];
+    }
+  }
+}
+function mergeArtifacts(list) {
+  const mergedABI = [];
+  const added = /* @__PURE__ */ new Map();
+  const mergedDevDocs = { kind: "dev", version: 1, methods: {} };
+  const mergedUserDocs = { kind: "user", version: 1, methods: {} };
+  const sigJSMap = /* @__PURE__ */ new Map();
+  for (let i = 0; i < list.length; i++) {
+    const listElem = list[i];
+    for (const element of listElem.artifact.abi) {
+      if (element.type === "function") {
+        const selector = import_ethers.FunctionFragment.from(element).selector;
+        if (sigJSMap.has(selector)) {
+          const existing = sigJSMap.get(selector);
+          throw new Error(
+            `ABI conflict: ${existing.routeName} has function "${existing.functionName}" which conflict with ${listElem.name}'s "${element.name}" (selector: "${selector}")  `
+          );
+        }
+        sigJSMap.set(selector, { index: i, routeName: listElem.name, functionName: element.name });
+        const exists = added.has(element.name);
+        if (exists) {
+        } else {
+          added.set(element.name, element);
+          mergedABI.push(element);
+        }
+      } else if (element.type === "constructor") {
+      } else if (element.type === "error") {
+        const exists = added.has(element.name);
+        if (exists) {
+        } else {
+          added.set(element.name, element);
+          mergedABI.push(element);
+        }
+      } else if (element.type === "event") {
+        const exists = added.has(element.name);
+        if (exists) {
+        } else {
+          added.set(element.name, element);
+          mergedABI.push(element);
+        }
+      } else if (element.type === "fallback") {
+      } else if (element.type === "receive") {
+      } else {
+      }
+    }
+    const devdoc = listElem.artifact.devdoc;
+    if (devdoc) {
+      mergeDoc(devdoc, mergedDevDocs, "events");
+      mergeDoc(devdoc, mergedDevDocs, "errors");
+      mergeDoc(devdoc, mergedDevDocs, "methods");
+      if (devdoc.author) {
+        if (mergedDevDocs.author && mergedDevDocs.author != devdoc.author) {
+          throw new Error(`DevDoc author conflict `);
+        }
+        mergedDevDocs.author = devdoc.author;
+        if (mergedDevDocs.title && mergedDevDocs.title != devdoc.title) {
+          throw new Error(`DevDoc title conflict `);
+        }
+        mergedDevDocs.title = devdoc.title;
+      }
+    }
+    const userdoc = listElem.artifact.userdoc;
+    if (userdoc) {
+      mergeDoc(userdoc, mergedUserDocs, "events");
+      mergeDoc(userdoc, mergedUserDocs, "errors");
+      mergeDoc(userdoc, mergedUserDocs, "methods");
+      if (userdoc.notice) {
+        if (mergedUserDocs.notice && mergedUserDocs.notice != userdoc.notice) {
+          throw new Error(`UserDoc notice conflict `);
+        }
+        mergedUserDocs.notice = userdoc.notice;
+      }
+    }
+  }
+  return {
+    mergedABI,
+    added,
+    mergedDevDocs,
+    mergedUserDocs,
+    sigJSMap
+  };
+}
+
 // src/environment/index.ts
 globalThis.extensions = [];
 function extendEnvironment(extension) {
@@ -309,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();
@@ -321,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) {
@@ -417,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 = {};
@@ -467,7 +600,31 @@ async function createEnvironment(config, providedContext) {
     return deployment;
   }
   function getOrNull(name) {
-    return deployments[name];
+    return deployments[name] || null;
+  }
+  function fromAddressToNamedABIOrNull(address) {
+    let list = [];
+    for (const name of Object.keys(deployments)) {
+      const deployment = deployments[name];
+      if (deployment.address.toLowerCase() == address.toLowerCase()) {
+        list.push({ name, artifact: deployment });
+      }
+    }
+    if (list.length === 0) {
+      return null;
+    }
+    const { mergedABI } = mergeArtifacts(list);
+    return {
+      mergedABI,
+      names: list.map((v) => v.name)
+    };
+  }
+  function fromAddressToNamedABI(address) {
+    const n = fromAddressToNamedABIOrNull(address);
+    if (!n) {
+      throw new Error(`could not find artifact for address ${address}`);
+    }
+    return n;
   }
   async function save(name, deployment) {
     deployments[name] = deployment;
@@ -736,6 +893,8 @@ async function createEnvironment(config, providedContext) {
     savePendingExecution,
     get,
     getOrNull,
+    fromAddressToNamedABI,
+    fromAddressToNamedABIOrNull,
     showMessage,
     showProgress
   };
@@ -762,24 +921,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") {
@@ -790,47 +980,59 @@ 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
+    };
+  } 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
+    };
   }
-  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) {
@@ -983,13 +1185,16 @@ async function executeDeployScripts(config, args) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  chainById,
   execute,
   executeDeployScripts,
   extendEnvironment,
+  getChain,
   handleSignerProtocol,
   loadAndExecuteDeployments,
   loadDeployments,
   loadEnvironment,
+  mergeArtifacts,
   readAndResolveConfig,
   readConfig,
   resolveConfig