@wagmi/core 3.0.2 → 3.2.0

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

@@ -0,0 +1,384 @@
+import { Actions } from 'viem/tempo';
+import { getConnectorClient } from '../../actions/getConnectorClient.js';
+/**
+ * Claims accumulated rewards for a recipient.
+ *
+ * @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.reward.claim(config, {
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function claim(config, parameters) {
+    const { account, chainId, connector } = parameters;
+    const client = await getConnectorClient(config, {
+        account,
+        assertChainId: false,
+        chainId,
+        connector,
+    });
+    return Actions.reward.claim(client, parameters);
+}
+/**
+ * Claims accumulated rewards for a recipient and waits for confirmation.
+ *
+ * @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.reward.claimSync(config, {
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction receipt.
+ */
+export async function claimSync(config, parameters) {
+    const { account, chainId, connector } = parameters;
+    const client = await getConnectorClient(config, {
+        account,
+        assertChainId: false,
+        chainId,
+        connector,
+    });
+    return Actions.reward.claimSync(client, parameters);
+}
+/**
+ * Gets the global reward per token value for a 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: [tempoModerato],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const value = await Actions.reward.getGlobalRewardPerToken(config, {
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The global reward per token value (scaled by 1e18).
+ */
+export function getGlobalRewardPerToken(config, parameters) {
+    const { chainId, ...rest } = parameters;
+    const client = config.getClient({ chainId });
+    return Actions.reward.getGlobalRewardPerToken(client, rest);
+}
+(function (getGlobalRewardPerToken) {
+    function queryKey(parameters) {
+        return ['getGlobalRewardPerToken', parameters];
+    }
+    getGlobalRewardPerToken.queryKey = queryKey;
+    function queryOptions(config, parameters) {
+        const { query, ...rest } = parameters;
+        return {
+            ...query,
+            enabled: Boolean(rest.token && (query?.enabled ?? true)),
+            queryKey: queryKey(rest),
+            async queryFn({ queryKey }) {
+                const [, parameters] = queryKey;
+                return await getGlobalRewardPerToken(config, parameters);
+            },
+        };
+    }
+    getGlobalRewardPerToken.queryOptions = queryOptions;
+})(getGlobalRewardPerToken || (getGlobalRewardPerToken = {}));
+/**
+ * Gets the reward information for a specific account.
+ *
+ * @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 info = await Actions.reward.getUserRewardInfo(config, {
+ *   token: '0x20c0000000000000000000000000000000000001',
+ *   account: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The user's reward information (recipient, rewardPerToken, rewardBalance).
+ */
+export function getUserRewardInfo(config, parameters) {
+    const { chainId, ...rest } = parameters;
+    const client = config.getClient({ chainId });
+    return Actions.reward.getUserRewardInfo(client, rest);
+}
+(function (getUserRewardInfo) {
+    function queryKey(parameters) {
+        return ['getUserRewardInfo', parameters];
+    }
+    getUserRewardInfo.queryKey = queryKey;
+    function queryOptions(config, parameters) {
+        const { query, ...rest } = parameters;
+        return {
+            ...query,
+            enabled: Boolean(rest.token && rest.account && (query?.enabled ?? true)),
+            queryKey: queryKey(rest),
+            async queryFn({ queryKey }) {
+                const [, parameters] = queryKey;
+                return await getUserRewardInfo(config, parameters);
+            },
+        };
+    }
+    getUserRewardInfo.queryOptions = queryOptions;
+})(getUserRewardInfo || (getUserRewardInfo = {}));
+/**
+ * Sets or changes the reward recipient for a token holder.
+ *
+ * @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.reward.setRecipient(config, {
+ *   recipient: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function setRecipient(config, parameters) {
+    const { account, chainId, connector } = parameters;
+    const client = await getConnectorClient(config, {
+        account,
+        assertChainId: false,
+        chainId,
+        connector,
+    });
+    return Actions.reward.setRecipient(client, parameters);
+}
+/**
+ * Sets or changes the reward recipient for a token holder and waits for confirmation.
+ *
+ * @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.reward.setRecipientSync(config, {
+ *   recipient: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction receipt and event data.
+ */
+export async function setRecipientSync(config, parameters) {
+    const { account, chainId, connector } = parameters;
+    const client = await getConnectorClient(config, {
+        account,
+        assertChainId: false,
+        chainId,
+        connector,
+    });
+    return Actions.reward.setRecipientSync(client, parameters);
+}
+/**
+ * Distributes tokens to opted-in holders.
+ *
+ * @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.reward.distribute(config, {
+ *   amount: 100000000000000000000n,
+ *   seconds: 86400,
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction hash.
+ */
+export async function distribute(config, parameters) {
+    const { account, chainId, connector } = parameters;
+    const client = await getConnectorClient(config, {
+        account,
+        assertChainId: false,
+        chainId,
+        connector,
+    });
+    return Actions.reward.distribute(client, parameters);
+}
+/**
+ * Distributes tokens to opted-in holders and waits for confirmation.
+ *
+ * @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.reward.distributeSync(config, {
+ *   amount: 100000000000000000000n,
+ *   seconds: 86400,
+ *   token: '0x20c0000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns The transaction receipt and event data.
+ */
+export async function distributeSync(config, parameters) {
+    const { account, chainId, connector } = parameters;
+    const client = await getConnectorClient(config, {
+        account,
+        assertChainId: false,
+        chainId,
+        connector,
+    });
+    return Actions.reward.distributeSync(client, parameters);
+}
+/**
+ * Watches for reward distributed 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: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const unwatch = Actions.reward.watchRewardDistributed(config, {
+ *   token: '0x20c0000000000000000000000000000000000001',
+ *   onRewardDistributed: (args, log) => {
+ *     console.log('Reward distributed:', args)
+ *   },
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns A function to unsubscribe from the event.
+ */
+export function watchRewardDistributed(config, parameters) {
+    const { chainId, ...rest } = parameters;
+    const client = config.getClient({ chainId });
+    return Actions.reward.watchRewardDistributed(client, rest);
+}
+/**
+ * Watches for reward recipient set 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: [tempoTestnet],
+ *   transports: {
+ *     [tempo.id]: http(),
+ *   },
+ * })
+ *
+ * const unwatch = Actions.reward.watchRewardRecipientSet(config, {
+ *   token: '0x20c0000000000000000000000000000000000001',
+ *   onRewardRecipientSet: (args, log) => {
+ *     console.log('Reward recipient set:', args)
+ *   },
+ * })
+ * ```
+ *
+ * @param config - Config.
+ * @param parameters - Parameters.
+ * @returns A function to unsubscribe from the event.
+ */
+export function watchRewardRecipientSet(config, parameters) {
+    const { chainId, ...rest } = parameters;
+    const client = config.getClient({ chainId });
+    return Actions.reward.watchRewardRecipientSet(client, rest);
+}
+//# sourceMappingURL=reward.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reward.js","sourceRoot":"","sources":["../../../../src/tempo/actions/reward.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AASxE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,MAAc,EACd,UAAoC;IAEpC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAElD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE;QAC9C,OAAO;QACP,aAAa,EAAE,KAAK;QACpB,OAAO;QACP,SAAS;KACV,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,UAAmB,CAAC,CAAA;AAC1D,CAAC;AAgBD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAc,EACd,UAAwC;IAExC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAElD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE;QAC9C,OAAO;QACP,aAAa,EAAE,KAAK;QACpB,OAAO;QACP,SAAS;KACV,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,UAAmB,CAAC,CAAA;AAC9D,CAAC;AAgBD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAc,EACd,UAAsD;IAEtD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAC5C,OAAO,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAC7D,CAAC;AAED,WAAiB,uBAAuB;IAQtC,SAAgB,QAAQ,CACtB,UAA8B;QAE9B,OAAO,CAAC,yBAAyB,EAAE,UAAU,CAAU,CAAA;IACzD,CAAC;IAJe,gCAAQ,WAIvB,CAAA;IAMD,SAAgB,YAAY,CAC1B,MAAc,EACd,UAAuD;QAEvD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;QACrC,OAAO;YACL,GAAG,KAAK;YACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC;YACxD,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC;YACxB,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE;gBACxB,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAA;gBAC/B,OAAO,MAAM,uBAAuB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YAC1D,CAAC;SACF,CAAA;IACH,CAAC;IAde,oCAAY,eAc3B,CAAA;AAwBH,CAAC,EAxDgB,uBAAuB,KAAvB,uBAAuB,QAwDvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAc,EACd,UAAgD;IAEhD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAC5C,OAAO,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AACvD,CAAC;AAED,WAAiB,iBAAiB;IAQhC,SAAgB,QAAQ,CACtB,UAA8B;QAE9B,OAAO,CAAC,mBAAmB,EAAE,UAAU,CAAU,CAAA;IACnD,CAAC;IAJe,0BAAQ,WAIvB,CAAA;IAMD,SAAgB,YAAY,CAC1B,MAAc,EACd,UAAuD;QAEvD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;QACrC,OAAO;YACL,GAAG,KAAK;YACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC;YACxE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC;YACxB,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE;gBACxB,MAAM,CAAC,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAA;gBAC/B,OAAO,MAAM,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YACpD,CAAC;SACF,CAAA;IACH,CAAC;IAde,8BAAY,eAc3B,CAAA;AAwBH,CAAC,EAxDgB,iBAAiB,KAAjB,iBAAiB,QAwDjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAc,EACd,UAA2C;IAE3C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAElD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE;QAC9C,OAAO;QACP,aAAa,EAAE,KAAK;QACpB,OAAO;QACP,SAAS;KACV,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,UAAmB,CAAC,CAAA;AACjE,CAAC;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAc,EACd,UAA+C;IAE/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAElD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE;QAC9C,OAAO;QACP,aAAa,EAAE,KAAK;QACpB,OAAO;QACP,SAAS;KACV,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAmB,CAAC,CAAA;AACrE,CAAC;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAc,EACd,UAAyC;IAEzC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAElD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE;QAC9C,OAAO;QACP,aAAa,EAAE,KAAK;QACpB,OAAO;QACP,SAAS;KACV,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAmB,CAAC,CAAA;AAC/D,CAAC;AAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAc,EACd,UAA6C;IAE7C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAElD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE;QAC9C,OAAO;QACP,aAAa,EAAE,KAAK;QACpB,OAAO;QACP,SAAS;KACV,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,UAAmB,CAAC,CAAA;AACnE,CAAC;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc,EACd,UAAqD;IAErD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAC5C,OAAO,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAC5D,CAAC;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAc,EACd,UAAsD;IAEtD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAA;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAC5C,OAAO,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAC7D,CAAC"}