wagmi 3.1.4 → 3.3.0

package/src/tempo/hooks/faucet.ts

@@ -0,0 +1,142 @@
+import type { UseMutationResult } from '@tanstack/react-query'
+import type { Config, ResolvedRegister } from '@wagmi/core'
+import { Actions } from '@wagmi/core/tempo'
+import { useConfig } from '../../hooks/useConfig.js'
+import type { ConfigParameter } from '../../types/properties.js'
+import { type UseMutationParameters, useMutation } from '../../utils/query.js'
+
+/**
+ * Hook for funding an account with an initial amount of set token(s)
+ * on Tempo's testnet.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate, isPending } = Hooks.faucet.useFund()
+ *
+ *   return (
+ *     <button
+ *       onClick={() => mutate({ account: '0xdeadbeef...' })}
+ *       disabled={isPending}
+ *     >
+ *       Fund Account
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useFund<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: useFund.Parameters<config, context> = {},
+): useFund.ReturnType<config, context> {
+  const { mutation } = parameters
+  const config = useConfig(parameters)
+  return useMutation({
+    ...mutation,
+    async mutationFn(variables) {
+      return Actions.faucet.fund(config, variables)
+    },
+    mutationKey: ['fund'],
+  })
+}
+
+export declare namespace useFund {
+  type Parameters<
+    config extends Config = Config,
+    context = unknown,
+  > = ConfigParameter<config> & {
+    mutation?:
+      | UseMutationParameters<
+          Actions.faucet.fund.ReturnValue,
+          Actions.faucet.fund.ErrorType,
+          Actions.faucet.fund.Parameters<config>,
+          context
+        >
+      | undefined
+  }
+
+  type ReturnType<
+    config extends Config = Config,
+    context = unknown,
+  > = UseMutationResult<
+    Actions.faucet.fund.ReturnValue,
+    Actions.faucet.fund.ErrorType,
+    Actions.faucet.fund.Parameters<config>,
+    context
+  >
+}
+
+/**
+ * Hook for funding an account with an initial amount of set token(s)
+ * on Tempo's testnet. Returns the transaction receipts.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate, isPending } = Hooks.faucet.useFundSync()
+ *
+ *   return (
+ *     <button
+ *       onClick={() => mutate({ account: '0xdeadbeef...' })}
+ *       disabled={isPending}
+ *     >
+ *       Fund Account
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useFundSync<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: useFundSync.Parameters<config, context> = {},
+): useFundSync.ReturnType<config, context> {
+  const { mutation } = parameters
+  const config = useConfig(parameters)
+  return useMutation({
+    ...mutation,
+    async mutationFn(variables) {
+      return Actions.faucet.fundSync(config, variables)
+    },
+    mutationKey: ['fundSync'],
+  })
+}
+
+export declare namespace useFundSync {
+  type Parameters<
+    config extends Config = Config,
+    context = unknown,
+  > = ConfigParameter<config> & {
+    mutation?:
+      | UseMutationParameters<
+          Actions.faucet.fundSync.ReturnValue,
+          Actions.faucet.fundSync.ErrorType,
+          Actions.faucet.fundSync.Parameters<config>,
+          context
+        >
+      | undefined
+  }
+
+  type ReturnType<
+    config extends Config = Config,
+    context = unknown,
+  > = UseMutationResult<
+    Actions.faucet.fundSync.ReturnValue,
+    Actions.faucet.fundSync.ErrorType,
+    Actions.faucet.fundSync.Parameters<config>,
+    context
+  >
+}

package/src/tempo/hooks/fee.ts

@@ -0,0 +1,264 @@
+import type { UseMutationResult } from '@tanstack/react-query'
+import type { Config, ResolvedRegister } from '@wagmi/core'
+import type { ExactPartial, UnionCompute } from '@wagmi/core/internal'
+import { Actions } from '@wagmi/core/tempo'
+import { useEffect } from 'react'
+
+import { useChainId } from '../../hooks/useChainId.js'
+import { useConfig } from '../../hooks/useConfig.js'
+import type { ConfigParameter, QueryParameter } from '../../types/properties.js'
+import {
+  type UseMutationParameters,
+  type UseQueryReturnType,
+  useMutation,
+  useQuery,
+} from '../../utils/query.js'
+
+/**
+ * Hook for getting the user's default fee token.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { data, isLoading } = Hooks.fee.useUserToken({
+ *     account: '0x20c...0055',
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *   return <div>Token: {data?.address}</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Query result with token address and ID.
+ */
+export function useUserToken<
+  config extends Config = ResolvedRegister['config'],
+  selectData = Actions.fee.getUserToken.ReturnValue,
+>(
+  parameters: useUserToken.Parameters<config, selectData>,
+): useUserToken.ReturnValue<selectData> {
+  const config = useConfig(parameters)
+  const chainId = useChainId({ config })
+  const options = Actions.fee.getUserToken.queryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  } as never)
+  return useQuery(options) as never
+}
+
+export declare namespace useUserToken {
+  export type Parameters<
+    config extends Config = ResolvedRegister['config'],
+    selectData = Actions.fee.getUserToken.ReturnValue,
+  > = ConfigParameter<config> &
+    QueryParameter<
+      Actions.fee.getUserToken.ReturnValue,
+      Actions.fee.getUserToken.ErrorType,
+      selectData,
+      Actions.fee.getUserToken.QueryKey<config>
+    > &
+    Omit<
+      Actions.fee.getUserToken.queryOptions.Parameters<config, selectData>,
+      'query'
+    >
+
+  export type ReturnValue<selectData = Actions.fee.getUserToken.ReturnValue> =
+    UseQueryReturnType<selectData, Error>
+}
+
+/**
+ * Hook for setting the user's default fee token.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate, isPending } = Hooks.fee.useSetUserToken()
+ *
+ *   return (
+ *     <button
+ *       onClick={() => mutate({ token: '0x20c...0055' })}
+ *       disabled={isPending}
+ *     >
+ *       Set Token
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useSetUserToken<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: useSetUserToken.Parameters<config, context> = {},
+): useSetUserToken.ReturnType<config, context> {
+  const { mutation } = parameters
+  const config = useConfig(parameters)
+  return useMutation({
+    ...mutation,
+    async mutationFn(variables) {
+      return Actions.fee.setUserToken(config, variables as never)
+    },
+    mutationKey: ['setUserToken'],
+  }) as never
+}
+
+export declare namespace useSetUserToken {
+  type Parameters<
+    config extends Config = Config,
+    context = unknown,
+  > = ConfigParameter<config> & {
+    mutation?:
+      | UseMutationParameters<
+          Actions.fee.setUserToken.ReturnValue,
+          Actions.fee.setUserToken.ErrorType,
+          Actions.fee.setUserToken.Parameters<config>,
+          context
+        >
+      | undefined
+  }
+
+  type ReturnType<
+    config extends Config = Config,
+    context = unknown,
+  > = UseMutationResult<
+    Actions.fee.setUserToken.ReturnValue,
+    Actions.fee.setUserToken.ErrorType,
+    Actions.fee.setUserToken.Parameters<config>,
+    context
+  >
+}
+
+/**
+ * Hook for setting the user's default fee token.
+ *
+ * Note: This is a synchronous hook that waits for the transaction
+ * to be included on a block before returning a response.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate, isPending } = Hooks.fee.useSetUserTokenSync()
+ *
+ *   return (
+ *     <button
+ *       onClick={() => mutate({ token: '0x20c...0055' })}
+ *       disabled={isPending}
+ *     >
+ *       Set Token
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useSetUserTokenSync<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: useSetUserTokenSync.Parameters<config, context> = {},
+): useSetUserTokenSync.ReturnType<config, context> {
+  const { mutation } = parameters
+  const config = useConfig(parameters)
+  return useMutation({
+    ...mutation,
+    async mutationFn(variables) {
+      return Actions.fee.setUserTokenSync(config, variables as never)
+    },
+    mutationKey: ['setUserTokenSync'],
+  }) as never
+}
+
+export declare namespace useSetUserTokenSync {
+  type Parameters<
+    config extends Config = Config,
+    context = unknown,
+  > = ConfigParameter<config> & {
+    mutation?:
+      | UseMutationParameters<
+          Actions.fee.setUserTokenSync.ReturnValue,
+          Actions.fee.setUserTokenSync.ErrorType,
+          Actions.fee.setUserTokenSync.Parameters<config>,
+          context
+        >
+      | undefined
+  }
+
+  type ReturnType<
+    config extends Config = Config,
+    context = unknown,
+  > = UseMutationResult<
+    Actions.fee.setUserTokenSync.ReturnValue,
+    Actions.fee.setUserTokenSync.ErrorType,
+    Actions.fee.setUserTokenSync.Parameters<config>,
+    context
+  >
+}
+
+/**
+ * Hook for watching user token set events.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   Hooks.fee.useWatchSetUserToken({
+ *     onUserTokenSet(args) {
+ *       console.log('User token set:', args)
+ *     },
+ *   })
+ *
+ *   return <div>Watching for user token changes...</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ */
+export function useWatchSetUserToken<
+  config extends Config = ResolvedRegister['config'],
+>(parameters: useWatchSetUserToken.Parameters<config> = {}) {
+  const { enabled = true, onUserTokenSet, ...rest } = parameters
+
+  const config = useConfig({ config: parameters.config })
+  const configChainId = useChainId({ config })
+  const chainId = parameters.chainId ?? configChainId
+
+  // biome-ignore lint/correctness/useExhaustiveDependencies: rest.x is explicitly listed
+  useEffect(() => {
+    if (!enabled) return
+    if (!onUserTokenSet) return
+    return Actions.fee.watchSetUserToken(config, {
+      ...rest,
+      chainId,
+      onUserTokenSet,
+    })
+  }, [
+    config,
+    enabled,
+    chainId,
+    onUserTokenSet,
+    rest.fromBlock,
+    rest.onError,
+    rest.poll,
+    rest.pollingInterval,
+  ])
+}
+
+export declare namespace useWatchSetUserToken {
+  type Parameters<config extends Config = Config> = UnionCompute<
+    ExactPartial<Actions.fee.watchSetUserToken.Parameters<config>> &
+      ConfigParameter<config> & { enabled?: boolean | undefined }
+  >
+}

package/src/tempo/hooks/index.ts

@@ -0,0 +1,10 @@
+/** biome-ignore-all lint/performance/noReExportAll: entrypoint */
+// biome-ignore lint/performance/noBarrelFile: stable
+export * as amm from './amm.js'
+export * as dex from './dex.js'
+export * as faucet from './faucet.js'
+export * as fee from './fee.js'
+export * as nonce from './nonce.js'
+export * as policy from './policy.js'
+export * as reward from './reward.js'
+export * as token from './token.js'

package/src/tempo/hooks/nonce.ts

@@ -0,0 +1,126 @@
+import type { Config, ResolvedRegister } from '@wagmi/core'
+import type { ExactPartial, UnionCompute } from '@wagmi/core/internal'
+import { Actions } from '@wagmi/core/tempo'
+import { useEffect } from 'react'
+
+import { useChainId } from '../../hooks/useChainId.js'
+import { useConfig } from '../../hooks/useConfig.js'
+import type { ConfigParameter, QueryParameter } from '../../types/properties.js'
+import { type UseQueryReturnType, useQuery } from '../../utils/query.js'
+
+/**
+ * Hook for getting the nonce for an account and nonce key.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { data, isLoading } = Hooks.nonce.useNonce({
+ *     account: '0x...',
+ *     nonceKey: 1n,
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *   return <div>Nonce: {data?.toString()}</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Query result with nonce value.
+ */
+export function useNonce<
+  config extends Config = ResolvedRegister['config'],
+  selectData = Actions.nonce.getNonce.ReturnValue,
+>(
+  parameters: useNonce.Parameters<config, selectData> = {},
+): useNonce.ReturnValue<selectData> {
+  const config = useConfig(parameters)
+  const chainId = useChainId({ config })
+  const options = Actions.nonce.getNonce.queryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  } as never)
+  return useQuery(options) as never
+}
+
+export declare namespace useNonce {
+  export type Parameters<
+    config extends Config = ResolvedRegister['config'],
+    selectData = Actions.nonce.getNonce.ReturnValue,
+  > = ConfigParameter<config> &
+    QueryParameter<
+      Actions.nonce.getNonce.ReturnValue,
+      Actions.nonce.getNonce.ErrorType,
+      selectData,
+      Actions.nonce.getNonce.QueryKey<config>
+    > &
+    ExactPartial<
+      Omit<
+        Actions.nonce.getNonce.queryOptions.Parameters<config, selectData>,
+        'query'
+      >
+    >
+
+  export type ReturnValue<selectData = Actions.nonce.getNonce.ReturnValue> =
+    UseQueryReturnType<selectData, Error>
+}
+
+/**
+ * Hook for watching nonce incremented events.
+ *
+ * @deprecated This function has been deprecated post-AllegroModerato. It will be removed in a future version.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   Hooks.nonce.useWatchNonceIncremented({
+ *     onNonceIncremented(args, log) {
+ *       console.log('Nonce incremented:', args)
+ *     },
+ *   })
+ *
+ *   return <div>Watching for nonce increments...</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ */
+export function useWatchNonceIncremented<
+  config extends Config = ResolvedRegister['config'],
+>(parameters: useWatchNonceIncremented.Parameters<config> = {}) {
+  const { enabled = true, onNonceIncremented, ...rest } = parameters
+
+  const config = useConfig({ config: parameters.config })
+  const configChainId = useChainId({ config })
+  const chainId = parameters.chainId ?? configChainId
+
+  // biome-ignore lint/correctness/useExhaustiveDependencies: rest.x is explicitly listed
+  useEffect(() => {
+    if (!enabled) return
+    if (!onNonceIncremented) return
+    return Actions.nonce.watchNonceIncremented(config, {
+      ...rest,
+      chainId,
+      onNonceIncremented,
+    })
+  }, [
+    config,
+    enabled,
+    chainId,
+    onNonceIncremented,
+    rest.fromBlock,
+    rest.onError,
+    rest.poll,
+    rest.pollingInterval,
+  ])
+}
+
+export declare namespace useWatchNonceIncremented {
+  type Parameters<config extends Config = Config> = UnionCompute<
+    ExactPartial<Actions.nonce.watchNonceIncremented.Parameters<config>> &
+      ConfigParameter<config> & { enabled?: boolean | undefined }
+  >
+}