@tokenops/sdk 1.0.0

package/dist/fhe-airdrop/react/useCreateConfidentialAirdropAndGetAddress.d.ts

@@ -0,0 +1,31 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { CreateAirdropResult, CreateAirdropArgs } from "../factory.js";
+import { type FactoryHookOptions } from "./_shared.js";
+/**
+ * **Recommended factory entry point.** Deploy a new
+ * `ConfidentialAirdropCloneable` clone and resolve its address from the
+ * `ConfidentialAirdropCreated` event in the tx receipt — in one call.
+ *
+ * Internally: `createConfidentialAirdrop` → `waitForTransactionReceipt` →
+ * `parseEventLogs({ eventName: "ConfidentialAirdropCreated" })`.
+ *
+ * After a successful create, invalidate factory queries that depend on
+ * per-creator state:
+ *
+ * ```ts
+ * const queryClient = useQueryClient();
+ * const create = useCreateConfidentialAirdropAndGetAddress();
+ * create.mutate(args, {
+ *   onSuccess: ({ airdrop }) => {
+ *     queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-airdrop"] });
+ *     navigate(`/airdrop/${airdrop}`);
+ *   },
+ * });
+ * ```
+ *
+ * @example
+ * const create = useCreateConfidentialAirdropAndGetAddress();
+ * create.mutate({ params, userSalt });
+ * // create.data → { hash, airdrop }
+ */
+export declare function useCreateConfidentialAirdropAndGetAddress(options?: FactoryHookOptions): UseMutationResult<CreateAirdropResult, Error, CreateAirdropArgs>;

package/dist/fhe-airdrop/react/useDisableCustomFee.d.ts

@@ -0,0 +1,14 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseDisableCustomFeeArgs {
+    campaignCreator: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: remove a per-creator fee override, reverting to `defaultGasFee`.
+ * Requires `FEE_MANAGER_ROLE`.
+ *
+ * After success, invalidate `useFactoryCustomFee({ creator: campaignCreator })`.
+ */
+export declare function useDisableCustomFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseDisableCustomFeeArgs>;

package/dist/fhe-airdrop/react/useExtendClaimWindow.d.ts

@@ -0,0 +1,16 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type AirdropHookOptions } from "./_shared.js";
+export interface UseExtendClaimWindowArgs {
+    newEndTime: number;
+    account?: Account | Address;
+}
+/**
+ * Admin: extend the claim window's `endTime`. Requires
+ * `DEFAULT_ADMIN_ROLE` AND `CAN_EXTEND_CLAIM_WINDOW == true` (immutable) — the
+ * contract reverts otherwise.
+ *
+ * After success, invalidate `useAirdropEndTime`,
+ * `useAirdropHasClaimEnded`, and `useAirdropIsClaimWindowActive`.
+ */
+export declare function useExtendClaimWindow(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseExtendClaimWindowArgs>;

package/dist/fhe-airdrop/react/useFactoryCustomFee.d.ts

@@ -0,0 +1,17 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import type { Address } from "viem";
+import { type CustomFee } from "../types.js";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseFactoryCustomFeeArgs extends BaseHookOptions {
+    /** Address whose per-creator fee override to read. Hook is disabled until set. */
+    creator?: Address;
+}
+/**
+ * Read the per-creator fee override set on the factory for `creator`. Returns
+ * `{ enabled: false, gasFee: 0n }` when no override exists.
+ *
+ * @example
+ * const { data: customFee } = useFactoryCustomFee({ creator });
+ * if (customFee?.enabled) { ... use customFee.gasFee ... }
+ */
+export declare function useFactoryCustomFee(args?: UseFactoryCustomFeeArgs): UseQueryResult<CustomFee, Error>;

package/dist/fhe-airdrop/react/useFactoryDefaultGasFee.d.ts

@@ -0,0 +1,10 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import { type BaseHookOptions } from "./_shared.js";
+/**
+ * Read the factory-wide default per-claim gas fee (in wei) — applied to new
+ * airdrop clones at deployment when the creator has no custom override.
+ *
+ * @example
+ * const { data: defaultGasFee } = useFactoryDefaultGasFee();
+ */
+export declare function useFactoryDefaultGasFee(options?: BaseHookOptions): UseQueryResult<bigint, Error>;

package/dist/fhe-airdrop/react/useFactoryFeeCollector.d.ts

@@ -0,0 +1,11 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import type { Address } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+/**
+ * Read the factory's current fee collector address — the account authorized to
+ * call `withdrawGasFee` on each deployed airdrop clone.
+ *
+ * @example
+ * const { data: feeCollector } = useFactoryFeeCollector();
+ */
+export declare function useFactoryFeeCollector(options?: BaseHookOptions): UseQueryResult<Address, Error>;

package/dist/fhe-airdrop/react/useFactoryInitCodeHash.d.ts

@@ -0,0 +1,17 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import type { Hex } from "viem";
+import { type AirdropParams } from "../types.js";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseFactoryInitCodeHashArgs extends BaseHookOptions {
+    params?: AirdropParams;
+    gasFee?: bigint;
+}
+/**
+ * Read the init-code hash the factory would use to CREATE2 an airdrop clone
+ * with the given `params` + `gasFee`. Mirrors Solidity's `getInitCodeHash`
+ * selector.
+ *
+ * @example
+ * const { data: initCodeHash } = useFactoryInitCodeHash({ params, gasFee });
+ */
+export declare function useFactoryInitCodeHash(args?: UseFactoryInitCodeHashArgs): UseQueryResult<Hex, Error>;

package/dist/fhe-airdrop/react/useFundConfidentialAirdrop.d.ts

@@ -0,0 +1,25 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Hex } from "viem";
+import type { FundAirdropArgs } from "../factory.js";
+import { type FactoryHookOptions } from "./_shared.js";
+/**
+ * Fund an existing (or not-yet-deployed) airdrop clone with encrypted tokens
+ * via the factory. The SDK encrypts the plaintext `amount` into an
+ * `externalEuint64` and submits it with an input proof — callers never handle
+ * ciphertext.
+ *
+ * **Encryptor resolution.** The hook-level `encryptor` (from
+ * {@link FactoryHookOptions}) is forwarded lazily to the SDK client. You can
+ * also pass `encryptor` per-mutation via `args.encryptor` to override it. If
+ * neither is present, the SDK throws `Missing encryptor — pass encryptor…`
+ * verbatim.
+ *
+ * **Prerequisites:** caller must have set the factory as an operator on the
+ * token: `token.setOperator(factoryAddress, deadline)`.
+ *
+ * **`args.gasFee` MUST match the fee active for `deployer` at airdrop creation
+ * time** — custom fee if `getCustomFee(deployer).enabled`, otherwise
+ * `defaultGasFee`. The factory derives the target clone address from this
+ * value via CREATE2; a mismatch funds the wrong (predicted) address.
+ */
+export declare function useFundConfidentialAirdrop(options?: FactoryHookOptions): UseMutationResult<Hex, Error, FundAirdropArgs>;

