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.

Encrypted readuseMutationencrypted handle

useAccessEcdsaClaimAmount

Submits a transaction. Previews a signed encrypted allocation as an encrypted handle.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Encrypted read

Description

Submits a transaction. Previews a signed encrypted allocation as an encrypted handle. Pass data.handle to the Zama relayer's userDecrypt.

The submitter can decrypt what it previews here. The contract grants the amount with FHE.allow(amount, msg.sender), unlike useAccessMerkleClaimAmount, whose grantee is the entry's claim identity rather than the caller.

An empty inputProof is accepted only for a zero handle or one the sender and the instance already hold ACL on; see EcdsaClaimArgs.encryptedInput.

Invalidates: nothing. The preview consumes neither replay guard nor the EIP-712 digest, so the same input is still claimable for real afterwards and no cached read changes value.

Signature

@tokenops/sdk/fhe-airdrop/react

function useAccessEcdsaClaimAmount(options: EcdsaAirdropInstanceClientOptions): UseMutationResult<EncryptedViewResult, Error, EcdsaGetClaimAmountArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type EcdsaGetClaimAmountArgs. 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 useAccessEcdsaClaimAmount; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const preview = useAccessEcdsaClaimAmount({ address: airdropAddress });
const { handle } = await preview.mutateAsync({ encryptedInput, dedupId, deadline, signer, 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 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 accessEcdsaClaimAmount = useAccessEcdsaClaimAmount(/* options */);

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