feat: bump viem to 1.6.0 (#1308)

latticexyz · Aug 15, 2023 · b8a6158 · b8a6158
1 parent 5294a7d
commit b8a6158
Show file tree

Hide file tree

Showing 40 changed files with 184 additions and 287 deletions.
diff --git a/.changeset/lazy-ladybugs-return.md b/.changeset/lazy-ladybugs-return.md
@@ -0,0 +1,6 @@
+---
+"@latticexyz/common": minor
+---
+
+- adds `defaultPriorityFee` to `mudFoundry` for better support with MUD's default anvil config and removes workaround in `createContract`
+- improves nonce error detection using viem's custom errors
diff --git a/.changeset/red-turkeys-develop.md b/.changeset/red-turkeys-develop.md
@@ -0,0 +1,14 @@
+---
+"@latticexyz/block-logs-stream": patch
+"@latticexyz/common": patch
+"@latticexyz/dev-tools": patch
+"@latticexyz/network": patch
+"@latticexyz/protocol-parser": patch
+"@latticexyz/schema-type": patch
+"@latticexyz/std-client": patch
+"@latticexyz/store-indexer": patch
+"@latticexyz/store-sync": patch
+"create-mud": patch
+---
+
+bump viem to 1.6.0
diff --git a/.changeset/sharp-worms-kneel.md b/.changeset/sharp-worms-kneel.md
@@ -0,0 +1,7 @@
+---
+"@latticexyz/block-logs-stream": major
+---
+
+- removes our own `getLogs` function now that viem's `getLogs` supports using multiple `events` per RPC call.
+- removes `isNonPendingBlock` and `isNonPendingLog` helpers now that viem narrows `Block` and `Log` types based on inputs
+- simplifies `groupLogsByBlockNumber` types and tests
diff --git a/.changeset/spotty-cups-destroy.md b/.changeset/spotty-cups-destroy.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/store-sync": patch
+---
+
+remove usages of `isNonPendingBlock` and `isNonPendingLog` (fixed with more specific viem types)
diff --git a/e2e/packages/client-vanilla/package.json b/e2e/packages/client-vanilla/package.json
@@ -33,7 +33,7 @@
     "react": "^18.2.0",
     "rxjs": "7.5.5",
     "threads": "^1.7.0",
-    "viem": "1.3.1"
+    "viem": "1.6.0"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",

diff --git a/e2e/packages/sync-test/package.json b/e2e/packages/sync-test/package.json
@@ -22,7 +22,7 @@
     "execa": "^7.1.1",
     "jsdom": "^22.0.0",
     "typescript": "5.1.6",
-    "viem": "1.3.1",
+    "viem": "1.6.0",
     "vite": "^4.2.1",
     "vitest": "^0.31.0"
   }

diff --git a/e2e/pnpm-lock.yaml b/e2e/pnpm-lock.yaml
diff --git a/examples/minimal/packages/client-phaser/package.json b/examples/minimal/packages/client-phaser/package.json
@@ -39,7 +39,7 @@
     "styled-components": "^5.3.10",
     "threads": "^1.7.0",
     "use-resize-observer": "^9.1.0",
-    "viem": "1.3.1",
+    "viem": "1.6.0",
     "vite": "^4.2.1",
     "zustand": "^4.3.8"
   },

diff --git a/examples/minimal/packages/client-react/package.json b/examples/minimal/packages/client-react/package.json
@@ -35,7 +35,7 @@
     "react-dom": "^18.2.0",
     "rxjs": "7.5.5",
     "threads": "^1.7.0",
-    "viem": "1.3.1"
+    "viem": "1.6.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.6",

diff --git a/examples/minimal/packages/client-vanilla/package.json b/examples/minimal/packages/client-vanilla/package.json
@@ -33,7 +33,7 @@
     "react": "^18.2.0",
     "rxjs": "7.5.5",
     "threads": "^1.7.0",
-    "viem": "1.3.1"
+    "viem": "1.6.0"
   },
   "devDependencies": {
     "vite": "^4.2.1",

diff --git a/examples/minimal/pnpm-lock.yaml b/examples/minimal/pnpm-lock.yaml
diff --git a/packages/block-logs-stream/README.md b/packages/block-logs-stream/README.md
@@ -10,23 +10,14 @@ A set of utilities for efficiently retrieving blockchain event logs. Built on to
 ```ts
 import { filter, map, mergeMap } from "rxjs";
 import { createPublicClient, parseAbi } from "viem";
-import {
-  createBlockStream,
-  isNonPendingBlock,
-  groupLogsByBlockNumber,
-  blockRangeToLogs,
-} from "@latticexyz/block-logs-stream";
+import { createBlockStream, groupLogsByBlockNumber, blockRangeToLogs } from "@latticexyz/block-logs-stream";
 
 const publicClient = createPublicClient({
   // your viem public client config here
 });
 
 const latestBlock$ = await createBlockStream({ publicClient, blockTag: "latest" });
-
-const latestBlockNumber$ = latestBlock$.pipe(
-  filter(isNonPendingBlock),
-  map((block) => block.number)
-);
+const latestBlockNumber$ = latestBlock$.pipe(map((block) => block.number));
 
 latestBlockNumber$
   .pipe(

diff --git a/packages/block-logs-stream/package.json b/packages/block-logs-stream/package.json
@@ -29,7 +29,7 @@
     "abitype": "0.9.3",
     "debug": "^4.3.4",
     "rxjs": "7.5.5",
-    "viem": "1.3.1"
+    "viem": "1.6.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",

diff --git a/packages/block-logs-stream/src/blockRangeToLogs.ts b/packages/block-logs-stream/src/blockRangeToLogs.ts
@@ -1,7 +1,7 @@
 import { EMPTY, OperatorFunction, concatMap, from, pipe, tap } from "rxjs";
 import { FetchLogsResult, fetchLogs } from "./fetchLogs";
-import { AbiEvent, Address } from "abitype";
-import { BlockNumber, PublicClient } from "viem";
+import { AbiEvent } from "abitype";
+import { Address, BlockNumber, PublicClient } from "viem";
 
 export type BlockRangeToLogsOptions<TAbiEvents extends readonly AbiEvent[]> = {
   /**

diff --git a/packages/block-logs-stream/src/createBlockStream.ts b/packages/block-logs-stream/src/createBlockStream.ts
@@ -1,14 +1,17 @@
 import { Observable } from "rxjs";
 import type { Block, BlockTag, PublicClient } from "viem";
 
-export type CreateBlockStreamOptions = {
+export type CreateBlockStreamOptions<TBlockTag extends BlockTag> = {
   publicClient: PublicClient;
-  blockTag: BlockTag;
+  blockTag: TBlockTag;
 };
 
-export type CreateBlockStreamResult = Observable<Block>;
+export type CreateBlockStreamResult<TBlockTag extends BlockTag> = Observable<Block<bigint, false, TBlockTag>>;
 
-export function createBlockStream({ publicClient, blockTag }: CreateBlockStreamOptions): CreateBlockStreamResult {
+export function createBlockStream<TBlockTag extends BlockTag>({
+  publicClient,
+  blockTag,
+}: CreateBlockStreamOptions<TBlockTag>): CreateBlockStreamResult<TBlockTag> {
   return new Observable(function subscribe(subscriber) {
     return publicClient.watchBlocks({
       blockTag,

diff --git a/packages/block-logs-stream/src/fetchLogs.ts b/packages/block-logs-stream/src/fetchLogs.ts
@@ -1,7 +1,6 @@
-import { AbiEvent, Address } from "abitype";
-import { PublicClient, BlockNumber } from "viem";
+import { AbiEvent } from "abitype";
+import { Address, PublicClient, BlockNumber, GetLogsReturnType } from "viem";
 import { bigIntMin, wait } from "@latticexyz/common/utils";
-import { GetLogsResult, getLogs } from "./getLogs";
 import { debug } from "./debug";
 
 export type FetchLogsOptions<TAbiEvents extends readonly AbiEvent[]> = {
@@ -40,7 +39,7 @@ export type FetchLogsOptions<TAbiEvents extends readonly AbiEvent[]> = {
 export type FetchLogsResult<TAbiEvents extends readonly AbiEvent[]> = {
   fromBlock: BlockNumber;
   toBlock: BlockNumber;
-  logs: GetLogsResult<TAbiEvents>;
+  logs: GetLogsReturnType<undefined, TAbiEvents, true, BlockNumber, BlockNumber>;
 };
 
 /**
@@ -61,6 +60,7 @@ export type FetchLogsResult<TAbiEvents extends readonly AbiEvent[]> = {
 export async function* fetchLogs<TAbiEvents extends readonly AbiEvent[]>({
   maxBlockRange = 1000n,
   maxRetryCount = 3,
+  publicClient,
   ...getLogsOpts
 }: FetchLogsOptions<TAbiEvents>): AsyncGenerator<FetchLogsResult<TAbiEvents>> {
   let fromBlock = getLogsOpts.fromBlock;
@@ -70,13 +70,14 @@ export async function* fetchLogs<TAbiEvents extends readonly AbiEvent[]>({
   while (fromBlock <= getLogsOpts.toBlock) {
     try {
       const toBlock = fromBlock + blockRange;
-      const logs = await getLogs({ ...getLogsOpts, fromBlock, toBlock });
+      const logs = await publicClient.getLogs({ ...getLogsOpts, fromBlock, toBlock, strict: true });
       yield { fromBlock, toBlock, logs };
       fromBlock = toBlock + 1n;
       blockRange = bigIntMin(maxBlockRange, getLogsOpts.toBlock - fromBlock);
     } catch (error: unknown) {
       if (!(error instanceof Error)) throw error;
 
+      // TODO: figure out actual rate limit message for RPCs
       if (error.message.includes("rate limit exceeded") && retryCount < maxRetryCount) {
         const seconds = 2 * retryCount;
         debug(`too many requests, retrying in ${seconds}s`, error);
@@ -85,6 +86,7 @@ export async function* fetchLogs<TAbiEvents extends readonly AbiEvent[]>({
         continue;
       }
 
+      // TODO: figure out actual block range exceeded message for RPCs
       if (error.message.includes("block range exceeded")) {
         blockRange /= 2n;
         if (blockRange <= 0n) {