@wagmi/vue 0.0.0-canary-20240515232917

package/src/composables/useWaitForTransactionReceipt.ts

@@ -0,0 +1,81 @@
+import type {
+  Config,
+  ResolvedRegister,
+  WaitForTransactionReceiptErrorType,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type WaitForTransactionReceiptData,
+  type WaitForTransactionReceiptOptions,
+  type WaitForTransactionReceiptQueryFnData,
+  type WaitForTransactionReceiptQueryKey,
+  waitForTransactionReceiptQueryOptions,
+} from '@wagmi/core/query'
+import { computed } from 'vue'
+
+import type { ConfigParameter, QueryParameter } from '../types/properties.js'
+import type { DeepMaybeRef } from '../types/ref.js'
+import { deepUnref } from '../utils/cloneDeep.js'
+import { type UseQueryReturnType, useQuery } from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWaitForTransactionReceiptParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = WaitForTransactionReceiptData<config, chainId>,
+> = Evaluate<
+  DeepMaybeRef<
+    WaitForTransactionReceiptOptions<config, chainId> &
+      ConfigParameter<config> &
+      QueryParameter<
+        WaitForTransactionReceiptQueryFnData<config, chainId>,
+        WaitForTransactionReceiptErrorType,
+        selectData,
+        WaitForTransactionReceiptQueryKey<config, chainId>
+      >
+  >
+>
+
+export type UseWaitForTransactionReceiptReturnType<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = WaitForTransactionReceiptData<config, chainId>,
+> = UseQueryReturnType<selectData, WaitForTransactionReceiptErrorType>
+
+/** https://wagmi.sh/vue/api/composables/useWaitForTransactionReceipt */
+export function useWaitForTransactionReceipt<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = WaitForTransactionReceiptData<config, chainId>,
+>(
+  parameters_: UseWaitForTransactionReceiptParameters<
+    config,
+    chainId,
+    selectData
+  > = {},
+): UseWaitForTransactionReceiptReturnType<config, chainId, selectData> {
+  const parameters = computed(() => deepUnref(parameters_))
+  const config = useConfig(parameters_)
+  const configChainId = useChainId()
+
+  const queryOptions = computed(() => {
+    const { chainId = configChainId.value, hash, query = {} } = parameters.value
+
+    const options = waitForTransactionReceiptQueryOptions(config, {
+      ...parameters.value,
+      chainId,
+    })
+    const enabled = Boolean(hash && (query.enabled ?? true))
+
+    return {
+      ...query,
+      ...options,
+      enabled,
+    }
+  })
+
+  return useQuery(
+    queryOptions as any,
+  ) as UseWaitForTransactionReceiptReturnType<config, chainId, selectData>
+}

package/src/composables/useWatchBlockNumber.ts

@@ -0,0 +1,61 @@
+import {
+  type Config,
+  type ResolvedRegister,
+  type WatchBlockNumberParameters,
+  watchBlockNumber,
+} from '@wagmi/core'
+import { type UnionEvaluate, type UnionPartial } from '@wagmi/core/internal'
+import { computed, watchEffect } from 'vue'
+
+import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
+import type { DeepMaybeRef } from '../types/ref.js'
+import { deepUnref } from '../utils/cloneDeep.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWatchBlockNumberParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = DeepMaybeRef<
+  UnionEvaluate<
+    UnionPartial<WatchBlockNumberParameters<config, chainId>> &
+      ConfigParameter<config> &
+      EnabledParameter
+  >
+>
+
+export type UseWatchBlockNumberReturnType = void
+
+/** https://wagmi.sh/vue/api/composables/useWatchBlockNumber */
+export function useWatchBlockNumber<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+>(
+  parameters_: UseWatchBlockNumberParameters<config, chainId> = {} as any,
+): UseWatchBlockNumberReturnType {
+  const parameters = computed(() => deepUnref(parameters_))
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId({ config })
+
+  watchEffect((onCleanup) => {
+    const {
+      chainId = configChainId.value,
+      enabled = true,
+      onBlockNumber,
+      config: _,
+      ...rest
+    } = parameters.value
+
+    if (!enabled) return
+    if (!onBlockNumber) return
+
+    const unwatch = watchBlockNumber(config, {
+      ...(rest as any),
+      chainId,
+      onBlockNumber,
+      emitOnBegin: true,
+    })
+    onCleanup(unwatch)
+  })
+}

package/src/composables/useWriteContract.ts

