viem 1.15.5 → 1.16.1

package/_types/types/withdrawal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawal.d.ts","sourceRoot":"","sources":["../../types/withdrawal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAEpC,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,GAAG,CAAA;IACZ,MAAM,EAAE,GAAG,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,cAAc,EAAE,GAAG,CAAA;CACpB,CAAA"}

package/_types/utils/formatters/proof.d.ts

@@ -0,0 +1,6 @@
+import type { ErrorType } from '../../errors/utils.js';
+import type { Proof } from '../../types/proof.js';
+import type { RpcProof } from '../../types/rpc.js';
+export type FormatProofErrorType = ErrorType;
+export declare function formatProof(proof: Partial<RpcProof>): Proof;
+//# sourceMappingURL=proof.d.ts.map

package/_types/utils/formatters/proof.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proof.d.ts","sourceRoot":"","sources":["../../../utils/formatters/proof.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAGlD,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAA;AAS5C,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,SASnD"}

package/actions/public/getProof.ts

@@ -0,0 +1,93 @@
+import type { Address } from 'abitype'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
+import type { Proof } from '../../types/proof.js'
+import type { RequestErrorType } from '../../utils/buildRequest.js'
+import {
+  type NumberToHexErrorType,
+  numberToHex,
+} from '../../utils/encoding/toHex.js'
+import {
+  type FormatProofErrorType,
+  formatProof,
+} from '../../utils/formatters/proof.js'
+
+export type GetProofParameters = {
+  /** Account address. */
+  address: Address
+  /** Array of storage-keys that should be proofed and included. */
+  storageKeys: Hash[]
+} & (
+  | {
+      /** The block number. */
+      blockNumber?: bigint
+      blockTag?: never
+    }
+  | {
+      blockNumber?: never
+      /**
+       * The block tag.
+       * @default 'latest'
+       */
+      blockTag?: BlockTag
+    }
+)
+
+export type GetProofReturnType = Proof
+
+export type GetProofErrorType =
+  | NumberToHexErrorType
+  | FormatProofErrorType
+  | RequestErrorType
+  | ErrorType
+
+/**
+ * Returns the account and storage values of the specified account including the Merkle-proof.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getProof.html
+ * - JSON-RPC Methods:
+ *   - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetProofParameters}
+ * @returns Proof data. {@link GetProofReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getProof } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const block = await getProof(client, {
+ *  address: '0x...',
+ *  storageKeys: ['0x...'],
+ * })
+ */
+export async function getProof<TChain extends Chain | undefined>(
+  client: Client<Transport, TChain>,
+  {
+    address,
+    blockNumber,
+    blockTag: blockTag_,
+    storageKeys,
+  }: GetProofParameters,
+): Promise<GetProofReturnType> {
+  const blockTag = blockTag_ ?? 'latest'
+
+  const blockNumberHex =
+    blockNumber !== undefined ? numberToHex(blockNumber) : undefined
+
+  const proof = await client.request({
+    method: 'eth_getProof',
+    params: [address, storageKeys, blockNumberHex || blockTag],
+  })
+
+  return formatProof(proof)
+}

package/clients/decorators/public.ts

@@ -126,6 +126,11 @@ import {
   type GetLogsReturnType,
   getLogs,
 } from '../../actions/public/getLogs.js'
+import {
+  type GetProofParameters,
+  type GetProofReturnType,
+  getProof,
+} from '../../actions/public/getProof.js'
 import {
   type GetStorageAtParameters,
   type GetStorageAtReturnType,
@@ -1065,6 +1070,31 @@ export type PublicActions<
   ) => Promise<
     GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>
   >
+  /**
+   * Returns the account and storage values of the specified account including the Merkle-proof.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/getProof.html
+   * - JSON-RPC Methods:
+   *   - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link GetProofParameters}
+   * @returns Proof data. {@link GetProofReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const block = await client.getProof({
+   *  address: '0x...',
+   *  storageKeys: ['0x...'],
+   * })
+   */
+  getProof: (args: GetProofParameters) => Promise<GetProofReturnType>
   /**
    * Returns an estimate for the max priority fee per gas (in wei) for a transaction
    * to be included in the next block.
@@ -1684,6 +1714,7 @@ export function publicActions<
     getFilterLogs: (args) => getFilterLogs(client, args),
     getGasPrice: () => getGasPrice(client),
     getLogs: (args) => getLogs(client, args as any),
+    getProof: (args) => getProof(client, args),
     estimateMaxPriorityFeePerGas: (args) =>
       estimateMaxPriorityFeePerGas(client, args),
     getStorageAt: (args) => getStorageAt(client, args),

package/errors/version.ts

@@ -1 +1 @@
-export const version = '1.15.5'
+export const version = '1.16.0'

package/index.ts

@@ -948,6 +948,7 @@ export type {
   RpcTransactionRequest,
   RpcUncle,
 } from './types/rpc.js'
+export type { Withdrawal } from './types/withdrawal.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": "1.15.5",
+  "version": "1.16.1",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -139,7 +139,7 @@
     "@scure/bip32": "1.3.2",
     "@scure/bip39": "1.2.1",
     "abitype": "0.9.8",
-    "isows": "1.0.2",
+    "isows": "1.0.3",
     "ws": "8.13.0"
   },
   "license": "MIT",

package/types/block.ts

@@ -2,6 +2,7 @@ import type { Address } from 'abitype'
 
 import type { Hash, Hex } from './misc.js'
 import type { Transaction } from './transaction.js'
+import type { Withdrawal } from './withdrawal.js'
 
 export type Block<
   TQuantity = bigint,
@@ -56,6 +57,10 @@ export type Block<
   transactionsRoot: Hash
   /** List of uncle hashes */
   uncles: Hash[]
+  /** List of withdrawal objects */
+  withdrawals?: Withdrawal[]
+  /** Root of the this block’s withdrawals trie */
+  withdrawalsRoot?: Hex
 }
 
 export type BlockIdentifier<TQuantity = bigint> = {

package/types/eip1193.ts

@@ -9,6 +9,7 @@ import type {
   RpcBlockNumber as BlockNumber,
   RpcFeeHistory as FeeHistory,
   RpcLog as Log,
+  RpcProof as Proof,
   RpcTransaction as Transaction,
   RpcTransactionReceipt as TransactionReceipt,
   RpcTransactionRequest as TransactionRequest,
@@ -447,6 +448,26 @@ export type PublicRpcSchema = [
     ]
     ReturnType: Log[]
   },
+  /**
+   * @description Returns the account and storage values of the specified account including the Merkle-proof.
+   * @link https://eips.ethereum.org/EIPS/eip-1186
+   * @example
+   * provider.request({ method: 'eth_getProof', params: ['0x...', ['0x...'], 'latest'] })
+   * // => {
+   * //   ...
+   * // }
+   */
+  {
+    Method: 'eth_getProof'
+    Parameters: [
+      /** Address of the account. */
+      address: Address,
+      /** An array of storage-keys that should be proofed and included. */
+      storageKeys: Hash[],
+      block: BlockNumber | BlockTag,
+    ]
+    ReturnType: Proof
+  },
   /**
    * @description Returns the value from a storage position at an address
    * @link https://eips.ethereum.org/EIPS/eip-1474

package/types/proof.ts

@@ -0,0 +1,20 @@
+import type { Address } from 'abitype'
+import type { Hash } from './misc.js'
+
+export type AccountProof = Hash
+
+export type StorageProof<TQuantity = bigint> = {
+  key: Hash
+  proof: Hash[]
+  value: TQuantity
+}
+
+export type Proof<TQuantity = bigint, TIndex = number> = {
+  address: Address
+  balance: TQuantity
+  codeHash: Hash
+  nonce: TIndex
+  storageHash: Hash
+  accountProof: AccountProof[]
+  storageProof: StorageProof<TQuantity>[]
+}

package/types/rpc.ts

@@ -7,6 +7,7 @@ import type {
 } from './block.js'
 import type { FeeHistory, FeeValues } from './fee.js'
 import type { Log } from './log.js'
+import type { Proof } from './proof.js'
 import type {
   TransactionEIP1559,
   TransactionEIP2930,
@@ -34,6 +35,7 @@ export type RpcUncle = Uncle<Quantity>
 export type RpcFeeHistory = FeeHistory<Quantity>
 export type RpcFeeValues = FeeValues<Quantity>
 export type RpcLog = Log<Quantity, Index>
+export type RpcProof = Proof<Quantity, Index>
 export type RpcTransactionReceipt = TransactionReceipt<
   Quantity,
   Index,

package/types/withdrawal.ts

@@ -0,0 +1,8 @@
+import type { Hex } from './misc.js'
+
+export type Withdrawal = {
+  address: Hex
+  amount: Hex
+  index: Hex
+  validatorIndex: Hex
+}

package/utils/formatters/proof.ts

@@ -0,0 +1,24 @@
+import type { ErrorType } from '../../errors/utils.js'
+import type { Proof } from '../../types/proof.js'
+import type { RpcProof } from '../../types/rpc.js'
+import { hexToNumber } from '../index.js'
+
+export type FormatProofErrorType = ErrorType
+
+function formatStorageProof(storageProof: RpcProof['storageProof']) {
+  return storageProof.map((proof) => ({
+    ...proof,
+    value: BigInt(proof.value),
+  }))
+}
+
+export function formatProof(proof: Partial<RpcProof>) {
+  return {
+    ...proof,
+    balance: proof.balance ? BigInt(proof.balance) : undefined,
+    nonce: proof.nonce ? hexToNumber(proof.nonce) : undefined,
+    storageProof: proof.storageProof
+      ? formatStorageProof(proof.storageProof)
+      : undefined,
+  } as Proof
+}