package/dist/fhe-airdrop/react/useGetClaimAmount.d.ts

@@ -0,0 +1,30 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { EncryptedViewResult, GetClaimAmountArgs } from "../airdrop.js";
+import { type AirdropHookOptions } from "./_shared.js";
+/**
+ * **Submits a transaction (costs gas) to grant the caller decrypt access to
+ * the claim amount as an `euint64` handle.** The handle is granted persistent
+ * ACL on-chain via `FHE.allow(handle, msg.sender)`; the SDK extracts it from
+ * the receipt's `ACL.Allowed` event (NOT from simulation — that returns a
+ * divergent, ACL-less handle; see CLAUDE.md Pitfall #1).
+ *
+ * Pass `data.handle` to the Zama relayer's `userDecrypt` to obtain the
+ * plaintext amount. The handle is only valid after the tx lands.
+ *
+ * Does **not** consume the claim (the `claimedSignatures` bit is not set).
+ * Call {@link useClaim} when the user is ready to transfer tokens.
+ *
+ * Submits the admin-issued `{ encryptedInput, signature }` pair verbatim. The
+ * SDK does NOT re-encrypt — the signature commits to the exact handle.
+ *
+ * @example
+ * // `encryptedInput` + `signature` are the admin-issued payload delivered to
+ * // the recipient (same pair the recipient passes to `useClaim`). Sourced
+ * // from your server API or, for admin-dashboard flows, by combining
+ * // `encryptUint64({ userAddress: recipient, ... })` with
+ * // `useSignClaimAuthorization`.
+ * const view = useGetClaimAmount({ address: airdropAddress });
+ * view.mutate({ encryptedInput, signature });
+ * // view.data → { handle: "0x...", hash: "0x..." }
+ */
+export declare function useGetClaimAmount(options: AirdropHookOptions): UseMutationResult<EncryptedViewResult, Error, GetClaimAmountArgs>;

package/dist/fhe-airdrop/react/useSetCustomFee.d.ts

@@ -0,0 +1,16 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetCustomFeeArgs {
+    campaignCreator: Address;
+    gasFee: bigint;
+    account?: Account | Address;
+}
+/**
+ * Admin: install a per-creator gas-fee override on the factory. Takes
+ * precedence over `defaultGasFee` for all airdrops `campaignCreator` deploys
+ * after the override. Requires `FEE_MANAGER_ROLE`.
+ *
+ * After success, invalidate `useFactoryCustomFee({ creator: campaignCreator })`.
+ */
+export declare function useSetCustomFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetCustomFeeArgs>;

package/dist/fhe-airdrop/react/useSetDefaultGasFee.d.ts

@@ -0,0 +1,15 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetDefaultGasFeeArgs {
+    newGasFee: bigint;
+    account?: Account | Address;
+}
+/**
+ * Admin: change the factory-wide default per-claim gas fee. Requires
+ * `FEE_MANAGER_ROLE`. Only affects airdrops deployed AFTER this call — already
+ * deployed clones carry the gas fee as an immutable arg.
+ *
+ * After success, invalidate `useFactoryDefaultGasFee()`.
+ */
+export declare function useSetDefaultGasFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetDefaultGasFeeArgs>;

package/dist/fhe-airdrop/react/useSetFeeCollector.d.ts

