feat(explorer): local indexer inside explorer (#3229)

Co-authored-by: Kevin Ingersoll <[email protected]>
latticexyz · Sep 25, 2024 · 95aa3bb · 95aa3bb
1 parent 2f2e63a
commit 95aa3bb
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 58 deletions.
diff --git a/.changeset/silent-hairs-heal.md b/.changeset/silent-hairs-heal.md
@@ -0,0 +1,19 @@
+---
+"@latticexyz/explorer": patch
+"create-mud": patch
+---
+
+Explorer now automatically starts a local indexer when using Anvil as the target chain.
+
+If you previously had an `indexer` entry in your `mprocs.yaml` file, it can now be removed.
+
+```diff
+-  indexer:
+-    cwd: packages/contracts
+-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
+-    env:
+-      DEBUG: mud:*
+-      RPC_HTTP_URL: "http://127.0.0.1:8545"
+-      FOLLOW_BLOCK_TAG: "latest"
+-      SQLITE_FILENAME: "indexer.db"
+```
diff --git a/examples/local-explorer/mprocs.yaml b/examples/local-explorer/mprocs.yaml
@@ -8,14 +8,6 @@ procs:
   anvil:
     cwd: packages/contracts
     shell: anvil --base-fee 0 --block-time 2
-  indexer:
-    cwd: packages/contracts
-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
-    env:
-      DEBUG: mud:*
-      RPC_HTTP_URL: "http://127.0.0.1:8545"
-      FOLLOW_BLOCK_TAG: "latest"
-      SQLITE_FILENAME: "indexer.db"
   explorer:
     cwd: packages/contracts
     shell: pnpm explorer --dev
diff --git a/packages/explorer/package.json b/packages/explorer/package.json
@@ -41,6 +41,7 @@
     "@latticexyz/protocol-parser": "workspace:*",
     "@latticexyz/schema-type": "workspace:*",
     "@latticexyz/store": "workspace:*",
+    "@latticexyz/store-indexer": "workspace:*",
     "@latticexyz/store-sync": "workspace:*",
     "@latticexyz/world": "workspace:*",
     "@radix-ui/react-checkbox": "^1.1.1",

diff --git a/packages/explorer/src/bin/explorer.ts b/packages/explorer/src/bin/explorer.ts
@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 import { watchFile } from "fs";
-import { readFile } from "fs/promises";
+import { readFile, rm } from "fs/promises";
 import path from "path";
 import process from "process";
 import { fileURLToPath } from "url";
+import { anvil } from "viem/chains";
 import yargs from "yargs";
 import { ChildProcess, spawn } from "child_process";
 import { validateChainId } from "../common";
@@ -63,15 +64,18 @@ const argv = yargs(process.argv.slice(2))
   .parseSync();
 
 const { port, hostname, chainId, indexerDatabase, worldsFile, dev } = argv;
+const indexerDatabasePath = path.join(packageRoot, indexerDatabase);
+
 let worldAddress = argv.worldAddress;
 let explorerProcess: ChildProcess;
+let indexerProcess: ChildProcess;
 
 async function startExplorer() {
   const env = {
     ...process.env,
     CHAIN_ID: chainId.toString(),
     WORLD_ADDRESS: worldAddress?.toString(),
-    INDEXER_DATABASE: path.join(process.cwd(), indexerDatabase),
+    INDEXER_DATABASE: indexerDatabasePath,
   };
 
   if (dev) {
@@ -97,6 +101,29 @@ async function startExplorer() {
   }
 }
 
+async function startStoreIndexer() {
+  if (chainId !== anvil.id) {
+    console.log("Skipping SQLite indexer for non-anvil chain ID", chainId);
+    return;
+  }
+
+  await rm(indexerDatabasePath, { recursive: true, force: true });
+
+  console.log("Running SQLite indexer for anvil...");
+  indexerProcess = spawn("sh", ["node_modules/.bin/sqlite-indexer"], {
+    cwd: packageRoot,
+    stdio: "inherit",
+    env: {
+      ...process.env,
+      DEBUG: "mud:*",
+      RPC_HTTP_URL: "http://127.0.0.1:8545",
+      FOLLOW_BLOCK_TAG: "latest",
+      SQLITE_FILENAME: indexerDatabase,
+      STORE_ADDRESS: worldAddress,
+    },
+  });
+}
+
 async function readWorldsJson() {
   try {
     const data = await readFile(worldsFile, "utf8");
@@ -117,9 +144,10 @@ async function readWorldsJson() {
 }
 
 async function restartExplorer() {
-  if (explorerProcess) {
-    explorerProcess.kill();
-  }
+  indexerProcess?.kill();
+  explorerProcess?.kill();
+
+  await startStoreIndexer();
   await startExplorer();
 }
 
@@ -139,11 +167,9 @@ function watchWorldsJson() {
   });
 }
 
-process.on("SIGINT", () => {
-  if (explorerProcess) {
-    explorerProcess.kill();
-  }
-  process.exit();
+process.on("exit", () => {
+  indexerProcess?.kill();
+  explorerProcess?.kill();
 });
 
 async function main() {
@@ -162,6 +188,7 @@ async function main() {
     watchWorldsJson();
   }
 
+  await startStoreIndexer();
   await startExplorer();
 }
 

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/templates/phaser/mprocs.yaml b/templates/phaser/mprocs.yaml
@@ -8,14 +8,6 @@ procs:
   anvil:
     cwd: packages/contracts
     shell: anvil --base-fee 0 --block-time 2
-  indexer:
-    cwd: packages/contracts
-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
-    env:
-      DEBUG: mud:*
-      RPC_HTTP_URL: "http://127.0.0.1:8545"
-      FOLLOW_BLOCK_TAG: "latest"
-      SQLITE_FILENAME: "indexer.db"
   explorer:
     cwd: packages/contracts
     shell: pnpm explorer
diff --git a/templates/react-ecs/mprocs.yaml b/templates/react-ecs/mprocs.yaml
@@ -8,14 +8,6 @@ procs:
   anvil:
     cwd: packages/contracts
     shell: anvil --base-fee 0 --block-time 2
-  indexer:
-    cwd: packages/contracts
-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
-    env:
-      DEBUG: mud:*
-      RPC_HTTP_URL: "http://127.0.0.1:8545"
-      FOLLOW_BLOCK_TAG: "latest"
-      SQLITE_FILENAME: "indexer.db"
   explorer:
     cwd: packages/contracts
     shell: pnpm explorer
diff --git a/templates/react/mprocs.yaml b/templates/react/mprocs.yaml
@@ -8,14 +8,6 @@ procs:
   anvil:
     cwd: packages/contracts
     shell: anvil --base-fee 0 --block-time 2
-  indexer:
-    cwd: packages/contracts
-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
-    env:
-      DEBUG: mud:*
-      RPC_HTTP_URL: "http://127.0.0.1:8545"
-      FOLLOW_BLOCK_TAG: "latest"
-      SQLITE_FILENAME: "indexer.db"
   explorer:
     cwd: packages/contracts
     shell: pnpm explorer
diff --git a/templates/threejs/mprocs.yaml b/templates/threejs/mprocs.yaml
@@ -8,14 +8,6 @@ procs:
   anvil:
     cwd: packages/contracts
     shell: anvil --base-fee 0 --block-time 2
-  indexer:
-    cwd: packages/contracts
-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
-    env:
-      DEBUG: mud:*
-      RPC_HTTP_URL: "http://127.0.0.1:8545"
-      FOLLOW_BLOCK_TAG: "latest"
-      SQLITE_FILENAME: "indexer.db"
   explorer:
     cwd: packages/contracts
     shell: pnpm explorer
diff --git a/templates/vanilla/mprocs.yaml b/templates/vanilla/mprocs.yaml
@@ -8,14 +8,6 @@ procs:
   anvil:
     cwd: packages/contracts
     shell: anvil --base-fee 0 --block-time 2
-  indexer:
-    cwd: packages/contracts
-    shell: shx rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
-    env:
-      DEBUG: mud:*
-      RPC_HTTP_URL: "http://127.0.0.1:8545"
-      FOLLOW_BLOCK_TAG: "latest"
-      SQLITE_FILENAME: "indexer.db"
   explorer:
     cwd: packages/contracts
     shell: pnpm explorer