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 · deployuseMutation

useCreateMerkleAirdrop

Deploy a Merkle-proof airdrop instance via the factory.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Setup · deploy

Description

Deploy a Merkle-proof airdrop instance via the factory.

Returns the headless client's CreateAirdropResult (or PendingCreateAirdropResult with waitForReceipt: false; both carry every address) unchanged - { hash, airdrop, complianceManager, managerImplementation, complianceDelegate }.

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.

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). 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 useCreateMerkleAirdrop(options?: AirdropClientOptions): UseMutationResult<CreateAirdropResult | PendingCreateAirdropResult, Error, CreateMerkleAirdropVariables>;

Parameters

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

Run it

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

Interactive · live Sepolia tx

ERC-7984 tokenUser salt

Loading editor…

Edit any input above, then press ⌘↵ to run.

Console0 lines

No output yet. Run the snippet to see logs stream in.

Examples

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

tsx

const create = useCreateMerkleAirdrop();
const { airdrop } = await create.mutateAsync({
  params: { common, merkleRoot, isMerkleRootMutable: true },
  mode: "clone",
  userSalt,
});

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

tsx

// From a plan (immutable root):
await create.mutateAsync({
  params: { ...params, merkleRoot: plan.root, isMerkleRootMutable: false },
  mode: "clone",
  userSalt,
  plan,
});

Pulled directly from the hook's TSDoc blocks — 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 createMerkleAirdrop = useCreateMerkleAirdrop(/* options */);

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