@wagmi/core 2.8.1 → 2.9.1

package/src/experimental/actions/writeContracts.ts

@@ -0,0 +1,77 @@
+import { type Account, type Chain, type ContractFunctionParameters } from 'viem'
+import {
+  type WriteContractsErrorType as viem_WriteContractsErrorType,
+  type WriteContractsParameters as viem_WriteContractsParameters,
+  type WriteContractsReturnType as viem_WriteContractsReturnType,
+  writeContracts as viem_writeContracts,
+} from 'viem/experimental'
+
+import {
+  type GetConnectorClientErrorType,
+  getConnectorClient,
+} from '../../actions/getConnectorClient.js'
+import { type Config } from '../../createConfig.js'
+import type { BaseErrorType, ErrorType } from '../../errors/base.js'
+import type { SelectChains } from '../../types/chain.js'
+import type {
+  ChainIdParameter,
+  ConnectorParameter,
+} from '../../types/properties.js'
+import { type Evaluate } from '../../types/utils.js'
+
+export type WriteContractsParameters<
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  ///
+  chains extends readonly Chain[] = SelectChains<config, chainId>,
+> = {
+  [key in keyof chains]: Evaluate<
+    Omit<
+      viem_WriteContractsParameters<
+        contracts,
+        chains[key],
+        Account,
+        chains[key]
+      >,
+      'chain'
+    > &
+      ChainIdParameter<config, chainId> &
+      ConnectorParameter
+  >
+}[number]
+
+export type WriteContractsReturnType = viem_WriteContractsReturnType
+
+export type WriteContractsErrorType =
+  // getConnectorClient()
+  | GetConnectorClientErrorType
+  // base
+  | BaseErrorType
+  | ErrorType
+  // viem
+  | viem_WriteContractsErrorType
+
+/** https://wagmi.sh/core/api/actions/writeContracts */
+export async function writeContracts<
+  const contracts extends readonly unknown[],
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(
+  config: config,
+  parameters: WriteContractsParameters<contracts, config, chainId>,
+): Promise<WriteContractsReturnType> {
+  const { account, chainId, connector, ...rest } = parameters
+
+  const client = await getConnectorClient(config, {
+    account,
+    chainId,
+    connector,
+  })
+
+  return viem_writeContracts(client, {
+    ...(rest as any),
+    ...(account ? { account } : {}),
+    chain: chainId ? { id: chainId } : undefined,
+  })
+}

package/src/experimental/query/getCallsStatus.ts

@@ -0,0 +1,50 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import { type Config } from '../../createConfig.js'
+import { ConnectorNotConnectedError } from '../../errors/config.js'
+import { filterQueryOptions } from '../../query/utils.js'
+import type { ScopeKeyParameter } from '../../types/properties.js'
+import type { Evaluate } from '../../types/utils.js'
+import {
+  type GetCallsStatusErrorType,
+  type GetCallsStatusParameters,
+  type GetCallsStatusReturnType,
+  getCallsStatus,
+} from '../actions/getCallsStatus.js'
+
+export type GetCallsStatusOptions = Evaluate<
+  GetCallsStatusParameters & ScopeKeyParameter
+>
+
+export function getCallsStatusQueryOptions<config extends Config,>(
+  config: config,
+  options: GetCallsStatusOptions,
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      const status = await getCallsStatus(config, parameters)
+      return status
+    },
+    queryKey: getCallsStatusQueryKey(options),
+    retry(failureCount, error) {
+      if (error instanceof ConnectorNotConnectedError) return false
+      return failureCount < 3
+    },
+  } as const satisfies QueryOptions<
+    GetCallsStatusQueryFnData,
+    GetCallsStatusErrorType,
+    GetCallsStatusData,
+    GetCallsStatusQueryKey
+  >
+}
+
+export type GetCallsStatusQueryFnData = GetCallsStatusReturnType
+
+export type GetCallsStatusData = GetCallsStatusQueryFnData
+
+export function getCallsStatusQueryKey(options: GetCallsStatusOptions) {
+  return ['callsStatus', filterQueryOptions(options)] as const
+}
+
+export type GetCallsStatusQueryKey = ReturnType<typeof getCallsStatusQueryKey>

package/src/experimental/query/getCapabilities.ts

