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

useSetMaxGasFee

Set the factory's ceiling on every fee setDefaultGasFee / setCustomFee may configure, and on the fee resolved at create.

Import

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

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Configure

Description

Set the factory's ceiling on every fee setDefaultGasFee / setCustomFee may configure, and on the fee resolved at create.

Requires DEFAULT_ADMIN_ROLE, deliberately not FEE_MANAGER_ROLE: the fee manager moves fees only within a bound the admin owns. This is the one fee control that is not a fee-manager operation.

Lowering it does not rewrite an already-configured fee. The stale value stays in storage and reverts GasFeeExceedsMaximum at the next create until it is lowered too, so a reduction is two steps, not one.

Invalidates: this factory's useFactoryFees entry (fn "fees", which carries maxGasFee) and every useResolveGasFee entry. The ceiling is checked at create time, and lowering it below existing fees is allowed: a create whose resolved fee is above it then reverts GasFeeExceedsMaximum. Deliberately NOT any instance's fn "gasFee" key - an instance's fee is frozen at create and cannot move. Also every cached usePreflightCreateAirdrop report on this factory: the preflight reports a resolved fee above the ceiling as a blocker, so the new ceiling must reach it.

Signature

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

function useSetMaxGasFee(options?: AirdropClientOptions): UseMutationResult<Hex, Error, SetMaxGasFeeArgs>;

Parameters

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

Example

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

tsx

const setCeiling = useSetMaxGasFee();
await setCeiling.mutateAsync({ maxGasFee: parseEther("0.5") });

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 setMaxGasFee = useSetMaxGasFee(/* options */);

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