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.

Setup · deployuseMutationencrypts input

useCreateAndFundEcdsaAirdrop

Deploy an ECDSA-authorised airdrop instance and seed its pool in one transaction.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Setup · deploy

Description

Deploy an ECDSA-authorised airdrop instance and seed its pool in one transaction.

Prerequisite: the funder must already have approved the factory as an ERC-7984 operator on the token (token.setOperator(factoryAddress, deadline)) — the factory pulls the pool via confidentialTransferFrom. Pass amount (plaintext, encrypted against the hook-level encryptor) or a pre-built encryptedInput, never both.

Returns CreateAirdropResult (or PendingCreateAirdropResult with waitForReceipt: false; both carry every address) unflattened - { hash, airdrop, complianceManager, managerImplementation, complianceDelegate }; the caller needs the instance address to do anything with the campaign afterwards.

A successful receipt does not prove the pool was funded. An ERC-7984 transfer moves an encrypted zero instead of reverting when the funder is short, because reverting would leak the balance.

Safe / multisig signers: pass waitForReceipt: false; see ReceiptMode.

Invalidates: the factory's registry pages, every cached isAirdrop answer, every cached create preflight (the salt is now consumed), and the useTokenOf / useComplianceManagerOf entries for the new address, which may hold a zero read before the create. No read hook here caches the confidential pool balance, so the fund leg moves nothing else.

Never log `amount`. It is the one plaintext confidential value this hook sees — keep it out of telemetry, onError context and console.

Beta: not yet validated through a real Safe.

Signature

@tokenops/sdk/fhe-airdrop/react

function useCreateAndFundEcdsaAirdrop(options?: AirdropClientOptions): UseMutationResult<CreateAirdropResult | PendingCreateAirdropResult, Error, CreateAndFundEcdsaAirdropArgs>;

Parameters

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

Example

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

tsx

const createAndFund = useCreateAndFundEcdsaAirdrop({ encryptor: () => sdk });
const { airdrop } = await createAndFund.mutateAsync({
  params: { common, signer, dedupMode: "perAddress" },
  mode: "clone",
  userSalt,
  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 createAndFundEcdsaAirdrop = useCreateAndFundEcdsaAirdrop(/* options */);

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