wagmi 3.1.4 → 3.2.0

package/dist/esm/tempo/Hooks/reward.js

@@ -0,0 +1,385 @@
+import { Actions } from '@wagmi/core/tempo';
+import { useEffect } from 'react';
+import { useChainId } from '../../hooks/useChainId.js';
+import { useConfig } from '../../hooks/useConfig.js';
+import { useMutation, useQuery, } from '../../utils/query.js';
+/**
+ * Hook for claiming accumulated rewards.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate: claim } = Hooks.reward.useClaim()
+ *
+ *   return (
+ *     <button onClick={() => claim({
+ *       token: '0x20c0000000000000000000000000000000000001'
+ *     })}>
+ *       Claim Rewards
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useClaim(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.reward.claim(config, variables);
+        },
+        mutationKey: ['claim'],
+    });
+}
+/**
+ * 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 (
+ *     <button onClick={() => claimSync({
+ *       token: '0x20c0000000000000000000000000000000000001'
+ *     })}>
+ *       Claim Rewards
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useClaimSync(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.reward.claimSync(config, variables);
+        },
+        mutationKey: ['claimSync'],
+    });
+}
+/**
+ * Hook for getting the total reward per second rate.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { data, isLoading } = Hooks.reward.useGetTotalPerSecond({
+ *     token: '0x20c0000000000000000000000000000000000001',
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *   return <div>Rate: {data?.toString()}</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Query result with total reward per second.
+ */
+export function useGetTotalPerSecond(parameters = {}) {
+    const config = useConfig(parameters);
+    const chainId = useChainId({ config });
+    const options = Actions.reward.getTotalPerSecond.queryOptions(config, {
+        ...parameters,
+        chainId: parameters.chainId ?? chainId,
+    });
+    return useQuery(options);
+}
+/**
+ * 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 <div>Loading...</div>
+ *   return (
+ *     <div>
+ *       <div>Recipient: {data?.rewardRecipient}</div>
+ *       <div>Reward per token: {data?.rewardPerToken.toString()}</div>
+ *       <div>Reward balance: {data?.rewardBalance.toString()}</div>
+ *     </div>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Query result with reward information (recipient, rewardPerToken, rewardBalance).
+ */
+export function useUserRewardInfo(parameters = {}) {
+    const config = useConfig(parameters);
+    const chainId = useChainId({ config });
+    const options = Actions.reward.getUserRewardInfo.queryOptions(config, {
+        ...parameters,
+        chainId: parameters.chainId ?? chainId,
+    });
+    return useQuery(options);
+}
+/**
+ * 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 (
+ *     <button onClick={() => setRecipient({
+ *       recipient: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ *       token: '0x20c0000000000000000000000000000000000001',
+ *     })}>
+ *       Set Recipient
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useSetRecipient(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.reward.setRecipient(config, variables);
+        },
+        mutationKey: ['setRecipient'],
+    });
+}
+/**
+ * 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 (
+ *     <button onClick={() => setRecipientSync({
+ *       recipient: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ *       token: '0x20c0000000000000000000000000000000000001',
+ *     })}>
+ *       Set Recipient
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useSetRecipientSync(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.reward.setRecipientSync(config, variables);
+        },
+        mutationKey: ['setRecipientSync'],
+    });
+}
+/**
+ * Hook for starting a new reward stream.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate: start } = Hooks.reward.useStart()
+ *
+ *   return (
+ *     <button onClick={() => start({
+ *       amount: 100000000000000000000n,
+ *       seconds: 86400,
+ *       token: '0x20c0000000000000000000000000000000000001',
+ *     })}>
+ *       Start Reward
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useStart(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.reward.start(config, variables);
+        },
+        mutationKey: ['start'],
+    });
+}
+/**
+ * Hook for starting a new reward stream and waiting for confirmation.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   const { mutate: startSync } = Hooks.reward.useStartSync()
+ *
+ *   return (
+ *     <button onClick={() => startSync({
+ *       amount: 100000000000000000000n,
+ *       seconds: 86400,
+ *       token: '0x20c0000000000000000000000000000000000001',
+ *     })}>
+ *       Start Reward
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useStartSync(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.reward.startSync(config, variables);
+        },
+        mutationKey: ['startSync'],
+    });
+}
+/**
+ * Hook for watching reward scheduled events.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'wagmi/tempo'
+ *
+ * function App() {
+ *   Hooks.reward.useWatchRewardScheduled({
+ *     token: '0x20c0000000000000000000000000000000000001',
+ *     onRewardScheduled(args) {
+ *       console.log('Reward scheduled:', args)
+ *     },
+ *   })
+ *
+ *   return <div>Watching for reward scheduled events...</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ */
+export function useWatchRewardScheduled(parameters = {}) {
+    const { enabled = true, onRewardScheduled, token, ...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 (!onRewardScheduled)
+            return;
+        if (!token)
+            return;
+        return Actions.reward.watchRewardScheduled(config, {
+            ...rest,
+            chainId,
+            onRewardScheduled,
+            token,
+        });
+    }, [
+        config,
+        enabled,
+        chainId,
+        token,
+        onRewardScheduled,
+        rest.fromBlock,
+        rest.onError,
+        rest.poll,
+        rest.pollingInterval,
+    ]);
+}
+/**
+ * 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 <div>Watching for reward recipient set events...</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ */
+export function useWatchRewardRecipientSet(parameters = {}) {
+    const { enabled = true, onRewardRecipientSet, token, ...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 (!onRewardRecipientSet)
+            return;
+        if (!token)
+            return;
+        return Actions.reward.watchRewardRecipientSet(config, {
+            ...rest,
+            chainId,
+            onRewardRecipientSet,
+            token,
+        });
+    }, [
+        config,
+        enabled,
+        chainId,
+        token,
+        onRewardRecipientSet,
+        rest.fromBlock,
+        rest.onError,
+        rest.poll,
+        rest.pollingInterval,
+    ]);
+}
+//# sourceMappingURL=reward.js.map

