viem 0.0.0-tsc-and-nodenext-20230405154910 → 0.0.0-w-20230711200108

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

package/src/types/filter.ts

@@ -1,9 +1,19 @@
 import type { Abi } from 'abitype'
+
 import type { MaybeExtractEventArgsFromAbi } from './contract.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,
@@ -11,8 +21,10 @@ export type Filter<
   TArgs extends
     | MaybeExtractEventArgsFromAbi<TAbi, TEventName>
     | undefined = MaybeExtractEventArgsFromAbi<TAbi, TEventName>,
+  TStrict extends boolean | undefined = undefined,
 > = {
   id: Hex
+  request: EIP1193RequestFn<FilterRpcSchema>
   type: TFilterType
 } & (TFilterType extends 'event'
   ? TAbi extends Abi
@@ -21,21 +33,25 @@ export type Filter<
           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?: never
         args?: never
         eventName?: never
+        strict?: never
       }
   : {})

package/src/types/formatter.ts

@@ -1,23 +1,33 @@
-import type { Block } from './block.js'
-import type {
-  RpcBlock,
-  RpcTransaction,
-  RpcTransactionReceipt,
-  RpcTransactionRequest,
-} from './rpc.js'
-import type {
-  Transaction,
-  TransactionReceipt,
-  TransactionRequest,
-} from './transaction.js'
+import type { Chain } from './chain.js'
 
-export type Formatter<TSource = any, TTarget = any> = (
-  value: TSource & { [key: string]: unknown },
-) => TTarget
+export type Formatter<TType extends string = string> = {
+  format: (args: any) => any
+  type: TType
+}
 
 export type Formatters = {
-  block?: Formatter<RpcBlock, Block>
-  transaction?: Formatter<RpcTransaction, Transaction>
-  transactionReceipt?: Formatter<RpcTransactionReceipt, TransactionReceipt>
-  transactionRequest?: Formatter<TransactionRequest, RpcTransactionRequest>
+  block?: Formatter<'block'>
+  transaction?: Formatter<'transaction'>
+  transactionReceipt?: Formatter<'transactionReceipt'>
+  transactionRequest?: Formatter<'transactionRequest'>
 }
+
+export type ExtractFormatterParameters<
+  TChain extends Chain | undefined,
+  TType extends keyof Formatters,
+  TFallback,
+> = TChain extends Chain<infer _Formatters extends Formatters>
+  ? _Formatters[TType] extends Formatter
+    ? Parameters<_Formatters[TType]['format']>[0]
+    : TFallback
+  : TFallback
+
+export type ExtractFormatterReturnType<
+  TChain extends Chain | undefined,
+  TType extends keyof Formatters,
+  TFallback,
+> = TChain extends Chain<infer _Formatters extends Formatters>
+  ? _Formatters[TType] extends Formatter
+    ? ReturnType<_Formatters[TType]['format']>
+    : TFallback
+  : TFallback

package/src/types/log.ts

@@ -1,39 +1,22 @@
-import type { Abi, AbiEvent, Address, ExtractAbiEventNames } from 'abitype'
-import type { GetEventArgs } from './contract.js'
-import type { Hash, Hex } from './misc.js'
+import type {
+  Abi,
+  AbiEvent,
+  Address,
+  ExtractAbiEvent,
+  ExtractAbiEventNames,
+} from 'abitype'
 