@@ -0,0 +1,14 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetFeeCollectorArgs {
+    newFeeCollector: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: change the factory's fee collector address. Requires
+ * `FEE_MANAGER_ROLE`.
+ *
+ * After success, invalidate `useFactoryFeeCollector()`.
+ */
+export declare function useSetFeeCollector(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetFeeCollectorArgs>;

package/dist/fhe-airdrop/react/useSetPaused.d.ts

@@ -0,0 +1,14 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type AirdropHookOptions } from "./_shared.js";
+export interface UseSetPausedArgs {
+    paused: boolean;
+    account?: Account | Address;
+}
+/**
+ * Admin: pause or unpause claims on this airdrop clone. Requires
+ * `DEFAULT_ADMIN_ROLE`.
+ *
+ * After success, invalidate `useAirdropIsPaused` and `useAirdropIsClaimWindowActive`.
+ */
+export declare function useSetPaused(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseSetPausedArgs>;

package/dist/fhe-airdrop/react/useSignClaimAuthorization.d.ts

@@ -0,0 +1,31 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Address, Hex } from "viem";
+export interface UseSignClaimAuthorizationArgs {
+    /** The deployed airdrop clone address (EIP-712 verifying contract). */
+    airdropAddress: Address;
+    /** Address authorised to claim. */
+    recipient: Address;
+    /** `externalEuint64` handle bytes32 — pass `encrypted.handle` from `encryptUint64`. */
+    encryptedAmountHandle: Hex;
+}
+export interface UseSignClaimAuthorizationOptions {
+    /** Override the chain id used for the wagmi `useWalletClient` lookup. Defaults to the connected chain. */
+    chainId?: number;
+}
+/**
+ * Sign a `Claim(address recipient, bytes32 encryptedAmount)` EIP-712
+ * authorization. The signer (pulled from wagmi's `useWalletClient()`) must
+ * hold `DEFAULT_ADMIN_ROLE` on the airdrop clone for the produced signature
+ * to be accepted by {@link useClaim} / {@link useGetClaimAmount}.
+ *
+ * Mutation throws {@link TokenOpsSdkError} if no wallet is connected.
+ *
+ * @example
+ * const sign = useSignClaimAuthorization();
+ * const signature = await sign.mutateAsync({
+ *   airdropAddress,
+ *   recipient,
+ *   encryptedAmountHandle: encrypted.handle,
+ * });
+ */
+export declare function useSignClaimAuthorization(options?: UseSignClaimAuthorizationOptions): UseMutationResult<Hex, Error, UseSignClaimAuthorizationArgs>;

package/dist/fhe-airdrop/react/useWithdraw.d.ts

@@ -0,0 +1,12 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type AirdropHookOptions } from "./_shared.js";
+export interface UseWithdrawArgs {
+    recipient: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: withdraw all confidential tokens from the airdrop to `recipient`.
+ * Requires `DEFAULT_ADMIN_ROLE`.
+ */
+export declare function useWithdraw(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseWithdrawArgs>;

package/dist/fhe-airdrop/react/useWithdrawOtherConfidentialToken.d.ts

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type AirdropHookOptions } from "./_shared.js";
+export interface UseWithdrawOtherConfidentialTokenArgs {
+    tokenAddress: Address;
+    recipient: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: rescue accidentally sent ERC-7984 confidential tokens (other than
+ * this airdrop's configured `TOKEN`). Requires `DEFAULT_ADMIN_ROLE`.
+ */
+export declare function useWithdrawOtherConfidentialToken(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseWithdrawOtherConfidentialTokenArgs>;

package/dist/fhe-airdrop/react/useWithdrawOtherToken.d.ts

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type AirdropHookOptions } from "./_shared.js";
+export interface UseWithdrawOtherTokenArgs {
+    tokenAddress: Address;
+    recipient: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: rescue accidentally sent ERC-20 (non-confidential) tokens. Requires
+ * `DEFAULT_ADMIN_ROLE`.
+ */
+export declare function useWithdrawOtherToken(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseWithdrawOtherTokenArgs>;

package/dist/fhe-airdrop/types.d.ts

@@ -0,0 +1,21 @@
+import type { Address } from "viem";
+export type { EncryptedInput, EncryptedInputs, EncryptedViewResult } from "../fhe/types.js";
+/**
+ * Parameters for creating a confidential airdrop.
+ *
+ * `startTimestamp` and `endTimestamp` are unix timestamps (uint32). The SDK
+ * maps them to the on-chain struct fields `startTime` / `endTime` before
+ * encoding — do not pass the on-chain names directly.
+ */
+export interface AirdropParams {
+    token: Address;
+    startTimestamp: number;
+    endTimestamp: number;
+    canExtendClaimWindow: boolean;
+    admin: Address;
+}
+/** Custom fee override for a campaign creator. */
+export interface CustomFee {
+    enabled: boolean;
+    gasFee: bigint;
+}

package/dist/fhe-disperse/abis/index.d.ts

@@ -0,0 +1,2 @@
+export { disperseConfidentialAbi } from "./singleton.js";
+export { disperseWalletAbi } from "./wallet.js";