@@ -0,0 +1,50 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import { type Config } from '../../createConfig.js'
+import { ConnectorNotConnectedError } from '../../errors/config.js'
+import { filterQueryOptions } from '../../query/utils.js'
+import type { ScopeKeyParameter } from '../../types/properties.js'
+import type { Evaluate, ExactPartial } from '../../types/utils.js'
+import {
+  type GetCapabilitiesErrorType,
+  type GetCapabilitiesParameters,
+  type GetCapabilitiesReturnType,
+  getCapabilities,
+} from '../actions/getCapabilities.js'
+
+export type GetCapabilitiesOptions = Evaluate<
+  ExactPartial<GetCapabilitiesParameters> & ScopeKeyParameter
+>
+
+export function getCapabilitiesQueryOptions<config extends Config,>(
+  config: config,
+  options: GetCapabilitiesOptions = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      const capabilities = await getCapabilities(config, parameters)
+      return capabilities
+    },
+    queryKey: getCapabilitiesQueryKey(options),
+    retry(failureCount, error) {
+      if (error instanceof ConnectorNotConnectedError) return false
+      return failureCount < 3
+    },
+  } as const satisfies QueryOptions<
+    GetCapabilitiesQueryFnData,
+    GetCapabilitiesErrorType,
+    GetCapabilitiesData,
+    GetCapabilitiesQueryKey
+  >
+}
+
+export type GetCapabilitiesQueryFnData = GetCapabilitiesReturnType
+
+export type GetCapabilitiesData = GetCapabilitiesQueryFnData
+
+export function getCapabilitiesQueryKey(options: GetCapabilitiesOptions = {}) {
+  return ['capabilities', filterQueryOptions(options)] as const
+}
+
+export type GetCapabilitiesQueryKey = ReturnType<typeof getCapabilitiesQueryKey>

package/src/experimental/query/sendCalls.ts

@@ -0,0 +1,64 @@
+import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
+
+import { type Config } from '../../createConfig.js'
+import { type Evaluate } from '../../types/utils.js'
+import {
+  type SendCallsErrorType,
+  type SendCallsParameters,
+  type SendCallsReturnType,
+  sendCalls,
+} from '../actions/sendCalls.js'
+
+export function sendCallsMutationOptions<config extends Config>(
+  config: config,
+) {
+  return {
+    mutationFn(variables) {
+      return sendCalls(config, variables)
+    },
+    mutationKey: ['sendCalls'],
+  } as const satisfies MutationOptions<
+    SendCallsData,
+    SendCallsErrorType,
+    SendCallsVariables<config, config['chains'][number]['id']>
+  >
+}
+
+export type SendCallsData = Evaluate<SendCallsReturnType>
+
+export type SendCallsVariables<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = SendCallsParameters<config, chainId>
+
+export type SendCallsMutate<config extends Config, context = unknown> = <
+  chainId extends config['chains'][number]['id'],
+>(
+  variables: SendCallsVariables<config, chainId>,
+  options?:
+    | Evaluate<
+        MutateOptions<
+          SendCallsData,
+          SendCallsErrorType,
+          Evaluate<SendCallsVariables<config, chainId>>,
+          context
+        >
+      >
+    | undefined,
+) => void
+
+export type SendCallsMutateAsync<config extends Config, context = unknown> = <
+  chainId extends config['chains'][number]['id'],
+>(
+  variables: SendCallsVariables<config, chainId>,
+  options?:
+    | Evaluate<
+        MutateOptions<
+          SendCallsData,
+          SendCallsErrorType,
+          Evaluate<SendCallsVariables<config, chainId>>,
+          context
+        >
+      >
+    | undefined,
+) => Promise<SendCallsData>

package/src/experimental/query/showCallsStatus.ts

@@ -0,0 +1,57 @@
+import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
+
+import { type Config } from '../../createConfig.js'
+import { type Evaluate } from '../../types/utils.js'
+import {
+  type ShowCallsStatusErrorType,
+  type ShowCallsStatusParameters,
+  type ShowCallsStatusReturnType,
+  showCallsStatus,
+} from '../actions/showCallsStatus.js'
+
+export function showCallsStatusMutationOptions<config extends Config>(
+  config: config,
+) {
+  return {
+    mutationFn(variables) {
+      return showCallsStatus(config, variables)
+    },
+    mutationKey: ['showCallsStatus'],
+  } as const satisfies MutationOptions<
+    ShowCallsStatusData,
+    ShowCallsStatusErrorType,
+    ShowCallsStatusVariables
+  >
+}
+
+export type ShowCallsStatusData = Evaluate<ShowCallsStatusReturnType>
+
+export type ShowCallsStatusVariables = ShowCallsStatusParameters
+
+export type ShowCallsStatusMutate<context = unknown> = (
+  variables: ShowCallsStatusVariables,
+  options?:
+    | Evaluate<
+        MutateOptions<
+          ShowCallsStatusData,
+          ShowCallsStatusErrorType,
+          Evaluate<ShowCallsStatusVariables>,
+          context
+        >
+      >
+    | undefined,
+) => void
+
+export type ShowCallsStatusMutateAsync<context = unknown,> = (
+  variables: ShowCallsStatusVariables,
+  options?:
+    | Evaluate<
+        MutateOptions<
+          ShowCallsStatusData,
+          ShowCallsStatusErrorType,
+          Evaluate<ShowCallsStatusVariables>,
+          context
+        >
+      >
+    | undefined,
+) => Promise<ShowCallsStatusData>

package/src/experimental/query/writeContracts.ts