-type DecodedAbiEvent<
-  TAbiEvent extends AbiEvent | undefined = undefined,
-  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
-  TEventName extends string | undefined = TAbiEvent extends AbiEvent
-    ? TAbiEvent['name']
-    : undefined,
-> = TAbi extends Abi
-  ? TEventName extends string
-    ? {
-        args: GetEventArgs<
-          TAbi,
-          TEventName,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
-        >
-        /** The event name decoded from `topics`. */
-        eventName: TEventName
-      }
-    : {
-        args: GetEventArgs<
-          TAbi,
-          string,
-          { EnableUnion: false; IndexedOnly: false; Required: true }
-        >
-        /** The event name decoded from `topics`. */
-        eventName: ExtractAbiEventNames<TAbi>
-      }
-  : {}
+import type {
+  AbiEventParametersToPrimitiveTypes,
+  GetEventArgs,
+} from './contract.js'
+import type { Hash, Hex } from './misc.js'
 
 export type Log<
   TQuantity = bigint,
   TIndex = number,
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TAbi extends Abi | readonly unknown[] = [TAbiEvent],
   TEventName extends string | undefined = TAbiEvent extends AbiEvent
     ? TAbiEvent['name']
@@ -53,8 +36,93 @@ export type Log<
   transactionHash: Hash | null
   /** Index of the transaction that created this log or `null` if pending */
   transactionIndex: TIndex | null
-  /** List of order-dependent topics */
-  topics: [Hex, ...Hex[]] | []
   /** `true` if this filter has been destroyed and is invalid */
   removed: boolean
-} & DecodedAbiEvent<TAbiEvent, TAbi, TEventName>
+} & GetInferredLogValues<TAbiEvent, TAbi, TEventName, TStrict>
+
+type Topics<
+  THead extends AbiEvent['inputs'],
+  TBase = [Hex],
+> = THead extends readonly [
+  infer _Head,
+  ...infer Tail extends AbiEvent['inputs'],
+]
+  ? _Head extends { indexed: true }
+    ? [Hex, ...Topics<Tail>]
+    : Topics<Tail>
+  : TBase
+
+type GetTopics<
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  TEventName extends string | undefined = TAbiEvent extends AbiEvent
+    ? TAbiEvent['name']
+    : undefined,
+  _AbiEvent extends AbiEvent | undefined = TAbi extends Abi
+    ? TEventName extends string
+      ? ExtractAbiEvent<TAbi, TEventName>
+      : undefined
+    : undefined,
+  _Args = _AbiEvent extends AbiEvent
+    ? AbiEventParametersToPrimitiveTypes<_AbiEvent['inputs']>
+    : never,
+  _FailedToParseArgs =
+    | ([_Args] extends [never] ? true : false)
+    | (readonly unknown[] extends _Args ? true : false),
+> = true extends _FailedToParseArgs
+  ? [Hex, ...Hex[]] | []
+  : TAbiEvent extends AbiEvent
+  ? Topics<TAbiEvent['inputs']>
+  : _AbiEvent extends AbiEvent
+  ? Topics<_AbiEvent['inputs']>
+  : [Hex, ...Hex[]] | []
+
+type GetInferredLogValues<
+  TAbiEvent extends AbiEvent | undefined = undefined,
+  TAbi extends Abi | readonly unknown[] = [TAbiEvent],
+  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
+      : ExtractAbiEventNames<TAbi>
+    : string,
+> = TAbi extends Abi
+  ? TEventName extends string
+    ? {
+        args: GetEventArgs<
+          TAbi,
+          TEventName,
+          {
+            EnableUnion: false
+            IndexedOnly: false
+            Required: TStrict extends boolean ? TStrict : false
+          }
+        >
+        /** The event name decoded from `topics`. */
+        eventName: TEventName
+        /** List of order-dependent topics */
+        topics: GetTopics<TAbiEvent, TAbi, TEventName>
+      }
+    : {
+        [TName in _EventNames]: {
+          args: GetEventArgs<
+            TAbi,
+            string,
+            {
+              EnableUnion: false
+              IndexedOnly: false
+              Required: TStrict extends boolean ? TStrict : false
+            }
+          >
+          /** The event name decoded from `topics`. */
+          eventName: TName
+          /** List of order-dependent topics */
+          topics: GetTopics<TAbiEvent, TAbi, TName>
+        }
+      }[_EventNames]
+  : {
+      topics: [Hex, ...Hex[]] | []
+    }

package/src/types/misc.ts

