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

useMerkleClaim

Claim the outstanding amount for a proof-bearing entry on a MerkleConfidentialAirdrop instance.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Claim the outstanding amount for a proof-bearing entry on a MerkleConfidentialAirdrop instance.

Invalidates: useClaimedAmount for entry.account on this instance — the read whose cumulative-delivered value a successful claim changes. The contract advances claimedAmount[account], keyed on the entry's claim identity and NOT on whoever sent the transaction, so a relayed claim must invalidate the recipient's cache entry rather than the relayer's. Other accounts' cached reads, and every other instance's cache, are left untouched.

Anyone may submit an entry; see MerkleClaimArgs.entry for what a third-party submission costs the recipient, and check useClaimedAmount first.

Signature

@tokenops/sdk/fhe-airdrop/react

function useMerkleClaim(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, MerkleClaimArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type MerkleClaimArgs. 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 a Merkle entry — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

Airdrop instance

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 = useMerkleClaim({ address: airdropAddress });
await claim.mutateAsync({ entry }); // any address may pass the entry unchanged

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 merkleClaim = useMerkleClaim(/* options */);

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