viem 1.4.2 → 1.5.2

package/src/types/log.ts

@@ -15,9 +15,12 @@ import type { Hash, Hex } from './misc.js'
 export type Log<
   TQuantity = bigint,
   TIndex = number,
+  TPending extends boolean = boolean,
   TAbiEvent extends AbiEvent | undefined = undefined,
   TStrict extends boolean | undefined = undefined,
-  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TAbi extends Abi | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
+    ? [TAbiEvent]
+    : undefined,
   TEventName extends string | undefined = TAbiEvent extends AbiEvent
     ? TAbiEvent['name']
     : undefined,
@@ -25,17 +28,17 @@ export type Log<
   /** The address from which this log originated */
   address: Address
   /** Hash of block containing this log or `null` if pending */
-  blockHash: Hash | null
+  blockHash: TPending extends true ? null : Hash
   /** Number of block containing this log or `null` if pending */
-  blockNumber: TQuantity | null
+  blockNumber: TPending extends true ? null : TQuantity
   /** Contains the non-indexed arguments of the log */
   data: Hex
   /** Index of this log within its block or `null` if pending */
-  logIndex: TIndex | null
+  logIndex: TPending extends true ? null : TIndex
   /** Hash of the transaction that created this log or `null` if pending */
-  transactionHash: Hash | null
+  transactionHash: TPending extends true ? null : Hash
   /** Index of the transaction that created this log or `null` if pending */
-  transactionIndex: TIndex | null
+  transactionIndex: TPending extends true ? null : TIndex
   /** `true` if this filter has been destroyed and is invalid */
   removed: boolean
 } & GetInferredLogValues<TAbiEvent, TAbi, TEventName, TStrict>
@@ -79,7 +82,9 @@ type GetTopics<
 
 type GetInferredLogValues<
   TAbiEvent extends AbiEvent | undefined = undefined,
-  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TAbi extends Abi | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
+    ? [TAbiEvent]
+    : undefined,
   TEventName extends string | undefined = TAbiEvent extends AbiEvent
     ? TAbiEvent['name']
     : undefined,
