v2.0.0-rc.1 release candidate

The API is frozen and later candidates carry fixes only, except the receipt-free and Safe create surface of /fhe-airdrop, which is @beta. Published on the next dist-tag; latest stays on 1.6.0 until 2.0.0.

WriteuseMutation

useEcdsaClaimAndUnwrap

Claim a signed encrypted allocation and route it straight into the wrapper's unwrap, making to the underlying ERC-20 beneficiary.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Claim a signed encrypted allocation and route it straight into the wrapper's unwrap, making to the underlying ERC-20 beneficiary.

Reverts FeatureDisabledError on a non-unwrappable campaign - gate the button on useAirdropConfig().unwrappable. Consumes the same replay guards and EIP-712 digest as useEcdsaClaim, and the same empty-proof rule.

The amount is public from the claim transaction. With the stock wrapper the unwrapped amount is publicly decryptable at once (the emitted unwrapRequestId is its handle); finalizeUnwrap only releases the ERC-20. Only a plain claim keeps it confidential.

Resolves to the claim's transaction hash; the underlying ERC-20 moves only at the wrapper's later finalizeUnwrap. Pass the hash to useUnwrapRequest for the unwrapRequestId that call takes.

Invalidates: the fn "isSignatureValid" PREFIX for this instance, exactly as useEcdsaClaim does: the claim consumes the EIP-712 digest, so a cached true is now a guaranteed replay. Per-claim dedup state itself remains unqueryable.

Signature

@tokenops/sdk/fhe-airdrop/react

function useEcdsaClaimAndUnwrap(options: EcdsaAirdropInstanceClientOptions): UseMutationResult<Hex, Error, EcdsaClaimArgs>;

Parameters

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

Want to run a similar shape interactively? The Playground ships 12 ready presets across vesting / airdrop / disperse / faucet — deploy a manager, create a vesting, claim, and run the product equivalents. The deep-link above auto-selects the closest preset to useEcdsaClaimAndUnwrap; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const unwrapClaim = useEcdsaClaimAndUnwrap({ address: airdropAddress });
await unwrapClaim.mutateAsync({ encryptedInput, dedupId, deadline, signer, signature, to });

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 generic-fallback errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Airdrop v2 › 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 ecdsaClaimAndUnwrap = useEcdsaClaimAndUnwrap(/* options */);

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