Setup · deployuseMutation Curated

useCreateConfidentialAirdropAndGetAddress

Deploy an airdrop + wait for receipt + return the clone address.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Setup · deploy

Description

Recommended factory entry point. Deploy a new ConfidentialAirdropCloneable clone and resolve its address from the ConfidentialAirdropCreated event in the tx receipt — in one call.

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

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

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

Signature

@tokenops/sdk/fhe-airdrop/react

function useCreateConfidentialAirdropAndGetAddress(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).

Want to run a similar shape interactively? The Playground ships 8 ready presets across vesting / airdrop / disperse — deploy a manager, create a vesting, claim, and the airdrop / disperse equivalents. The deep-link above auto-selects the closest preset to useCreateConfidentialAirdropAndGetAddress; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const create = useCreateConfidentialAirdropAndGetAddress();
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 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).

patterns/invalidation.ts

import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const createConfidentialAirdropAndGetAddress = useCreateConfidentialAirdropAndGetAddress(/* options */);

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