viem 0.0.0-w-20230810183250 → 0.0.0-w-20230816150015

package/src/actions/public/readContract.ts

@@ -1,12 +1,12 @@
-import type { Abi } from 'abitype'
+import type { Abi, ExtractAbiFunctionNames } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { BaseError } from '../../errors/base.js'
 import type { Chain } from '../../types/chain.js'
 import type {
-  ContractFunctionConfig,
   ContractFunctionResult,
+  ContractParameters,
 } from '../../types/contract.js'
 import {
   type DecodeFunctionResultParameters,
@@ -21,10 +21,13 @@ import { getContractError } from '../../utils/errors/getContractError.js'
 import { type CallParameters, call } from './call.js'
 
 export type ReadContractParameters<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ExtractAbiFunctionNames<
+    abi extends Abi ? abi : Abi,
+    'view' | 'pure'
+  > = string,
 > = Pick<CallParameters, 'account' | 'blockNumber' | 'blockTag'> &
-  ContractFunctionConfig<TAbi, TFunctionName, 'view' | 'pure'>
+  ContractParameters<abi, 'view' | 'pure', functionName>
 
 export type ReadContractReturnType<
   TAbi extends Abi | readonly unknown[] = Abi,
@@ -63,24 +66,19 @@ export type ReadContractReturnType<
  * // 424122n
  */
 export async function readContract<
-  TChain extends Chain | undefined,
-  TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
+  chain extends Chain | undefined,
+  const abi extends Abi | readonly unknown[],
+  functionName extends string,
 >(
-  client: Client<Transport, TChain>,
-  {
-    abi,
-    address,
-    args,
-    functionName,
-    ...callRequest
-  }: ReadContractParameters<TAbi, TFunctionName>,
-): Promise<ReadContractReturnType<TAbi, TFunctionName>> {
+  client: Client<Transport, chain>,
+  parameters: ReadContractParameters<abi, functionName>,
+): Promise<ReadContractReturnType<abi, functionName>> {
+  const { abi, address, args, functionName, ...callRequest } = parameters
   const calldata = encodeFunctionData({
     abi,
     args,
     functionName,
-  } as unknown as EncodeFunctionDataParameters<TAbi, TFunctionName>)
+  } as unknown as EncodeFunctionDataParameters<abi, functionName>)
   try {
     const { data } = await call(client, {
       data: calldata,
@@ -93,9 +91,9 @@ export async function readContract<
       functionName,
       data: data || '0x',
     } as DecodeFunctionResultParameters<
-      TAbi,
-      TFunctionName
-    >) as ReadContractReturnType<TAbi, TFunctionName>
+      abi,
+      functionName
+    >) as ReadContractReturnType<abi, functionName>
   } catch (err) {
     throw getContractError(err as BaseError, {
       abi: abi as Abi,

package/src/actions/public/simulateContract.ts

@@ -102,7 +102,7 @@ export type SimulateContractReturnType<
  */
 export async function simulateContract<
   TChain extends Chain | undefined,
-  TAbi extends Abi | readonly unknown[],
+  const TAbi extends Abi | readonly unknown[],
   TFunctionName extends string,
   TChainOverride extends Chain | undefined,
 >(

package/src/actions/public/watchContractEvent.ts

@@ -1,4 +1,4 @@
-import type { Abi, AbiEvent, Address, ExtractAbiEvent, Narrow } from 'abitype'
+import type { Abi, AbiEvent, Address, ExtractAbiEvent } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -68,7 +68,7 @@ export type WatchContractEventParameters<
   /** The address of the contract. */
   address?: Address | Address[]
   /** Contract ABI. */
-  abi: Narrow<TAbi>
+  abi: TAbi
   args?: GetEventArgs<TAbi, TEventName>
   /** Contract event. */
   eventName?: InferEventName<TAbi, TEventName>
@@ -137,7 +137,7 @@ export type WatchContractEventReturnType = () => void
  */
 export function watchContractEvent<
   TChain extends Chain | undefined,
-  TAbi extends Abi | readonly unknown[],
+  const TAbi extends Abi | readonly unknown[],
   TEventName extends string,
   TStrict extends boolean | undefined = undefined,
 >(

package/src/actions/public/watchEvent.ts

@@ -1,4 +1,4 @@
-import type { Abi, AbiEvent, Address, Narrow } from 'abitype'
+import type { Abi, AbiEvent, Address } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
@@ -107,7 +107,7 @@ export type WatchEventParameters<
     }) &
   (
     | {
-        event: Narrow<TAbiEvent>
+        event: TAbiEvent
         events?: never
         args?: MaybeExtractEventArgsFromAbi<TAbiEvents, _EventName>
         /**
@@ -118,7 +118,7 @@ export type WatchEventParameters<
       }
     | {
         event?: never
-        events?: Narrow<TAbiEvents>
+        events?: TAbiEvents
         args?: never
         /**
          * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
@@ -170,8 +170,8 @@ export type WatchEventReturnType = () => void
  */
 export function watchEvent<
   TChain extends Chain | undefined,
-  TAbiEvent extends AbiEvent | undefined = undefined,
-  TAbiEvents extends
+  const TAbiEvent extends AbiEvent | undefined = undefined,
+  const TAbiEvents extends
     | readonly AbiEvent[]
     | readonly unknown[]
     | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,

package/src/actions/wallet/deployContract.ts

@@ -1,4 +1,4 @@
-import type { Abi, Narrow } from 'abitype'
+import type { Abi } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
 import type { Client } from '../../clients/createClient.js'
@@ -24,7 +24,7 @@ export type DeployContractParameters<
   SendTransactionParameters<TChain, TAccount, TChainOverride>,
   'accessList' | 'chain' | 'to' | 'data'
 > & {
-  abi: Narrow<TAbi>
+  abi: TAbi
   bytecode: Hex
 } & GetChain<TChain, TChainOverride> &
   GetConstructorArgs<TAbi>
@@ -59,7 +59,7 @@ export type DeployContractReturnType = SendTransactionReturnType
  * })
  */
 export function deployContract<
-  TAbi extends Abi | readonly unknown[],
+  const TAbi extends Abi | readonly unknown[],
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
   TChainOverride extends Chain | undefined,

package/src/actions/wallet/writeContract.ts

@@ -1,11 +1,11 @@
-import type { Abi } from 'abitype'
+import type { Abi, ExtractAbiFunctionNames } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { GetAccountParameter } from '../../types/account.js'
 import type { Chain, GetChain } from '../../types/chain.js'
-import type { ContractFunctionConfig, GetValue } from '../../types/contract.js'
+import type { ContractParameters, GetValue } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import type { UnionOmit } from '../../types/utils.js'
 import {
@@ -20,29 +20,32 @@ import {
 } from './sendTransaction.js'
 
 export type WriteContractParameters<
-  TAbi extends Abi | readonly unknown[] = Abi,
-  TFunctionName extends string = string,
-  TChain extends Chain | undefined = Chain,
-  TAccount extends Account | undefined = Account | undefined,
-  TChainOverride extends Chain | undefined = Chain | undefined,
-> = ContractFunctionConfig<TAbi, TFunctionName, 'payable' | 'nonpayable'> &
-  GetAccountParameter<TAccount> &
-  GetChain<TChain, TChainOverride> &
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ExtractAbiFunctionNames<
+    abi extends Abi ? abi : Abi,
+    'payable' | 'nonpayable'
+  > = string,
+  chain extends Chain | undefined = Chain,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+> = ContractParameters<abi, 'payable' | 'nonpayable', functionName> &
   UnionOmit<
     FormattedTransactionRequest<
-      TChainOverride extends Chain ? TChainOverride : TChain
+      chainOverride extends Chain ? chainOverride : chain
     >,
-    'from' | 'to' | 'data' | 'value'
+    'data' | 'from' | 'to' | 'value'
   > &
+  GetAccountParameter<account> &
+  GetChain<chain, chainOverride> &
   GetValue<
-    TAbi,
-    TFunctionName,
+    abi,
+    functionName,
     SendTransactionParameters<
-      TChain,
-      TAccount,
-      TChainOverride
+      chain,
+      account,
+      chainOverride
     > extends SendTransactionParameters
-      ? SendTransactionParameters<TChain, TAccount, TChainOverride>['value']
+      ? SendTransactionParameters<chain, account, chainOverride>['value']
       : SendTransactionParameters['value']
   > & {
     /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
@@ -102,37 +105,32 @@ export type WriteContractReturnType = SendTransactionReturnType
  * const hash = await writeContract(client, request)
  */
 export async function writeContract<
-  TChain extends Chain | undefined,
-  TAccount extends Account | undefined,
-  TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
-  TChainOverride extends Chain | undefined,
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  const abi extends Abi | readonly unknown[],
+  functionName extends string,
+  chainOverride extends Chain | undefined,
 >(
-  client: Client<Transport, TChain, TAccount>,
-  {
+  client: Client<Transport, chain, account>,
+  parameters: WriteContractParameters<
     abi,
-    address,
-    args,
-    dataSuffix,
     functionName,
-    ...request
-  }: WriteContractParameters<
-    TAbi,
-    TFunctionName,
-    TChain,
-    TAccount,
-    TChainOverride
+    chain,
+    account,
+    chainOverride
   >,
 ): Promise<WriteContractReturnType> {
+  const { abi, address, args, dataSuffix, functionName, ...request } =
+    parameters
   const data = encodeFunctionData({
     abi,
     args,
     functionName,
-  } as unknown as EncodeFunctionDataParameters<TAbi, TFunctionName>)
+  } as unknown as EncodeFunctionDataParameters<abi, functionName>)
   const hash = await sendTransaction(client, {
     data: `${data}${dataSuffix ? dataSuffix.replace('0x', '') : ''}`,
     to: address,
     ...request,
-  } as unknown as SendTransactionParameters<TChain, TAccount, TChainOverride>)
+  } as unknown as SendTransactionParameters<chain, account, chainOverride>)
   return hash
 }

package/src/chains/index.ts

@@ -94,6 +94,7 @@ export const polygonZkEvmTestnet = /*#__PURE__*/ defineChain(
 )
 export const pulsechain = /*#__PURE__*/ defineChain(chains.pulsechain)
 export const pulsechainV4 = /*#__PURE__*/ defineChain(chains.pulsechainV4)
+export const scrollSepolia = /*#__PURE__*/ defineChain(chains.scrollSepolia)
 export const scrollTestnet = /*#__PURE__*/ defineChain(chains.scrollTestnet)
 export const sepolia = /*#__PURE__*/ defineChain(chains.sepolia)
 export const skaleBlockBrawlers = /*#__PURE__*/ defineChain(

package/src/clients/decorators/public.ts

@@ -278,7 +278,7 @@ export type PublicActions<
    * })
    */
   createContractEventFilter: <
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TEventName extends string | undefined,
     TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
     TStrict extends boolean | undefined = undefined,
