SDK 2.1: platform toolkit + vesting engine
1.x: critical fixes onlyView 2.x docs
Setup · deployuseMutationencrypts input Curated

useCreateAndFundConfidentialAirdropAndGetAddress

Same as useCreateAndFundConfidentialAirdrop but returns the clone address.

Import
@tokenops/sdk/fhe-airdrop/react
Return
{ mutate, mutateAsync, isPending, error, data }
Lifecycle
Setup · deploy

Description

Recommended fund-on-create entry point. Deploy AND fund a new airdrop clone in one tx, then resolve its address from the ConfidentialAirdropCreated event in the receipt.

Use this in place of useCreateAndFundConfidentialAirdrop when you need the deployed clone address — for example to navigate to a detail page immediately after the deploy.

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

Silent-zero transfers. ERC-7984 transfers do not revert when the sender's encrypted balance is insufficient — the transfer succeeds and moves an encrypted zero instead. This is by design: reverting would leak balance information. The transaction receipt alone cannot tell you whether value actually moved.

Amount units: TokenOps confidential (ERC-7984) tokens use a 6-decimals convention (1 token = 1_000_000 base units), not the 18 decimals typical of ERC-20. Amount parameters are base units of the token's actual decimals: for the CTTT test token (6 decimals) 1_000_000n = 1 CTTT, while the transparent TTT test token uses 18 decimals.

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

function Component() {
  const queryClient = useQueryClient();
  const zamaSDK = useZamaSDK();
  const create = useCreateAndFundConfidentialAirdropAndGetAddress({
    encryptor: () => zamaSDK.relayer,
  });
  create.mutate(args, {
    onSuccess: ({ airdrop }) => {
      queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-airdrop"] });
      navigate(`/airdrop/${airdrop}`);
    },
  });
}

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useCreateAndFundConfidentialAirdropAndGetAddress(options?: FactoryHookOptions): UseMutationResult<CreateAirdropResult, Error, CreateAndFundAirdropArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type CreateAndFundAirdropArgs. 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 / faucet — deploy a manager, create a vesting, claim, and run the product equivalents. The deep-link above auto-selects the closest preset to useCreateAndFundConfidentialAirdropAndGetAddress; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/react · @example
tsx
const create = useCreateAndFundConfidentialAirdropAndGetAddress();
create.mutate({ params, userSalt, amount });
// 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
ts
import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const createAndFundConfidentialAirdropAndGetAddress = useCreateAndFundConfidentialAirdropAndGetAddress(/* options */);

createAndFundConfidentialAirdropAndGetAddress.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: