viem 0.0.0-portable-types-20230523145621 → 0.0.0-refactor-generics-20230831161903

package/src/types/fee.ts

@@ -20,6 +20,7 @@ export type FeeValuesLegacy<TQuantity = bigint> = {
 }
 
 export type FeeValuesEIP1559<TQuantity = bigint> = {
+  /** Base fee per gas. */
   gasPrice?: never
   /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
   maxFeePerGas: TQuantity
@@ -30,3 +31,5 @@ export type FeeValuesEIP1559<TQuantity = bigint> = {
 export type FeeValues<TQuantity = bigint> =
   | FeeValuesLegacy<TQuantity>
   | FeeValuesEIP1559<TQuantity>
+
+export type FeeValuesType = 'legacy' | 'eip1559'

package/src/types/filter.ts

@@ -1,45 +1,63 @@
 import type { Abi } from 'abitype'
 
+import type { BlockNumber, BlockTag } from './block.js'
 import type { MaybeExtractEventArgsFromAbi } from './contract.js'
-import type { Requests } from './eip1193.js'
+import type { EIP1193RequestFn, PublicRpcSchema } from './eip1193.js'
 import type { Hex } from './misc.js'
+import type { Filter as Filter_ } from './utils.js'
 
 export type FilterType = 'transaction' | 'block' | 'event'
 
+type FilterRpcSchema = Filter_<
+  PublicRpcSchema,
+  {
+    Method: 'eth_getFilterLogs' | 'eth_getFilterChanges' | 'eth_uninstallFilter'
+  }
+>
+
 export type Filter<
   TFilterType extends FilterType = 'event',
-  TAbi extends Abi | readonly unknown[] = Abi,
+  TAbi extends Abi | readonly unknown[] | undefined = undefined,
   TEventName extends string | undefined = undefined,
   TArgs extends
     | 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
-  // TODO: Narrow `request` to filter-based methods (ie. `eth_getFilterLogs`, etc).
-  request: Requests['request']
+  request: EIP1193RequestFn<FilterRpcSchema>
   type: TFilterType
 } & (TFilterType extends 'event'
-  ? TAbi extends Abi
-    ? undefined extends TEventName
-      ? {
-          abi: TAbi
-          args?: never
-          eventName?: never
-        }
-      : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
-      ? {
-          abi: TAbi
-          args: TArgs
-          eventName: TEventName
-        }
+  ? {
+      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
-        }
-    : {
-        abi?: never
-        args?: never
-        eventName?: never
-      }
+          eventName?: never
+          strict?: never
+        })
   : {})

package/src/types/log.ts

@@ -15,8 +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,
-  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TStrict extends boolean | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] | undefined = TAbiEvent extends AbiEvent
+    ? [TAbiEvent]
+    : undefined,
   TEventName extends string | undefined = TAbiEvent extends AbiEvent
     ? TAbiEvent['name']
     : undefined,
@@ -24,20 +28,20 @@ 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>
+} & GetInferredLogValues<TAbiEvent, TAbi, TEventName, TStrict>
 
 type Topics<
   THead extends AbiEvent['inputs'],
@@ -78,10 +82,13 @@ 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,
+  TStrict extends boolean | undefined = undefined,
   _EventNames extends string = TAbi extends Abi
     ? Abi extends TAbi
       ? string
@@ -93,7 +100,11 @@ type GetInferredLogValues<
         args: GetEventArgs<
           TAbi,
           TEventName,
-          { EnableUnion: false; IndexedOnly: false }
+          {
+            EnableUnion: false
+            IndexedOnly: false
+            Required: TStrict extends boolean ? TStrict : false
+          }
         >
         /** The event name decoded from `topics`. */
         eventName: TEventName
