viem 0.0.0-main.20230727T170020 → 0.0.0-main.20230730T091111

package/src/types/block.ts

@@ -3,7 +3,16 @@ import type { Address } from 'abitype'
 import type { Hash, Hex } from './misc.js'
 import type { Transaction } from './transaction.js'
 
-export type Block<TQuantity = bigint, TTransaction = Transaction> = {
+export type Block<
+  TQuantity = bigint,
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  TTransaction = Transaction<
+    bigint,
+    number,
+    TBlockTag extends 'pending' ? true : false
+  >,
+> = {
   /** Base fee per gas */
   baseFeePerGas: TQuantity | null
   /** Difficulty for this block */
@@ -15,17 +24,17 @@ export type Block<TQuantity = bigint, TTransaction = Transaction> = {
   /** Total used gas by all transactions in this block */
   gasUsed: TQuantity
   /** Block hash or `null` if pending */
-  hash: Hash | null
+  hash: TBlockTag extends 'pending' ? null : Hash
   /** Logs bloom filter or `null` if pending */
-  logsBloom: Hex | null
+  logsBloom: TBlockTag extends 'pending' ? null : Hex
   /** Address that received this block’s mining rewards */
   miner: Address
   /** Unique identifier for the block. */
   mixHash: Hash
   /** Proof-of-work hash or `null` if pending */
-  nonce: Hex | null
+  nonce: TBlockTag extends 'pending' ? null : Hex
   /** Block number or `null` if pending */
-  number: TQuantity | null
+  number: TBlockTag extends 'pending' ? null : TQuantity
   /** Parent block hash */
   parentHash: Hash
   /** Root of the this block’s receipts trie */
@@ -42,7 +51,7 @@ export type Block<TQuantity = bigint, TTransaction = Transaction> = {
   /** Total difficulty of the chain until this block */
   totalDifficulty: TQuantity | null
   /** List of transaction objects or hashes */
-  transactions: Hash[] | TTransaction[]
+  transactions: TIncludeTransactions extends true ? TTransaction[] : Hash[]
   /** Root of this block’s transaction trie */
   transactionsRoot: Hash
   /** List of uncle hashes */
@@ -67,7 +76,13 @@ export type BlockNumber<TQuantity = bigint> = TQuantity
 
 export type BlockTag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
 
-export type Uncle<TQuantity = bigint, TTransaction = Transaction> = Block<
-  TQuantity,
-  TTransaction
->
+export type Uncle<
+  TQuantity = bigint,
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+  TTransaction = Transaction<
+    bigint,
+    number,
+    TBlockTag extends 'pending' ? true : false
+  >,
+> = Block<TQuantity, TIncludeTransactions, TBlockTag, TTransaction>

package/src/types/filter.ts

@@ -1,5 +1,6 @@
 import type { Abi } from 'abitype'
 
+import type { BlockNumber, BlockTag } from './block.js'
 import type { MaybeExtractEventArgsFromAbi } from './contract.js'
 import type { EIP1193RequestFn, PublicRpcSchema } from './eip1193.js'
 import type { Hex } from './misc.js'
@@ -22,36 +23,41 @@ export type Filter<
     | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
     | undefined = MaybeExtractEventArgsFromAbi<TAbi, TEventName>,
   TStrict extends boolean | undefined = undefined,
+  TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  TToBlock extends BlockNumber | BlockTag | undefined = undefined,
 > = {
   id: Hex
   request: EIP1193RequestFn<FilterRpcSchema>
   type: TFilterType
 } & (TFilterType extends 'event'
-  ? TAbi extends Abi
-    ? undefined extends TEventName
-      ? {
-          abi: TAbi
-          args?: never
-          eventName?: never
-          strict: TStrict
-        }
-      : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
-      ? {
-          abi: TAbi
-          args: TArgs
-          eventName: TEventName
-          strict: TStrict
-        }
+  ? {
+      fromBlock?: TFromBlock
+      toBlock?: TToBlock
+    } & (TAbi extends Abi
+      ? undefined extends TEventName
+        ? {
+            abi: TAbi
+            args?: never
+            eventName?: never
+            strict: TStrict
+          }
+        : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
+        ? {
+            abi: TAbi
+            args: TArgs
+            eventName: TEventName
+            strict: TStrict
+          }
+        : {
+            abi: TAbi
+            args?: never
+            eventName: TEventName
+            strict: TStrict
+          }
       : {
-          abi: TAbi
+          abi?: never
           args?: never
-          eventName: TEventName
-          strict: TStrict
-        }
-    : {
-        abi?: never
-        args?: never
-        eventName?: never
-        strict?: never
-      }
+          eventName?: never
+          strict?: never
+        })
   : {})

package/src/types/formatter.ts

@@ -12,6 +12,15 @@ export type Formatters = {
   transactionRequest?: Formatter<'transactionRequest'>
 }
 
+export type ExtractFormatterExclude<
+  TChain extends Chain | undefined,
+  TType extends keyof Formatters,
+> = TChain extends Chain<infer _Formatters extends Formatters>
+  ? _Formatters[TType] extends { exclude: infer Exclude }
+    ? Extract<Exclude, string[]>[number]
+    : ''
+  : ''
+
 export type ExtractFormatterParameters<
   TChain extends Chain | undefined,
   TType extends keyof Formatters,

package/src/types/log.ts

@@ -15,6 +15,7 @@ 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],
@@ -25,17 +26,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>

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',