@@ -0,0 +1,85 @@
+import { useMutation } from '@tanstack/vue-query'
+import type {
+  Config,
+  ResolvedRegister,
+  WriteContractErrorType,
+} from '@wagmi/core'
+import {
+  type WriteContractData,
+  type WriteContractMutate,
+  type WriteContractMutateAsync,
+  type WriteContractVariables,
+  writeContractMutationOptions,
+} from '@wagmi/core/query'
+import type { Abi } from 'viem'
+
+import type { ConfigParameter } from '../types/properties.js'
+import type {
+  UseMutationParameters,
+  UseMutationReturnType,
+} from '../utils/query.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWriteContractParameters<
+  config extends Config = Config,
+  context = unknown,
+> = ConfigParameter<config> & {
+  mutation?:
+    | UseMutationParameters<
+        WriteContractData,
+        WriteContractErrorType,
+        WriteContractVariables<
+          Abi,
+          string,
+          readonly unknown[],
+          config,
+          config['chains'][number]['id']
+        >,
+        context
+      >
+    | undefined
+}
+
+export type UseWriteContractReturnType<
+  config extends Config = Config,
+  context = unknown,
+> = UseMutationReturnType<
+  WriteContractData,
+  WriteContractErrorType,
+  WriteContractVariables<
+    Abi,
+    string,
+    readonly unknown[],
+    config,
+    config['chains'][number]['id']
+  >,
+  context
+> & {
+  writeContract: WriteContractMutate<config, context>
+  writeContractAsync: WriteContractMutateAsync<config, context>
+}
+
+/** https://wagmi.sh/vue/api/composables/useWriteContract */
+export function useWriteContract<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: UseWriteContractParameters<config, context> = {},
+): UseWriteContractReturnType<config, context> {
+  const { mutation } = parameters
+
+  const config = useConfig(parameters)
+
+  const mutationOptions = writeContractMutationOptions(config)
+  const { mutate, mutateAsync, ...result } = useMutation({
+    ...mutation,
+    ...mutationOptions,
+  })
+
+  type Return = UseWriteContractReturnType<config, context>
+  return {
+    ...result,
+    writeContract: mutate as Return['writeContract'],
+    writeContractAsync: mutateAsync as Return['writeContractAsync'],
+  }
+}

package/src/errors/base.ts

@@ -0,0 +1,14 @@
+import { BaseError as CoreError } from '@wagmi/core'
+
+import { getVersion } from '../utils/getVersion.js'
+
+export type BaseErrorType = BaseError & { name: 'WagmiError' }
+export class BaseError extends CoreError {
+  override name = 'WagmiError'
+  override get docsBaseUrl() {
+    return 'https://wagmi.sh/vue'
+  }
+  override get version() {
+    return getVersion()
+  }
+}

package/src/errors/plugin.ts

@@ -0,0 +1,31 @@
+import { BaseError } from './base.js'
+
+export type WagmiPluginNotFoundErrorType = WagmiPluginNotFoundError & {
+  name: 'WagmiPluginNotFoundError'
+}
+export class WagmiPluginNotFoundError extends BaseError {
+  override name = 'WagmiPluginNotFoundError'
+  constructor() {
+    super(
+      'No `config` found in Vue context, use `WagmiPlugin` to properly initialize the library.',
+      {
+        docsPath: '/api/TODO',
+      },
+    )
+  }
+}
+
+export type WagmiInjectionContextErrorType = WagmiInjectionContextError & {
+  name: 'WagmiInjectionContextError'
+}
+export class WagmiInjectionContextError extends BaseError {
+  override name = 'WagmiInjectionContextError'
+  constructor() {
+    super(
+      'Wagmi composables can only be used inside `setup()` function or functions that support injection context.',
+      {
+        docsPath: '/api/TODO',
+      },
+    )
+  }
+}

package/src/exports/actions.ts

@@ -0,0 +1,5 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/actions
+////////////////////////////////////////////////////////////////////////////////
+
+export * from '@wagmi/core/actions'

package/src/exports/chains.ts

@@ -0,0 +1,5 @@
+////////////////////////////////////////////////////////////////////////////////
+// viem/chains
+////////////////////////////////////////////////////////////////////////////////
+
+export * from 'viem/chains'

package/src/exports/connectors.ts

@@ -0,0 +1,5 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/connectors
+////////////////////////////////////////////////////////////////////////////////
+
+export * from '@wagmi/connectors'

package/src/exports/index.ts