@@ -110,7 +115,7 @@ type GetInferredLogValues<
         [TName in _EventNames]: {
           args: GetEventArgs<
             TAbi,
-            string,
+            TName,
             {
               EnableUnion: false
               IndexedOnly: false

package/src/types/misc.ts

@@ -9,7 +9,10 @@ export type SignableMessage =
       raw: Hex | ByteArray
     }
 export type Signature = {
+  // TODO(v2): Make `bigint`
   r: Hex
+  // TODO(v2): Make `bigint`
   s: Hex
+  // TODO(v2): `v` to `recovery`
   v: bigint
 }

package/src/types/rpc.ts

@@ -1,4 +1,10 @@
-import type { Block, BlockIdentifier, BlockNumber, Uncle } from './block.js'
+import type {
+  Block,
+  BlockIdentifier,
+  BlockNumber,
+  BlockTag,
+  Uncle,
+} from './block.js'
 import type { FeeHistory, FeeValues } from './fee.js'
 import type { Log } from './log.js'
 import type {
@@ -17,7 +23,15 @@ export type Quantity = `0x${string}`
 export type Status = '0x0' | '0x1'
 export type TransactionType = '0x0' | '0x1' | '0x2' | (string & {})
 
-export type RpcBlock = Block<Quantity, RpcTransaction>
+export type RpcBlock<
+  TBlockTag extends BlockTag = BlockTag,
+  TIncludeTransactions extends boolean = boolean,
+> = Block<
+  Quantity,
+  TIncludeTransactions,
+  TBlockTag,
+  RpcTransaction<TBlockTag extends 'pending' ? true : false>
+>
 export type RpcBlockNumber = BlockNumber<Quantity>
 export type RpcBlockIdentifier = BlockIdentifier<Quantity>
 export type RpcUncle = Uncle<Quantity>
@@ -34,9 +48,9 @@ export type RpcTransactionRequest =
   | TransactionRequestLegacy<Quantity, Index, '0x0'>
   | TransactionRequestEIP2930<Quantity, Index, '0x1'>
   | TransactionRequestEIP1559<Quantity, Index, '0x2'>
-export type RpcTransaction = UnionOmit<
-  | TransactionLegacy<Quantity, Index, '0x0'>
-  | TransactionEIP2930<Quantity, Index, '0x1'>
-  | TransactionEIP1559<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'
 >

package/src/types/transaction.ts

@@ -47,11 +47,15 @@ export type TransactionReceipt<
   type: TType
 }
 
-export type TransactionBase<TQuantity = bigint, TIndex = number> = {
+export type TransactionBase<
+  TQuantity = bigint,
+  TIndex = number,
+  TPending extends boolean = boolean,
+> = {
   /** Hash of block containing this transaction or `null` if pending */
-  blockHash: Hash | null
+  blockHash: TPending extends true ? null : Hash
   /** Number of block containing this transaction or `null` if pending */
-  blockNumber: TQuantity | null
+  blockNumber: TPending extends true ? null : TQuantity
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
@@ -69,7 +73,7 @@ export type TransactionBase<TQuantity = bigint, TIndex = number> = {
   /** Transaction recipient or `null` if deploying a contract */
   to: Address | null
   /** Index of this transaction in the block or `null` if pending */
-  transactionIndex: TIndex | null
+  transactionIndex: TPending extends true ? null : TIndex
   /** The type represented as hex. */
   typeHex: Hex | null
   /** ECDSA recovery ID */
@@ -80,8 +84,9 @@ export type TransactionBase<TQuantity = bigint, TIndex = number> = {
 export type TransactionLegacy<
   TQuantity = bigint,
   TIndex = number,
+  TPending extends boolean = boolean,
   TType = 'legacy',
-> = TransactionBase<TQuantity, TIndex> &
+> = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesLegacy<TQuantity> & {
     accessList?: never
     chainId?: TIndex
@@ -90,8 +95,9 @@ export type TransactionLegacy<
 export type TransactionEIP2930<
   TQuantity = bigint,
   TIndex = number,
+  TPending extends boolean = boolean,
   TType = 'eip2930',
-> = TransactionBase<TQuantity, TIndex> &
+> = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesLegacy<TQuantity> & {
     accessList: AccessList
     chainId: TIndex
@@ -100,17 +106,22 @@ export type TransactionEIP2930<
 export type TransactionEIP1559<
   TQuantity = bigint,
   TIndex = number,
+  TPending extends boolean = boolean,
   TType = 'eip1559',
-> = TransactionBase<TQuantity, TIndex> &
+> = TransactionBase<TQuantity, TIndex, TPending> &
   FeeValuesEIP1559<TQuantity> & {
     accessList: AccessList
     chainId: TIndex
     type: TType
   }
-export type Transaction<TQuantity = bigint, TIndex = number> =
-  | TransactionLegacy<TQuantity, TIndex>
-  | TransactionEIP2930<TQuantity, TIndex>
-  | TransactionEIP1559<TQuantity, TIndex>
+export type Transaction<
+  TQuantity = bigint,
+  TIndex = number,
+  TPending extends boolean = boolean,
+> =
+  | TransactionLegacy<TQuantity, TIndex, TPending>
+  | TransactionEIP2930<TQuantity, TIndex, TPending>
+  | TransactionEIP1559<TQuantity, TIndex, TPending>
 
 export type TransactionRequestBase<TQuantity = bigint, TIndex = number> = {
   /** Contract code or a hashed method call with encoded args */

package/src/utils/formatters/block.ts

@@ -1,14 +1,41 @@
-import type { Block } from '../../types/block.js'
+import type { Block, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
-import type { ExtractFormatterReturnType } from '../../types/formatter.js'
+import type {
+  ExtractFormatterExclude,
+  ExtractFormatterReturnType,
+} from '../../types/formatter.js'
+import type { Hash } from '../../types/misc.js'
 import type { RpcBlock } from '../../types/rpc.js'
+import type { Prettify } from '../../types/utils.js'
 
 import { defineFormatter } from './formatter.js'
-import { formatTransaction } from './transaction.js'
+import { type FormattedTransaction, formatTransaction } from './transaction.js'
+
+type BlockPendingDependencies = 'hash' | 'logsBloom' | 'nonce' | 'number'
 
 export type FormattedBlock<
   TChain extends Chain | undefined = Chain | undefined,
-> = ExtractFormatterReturnType<TChain, 'block', Block>
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  _FormatterReturnType = ExtractFormatterReturnType<
+    TChain,
+    'block',
+    Block<bigint, TIncludeTransactions>
+  >,
+  _ExcludedPendingDependencies extends string = BlockPendingDependencies &
+    ExtractFormatterExclude<TChain, 'block'>,
+  _Formatted = Omit<_FormatterReturnType, BlockPendingDependencies> & {
+    [K in _ExcludedPendingDependencies]: never
+  } & Pick<
+      Block<bigint, TIncludeTransactions, TBlockTag>,
+      BlockPendingDependencies
+    >,
+  _Transactions = TIncludeTransactions extends true
+    ? Prettify<FormattedTransaction<TChain, TBlockTag>>[]
+    : Hash[],
+> = Omit<_Formatted, 'transactions'> & {
+  transactions: _Transactions
+}
 
 export function formatBlock(block: Partial<RpcBlock>) {
   const transactions = block.transactions?.map((transaction) => {

package/src/utils/formatters/formatter.ts

@@ -16,6 +16,7 @@ export function defineFormatter<TType extends string, TParameters, TReturnType>(
     format: (_: TOverrideParameters) => TOverrideReturnType
   }) => {
     return {
+      exclude,
       format: (args: TParameters & TOverrideParameters) => {
         const formatted = format(args)
         if (exclude) {

package/src/utils/formatters/transaction.ts

@@ -1,13 +1,36 @@
+import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
-import type { ExtractFormatterReturnType } from '../../types/formatter.js'
+import type {
+  ExtractFormatterExclude,
+  ExtractFormatterReturnType,
+} from '../../types/formatter.js'
 import type { RpcTransaction } from '../../types/rpc.js'
 import type { Transaction } from '../../types/transaction.js'
+import type { UnionOmit } from '../../types/utils.js'
 import { hexToNumber } from '../encoding/fromHex.js'
 import { defineFormatter } from './formatter.js'
 
+type TransactionPendingDependencies =
+  | 'blockHash'
+  | 'blockNumber'
+  | 'transactionIndex'
+
 export type FormattedTransaction<
   TChain extends Chain | undefined = Chain | undefined,
-> = ExtractFormatterReturnType<TChain, 'transaction', Transaction>
+  TBlockTag extends BlockTag = BlockTag,
+  _FormatterReturnType = ExtractFormatterReturnType<
+    TChain,
+    'transaction',
+    Transaction
+  >,
+  _ExcludedPendingDependencies extends string = TransactionPendingDependencies &
+    ExtractFormatterExclude<TChain, 'transaction'>,
+> = UnionOmit<_FormatterReturnType, TransactionPendingDependencies> & {
+  [K in _ExcludedPendingDependencies]: never
+} & Pick<
+    Transaction<bigint, number, TBlockTag extends 'pending' ? true : false>,
+    TransactionPendingDependencies
+  >
 
 export const transactionType = {
   '0x0': 'legacy',

package/src/utils/hash/hashFunction.ts

@@ -1,3 +1,4 @@
+import { formatAbiItem } from '../abi/formatAbiItem.js'
 import {
   extractFunctionName,
   extractFunctionParams,
@@ -15,6 +16,6 @@ export function hashFunction(def: string) {
   return hash(`${name}(${params.map(({ type }) => type).join(',')})`)
 }
 
-export function hashAbiItem(def: AbiFunction | AbiEvent) {
-  return hash(`${def.name}(${def.inputs.map(({ type }) => type).join(',')})`)
+export function hashAbiItem(abiItem: AbiFunction | AbiEvent) {
+  return hash(formatAbiItem(abiItem))
 }

package/src/utils/promise/withCache.ts

@@ -27,8 +27,8 @@ export function getCache<TData>(cacheKey: string) {
 export type WithCacheParameters = {
   /** The key to cache the data against. */
   cacheKey: string
-  /** The maximum age (in ms) of the cached value. Default: Infinity (no expiry) */
-  maxAge?: number
+  /** The time that cached data will remain in memory. Default: Infinity (no expiry) */
+  cacheTime?: number
 }
 
 /**
@@ -37,7 +37,7 @@ export type WithCacheParameters = {
  */
 export async function withCache<TData>(
   fn: () => Promise<TData>,
-  { cacheKey, maxAge = Infinity }: WithCacheParameters,
+  { cacheKey, cacheTime = Infinity }: WithCacheParameters,
 ) {
   const cache = getCache<TData>(cacheKey)
 
@@ -45,9 +45,9 @@ export async function withCache<TData>(
   // and do not invoke the promise.
   // If the max age is 0, the cache is disabled.
   const response = cache.response.get()
-  if (response && maxAge > 0) {
+  if (response && cacheTime > 0) {
     const age = new Date().getTime() - response.created.getTime()
-    if (age < maxAge) return response.data
+    if (age < cacheTime) return response.data
   }
 
   let promise = cache.promise.get()

package/src/utils/signature/hexToSignature.ts

@@ -0,0 +1,20 @@
+import { secp256k1 } from '@noble/curves/secp256k1'
+
+import type { Hex, Signature } from '../../types/misc.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
+
+/**
+ * @description Parses a hex formatted signature into a structured signature.
+ *
+ * @param signatureHex Signature in hex format.
+ * @returns The structured signature.
+ *
+ * @example
+ * hexToSignature('0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c')
+ * // { r: '0x...', s: '0x...', v: 28n }
+ */
+export function hexToSignature(signatureHex: Hex): Signature {
+  const { r, s } = secp256k1.Signature.fromCompact(signatureHex.slice(2, 130))
+  const v = BigInt(`0x${signatureHex.slice(130)}`)
+  return { r: numberToHex(r), s: numberToHex(s), v }
+}

package/src/utils/signature/signatureToHex.ts

@@ -0,0 +1,26 @@
+import { secp256k1 } from '@noble/curves/secp256k1'
+
+import type { Hex, Signature } from '../../types/misc.js'
+import { hexToBigInt } from '../../utils/encoding/fromHex.js'
+import { toHex } from '../../utils/encoding/toHex.js'
+
+/**
+ * @description Converts a signature into hex format.
+ *
+ * @param signature The signature to convert.
+ * @returns The signature in hex format.
+ *
+ * @example
+ * signatureToHex({
+ *   r: '0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf',
+ *   s: '0x4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db8',
+ *   v: 28n
+ * })
+ * // "0x6e100a352ec6ad1b70802290e18aeed190704973570f3b8ed42cb9808e2ea6bf4a90a229a244495b41890987806fcbd2d5d23fc0dbe5f5256c2613c039d76db81c"
+ */
+export function signatureToHex({ r, s, v }: Signature): Hex {
+  return `0x${new secp256k1.Signature(
+    hexToBigInt(r),
+    hexToBigInt(s),
+  ).toCompactHex()}${toHex(v).slice(2)}`
+}

package/dist/cjs/accounts/utils/signatureToHex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signatureToHex.js","sourceRoot":"","sources":["../../../../src/accounts/utils/signatureToHex.ts"],"names":[],"mappings":";;;AAAA,uDAAmD;AAGnD,gEAA6D;AAC7D,4DAAqD;AAErD,SAAgB,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAa;IACnD,OAAO,KAAK,IAAI,qBAAS,CAAC,SAAS,CACjC,IAAA,wBAAW,EAAC,CAAC,CAAC,EACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CACf,CAAC,YAAY,EAAE,GAAG,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;AACxC,CAAC;AALD,wCAKC"}

package/dist/esm/accounts/utils/signatureToHex.js

@@ -1,7 +0,0 @@
-import { secp256k1 } from '@noble/curves/secp256k1';
-import { hexToBigInt } from '../../utils/encoding/fromHex.js';
-import { toHex } from '../../utils/encoding/toHex.js';
-export function signatureToHex({ r, s, v }) {
-    return `0x${new secp256k1.Signature(hexToBigInt(r), hexToBigInt(s)).toCompactHex()}${toHex(v).slice(2)}`;
-}
-//# sourceMappingURL=signatureToHex.js.map

package/dist/esm/accounts/utils/signatureToHex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signatureToHex.js","sourceRoot":"","sources":["../../../../src/accounts/utils/signatureToHex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAErD,MAAM,UAAU,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAa;IACnD,OAAO,KAAK,IAAI,SAAS,CAAC,SAAS,CACjC,WAAW,CAAC,CAAC,CAAC,EACd,WAAW,CAAC,CAAC,CAAC,CACf,CAAC,YAAY,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;AACxC,CAAC"}

package/dist/types/accounts/utils/signatureToHex.d.ts

@@ -1,3 +0,0 @@
-import type { Hex, Signature } from '../../types/misc.js';
-export declare function signatureToHex({ r, s, v }: Signature): Hex;
-//# sourceMappingURL=signatureToHex.d.ts.map

package/dist/types/accounts/utils/signatureToHex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"signatureToHex.d.ts","sourceRoot":"","sources":["../../../../src/accounts/utils/signatureToHex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAIzD,wBAAgB,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,GAAG,GAAG,CAK1D"}

package/src/accounts/utils/signatureToHex.ts

@@ -1,12 +0,0 @@
-import { secp256k1 } from '@noble/curves/secp256k1'
-
-import type { Hex, Signature } from '../../types/misc.js'
-import { hexToBigInt } from '../../utils/encoding/fromHex.js'
-import { toHex } from '../../utils/encoding/toHex.js'
-
-export function signatureToHex({ r, s, v }: Signature): Hex {
-  return `0x${new secp256k1.Signature(
-    hexToBigInt(r),
-    hexToBigInt(s),
-  ).toCompactHex()}${toHex(v).slice(2)}`
-}