viem 2.7.22 → 2.8.0

package/types/account.ts

@@ -15,9 +15,9 @@ export type GetAccountParameter<
   TRequired extends boolean = true,
 > = IsUndefined<TAccount> extends true
   ? TRequired extends true
-    ? { account: TAccountOverride }
-    : { account?: TAccountOverride }
-  : { account?: TAccountOverride }
+    ? { account: TAccountOverride | Account | Address }
+    : { account?: TAccountOverride | Account | Address | undefined }
+  : { account?: TAccountOverride | Account | Address | undefined }
 
 export type ParseAccount<
   TAccountOrAddress extends Account | Address | undefined =

package/types/chain.ts

@@ -9,6 +9,7 @@ import type { FeeValuesType } from '../types/fee.js'
 import type {
   TransactionSerializable,
   TransactionSerializableGeneric,
+  TransactionSerializedGeneric,
 } from '../types/transaction.js'
 import type { IsNarrowable, IsUndefined, Prettify } from '../types/utils.js'
 import type { FormattedBlock } from '../utils/formatters/block.js'
@@ -162,7 +163,8 @@ export type ChainSerializers<
             ? TransactionSerializableGeneric &
                 Parameters<formatters['transactionRequest']['format']>[0]
             : TransactionSerializable
-          : TransactionSerializable
+          : TransactionSerializable,
+        TransactionSerializedGeneric
       >
     | undefined
 }

package/types/eip1193.ts

@@ -195,14 +195,14 @@ export type PublicRpcSchema = [
     ReturnType: Quantity
   },
   /**
-   * @description Returns the current blob price of gas expressed in wei
+   * @description Returns the base fee per blob gas in wei.
    *
    * @example
-   * provider.request({ method: 'eth_blobGasPrice' })
+   * provider.request({ method: 'eth_blobBaseFee' })
    * // => '0x09184e72a000'
    */
   {
-    Method: 'eth_blobGasPrice'
+    Method: 'eth_blobBaseFee'
     Parameters?: undefined
     ReturnType: Quantity
   },

package/types/eip4844.ts

@@ -0,0 +1,12 @@
+import type { ByteArray, Hex } from './misc.js'
+
+export type BlobSidecar<type extends Hex | ByteArray = Hex | ByteArray> = {
+  /** The blob associated with the transaction. */
+  blob: type
+  /** The KZG commitment corresponding to this blob. */
+  commitment: type
+  /** The KZG proof corresponding to this blob and commitment. */
+  proof: type
+}
+export type BlobSidecars<type extends Hex | ByteArray = Hex | ByteArray> =
+  BlobSidecar<type>[]

package/types/fee.ts

@@ -1,4 +1,4 @@
-import type { Assign } from './utils.js'
+import type { Assign, OneOf } from './utils.js'
 
 export type FeeHistory<TQuantity = bigint> = {
   /**
@@ -39,9 +39,10 @@ export type FeeValuesEIP4844<TQuantity = bigint> = Assign<
   }
 >
 
-export type FeeValues<TQuantity = bigint> =
+export type FeeValues<TQuantity = bigint> = OneOf<
   | FeeValuesLegacy<TQuantity>
   | FeeValuesEIP1559<TQuantity>
   | FeeValuesEIP4844<TQuantity>
+>
 
 export type FeeValuesType = 'legacy' | 'eip1559' | 'eip4844'

package/types/kzg.ts

@@ -0,0 +1,32 @@
+import type { Address } from 'abitype'
+import type { LocalAccount } from './account.js'
+import type { ByteArray } from './misc.js'
+import type { TransactionRequestEIP4844 } from './transaction.js'
+import type { MaybeRequired } from './utils.js'
+
+export type Kzg = {
+  /**
+   * Convert a blob to a KZG commitment.
+   */
+  blobToKzgCommitment(blob: ByteArray): ByteArray
+  /**
+   * Given a blob, return the KZG proof that is used to verify it against the
+   * commitment.
+   */
+  computeBlobKzgProof(blob: ByteArray, commitment: ByteArray): ByteArray
+}
+
+export type GetTransactionRequestKzgParameter<
+  request extends unknown | undefined = undefined,
+> = MaybeRequired<
+  {
+    /** KZG implementation */
+    kzg?: Kzg
+  },
+  request extends {
+    account: LocalAccount<string, Address>
+    blobs: TransactionRequestEIP4844['blobs']
+  }
+    ? true
+    : false
+>

