Add fork feature

.env.example

@@ -0,0 +1 @@
+INFURA_KEY=<fillme>

.github/workflows/test.yml

@@ -44,3 +44,5 @@ jobs:
 
       - name: Test 🧪
         run: npm test
+        env:
+          INFURA_KEY: ${{ secrets.INFURA_KEY }}

package.json

@@ -73,6 +73,7 @@
     "@typescript-eslint/parser": "^5.36.2",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
+    "dotenv": "^16.3.1",
     "eslint": "^8.23.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-standard": "^17.0.0",

registry/hardhat.config.ts

@@ -23,6 +23,14 @@ const config: HardhatUserConfig = {
   networks: {
     // we need automining for the validator event processor to work
     hardhat: {
+      forking: process.env.FORK
+        ? {
+            url: process.env.FORK,
+            blockNumber: process.env.FORK_BLOCK_NUMBER
+              ? Number(process.env.FORK_BLOCK_NUMBER)
+              : undefined,
+          }
+        : undefined,
       mining: {
         auto: !(process.env.HARDHAT_DISABLE_AUTO_MINING === "true"),
         interval: [100, 3000],

src/main.ts

@@ -68,24 +68,35 @@ class LocalTableland {
     }
 
     // make sure we are starting fresh
-    // TODO: I don't think this is doing anything anymore...
     this.#_cleanup();
 
-    // Run a local hardhat node
-    this.registry = spawn(
-      isWindows() ? "npx.cmd" : "npx",
-      ["hardhat", "node"],
-      {
-        // we can't run in windows if we use detached mode
-        detached: !isWindows(),
-        cwd: this.registryDir,
-        env: {
-          ...process.env,
-          HARDHAT_NETWORK: "hardhat",
-          HARDHAT_UNLIMITED_CONTRACT_SIZE: "true",
-        },
+    // There's two ways of signaling a mainnet fork should be used. The `FORK`
+    // env var, or the config has a fork property.  Either way this means we
+    // don't need to deploy the registry, and the validator should listen to
+    // a different contract address, specifically the mainnet address.
+    const shouldFork = !!(process.env.FORK || config.fork);
+    const hardhatCommandArr = ["hardhat", "node"];
+
+    if (config.fork) {
+      hardhatCommandArr.push("--fork");
+      hardhatCommandArr.push(config.fork);
+      if (config.forkBlockNumber) {
+        hardhatCommandArr.push("--fork-block-number");
+        hardhatCommandArr.push(config.forkBlockNumber);
       }
-    );
+    }
+
+    // Run a local hardhat node
+    this.registry = spawn(isWindows() ? "npx.cmd" : "npx", hardhatCommandArr, {
+      // we can't run in windows if we use detached mode
+      detached: !isWindows(),
+      cwd: this.registryDir,
+      env: {
+        ...process.env,
+        HARDHAT_NETWORK: "hardhat",
+        HARDHAT_UNLIMITED_CONTRACT_SIZE: "true",
+      },
+    });
 
     this.registry.on("error", (err) => {
       throw new Error(`registry errored with: ${err}`);
@@ -106,18 +117,19 @@ class LocalTableland {
     // wait until initialization is done
     await waitForReady(registryReadyEvent, this.initEmitter);
 
-    // Deploy the Registry to the Hardhat node
-    logSync(
-      spawnSync(
-        isWindows() ? "npx.cmd" : "npx",
-        ["hardhat", "run", "--network", "localhost", "scripts/deploy.ts"],
-        {
-          cwd: this.registryDir,
-        }
-      ),
-      !inDebugMode()
-    );
-
+    if (!shouldFork) {
+      // Deploy the Registry to the Hardhat node
+      logSync(
+        spawnSync(
+          isWindows() ? "npx.cmd" : "npx",
+          ["hardhat", "run", "--network", "localhost", "scripts/deploy.ts"],
+          {
+            cwd: this.registryDir,
+          }
+        ),
+        !inDebugMode()
+      );
+    }
     // need to determine if we are starting the validator via docker
     // and a local repo, or if are running a binary etc...
     const ValidatorClass = this.validatorDir ? ValidatorDev : ValidatorPkg;
@@ -127,7 +139,7 @@ class LocalTableland {
     // run this before starting in case the last instance of the validator didn't get cleanup after
     // this might be needed if a test runner force quits the parent local-tableland process
     this.validator.cleanup();
-    this.validator.start();
+    this.validator.start(shouldFork);
 
     // TODO: It seems like this check isn't sufficient to see if the process is gonna get to a point
     //       where the on error listener can be attached.

src/util.ts

@@ -22,9 +22,27 @@ overrideDefaults(getChainId("local-tableland"), {
 
 export type ConfigDescriptor = {
   name: string;
-  env: "VALIDATOR_DIR" | "REGISTRY_DIR" | "VERBOSE" | "SILENT";
-  file: "validatorDir" | "registryDir" | "verbose" | "silent";
-  arg: "validator" | "registry" | "verbose" | "silent";
+  env:
+    | "VALIDATOR_DIR"
+    | "REGISTRY_DIR"
+    | "VERBOSE"
+    | "SILENT"
+    | "FORK"
+    | "FORK_BLOCK_NUMBER";
+  file:
+    | "validatorDir"
+    | "registryDir"
+    | "verbose"
+    | "silent"
+    | "fork"
+    | "forkBlockNumber";
+  arg:
+    | "validator"
+    | "registry"
+    | "verbose"
+    | "silent"
+    | "fork"
+    | "forkBlockNumber";
   isPath: boolean;
 };
 
@@ -62,6 +80,20 @@ const configDescriptors: ConfigDescriptor[] = [
     arg: "silent",
     isPath: false,
   },
+  {
+    name: "fork",
+    env: "FORK",
+    file: "fork",
+    arg: "fork",
+    isPath: false,
+  },
+  {
+    name: "forkBlockNumber",
+    env: "FORK_BLOCK_NUMBER",
+    file: "forkBlockNumber",
+    arg: "forkBlockNumber",
+    isPath: false,
+  },
 ];
 
 export type Config = {
@@ -71,6 +103,8 @@ export type Config = {
   registryDir?: string;
   verbose?: boolean;
   silent?: boolean;
+  fork?: string;
+  forkBlockNumber?: string;
 };
 
 export const buildConfig = function (config: Config) {