2.0 RC docsView 1.x docs
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.
ReaduseQuery

useGetBatchLimits

Read the maximum batch size for each of the three disperse modes ("wallet", "direct", "wallet-token-fee").

Import
@tokenops/sdk/fhe-disperse/react
Return
{ data, isLoading, error, refetch }
Lifecycle
Read

Description

Read the maximum batch size for each of the three disperse modes ("wallet", "direct", "wallet-token-fee"). 0n means no limit.

Signature

@tokenops/sdk/fhe-disperse/react
ts
function useGetBatchLimits(options?: BaseHookOptions & ReadHookQueryOptions<BatchLimits>): UseQueryResult<BatchLimits, Error>;
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 useGetBatchLimits; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-disperse/react · @example
tsx
const { data: limits } = useGetBatchLimits();
// limits → { holding, direct, tokenFee }

Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.

See also

Other Read hooks in disperse 2.0: