@wagmi/core 3.0.2 → 3.1.0

package/src/tempo/Actions/faucet.ts

@@ -0,0 +1,95 @@
+import type { BaseErrorType } from 'viem'
+import { Actions } from 'viem/tempo'
+import type { Config } from '../../createConfig.js'
+import type { ChainIdParameter } from '../../types/properties.js'
+import type { UnionCompute } from '../../types/utils.js'
+
+/**
+ * Funds an account with an initial amount of set token(s)
+ * on Tempo's testnet.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const hashes = await Actions.faucet.fund(config, {
+ *   account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction hashes.
+ */
+export async function fund<config extends Config>(
+  config: config,
+  parameters: fund.Parameters<config>,
+): Promise<fund.ReturnValue> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.faucet.fund(client, rest)
+}
+
+export declare namespace fund {
+  export type Parameters<config extends Config> = UnionCompute<
+    ChainIdParameter<config> & Actions.faucet.fund.Parameters
+  >
+
+  export type ReturnValue = Actions.faucet.fund.ReturnValue
+
+  export type ErrorType = BaseErrorType // TODO: Actions.faucet.fund.ErrorType
+}
+
+/**
+ * Funds an account with an initial amount of set token(s)
+ * on Tempo's testnet. Returns with the transaction receipts.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const receipts = await Actions.faucet.fundSync(config, {
+ *   account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction hashes.
+ */
+export async function fundSync<config extends Config>(
+  config: config,
+  parameters: fundSync.Parameters<config>,
+): Promise<fundSync.ReturnValue> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.faucet.fundSync(client, rest)
+}
+
+export declare namespace fundSync {
+  export type Parameters<config extends Config> = UnionCompute<
+    ChainIdParameter<config> & Actions.faucet.fundSync.Parameters
+  >
+
+  export type ReturnValue = Actions.faucet.fundSync.ReturnValue
+
+  export type ErrorType = BaseErrorType // TODO: Actions.faucet.fundSync.ErrorType
+}

package/src/tempo/Actions/fee.ts

@@ -0,0 +1,259 @@
+import type { Account, BaseErrorType } from 'viem'
+import { Actions } from 'viem/tempo'
+import { getConnectorClient } from '../../actions/getConnectorClient.js'
+import type { Config } from '../../createConfig.js'
+import { filterQueryOptions } from '../../query/utils.js'
+import type {
+  ChainIdParameter,
+  ConnectorParameter,
+} from '../../types/properties.js'
+import type { PartialBy, UnionLooseOmit } from '../../types/utils.js'
+import type { QueryOptions, QueryParameter } from './utils.js'
+
+/**
+ * Gets the user's default fee token.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const hash = await Actions.fee.getUserToken(config, {
+ *   account: '0x20c...0055',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns Transaction hash.
+ */
+export function getUserToken<config extends Config>(
+  config: config,
+  parameters: getUserToken.Parameters<config>,
+): Promise<getUserToken.ReturnValue> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.fee.getUserToken(client, rest)
+}
+
+export namespace getUserToken {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    Actions.fee.getUserToken.Parameters
+
+  export type ReturnValue = Actions.fee.getUserToken.ReturnValue
+
+  export type ErrorType = BaseErrorType
+
+  export function queryKey<config extends Config>(
+    parameters: PartialBy<Parameters<config>, 'account'>,
+  ) {
+    return ['getUserToken', filterQueryOptions(parameters)] as const
+  }
+
+  export type QueryKey<config extends Config> = ReturnType<
+    typeof queryKey<config>
+  >
+
+  export function queryOptions<config extends Config, selectData = ReturnValue>(
+    config: Config,
+    parameters: queryOptions.Parameters<config, selectData>,
+  ): queryOptions.ReturnValue<config, selectData> {
+    const { query, ...rest } = parameters
+    return {
+      ...query,
+      enabled: Boolean(rest.account && (query?.enabled ?? true)),
+      queryKey: queryKey(rest),
+      async queryFn(context) {
+        const [, { account, ...parameters }] = context.queryKey
+        if (!account) throw new Error('account is required.')
+        return await getUserToken(config, { account, ...parameters })
+      },
+    }
+  }
+
+  export declare namespace queryOptions {
+    export type Parameters<
+      config extends Config,
+      selectData = getUserToken.ReturnValue,
+    > = PartialBy<getUserToken.Parameters<config>, 'account'> &
+      QueryParameter<
+        getUserToken.ReturnValue,
+        getUserToken.ErrorType,
+        selectData,
+        getUserToken.QueryKey<config>
+      >
+
+    export type ReturnValue<
+      config extends Config,
+      selectData = getUserToken.ReturnValue,
+    > = QueryOptions<
+      getUserToken.ReturnValue,
+      getUserToken.ErrorType,
+      selectData,
+      getUserToken.QueryKey<config>
+    >
+  }
+}
+
+/**
+ * Sets the user's default fee token.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const result = await Actions.fee.setUserToken(config, {
+ *   token: '0x20c...0055',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction receipt and event data.
+ */
+export async function setUserToken<config extends Config>(
+  config: config,
+  parameters: setUserToken.Parameters<config>,
+): Promise<Actions.fee.setUserToken.ReturnValue> {
+  const { account, chainId, connector } = parameters
+
+  const client = await getConnectorClient(config, {
+    account,
+    assertChainId: false,
+    chainId,
+    connector,
+  })
+
+  return Actions.fee.setUserToken(client, parameters as never)
+}
+
+export declare namespace setUserToken {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    ConnectorParameter &
+    UnionLooseOmit<
+      Actions.fee.setUserToken.Parameters<config['chains'][number], Account>,
+      'chain'
+    >
+
+  export type ReturnValue = Actions.fee.setUserToken.ReturnValue
+
+  export type ErrorType = BaseErrorType // TODO: Actions.fee.setUserToken.ErrorType
+}
+
+/**
+ * Sets the user's default fee token.
+ *
+ * Note: This is a synchronous action that waits for the transaction to
+ * be included on a block before returning a response.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const result = await Actions.fee.setUserTokenSync(config, {
+ *   token: '0x20c...0055',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction receipt and event data.
+ */
+export async function setUserTokenSync<config extends Config>(
+  config: config,
+  parameters: setUserTokenSync.Parameters<config>,
+): Promise<Actions.fee.setUserTokenSync.ReturnValue> {
+  const { account, chainId, connector } = parameters
+
+  const client = await getConnectorClient(config, {
+    account,
+    assertChainId: false,
+    chainId,
+    connector,
+  })
+
+  return Actions.fee.setUserTokenSync(client, parameters as never)
+}
+
+export declare namespace setUserTokenSync {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    ConnectorParameter &
+    UnionLooseOmit<
+      Actions.fee.setUserTokenSync.Parameters<
+        config['chains'][number],
+        Account
+      >,
+      'chain'
+    >
+
+  export type ReturnValue = Actions.fee.setUserTokenSync.ReturnValue
+
+  export type ErrorType = BaseErrorType // TODO: Actions.fee.setUserTokenSync.ErrorType
+}
+
+/**
+ * Watches for user token set events on the Fee Manager.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempo],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const unwatch = Actions.fee.watchSetUserToken(config, {
+ *   onUserTokenSet: (args, log) => {
+ *     console.log('User token set:', args)
+ *   },
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns A function to unsubscribe from the event.
+ */
+export function watchSetUserToken<config extends Config>(
+  config: config,
+  parameters: watchSetUserToken.Parameters<config>,
+): () => void {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.fee.watchSetUserToken(client, rest)
+}
+
+export declare namespace watchSetUserToken {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    Actions.fee.watchSetUserToken.Parameters
+}