package/types/misc.ts

@@ -1,3 +1,5 @@
+import type { OneOf } from './utils.js'
+
 export type ByteArray = Uint8Array
 export type Hex = `0x${string}`
 export type Hash = `0x${string}`
@@ -8,11 +10,28 @@ export type SignableMessage =
       /** Raw data representation of the message. */
       raw: Hex | ByteArray
     }
-export type Signature = {
+export type SignatureLegacy = {
   r: Hex
   s: Hex
   v: bigint
 }
+export type Signature = OneOf<
+  | SignatureLegacy
+  | {
+      r: Hex
+      s: Hex
+      /** @deprecated use `yParity`. */
+      v: bigint
+      yParity?: number
+    }
+  | {
+      r: Hex
+      s: Hex
+      /** @deprecated use `yParity`. */
+      v?: bigint
+      yParity: number
+    }
+>
 export type CompactSignature = {
   r: Hex
   yParityAndS: Hex

package/types/rpc.ts

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

package/types/transaction.ts

@@ -1,13 +1,15 @@
 import type { Address } from 'abitype'
 
+import type { BlobSidecar } from './eip4844.js'
 import type {
   FeeValuesEIP1559,
   FeeValuesEIP4844,
   FeeValuesLegacy,
 } from './fee.js'
+import type { Kzg } from './kzg.js'
 import type { Log } from './log.js'
-import type { Hash, Hex, Signature } from './misc.js'
-import type { OneOf } from './utils.js'
+import type { ByteArray, Hash, Hex, Signature } from './misc.js'
+import type { Branded, IsNever, OneOf, RequiredBy } from './utils.js'
 
 export type AccessList = { address: Address; storageKeys: Hex[] }[]
 
@@ -186,6 +188,7 @@ export type TransactionRequestLegacy<
 > = TransactionRequestBase<TQuantity, TIndex> &
   Partial<FeeValuesLegacy<TQuantity>> & {
     accessList?: never
+    blobs?: undefined
     type?: TTransactionType
   }
 export type TransactionRequestEIP2930<
@@ -195,6 +198,7 @@ export type TransactionRequestEIP2930<
 > = TransactionRequestBase<TQuantity, TIndex> &
   Partial<FeeValuesLegacy<TQuantity>> & {
     accessList?: AccessList
+    blobs?: undefined
     type?: TTransactionType
   }
 export type TransactionRequestEIP1559<
@@ -204,73 +208,127 @@ export type TransactionRequestEIP1559<
 > = TransactionRequestBase<TQuantity, TIndex> &
   Partial<FeeValuesEIP1559<TQuantity>> & {
     accessList?: AccessList
+    blobs?: undefined
     type?: TTransactionType
   }
-export type TransactionRequest<TQuantity = bigint, TIndex = number> =
+export type TransactionRequestEIP4844<
+  TQuantity = bigint,
+  TIndex = number,
+  TTransactionType = 'eip4844',
+> = RequiredBy<TransactionRequestBase<TQuantity, TIndex>, 'to'> &
+  RequiredBy<Partial<FeeValuesEIP4844<TQuantity>>, 'maxFeePerBlobGas'> & {
+    accessList?: AccessList
+    /** The blobs associated with this transaction. */
+    blobs: readonly Hex[] | readonly ByteArray[]
+    type?: TTransactionType
+  }
+export type TransactionRequest<TQuantity = bigint, TIndex = number> = OneOf<
   | TransactionRequestLegacy<TQuantity, TIndex>
   | TransactionRequestEIP2930<TQuantity, TIndex>
   | TransactionRequestEIP1559<TQuantity, TIndex>
+  | TransactionRequestEIP4844<TQuantity, TIndex>
+>
 
 export type TransactionSerializedEIP1559 = `0x02${string}`
 export type TransactionSerializedEIP2930 = `0x01${string}`
-export type TransactionSerializedLegacy = Hex
-export type TransactionSerializedGeneric = Hex
-export type TransactionSerialized<TType extends TransactionType = 'legacy'> =
-  TType extends 'eip1559'
-    ? TransactionSerializedEIP1559
-    : TType extends 'eip2930'
-      ? TransactionSerializedEIP2930
-      : TType extends 'legacy'
-        ? TransactionSerializedLegacy
-        : TransactionSerializedGeneric
+export type TransactionSerializedEIP4844 = `0x03${string}`
+export type TransactionSerializedLegacy = Branded<`0x${string}`, 'legacy'>
+export type TransactionSerializedGeneric = `0x${string}`
+export type TransactionSerialized<
+  TType extends TransactionType = TransactionType,
+  result =
+    | (TType extends 'eip1559' ? TransactionSerializedEIP1559 : never)
+    | (TType extends 'eip2930' ? TransactionSerializedEIP2930 : never)
+    | (TType extends 'eip4844' ? TransactionSerializedEIP4844 : never)
+    | (TType extends 'legacy' ? TransactionSerializedLegacy : never),
+> = IsNever<result> extends true ? TransactionSerializedGeneric : result
 
 export type TransactionSerializableBase<
   TQuantity = bigint,
   TIndex = number,
 > = Omit<TransactionRequestBase<TQuantity, TIndex>, 'from'> & Partial<Signature>
+
 export type TransactionSerializableLegacy<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
   Partial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: never
+    accessList?: undefined
+    blobs?: undefined
+    blobVersionedHashes?: undefined
     chainId?: number
     type?: 'legacy'
   }
+
 export type TransactionSerializableEIP2930<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
   Partial<FeeValuesLegacy<TQuantity>> & {
     accessList?: AccessList
+    blobs?: undefined
+    blobVersionedHashes?: undefined
     chainId: number
     type?: 'eip2930'
     yParity?: number
   }
+
 export type TransactionSerializableEIP1559<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
   Partial<FeeValuesEIP1559<TQuantity>> & {
     accessList?: AccessList
+    blobs?: undefined
+    blobVersionedHashes?: undefined
     chainId: number
     type?: 'eip1559'
     yParity?: number
   }
+
+export type TransactionSerializableEIP4844<
+  TQuantity = bigint,
+  TIndex = number,
+> = TransactionSerializableBase<TQuantity, TIndex> &
+  Partial<FeeValuesEIP4844<TQuantity>> & {
+    accessList?: AccessList
+    chainId: number
+    type?: 'eip4844'
+    yParity?: number
+  } & OneOf<
+    | {
+        blobVersionedHashes: readonly Hex[]
+        sidecars?: readonly BlobSidecar<Hex>[] | false
+      }
+    | {
+        blobs: readonly Hex[] | readonly ByteArray[]
+        kzg: Kzg
+        sidecars?: false
+      }
+  >
+
 export type TransactionSerializableGeneric<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> & {
   accessList?: AccessList
+  blobs?: readonly Hex[] | readonly ByteArray[]
+  blobVersionedHashes?: readonly Hex[]
   chainId?: number
   gasPrice?: TQuantity
+  maxFeePerBlobGas?: TQuantity
   maxFeePerGas?: TQuantity
   maxPriorityFeePerGas?: TQuantity
-  type: string
+  sidecars?: readonly BlobSidecar<Hex>[] | false
+  type?: string
 }
 
-export type TransactionSerializable<TQuantity = bigint, TIndex = number> =
+export type TransactionSerializable<
+  TQuantity = bigint,
+  TIndex = number,
+> = OneOf<
   | TransactionSerializableLegacy<TQuantity, TIndex>
   | TransactionSerializableEIP2930<TQuantity, TIndex>
   | TransactionSerializableEIP1559<TQuantity, TIndex>
-  | TransactionSerializableGeneric<TQuantity, TIndex>
+  | TransactionSerializableEIP4844<TQuantity, TIndex>
+>

package/types/utils.ts

@@ -1,3 +1,18 @@
+declare const symbol: unique symbol
+
+/**
+ * Creates a branded type of {@link T} with the brand {@link U}.
+ *
+ * @param T - Type to brand
+ * @param U - Label
+ * @returns Branded type
+ *
+ * @example
+ * type Result = Branded<string, 'foo'>
+ * //   ^? type Result = string & { [symbol]: 'foo' }
+ */
+export type Branded<T, U> = T & { [symbol]: U }
+
 /**
  * Filters out all members of {@link T} that are not {@link P}
  *
@@ -42,6 +57,21 @@ export type IsNarrowable<T, U> = IsNever<
  */
 export type IsNever<T> = [T] extends [never] ? true : false
 
+/**
+ * @description Returns type {@link T} if it is an opaque type of {@link U}
+ * @param T - Type to check
+ * @param U - Type to against
+ *
+ * @example
+ * type Result = Opaque<string, 'foo'>
+ * //   ^? never
+ *
+ * @example
+ * type Result = Opaque<string, string>
+ * //   ^? string
+ */
+export type Opaque<T, U> = IsNarrowable<T, U> extends true ? T : never
+
 /**
  * @description Evaluates boolean "or" condition for {@link T} properties.
  * @param T - Type to check
@@ -203,10 +233,18 @@ export type ExactPartial<type> = {
 
 export type OneOf<
   union extends object,
+  fallback extends object | undefined = undefined,
   ///
   keys extends KeyofUnion<union> = KeyofUnion<union>,
 > = union extends infer Item
-  ? Prettify<Item & { [_K in Exclude<keys, keyof Item>]?: undefined }>
+  ? Prettify<
+      Item & {
+        [_K in Exclude<keys, keyof Item>]?: fallback extends object
+          ? // @ts-ignore
+            fallback[_K]
+          : undefined
+      }
+    >
   : never
 type KeyofUnion<type> = type extends type ? keyof type : never
 
@@ -238,6 +276,16 @@ export type UnionOmit<type, keys extends keyof type> = type extends any
   ? Omit<type, keys>
   : never
 
+/**
+ * @description Construct a type with the properties of union type T except for those in type K.
+ * @example
+ * type Result = UnionOmit<{ a: string, b: number } | { a: string, b: undefined, c: number }, 'a'>
+ * => { b: number } | { b: undefined, c: number }
+ */
+export type UnionPick<type, keys extends keyof type> = type extends any
+  ? Pick<type, keys>
+  : never
+
 /**
  * @description Creates a type that is a partial of T, but with the required keys K.
  *

package/utils/blob/blobsToCommitments.ts

@@ -0,0 +1,69 @@
+import type { ErrorType } from '../../errors/utils.js'
+import type { Kzg } from '../../types/kzg.js'
+import type { ByteArray, Hex } from '../../types/misc.js'
+import { type HexToBytesErrorType, hexToBytes } from '../encoding/toBytes.js'
+import { type BytesToHexErrorType, bytesToHex } from '../encoding/toHex.js'
+
+type To = 'hex' | 'bytes'
+
+export type BlobsToCommitmentsParameters<
+  blobs extends ByteArray[] | Hex[] = ByteArray[] | Hex[],
+  to extends To | undefined = undefined,
+> = {
+  /** Blobs to transform into commitments. */
+  blobs: blobs | ByteArray[] | Hex[]
+  /** KZG implementation. */
+  kzg: Pick<Kzg, 'blobToKzgCommitment'>
+  /** Return type. */
+  to?: to | To | undefined
+}
+
+export type BlobsToCommitmentsReturnType<to extends To> =
+  | (to extends 'bytes' ? ByteArray[] : never)
+  | (to extends 'hex' ? Hex[] : never)
+
+export type BlobsToCommitmentsErrorType =
+  | HexToBytesErrorType
+  | BytesToHexErrorType
+  | ErrorType
+
+/**
+ * Compute commitments from a list of blobs.
+ *
+ * @example
+ * ```ts
+ * import { blobsToCommitments, toBlobs } from 'viem'
+ * import { kzg } from './kzg'
+ *
+ * const blobs = toBlobs({ data: '0x1234' })
+ * const commitments = blobsToCommitments({ blobs, kzg })
+ * ```
+ */
+export function blobsToCommitments<
+  const blobs extends ByteArray[] | Hex[],
+  to extends To =
+    | (blobs extends Hex[] ? 'hex' : never)
+    | (blobs extends ByteArray[] ? 'bytes' : never),
+>(
+  parameters: BlobsToCommitmentsParameters<blobs, to>,
+): BlobsToCommitmentsReturnType<to> {
+  const { kzg } = parameters
+
+  const to =
+    parameters.to ?? (typeof parameters.blobs[0] === 'string' ? 'hex' : 'bytes')
+  const blobs = (
+    typeof parameters.blobs[0] === 'string'
+      ? parameters.blobs.map((x) => hexToBytes(x as any))
+      : parameters.blobs
+  ) as ByteArray[]
+
+  const commitments: ByteArray[] = []
+  for (const blob of blobs)
+    commitments.push(Uint8Array.from(kzg.blobToKzgCommitment(blob)))
+
+  return (to === 'bytes'
+    ? commitments
+    : commitments.map((x) =>
+        bytesToHex(x),
+      )) as {} as BlobsToCommitmentsReturnType<to>
+}

