tempo.ts 0.1.5 → 0.2.0

package/dist/wagmi/Hooks/reward.js

@@ -0,0 +1,349 @@
+import { useChainId, useConfig } from 'wagmi';
+import { useMutation, useQuery, } from 'wagmi/query';
+import * as Actions from '../Actions/reward.js';
+/**
+ * Hook for canceling an active reward stream.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * function App() {
+ *   const { mutate: cancel } = Hooks.reward.useCancel()
+ *
+ *   return (
+ *     <button onClick={() => cancel({
+ *       id: 1n,
+ *       token: '0x20c0000000000000000000000000000000000001'
+ *     })}>
+ *       Cancel Stream
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useCancel(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.cancel(config, variables);
+        },
+        mutationKey: ['cancel'],
+    });
+}
+/**
+ * Hook for canceling an active reward stream and waiting for confirmation.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * function App() {
+ *   const { mutate: cancelSync } = Hooks.reward.useCancelSync()
+ *
+ *   return (
+ *     <button onClick={() => cancelSync({
+ *       id: 1n,
+ *       token: '0x20c0000000000000000000000000000000000001'
+ *     })}>
+ *       Cancel Stream
+ *     </button>
+ *   )
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Mutation result.
+ */
+export function useCancelSync(parameters = {}) {
+    const { mutation } = parameters;
+    const config = useConfig(parameters);
+    return useMutation({
+        ...mutation,
+        async mutationFn(variables) {
+            return Actions.cancelSync(config, variables);
+        },
+        mutationKey: ['cancelSync'],
+    });
+}
+/**
+ * Hook for claiming accumulated rewards.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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.claim(config, variables);
+        },
+        mutationKey: ['claim'],
+    });
+}
+/**
+ * Hook for claiming accumulated rewards and waiting for confirmation.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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.claimSync(config, variables);
+        },
+        mutationKey: ['claimSync'],
+    });
+}
+/**
+ * Hook for getting a reward stream by its ID.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * function App() {
+ *   const { data, isLoading } = Hooks.reward.useGetStream({
+ *     id: 1n,
+ *     token: '0x20c0000000000000000000000000000000000001',
+ *   })
+ *
+ *   if (isLoading) return <div>Loading...</div>
+ *   return <div>Funder: {data?.funder}</div>
+ * }
+ * ```
+ *
+ * @param parameters - Parameters.
+ * @returns Query result with stream details.
+ */
+export function useGetStream(parameters = {}) {
+    const { id, query = {}, token } = parameters;
+    const config = useConfig(parameters);
+    const chainId = useChainId({ config });
+    const options = Actions.getStream.queryOptions(config, {
+        ...parameters,
+        chainId: parameters.chainId ?? chainId,
+        query: undefined,
+    });
+    const enabled = Boolean(id !== undefined && token && (query.enabled ?? true));
+    return useQuery({ ...query, ...options, enabled });
+}
+/**
+ * Hook for getting the total reward per second rate.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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 { query = {}, token } = parameters;
+    const config = useConfig(parameters);
+    const chainId = useChainId({ config });
+    const options = Actions.getTotalPerSecond.queryOptions(config, {
+        ...parameters,
+        chainId: parameters.chainId ?? chainId,
+        query: undefined,
+    });
+    const enabled = Boolean(token && (query.enabled ?? true));
+    return useQuery({ ...query, ...options, enabled });
+}
+/**
+ * Hook for setting the reward recipient for a token holder.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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.setRecipient(config, variables);
+        },
+        mutationKey: ['setRecipient'],
+    });
+}
+/**
+ * Hook for setting the reward recipient and waiting for confirmation.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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.setRecipientSync(config, variables);
+        },
+        mutationKey: ['setRecipientSync'],
+    });
+}
+/**
+ * Hook for starting a new reward stream.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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.start(config, variables);
+        },
+        mutationKey: ['start'],
+    });
+}
+/**
+ * Hook for starting a new reward stream and waiting for confirmation.
+ *
+ * @example
+ * ```tsx
+ * import { Hooks } from 'tempo.ts/wagmi'
+ *
+ * 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.startSync(config, variables);
+        },
+        mutationKey: ['startSync'],
+    });
+}
+//# sourceMappingURL=reward.js.map

package/dist/wagmi/Hooks/reward.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reward.js","sourceRoot":"","sources":["../../../src/wagmi/Hooks/reward.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAE7C,OAAO,EAGL,WAAW,EACX,QAAQ,GACT,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,SAAS,CAIvB,aAAoD,EAAE;IAEtD,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,MAAM,EAAE,SAAS,CAAC,CAAA;QAC1C,CAAC;QACD,WAAW,EAAE,CAAC,QAAQ,CAAC;KACxB,CAAC,CAAA;AACJ,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,aAAa,CAI3B,aAAwD,EAAE;IAE1D,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,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QAC9C,CAAC;QACD,WAAW,EAAE,CAAC,YAAY,CAAC;KAC5B,CAAC,CAAA;AACJ,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;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,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QACzC,CAAC;QACD,WAAW,EAAE,CAAC,OAAO,CAAC;KACvB,CAAC,CAAA;AACJ,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,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QAC7C,CAAC;QACD,WAAW,EAAE,CAAC,WAAW,CAAC;KAC3B,CAAC,CAAA;AACJ,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CAG1B,aAA0D,EAAE;IAC5D,MAAM,EAAE,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,UAAU,CAAA;IAE5C,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEtC,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE;QACrD,GAAG,UAAU;QACb,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,OAAO;QACtC,KAAK,EAAE,SAAS;KACR,CAAC,CAAA;IACX,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAA;IAE7E,OAAO,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;AACpD,CAAC;AAwBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,oBAAoB,CAGlC,aAAkE,EAAE;IACpE,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,UAAU,CAAA;IAExC,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;IACpC,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEtC,MAAM,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,MAAM,EAAE;QAC7D,GAAG,UAAU;QACb,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,OAAO;QACtC,KAAK,EAAE,SAAS;KACR,CAAC,CAAA;IACX,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAA;IAEzD,OAAO,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;AACpD,CAAC;AAwBD;;;;;;;;;;;;;;;;;;;;;;;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,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,EAAE,CAAC,cAAc,CAAC;KAC9B,CAAC,CAAA;AACJ,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,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QACpD,CAAC;QACD,WAAW,EAAE,CAAC,kBAAkB,CAAC;KAClC,CAAC,CAAA;AACJ,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,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QACzC,CAAC;QACD,WAAW,EAAE,CAAC,OAAO,CAAC;KACvB,CAAC,CAAA;AACJ,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,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QAC7C,CAAC;QACD,WAAW,EAAE,CAAC,WAAW,CAAC;KAC3B,CAAC,CAAA;AACJ,CAAC"}