package/src/tempo/Actions/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/Actions/nonce.ts

@@ -0,0 +1,283 @@
+import type { BaseErrorType } from 'viem'
+import { Actions } from 'viem/tempo'
+import type { Config } from '../../createConfig.js'
+import { filterQueryOptions } from '../../query/utils.js'
+import type { ChainIdParameter } from '../../types/properties.js'
+import type { PartialBy } from '../../types/utils.js'
+import type { QueryOptions, QueryParameter } from './utils.js'
+
+/**
+ * Gets the nonce for an account and nonce key.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempo],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const nonce = await Actions.nonce.getNonce(config, {
+ *   account: '0x...',
+ *   nonceKey: 1n,
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The nonce value.
+ */
+export function getNonce<config extends Config>(
+  config: config,
+  parameters: getNonce.Parameters<config>,
+): Promise<getNonce.ReturnValue> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.nonce.getNonce(client, rest)
+}
+
+export namespace getNonce {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    Actions.nonce.getNonce.Parameters
+
+  export type ReturnValue = Actions.nonce.getNonce.ReturnValue
+
+  export type ErrorType = BaseErrorType
+
+  export function queryKey<config extends Config>(
+    parameters: PartialBy<Parameters<config>, 'account' | 'nonceKey'>,
+  ) {
+    return ['getNonce', filterQueryOptions(parameters)] as const
+  }
+
+  export type QueryKey<config extends Config> = ReturnType<
+    typeof queryKey<config>
+  >
+
+  export function queryOptions<config extends Config, selectData = ReturnValue>(
+    config: Config,
+    parameters: queryOptions.Parameters<config, selectData>,
+  ): queryOptions.ReturnValue<config, selectData> {
+    const { query, ...rest } = parameters
+    return {
+      ...query,
+      enabled: Boolean(
+        rest.account && rest.nonceKey !== undefined && (query?.enabled ?? true),
+      ),
+      queryKey: queryKey(rest),
+      async queryFn(context) {
+        const [, { account, nonceKey, ...parameters }] = context.queryKey
+        if (!account) throw new Error('account is required.')
+        if (nonceKey === undefined) throw new Error('nonceKey is required.')
+        return await getNonce(config, { account, nonceKey, ...parameters })
+      },
+    }
+  }
+
+  export declare namespace queryOptions {
+    export type Parameters<
+      config extends Config,
+      selectData = getNonce.ReturnValue,
+    > = PartialBy<getNonce.Parameters<config>, 'account' | 'nonceKey'> &
+      QueryParameter<
+        getNonce.ReturnValue,
+        getNonce.ErrorType,
+        selectData,
+        getNonce.QueryKey<config>
+      >
+
+    export type ReturnValue<
+      config extends Config,
+      selectData = getNonce.ReturnValue,
+    > = QueryOptions<
+      getNonce.ReturnValue,
+      getNonce.ErrorType,
+      selectData,
+      getNonce.QueryKey<config>
+    >
+  }
+}
+
+/**
+ * Watches for nonce incremented events.
+ *
+ * @deprecated This function has been deprecated post-AllegroModerato. It will be removed in a future version.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempo],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const unwatch = Actions.nonce.watchNonceIncremented(config, {
+ *   onNonceIncremented: (args, log) => {
+ *     console.log('Nonce incremented:', args)
+ *   },
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns A function to unsubscribe from the event.
+ */
+export function watchNonceIncremented<config extends Config>(
+  config: config,
+  parameters: watchNonceIncremented.Parameters<config>,
+): () => void {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.nonce.watchNonceIncremented(client, rest)
+}
+
+export declare namespace watchNonceIncremented {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    Actions.nonce.watchNonceIncremented.Parameters
+}
+
+/**
+ * Watches for active key count changed events.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempo],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const unwatch = Actions.nonce.watchActiveKeyCountChanged(config, {
+ *   onActiveKeyCountChanged: (args, log) => {
+ *     console.log('Active key count changed:', args)
+ *   },
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns A function to unsubscribe from the event.
+ */
+export function watchActiveKeyCountChanged<config extends Config>(
+  config: config,
+  parameters: watchActiveKeyCountChanged.Parameters<config>,
+): () => void {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.nonce.watchActiveKeyCountChanged(client, rest)
+}
+
+export declare namespace watchActiveKeyCountChanged {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    Actions.nonce.watchActiveKeyCountChanged.Parameters
+}
+
+/**
+ * Gets the number of active nonce keys for an account.
+ *
+ * @deprecated This function has been deprecated post-AllegroModerato. It will be removed in a future version.
+ *
+ * @example
+ * ```ts
+ * import { createConfig, http } from '@wagmi/core'
+ * import { tempo } from '@wagmi/core/chains'
+ * import { Actions } from '@wagmi/core/tempo'
+ *
+ * const config = createConfig({
+ *   chains: [tempo],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const count = await Actions.nonce.getNonceKeyCount(config, {
+ *   account: '0x...',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The number of active nonce keys.
+ */
+export function getNonceKeyCount<config extends Config>(
+  config: config,
+  parameters: getNonceKeyCount.Parameters<config>,
+): Promise<getNonceKeyCount.ReturnValue> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return Actions.nonce.getNonceKeyCount(client, rest)
+}
+
+export namespace getNonceKeyCount {
+  export type Parameters<config extends Config> = ChainIdParameter<config> &
+    Actions.nonce.getNonceKeyCount.Parameters
+
+  export type ReturnValue = Actions.nonce.getNonceKeyCount.ReturnValue
+
+  export type ErrorType = BaseErrorType
+
+  export function queryKey<config extends Config>(
+    parameters: PartialBy<Parameters<config>, 'account'>,
+  ) {
+    return ['getNonceKeyCount', filterQueryOptions(parameters)] as const
+  }
+
+  export type QueryKey<config extends Config> = ReturnType<
+    typeof queryKey<config>
+  >
+
+  export function queryOptions<config extends Config, selectData = ReturnValue>(
+    config: Config,
+    parameters: queryOptions.Parameters<config, selectData>,
+  ): queryOptions.ReturnValue<config, selectData> {
+    const { query, ...rest } = parameters
+    return {
+      ...query,
+      enabled: Boolean(rest.account && (query?.enabled ?? true)),
+      queryKey: queryKey(rest),
+      async queryFn(context) {
+        const [, { account, ...parameters }] = context.queryKey
+        if (!account) throw new Error('account is required.')
+        return await getNonceKeyCount(config, { account, ...parameters })
+      },
+    }
+  }
+
+  export declare namespace queryOptions {
+    export type Parameters<
+      config extends Config,
+      selectData = getNonceKeyCount.ReturnValue,
+    > = PartialBy<getNonceKeyCount.Parameters<config>, 'account'> &
+      QueryParameter<
+        getNonceKeyCount.ReturnValue,
+        getNonceKeyCount.ErrorType,
+        selectData,
+        getNonceKeyCount.QueryKey<config>
+      >
+
+    export type ReturnValue<
+      config extends Config,
+      selectData = getNonceKeyCount.ReturnValue,
+    > = QueryOptions<
+      getNonceKeyCount.ReturnValue,
+      getNonceKeyCount.ErrorType,
+      selectData,
+      getNonceKeyCount.QueryKey<config>
+    >
+  }
+}