@@ -0,0 +1,70 @@
+import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
+
+import { type Config } from '../../createConfig.js'
+import { type Evaluate } from '../../types/utils.js'
+import {
+  type WriteContractsErrorType,
+  type WriteContractsParameters,
+  type WriteContractsReturnType,
+  writeContracts,
+} from '../actions/writeContracts.js'
+
+export function writeContractsMutationOptions<
+  const contracts extends readonly unknown[],
+  config extends Config,
+>(config: config) {
+  return {
+    mutationFn(variables) {
+      return writeContracts(config, variables as any) as any
+    },
+    mutationKey: ['writeContracts'],
+  } as const satisfies MutationOptions<
+    WriteContractsData,
+    WriteContractsErrorType,
+    WriteContractsVariables<contracts, config, config['chains'][number]['id']>
+  >
+}
+
+export type WriteContractsData = Evaluate<WriteContractsReturnType>
+
+export type WriteContractsVariables<
+  contracts extends readonly unknown[],
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = WriteContractsParameters<contracts, config, chainId>
+
+export type WriteContractsMutate<
+  contracts extends readonly unknown[],
+  config extends Config,
+  context = unknown,
+> = <chainId extends config['chains'][number]['id'],>(
+  variables: WriteContractsVariables<contracts, config, chainId>,
+  options?:
+    | Evaluate<
+        MutateOptions<
+          WriteContractsData,
+          WriteContractsErrorType,
+          Evaluate<WriteContractsVariables<contracts, config, chainId>>,
+          context
+        >
+      >
+    | undefined,
+) => void
+
+export type WriteContractsMutateAsync<
+  contracts extends readonly unknown[],
+  config extends Config,
+  context = unknown,
+> = <chainId extends config['chains'][number]['id'],>(
+  variables: WriteContractsVariables<contracts, config, chainId>,
+  options?:
+    | Evaluate<
+        MutateOptions<
+          WriteContractsData,
+          WriteContractsErrorType,
+          Evaluate<WriteContractsVariables<contracts, config, chainId>>,
+          context
+        >
+      >
+    | undefined,
+) => Promise<WriteContractsData>

package/src/exports/experimental.ts

@@ -0,0 +1,84 @@
+////////////////////////////////////////////////////////////////////////////////
+// Actions
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  type GetCallsStatusErrorType,
+  type GetCallsStatusParameters,
+  type GetCallsStatusReturnType,
+  getCallsStatus,
+} from '../experimental/actions/getCallsStatus.js'
+
+export {
+  type GetCapabilitiesErrorType,
+  type GetCapabilitiesParameters,
+  type GetCapabilitiesReturnType,
+  getCapabilities,
+} from '../experimental/actions/getCapabilities.js'
+
+export {
+  type SendCallsErrorType,
+  type SendCallsParameters,
+  type SendCallsReturnType,
+  sendCalls,
+} from '../experimental/actions/sendCalls.js'
+
+export {
+  type ShowCallsStatusErrorType,
+  type ShowCallsStatusParameters,
+  type ShowCallsStatusReturnType,
+  showCallsStatus,
+} from '../experimental/actions/showCallsStatus.js'
+
+export {
+  type WriteContractsErrorType,
+  type WriteContractsParameters,
+  type WriteContractsReturnType,
+  writeContracts,
+} from '../experimental/actions/writeContracts.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Tanstack Query
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  type GetCallsStatusData,
+  type GetCallsStatusOptions,
+  type GetCallsStatusQueryFnData,
+  type GetCallsStatusQueryKey,
+  getCallsStatusQueryOptions,
+  getCallsStatusQueryKey,
+} from '../experimental/query/getCallsStatus.js'
+
+export {
+  type GetCapabilitiesData,
+  type GetCapabilitiesOptions,
+  type GetCapabilitiesQueryFnData,
+  type GetCapabilitiesQueryKey,
+  getCapabilitiesQueryOptions,
+  getCapabilitiesQueryKey,
+} from '../experimental/query/getCapabilities.js'
+
+export {
+  type SendCallsData,
+  type SendCallsMutate,
+  type SendCallsMutateAsync,
+  type SendCallsVariables,
+  sendCallsMutationOptions,
+} from '../experimental/query/sendCalls.js'
+
+export {
+  type ShowCallsStatusData,
+  type ShowCallsStatusMutate,
+  type ShowCallsStatusMutateAsync,
+  type ShowCallsStatusVariables,
+  showCallsStatusMutationOptions,
+} from '../experimental/query/showCallsStatus.js'
+
+export {
+  type WriteContractsData,
+  type WriteContractsMutate,
+  type WriteContractsMutateAsync,
+  type WriteContractsVariables,
+  writeContractsMutationOptions,
+} from '../experimental/query/writeContracts.js'

package/src/version.ts

@@ -1 +1 @@
-export const version = '2.8.1'
+export const version = '2.9.1'