package/dist/esm/tempo/Hooks/reward.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reward.js","sourceRoot":"","sources":["../../../../src/tempo/Hooks/reward.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAEjC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAGL,WAAW,EACX,QAAQ,GACT,MAAM,sBAAsB,CAAA;AAE7B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,QAAQ,CAItB,aAAmD,EAAE;IAErD,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;IAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,OAAO,WAAW,CAAC;QACjB,GAAG,QAAQ;QACX,KAAK,CAAC,UAAU,CAAC,SAAS;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,SAAkB,CAAC,CAAA;QACzD,CAAC;QACD,WAAW,EAAE,CAAC,OAAO,CAAC;KACvB,CAAU,CAAA;AACb,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,YAAY,CAI1B,aAAuD,EAAE;IAEzD,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;IAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,OAAO,WAAW,CAAC;QACjB,GAAG,QAAQ;QACX,KAAK,CAAC,UAAU,CAAC,SAAS;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,SAAkB,CAAC,CAAA;QAC7D,CAAC;QACD,WAAW,EAAE,CAAC,WAAW,CAAC;KAC3B,CAAU,CAAA;AACb,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,oBAAoB,CAIlC,aAAkE,EAAE;IAEpE,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IACtC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,MAAM,EAAE;QACpE,GAAG,UAAU;QACb,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,OAAO;KAC9B,CAAC,CAAA;IACX,OAAO,QAAQ,CAAC,OAAO,CAAU,CAAA;AACnC,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,iBAAiB,CAI/B,aAA+D,EAAE;IAEjE,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IACtC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,MAAM,EAAE;QACpE,GAAG,UAAU;QACb,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,OAAO;KAC9B,CAAC,CAAA;IACX,OAAO,QAAQ,CAAC,OAAO,CAAU,CAAA;AACnC,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,eAAe,CAI7B,aAA0D,EAAE;IAE5D,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;IAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,OAAO,WAAW,CAAC;QACjB,GAAG,QAAQ;QACX,KAAK,CAAC,UAAU,CAAC,SAAS;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAkB,CAAC,CAAA;QAChE,CAAC;QACD,WAAW,EAAE,CAAC,cAAc,CAAC;KAC9B,CAAU,CAAA;AACb,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,mBAAmB,CAIjC,aAA8D,EAAE;IAEhE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;IAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,OAAO,WAAW,CAAC;QACjB,GAAG,QAAQ;QACX,KAAK,CAAC,UAAU,CAAC,SAAS;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAkB,CAAC,CAAA;QACpE,CAAC;QACD,WAAW,EAAE,CAAC,kBAAkB,CAAC;KAClC,CAAU,CAAA;AACb,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,QAAQ,CAItB,aAAmD,EAAE;IAErD,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;IAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,OAAO,WAAW,CAAC;QACjB,GAAG,QAAQ;QACX,KAAK,CAAC,UAAU,CAAC,SAAS;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,SAAkB,CAAC,CAAA;QACzD,CAAC;QACD,WAAW,EAAE,CAAC,OAAO,CAAC;KACvB,CAAU,CAAA;AACb,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,YAAY,CAI1B,aAAuD,EAAE;IAEzD,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;IAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,OAAO,WAAW,CAAC;QACjB,GAAG,QAAQ;QACX,KAAK,CAAC,UAAU,CAAC,SAAS;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,SAAkB,CAAC,CAAA;QAC7D,CAAC;QACD,WAAW,EAAE,CAAC,WAAW,CAAC;KAC3B,CAAU,CAAA;AACb,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,uBAAuB,CAErC,aAAyD,EAAE;IAC3D,MAAM,EAAE,OAAO,GAAG,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;IAExE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAA;IACvD,MAAM,aAAa,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5C,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,aAAa,CAAA;IAEnD,uFAAuF;IACvF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,IAAI,CAAC,iBAAiB;YAAE,OAAM;QAC9B,IAAI,CAAC,KAAK;YAAE,OAAM;QAClB,OAAO,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE;YACjD,GAAG,IAAI;YACP,OAAO;YACP,iBAAiB;YACjB,KAAK;SACN,CAAC,CAAA;IACJ,CAAC,EAAE;QACD,MAAM;QACN,OAAO;QACP,OAAO;QACP,KAAK;QACL,iBAAiB;QACjB,IAAI,CAAC,SAAS;QACd,IAAI,CAAC,OAAO;QACZ,IAAI,CAAC,IAAI;QACT,IAAI,CAAC,eAAe;KACrB,CAAC,CAAA;AACJ,CAAC;AASD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,0BAA0B,CAExC,aAA4D,EAAE;IAC9D,MAAM,EAAE,OAAO,GAAG,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;IAE3E,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAA;IACvD,MAAM,aAAa,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5C,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,aAAa,CAAA;IAEnD,uFAAuF;IACvF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,IAAI,CAAC,oBAAoB;YAAE,OAAM;QACjC,IAAI,CAAC,KAAK;YAAE,OAAM;QAClB,OAAO,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE;YACpD,GAAG,IAAI;YACP,OAAO;YACP,oBAAoB;YACpB,KAAK;SACN,CAAC,CAAA;IACJ,CAAC,EAAE;QACD,MAAM;QACN,OAAO;QACP,OAAO;QACP,KAAK;QACL,oBAAoB;QACpB,IAAI,CAAC,SAAS;QACd,IAAI,CAAC,OAAO;QACZ,IAAI,CAAC,IAAI;QACT,IAAI,CAAC,eAAe;KACrB,CAAC,CAAA;AACJ,CAAC"}