feat(common): add indexer URL to chain configs (latticexyz#2771)

Co-authored-by: Kevin Ingersoll <[email protected]>
tenetxyz · May 24, 2024 · 55a9714 · 55a9714
1 parent 556fc72
commit 55a9714
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 2 deletions.
diff --git a/.changeset/lemon-apples-march.md b/.changeset/lemon-apples-march.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/store-sync": patch
+---
+
+Updated `createStoreSync` to default to the chain's indexer URL when no `indexerUrl` is passed in. To intentionally unset the value and not use the indexer at all, `indexerUrl` can now also be `false`.
diff --git a/.changeset/rotten-rules-switch.md b/.changeset/rotten-rules-switch.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/common": patch
+---
+
+Added an optional `indexerUrl` property to `MUDChain`, and populated it in the Redstone and Garnet chain configs.
diff --git a/packages/common/src/chains/garnet.ts b/packages/common/src/chains/garnet.ts
@@ -22,6 +22,7 @@ export const garnet = {
       url: "https://explorer.garnetchain.com",
     },
   },
+  indexerUrl: "https://indexer.mud.garnetchain.com",
   contracts: {
     ...chainConfig.contracts,
     multicall3: {

diff --git a/packages/common/src/chains/redstone.ts b/packages/common/src/chains/redstone.ts
@@ -21,6 +21,7 @@ export const redstone = {
       url: "https://explorer.redstone.xyz",
     },
   },
+  indexerUrl: "https://indexer.mud.redstonechain.com",
   contracts: {
     ...chainConfig.contracts,
     multicall3: {

diff --git a/packages/common/src/chains/types.ts b/packages/common/src/chains/types.ts
@@ -8,6 +8,7 @@ export type RpcUrls = {
 };
 
 export type MUDChain = Chain & {
+  indexerUrl?: string;
   faucetUrl?: string;
   iconUrls?: readonly string[];
   rpcUrls?: Chain["rpcUrls"] & {

diff --git a/packages/store-sync/src/common.ts b/packages/store-sync/src/common.ts
@@ -95,7 +95,7 @@ export type SyncOptions<config extends StoreConfig = StoreConfig> = {
   /**
    * Optional MUD tRPC indexer URL to fetch initial state from.
    */
-  indexerUrl?: string;
+  indexerUrl?: string | false;
   /**
    * Optional initial state to hydrate from. Useful if you're hydrating from an indexer or cache.
    * @deprecated Use `initialLogs` option instead.

diff --git a/packages/store-sync/src/createStoreSync.ts b/packages/store-sync/src/createStoreSync.ts
@@ -96,7 +96,15 @@ export async function createStoreSync<config extends StoreConfig = StoreConfig>(
       filters,
       initialState,
       initialBlockLogs,
-      indexerUrl,
+      indexerUrl:
+        indexerUrl !== false
+          ? indexerUrl ??
+            (publicClient.chain &&
+            "indexerUrl" in publicClient.chain &&
+            typeof publicClient.chain.indexerUrl === "string"
+              ? publicClient.chain.indexerUrl
+              : undefined)
+          : undefined,
     });
 
     onProgress?.({