WriteuseMutation

useClaim

Claim tokens from an airdrop using an EIP-712 admin signature.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Claim tokens from an airdrop using an EIP-712 admin signature. Submits the admin-issued { encryptedInput, signature } pair verbatim — the SDK does NOT re-encrypt on the recipient side, because the signature commits to the exact bytes32 handle and any re-encryption would invalidate it.

Attaches GAS_FEE() ETH as msg.value automatically unless args.value is set.

The admin builds encryptedInput server-side via encryptUint64 with userAddress: recipient (Zama input proofs are bound to the recipient), then signs the resulting handle with signClaimAuthorization. Deliver (encryptedInput, signature) to the recipient via your channel of choice; the recipient passes the pair to this hook unchanged.

After a successful claim, invalidate useAirdropIsSignatureClaimed({ user, encryptedAmountHandle }) and any UI counts you computed off it.

Signature

@tokenops/sdk/fhe-airdrop/react

function useClaim(options: AirdropHookOptions): UseMutationResult<Hex, Error, ClaimArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type ClaimArgs. Inspect the type for the full shape (discriminated unions collapse to a tagged variant at call time).

Run it

Connect your wallet and click Claim — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

Manager clone addressvestingId (32-byte hex)

Loading editor…

Edit any input above, then press ⌘↵ to run.

Console0 lines

No output yet. Run the snippet to see logs stream in.

Example

@tokenops/sdk/fhe-airdrop/react · @example

tsx

const claim = useClaim({ address: airdropAddress });
claim.mutate({ encryptedInput, signature });

Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.

Errors

This mutation can reject with SDK-level, product-level, or viem-passthrough errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Airdrop › Errors for the per-class recovery table.

Invalidation recipe

After this mutation succeeds, invalidate the queries it affects so consumer UI re-fetches fresh state. The SDK never auto-invalidates — that's a consumer decision (different apps cache different shapes).

patterns/invalidation.ts

import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const claim = useClaim(/* options */);

claim.mutate(args, {
  onSuccess() {
    // Coarse invalidation: refresh every cached read on this product surface.
    queryClient.invalidateQueries({
      queryKey: ["tokenops-sdk", "fhe-airdrop"],
    });
  },
});