2.0 RC docsView 1.x docs
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.
Disclose · ACLuseMutation Curated

useBatchDiscloseHandlesToParty

Batch ACL grant across many handles in one tx.

Import
@tokenops/sdk/fhe-airdrop/react
Return
{ mutate, mutateAsync, isPending, error, data }
Lifecycle
Disclose · ACL

Description

Grants one party decrypt access to several handles you already hold, in a single transaction. Produces no new handles, so it returns the transaction hash.

The same two gates as useDiscloseHandleToParty apply per handle - the caller allowed on it (unless it holds DISCLOSURE_ADMIN_ROLE) and the instance allowed on it - and the first failure reverts the whole batch, naming the offending handle. It is all-or-nothing: a partial grant is never left behind.

Invalidates: nothing. ACL is append-only and no read hook in this subpath caches who is allowed on a handle.

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useBatchDiscloseHandlesToParty(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, BatchDiscloseHandlesToPartyArgs>;

Parameters

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

Example

@tokenops/sdk/fhe-airdrop/react · @example
tsx
const disclose = useBatchDiscloseHandlesToParty({ address: airdropAddress });
await disclose.mutateAsync({ handles: [balanceHandle, claimHandle], party: auditor });

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
ts
import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const batchDiscloseHandlesToParty = useBatchDiscloseHandlesToParty(/* options */);

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

See also