import type { Abi, AbiEvent, AbiFunction, AbiParameter, AbiParameterToPrimitiveType, AbiParametersToPrimitiveTypes, AbiStateMutability, Address, ExtractAbiError, ExtractAbiErrorNames, ExtractAbiEvent, ExtractAbiEventNames, ExtractAbiFunction, ExtractAbiFunctionNames, ResolvedRegister, } from 'abitype' import type { Hex, LogTopic } from './misc.js' import type { TransactionRequest } from './transaction.js' import type { Filter, IsNarrowable, IsUnion, MaybeRequired, NoInfer, Prettify, UnionToTuple, } from './utils.js' export type ContractFunctionName< abi extends Abi | readonly unknown[] = Abi, mutability extends AbiStateMutability = AbiStateMutability, > = ExtractAbiFunctionNames< abi extends Abi ? abi : Abi, mutability > extends infer functionName extends string ? [functionName] extends [never] ? string : functionName : string export type ContractErrorName = ExtractAbiErrorNames< abi extends Abi ? abi : Abi > extends infer errorName extends string ? [errorName] extends [never] ? string : errorName : string export type ContractEventName = 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, functionName extends ContractFunctionName< abi, mutability > = ContractFunctionName, > = AbiParametersToPrimitiveTypes< ExtractAbiFunction< abi extends Abi ? abi : Abi, functionName, mutability >['inputs'], 'inputs' > extends infer args ? [args] extends [never] ? readonly unknown[] : 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 = ContractErrorName, > = AbiParametersToPrimitiveTypes< ExtractAbiError['inputs'], 'inputs' > extends infer args ? [args] extends [never] ? readonly unknown[] : args : readonly unknown[] export type ContractEventArgs< abi extends Abi | readonly unknown[] = Abi, eventName extends ContractEventName = ContractEventName, > = AbiEventParametersToPrimitiveTypes< ExtractAbiEvent['inputs'] > extends infer args ? [args] extends [never] ? readonly unknown[] | Record : args : readonly unknown[] | Record export type ContractEventArgsFromTopics< abi extends Abi | readonly unknown[] = Abi, eventName extends ContractEventName = ContractEventName, strict extends boolean = true, > = AbiEventParametersToPrimitiveTypes< ExtractAbiEvent['inputs'], { EnableUnion: false; IndexedOnly: false; Required: strict } > extends infer args ? [args] extends [never] ? readonly unknown[] | Record : args : readonly unknown[] | Record export type Widen = | ([unknown] extends [type] ? unknown : never) | (type extends Function ? type : never) | (type extends ResolvedRegister['BigIntType'] ? bigint : never) | (type extends boolean ? boolean : never) | (type extends ResolvedRegister['IntType'] ? number : never) | (type extends string ? type extends ResolvedRegister['AddressType'] ? ResolvedRegister['AddressType'] : type extends ResolvedRegister['BytesType']['inputs'] ? ResolvedRegister['BytesType'] : string : never) | (type extends readonly [] ? readonly [] : never) | (type extends Record ? { [K in keyof type]: Widen } : never) | (type extends { length: number } ? { [K in keyof type]: Widen } extends infer Val extends readonly unknown[] ? readonly [...Val] : never : never) export type UnionWiden = type extends any ? Widen : never export type ExtractAbiFunctionForArgs< abi extends Abi, mutability extends AbiStateMutability, functionName extends ContractFunctionName, args extends ContractFunctionArgs, > = ExtractAbiFunction< abi, functionName, mutability > extends infer abiFunction extends AbiFunction ? IsUnion extends true // narrow overloads using `args` by converting to tuple and filtering out overloads that don't match ? UnionToTuple extends infer abiFunctions extends readonly AbiFunction[] ? // convert back to union (removes `never` tuple entries) { [k in keyof abiFunctions]: CheckArgs }[number] : never : abiFunction : never type CheckArgs< abiFunction extends AbiFunction, args, /// targetArgs extends AbiParametersToPrimitiveTypes< abiFunction['inputs'], 'inputs' > = AbiParametersToPrimitiveTypes, > = (readonly [] extends args ? readonly [] : args) extends targetArgs // fallback to `readonly []` if `args` has no value (e.g. `args` property not provided) ? abiFunction : never export type ContractFunctionParameters< abi extends Abi | readonly unknown[] = Abi, mutability extends AbiStateMutability = AbiStateMutability, functionName extends ContractFunctionName< abi, mutability > = ContractFunctionName, args extends ContractFunctionArgs< abi, mutability, functionName > = ContractFunctionArgs, deployless extends boolean = false, /// allFunctionNames = ContractFunctionName, allArgs = ContractFunctionArgs, // when `args` is inferred to `readonly []` ("inputs": []) or `never` (`abi` declared as `Abi` or not inferrable), allow `args` to be optional. // important that both branches return same structural type > = { abi: abi functionName: | allFunctionNames // show all options | (functionName extends allFunctionNames ? functionName : never) // infer value args?: (abi extends Abi ? UnionWiden : never) | allArgs | undefined } & (readonly [] extends allArgs ? {} : { args: Widen }) & (deployless extends true ? { address?: undefined; code: Hex } : { address: Address }) export type ContractFunctionReturnType< abi extends Abi | readonly unknown[] = Abi, mutability extends AbiStateMutability = AbiStateMutability, functionName extends ContractFunctionName< abi, mutability > = ContractFunctionName, args extends ContractFunctionArgs< abi, mutability, functionName > = ContractFunctionArgs, > = abi extends Abi ? 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 : unknown export type AbiItem = Abi[number] export type ExtractAbiItemNames = Extract< abi[number], { name: string } >['name'] export type ExtractAbiItem< abi extends Abi, name extends ExtractAbiItemNames, > = Extract export type AbiItemName = abi extends Abi ? ExtractAbiItemNames : string export type AbiItemArgs< abi extends Abi | readonly unknown[] = Abi, name extends AbiItemName = AbiItemName, > = AbiParametersToPrimitiveTypes< ExtractAbiItem['inputs'], 'inputs' > extends infer args ? [args] extends [never] ? readonly unknown[] : args : readonly unknown[] export type ExtractAbiItemForArgs< abi extends Abi, name extends AbiItemName, args extends AbiItemArgs, > = ExtractAbiItem extends infer abiItem extends AbiItem & { inputs: readonly AbiParameter[] } ? IsUnion extends true // narrow overloads using `args` by converting to tuple and filtering out overloads that don't match ? UnionToTuple 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< abi extends Abi | readonly unknown[], functionName extends string, valueType = TransactionRequest['value'], abiFunction extends AbiFunction = abi extends Abi ? ExtractAbiFunction : AbiFunction, _Narrowable extends boolean = IsNarrowable, > = _Narrowable extends true ? abiFunction['stateMutability'] extends 'payable' ? { value?: NoInfer | undefined } : abiFunction['payable'] extends true ? { value?: NoInfer | undefined } : { value?: undefined } : { value?: NoInfer | undefined } ////////////////////////////////////////////////////////////////////////////////////////////////// export type MaybeAbiEventName = abiEvent extends AbiEvent ? abiEvent['name'] : undefined export type MaybeExtractEventArgsFromAbi< abi extends Abi | readonly unknown[] | undefined, eventName extends string | undefined, > = abi extends Abi | readonly unknown[] ? eventName extends string ? GetEventArgs : undefined : undefined ////////////////////////////////////////////////////////////////////// // ABI item args export type GetEventArgs< abi extends Abi | readonly unknown[], eventName extends string, config extends EventParameterOptions = DefaultEventParameterOptions, abiEvent extends AbiEvent & { type: 'event' } = abi extends Abi ? ExtractAbiEvent : AbiEvent & { type: 'event' }, args = AbiEventParametersToPrimitiveTypes, FailedToParseArgs = | ([args] extends [never] ? true : false) | (readonly unknown[] extends args ? true : false), > = true extends FailedToParseArgs ? readonly unknown[] | Record : args ////////////////////////////////////////////////////////////////////// // ABI event types type EventParameterOptions = { EnableUnion?: boolean IndexedOnly?: boolean Required?: boolean } type DefaultEventParameterOptions = { EnableUnion: true IndexedOnly: true Required: false } export type AbiEventParametersToPrimitiveTypes< abiParameters extends readonly AbiParameter[], // _options extends EventParameterOptions = DefaultEventParameterOptions, // Remove non-indexed parameters based on `Options['IndexedOnly']` > = abiParameters extends readonly [] ? readonly [] : Filter< abiParameters, _options['IndexedOnly'] extends true ? { indexed: true } : object > extends infer Filtered extends readonly AbiParameter[] ? _HasUnnamedAbiParameter 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 }], _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 | undefined } extends infer Mapped ? Prettify< MaybeRequired< Mapped, _options['Required'] extends boolean ? _options['Required'] : false > > : never : never // TODO: Speed up by returning immediately as soon as named parameter is found. type _HasUnnamedAbiParameter = abiParameters extends readonly [ infer Head extends AbiParameter, ...infer Tail extends readonly AbiParameter[], ] ? Head extends { name: string } ? Head['name'] extends '' ? true : _HasUnnamedAbiParameter : true : false /** * @internal */ export type LogTopicType< primitiveType = Hex, topic extends LogTopic = LogTopic, > = topic extends Hex ? primitiveType : topic extends Hex[] ? primitiveType[] : topic extends null ? null : never /** * @internal */ export type AbiEventParameterToPrimitiveType< abiParameter extends AbiParameter, // _options extends EventParameterOptions = DefaultEventParameterOptions, _type = AbiParameterToPrimitiveType, > = _options['EnableUnion'] extends true ? LogTopicType<_type> : _type type HashedEventTypes = 'bytes' | 'string' | 'tuple' | `${string}[${string}]` /** * @internal */ export type AbiEventTopicToPrimitiveType< abiParameter extends AbiParameter, topic extends LogTopic, primitiveType = abiParameter['type'] extends HashedEventTypes ? topic : AbiParameterToPrimitiveType, > = LogTopicType