@@ -104,8 +115,12 @@ type GetInferredLogValues<
         [TName in _EventNames]: {
           args: GetEventArgs<
             TAbi,
-            string,
-            { EnableUnion: false; IndexedOnly: false }
+            TName,
+            {
+              EnableUnion: false
+              IndexedOnly: false
+              Required: TStrict extends boolean ? TStrict : false
+            }
           >
           /** The event name decoded from `topics`. */
           eventName: TName

package/src/types/misc.ts

@@ -2,8 +2,17 @@ export type ByteArray = Uint8Array
 export type Hex = `0x${string}`
 export type Hash = `0x${string}`
 export type LogTopic = Hex | Hex[] | null
+export type SignableMessage =
+  | string
+  | {
+      /** Raw data representation of the message. */
+      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/multicall.ts

@@ -1,4 +1,4 @@
-import type { Abi } from 'abitype'
+import type { Abi, ExtractAbiFunctionNames } from 'abitype'
 
 import type {
   ContractFunctionConfig,
@@ -7,13 +7,16 @@ import type {
 
 type MAXIMUM_DEPTH = 20
 
-export type Contract<
+export type MulticallContract<
   TAbi extends Abi | readonly unknown[] = Abi | readonly unknown[],
-  TFunctionName extends string = string,
+  TFunctionName extends ExtractAbiFunctionNames<
+    TAbi extends Abi ? TAbi : Abi,
+    'pure' | 'view'
+  > = string,
 > = { abi: TAbi; functionName: TFunctionName }
 
 export type MulticallContracts<
-  TContracts extends Contract[],
+  TContracts extends readonly MulticallContract[],
   TProperties extends Record<string, any> = object,
   Result extends any[] = [],
   Depth extends readonly number[] = [],
@@ -21,14 +24,14 @@ export type MulticallContracts<
   ? (ContractFunctionConfig & TProperties)[]
   : TContracts extends []
   ? []
-  : TContracts extends [infer Head extends Contract]
+  : TContracts extends [infer Head extends MulticallContract]
   ? [
       ...Result,
       ContractFunctionConfig<Head['abi'], Head['functionName']> & TProperties,
     ]
   : TContracts extends [
-      infer Head extends Contract,
-      ...infer Tail extends Contract[],
+      infer Head extends MulticallContract,
+      ...infer Tail extends readonly MulticallContract[],
     ]
   ? MulticallContracts<
       [...Tail],
@@ -65,7 +68,7 @@ export type MulticallResult<
   : Result
 
 export type MulticallResults<
-  TContracts extends Contract[],
+  TContracts extends readonly MulticallContract[],
   TAllowFailure extends boolean = true,
   Result extends any[] = [],
   Depth extends readonly number[] = [],
@@ -73,7 +76,7 @@ export type MulticallResults<
   ? MulticallResult<ContractFunctionResult, TAllowFailure>[]
   : TContracts extends []
   ? []
-  : TContracts extends [infer Head extends Contract]
+  : TContracts extends [infer Head extends MulticallContract]
   ? [
       ...Result,
       MulticallResult<
@@ -82,8 +85,8 @@ export type MulticallResults<
       >,
     ]
   : TContracts extends [
-      infer Head extends Contract,
-      ...infer Tail extends Contract[],
+      infer Head extends MulticallContract,
+      ...infer Tail extends readonly MulticallContract[],
     ]
   ? MulticallResults<
       [...Tail],

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 {
@@ -6,15 +12,22 @@ import type {
   TransactionEIP2930,
   TransactionLegacy,
   TransactionReceipt,
-  TransactionRequest,
+  TransactionRequestEIP1559,
+  TransactionRequestEIP2930,
+  TransactionRequestLegacy,
 } from './transaction.js'
+import type { UnionOmit } from './utils.js'
 
 export type Index = `0x${string}`
 export type Quantity = `0x${string}`
 export type Status = '0x0' | '0x1'
-export type TransactionType = '0x0' | '0x1' | '0x2'
+export type TransactionType = '0x0' | '0x1' | '0x2' | (string & {})
 
-export type RpcBlock = Block<Quantity, RpcTransaction>
+export type RpcBlock<
+  TBlockTag extends BlockTag = BlockTag,
+  TIncludeTransactions extends boolean = boolean,
+  TTransaction = RpcTransaction<TBlockTag extends 'pending' ? true : false>,
+> = Block<Quantity, TIncludeTransactions, TBlockTag, TTransaction>
 export type RpcBlockNumber = BlockNumber<Quantity>
 export type RpcBlockIdentifier = BlockIdentifier<Quantity>
 export type RpcUncle = Uncle<Quantity>
@@ -27,8 +40,13 @@ export type RpcTransactionReceipt = TransactionReceipt<
   Status,
   TransactionType
 >
-export type RpcTransactionRequest = TransactionRequest<Quantity, Index>
-export type RpcTransaction =
-  | TransactionLegacy<Quantity, Index, '0x0'>
-  | TransactionEIP2930<Quantity, Index, '0x1'>
-  | TransactionEIP1559<Quantity, Index, '0x2'>
+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'
+>

package/src/types/transaction.ts

@@ -9,7 +9,7 @@ import type { ValueOf } from './utils.js'
 
 export type AccessList = { address: Address; storageKeys: Hex[] }[]
 
-export type TransactionType = ValueOf<typeof transactionType>
+export type TransactionType = ValueOf<typeof transactionType> | (string & {})
 
 export type TransactionReceipt<
   TQuantity = bigint,
@@ -35,7 +35,7 @@ export type TransactionReceipt<
   logs: Log<TQuantity, TIndex>[]
   /** Logs bloom filter */
   logsBloom: Hex
-  /** `1` if this transaction was successful or `0` if it failed */
+  /** `success` if this transaction was successful or `reverted` if it failed */
   status: TStatus
   /** Transaction recipient or `null` if deploying a contract */
   to: Address | null
@@ -47,13 +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
-  /** Chain ID. */
-  chainId: TIndex
+  blockNumber: TPending extends true ? null : TQuantity
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
@@ -71,7 +73,9 @@ 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 */
   v: TQuantity
   /** Value in wei sent with this transaction */
@@ -80,34 +84,44 @@ 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
     type: TType
   }
 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
     type: TType
   }
 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 */
@@ -126,23 +140,29 @@ export type TransactionRequestBase<TQuantity = bigint, TIndex = number> = {
 export type TransactionRequestLegacy<
   TQuantity = bigint,
   TIndex = number,
+  TTransactionType = 'legacy',
 > = TransactionRequestBase<TQuantity, TIndex> &
   Partial<FeeValuesLegacy<TQuantity>> & {
     accessList?: never
+    type?: TTransactionType
   }
 export type TransactionRequestEIP2930<
   TQuantity = bigint,
   TIndex = number,
+  TTransactionType = 'eip2930',
 > = TransactionRequestBase<TQuantity, TIndex> &
   Partial<FeeValuesLegacy<TQuantity>> & {
     accessList?: AccessList
+    type?: TTransactionType
   }
 export type TransactionRequestEIP1559<
   TQuantity = bigint,
   TIndex = number,
+  TTransactionType = 'eip1559',
 > = TransactionRequestBase<TQuantity, TIndex> &
   Partial<FeeValuesEIP1559<TQuantity>> & {
     accessList?: AccessList
+    type?: TTransactionType
   }
 export type TransactionRequest<TQuantity = bigint, TIndex = number> =
   | TransactionRequestLegacy<TQuantity, TIndex>
@@ -152,10 +172,15 @@ export type TransactionRequest<TQuantity = bigint, TIndex = number> =
 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 : never)
-  | (TType extends 'eip2930' ? TransactionSerializedEIP2930 : never)
-  | (TType extends 'legacy' ? TransactionSerializedLegacy : never)
+  TType extends 'eip1559'
+    ? TransactionSerializedEIP1559
+    : TType extends 'eip2930'
+    ? TransactionSerializedEIP2930
+    : TType extends 'legacy'
+    ? TransactionSerializedLegacy
+    : TransactionSerializedGeneric
 
 export type TransactionSerializableBase<
   TQuantity = bigint,
@@ -190,7 +215,20 @@ export type TransactionSerializableEIP1559<
     type?: 'eip1559'
     yParity?: number
   }
+export type TransactionSerializableGeneric<
+  TQuantity = bigint,
+  TIndex = number,
+> = TransactionSerializableBase<TQuantity, TIndex> & {
+  accessList?: AccessList
+  chainId?: number
+  gasPrice?: TQuantity
+  maxFeePerGas?: TQuantity
+  maxPriorityFeePerGas?: TQuantity
+  type: string
+}
+
 export type TransactionSerializable<TQuantity = bigint, TIndex = number> =
   | TransactionSerializableLegacy<TQuantity, TIndex>
   | TransactionSerializableEIP2930<TQuantity, TIndex>
   | TransactionSerializableEIP1559<TQuantity, TIndex>
+  | TransactionSerializableGeneric<TQuantity, TIndex>

package/src/types/typedData.ts

@@ -1,5 +1,4 @@
 import type {
-  Narrow,
   TypedData,
   TypedDataDomain,
   TypedDataToPrimitiveTypes,
@@ -15,11 +14,11 @@ export type TypedDataDefinition<
   GetTypedDataDomain<TTypedData, TPrimaryType>
 
 export type GetTypedDataDomain<
-  TTypedData extends TypedData | { [key: string]: unknown } = TypedData,
+  TTypedData extends TypedData | { [key_1: string]: unknown } = TypedData,
   TPrimaryType extends string = string,
   TSchema = TTypedData extends TypedData
     ? TypedDataToPrimitiveTypes<TTypedData>
-    : { [key: string]: any },
+    : { [key_2: string]: any },
   TDomain = TSchema extends { EIP712Domain: infer Domain }
     ? Domain
     : TypedDataDomain,
@@ -32,24 +31,24 @@ export type GetTypedDataDomain<
     }
 
 export type GetTypedDataMessage<
-  TTypedData extends TypedData | { [key: string]: unknown } = TypedData,
+  TTypedData extends TypedData | { [key_1: string]: unknown } = TypedData,
   TPrimaryType extends string = string,
   TSchema = TTypedData extends TypedData
     ? TypedDataToPrimitiveTypes<TTypedData>
-    : { [key: string]: any },
+    : { [key_2: string]: any },
   TMessage = TSchema[TPrimaryType extends keyof TSchema
     ? TPrimaryType
     : keyof TSchema],
 > = TPrimaryType extends 'EIP712Domain'
   ? {}
-  : { [key: string]: any } extends TMessage // Check if we were able to infer the shape of typed data
+  : { [key_3: string]: any } extends TMessage // Check if we were able to infer the shape of typed data
   ? {
       /**
        * Data to sign
        *
        * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link types} for type inference.
        */
-      message: { [key: string]: unknown }
+      message: { [key_4: string]: unknown }
     }
   : {
       /** Data to sign */
@@ -74,8 +73,8 @@ export type GetTypedDataTypes<
   TPrimaryType extends string = string,
 > = TPrimaryType extends 'EIP712Domain'
   ? {
-      types?: Narrow<TTypedData>
+      types?: TTypedData
     }
   : {
-      types: Narrow<TTypedData>
+      types: TTypedData
     }