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

useAdminGetCurrentBalance

Submits a transaction. Reads the instance's remaining confidential pool balance as an euint64 handle the caller may decrypt - pass data.handle to the Zama relayer's userDecrypt.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Encrypted read

Description

Submits a transaction. Reads the instance's remaining confidential pool balance as an euint64 handle the caller may decrypt - pass data.handle to the Zama relayer's userDecrypt. Requires DISCLOSURE_ADMIN_ROLE.

The name reads like a getter but the entrypoint calls FHE.allow, so it is nonpayable and its handle comes from the receipt's ACL Allowed event - never from a simulation, whose handle would carry no grant. That is why this is a mutation and not a query.

Invalidates: nothing. It grants ACL and reads no cached state. Note the converse too: funding and withdrawing move the balance this returns, but a mutation result is not a cache entry, so no write can refresh it - re-run this hook after useFundAirdrop or useWithdrawConfidential to see the new value.

Signature

@tokenops/sdk/fhe-airdrop/react

function useAdminGetCurrentBalance(options: AirdropInstanceClientOptions): UseMutationResult<EncryptedViewResult, Error, WriteAccountOverride | void>;

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 useAdminGetCurrentBalance; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const balance = useAdminGetCurrentBalance({ address: airdropAddress });
const { handle } = await balance.mutateAsync();

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 adminGetCurrentBalance = useAdminGetCurrentBalance(/* options */);

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