@@ -0,0 +1,260 @@
+////////////////////////////////////////////////////////////////////////////////
+// Plugin
+////////////////////////////////////////////////////////////////////////////////
+
+export { configKey, type WagmiPluginOptions, WagmiPlugin } from '../plugin.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Errors
+////////////////////////////////////////////////////////////////////////////////
+
+export { type BaseErrorType, BaseError } from '../errors/base.js'
+
+export {
+  type WagmiPluginNotFoundErrorType,
+  WagmiPluginNotFoundError,
+  type WagmiInjectionContextErrorType,
+  WagmiInjectionContextError,
+} from '../errors/plugin.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Composables
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  type UseAccountParameters,
+  type UseAccountReturnType,
+  useAccount,
+} from '../composables/useAccount.js'
+
+export {
+  type UseAccountEffectParameters,
+  useAccountEffect,
+} from '../composables/useAccountEffect.js'
+
+export {
+  type UseBalanceParameters,
+  type UseBalanceReturnType,
+  useBalance,
+} from '../composables/useBalance.js'
+
+export {
+  type UseBlockNumberParameters,
+  type UseBlockNumberReturnType,
+  useBlockNumber,
+} from '../composables/useBlockNumber.js'
+
+export {
+  type UseChainIdParameters,
+  type UseChainIdReturnType,
+  useChainId,
+} from '../composables/useChainId.js'
+
+export {
+  type UseClientParameters,
+  type UseClientReturnType,
+  useClient,
+} from '../composables/useClient.js'
+
+export {
+  type UseConnectorClientParameters,
+  type UseConnectorClientReturnType,
+  useConnectorClient,
+} from '../composables/useConnectorClient.js'
+
+export {
+  type UseChainsParameters,
+  type UseChainsReturnType,
+  useChains,
+} from '../composables/useChains.js'
+
+export {
+  type UseConfigParameters,
+  type UseConfigReturnType,
+  useConfig,
+} from '../composables/useConfig.js'
+
+export {
+  type UseConnectParameters,
+  type UseConnectReturnType,
+  useConnect,
+} from '../composables/useConnect.js'
+
+export {
+  type UseConnectionsParameters,
+  type UseConnectionsReturnType,
+  useConnections,
+} from '../composables/useConnections.js'
+
+export {
+  type UseConnectorsParameters,
+  type UseConnectorsReturnType,
+  useConnectors,
+} from '../composables/useConnectors.js'
+
+export {
+  type UseDisconnectParameters,
+  type UseDisconnectReturnType,
+  useDisconnect,
+} from '../composables/useDisconnect.js'
+
+export {
+  type UseEnsAddressParameters,
+  type UseEnsAddressReturnType,
+  useEnsAddress,
+} from '../composables/useEnsAddress.js'
+
+export {
+  type UseEnsAvatarParameters,
+  type UseEnsAvatarReturnType,
+  useEnsAvatar,
+} from '../composables/useEnsAvatar.js'
+
+export {
+  type UseEnsNameParameters,
+  type UseEnsNameReturnType,
+  useEnsName,
+} from '../composables/useEnsName.js'
+
+export {
+  type UseEstimateGasParameters,
+  type UseEstimateGasReturnType,
+  useEstimateGas,
+} from '../composables/useEstimateGas.js'
+
+export {
+  type UseReadContractParameters,
+  type UseReadContractReturnType,
+  useReadContract,
+} from '../composables/useReadContract.js'
+
+export {
+  type UseReconnectParameters,
+  type UseReconnectReturnType,
+  useReconnect,
+} from '../composables/useReconnect.js'
+
+export {
+  type UseSendTransactionParameters,
+  type UseSendTransactionReturnType,
+  useSendTransaction,
+} from '../composables/useSendTransaction.js'
+
+export {
+  type UseSignMessageParameters,
+  type UseSignMessageReturnType,
+  useSignMessage,
+} from '../composables/useSignMessage.js'
+
+export {
+  type UseSignTypedDataParameters,
+  type UseSignTypedDataReturnType,
+  useSignTypedData,
+} from '../composables/useSignTypedData.js'
+
+export {
+  type UseSimulateContractParameters,
+  type UseSimulateContractReturnType,
+  useSimulateContract,
+} from '../composables/useSimulateContract.js'
+
+export {
+  type UseSwitchAccountParameters,
+  type UseSwitchAccountReturnType,
+  useSwitchAccount,
+} from '../composables/useSwitchAccount.js'
+
+export {
+  type UseSwitchChainParameters,
+  type UseSwitchChainReturnType,
+  useSwitchChain,
+} from '../composables/useSwitchChain.js'
+
+export {
+  type UseTransactionParameters,
+  type UseTransactionReturnType,
+  useTransaction,
+} from '../composables/useTransaction.js'
+
+export {
+  type UseTransactionReceiptParameters,
+  type UseTransactionReceiptReturnType,
+  useTransactionReceipt,
+} from '../composables/useTransactionReceipt.js'
+
+export {
+  type UseWatchBlockNumberParameters,
+  type UseWatchBlockNumberReturnType,
+  useWatchBlockNumber,
+} from '../composables/useWatchBlockNumber.js'
+
+export {
+  type UseWaitForTransactionReceiptParameters,
+  type UseWaitForTransactionReceiptReturnType,
+  useWaitForTransactionReceipt,
+} from '../composables/useWaitForTransactionReceipt.js'
+
+export {
+  type UseWriteContractParameters,
+  type UseWriteContractReturnType,
+  useWriteContract,
+} from '../composables/useWriteContract.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  // Config
+  type Connection,
+  type Connector,
+  type Config,
+  type CreateConfigParameters,
+  type State,
+  createConfig,
+  // Connector
+  type ConnectorEventMap,
+  type CreateConnectorFn,
+  createConnector,
+  // Errors
+  type ChainNotConfiguredErrorType,
+  ChainNotConfiguredError,
+  type ConnectorAlreadyConnectedErrorType,
+  ConnectorAlreadyConnectedError,
+  type ConnectorNotFoundErrorType,
+  ConnectorNotFoundError,
+  type ConnectorAccountNotFoundErrorType,
+  ConnectorAccountNotFoundError,
+  type ProviderNotFoundErrorType,
+  ProviderNotFoundError,
+  type SwitchChainNotSupportedErrorType,
+  SwitchChainNotSupportedError,
+  // Storage
+  type CreateStorageParameters,
+  type Storage,
+  createStorage,
+  noopStorage,
+  // Transports
+  custom,
+  fallback,
+  http,
+  webSocket,
+  unstable_connector,
+  // Types
+  type Register,
+  type ResolvedRegister,
+  // Utilities
+  cookieStorage,
+  cookieToInitialState,
+  deepEqual,
+  deserialize,
+  normalizeChainId,
+  parseCookie,
+  serialize,
+} from '@wagmi/core'
+
+////////////////////////////////////////////////////////////////////////////////
+// Version
+////////////////////////////////////////////////////////////////////////////////
+
+export { version } from '../version.js'

