feat: upgrade viem to v2 #2284

tash-2s · 2024-02-20T18:55:31Z

changeset-bot · 2024-02-20T18:55:35Z

🦋 Changeset detected

Latest commit: 39af8bb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 30 packages

Name	Type
@latticexyz/block-logs-stream	Major
@latticexyz/cli	Major
@latticexyz/common	Major
@latticexyz/config	Major
@latticexyz/dev-tools	Major
@latticexyz/faucet	Major
@latticexyz/protocol-parser	Major
@latticexyz/schema-type	Major
@latticexyz/store-indexer	Major
@latticexyz/store-sync	Major
@latticexyz/store	Major
@latticexyz/world	Major
create-mud	Major
@latticexyz/world-modules	Major
@latticexyz/recs	Major
@latticexyz/react	Major
@latticexyz/abi-ts	Major
@latticexyz/ecs-browser	Major
@latticexyz/gas-report	Major
@latticexyz/network	Major
@latticexyz/noise	Major
@latticexyz/phaserx	Major
@latticexyz/services	Major
@latticexyz/solecs	Major
solhint-config-mud	Major
solhint-plugin-mud	Major
@latticexyz/std-client	Major
@latticexyz/std-contracts	Major
@latticexyz/store-cache	Major
@latticexyz/utils	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

tash-2s · 2024-02-20T19:05:29Z

warning when executing pnpm install at the repository root:

 WARN  Issues with peer dependencies found
packages/cli
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

packages/config
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

packages/faucet
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

packages/react
└─┬ @testing-library/react-hooks 8.0.1
  ├── ✕ unmet peer @types/react@"^16.9.0 || ^17.0.0": found 18.2.22
  ├── ✕ unmet peer react@"^16.9.0 || ^17.0.0": found 18.2.0
  └── ✕ unmet peer react-test-renderer@"^16.9.0 || ^17.0.0": found 18.2.0

packages/store
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

packages/store-indexer
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

packages/store-sync
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

packages/world
└─┬ viem 2.7.11
  └─┬ abitype 1.0.0
    └── ✕ unmet peer zod@"^3 >=3.22.0": found 3.21.4

holic · 2024-02-20T20:49:41Z

I think we could bump zod here too! At least to the minimum range expected by viem/abitype.

I wouldn't worry about the warnings for React-related packages, can solve that separately.

tash-2s · 2024-02-20T20:54:57Z

@holic The abitype's zod peer dependency is optional, and we're not using abitype/zod, so I believe it doesn't cause an issue. But it's better to resolve the warning later.

Correction: viem uses abitype but doesn't use abitype/zod (so the warning shouldn't be an actual issue)

tash-2s · 2024-02-20T21:11:04Z

Also, I might be able to pass the typescript test without upgrading the mud's abitype, but also it's better to upgrade it alongside viem.

holic · 2024-02-20T22:51:04Z

but also it's better to upgrade it alongside viem

agree on aligning our abitype version with the one that viem's version uses

holic · 2024-02-21T10:41:17Z

packages/block-logs-stream/tsconfig.json

@@ -9,6 +9,7 @@
    "isolatedModules": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,


what are the consequences of this?

By leaving skipLibCheck at default false, I encounter the following error:

cd packages/block-logs-stream && pnpm tsc --noEmit

