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.

ConfigureuseMutation

useSetCustomFee

Override the factory's default per-claim gas fee for one creator.

Import

@tokenops/sdk/fhe-airdrop/advanced/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Configure

Description

Override the factory's default per-claim gas fee for one creator.

Requires FEE_MANAGER_ROLE.

Invalidates: useFactoryCustomFee({ creator }) for the TARGET creator - variables.creator, never the sending admin. account is the submitter and has no cache entry of its own here, so keying the invalidation off it would refresh the wrong row and leave the edited one stale. Also every useResolveGasFee entry, since an override is what that hook resolves, and every cached usePreflightCreateAirdrop report on this factory, whose fee blockers (the maxGasFee ceiling and GasFeeNotAcceptedError) this write moves.

Signature

@tokenops/sdk/fhe-airdrop/advanced/react

function useSetCustomFee(options?: AirdropClientOptions): UseMutationResult<Hex, Error, SetCustomFeeArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type SetCustomFeeArgs. 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 12 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 useSetCustomFee; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const setCustomFee = useSetCustomFee();
await setCustomFee.mutateAsync({ creator, gasFee: 0n });

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 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 setCustomFee = useSetCustomFee(/* options */);

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