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.

WriteuseMutationencrypts input

useFundAirdrop

Top up an already-deployed instance's pool through the factory.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Top up an already-deployed instance's pool through the factory.

Takes exactly one of amount (plaintext — the SDK encrypts it against the hook-level encryptor, or a per-call encryptor override) or encryptedInput (already built ciphertext) — see FundInput. The lazy encryptor on the hook config is threaded through to the underlying ConfidentialAirdropFactoryClient, which itself falls back from a per-call override to this hook-level default and throws MissingEncryptorError only if neither resolves — no encryptor indirection needs duplicating here.

Invalidates: nothing. No read hook in this subpath caches the confidential pool balance (useAdminGetCurrentBalance is a mutation, so there is nothing to invalidate).

Never log `amount`. It is the one plaintext confidential value this hook ever sees — do not pass it to telemetry, onError context, or a console statement.

Signature

@tokenops/sdk/fhe-airdrop/react

function useFundAirdrop(options?: AirdropClientOptions): UseMutationResult<Hex, Error, FundAirdropArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type FundAirdropArgs. Inspect the type for the full shape (discriminated unions collapse to a tagged variant at call time).

Run it

Connect your wallet and click Fund the Merkle campaign — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

ERC-7984 tokenAirdrop instancePool amount

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 fund = useFundAirdrop({ encryptor: () => sdk });
await fund.mutateAsync({ airdrop: airdropAddress, amount: 1_000_000n });

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 fundAirdrop = useFundAirdrop(/* options */);

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