ConfigureuseMutation

useSetMaxBatchSizeDirect

Admin: set the maximum batch size for "direct" mode disperses.

Import

@tokenops/sdk/fhe-disperse/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Configure

Description

Admin: set the maximum batch size for "direct" mode disperses. 0n = no limit. Requires DEFAULT_ADMIN_ROLE.

After success, invalidate useGetBatchLimits.

Signature

@tokenops/sdk/fhe-disperse/react

function useSetMaxBatchSizeDirect(options?: DisperseHookOptions): UseMutationResult<Hex, Error, UseSetMaxBatchSizeDirectArgs>;

Parameters

Shape of the object you pass to .mutate(args).

Property	Type	Description
sizerequired	bigint	Max recipients in a single `"direct"` mode call. `0n` = no limit.
account	Account \| Address	Override signer account. Falls back to `walletClient.account`.

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 useSetMaxBatchSizeDirect; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const setLimit = useSetMaxBatchSizeDirect();
setLimit.mutate({ size: 128n });

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 Disperse › 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 setMaxBatchSizeDirect = useSetMaxBatchSizeDirect(/* options */);

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