@@ -325,8 +325,8 @@ export type PublicActions<
    * })
    */
   createEventFilter: <
-    TAbiEvent extends AbiEvent | undefined = undefined,
-    TAbiEvents extends
+    const TAbiEvent extends AbiEvent | undefined = undefined,
+    const TAbiEvents extends
       | readonly AbiEvent[]
       | readonly unknown[]
       | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
@@ -406,7 +406,7 @@ export type PublicActions<
    */
   estimateContractGas: <
     TChain extends Chain | undefined,
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
   >(
     args: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>,
@@ -844,7 +844,7 @@ export type PublicActions<
    */
   getFilterChanges: <
     TFilterType extends FilterType,
-    TAbi extends Abi | readonly unknown[] | undefined,
+    const TAbi extends Abi | readonly unknown[] | undefined,
     TEventName extends string | undefined,
     TStrict extends boolean | undefined = undefined,
     TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
@@ -895,7 +895,7 @@ export type PublicActions<
    * const logs = await client.getFilterLogs({ filter })
    */
   getFilterLogs: <
-    TAbi extends Abi | readonly unknown[] | undefined,
+    const TAbi extends Abi | readonly unknown[] | undefined,
     TEventName extends string | undefined,
     TStrict extends boolean | undefined = undefined,
     TFromBlock extends BlockNumber | BlockTag | undefined = undefined,
@@ -951,8 +951,8 @@ export type PublicActions<
    * const logs = await client.getLogs()
    */
   getLogs: <
-    TAbiEvent extends AbiEvent | undefined = undefined,
-    TAbiEvents extends
+    const TAbiEvent extends AbiEvent | undefined = undefined,
+    const TAbiEvents extends
       | readonly AbiEvent[]
       | readonly unknown[]
       | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
@@ -1133,7 +1133,12 @@ export type PublicActions<
    * // [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }]
    */
   multicall: <
-    TContracts extends ContractFunctionConfig[],
+    const TAbi extends Abi | readonly unknown[],
+    TFunctionName extends string,
+    const TContracts extends readonly ContractFunctionConfig<
+      TAbi,
+      TFunctionName
+    >[],
     TAllowFailure extends boolean = true,
   >(
     args: MulticallParameters<TContracts, TAllowFailure>,
@@ -1170,7 +1175,7 @@ export type PublicActions<
    * // 424122n
    */
   readContract: <
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
   >(
     args: ReadContractParameters<TAbi, TFunctionName>,
@@ -1206,7 +1211,7 @@ export type PublicActions<
    * })
    */
   simulateContract: <
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
     TChainOverride extends Chain | undefined,
   >(
@@ -1383,7 +1388,7 @@ export type PublicActions<
    * })
    */
   watchContractEvent: <
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TEventName extends string,
     TStrict extends boolean | undefined = undefined,
   >(
@@ -1421,8 +1426,8 @@ export type PublicActions<
    * })
    */
   watchEvent: <
