feat(store-sync): use client instead of decorated public client

.changeset/tricky-experts-pull.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/store-sync": patch
+---
+
+All sync methods using a `publicClient` argument now accept a plain Viem `Client` rather than a decorated `PublicClient`, allowing for more flexibility and better tree-shaking for lighter bundles.

packages/store-sync/src/common.ts

@@ -1,4 +1,4 @@
-import { Address, Block, Hex, Log, PublicClient, TransactionReceipt } from "viem";
+import { Address, Block, Client, Hex, Log, TransactionReceipt } from "viem";
 import { StoreEventsAbiItem, StoreEventsAbi } from "@latticexyz/store";
 import { Observable } from "rxjs";
 import { UnionPick } from "@latticexyz/common/type-utils";
@@ -67,11 +67,11 @@ export type SyncFilter = {
 
 export type SyncOptions = {
   /**
-   * [viem `PublicClient`][0] used for fetching logs from the RPC.
+   * [viem `Client`][0] used for fetching logs from the RPC.
    *
-   * [0]: https://viem.sh/docs/clients/public.html
+   * [0]: https://viem.sh/docs/clients/custom
    */
-  publicClient: PublicClient;
+  publicClient: Client;
   /**
    * MUD Store/World contract address
    */

packages/store-sync/src/createStoreSync.ts

@@ -40,6 +40,8 @@ import { fetchAndStoreLogs } from "./fetchAndStoreLogs";
 import { isLogsApiResponse } from "./indexer-client/isLogsApiResponse";
 import { toStorageAdatperBlock } from "./indexer-client/toStorageAdapterBlock";
 import { watchLogs } from "./watchLogs";
+import { getAction } from "viem/utils";
+import { getChainId, getTransactionReceipt } from "viem/actions";
 
 const debug = parentDebug.extend("createStoreSync");
 
@@ -93,7 +95,7 @@ export async function createStoreSync({
           : undefined)
       : undefined;
 
-  const chainId = publicClient.chain?.id ?? (await publicClient.getChainId());
+  const chainId = publicClient.chain?.id ?? (await getAction(publicClient, getChainId, "getChainId")({}));
 
   const initialBlockLogs$ = defer(async (): Promise<StorageAdapterBlock | undefined> => {
     onProgress?.({
@@ -352,7 +354,11 @@ export async function createStoreSync({
         try {
           const lastBlock = blocks[0];
           debug("fetching tx receipt for block", lastBlock.blockNumber);
-          const { status, blockNumber, transactionHash } = await publicClient.getTransactionReceipt({ hash: tx });
+          const { status, blockNumber, transactionHash } = await getAction(
+            publicClient,
+            getTransactionReceipt,
+            "getTransactionReceipt",
+          )({ hash: tx });
           if (lastBlock.blockNumber >= blockNumber) {
             return { status, blockNumber, transactionHash };
           }

packages/store-sync/src/getRecords.ts

@@ -2,7 +2,7 @@ import { fetchBlockLogs } from "@latticexyz/block-logs-stream";
 import { Table } from "@latticexyz/config";
 import { getSchemaPrimitives } from "@latticexyz/protocol-parser/internal";
 import { LogToRecordArgs, flattenStoreLogs, getStoreLogs, logToRecord } from "@latticexyz/store/internal";
-import { Address, Client, createPublicClient, http } from "viem";
+import { Address, Client, createClient, http } from "viem";
 import { getAction } from "viem/utils";
 import { getBlockNumber } from "viem/actions";
 import { debug } from "./debug";
@@ -59,7 +59,7 @@ export async function getRecords<table extends Table>(
     } else {
       const client =
         options.client ??
-        createPublicClient({
+        createClient({
           transport: http(options.rpcUrl),
         });
       debug("fetching records for", options.table.label, "via RPC from", client.transport.url);

packages/store-sync/src/postgres-decoded/createStorageAdapter.test.ts

@@ -2,7 +2,7 @@ import { beforeEach, describe, expect, it } from "vitest";
 import { eq } from "drizzle-orm";
 import { drizzle } from "drizzle-orm/postgres-js";
 import postgres from "postgres";
-import { Hex, RpcLog, createPublicClient, decodeEventLog, formatLog, http } from "viem";
+import { Hex, RpcLog, createClient, decodeEventLog, formatLog, http } from "viem";
 import { foundry } from "viem/chains";
 import { getTables } from "./getTables";
 import { PostgresStorageAdapter, createStorageAdapter } from "./createStorageAdapter";
@@ -31,7 +31,7 @@ describe("createStorageAdapter", async () => {
     // logger: new DefaultLogger(),
   });
 
-  const publicClient = createPublicClient({
+  const publicClient = createClient({
     chain: foundry,
     transport: http(),
   });

packages/store-sync/src/postgres-decoded/createStorageAdapter.ts

@@ -1,4 +1,4 @@
-import { Hex, PublicClient, concatHex, getAddress } from "viem";
+import { Client, Hex, concatHex, getAddress } from "viem";
 import { PgDatabase, QueryResultHKT } from "drizzle-orm/pg-core";
 import { and, eq } from "drizzle-orm";
 import { buildTable } from "./buildTable";
@@ -26,7 +26,7 @@ export async function createStorageAdapter({
   publicClient,
 }: {
   database: PgDatabase<QueryResultHKT>;
-  publicClient: PublicClient;
+  publicClient: Client;
 }): Promise<PostgresStorageAdapter> {
   const bytesStorageAdapter = await createBytesStorageAdapter({ database, publicClient });
   const cleanUp: (() => Promise<void>)[] = [];

packages/store-sync/src/postgres/createStorageAdapter.test.ts

@@ -2,7 +2,7 @@ import { beforeEach, describe, expect, it } from "vitest";
 import { eq } from "drizzle-orm";
 import { drizzle } from "drizzle-orm/postgres-js";
 import postgres from "postgres";
-import { Hex, RpcLog, createPublicClient, decodeEventLog, formatLog, http } from "viem";
+import { Hex, RpcLog, createClient, decodeEventLog, formatLog, http } from "viem";
 import { foundry } from "viem/chains";
 import { PostgresStorageAdapter, createStorageAdapter } from "./createStorageAdapter";
 import { groupLogsByBlockNumber } from "@latticexyz/block-logs-stream";
@@ -30,7 +30,7 @@ describe("createStorageAdapter", async () => {
     // logger: new DefaultLogger(),
   });
 
-  const publicClient = createPublicClient({
+  const publicClient = createClient({
     chain: foundry,
     transport: http(),
   });

packages/store-sync/src/postgres/createStorageAdapter.ts

@@ -1,4 +1,4 @@
-import { PublicClient, encodePacked, size } from "viem";
+import { Client, encodePacked, size } from "viem";
 import { PgDatabase, QueryResultHKT } from "drizzle-orm/pg-core";
 import { and, eq } from "drizzle-orm";
 import { debug } from "./debug";
@@ -7,6 +7,8 @@ import { spliceHex } from "@latticexyz/common";
 import { setupTables } from "./setupTables";
 import { StorageAdapter, StorageAdapterBlock } from "../common";
 import { version } from "./version";
+import { getAction } from "viem/utils";
+import { getChainId } from "viem/actions";
 
 // Currently assumes one DB per chain ID
 
@@ -21,11 +23,11 @@ export async function createStorageAdapter({
   publicClient,
 }: {
   database: PgDatabase<QueryResultHKT>;
-  publicClient: PublicClient;
+  publicClient: Client;
 }): Promise<PostgresStorageAdapter> {
   const cleanUp: (() => Promise<void>)[] = [];
 
-  const chainId = publicClient.chain?.id ?? (await publicClient.getChainId());
+  const chainId = publicClient.chain?.id ?? (await getAction(publicClient, getChainId, "getChainId")({}));
 
   cleanUp.push(await setupTables(database, Object.values(tables)));
 

packages/store-sync/src/sqlite/sqliteStorage.test.ts

@@ -6,7 +6,7 @@ import { BaseSQLiteDatabase } from "drizzle-orm/sqlite-core";
 import { buildTable } from "./buildTable";
 import initSqlJs from "sql.js";
 import { drizzle } from "drizzle-orm/sql-js";
-import { Hex, RpcLog, createPublicClient, decodeEventLog, formatLog, http } from "viem";
+import { Hex, RpcLog, createClient, decodeEventLog, formatLog, http } from "viem";
 import { foundry } from "viem/chains";
 import worldRpcLogs from "../../../../test-data/world-logs.json";
 import { storeEventsAbi } from "@latticexyz/store";
@@ -32,7 +32,7 @@ describe("sqliteStorage", async () => {
   const SqlJs = await initSqlJs();
   let db: BaseSQLiteDatabase<"sync", void>;
 
-  const publicClient = createPublicClient({
+  const publicClient = createClient({
     chain: foundry,
     transport: http(),
   });

packages/store-sync/src/sqlite/sqliteStorage.ts

@@ -1,4 +1,4 @@
-import { Hex, PublicClient, concatHex, getAddress, size } from "viem";
+import { Client, Hex, concatHex, getAddress, size } from "viem";
 import { BaseSQLiteDatabase } from "drizzle-orm/sqlite-core";
 import { and, eq, sql } from "drizzle-orm";
 import { sqliteTableToSql } from "./sqliteTableToSql";
@@ -13,6 +13,8 @@ import { isTableRegistrationLog } from "../isTableRegistrationLog";
 import { logToTable } from "../logToTable";
 import { hexToResource, resourceToLabel, spliceHex } from "@latticexyz/common";
 import { KeySchema, decodeKey, decodeValueArgs } from "@latticexyz/protocol-parser/internal";
+import { getChainId } from "viem/actions";
+import { getAction } from "viem/utils";
 
 // TODO: upgrade drizzle and use async sqlite interface for consistency
 
@@ -21,9 +23,9 @@ export async function sqliteStorage({
   publicClient,
 }: {
   database: BaseSQLiteDatabase<"sync", void>;
-  publicClient: PublicClient;
+  publicClient: Client;
 }): Promise<StorageAdapter> {
-  const chainId = publicClient.chain?.id ?? (await publicClient.getChainId());
+  const chainId = publicClient.chain?.id ?? (await getAction(publicClient, getChainId, "getChainId")({}));
 
   // TODO: should these run lazily before first `registerTables`?
   database.run(sql.raw(sqliteTableToSql(chainState)));