feat: support block overrides on readContract and multicall actions (#3922)

* chore: enable call block overrides test

* feat: support block overrides on readContract

* feat: support block overrides on multicall

Author: cruzdanilo

.changeset/dry-bobcats-unite.md

@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Added support for `blockOverrides` on `readContract`.

.changeset/sharp-goats-drive.md

@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Added support for `blockOverrides` on `multicall`.

src/actions/public/call.test.ts

@@ -237,14 +237,13 @@ test('args: override', async () => {
   )
 })
 
-test.skip('args: blockOverrides', async () => {
-  // TODO: don't skip once block overrides are supported in Anvil.
+test('args: blockOverrides', async () => {
   const { data } = await call(client, {
     data: getCurrentBlockTimestamp4bytes,
     code: multicall3ContractConfig.bytecode,
     blockOverrides: { time: 420n },
   })
-  expect(data).toMatchInlineSnapshot(fourTwenty)
+  expect(data).toMatchInlineSnapshot(`"0x${fourTwenty}"`)
 })
 
 test.skip('args: blobs', async () => {

src/actions/public/multicall.test.ts

@@ -8,6 +8,7 @@ import { describe, expect, test, vi } from 'vitest'
 import { Delegation, ErrorsExample, GH434 } from '~contracts/generated.js'
 import {
   baycContractConfig,
+  multicall3ContractConfig,
   usdcContractConfig,
   wagmiContractConfig,
 } from '~test/src/abis.js'
@@ -449,6 +450,36 @@ test('args: stateOverride', async () => {
   `)
 })
 
+test('args: blockOverrides', async () => {
+  expect(
+    await multicall(client, {
+      batchSize: 2,
+      contracts: [
+        {
+          ...multicall3ContractConfig,
+          functionName: 'getCurrentBlockTimestamp',
+        },
+        {
+          ...multicall3ContractConfig,
+          functionName: 'getCurrentBlockTimestamp',
+        },
+      ],
+      blockOverrides: { time: 420n },
+    }),
+  ).toMatchInlineSnapshot(`
+    [
+      {
+        "result": 420n,
+        "status": "success",
+      },
+      {
+        "result": 420n,
+        "status": "success",
+      },
+    ]
+  `)
+})
+
 test('args: authorizationList', async () => {
   const { contractAddress } = await deploy(client, {
     abi: Delegation.abi,

src/actions/public/multicall.ts

@@ -44,7 +44,11 @@ export type MulticallParameters<
   } = {},
 > = Pick<
   CallParameters,
-  'authorizationList' | 'blockNumber' | 'blockTag' | 'stateOverride'
+  | 'authorizationList'
+  | 'blockNumber'
+  | 'blockOverrides'
+  | 'blockTag'
+  | 'stateOverride'
 > & {
   /** The account to use for the multicall. */
   account?: Address | undefined
@@ -135,6 +139,7 @@ export async function multicall<
     authorizationList,
     allowFailure = true,
     blockNumber,
+    blockOverrides,
     blockTag,
     stateOverride,
   } = parameters
@@ -233,6 +238,7 @@ export async function multicall<
         args: [calls],
         authorizationList,
         blockNumber,
+        blockOverrides,
         blockTag,
         functionName: 'aggregate3',
         stateOverride,

src/actions/public/readContract.test.ts

@@ -6,7 +6,11 @@ import {
   SoladyAccount07,
   SoladyAccountFactory07,
 } from '~contracts/generated.js'
-import { baycContractConfig, wagmiContractConfig } from '~test/src/abis.js'
+import {
+  baycContractConfig,
+  multicall3ContractConfig,
+  wagmiContractConfig,
+} from '~test/src/abis.js'
 import { accounts, address } from '~test/src/constants.js'
 import {
   deploy,
@@ -151,6 +155,16 @@ describe('wagmi', () => {
       }),
     ).toEqual(fakeName)
   })
+
+  test('args: blockOverrides', async () => {
+    expect(
+      await readContract(client, {
+        ...multicall3ContractConfig,
+        functionName: 'getCurrentBlockTimestamp',
+        blockOverrides: { time: 420n },
+      }),
+    ).toEqual(420n)
+  })
 })
 
 describe('bayc', () => {

src/actions/public/readContract.ts

@@ -45,6 +45,7 @@ export type ReadContractParameters<
     | 'account'
     | 'authorizationList'
     | 'blockNumber'
+    | 'blockOverrides'
     | 'blockTag'
     | 'factory'
     | 'factoryData'

src/constants/abis.ts

@@ -41,6 +41,19 @@ export const multicall3Abi = [
     stateMutability: 'view',
     type: 'function',
   },
+  {
+    inputs: [],
+    name: 'getCurrentBlockTimestamp',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: 'timestamp',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
 ] as const
 
 export const batchGatewayAbi = [