-    TAbiEvent extends AbiEvent | undefined = undefined,
-    TAbiEvents extends
+    const TAbiEvent extends AbiEvent | undefined = undefined,
+    const TAbiEvents extends
       | readonly AbiEvent[]
       | readonly unknown[]
       | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined,
@@ -1502,7 +1507,7 @@ export function publicActions<
       getTransactionConfirmations(client, args),
     getTransactionCount: (args) => getTransactionCount(client, args),
     getTransactionReceipt: (args) => getTransactionReceipt(client, args),
-    multicall: (args) => multicall(client, args),
+    multicall: (args) => multicall(client, args as any) as any,
     readContract: (args) => readContract(client, args),
     simulateContract: (args) => simulateContract(client, args),
     verifyMessage: (args) => verifyMessage(client, args),

package/src/clients/decorators/wallet.ts

@@ -112,7 +112,7 @@ export type WalletActions<
    * })
    */
   deployContract: <
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TChainOverride extends Chain | undefined,
   >(
     args: DeployContractParameters<TAbi, TChain, TAccount, TChainOverride>,
@@ -410,7 +410,7 @@ export type WalletActions<
    * })
    */
   signTypedData: <
-    TTypedData extends TypedData | { [key: string]: unknown },
+    const TTypedData extends TypedData | { [key: string]: unknown },
     TPrimaryType extends string,
   >(
     args: SignTypedDataParameters<TTypedData, TPrimaryType, TAccount>,
@@ -509,7 +509,7 @@ export type WalletActions<
    * const hash = await client.writeContract(request)
    */
   writeContract: <
-    TAbi extends Abi | readonly unknown[],
+    const TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
     TChainOverride extends Chain | undefined,
   >(

package/src/index.ts

@@ -514,6 +514,8 @@ export { SizeExceedsPaddingSizeError } from './errors/data.js'
 export { UrlRequiredError } from './errors/transport.js'
 export type {
   AbiItem,
+  ContractParameters,
+  ContractReturnType,
   ContractFunctionConfig,
   ContractFunctionResult,
   GetConstructorArgs,
@@ -633,6 +635,7 @@ export type { GetTransportConfig } from './types/transport.js'
 export type { HDKey } from '@scure/bip32'
 export type { Log } from './types/log.js'
 export type {
+  MulticallContract,
   MulticallContracts,
   MulticallResult,
   MulticallResults,

package/src/types/contract.ts

@@ -15,7 +15,6 @@ import type {
   ExtractAbiEventNames,
   ExtractAbiFunction,
   ExtractAbiFunctionNames,
-  Narrow,
 } from 'abitype'
 
 import type { Hex, LogTopic } from './misc.js'
@@ -32,13 +31,68 @@ export type AbiItem = Abi[number]
 
 export type EventDefinition = `${string}(${string})`
 
+export type ContractParameters<
+  abi extends Abi | readonly unknown[] = readonly unknown[],
+  stateMutability extends AbiStateMutability = AbiStateMutability,
+  functionName extends ExtractAbiFunctionNames<
+    abi extends Abi ? abi : Abi,
+    stateMutability
+  > = string,
+  ///
+  functionNames extends string = abi extends Abi
+    ? ExtractAbiFunctionNames<abi, stateMutability>
+    : string,
+  abiFunction extends AbiFunction = abi extends Abi
+    ? ExtractAbiFunction<abi, functionName, stateMutability>
+    : AbiFunction,
+  types = AbiParametersToPrimitiveTypes<abiFunction['inputs'], 'inputs'>,
+  args =
+    | types // show all values
+    | (Abi extends abi ? readonly unknown[] | undefined : never) // `abi` declared as `Abi`
+    | (readonly [] extends types ? undefined : never), // `abiFunction` has no inputs
+  isArgsOptional extends boolean = Abi extends abi
+    ? true
+    : readonly [] extends types
+    ? true
+    : false,
+> = {
+  abi: abi
+  address: Address
+  functionName:
+    | functionNames // show all values
+    | (functionName extends functionNames ? functionName : never) // validate `functionName`
+    | ([functionNames] extends [never] ? string : never) // `abi` declared as `Abi`
+} & (isArgsOptional extends true ? { args?: args | undefined } : { args: args })
+
+export type ContractReturnType<
+  abi extends Abi | readonly unknown[] = readonly unknown[],
+  stateMutability extends AbiStateMutability = AbiStateMutability,
+  functionName extends ExtractAbiFunctionNames<
+    abi extends Abi ? abi : Abi,
+    stateMutability
+  > = string,
+  ///
+  abiFunction extends AbiFunction = abi extends Abi
+    ? ExtractAbiFunction<abi, functionName, stateMutability>
+    : AbiFunction,
+  types = AbiParametersToPrimitiveTypes<abiFunction['outputs'], 'outputs'>,
+> = [abiFunction] extends [never]
+  ? unknown // `abiFunction` was not inferrable (e.g. `abi` declared as `Abi`)
+  : readonly unknown[] extends types
+  ? unknown // `abiFunction` was not inferrable (e.g. `abi` not const asserted)
+  : types extends readonly [] // unwrap `types`
+  ? void // no outputs
+  : types extends readonly [infer type]
+  ? type // single output
+  : types
+
 export type ContractFunctionConfig<
   TAbi extends Abi | readonly unknown[] = Abi,
   TFunctionName extends string = string,
   TAbiStateMutability extends AbiStateMutability = AbiStateMutability,
 > = {
   /** Contract ABI */
-  abi: Narrow<TAbi>
+  abi: TAbi
   /** Contract address */
   address: Address
   /** Function to invoke on the contract */