package/utils/blob/blobsToProofs.ts

@@ -0,0 +1,93 @@
+import type { ErrorType } from '../../errors/utils.js'
+import type { Kzg } from '../../types/kzg.js'
+import type { ByteArray, Hex } from '../../types/misc.js'
+import { type HexToBytesErrorType, hexToBytes } from '../encoding/toBytes.js'
+import { type BytesToHexErrorType, bytesToHex } from '../encoding/toHex.js'
+
+type To = 'hex' | 'bytes'
+
+export type blobsToProofsParameters<
+  blobs extends ByteArray[] | Hex[],
+  commitments extends ByteArray[] | Hex[],
+  to extends To =
+    | (blobs extends Hex[] ? 'hex' : never)
+    | (blobs extends ByteArray[] ? 'bytes' : never),
+  ///
+  _blobsType =
+    | (blobs extends Hex[] ? Hex[] : never)
+    | (blobs extends ByteArray[] ? ByteArray[] : never),
+> = {
+  /** Blobs to transform into proofs. */
+  blobs: blobs
+  /** Commitments for the blobs. */
+  commitments: commitments &
+    (commitments extends _blobsType
+      ? {}
+      : `commitments must be the same type as blobs`)
+  /** KZG implementation. */
+  kzg: Pick<Kzg, 'computeBlobKzgProof'>
+  /** Return type. */
+  to?: to | To | undefined
+}
+
+export type blobsToProofsReturnType<to extends To> =
+  | (to extends 'bytes' ? ByteArray[] : never)
+  | (to extends 'hex' ? Hex[] : never)
+
+export type blobsToProofsErrorType =
+  | BytesToHexErrorType
+  | HexToBytesErrorType
+  | ErrorType
+
+/**
+ * Compute the proofs for a list of blobs and their commitments.
+ *
+ * @example
+ * ```ts
+ * import {
+ *   blobsToCommitments,
+ *   toBlobs
+ * } from 'viem'
+ * import { kzg } from './kzg'
+ *
+ * const blobs = toBlobs({ data: '0x1234' })
+ * const commitments = blobsToCommitments({ blobs, kzg })
+ * const proofs = blobsToProofs({ blobs, commitments, kzg })
+ * ```
+ */
+export function blobsToProofs<
+  const blobs extends ByteArray[] | Hex[],
+  const commitments extends ByteArray[] | Hex[],
+  to extends To =
+    | (blobs extends Hex[] ? 'hex' : never)
+    | (blobs extends ByteArray[] ? 'bytes' : never),
+>(
+  parameters: blobsToProofsParameters<blobs, commitments, to>,
+): blobsToProofsReturnType<to> {
+  const { kzg } = parameters
+
+  const to =
+    parameters.to ?? (typeof parameters.blobs[0] === 'string' ? 'hex' : 'bytes')
+
+  const blobs = (
+    typeof parameters.blobs[0] === 'string'
+      ? parameters.blobs.map((x) => hexToBytes(x as any))
+      : parameters.blobs
+  ) as ByteArray[]
+  const commitments = (
+    typeof parameters.commitments[0] === 'string'
+      ? parameters.commitments.map((x) => hexToBytes(x as any))
+      : parameters.commitments
+  ) as ByteArray[]
+
+  const proofs: ByteArray[] = []
+  for (let i = 0; i < blobs.length; i++) {
+    const blob = blobs[i]
+    const commitment = commitments[i]
+    proofs.push(Uint8Array.from(kzg.computeBlobKzgProof(blob, commitment)))
+  }
+
+  return (to === 'bytes'
+    ? proofs
+    : proofs.map((x) => bytesToHex(x))) as {} as blobsToProofsReturnType<to>
+}

