@tokenops/sdk 1.6.0 → 2.0.0-alpha.1

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

@@ -1,51 +0,0 @@
-import { type UseQueryResult } from "@tanstack/react-query";
-import type { Address, Hex } from "viem";
-import type { AirdropParams, CreateAirdropPreflightReport } from "../types.js";
-import { type BaseHookOptions } from "./_shared.js";
-export interface UsePreflightCreateAirdropArgs extends BaseHookOptions {
-    /** The airdrop parameters that will be passed to the create call. */
-    params?: AirdropParams;
-    /** The address that will send the create transaction (`msg.sender`). */
-    creator?: Address;
-    /**
-     * The `userSalt` planned for the create call. Optional — when supplied, the
-     * report also carries `predictedAirdrop` and `alreadyDeployed`.
-     */
-    userSalt?: Hex;
-    /**
-     * Set `true` when the plan is `useCreateAndFundConfidentialAirdrop` — a
-     * missing factory-operator approval then becomes a blocker instead of
-     * informational `isFactoryOperator` state.
-     */
-    funding?: boolean;
-}
-/**
- * Read-only preflight for `useCreateConfidentialAirdrop` /
- * `useCreateAndFundConfidentialAirdrop` — wraps
- * {@link ConfidentialAirdropFactoryClient.preflightCreateAirdrop} as a
- * TanStack query.
- *
- * The report carries `isFactoryOperator`, `gasFee`, `predictedAirdrop`,
- * `alreadyDeployed`, `ready`, `blockers` (human-readable strings) and
- * `blockerErrors` (typed `TokenOpsSdkError`s, index-aligned with `blockers` —
- * branch on `error.code`).
- *
- * Checks: structural `params` validation (non-zero token/admin, timestamp
- * ordering, end time in the future), ERC-7984 operator approval of the
- * factory on `params.token` (blocker only with `funding: true`), and — when
- * `userSalt` is set — whether a clone already exists at the predicted CREATE2
- * address. The creator's confidential token balance is NOT checked
- * (encrypted; an underfunded create-and-fund silently moves an encrypted
- * zero) — see the headless method's TSDoc.
- *
- * Hook is disabled until `params` and `creator` are both set. Refetch after
- * the user calls `setOperator` (e.g. via `queryClient.invalidateQueries` or a
- * `refetchInterval`).
- *
- * @example
- * const { data: report } = usePreflightCreateAirdrop({
- *   params, creator, userSalt, funding: true,
- * });
- * if (report?.ready) { /* enable submit *\/ }
- */
-export declare function usePreflightCreateAirdrop(args?: UsePreflightCreateAirdropArgs): UseQueryResult<CreateAirdropPreflightReport, Error>;

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

@@ -1,16 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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 useAccessClaimAmount}.
- *
- * 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

@@ -1,12 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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>;