useCreateConfidentialAirdrop
Deploy an airdrop clone for a token + admin + claim window.
@tokenops/sdk/fhe-airdrop/react{ mutate, mutateAsync, isPending, error, data }Description
Deploy a new airdrop clone via the factory. Raw-hash-only variant — parse
the ConfidentialAirdropCreated event yourself if you need the address.
For the common "deploy and learn the address" flow, prefer
`useCreateConfidentialAirdropAndGetAddress` — it's a one-call wrapper
that returns { hash, airdrop }.
After a successful create, invalidate factory queries that depend on per-creator state:
const queryClient = useQueryClient();
const create = useCreateConfidentialAirdrop();
create.mutate(args, {
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-airdrop"] });
},
});Signature
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.
Example
const create = useCreateConfidentialAirdrop();
create.mutate({ params, userSalt });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 viem-passthrough 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).
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"],
});
},
});See also
Other Setup · deploy hooks in airdrop:
useCreateConfidentialAirdropAndGetAddressDeploy an airdrop + wait for receipt + return the clone address.useCreateAndFundConfidentialAirdropSingle-flow helper: deploy + fund in one bundle.useCreateAndFundConfidentialAirdropAndGetAddressSame as useCreateAndFundConfidentialAirdrop but returns the clone address.