package/utils/blob/commitmentToVersionedHash.ts

@@ -0,0 +1,62 @@
+import type { ErrorType } from '../../errors/utils.js'
+import type { ByteArray, Hex } from '../../types/misc.js'
+import { type BytesToHexErrorType, bytesToHex } from '../encoding/toHex.js'
+import { type Sha256ErrorType, sha256 } from '../hash/sha256.js'
+
+type To = 'hex' | 'bytes'
+
+export type CommitmentToVersionedHashParameters<
+  commitment extends Uint8Array | Hex = Uint8Array | Hex,
+  to extends To | undefined = undefined,
+> = {
+  /** Commitment from blob. */
+  commitment: commitment | Uint8Array | Hex
+  /** Return type. */
+  to?: to | To | undefined
+  /** Version to tag onto the hash. */
+  version?: number
+}
+
+export type CommitmentToVersionedHashReturnType<to extends To> =
+  | (to extends 'bytes' ? ByteArray : never)
+  | (to extends 'hex' ? Hex : never)
+
+export type CommitmentToVersionedHashErrorType =
+  | Sha256ErrorType
+  | BytesToHexErrorType
+  | ErrorType
+
+/**
+ * Transform a commitment to it's versioned hash.
+ *
+ * @example
+ * ```ts
+ * import {
+ *   blobsToCommitments,
+ *   commitmentToVersionedHash,
+ *   toBlobs
+ * } from 'viem'
+ * import { kzg } from './kzg'
+ *
+ * const blobs = toBlobs({ data: '0x1234' })
+ * const [commitment] = blobsToCommitments({ blobs, kzg })
+ * const versionedHash = commitmentToVersionedHash({ commitment })
+ * ```
+ */
+export function commitmentToVersionedHash<
+  const commitment extends Hex | ByteArray,
+  to extends To =
+    | (commitment extends Hex ? 'hex' : never)
+    | (commitment extends ByteArray ? 'bytes' : never),
+>(
+  parameters: CommitmentToVersionedHashParameters<commitment, to>,
+): CommitmentToVersionedHashReturnType<to> {
+  const { commitment, version = 1 } = parameters
+  const to = parameters.to ?? (typeof commitment === 'string' ? 'hex' : 'bytes')
+
+  const versionedHash = sha256(commitment, 'bytes')
+  versionedHash.set([version], 0)
+  return (
+    to === 'bytes' ? versionedHash : bytesToHex(versionedHash)
+  ) as CommitmentToVersionedHashReturnType<to>
+}