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

useAccessMerkleClaimAmount

Submits a transaction. Previews the outstanding amount for a proof-bearing Merkle entry as an encrypted handle.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Encrypted read

Description

Submits a transaction. Previews the outstanding amount for a proof-bearing Merkle entry as an encrypted handle. Pass data.handle to the Zama relayer's userDecrypt.

entry.account selects the leaf. A leaf someone else already settled previews as an encrypted zero; see MerkleClaimArgs.entry.

`entry.account` is the only party that can decrypt the result, not the submitter. The contract grants the outstanding handle with _outstandingOf(account, account, …), so a third-party submitter gets back a valid handle it learns nothing from - never offer it a userDecrypt action. This is the opposite of useAccessEcdsaClaimAmount, whose preview is ACL'd to msg.sender.

Invalidates: nothing. The preview consumes no accounting and no per-leaf state, so no cached read changes value - the same entry still pays the same amount afterwards.

Signature

@tokenops/sdk/fhe-airdrop/react

function useAccessMerkleClaimAmount(options: AirdropInstanceClientOptions): UseMutationResult<EncryptedViewResult, Error, GetClaimAmountArgs>;

Parameters

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

Example

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

tsx

const preview = useAccessMerkleClaimAmount({ address: airdropAddress });
const { handle } = await preview.mutateAsync({ entry });

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 accessMerkleClaimAmount = useAccessMerkleClaimAmount(/* options */);

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