viem 1.18.9 → 1.19.0

package/constants/bytes.ts

@@ -0,0 +1,2 @@
+export const zeroHash =
+  '0x0000000000000000000000000000000000000000000000000000000000000000' as const

package/constants/strings.ts

@@ -0,0 +1 @@
+export const presignMessagePrefix = '\x19Ethereum Signed Message:\n'

package/index.ts

@@ -582,6 +582,8 @@ export {
   minInt248,
   minInt256,
 } from './constants/number.js'
+export { zeroHash } from './constants/bytes.js'
+export { presignMessagePrefix } from './constants/strings.js'
 export {
   AbiConstructorNotFoundError,
   type AbiConstructorNotFoundErrorType,

package/package.json

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

package/types/eip1193.ts

@@ -707,6 +707,14 @@ export type TestRpcSchema<TMode extends string> = [
     Parameters: [hash: Hash]
     ReturnType: void
   },
+  /**
+   * @description Serializes the current state (including contracts code, contract's storage, accounts properties, etc.) into a savable data blob.
+   */
+  {
+    Method: `${TMode}_dumpState`
+    Parameters?: undefined
+    ReturnType: Hex
+  },
   /**
    * @description Turn on call traces for transactions that are returned to the user when they execute a transaction (instead of just txhash/receipt).
    */
@@ -733,6 +741,14 @@ export type TestRpcSchema<TMode extends string> = [
     Parameters?: undefined
     ReturnType: boolean
   },
+  /**
+   * @description Adds state previously dumped with `dumpState` to the current chain.
+   */
+  {
+    Method: `${TMode}_loadState`
+    Parameters?: [Hex]
+    ReturnType: void
+  },
   /**
    * @description Advance the block number of the network by a certain number of blocks
    * @link https://hardhat.org/hardhat-network/docs/reference#hardhat_mine

package/types/rpc.ts

@@ -17,7 +17,7 @@ import type {
   TransactionRequestEIP2930,
   TransactionRequestLegacy,
 } from './transaction.js'
-import type { UnionOmit } from './utils.js'
+import type { UnionOmit, UnionPartialBy } from './utils.js'
 
 export type Index = `0x${string}`
 export type Quantity = `0x${string}`
@@ -46,9 +46,18 @@ export type RpcTransactionRequest =
   | TransactionRequestLegacy<Quantity, Index, '0x0'>
   | TransactionRequestEIP2930<Quantity, Index, '0x1'>
   | TransactionRequestEIP1559<Quantity, Index, '0x2'>
-export type RpcTransaction<TPending extends boolean = boolean> = UnionOmit<
-  | TransactionLegacy<Quantity, Index, TPending, '0x0'>
-  | TransactionEIP2930<Quantity, Index, TPending, '0x1'>
-  | TransactionEIP1559<Quantity, Index, TPending, '0x2'>,
-  'typeHex'
+export type RpcTransaction<
+  TPending extends boolean = boolean,
+  // `yParity` is optional on the RPC type as some nodes do not return it
+  // for 1559 & 2930 transactions (they should!).
+  _optionalProperties extends 'yParity' = 'yParity',
+  _excludedProperties extends string = 'typeHex',
+> = UnionOmit<
+  UnionPartialBy<
+    | TransactionLegacy<Quantity, Index, TPending, '0x0'>
+    | TransactionEIP2930<Quantity, Index, TPending, '0x1'>
+    | TransactionEIP1559<Quantity, Index, TPending, '0x2'>,
+    _optionalProperties
+  >,
+  _excludedProperties
 >

package/types/transaction.ts

@@ -80,16 +80,21 @@ export type TransactionBase<
   v: TQuantity
   /** Value in wei sent with this transaction */
   value: TQuantity
+  /** The parity of the y-value of the secp256k1 signature. */
+  yParity: TIndex
 }
 export type TransactionLegacy<
   TQuantity = bigint,
   TIndex = number,
   TPending extends boolean = boolean,
   TType = 'legacy',
-> = TransactionBase<TQuantity, TIndex, TPending> &
+> = Omit<TransactionBase<TQuantity, TIndex, TPending>, 'yParity'> &
   FeeValuesLegacy<TQuantity> & {
+    /** EIP-2930 Access List. */
     accessList?: never
+    /** Chain ID that this transaction is valid on. */
     chainId?: TIndex
+    yParity?: never
     type: TType
   }
 export type TransactionEIP2930<
@@ -99,7 +104,9 @@ export type TransactionEIP2930<
   TType = 'eip2930',
 > = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesLegacy<TQuantity> & {
+    /** EIP-2930 Access List. */
     accessList: AccessList
+    /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
   }