../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(51,217): error TS2536: Type 'K_1' cannot be used to index type '{ gas: bigint; value: bigint; blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; ... 11 more ...; type: "legacy"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(75,82): error TS2536: Type 'K' cannot be used to index type '{ [K_1 in keyof { gas: bigint; value: bigint; blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; ... 11 more ...; type: "legacy"; } as K_1 extends keyof TOverrideRetu...'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(99,217): error TS2536: Type 'K_1' cannot be used to index type '{ gas: bigint; value: bigint; blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; ... 11 more ...; type: "legacy"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(147,217): error TS2536: Type 'K_3' cannot be used to index type '{ blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip2930"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(171,88): error TS2536: Type 'K_2' cannot be used to index type '{ [K_3 in keyof { blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip2930"; } as K_3 extends ...'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(195,217): error TS2536: Type 'K_3' cannot be used to index type '{ blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip2930"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(243,217): error TS2536: Type 'K_5' cannot be used to index type '{ blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip1559"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(267,88): error TS2536: Type 'K_4' cannot be used to index type '{ [K_5 in keyof { blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip1559"; } as K_5 extends ...'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(291,217): error TS2536: Type 'K_5' cannot be used to index type '{ blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip1559"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(339,219): error TS2536: Type 'K_7' cannot be used to index type '{ blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip4844"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(363,88): error TS2536: Type 'K_6' cannot be used to index type '{ [K_7 in keyof { blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip4844"; } as K_7 extends ...'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transaction.d.ts(387,219): error TS2536: Type 'K_7' cannot be used to index type '{ blockHash: `0x${string}` | null; blockNumber: bigint | null; from: `0x${string}`; gas: bigint; hash: `0x${string}`; input: `0x${string}`; nonce: number; r: `0x${string}`; s: `0x${string}`; to: `0x${string}` | null; transactionIndex: number | null; ... 11 more ...; type: "eip4844"; }'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transactionRequest.d.ts(21,598): error TS2536: Type 'K' cannot be used to index type '{ [K_1 in keyof TransactionRequestLegacy<`0x${string}`, `0x${string}`, "0x0"> as K_1 extends keyof TOverrideReturnType ? TOverrideReturnType[K_1] extends void ? never : K_1 : K_1]: K_1 extends keyof TOverrideReturnType ? TOverrideReturnType[K_1] : TransactionRequestLegacy<...>[K_1]; } & TOverrideReturnType'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transactionRequest.d.ts(21,1558): error TS2536: Type 'K_2' cannot be used to index type '{ [K_3 in keyof TransactionRequestEIP2930<`0x${string}`, `0x${string}`, "0x1"> as K_3 extends keyof TOverrideReturnType ? TOverrideReturnType[K_3] extends void ? never : K_3 : K_3]: K_3 extends keyof TOverrideReturnType ? TOverrideReturnType[K_3] : TransactionRequestEIP2930<...>[K_3]; } & TOverrideReturnType'. ../../node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/viem/_types/utils/formatters/transactionRequest.d.ts(21,2522): error TS2536: Type 'K_4' cannot be used to index type '{ [K_5 in keyof TransactionRequestEIP1559<`0x${string}`, `0x${string}`, "0x2"> as K_5 extends keyof TOverrideReturnType ? TOverrideReturnType[K_5] extends void ? never : K_5 : K_5]: K_5 extends keyof TOverrideReturnType ? TOverrideReturnType[K_5] : TransactionRequestEIP1559<...>[K_5]; } & TOverrideReturnType'.

This is the same error mentioned in wevm/viem#1828 (comment), where it's suggested to enable the flag. It appears that viem and its examples have this flag turned on.

By setting "skipLibCheck": true, our tsc skips type checking of declaration files. I'll look into this to see if there's a better solution.

"skipLibCheck": true is necessary for using viem, and even in the viem repository, the same error occurs when removing the "skipLibCheck": true. I believe there isn't a good way to maintain "skipLibCheck": false, although I don't fully understand the exact cause of the error.

Skipping the check should be fine here because the declaration files are not utilized in the packages where I enabled the flag, making it relevant only for library files.

holic · 2024-02-21T10:41:50Z

packages/cli/src/deploy/ensureWorldFactory.ts

@@ -17,7 +17,7 @@ export const accessManagementSystemDeployedBytecodeSize = size(
 );
 export const accessManagementSystemBytecode = encodeDeployData({
  bytecode: accessManagementSystemBuild.bytecode.object as Hex,
-  abi: [],
+  abi: [] as Abi,


why do we have to cast this? I would expect TS to be able to infer this in the call to encodeDeployData

abi: [] is now not allowed for encodeDeployData. I think [] is not the abi expected here. I'll look into this.

src/deploy/ensureWorldFactory.ts:18:64 - error TS2345: Argument of type '{ bytecode: `0x${string}`; abi: never[]; }' is not assignable to parameter of type 'never'. 18 export const accessManagementSystemBytecode = encodeDeployData({ ~ 19 bytecode: accessManagementSystemBuild.bytecode.object as Hex, ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 20 abi: [], ~~~~~~~~~~ 21 }); ~

The encodeDeployData function does the task only if the contract has constructor args. It appears to have started rejecting abis with no effects at the type level? The logic of the function hasn't changed, so its behavior remains the same as before.

Alternatively, we can bypass this function:

diff --git a/packages/cli/src/deploy/ensureWorldFactory.ts b/packages/cli/src/deploy/ensureWorldFactory.ts index 1f2913a8..f45cbed8 100644 --- a/packages/cli/src/deploy/ensureWorldFactory.ts +++ b/packages/cli/src/deploy/ensureWorldFactory.ts @@ -15,10 +15,7 @@ import { Contract } from "./ensureContract"; export const accessManagementSystemDeployedBytecodeSize = size( accessManagementSystemBuild.deployedBytecode.object as Hex ); -export const accessManagementSystemBytecode = encodeDeployData({ - bytecode: accessManagementSystemBuild.bytecode.object as Hex, - abi: [] as Abi, -}); +export const accessManagementSystemBytecode = accessManagementSystemBuild.bytecode.object as Hex; export const accessManagementSystem = getCreate2Address({ from: deployer, bytecode: accessManagementSystemBytecode,

seems fine to leave the empty ABI approach! feels clearer to me

holic · 2024-02-21T10:42:48Z

packages/common/src/chains/latticeTestnet.ts

@@ -3,7 +3,6 @@ import type { MUDChain } from "./types";
 export const latticeTestnet = {
  name: "Lattice Testnet",
  id: 4242,
-  network: "lattice-testnet",


for anyone reading: the network key got removed from Chain in latest viem (I think this was a ethers carry-over)

The network field was removed in this commit. It suggests using the id field instead when necessary.

tash-2s · 2024-02-22T05:17:50Z

packages/world/ts/encodeSystemCall.ts

-export function encodeSystemCall<abi extends Abi, functionName extends string = string>({
+export function encodeSystemCall<abi extends Abi, functionName extends ContractFunctionName<abi>>({
  abi,
  systemId,
  functionName,
  args,
-}: SystemCall<abi, functionName>): GetFunctionArgs<typeof IWorldCallAbi, "call">["args"] {
+}: SystemCall<abi, functionName>): AbiParametersToPrimitiveTypes<
+  ExtractAbiFunction<typeof IWorldCallAbi, "call">["inputs"]
+> {


These encode call functions have been manually tested like this:

await worldContract.write.call( encodeSystemCall({ abi: worldContract.abi, functionName: "addTask", args: [label], systemId: resourceToHex({ type: "system", namespace: "", name: "TasksSystem" }), }) ); await worldContract.write.batchCall([ encodeSystemCalls(worldContract.abi, [ { functionName: "addTask", args: [label], systemId: resourceToHex({ type: "system", namespace: "", name: "TasksSystem" }), }, ]).map(([systemId, callData]) => ({ systemId, callData })), ]); await worldContract.write.callFrom( encodeSystemCallFrom({ from: walletClient.account.address, abi: worldContract.abi, functionName: "addTask", args: [label], systemId: resourceToHex({ type: "system", namespace: "", name: "TasksSystem" }), }) ); await worldContract.write.batchCallFrom([ encodeSystemCallsFrom(worldContract.abi, walletClient.account.address, [ { functionName: "addTask", args: [label], systemId: resourceToHex({ type: "system", namespace: "", name: "TasksSystem" }), }, ]).map(([from, systemId, callData]) => ({ from, systemId, callData })), ]);

packages/common/src/getContract.ts

packages/common/src/sendTransaction.ts

holic · 2024-02-22T19:28:41Z

packages/common/src/getContract.ts

+      wallet: walletClient,
+    },
+  }) as unknown as GetContractReturnType<TAbi, { public: TPublicClient; wallet: TWalletClient }, TAddress> & {
+    write: unknown;


what does this bit do? do we need it?

This corresponds to this viem code. At the type level, the properties attached to the contract object depend on the clients and the abi types. Since the actual abi type isn't known here, I needed to specify it to have the 'write' property. (To fix Property 'write' does not exist on type '... typescript error)
There might be a better way to handle this?

While calling this MUD's getContract, it is typed the same as Viem's since it uses the same arguments and return type.

holic · 2024-02-22T19:29:15Z

packages/common/src/getContract.ts

@@ -98,11 +108,11 @@ export function getContract<
              args,
              ...options,
              onWrite,
-            } as unknown as WriteContractParameters<TAbi, typeof functionName, TChain, TAccount>;
+            } as unknown as WriteContractParameters;


are we losing type specificity/safety here?

This loses some type specificity. I'll fix it.

holic · 2024-02-22T19:31:55Z

packages/world/ts/encodeSystemCall.ts

  return [
    systemId,
    encodeFunctionData({
      abi,
      functionName,
      args,
-    } as unknown as EncodeFunctionDataParameters<abi, functionName>),
+    } as unknown as EncodeFunctionDataParameters),


same as above, are we losing any type specificity/safety here?

holic

this is looking great!

just a few comments and I went ahead and added a changeset

tash-2s · 2024-02-22T21:28:21Z

@holic Thank you so much for the review and the changeset! I've addressed the comments and resolved the conflict.

tash-2s added 2 commits February 20, 2024 12:49

upgrade viem to latest (v2)

8d2cad9

pnpm install

1cc4f8d

tash-2s added 2 commits February 20, 2024 22:42

upgrade abitype

106fa22

wip: test passes but should be wrong

ec2ee10

holic reviewed Feb 21, 2024

View reviewed changes

tash-2s mentioned this pull request Feb 21, 2024

Better wallet support #2256

Closed

tash-2s added 2 commits February 21, 2024 20:50

refactor

ff11b79

fix encodeSystemCall issue

8b9d9ce

tash-2s changed the title ~~upgrade viem to v2~~ build: upgrade viem to v2 Feb 22, 2024

tash-2s marked this pull request as ready for review February 22, 2024 04:02

tash-2s requested review from alvrs and yonadaa as code owners February 22, 2024 04:02

viem: 2.7.11 => 2.7.12

7574d7a

tash-2s commented Feb 22, 2024

View reviewed changes

packages/common/src/getContract.ts Show resolved Hide resolved

tash-2s commented Feb 22, 2024

View reviewed changes

packages/common/src/sendTransaction.ts Show resolved Hide resolved

update mud_getContract args to match with viem_getContract

a435b97

holic changed the title ~~build: upgrade viem to v2~~ feat: upgrade viem to v2 Feb 22, 2024

Create twelve-gorillas-learn.md

63eb5ee

holic reviewed Feb 22, 2024

View reviewed changes

tash-2s added 2 commits February 22, 2024 15:05

detail types

39c49d3

Merge remote-tracking branch 'main' into viem-v2

1cea93b

tash-2s mentioned this pull request Feb 23, 2024

WIP: viem custom client within external wallet example #2294

Closed

Update twelve-gorillas-learn.md

39af8bb

holic approved these changes Feb 23, 2024

View reviewed changes

holic merged commit d7b1c58 into latticexyz:main Feb 23, 2024
10 of 11 checks passed

tash-2s deleted the viem-v2 branch February 23, 2024 13:48

tash-2s mentioned this pull request Feb 23, 2024

feat(examples): add external wallet support example #2268

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: upgrade viem to v2 #2284

feat: upgrade viem to v2 #2284

tash-2s commented Feb 20, 2024 •

edited

Loading

changeset-bot bot commented Feb 20, 2024 •

edited

Loading

tash-2s commented Feb 20, 2024

holic commented Feb 20, 2024 •

edited

Loading

tash-2s commented Feb 20, 2024 •

edited

Loading

tash-2s commented Feb 20, 2024

holic commented Feb 20, 2024

holic Feb 21, 2024

tash-2s Feb 21, 2024

tash-2s Feb 22, 2024

holic Feb 21, 2024

tash-2s Feb 21, 2024

tash-2s Feb 22, 2024

holic Feb 22, 2024 •

edited

Loading

holic Feb 21, 2024

tash-2s Feb 22, 2024

tash-2s Feb 22, 2024 •

edited

Loading

holic Feb 22, 2024

tash-2s Feb 22, 2024 •

edited

Loading

tash-2s Feb 22, 2024

holic Feb 22, 2024 •

edited

Loading

tash-2s Feb 22, 2024

holic Feb 22, 2024

holic left a comment

tash-2s commented Feb 22, 2024

feat: upgrade viem to v2 #2284

feat: upgrade viem to v2 #2284

Conversation

tash-2s commented Feb 20, 2024 • edited Loading

changeset-bot bot commented Feb 20, 2024 • edited Loading

🦋 Changeset detected

tash-2s commented Feb 20, 2024

holic commented Feb 20, 2024 • edited Loading

tash-2s commented Feb 20, 2024 • edited Loading

tash-2s commented Feb 20, 2024

holic commented Feb 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holic Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tash-2s Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tash-2s Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holic Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holic left a comment

Choose a reason for hiding this comment

tash-2s commented Feb 22, 2024

tash-2s commented Feb 20, 2024 •

edited

Loading

changeset-bot bot commented Feb 20, 2024 •

edited

Loading

holic commented Feb 20, 2024 •

edited

Loading

tash-2s commented Feb 20, 2024 •

edited

Loading

holic Feb 22, 2024 •

edited

Loading

tash-2s Feb 22, 2024 •

edited

Loading

tash-2s Feb 22, 2024 •

edited

Loading

holic Feb 22, 2024 •

edited

Loading