Setup · deployuseMutation Curated

useCreateConfidentialAirdrop

Deploy an airdrop clone for a token + admin + claim window.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Setup · deploy

Description

Deploy a new airdrop clone via the factory.

Returns { hash, airdrop } — the clone address is parsed from the ConfidentialAirdropCreated event in the receipt. This call waits for the receipt before resolving.

Internally: createConfidentialAirdrop → waitForTransactionReceipt → parseEventLogs({ eventName: "ConfidentialAirdropCreated" }).

useCreateConfidentialAirdropAndGetAddress is a direct alias and behaves identically.

After a successful create, invalidate factory queries that depend on per-creator state:

const queryClient = useQueryClient();
const create = useCreateConfidentialAirdrop();
create.mutate(args, {
  onSuccess: ({ airdrop }) => {
    queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-airdrop"] });
    navigate(`/airdrop/${airdrop}`);
  },
});

Signature

@tokenops/sdk/fhe-airdrop/react

function useCreateConfidentialAirdrop(options?: FactoryHookOptions): UseMutationResult<CreateAirdropResult, Error, CreateAirdropArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type CreateAirdropArgs. 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 an airdrop — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

ERC-7984 tokenAdmin / signer addressHolder of DEFAULT_ADMIN_ROLE — signs EIP-712 claim messages.Claim window length (days)

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 create = useCreateConfidentialAirdrop();
create.mutate({ params, userSalt });
// create.data → { hash, airdrop }

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 › 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 createConfidentialAirdrop = useCreateConfidentialAirdrop(/* options */);

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