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
useClaimedAmount
Read account's cumulative delivered total on a MerkleConfidentialAirdrop instance, as an encrypted handle — pass it to the Zama relayer's userDecrypt to see the plaintext.
Import
@tokenops/sdk/fhe-airdrop/reactReturn
{ data, isLoading, error, refetch }Lifecycle
ReadDescription
Read account's cumulative delivered total on a MerkleConfidentialAirdrop
instance, as an encrypted handle — pass it to the Zama relayer's
userDecrypt to see the plaintext.
Caller-specific — `account` is part of the cache key. Switching the
connected account (or checking a different address) never serves a value
cached for the previous account; see airdropQueryKey.
Signature
@tokenops/sdk/fhe-airdrop/react
ts
function useClaimedAmount(args: UseClaimedAmountArgs): UseQueryResult<EncryptedHandle, Error>;Parameters
Shape of the options object passed to the hook itself.
| Property | Type | Description |
|---|---|---|
| account | Address | The account whose cumulative delivered total to read. |
Example
@tokenops/sdk/fhe-airdrop/react · @example
tsx
const { data: claimedHandle } = useClaimedAmount({ address, account });Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.
See also
Other Read hooks in airdrop v2:
useAirdropTokenRead the ERC-7984 token an airdrop instance distributes.useAirdropWindowRead an airdrop instance's claim-window snapshot in one round trip.useAirdropGasFeeRead the per-claim ETH fee (wei) an instance charges; 0n on a fee-free campaign.useMerkleRootRead a MerkleConfidentialAirdrop instance's currently published root.