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

useCreateAndFundMerkleAirdrop

Deploy a Merkle-proof 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 a Merkle-proof 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)). Pass amount (plaintext, encrypted against the hook-level encryptor) or a pre-built encryptedInput, never both.

mode: "uups" is rejected before the wallet is even looked up, so the mutation rejects without prompting for a signature. Returns CreateAirdropResult (or PendingCreateAirdropResult with waitForReceipt: false; both carry every address) unflattened - { hash, airdrop, complianceManager, managerImplementation, complianceDelegate }.

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.

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

Creating from a plan. Pass the PlannedCampaign as plan, with merkleRoot: plan.root. The create then pins plan.predictedAddress, refuses a root that differs from the plan's, and refuses to send once the factory's Merkle implementation has moved since the plan (PredictionDriftError). Both are checked before anything is encrypted. expected: { airdrop: plan.predictedAddress } is the lower-level equivalent of the pin alone.

Beta: not yet validated through a real Safe.

Signature

@tokenops/sdk/fhe-airdrop/react

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

Parameters

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

Example

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

tsx

const createAndFund = useCreateAndFundMerkleAirdrop({ encryptor: () => sdk });
const { airdrop } = await createAndFund.mutateAsync({
  params: { common, merkleRoot: plan.root, isMerkleRootMutable: false },
  mode: "clone",
  userSalt,
  plan,
  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 createAndFundMerkleAirdrop = useCreateAndFundMerkleAirdrop(/* options */);

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