viem 2.21.60 → 2.22.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.21.60",
+  "version": "2.22.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -177,7 +177,7 @@
     "@scure/bip39": "1.5.0",
     "abitype": "1.0.7",
     "isows": "1.0.6",
-    "ox": "0.4.4",
+    "ox": "0.6.0",
     "webauthn-p256": "0.0.10",
     "ws": "8.18.0"
   },

package/types/calls.ts

@@ -3,31 +3,40 @@ import type { Hex } from './misc.js'
 import type { GetMulticallContractParameters } from './multicall.js'
 import type { OneOf, Prettify } from './utils.js'
 
-export type Call<call = unknown> = OneOf<
-  | {
+export type Call<
+  call = unknown,
+  extraProperties extends Record<string, unknown> = {},
+> = OneOf<
+  | (extraProperties & {
       data?: Hex | undefined
       to: Address
       value?: bigint | undefined
-    }
-  | (Omit<
-      GetMulticallContractParameters<call, AbiStateMutability>,
-      'address'
-    > & {
-      to: Address
-      value?: bigint | undefined
     })
+  | (extraProperties &
+      (Omit<
+        GetMulticallContractParameters<call, AbiStateMutability>,
+        'address'
+      > & {
+        to: Address
+        value?: bigint | undefined
+      }))
 >
 
 export type Calls<
   calls extends readonly unknown[],
+  extraProperties extends Record<string, unknown> = {},
   ///
   result extends readonly any[] = [],
 > = calls extends readonly [] // no calls, return empty
   ? readonly []
   : calls extends readonly [infer call] // one call left before returning `result`
-    ? readonly [...result, Prettify<Call<call>>]
+    ? readonly [...result, Prettify<Call<call, extraProperties>>]
     : calls extends readonly [infer call, ...infer rest] // grab first call and recurse through `rest`
-      ? Calls<[...rest], [...result, Prettify<Call<call>>]>
+      ? Calls<
+          [...rest],
+          extraProperties,
+          [...result, Prettify<Call<call, extraProperties>>]
+        >
       : readonly unknown[] extends calls
         ? calls
         : // If `calls` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!

package/types/eip1193.ts

@@ -1,5 +1,6 @@
 import type { Address } from 'abitype'
 
+import type * as BlockOverrides from 'ox/BlockOverrides'
 import type {
   RpcEstimateUserOperationGasReturnType,
   RpcGetUserOperationByHashReturnType,
@@ -1124,6 +1125,43 @@ export type PublicRpcSchema = [
     Parameters: [signedTransaction: Hex]
     ReturnType: Hash
   },
+  /**
+   * @description Simulates execution of a set of calls with optional block and state overrides.
+   * @example
+   * provider.request({ method: 'eth_simulateV1', params: [{ blockStateCalls: [{ calls: [{ from: '0x...', to: '0x...', value: '0x...', data: '0x...' }] }] }, 'latest'] })
+   * // => { ... }
+   */
+  {
+    Method: 'eth_simulateV1'
+    Parameters: [
+      {
+        blockStateCalls: readonly {
+          blockOverrides?: BlockOverrides.Rpc | undefined
+          calls?: readonly ExactPartial<TransactionRequest>[] | undefined
+          stateOverrides?: RpcStateOverride | undefined
+        }[]
+        returnFullTransactions?: boolean | undefined
+        traceTransfers?: boolean | undefined
+        validation?: boolean | undefined
+      },
+      BlockNumber | BlockTag,
+    ]
+    ReturnType: readonly (Block & {
+      calls: readonly {
+        error?:
+          | {
+              data?: Hex | undefined
+              code: number
+              message: string
+            }
+          | undefined
+        logs?: readonly Log[] | undefined
+        gasUsed: Hex
+        returnData: Hex
+        status: Hex
+      }[]
+    })[]
+  },
   /**
    * @description Destroys a filter based on filter ID
    * @link https://eips.ethereum.org/EIPS/eip-1474

package/types/multicall.ts

@@ -68,9 +68,10 @@ export type MulticallResults<
   contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
   allowFailure extends boolean = true,
   options extends {
-    error?: Error
+    error?: Error | undefined
+    extraProperties?: Record<string, unknown> | undefined
     mutability: AbiStateMutability
-  } = { error: Error; mutability: AbiStateMutability },
+  } = { error: Error; extraProperties: {}; mutability: AbiStateMutability },
   ///
   result extends any[] = [],
 > = contracts extends readonly [] // no contracts, return empty
@@ -81,7 +82,8 @@ export type MulticallResults<
         MulticallResponse<
           GetMulticallContractReturnType<contract, options['mutability']>,
           options['error'],
-          allowFailure
+          allowFailure,
+          options['extraProperties']
         >,
       ]
     : contracts extends readonly [infer contract, ...infer rest] // grab first contract and recurse through `rest`
@@ -94,12 +96,18 @@ export type MulticallResults<
             MulticallResponse<
               GetMulticallContractReturnType<contract, options['mutability']>,
               options['error'],
-              allowFailure
+              allowFailure,
+              options['extraProperties']
             >,
           ]
         >
       : readonly unknown[] extends contracts
-        ? MulticallResponse<unknown, options['error'], allowFailure>[]
+        ? MulticallResponse<
+            unknown,
+            options['error'],
+            allowFailure,
+            options['extraProperties']
+          >[]
         : // If `contracts` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!
           // use this to infer the param types in the case of Array.map() argument
           contracts extends readonly (infer contract extends
@@ -107,23 +115,34 @@ export type MulticallResults<
           ? MulticallResponse<
               GetMulticallContractReturnType<contract, options['mutability']>,
               options['error'],
-              allowFailure
+              allowFailure,
+              options['extraProperties']
             >[]
           : // Fallback
-            MulticallResponse<unknown, options['error'], allowFailure>[]
+            MulticallResponse<
+              unknown,
+              options['error'],
+              allowFailure,
+              options['extraProperties']
+            >[]
 
 export type MulticallResponse<
   result = unknown,
   error = unknown,
   allowFailure extends boolean = true,
+  extraProperties extends Record<string, unknown> | undefined = {},
 > = allowFailure extends true
   ?
-      | { error?: undefined; result: result; status: 'success' }
-      | {
+      | (extraProperties & {
+          error?: undefined
+          result: result
+          status: 'success'
+        })
+      | (extraProperties & {
           error: unknown extends error ? Error : error
           result?: undefined
           status: 'failure'
-        }
+        })
   : result
 
 // infer contract parameters from `unknown`