@@ -110,7 +117,9 @@ export type TransactionEIP1559<
   TType = 'eip1559',
 > = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesEIP1559<TQuantity> & {
+    /** EIP-2930 Access List. */
     accessList: AccessList
+    /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
   }

package/types/utils.ts

@@ -194,6 +194,17 @@ export type UnionOmit<T, K extends keyof any> = T extends any
  */
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 
+/**
+ * @description Creates a type that is a partial of T, but with the required keys K.
+ *
+ * @example
+ * PartialBy<{ a: string, b: number } | { a: string, b: undefined, c: number }, 'a'>
+ * => { a?: string, b: number } | { a?: string, b: undefined, c: number }
+ */
+export type UnionPartialBy<T, K extends keyof T> = T extends any
+  ? PartialBy<T, K>
+  : never
+
 /**
  * @description Combines members of an intersection into a readable type.
  *

package/utils/formatters/transaction.ts

@@ -68,18 +68,33 @@ export function formatTransaction(transaction: Partial<RpcTransaction>) {
     typeHex: transaction.type ? transaction.type : undefined,
     value: transaction.value ? BigInt(transaction.value) : undefined,
     v: transaction.v ? BigInt(transaction.v) : undefined,
-  }
+  } as Transaction
+
+  transaction_.yParity = (() => {
+    // If `yParity` is provided, we will use it.
+    if (transaction.yParity) return Number(transaction.yParity)
+
+    // If no `yParity` provided, try derive from `v`.
+    if (typeof transaction_.v === 'bigint') {
+      if (transaction_.v === 0n || transaction_.v === 27n) return 0
+      if (transaction_.v === 1n || transaction_.v === 28n) return 1
+      if (transaction_.v >= 35n) return transaction_.v % 2n === 0n ? 1 : 0
+    }
+
+    return undefined
+  })()
 
   if (transaction_.type === 'legacy') {
     delete transaction_.accessList
     delete transaction_.maxFeePerGas
     delete transaction_.maxPriorityFeePerGas
+    delete transaction_.yParity
   }
   if (transaction_.type === 'eip2930') {
     delete transaction_.maxFeePerGas
     delete transaction_.maxPriorityFeePerGas
   }
-  return transaction_ as Transaction
+  return transaction_
 }
 
 export type DefineTransactionErrorType = DefineFormatterErrorType | ErrorType

package/utils/signature/hashMessage.ts

@@ -1,3 +1,4 @@
+import { presignMessagePrefix } from '../../constants/strings.js'
 import type { ErrorType } from '../../errors/utils.js'
 import type { ByteArray, Hex, SignableMessage } from '../../types/misc.js'
 import { type ConcatErrorType, concat } from '../data/concat.js'
@@ -32,7 +33,7 @@ export function hashMessage<TTo extends To = 'hex'>(
     return toBytes(message.raw)
   })()
   const prefixBytes = stringToBytes(
-    `\x19Ethereum Signed Message:\n${messageBytes.length}`,
+    `${presignMessagePrefix}${messageBytes.length}`,
   )
   return keccak256(concat([prefixBytes, messageBytes]), to_)
 }

package/utils/transaction/serializeTransaction.ts

@@ -121,12 +121,15 @@ function serializeTransactionEIP1559(
     serializedAccessList,
   ]
 
-  if (signature)
-    serializedTransaction.push(
-      signature.v === 27n ? '0x' : toHex(1), // yParity
-      trim(signature.r),
-      trim(signature.s),
-    )
+  if (signature) {
+    const yParity = (() => {
+      if (signature.v === 0n) return '0x'
+      if (signature.v === 1n) return toHex(1)
+
+      return signature.v === 27n ? '0x' : toHex(1)
+    })()
+    serializedTransaction.push(yParity, trim(signature.r), trim(signature.s))
+  }
 
   return concatHex([
     '0x02',
@@ -165,12 +168,15 @@ function serializeTransactionEIP2930(
     serializedAccessList,
   ]
 
-  if (signature)
-    serializedTransaction.push(
-      signature.v === 27n ? '0x' : toHex(1), // yParity
-      signature.r,
-      signature.s,
-    )
+  if (signature) {
+    const yParity = (() => {
+      if (signature.v === 0n) return '0x'
+      if (signature.v === 1n) return toHex(1)
+
+      return signature.v === 27n ? '0x' : toHex(1)
+    })()
+    serializedTransaction.push(yParity, trim(signature.r), trim(signature.s))
+  }
 
   return concatHex([
     '0x01',