import type { UseMutationResult } from '@tanstack/react-query'; import type { Config, ResolvedRegister } from '@wagmi/core'; import type { ConfigParameter, ExactPartial, UnionCompute } from '@wagmi/core/internal'; import { Actions } from '@wagmi/core/tempo'; import { type UseMutationParameters, type UseQueryReturnType } from '../../utils/query.js'; import type { QueryParameter } from '../utils.js'; /** * Hook for claiming accumulated rewards. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { mutate: claim } = Hooks.reward.useClaim() * * return ( * * ) * } * ``` * * @param parameters - Parameters. * @returns Mutation result. */ export declare function useClaim(parameters?: useClaim.Parameters): useClaim.ReturnType; export declare namespace useClaim { type Parameters = ConfigParameter & { mutation?: UseMutationParameters, context> | undefined; }; type ReturnType = UseMutationResult, context>; } /** * Hook for claiming accumulated rewards and waiting for confirmation. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { mutate: claimSync } = Hooks.reward.useClaimSync() * * return ( * * ) * } * ``` * * @param parameters - Parameters. * @returns Mutation result. */ export declare function useClaimSync(parameters?: useClaimSync.Parameters): useClaimSync.ReturnType; export declare namespace useClaimSync { type Parameters = ConfigParameter & { mutation?: UseMutationParameters, context> | undefined; }; type ReturnType = UseMutationResult, context>; } /** * Hook for getting the global reward per token value. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { data, isLoading } = Hooks.reward.useGetGlobalRewardPerToken({ * token: '0x20c0000000000000000000000000000000000001', * }) * * if (isLoading) return
Loading...
* return
Value: {data?.toString()}
* } * ``` * * @param parameters - Parameters. * @returns Query result with global reward per token value. */ export declare function useGetGlobalRewardPerToken(parameters?: useGetGlobalRewardPerToken.Parameters): useGetGlobalRewardPerToken.ReturnValue; export declare namespace useGetGlobalRewardPerToken { type Parameters = ConfigParameter & QueryParameter> & ExactPartial>; type ReturnValue = UseQueryReturnType; } /** * Hook for getting the reward information for a specific account. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { data, isLoading } = Hooks.reward.useUserRewardInfo({ * token: '0x20c0000000000000000000000000000000000001', * account: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', * }) * * if (isLoading) return
Loading...
* return ( *
*
Recipient: {data?.rewardRecipient}
*
Reward per token: {data?.rewardPerToken.toString()}
*
Reward balance: {data?.rewardBalance.toString()}
*
* ) * } * ``` * * @param parameters - Parameters. * @returns Query result with reward information (recipient, rewardPerToken, rewardBalance). */ export declare function useUserRewardInfo(parameters?: useUserRewardInfo.Parameters): useUserRewardInfo.ReturnValue; export declare namespace useUserRewardInfo { type Parameters = ConfigParameter & QueryParameter> & ExactPartial>; type ReturnValue = UseQueryReturnType; } /** * Hook for setting the reward recipient for a token holder. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { mutate: setRecipient } = Hooks.reward.useSetRecipient() * * return ( * * ) * } * ``` * * @param parameters - Parameters. * @returns Mutation result. */ export declare function useSetRecipient(parameters?: useSetRecipient.Parameters): useSetRecipient.ReturnType; export declare namespace useSetRecipient { type Parameters = ConfigParameter & { mutation?: UseMutationParameters, context> | undefined; }; type ReturnType = UseMutationResult, context>; } /** * Hook for setting the reward recipient and waiting for confirmation. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { mutate: setRecipientSync } = Hooks.reward.useSetRecipientSync() * * return ( * * ) * } * ``` * * @param parameters - Parameters. * @returns Mutation result. */ export declare function useSetRecipientSync(parameters?: useSetRecipientSync.Parameters): useSetRecipientSync.ReturnType; export declare namespace useSetRecipientSync { type Parameters = ConfigParameter & { mutation?: UseMutationParameters, context> | undefined; }; type ReturnType = UseMutationResult, context>; } /** * Hook for distributing rewards. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { mutate: distribute } = Hooks.reward.useDistribute() * * return ( * * ) * } * ``` * * @param parameters - Parameters. * @returns Mutation result. */ export declare function useDistribute(parameters?: useDistribute.Parameters): useDistribute.ReturnType; export declare namespace useDistribute { type Parameters = ConfigParameter & { mutation?: UseMutationParameters, context> | undefined; }; type ReturnType = UseMutationResult, context>; } /** * Hook for distributing rewards and waiting for confirmation. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * const { mutate: distributeSync } = Hooks.reward.useDistributeSync() * * return ( * * ) * } * ``` * * @param parameters - Parameters. * @returns Mutation result. */ export declare function useDistributeSync(parameters?: useDistributeSync.Parameters): useDistributeSync.ReturnType; export declare namespace useDistributeSync { type Parameters = ConfigParameter & { mutation?: UseMutationParameters, context> | undefined; }; type ReturnType = UseMutationResult, context>; } /** * Hook for watching reward distributed events. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * Hooks.reward.useWatchRewardDistributed({ * token: '0x20c0000000000000000000000000000000000001', * onRewardDistributed(args) { * console.log('Reward distributed:', args) * }, * }) * * return
Watching for reward distributed events...
* } * ``` * * @param parameters - Parameters. */ export declare function useWatchRewardDistributed(parameters?: useWatchRewardDistributed.Parameters): void; export declare namespace useWatchRewardDistributed { type Parameters = UnionCompute> & ConfigParameter & { enabled?: boolean | undefined; }>; } /** * Hook for watching reward recipient set events. * * @example * ```tsx * import { Hooks } from 'wagmi/tempo' * * function App() { * Hooks.reward.useWatchRewardRecipientSet({ * token: '0x20c0000000000000000000000000000000000001', * onRewardRecipientSet(args) { * console.log('Reward recipient set:', args) * }, * }) * * return
Watching for reward recipient set events...
* } * ``` * * @param parameters - Parameters. */ export declare function useWatchRewardRecipientSet(parameters?: useWatchRewardRecipientSet.Parameters): void; export declare namespace useWatchRewardRecipientSet { type Parameters = UnionCompute> & ConfigParameter & { enabled?: boolean | undefined; }>; } //# sourceMappingURL=reward.d.ts.map