viem 2.0.0-beta.6 → 2.0.0-beta.9

package/types/contract.ts

@@ -138,8 +138,8 @@ export type Widen<type> =
       ? type extends ResolvedRegister['AddressType']
         ? ResolvedRegister['AddressType']
         : type extends ResolvedRegister['BytesType']['inputs']
-        ? ResolvedRegister['BytesType']
-        : string
+          ? ResolvedRegister['BytesType']
+          : string
       : never)
   | (type extends readonly [] ? readonly [] : never)
   | (type extends Record<string, unknown>
@@ -166,7 +166,8 @@ export type ExtractAbiFunctionForArgs<
   mutability
 > extends infer abiFunction extends AbiFunction
   ? IsUnion<abiFunction> extends true // narrow overloads using `args` by converting to tuple and filtering out overloads that don't match
-    ? UnionToTuple<abiFunction> extends infer abiFunctions extends readonly AbiFunction[]
+    ? UnionToTuple<abiFunction> extends infer abiFunctions extends
+        readonly AbiFunction[]
       ? {
           [k in keyof abiFunctions]: (
             readonly [] extends args
@@ -225,19 +226,19 @@ export type ContractFunctionReturnType<
   ? Abi extends abi
     ? unknown
     : AbiParametersToPrimitiveTypes<
-        ExtractAbiFunctionForArgs<
-          abi,
-          mutability,
-          functionName,
-          args
-        >['outputs']
-      > extends infer types
-    ? types extends readonly []
-      ? void
-      : types extends readonly [infer type]
-      ? type
-      : types
-    : never
+          ExtractAbiFunctionForArgs<
+            abi,
+            mutability,
+            functionName,
+            args
+          >['outputs']
+        > extends infer types
+      ? types extends readonly []
+        ? void
+        : types extends readonly [infer type]
+          ? type
+          : types
+      : never
   : unknown
 
 export type AbiItem = Abi[number]
@@ -308,8 +309,8 @@ export type GetValue<
   ? TAbiFunction['stateMutability'] extends 'payable'
     ? { value?: NoUndefined<TValueType> }
     : TAbiFunction['payable'] extends true
-    ? { value?: NoUndefined<TValueType> }
-    : { value?: never }
+      ? { value?: NoUndefined<TValueType> }
+      : { value?: never }
   : { value?: TValueType }
 
 //////////////////////////////////////////////////////////////////////////////////////////////////
@@ -365,49 +366,48 @@ export type AbiEventParametersToPrimitiveTypes<
 > = TAbiParameters extends readonly []
   ? readonly []
   : Filter<
-      TAbiParameters,
-      Options['IndexedOnly'] extends true ? { indexed: true } : object
-    > extends infer Filtered extends readonly AbiParameter[]
-  ? _HasUnnamedAbiParameter<Filtered> extends true
-    ? // Has unnamed tuple parameters so return as array
-        | readonly [
-            ...{
-              [K in keyof Filtered]: AbiEventParameterToPrimitiveType<
-                Filtered[K],
-                Options
-              >
-            },
-          ]
-        // Distribute over tuple to represent optional parameters
-        | (Options['Required'] extends true
-            ? never
-            : // Distribute over tuple to represent optional parameters
-            Filtered extends readonly [
-                ...infer Head extends readonly AbiParameter[],
-                infer _,
-              ]
-            ? AbiEventParametersToPrimitiveTypes<
-                readonly [...{ [K in keyof Head]: Omit<Head[K], 'name'> }],
-                Options
-              >
-            : never)
-    : // All tuple parameters are named so return as object
-    {
-        [Parameter in
-          Filtered[number] as Parameter extends {
-            name: infer Name extends string
-          }
-            ? Name
-            : never]?: AbiEventParameterToPrimitiveType<Parameter, Options>
-      } extends infer Mapped
-    ? Prettify<
-        MaybeRequired<
-          Mapped,
-          Options['Required'] extends boolean ? Options['Required'] : false
-        >
-      >
+        TAbiParameters,
+        Options['IndexedOnly'] extends true ? { indexed: true } : object
+      > extends infer Filtered extends readonly AbiParameter[]
+    ? _HasUnnamedAbiParameter<Filtered> extends true
+      ? // Has unnamed tuple parameters so return as array
+          | readonly [
+              ...{
+                [K in keyof Filtered]: AbiEventParameterToPrimitiveType<
+                  Filtered[K],
+                  Options
+                >
+              },
+            ]
+          // Distribute over tuple to represent optional parameters
+          | (Options['Required'] extends true
+              ? never
+              : // Distribute over tuple to represent optional parameters
+                Filtered extends readonly [
+                    ...infer Head extends readonly AbiParameter[],
+                    infer _,
+                  ]
+                ? AbiEventParametersToPrimitiveTypes<
+                    readonly [...{ [K in keyof Head]: Omit<Head[K], 'name'> }],
+                    Options
+                  >
+                : never)
+      : // All tuple parameters are named so return as object
+        {
+            [Parameter in Filtered[number] as Parameter extends {
+              name: infer Name extends string
+            }
+              ? Name
+              : never]?: AbiEventParameterToPrimitiveType<Parameter, Options>
+          } extends infer Mapped
+        ? Prettify<
+            MaybeRequired<
+              Mapped,
+              Options['Required'] extends boolean ? Options['Required'] : false
+            >
+          >
+        : never
     : never
-  : never
 
 // TODO: Speed up by returning immediately as soon as named parameter is found.
 type _HasUnnamedAbiParameter<TAbiParameters extends readonly AbiParameter[]> =
@@ -431,10 +431,10 @@ export type LogTopicType<
 > = TTopic extends Hex
   ? TPrimitiveType
   : TTopic extends Hex[]
-  ? TPrimitiveType[]
-  : TTopic extends null
-  ? null
-  : never
+    ? TPrimitiveType[]
+    : TTopic extends null
+      ? null
+      : never
 
 /**
  * @internal

package/types/eip1193.ts

@@ -1330,6 +1330,13 @@ export type EIP1193Parameters<
       params?: unknown
     }
 
+export type EIP1193RequestOptions = {
+  // The base delay (in ms) between retries.
+  retryDelay?: number
+  // The max number of times to retry.
+  retryCount?: number
+}
+
 type DerivedRpcSchema<
   TRpcSchema extends RpcSchema | undefined,
   TRpcSchemaOverride extends RpcSchemaOverride | undefined,
@@ -1355,4 +1362,5 @@ export type EIP1193RequestFn<
     : unknown,
 >(
   args: TParameters,
+  options?: EIP1193RequestOptions,
 ) => Promise<_ReturnType>

package/types/ens.ts

@@ -1,5 +1,5 @@
 export type AssetGateway = 'ipfs' | 'arweave'
 
 export type AssetGatewayUrls = {
-  [key in AssetGateway]?: string
+  [_key in AssetGateway]?: string
 }

package/types/filter.ts

@@ -42,18 +42,18 @@ export type Filter<
             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
+              args: TArgs
+              eventName: TEventName
+              strict: TStrict
+            }
+          : {
+              abi: TAbi
+              args?: never
+              eventName: TEventName
+              strict: TStrict
+            }
       : {
           abi?: never
           args?: never

package/types/log.ts

@@ -75,10 +75,10 @@ type GetTopics<
 > = true extends _FailedToParseArgs
   ? [Hex, ...Hex[]] | []
   : TAbiEvent extends AbiEvent
-  ? Topics<TAbiEvent['inputs']>
-  : _AbiEvent extends AbiEvent
-  ? Topics<_AbiEvent['inputs']>
-  : [Hex, ...Hex[]] | []
+    ? Topics<TAbiEvent['inputs']>
+    : _AbiEvent extends AbiEvent
+      ? Topics<_AbiEvent['inputs']>
+      : [Hex, ...Hex[]] | []
 
 type GetInferredLogValues<
   TAbiEvent extends AbiEvent | undefined = undefined,

package/types/multicall.ts

@@ -20,21 +20,7 @@ export type MulticallContracts<
 > = contracts extends readonly [] // no contracts, return empty
   ? readonly []
   : contracts extends readonly [infer contract] // one contract left before returning `result`
-  ? readonly [
-      ...result,
-      MaybePartial<
-        Prettify<
-          GetMulticallContractParameters<contract, options['mutability']> &
-            options['properties']
-        >,
-        options['optional']
-      >,
-    ]
-  : contracts extends readonly [infer contract, ...infer rest] // grab first contract and recurse through `rest`
-  ? MulticallContracts<
-      [...rest],
-      options,
-      [
+    ? readonly [
         ...result,
         MaybePartial<
           Prettify<
@@ -44,21 +30,39 @@ export type MulticallContracts<
           options['optional']
         >,
       ]
-    >
-  : readonly unknown[] extends contracts
-  ? contracts
-  : // If `contracts` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!
-  // use this to infer the param types in the case of Array.map() argument
-  contracts extends readonly (infer contract extends ContractFunctionParameters)[]
-  ? readonly MaybePartial<
-      Prettify<contract & options['properties']>,
-      options['optional']
-    >[]
-  : // Fallback
-    readonly MaybePartial<
-      Prettify<ContractFunctionParameters & options['properties']>,
-      options['optional']
-    >[]
+    : contracts extends readonly [infer contract, ...infer rest] // grab first contract and recurse through `rest`
+      ? MulticallContracts<
+          [...rest],
+          options,
+          [
+            ...result,
+            MaybePartial<
+              Prettify<
+                GetMulticallContractParameters<
+                  contract,
+                  options['mutability']
+                > &
+                  options['properties']
+              >,
+              options['optional']
+            >,
+          ]
+        >
+      : readonly unknown[] extends contracts
+        ? contracts
+        : // If `contracts` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!
+          // use this to infer the param types in the case of Array.map() argument
+          contracts extends readonly (infer contract extends
+              ContractFunctionParameters)[]
+          ? readonly MaybePartial<
+              Prettify<contract & options['properties']>,
+              options['optional']
+            >[]
+          : // Fallback
+            readonly MaybePartial<
+              Prettify<ContractFunctionParameters & options['properties']>,
+              options['optional']
+            >[]
 
 export type MulticallResults<
   contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
@@ -72,20 +76,7 @@ export type MulticallResults<
 > = contracts extends readonly [] // no contracts, return empty
   ? readonly []
   : contracts extends readonly [infer contract] // one contract left before returning `result`
-  ? [
-      ...result,
-      MulticallResponse<
-        GetMulticallContractReturnType<contract, options['mutability']>,
-        options['error'],
-        allowFailure
-      >,
-    ]
-  : contracts extends readonly [infer contract, ...infer rest] // grab first contract and recurse through `rest`
-  ? MulticallResults<
-      [...rest],
-      allowFailure,
-      options,
-      [
+    ? [
         ...result,
         MulticallResponse<
           GetMulticallContractReturnType<contract, options['mutability']>,
@@ -93,19 +84,33 @@ export type MulticallResults<
           allowFailure
         >,
       ]
-    >
-  : readonly unknown[] extends contracts
-  ? MulticallResponse<unknown, options['error'], allowFailure>[]
-  : // If `contracts` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!
-  // use this to infer the param types in the case of Array.map() argument
-  contracts extends readonly (infer contract extends ContractFunctionParameters)[]
-  ? MulticallResponse<
-      GetMulticallContractReturnType<contract, options['mutability']>,
-      options['error'],
-      allowFailure
-    >[]
-  : // Fallback
-    MulticallResponse<unknown, options['error'], allowFailure>[]
+    : contracts extends readonly [infer contract, ...infer rest] // grab first contract and recurse through `rest`
+      ? MulticallResults<
+          [...rest],
+          allowFailure,
+          options,
+          [
+            ...result,
+            MulticallResponse<
+              GetMulticallContractReturnType<contract, options['mutability']>,
+              options['error'],
+              allowFailure
+            >,
+          ]
+        >
+      : readonly unknown[] extends contracts
+        ? MulticallResponse<unknown, options['error'], allowFailure>[]
+        : // If `contracts` is *some* array but we couldn't assign `unknown[]` to it, then it must hold some known/homogenous type!
+          // use this to infer the param types in the case of Array.map() argument
+          contracts extends readonly (infer contract extends
+              ContractFunctionParameters)[]
+          ? MulticallResponse<
+              GetMulticallContractReturnType<contract, options['mutability']>,
+              options['error'],
+              allowFailure
+            >[]
+          : // Fallback
+            MulticallResponse<unknown, options['error'], allowFailure>[]
 
 export type MulticallResponse<
   result = unknown,
@@ -144,10 +149,10 @@ type GetMulticallContractParameters<
       ? ContractFunctionParameters<abi, mutability, functionName, args> // `args` valid, pass through
       : ContractFunctionParameters<abi, mutability, functionName> // invalid `args`
     : // 1b. `functionName` is invalid, check if `abi` is declared as `Abi`
-    Abi extends abi
-    ? ContractFunctionParameters // `abi` declared as `Abi`, unable to infer types further
-    : // `abi` is const-asserted or defined inline, infer types for `functionName` and `args`
-      ContractFunctionParameters<abi, mutability>
+      Abi extends abi
+      ? ContractFunctionParameters // `abi` declared as `Abi`, unable to infer types further
+      : // `abi` is const-asserted or defined inline, infer types for `functionName` and `args`
+        ContractFunctionParameters<abi, mutability>
   : ContractFunctionParameters<readonly unknown[]> // invalid `contract['abi']`, set to `readonly unknown[]`
 
 type GetMulticallContractReturnType<

package/types/rpc.ts

@@ -46,7 +46,7 @@ export type RpcTransactionRequest =
   | TransactionRequestLegacy<Quantity, Index, '0x0'>
   | TransactionRequestEIP2930<Quantity, Index, '0x1'>
   | TransactionRequestEIP1559<Quantity, Index, '0x2'>
-export type RpcTransaction<TPending extends boolean = boolean,> = UnionOmit<
+export type RpcTransaction<TPending extends boolean = boolean> = UnionOmit<
   UnionPartialBy<
     | TransactionLegacy<Quantity, Index, TPending, '0x0'>
     | TransactionEIP2930<Quantity, Index, TPending, '0x1'>

package/types/transaction.ts

@@ -186,10 +186,10 @@ export type TransactionSerialized<TType extends TransactionType = 'legacy'> =
   TType extends 'eip1559'
     ? TransactionSerializedEIP1559
     : TType extends 'eip2930'
-    ? TransactionSerializedEIP2930
-    : TType extends 'legacy'
-    ? TransactionSerializedLegacy
-    : TransactionSerializedGeneric
+      ? TransactionSerializedEIP2930
+      : TType extends 'legacy'
+        ? TransactionSerializedLegacy
+        : TransactionSerializedGeneric
 
 export type TransactionSerializableBase<
   TQuantity = bigint,

package/types/utils.ts

@@ -97,12 +97,11 @@ export type MaybeRequired<T, TRequired extends boolean> = TRequired extends true
  */
 export type Assign<T, U> = Assign_<T, U> & U
 type Assign_<T, U> = {
-  [K in
-    keyof T as K extends keyof U
-      ? U[K] extends void
-        ? never
-        : K
-      : K]: K extends keyof U ? U[K] : T[K]
+  [K in keyof T as K extends keyof U
+    ? U[K] extends void
+      ? never
+      : K
+    : K]: K extends keyof U ? U[K] : T[K]
 }
 
 /**
@@ -151,6 +150,15 @@ export type Prettify<T> = {
   [K in keyof T]: T[K]
 } & {}
 
+/**
+ * @description Creates a type that is T with the required keys K.
+ *
+ * @example
+ * RequiredBy<{ a?: string, b: number }, 'a'>
+ * => { a: string, b: number }
+ */
+export type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+
 /**
  * @description Creates a type that extracts the values of T.
  *
@@ -198,7 +206,7 @@ export type OneOf<
   ///
   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>]?: undefined }>
   : never
 type KeyofUnion<type> = type extends type ? keyof type : never
 
@@ -240,3 +248,14 @@ export type UnionOmit<type, keys extends keyof type> = type extends any
 export type UnionPartialBy<T, K extends keyof T> = T extends any
   ? PartialBy<T, K>
   : never
+
+/**
+ * @description Creates a type that is T with the required keys K.
+ *
+ * @example
+ * RequiredBy<{ a?: string, b: number } | { a?: string, c?: number }, 'a'>
+ * => { a: string, b: number } | { a: string, c?: number }
+ */
+export type UnionRequiredBy<T, K extends keyof T> = T extends any
+  ? RequiredBy<T, K>
+  : never

package/utils/abi/decodeEventLog.ts

@@ -56,7 +56,8 @@ export type DecodeEventLogReturnType<
   data extends Hex | undefined = undefined,
   strict extends boolean = true,
   ///
-  allEventNames extends ContractEventName<abi> = eventName extends ContractEventName<abi>
+  allEventNames extends
+    ContractEventName<abi> = eventName extends ContractEventName<abi>
     ? eventName
     : ContractEventName<abi>,
 > = IsNarrowable<abi, Abi> extends true

package/utils/abi/decodeFunctionData.ts

@@ -29,7 +29,8 @@ export type DecodeFunctionDataParameters<
 export type DecodeFunctionDataReturnType<
   abi extends Abi | readonly unknown[] = Abi,
   ///
-  allFunctionNames extends ContractFunctionName<abi> = ContractFunctionName<abi>,
+  allFunctionNames extends
+    ContractFunctionName<abi> = ContractFunctionName<abi>,
 > = IsNarrowable<abi, Abi> extends true
   ? UnionEvaluate<
       {

package/utils/abi/decodeFunctionResult.ts

@@ -47,8 +47,8 @@ export type DecodeFunctionResultParameters<
     ? Abi extends abi
       ? true
       : [ExtractAbiFunctions<abi>] extends [never]
-      ? false
-      : true
+        ? false
+        : true
     : true,
   allArgs = ContractFunctionArgs<
     abi,

package/utils/abi/encodeDeployData.ts

@@ -24,8 +24,8 @@ export type EncodeDeployDataParameters<
     ? Abi extends abi
       ? true
       : [Extract<abi[number], { type: 'constructor' }>] extends [never]
-      ? false
-      : true
+        ? false
+        : true
     : true,
   allArgs = ContractConstructorArgs<abi>,
 > = {

package/utils/abi/encodeErrorResult.ts

@@ -34,8 +34,8 @@ export type EncodeErrorResultParameters<
     ? Abi extends abi
       ? true
       : [ExtractAbiErrors<abi>] extends [never]
-      ? false
-      : true
+        ? false
+        : true
     : true,
   allArgs = ContractErrorArgs<
     abi,

package/utils/abi/encodeEventTopics.ts

@@ -44,8 +44,8 @@ export type EncodeEventTopicsParameters<
     ? Abi extends abi
       ? true
       : [ExtractAbiEvents<abi>] extends [never]
-      ? false
-      : true
+        ? false
+        : true
     : true,
   allArgs = ContractEventArgs<
     abi,
@@ -101,8 +101,8 @@ export function encodeEventTopics<
     const args_ = Array.isArray(args)
       ? args
       : Object.values(args).length > 0
-      ? indexedInputs?.map((x: any) => (args as any)[x.name]) ?? []
-      : []
+        ? indexedInputs?.map((x: any) => (args as any)[x.name]) ?? []
+        : []
 
     if (args_.length > 0) {
       topics =
@@ -112,8 +112,8 @@ export function encodeEventTopics<
                 encodeArg({ param, value: args_[i][j] }),
               )
             : args_[i]
-            ? encodeArg({ param, value: args_[i] })
-            : null,
+              ? encodeArg({ param, value: args_[i] })
+              : null,
         ) ?? []
     }
   }

package/utils/abi/encodeFunctionData.ts

@@ -36,8 +36,8 @@ export type EncodeFunctionDataParameters<
     ? Abi extends abi
       ? true
       : [ExtractAbiFunctions<abi>] extends [never]
-      ? false
-      : true
+        ? false
+        : true
     : true,
   allArgs = ContractFunctionArgs<
     abi,

package/utils/abi/encodeFunctionResult.ts

@@ -30,8 +30,8 @@ export type EncodeFunctionResultParameters<
     ? Abi extends abi
       ? true
       : [ExtractAbiFunctions<abi>] extends [never]
-      ? false
-      : true
+        ? false
+        : true
     : true,
   allFunctionNames = ContractFunctionName<abi>,
 > = {