package/src/exports/nuxt.ts

@@ -0,0 +1,4 @@
+import { wagmiModule } from '../nuxt/module.js'
+
+export { type WagmiModuleOptions } from '../nuxt/module.js'
+export default wagmiModule

package/src/exports/query.ts

@@ -0,0 +1,17 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/query
+////////////////////////////////////////////////////////////////////////////////
+
+export * from '@wagmi/core/query'
+
+export {
+  type UseMutationParameters,
+  type UseMutationReturnType,
+  useMutation,
+} from '../utils/query.js'
+
+export {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'

package/src/nuxt/module.ts

@@ -0,0 +1,59 @@
+import type { NuxtModule } from '@nuxt/schema'
+import { addImports, createResolver, defineNuxtModule } from 'nuxt/kit'
+
+export type WagmiModuleOptions = {}
+
+export const wagmiModule: NuxtModule<WagmiModuleOptions> =
+  defineNuxtModule<WagmiModuleOptions>({
+    meta: {
+      name: '@wagmi/vue',
+      configKey: 'wagmi',
+      compatibility: {
+        nuxt: '^3.0.0',
+      },
+    },
+    setup(_options, nuxt) {
+      const { resolve } = createResolver(import.meta.url)
+
+      // Add types
+      nuxt.hook('prepare:types', ({ references }) => {
+        references.push({ types: '@wagmi/vue/nuxt' })
+      })
+
+      // Add auto imports
+      const composables = resolve('./runtime/composables')
+      const names = [
+        'useAccount',
+        'useAccountEffect',
+        'useBalance',
+        'useBlockNumber',
+        'useChainId',
+        'useChains',
+        'useClient',
+        'useConfig',
+        'useConnect',
+        'useConnections',
+        'useConnectorClient',
+        'useConnectors',
+        'useDisconnect',
+        'useEnsAddress',
+        'useEnsAvatar',
+        'useEnsName',
+        'useEstimateGas',
+        'useReadContract',
+        'useReconnect',
+        'useSendTransaction',
+        'useSignMessage',
+        'useSignTypedData',
+        'useSimulateContract',
+        'useSwitchAccount',
+        'useSwitchChain',
+        'useTransaction',
+        'useTransactionReceipt',
+        'useWaitForTransactionReceipt',
+        'useWatchBlockNumber',
+        'useWriteContract',
+      ]
+      addImports(names.map((name) => ({ from: composables, name })))
+    },
+  })

package/src/nuxt/runtime/composables.ts

@@ -0,0 +1 @@
+export * from '../../exports/index.js'

package/src/plugin.ts

@@ -0,0 +1,22 @@
+import { type ResolvedRegister, type State, hydrate } from '@wagmi/core'
+import type { Plugin } from 'vue'
+
+export const configKey = Symbol()
+
+export type WagmiPluginOptions = {
+  config: ResolvedRegister['config']
+  initialState?: State | undefined
+  reconnectOnMount?: boolean | undefined
+}
+
+export const WagmiPlugin = {
+  install(app, options) {
+    const { config, reconnectOnMount = true } = options
+    app.provide(configKey, config)
+    // TODO: check this works in SSR env.
+    //       - reconnect on mount.
+    //       - hydrate initial state.
+    const { onMount } = hydrate(config, { ...options, reconnectOnMount })
+    onMount()
+  },
+} satisfies Plugin<WagmiPluginOptions>