viem 0.0.0-w-20230828183856 → 0.0.0-w-20230904174840

package/src/types/contract.ts

@@ -1,7 +1,5 @@
 import {
   type Abi,
-  type AbiConstructor,
-  type AbiError,
   type AbiEvent,
   type AbiFunction,
   type AbiParameter,
@@ -43,6 +41,24 @@ export type ContractFunctionName<
     : functionName
   : string
 
+export type ContractErrorName<abi extends Abi | readonly unknown[] = Abi> =
+  ExtractAbiErrorNames<
+    abi extends Abi ? abi : Abi
+  > extends infer errorName extends string
+    ? [errorName] extends [never]
+      ? string
+      : errorName
+    : string
+
+export type ContractEventName<abi extends Abi | readonly unknown[] = Abi> =
+  ExtractAbiEventNames<
+    abi extends Abi ? abi : Abi
+  > extends infer eventName extends string
+    ? [eventName] extends [never]
+      ? string
+      : eventName
+    : string
+
 export type ContractFunctionArgs<
   abi extends Abi | readonly unknown[] = Abi,
   mutability extends AbiStateMutability = AbiStateMutability,
@@ -63,6 +79,56 @@ export type ContractFunctionArgs<
     : args
   : readonly unknown[]
 
+export type ContractConstructorArgs<
+  abi extends Abi | readonly unknown[] = Abi,
+> = AbiParametersToPrimitiveTypes<
+  Extract<
+    (abi extends Abi ? abi : Abi)[number],
+    { type: 'constructor' }
+  >['inputs'],
+  'inputs'
+> extends infer args
+  ? [args] extends [never]
+    ? readonly unknown[]
+    : args
+  : readonly unknown[]
+
+export type ContractErrorArgs<
+  abi extends Abi | readonly unknown[] = Abi,
+  errorName extends ContractErrorName<abi> = ContractErrorName<abi>,
+> = AbiParametersToPrimitiveTypes<
+  ExtractAbiError<abi extends Abi ? abi : Abi, errorName>['inputs'],
+  'inputs'
+> extends infer args
+  ? [args] extends [never]
+    ? readonly unknown[]
+    : args
+  : readonly unknown[]
+
+export type ContractEventArgs<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractErrorName<abi> = ContractErrorName<abi>,
+> = AbiEventParametersToPrimitiveTypes<
+  ExtractAbiEvent<abi extends Abi ? abi : Abi, eventName>['inputs']
+> extends infer args
+  ? [args] extends [never]
+    ? readonly unknown[] | Record<string, unknown>
+    : args
+  : readonly unknown[] | Record<string, unknown>
+
+export type ContractEventArgsFromTopics<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> = ContractEventName<abi>,
+  strict extends boolean = true,
+> = AbiEventParametersToPrimitiveTypes<
+  ExtractAbiEvent<abi extends Abi ? abi : Abi, eventName>['inputs'],
+  { EnableUnion: false; IndexedOnly: false; Required: strict }
+> extends infer args
+  ? [args] extends [never]
+    ? readonly unknown[] | Record<string, unknown>
+    : args
+  : readonly unknown[] | Record<string, unknown>
+
 export type Widen<type> =
   | ([unknown] extends [type] ? unknown : never)
   | (type extends Function ? type : never)
@@ -101,7 +167,11 @@ export type ExtractAbiFunctionForArgs<
   ? 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[]
       ? {
-          [k in keyof abiFunctions]: args extends AbiParametersToPrimitiveTypes<
+          [k in keyof abiFunctions]: (
+            readonly [] extends args
+              ? readonly [] // fallback to `readonly []` if `args` has no value (e.g. `args` property not provided)
+              : args
+          ) extends AbiParametersToPrimitiveTypes<
             abiFunctions[k]['inputs'],
             'inputs'
           >
@@ -135,16 +205,17 @@ export type ContractFunctionParameters<
   functionName:
     | allFunctionNames // show all options
     | (functionName extends allFunctionNames ? functionName : never) // infer value
-  args?:
-    | allArgs // show all options
-    | (args extends allArgs ? Widen<args> : never) // infer value, widen inferred value of `args` conditionally to match `allArgs`
-    | undefined
 } & UnionEvaluate<
   readonly [] extends allArgs
     ? {
         args?:
           | allArgs // show all options
-          | (args extends allArgs ? Widen<args> : never) // infer value, widen inferred value of `args` conditionally to match `allArgs`
+          // infer value, widen inferred value of `args` conditionally to match `allArgs`
+          | (abi extends Abi
+              ? args extends allArgs
+                ? Widen<args>
+                : never
+              : never)
           | undefined
       }
     : {
@@ -174,7 +245,7 @@ export type ContractFunctionReturnType<
           abi,
           mutability,
           functionName,
-          readonly [] extends args ? readonly [] : args
+          args
         >['outputs']
       > extends infer types
     ? types extends readonly []
@@ -187,25 +258,59 @@ export type ContractFunctionReturnType<
 
 export type AbiItem = Abi[number]
 
-export type EventDefinition = `${string}(${string})`
+export type ExtractAbiItemNames<abi extends Abi> = Extract<
+  abi[number],
+  { name: string }
+>['name']
 
-export type ContractFunctionResult<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
-  TAbiFunction extends AbiFunction & {
-    type: 'function'
-  } = TAbi extends Abi ? ExtractAbiFunction<TAbi, TFunctionName> : AbiFunction,
-  TArgs = AbiParametersToPrimitiveTypes<TAbiFunction['outputs']>,
-  FailedToParseArgs =
-    | ([TArgs] extends [never] ? true : false)
-    | (readonly unknown[] extends TArgs ? true : false),
-> = true extends FailedToParseArgs
-  ? unknown
-  : TArgs extends readonly []
-  ? void
-  : TArgs extends readonly [infer Arg]
-  ? Arg
-  : TArgs
+export type ExtractAbiItem<
+  abi extends Abi,
+  name extends ExtractAbiItemNames<abi>,
+> = Extract<abi[number], { name: name }>
+
+export type AbiItemName<abi extends Abi | readonly unknown[] = Abi> =
+  abi extends Abi ? ExtractAbiItemNames<abi> : string
+
+export type AbiItemArgs<
+  abi extends Abi | readonly unknown[] = Abi,
+  name extends AbiItemName<abi> = AbiItemName<abi>,
+> = AbiParametersToPrimitiveTypes<
+  ExtractAbiItem<abi extends Abi ? abi : Abi, name>['inputs'],
+  'inputs'
+> extends infer args
+  ? [args] extends [never]
+    ? readonly unknown[]
+    : args
+  : readonly unknown[]
+
+export type ExtractAbiItemForArgs<
+  abi extends Abi,
+  name extends AbiItemName<abi>,
+  args extends AbiItemArgs<abi, name>,
+> = ExtractAbiItem<abi, name> extends infer abiItem extends AbiItem & {
+  inputs: readonly AbiParameter[]
+}
+  ? IsUnion<abiItem> extends true // narrow overloads using `args` by converting to tuple and filtering out overloads that don't match
+    ? UnionToTuple<abiItem> extends infer abiItems extends readonly (AbiItem & {
+        inputs: readonly AbiParameter[]
+      })[]
+      ? {
+          [k in keyof abiItems]: (
+            readonly [] extends args
+              ? readonly [] // fallback to `readonly []` if `args` has no value (e.g. `args` property not provided)
+              : args
+          ) extends AbiParametersToPrimitiveTypes<
+            abiItems[k]['inputs'],
+            'inputs'
+          >
+            ? abiItems[k]
+            : never
+        }[number] // convert back to union (removes `never` tuple entries: `['foo', never, 'bar'][number]` => `'foo' | 'bar'`)
+      : never
+    : abiItem
+  : never
+
+export type EventDefinition = `${string}(${string})`
 
 export type GetValue<
   TAbi extends Abi | readonly unknown[],
@@ -223,6 +328,8 @@ export type GetValue<
     : { value?: never }
   : { value?: TValueType }
 
+//////////////////////////////////////////////////////////////////////////////////////////////////
+
 export type MaybeAbiEventName<TAbiEvent extends AbiEvent | undefined> =
   TAbiEvent extends AbiEvent ? TAbiEvent['name'] : undefined
 
@@ -235,21 +342,6 @@ export type MaybeExtractEventArgsFromAbi<
     : undefined
   : undefined
 
-//////////////////////////////////////////////////////////////////////
-// ABI item name
-
-export type InferErrorName<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TErrorName extends string | undefined = string,
-> = TAbi extends Abi
-  ? ExtractAbiErrorNames<TAbi> extends infer AbiErrorNames
-    ?
-        | AbiErrorNames
-        | (TErrorName extends AbiErrorNames ? TErrorName : never)
-        | (Abi extends TAbi ? string : never)
-    : never
-  : TErrorName
-
 export type InferEventName<
   TAbi extends Abi | readonly unknown[] = Abi,
   TEventName extends string | undefined = string,
@@ -259,115 +351,9 @@ export type InferEventName<
     : never
   : TEventName
 
-export type InferFunctionName<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string | undefined = string,
-  TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
-> = TAbi extends Abi
-  ? ExtractAbiFunctionNames<
-      TAbi,
-      TAbiStateMutability
-    > extends infer AbiFunctionNames
-    ?
-        | AbiFunctionNames
-        | (TFunctionName extends AbiFunctionNames ? TFunctionName : never)
-        | (Abi extends TAbi ? string : never)
-    : never
-  : TFunctionName
-
-export type InferItemName<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TName extends string = string,
-> = TAbi extends Abi
-  ? ExtractAbiItemNames<TAbi> extends infer AbiNames
-    ?
-        | AbiNames
-        | (TName extends AbiNames ? TName : never)
-        | (Abi extends TAbi ? string : never)
-    : never
-  : TName
-type ExtractAbiItemNames<TAbi extends Abi> =
-  | ExtractAbiFunctionNames<TAbi>
-  | ExtractAbiEventNames<TAbi>
-  | ExtractAbiErrorNames<TAbi>
-
 //////////////////////////////////////////////////////////////////////
 // ABI item args
 
-export type GetFunctionArgs<
-  TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
-  TAbiFunction extends AbiFunction = TAbi extends Abi
-    ? ExtractAbiFunction<TAbi, TFunctionName>
-    : AbiFunction,
-  TArgs = AbiParametersToPrimitiveTypes<TAbiFunction['inputs']>,
-  FailedToParseArgs =
-    | ([TArgs] extends [never] ? true : false)
-    | (readonly unknown[] extends TArgs ? true : false),
-> = true extends FailedToParseArgs
-  ? {
-      /**
-       * Arguments to pass contract method
-       *
-       * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
-       */
-      args?: readonly unknown[]
-    }
-  : TArgs extends readonly []
-  ? { args?: never }
-  : {
-      /** Arguments to pass contract method */ args: TArgs
-    }
-
-export type GetConstructorArgs<
-  TAbi extends Abi | readonly unknown[],
-  TAbiConstructor extends AbiConstructor = TAbi extends Abi
-    ? Extract<TAbi[number], { type: 'constructor' }>
-    : AbiConstructor,
-  TArgs = AbiParametersToPrimitiveTypes<TAbiConstructor['inputs']>,
-  FailedToParseArgs =
-    | ([TArgs] extends [never] ? true : false)
-    | (readonly unknown[] extends TArgs ? true : false),
-> = true extends FailedToParseArgs
-  ? {
-      /**
-       * Arguments to pass contract constructor
-       *
-       * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
-       */
-      args?: readonly unknown[]
-    }
-  : TArgs extends readonly []
-  ? { args?: never }
-  : {
-      /** Arguments to pass contract constructor */ args: TArgs
-    }
-
-export type GetErrorArgs<
-  TAbi extends Abi | readonly unknown[],
-  TErrorName extends string,
-  TAbiError extends AbiError = TAbi extends Abi
-    ? ExtractAbiError<TAbi, TErrorName>
-    : AbiError,
-  TArgs = AbiParametersToPrimitiveTypes<TAbiError['inputs']>,
-  FailedToParseArgs =
-    | ([TArgs] extends [never] ? true : false)
-    | (readonly unknown[] extends TArgs ? true : false),
-> = true extends FailedToParseArgs
-  ? {
-      /**
-       * Arguments to pass contract method
-       *
-       * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
-       */
-      args?: readonly unknown[]
-    }
-  : TArgs extends readonly []
-  ? { args?: never }
-  : {
-      /** Arguments to pass contract method */ args: TArgs
-    }
-
 export type GetEventArgs<
   TAbi extends Abi | readonly unknown[],
   TEventName extends string,
@@ -383,25 +369,6 @@ export type GetEventArgs<
   ? readonly unknown[] | Record<string, unknown>
   : TArgs
 
-export type GetEventArgsFromTopics<
-  TAbi extends Abi | readonly unknown[],
-  TEventName extends string,
-  TTopics extends LogTopic[],
-  TData extends Hex | undefined,
-  TStrict extends boolean = true,
-  TAbiEvent extends AbiEvent & { type: 'event' } = TAbi extends Abi
-    ? ExtractAbiEvent<TAbi, TEventName>
-    : AbiEvent & { type: 'event' },
-  TArgs = AbiEventParametersToPrimitiveTypes<
-    TAbiEvent['inputs'],
-    { EnableUnion: false; IndexedOnly: false; Required: TStrict }
-  >,
-> = TTopics extends readonly []
-  ? TData extends undefined
-    ? { args?: never }
-    : { args?: TArgs }
-  : { args: TArgs }
-
 //////////////////////////////////////////////////////////////////////
 // ABI event types
 
@@ -416,55 +383,6 @@ type DefaultEventParameterOptions = {
   Required: false
 }
 
-type HashedEventTypes = 'bytes' | 'string' | 'tuple' | `${string}[${string}]`
-
-// TODO: Speed up by returning immediately as soon as named parameter is found.
-type _HasUnnamedAbiParameter<TAbiParameters extends readonly AbiParameter[]> =
-  TAbiParameters extends readonly [
-    infer Head extends AbiParameter,
-    ...infer Tail extends readonly AbiParameter[],
-  ]
-    ? Head extends { name: string }
-      ? Head['name'] extends ''
-        ? true
-        : _HasUnnamedAbiParameter<Tail>
-      : true
-    : false
-
-/**
- * @internal
- */
-export type LogTopicType<
-  TPrimitiveType = Hex,
-  TTopic extends LogTopic = LogTopic,
-> = TTopic extends Hex
-  ? TPrimitiveType
-  : TTopic extends Hex[]
-  ? TPrimitiveType[]
-  : TTopic extends null
-  ? null
-  : never
-
-/**
- * @internal
- */
-export type AbiEventParameterToPrimitiveType<
-  TAbiParameter extends AbiParameter,
-  Options extends EventParameterOptions = DefaultEventParameterOptions,
-  _Type = AbiParameterToPrimitiveType<TAbiParameter>,
-> = Options['EnableUnion'] extends true ? LogTopicType<_Type> : _Type
-
-/**
- * @internal
- */
-export type AbiEventTopicToPrimitiveType<
-  TAbiParameter extends AbiParameter,
-  TTopic extends LogTopic,
-  TPrimitiveType = TAbiParameter['type'] extends HashedEventTypes
-    ? TTopic
-    : AbiParameterToPrimitiveType<TAbiParameter>,
-> = LogTopicType<TPrimitiveType, TTopic>
-
 export type AbiEventParametersToPrimitiveTypes<
   TAbiParameters extends readonly AbiParameter[],
   Options extends EventParameterOptions = DefaultEventParameterOptions,
@@ -515,3 +433,52 @@ export type AbiEventParametersToPrimitiveTypes<
       >
     : never
   : never
+
+// TODO: Speed up by returning immediately as soon as named parameter is found.
+type _HasUnnamedAbiParameter<TAbiParameters extends readonly AbiParameter[]> =
+  TAbiParameters extends readonly [
+    infer Head extends AbiParameter,
+    ...infer Tail extends readonly AbiParameter[],
+  ]
+    ? Head extends { name: string }
+      ? Head['name'] extends ''
+        ? true
+        : _HasUnnamedAbiParameter<Tail>
+      : true
+    : false
+
+/**
+ * @internal
+ */
+export type LogTopicType<
+  TPrimitiveType = Hex,
+  TTopic extends LogTopic = LogTopic,
+> = TTopic extends Hex
+  ? TPrimitiveType
+  : TTopic extends Hex[]
+  ? TPrimitiveType[]
+  : TTopic extends null
+  ? null
+  : never
+
+/**
+ * @internal
+ */
+export type AbiEventParameterToPrimitiveType<
+  TAbiParameter extends AbiParameter,
+  Options extends EventParameterOptions = DefaultEventParameterOptions,
+  _Type = AbiParameterToPrimitiveType<TAbiParameter>,
+> = Options['EnableUnion'] extends true ? LogTopicType<_Type> : _Type
+
+type HashedEventTypes = 'bytes' | 'string' | 'tuple' | `${string}[${string}]`
+
+/**
+ * @internal
+ */
+export type AbiEventTopicToPrimitiveType<
+  TAbiParameter extends AbiParameter,
+  TTopic extends LogTopic,
+  TPrimitiveType = TAbiParameter['type'] extends HashedEventTypes
+    ? TTopic
+    : AbiParameterToPrimitiveType<TAbiParameter>,
+> = LogTopicType<TPrimitiveType, TTopic>

package/src/types/multicall.ts

@@ -6,7 +6,7 @@ import type {
   ContractFunctionParameters,
   ContractFunctionReturnType,
 } from './contract.js'
-import type { MaybePartial } from './utils.js'
+import type { MaybePartial, Prettify } from './utils.js'
 
 export type MulticallContracts<
   contracts extends readonly unknown[],
@@ -23,8 +23,10 @@ export type MulticallContracts<
   ? readonly [
       ...result,
       MaybePartial<
-        GetMulticallContractParameters<contract, options['mutability']> &
-          options['properties'],
+        Prettify<
+          GetMulticallContractParameters<contract, options['mutability']> &
+            options['properties']
+        >,
         options['optional']
       >,
     ]
@@ -35,8 +37,10 @@ export type MulticallContracts<
       [
         ...result,
         MaybePartial<
-          GetMulticallContractParameters<contract, options['mutability']> &
-            options['properties'],
+          Prettify<
+            GetMulticallContractParameters<contract, options['mutability']> &
+              options['properties']
+          >,
           options['optional']
         >,
       ]
@@ -52,18 +56,20 @@ export type MulticallContracts<
       infer args
     >[]
   ? readonly MaybePartial<
-      ContractFunctionParameters<
-        abi,
-        options['mutability'],
-        functionName,
-        args
-      > &
-        options['properties'],
+      Prettify<
+        ContractFunctionParameters<
+          abi,
+          options['mutability'],
+          functionName,
+          args
+        > &
+          options['properties']
+      >,
       options['optional']
     >[]
   : // Fallback
     readonly MaybePartial<
-      ContractFunctionParameters & options['properties'],
+      Prettify<ContractFunctionParameters & options['properties']>,
       options['optional']
     >[]
 

package/src/utils/abi/decodeDeployData.ts

@@ -4,7 +4,7 @@ import {
   AbiConstructorNotFoundError,
   AbiConstructorParamsNotFoundError,
 } from '../../errors/abi.js'
-import type { GetConstructorArgs } from '../../types/contract.js'
+import type { ContractConstructorArgs } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 
 import { decodeAbiParameters } from './decodeAbiParameters.js'
@@ -12,28 +12,29 @@ import { decodeAbiParameters } from './decodeAbiParameters.js'
 const docsPath = '/docs/contract/decodeDeployData'
 
 export type DecodeDeployDataParameters<
-  TAbi extends Abi | readonly unknown[] = Abi,
+  abi extends Abi | readonly unknown[] = Abi,
 > = {
-  abi: TAbi
+  abi: abi
   bytecode: Hex
   data: Hex
 }
+
 export type DecodeDeployDataReturnType<
-  TAbi extends Abi | readonly unknown[] = Abi,
+  abi extends Abi | readonly unknown[] = Abi,
+  ///
+  allArgs = ContractConstructorArgs<abi>,
 > = {
   bytecode: Hex
-} & GetConstructorArgs<TAbi>
+  args: allArgs
+}
 
-export function decodeDeployData<const TAbi extends Abi | readonly unknown[]>({
-  abi,
-  bytecode,
-  data,
-}: DecodeDeployDataParameters<TAbi>): DecodeDeployDataReturnType<TAbi> {
-  if (data === bytecode) return { bytecode } as DecodeDeployDataReturnType<TAbi>
+export function decodeDeployData<const abi extends Abi | readonly unknown[]>(
+  parameters: DecodeDeployDataParameters<abi>,
+): DecodeDeployDataReturnType<abi> {
+  const { abi, bytecode, data } = parameters as DecodeDeployDataParameters
+  if (data === bytecode) return { bytecode } as DecodeDeployDataReturnType<abi>
 
-  const description = (abi as Abi).find(
-    (x) => 'type' in x && x.type === 'constructor',
-  )
+  const description = abi.find((x) => 'type' in x && x.type === 'constructor')
   if (!description) throw new AbiConstructorNotFoundError({ docsPath })
   if (!('inputs' in description))
     throw new AbiConstructorParamsNotFoundError({ docsPath })
@@ -44,5 +45,5 @@ export function decodeDeployData<const TAbi extends Abi | readonly unknown[]>({
     description.inputs,
     `0x${data.replace(bytecode, '')}`,
   )
-  return { args, bytecode } as unknown as DecodeDeployDataReturnType<TAbi>
+  return { args, bytecode } as unknown as DecodeDeployDataReturnType<abi>
 }