@@ -2,6 +2,12 @@ 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 = {
   r: Hex
   s: Hex

package/src/types/multicall.ts

@@ -1,4 +1,5 @@
 import type { Abi } from 'abitype'
+
 import type {
   ContractFunctionConfig,
   ContractFunctionResult,
@@ -59,7 +60,7 @@ export type MulticallResult<
       | {
           error: Error
           result?: undefined
-          status: 'error'
+          status: 'failure'
         }
   : Result
 

package/src/types/rpc.ts

@@ -6,13 +6,16 @@ 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 RpcBlockNumber = BlockNumber<Quantity>
@@ -27,8 +30,13 @@ export type RpcTransactionReceipt = TransactionReceipt<
   Status,
   TransactionType
 >
-export type RpcTransactionRequest = TransactionRequest<Quantity, Index>
-export type RpcTransaction =
+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'>
+  | TransactionEIP1559<Quantity, Index, '0x2'>,
+  'typeHex'
+>

package/src/types/serializer.ts

@@ -0,0 +1,19 @@
+import type {
+  TransactionSerializable,
+  TransactionSerializableGeneric,
+} from '../types/transaction.js'
+import type { SerializeTransactionFn } from '../utils/transaction/serializeTransaction.js'
+import type { Formatter, Formatters } from './formatter.js'
+
+export type Serializers<
+  TFormatters extends Formatters | undefined = undefined,
+> = {
+  transaction?: SerializeTransactionFn<
+    TFormatters extends Formatters
+      ? TFormatters['transactionRequest'] extends Formatter
+        ? TransactionSerializableGeneric &
+            Parameters<TFormatters['transactionRequest']['format']>[0]
+        : TransactionSerializable
+      : TransactionSerializable
+  >
+}

package/src/types/transaction.ts

@@ -1,5 +1,7 @@
 import type { Address } from 'abitype'
-import type { transactionType } from '../utils/index.js'
+
+import type { transactionType } from '../utils/formatters/transaction.js'
+
 import type { FeeValuesEIP1559, FeeValuesLegacy } from './fee.js'
 import type { Log } from './log.js'
 import type { Hash, Hex, Signature } from './misc.js'
@@ -7,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,
@@ -33,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
@@ -50,8 +52,6 @@ export type TransactionBase<TQuantity = bigint, TIndex = number> = {
   blockHash: Hash | null
   /** Number of block containing this transaction or `null` if pending */
   blockNumber: TQuantity | null
-  /** Chain ID. */
-  chainId: TIndex
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
@@ -70,6 +70,8 @@ export type TransactionBase<TQuantity = bigint, TIndex = number> = {
   to: Address | null
   /** Index of this transaction in the block or `null` if pending */
   transactionIndex: TIndex | null
+  /** The type represented as hex. */
+  typeHex: Hex | null
   /** ECDSA recovery ID */
   v: TQuantity
   /** Value in wei sent with this transaction */
@@ -82,6 +84,7 @@ export type TransactionLegacy<
 > = TransactionBase<TQuantity, TIndex> &
   FeeValuesLegacy<TQuantity> & {
     accessList?: never
+    chainId?: TIndex
     type: TType
   }
 export type TransactionEIP2930<
@@ -91,6 +94,7 @@ export type TransactionEIP2930<
 > = TransactionBase<TQuantity, TIndex> &
   FeeValuesLegacy<TQuantity> & {
     accessList: AccessList
+    chainId: TIndex
     type: TType
   }
 export type TransactionEIP1559<
@@ -100,6 +104,7 @@ export type TransactionEIP1559<
 > = TransactionBase<TQuantity, TIndex> &
   FeeValuesEIP1559<TQuantity> & {
     accessList: AccessList
+    chainId: TIndex
     type: TType
   }
 export type Transaction<TQuantity = bigint, TIndex = number> =
@@ -124,23 +129,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>
@@ -150,10 +161,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,
@@ -188,7 +204,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/transport.ts

@@ -1,4 +1,4 @@
-import type { Transport } from '../clients/index.js'
+import type { Transport } from '../clients/transports/createTransport.js'
 
 export type GetTransportConfig<TTransport extends Transport> =
   ReturnType<TTransport>['config']

package/src/types/typedData.ts

@@ -15,11 +15,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 +32,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 */

package/src/types/utils.ts

@@ -42,6 +42,27 @@ export type IsNarrowable<T, U> = IsNever<
  */
 export type IsNever<T> = [T] extends [never] ? true : false
 
+/**
+ * @description Evaluates boolean "or" condition for {@link T} properties.
+ * @param T - Type to check
+ *
+ * * @example
+ * type Result = Or<[false, true, false]>
+ * //   ^? type Result = true
+ *
+ * @example
+ * type Result = Or<[false, false, false]>
+ * //   ^? type Result = false
+ */
+export type Or<T extends readonly unknown[],> = T extends readonly [
+  infer Head,
+  ...infer Tail,
+]
+  ? Head extends true
+    ? true
+    : Or<Tail>
+  : false
+
 /**
  * @description Checks if {@link T} is `undefined`
  * @param T - Type to check
@@ -86,13 +107,24 @@ export type MaybeRequired<T, TRequired extends boolean> = TRequired extends true
   : T
 
 /**
- * @description Merges the intersection properties of T and U.
+ * @description Makes the attribute on the type T allow undefined if TUndefinedish is true.
  *
  * @example
- * MergeIntersectionProperties<{ a: string, b: number }, { a: number, c: boolean }>
- * => { a: number, b: number }
+ * MaybeUndefined<string, true>
+ * => string | undefined
+ *
+ * MaybeUndefined<string, false>
+ * => string
  */
-export type MergeIntersectionProperties<T, U> = {
+export type MaybeUndefined<
+  T,
+  TUndefinedish extends boolean,
+> = TUndefinedish extends true ? T | undefined : T
+
+/**
+ * @private Helper for `Assign`. This is a workaround for tsc generating errorneous type definitions.
+ */
+export type Assign_<T, U> = {
   [K in
     keyof T as K extends keyof U
       ? U[K] extends void
@@ -101,6 +133,15 @@ export type MergeIntersectionProperties<T, U> = {
       : K]: K extends keyof U ? U[K] : T[K]
 }
 
+/**
+ * @description Assigns the properties of U onto T.
+ *
+ * @example
+ * Assign<{ a: string, b: number }, { a: undefined, c: boolean }>
+ * => { a: undefined, b: number, c: boolean }
+ */
+export type Assign<T, U> = Assign_<T, U> & U
+
 /**
  * @description Makes nullable properties from T optional.
  *
@@ -123,6 +164,16 @@ export type OptionalNullable<T> = {
  */
 export type NoUndefined<T> = T extends undefined ? never : T
 
+/**
+ * @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 UnionOmit<T, K extends keyof any> = T extends any
+  ? Omit<T, K>
+  : never
+
 /**
  * @description Creates a type that is a partial of T, but with the required keys K.
  *
@@ -135,9 +186,9 @@ export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 /**
  * @description Combines members of an intersection into a readable type.
  *
- * @link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg
+ * @see {@link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg}
  * @example
- * Prettify<{ a: string } | { b: string } | { c: number, d: bigint }>
+ * Prettify<{ a: string } & { b: string } & { c: number, d: bigint }>
  * => { a: string, b: string, c: number, d: bigint }
  */
 export type Prettify<T> = {

package/src/types/window.ts

@@ -1,9 +1,7 @@
-import type { Events, Requests } from './eip1193.js'
-
-type WindowProvider = Requests & Events
+import type { EIP1193Provider } from './eip1193.js'
 
 declare global {
   interface Window {
-    ethereum?: WindowProvider
+    ethereum?: EIP1193Provider
   }
 }