viem 2.7.1 → 2.7.3

package/errors/contract.ts

@@ -17,6 +17,7 @@ import { formatGwei } from '../utils/unit/formatGwei.js'
 
 import { AbiErrorSignatureNotFoundError } from './abi.js'
 import { BaseError } from './base.js'
+import { prettyStateOverride } from './stateOverride.js'
 import { prettyPrint } from './transaction.js'
 import { getContractAddress } from './utils.js'
 
@@ -42,10 +43,11 @@ export class CallExecutionError extends BaseError {
       nonce,
       to,
       value,
+      stateOverride,
     }: CallParameters & { chain?: Chain; docsPath?: string },
   ) {
     const account = account_ ? parseAccount(account_) : undefined
-    const prettyArgs = prettyPrint({
+    let prettyArgs = prettyPrint({
       from: account?.address,
       to,
       value:
@@ -64,6 +66,10 @@ export class CallExecutionError extends BaseError {
       nonce,
     })
 
+    if (stateOverride) {
+      prettyArgs += `\n${prettyStateOverride(stateOverride)}`
+    }
+
     super(cause.shortMessage, {
       cause,
       docsPath,

package/errors/data.ts

@@ -39,3 +39,25 @@ export class SizeExceedsPaddingSizeError extends BaseError {
     )
   }
 }
+
+export type InvalidBytesLengthErrorType = InvalidBytesLengthError & {
+  name: 'InvalidBytesLengthError'
+}
+export class InvalidBytesLengthError extends BaseError {
+  override name = 'InvalidBytesLengthError'
+  constructor({
+    size,
+    targetSize,
+    type,
+  }: {
+    size: number
+    targetSize: number
+    type: 'hex' | 'bytes'
+  }) {
+    super(
+      `${type.charAt(0).toUpperCase()}${type
+        .slice(1)
+        .toLowerCase()} is expected to be ${targetSize} ${type} long, but is ${size} ${type} long.`,
+    )
+  }
+}

package/errors/stateOverride.ts

@@ -0,0 +1,50 @@
+import type { StateMapping, StateOverride } from '../types/stateOverride.js'
+import { BaseError } from './base.js'
+
+export type AccountStateConflictErrorType = AccountStateConflictError & {
+  name: 'AccountStateConflictError'
+}
+
+export class AccountStateConflictError extends BaseError {
+  override name = 'AccountStateConflictError'
+  constructor({ address }: { address: string }) {
+    super(`State for account "${address}" is set multiple times.`)
+  }
+}
+
+export type StateAssignmentConflictErrorType = StateAssignmentConflictError & {
+  name: 'StateAssignmentConflictError'
+}
+
+export class StateAssignmentConflictError extends BaseError {
+  override name = 'StateAssignmentConflictError'
+  constructor() {
+    super('state and stateDiff are set on the same account.')
+  }
+}
+
+export function prettyStateMapping(stateMapping: StateMapping) {
+  return stateMapping.reduce((pretty, { slot, value }) => {
+    return `${pretty}        ${slot}: ${value}\n`
+  }, '')
+}
+
+export function prettyStateOverride(stateOverride: StateOverride) {
+  return stateOverride
+    .reduce((pretty, { address, ...state }) => {
+      let val = `${pretty}    ${address}:\n`
+      if (state.nonce) val += `      nonce: ${state.nonce}\n`
+      if (state.balance) val += `      balance: ${state.balance}\n`
+      if (state.code) val += `      code: ${state.code}\n`
+      if (state.state) {
+        val += '      state:\n'
+        val += prettyStateMapping(state.state)
+      }
+      if (state.stateDiff) {
+        val += '      stateDiff:\n'
+        val += prettyStateMapping(state.stateDiff)
+      }
+      return val
+    }, '  State Override:\n')
+    .slice(0, -1)
+}

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.7.1'
+export const version = '2.7.3'

package/index.ts

@@ -852,6 +852,12 @@ export {
   UrlRequiredError,
   type UrlRequiredErrorType,
 } from './errors/transport.js'
+export {
+  AccountStateConflictError,
+  type AccountStateConflictErrorType,
+  StateAssignmentConflictError,
+  type StateAssignmentConflictErrorType,
+} from './errors/stateOverride.js'
 export type {
   AbiItem,
   ExtractAbiFunctionForArgs,
@@ -973,8 +979,15 @@ export type {
   RpcUncle,
   Status,
   RpcProof,
+  RpcAccountStateOverride,
+  RpcStateOverride,
+  RpcStateMapping,
 } from './types/rpc.js'
 export type { Withdrawal } from './types/withdrawal.js'
+export type {
+  StateMapping,
+  StateOverride,
+} from './types/stateOverride.js'
 export { labelhash, type LabelhashErrorType } from './utils/ens/labelhash.js'
 export { namehash, type NamehashErrorType } from './utils/ens/namehash.js'
 export {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.7.1",
+  "version": "2.7.3",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/types/eip1193.ts

@@ -2,6 +2,7 @@ import type { Address } from 'abitype'
 
 import type { BlockTag } from './block.js'
 import type { Hash, Hex, LogTopic } from './misc.js'
+import type { RpcStateOverride } from './rpc.js'
 import type {
   Quantity,
   RpcBlock as Block,
@@ -232,6 +233,11 @@ export type PublicRpcSchema = [
           transaction: Partial<TransactionRequest>,
           block: BlockNumber | BlockTag | BlockIdentifier,
         ]
+      | [
+          transaction: Partial<TransactionRequest>,
+          block: BlockNumber | BlockTag | BlockIdentifier,
+          stateOverrideSet: RpcStateOverride,
+        ]
     ReturnType: Hex
   },
   /**

package/types/rpc.ts

@@ -1,3 +1,4 @@
+import type { Address } from 'abitype'
 import type {
   Block,
   BlockIdentifier,
@@ -7,6 +8,7 @@ import type {
 } from './block.js'
 import type { FeeHistory, FeeValues } from './fee.js'
 import type { Log } from './log.js'
+import type { Hex } from './misc.js'
 import type { Proof } from './proof.js'
 import type {
   TransactionEIP1559,
@@ -103,3 +105,25 @@ export type RpcResponse<TResult = any, TError = any> = {
   | ErrorResult<TError>
   | Subscription<TResult, TError>
 )
+
+/** A key-value mapping of slot and storage values (supposedly 32 bytes each) */
+export type RpcStateMapping = {
+  [slots: Hex]: Hex
+}
+
+export type RpcAccountStateOverride = {
+  /** Fake balance to set for the account before executing the call. <32 bytes */
+  balance?: Hex
+  /** Fake nonce to set for the account before executing the call. <8 bytes */
+  nonce?: Hex
+  /** Fake EVM bytecode to inject into the account before executing the call. */
+  code?: Hex
+  /** Fake key-value mapping to override all slots in the account storage before executing the call. */
+  state?: RpcStateMapping
+  /** Fake key-value mapping to override individual slots in the account storage before executing the call. */
+  stateDiff?: RpcStateMapping
+}
+
+export type RpcStateOverride = {
+  [address: Address]: RpcAccountStateOverride
+}

package/types/stateOverride.ts

@@ -0,0 +1,26 @@
+import type { Address } from 'abitype'
+import type { Hex } from './misc.js'
+import type { OneOf } from './utils.js'
+
+export type StateMapping = Array<{
+  slot: Hex
+  value: Hex
+}>
+
+export type StateOverride = Array<
+  {
+    address: Address
+    balance?: bigint
+    nonce?: number
+    code?: Hex
+  } & OneOf<
+    | {
+        /** Fake key-value mapping to override all slots in the account storage before executing the call. */
+        state?: StateMapping
+      }
+    | {
+        /** Fake key-value mapping to override individual slots in the account storage before executing the call. */
+        stateDiff?: StateMapping
+      }
+  >
+>