TokenOps
API reference · 230 exports

Every public export, A–Z.

The escape hatch when you know the name. Filter by kind, search the description, click through to the detail page (hooks) or the concept (everything else). The full type signature ships in the published .d.ts; this page is the navigable index over it.

230
NameKindDescription
AccessDeniedError#ErrorCaller lacks the required RBAC role for the call.
AirdropId#TypeBranded Hex for an airdrop clone.
AlreadyClaimedError#ErrorEIP-712 signature already redeemed by this recipient.
BatchTooLargeError#ErrorBatch entries exceed the contract's on-chain cap.
ClaimArgs#TypeDiscriminated union by FeeType for useClaim.
ClaimLockedError#ErrorCliff not reached or schedule paused.
ClaimNotStartedError#ErrorSchedule hasn't started — vesting.start is in the future.
ClaimWindowClosedError#Errorclaim() outside [startTime, endTime].
ContractRevertError#ErrorWraps an on-chain revert the SDK couldn't decode further.
createConfidentialAirdropClient#ClientPer-airdrop client — fund, sign claim, claim, extend window.
createConfidentialAirdropFactoryAdvancedClient#ClientPredict airdrop clone addresses before deploying.
createConfidentialAirdropFactoryClient#ClientFactory client — deploy per-campaign airdrop clones.
createConfidentialDisperseClient#ClientSingleton client — register, fund, disperse, preflight, recover.
createConfidentialVestingFactoryAdvancedClient#ClientPredict manager clone addresses before deploying.
createConfidentialVestingFactoryClient#ClientFactory client — deploy manager clones per user.
createConfidentialVestingManagerClient#ClientManager client — open vestings, claim, disclose, revoke.
createMockEncryptor#FunctionLocal-only encryptor for Anvil + forge-fhevm tests.
createSepoliaEncryptor#FunctionNode-side encryptor wrapping the Zama relayer.
createSepoliaEncryptorWeb#FunctionBrowser-side encryptor wrapping Zama RelayerWeb.
DecryptionFailedError#ErrorUser-decrypt round-trip failed (relayer, KMS, ACL).
DEPLOYED_ADDRESSES#ConstantPer-chain factory + singleton address registry.
DeploymentAddressUnavailableError#ErrorNo DEPLOYED_ADDRESSES entry for (product, contract, chainId).
DisclosureType#TypeWhich view to disclose: vested / claimable / settled / total.
DisperseId#TypeBranded Hex for a disperse subwallet.
DisperseSubwalletNotFoundError#ErroruseDisperse hit a recipient with no registered subwallet.
EncryptedHandle#TypeBranded bytes32 for an FHE ciphertext handle.
EncryptedInput#TypeDiscriminated union of euint64 / euint128 client inputs.
EncryptedViewResult#Type{ handle, hash } returned by encrypted-view mutations.
EncryptionFailedError#ErrorEncryptor refused or returned invalid ciphertext/proof.
Encryptor#TypeInterface for the Zama relayer abstraction.
EncryptorSource#TypeEager Encryptor | () => Encryptor | undefined.
encryptUint64#FunctionEncrypt a single uint64 with the given encryptor source.
encryptUint64Batch#FunctionEncrypt N uint64 values in one batch input proof.
ERC7984_OPERATOR_MAX_DEADLINE#ConstantMax far-future deadline for ERC-7984 operator approvals.
FeatureDisabledError#ErrorFeature disabled at clone-time (e.g. split on a non-split manager).
FeeType#TypeGas-side vs token-side fee discriminant.
FHE_SPLIT_DENOMINATOR#Constant10^18 — bigint denominator for ratio scaling.
FheHandleNotAllowedError#ErrorCaller lacks ACL on the handle they tried to decrypt.
getFheAirdropFactoryAddress#FunctionDEPLOYED_ADDRESSES accessor for the airdrop factory.
getFheDisperseSingletonAddress#FunctionDEPLOYED_ADDRESSES accessor for the disperse singleton.
getFheVestingFactoryAddress#FunctionDEPLOYED_ADDRESSES accessor for the vesting factory.
InsufficientBalanceError#ErrorEncrypted source balance is below the requested amount.
InsufficientGasFundsError#ErrorWallet ETH balance below estimated gas + buffer.
InvalidArgumentError#ErrorArgument shape rejected by an SDK validation boundary.
InvalidSignatureError#ErrorEIP-712 signature bytes are malformed (length, s-range).
mintMockERC7984#FunctionTest-only mint helper for the mock ERC-7984 token.
MissingEncryptorError#ErrorHook requires an encryptor source but none was passed.
NetworkError#ErrorRPC/transport failure during read or write.
PausedError#ErrorContract is paused; write-side calls revert until unpaused.
PreflightResult#Type{ ok, gasEstimate } | { ok: false, reasons }.
resolveEncryptor#FunctionEager-or-lazy encryptor resolution helper.
scaleRatio#FunctionScale a fractional ratio to FHE_SPLIT_DENOMINATOR.
SdkTelemetry#TypeAdapter interface for the SDK's event surface.
setOperator#FunctionApprove an operator for an ERC-7984 confidential token.
share#FunctionCompute a numerator / denominator share for FHE splits.
signClaimAuthorization#FunctionAdmin signs EIP-712 Claim(recipient, encryptedAmountHandle).
TransferAlreadyPendingError#ErroruseInitiateVestingTransfer while a prior transfer is pending.
TransferExpiredError#ErroruseAcceptVestingTransfer after the offer expired.
UnsupportedChainError#ErrorWallet chain does not match the SDK client's chain.
useAcceptVestingTransfer#HookAccept an inbound vesting transfer (counterparty side).
useAccessEncryptedFeeReserve#HookMUTATION — submits a transaction (costs gas). Mirrors the on-chain accessEncryptedFeeReserve(token) function: grants the caller persistent decrypt access to the encrypted token fee reserve as an euint64 handle.
useAdminBatchDiscloseToParty#HookAdmin variant of useBatchDiscloseToParty — caller must hold DISCLOSURE_ADMIN_ROLE.
useAdminClaim#HookAdmin variant of useClaim — caller must hold CLAIMER_ROLE.
useAdminDiscloseToParty#HookAdmin variant of useDiscloseToParty — caller must hold DISCLOSURE_ADMIN_ROLE.
useAdminGetClaimableAmount#HookAdmin variant of useGetClaimableAmount — caller must hold DISCLOSURE_ADMIN_ROLE.
useAdminGetSettledAmount#HookAdmin variant of useGetSettledAmount — caller must hold DISCLOSURE_ADMIN_ROLE.
useAdminGetTokenBalance#HookAdmin: read the manager clone's confidential ERC-7984 token balance as an euint64 handle.
useAdminGetTotalAllocation#HookAdmin variant of useGetTotalAllocation — caller must hold DISCLOSURE_ADMIN_ROLE.
useAdminGetVestedAmount#HookAdmin variant of useGetVestedAmount — caller must hold DISCLOSURE_ADMIN_ROLE.
useAdminPartialClaim#HookAdmin variant of usePartialClaim — caller must hold CLAIMER_ROLE.
useAirdropCanExtendClaimWindow#HookRead whether the admin can extend the claim window past endTime on this airdrop clone.
useAirdropClaimedSignatures#HookCheck whether a pre-computed claim struct hash has been consumed on this airdrop clone.
useAirdropClaimTypehash#HookRead the EIP-712 type hash for Claim(address recipient, bytes32 encryptedAmount).
useAirdropDeploymentBlockNumber#HookRead the block number at which this airdrop clone was deployed.
useAirdropDomainSeparator#HookRead the EIP-712 domain separator for this airdrop clone.
useAirdropEndTime#HookRead the airdrop clone's endTime — the unix timestamp when claims close.
useAirdropGasFee#HookRead the airdrop clone's immutable per-claim gas fee (in wei).
useAirdropGrantRole#HookAccessControl: grant role to accountTarget on this airdrop clone.
useAirdropHasClaimEnded#HookRead whether the current chain timestamp is past endTime on this airdrop clone.
useAirdropHasClaimStarted#HookRead whether the current chain timestamp is past START_TIME on this airdrop clone.
useAirdropHasRole#HookRead AccessControl: is account a member of role on this airdrop clone? The role hashes are stable across deployments (DEFAULT_ADMIN_ROLE, FEE_COLLECTOR_ROLE, etc.).
useAirdropIsClaimWindowActive#HookReturns true between startTime and endTime per the on-chain config.
useAirdropIsPaused#HookRead whether claims are currently paused by the admin on this airdrop clone.
useAirdropIsSignatureClaimed#HookHas this admin signature already been redeemed?
useAirdropIsSignatureValid#HookOff-chain check of the signature shape before paying gas to submit it.
useAirdropRevokeRole#HookAccessControl: revoke role from accountTarget on this airdrop clone.
useAirdropStartTime#HookRead the airdrop clone's immutable START_TIME — the unix timestamp when claims become available.
useAirdropToken#HookRead the airdrop clone's immutable TOKEN.
useAirdropWithdrawGasFee#HookFee collector: withdraw collected ETH gas fees from the airdrop clone.
useAllRecipients#HookEvery recipient currently registered on this manager.
useAllRecipientsLength#HookCount of registered recipients (cheap pre-paging check).
useAllRecipientsSliced#HookRead a [start, end) slice of the recipients set.
useApproveTokenOnWallets#HookApprove the subwallets to transferFromConfidential for the listed tokens.
useBatchCreateVesting#HookBatch variant of useCreateVesting — open N vestings in one tx with one batch input proof.
useBatchDiscloseHandlesToParty#HookBatch ACL grant across many handles in one tx.
useBatchDiscloseHandlesToParty#HookBatch ACL grant across many handles in one tx.
useBatchDiscloseToParty#HookBatch variant of useDiscloseToParty.
useBatchRevokeVesting#HookBatch variant of useRevokeVesting.
useCalculateFee#HookQuote the on-chain fee config for a given disperse batch shape (count + mode).
useCancelVestingTransfer#HookCancel an outbound transfer before the counterparty accepts.
useClaim#HookRecipient-side claim. For FeeType.Gas managers pass value (read it with useManagerFeeInfo); omit value for FeeType.DistributionToken.
useClaim#HookClaim tokens from an airdrop using an EIP-712 admin signature.
useConfidentialAirdropFactoryImplementation#HookRead the FHE-airdrop factory's current implementation() address — the LibClone target every new airdrop clone delegates to.
useConfidentialVestingFactoryImplementation#HookRead the FHE-vesting factory's current implementation() address — the LibClone target every new manager clone delegates to.
useCreateAndFundConfidentialAirdrop#HookSingle-flow helper: deploy + fund in one bundle.
useCreateAndFundConfidentialAirdropAndGetAddress#HookSame as useCreateAndFundConfidentialAirdrop but returns the clone address.
useCreateConfidentialAirdrop#HookDeploy an airdrop clone for a token + admin + claim window.
useCreateConfidentialAirdropAndGetAddress#HookDeploy an airdrop + wait for receipt + return the clone address.
useCreateManager#HookDeploy a per-user vesting manager clone via the factory.
useCreateManagerAndGetAddress#HookDeploy a manager and wait for the receipt — returns the deterministic clone address.
useCreateVesting#HookOpen a new vesting schedule on a manager — encrypts the amount client-side, submits the tx.
useDecryptedHandle#HookSubscribe to a single encrypted handle and reactively decrypt via the connected wallet.
useDeploymentBlockNumber#HookRead the block number at which the singleton was deployed — useful as the fromBlock argument to getLogs when subscribing to events.
useDirectVestingTransfer#HookAdmin-driven transfer — moves a vesting without the recipient's signature.
useDisableCustomFee#HookAdmin: disable the per-creator fee override for creator.
useDisableCustomFee#HookAdmin: remove a per-creator fee override, reverting to defaultGasFee.
useDisableCustomFee#HookAdmin: remove a per-user fee override, falling back to the global defaults.
useDiscloseHandleToParty#HookGrant ACL on a single ciphertext handle to a third party (e.g. an auditor).
useDiscloseHandleToParty#HookGrant ACL on a single ciphertext handle to a third party (e.g. an auditor).
useDiscloseToParty#HookGrant ACL on a full vesting (allocation + settled + claimable) to a third party.
useDisperse#HookMulti-recipient confidential transfer in one tx — batch-encrypts amounts + per-recipient ACL.
useExtendClaimWindow#HookAdmin extends the claim deadline.
useFactoryCustomFee#HookRead the per-creator fee override set on the factory for creator.
useFactoryCustomFee#HookRead the per-creator fee override set on the factory for creator.
useFactoryDefaultFeeType#HookRead the factory-wide default fee model (FeeType.Gas or FeeType.DistributionToken) applied to newly-created manager clones.
useFactoryDefaultGasFee#HookRead the factory-wide default gas fee (in wei) — applied to new FeeType.Gas manager clones at deployment.
useFactoryDefaultGasFee#HookRead the factory-wide default per-claim gas fee (in wei) — applied to new airdrop clones at deployment when the creator has no custom override.
useFactoryDefaultTokenFee#HookRead the factory-wide default token fee in basis points — applied to new FeeType.DistributionToken manager clones at deployment.
useFactoryFeeCollector#HookRead the factory's current fee collector address.
useFactoryFeeCollector#HookRead the factory's current fee collector address — the account authorized to call withdrawGasFee on each deployed airdrop clone.
useFactoryInitCodeHash#HookRead the init-code hash the factory would use to CREATE2 a manager clone with the given token + deployer (+ optional immutable flags).
useFactoryInitCodeHash#HookRead the init-code hash the factory would use to CREATE2 an airdrop clone with the given params + gasFee.
useFundConfidentialAirdrop#HookEncrypt the funding amount and transferFromConfidential into the clone.
useGetBatchLimits#HookRead the maximum batch size for each of the three disperse modes ("wallet", "direct", "wallet-token-fee").
useGetClaimableAmount#HookEncrypted-view read: min(vested, balance) - settled. Pair with useDecryptedHandle.
useGetClaimAmount#HookSubmits a transaction (costs gas) to grant the caller decrypt access to the claim amount as an euint64 handle. The handle is granted persistent ACL on-chain via FHE.allow(handle, msg.sender); the SDK extracts it from the receipt's ACL.Allowed event (NOT from simulation — that returns a divergent, ACL-less handle; see CLAUDE.md Pitfall #1).
useGetEncryptedFeeReserve#HookMUTATION — submits a transaction (costs gas). Mirrors the on-chain accessEncryptedFeeReserve(token) function: grants the caller persistent decrypt access to the encrypted token fee reserve as an euint64 handle.
useGetFeeConfig#HookRead the singleton's { gasFeeEnabled, tokenFeeEnabled, defaultGasFee, defaultTokenFee } fee config.
useGetFees#HookRead consolidated fee information for user — combines per-user resolved fees (getFeeAmounts) with the global feeConfig toggles in one read.
useGetSettledAmount#HookEncrypted-view read: running settled total. Pair with useDecryptedHandle.
useGetTotalAllocation#HookEncrypted-view read: original allocation. Pair with useDecryptedHandle.
useGetVestedAmount#HookEncrypted-view read: time-unlocked total. Pair with useDecryptedHandle.
useGetWallets#HookRead the deployer's two registered subwallet addresses.
useGrantRole#HookAccessControl: grant role to accountTarget.
useGrantRole#HookAccessControl: grant role to accountTarget on the singleton.
useHasApprovedSubwallets#HookCheck whether a user's registered subwallets have approved the singleton as an ERC-7984 operator for token.
useHasRole#HookRead AccessControl: is account a member of role on this manager? The role hashes are stable across deployments — see useRoleConstants if you need to look them up dynamically.
useHasRole#HookRead AccessControl: is account a member of role on the singleton? All five role constants (DEFAULT_ADMIN_ROLE, FEE_MANAGER_ROLE, FEE_COLLECTOR_ROLE, PAUSER_ROLE, WITHDRAWER_ROLE) are exported from @tokenops/sdk/fhe-disperse/react.
useInitiateVestingTransfer#HookRecipient initiates a two-step transfer of a vesting position to another recipient.
useIsPaused#HookRead the singleton's paused flag.
useIsRecipient#HookRead whether account is currently a recipient on this manager clone.
useIsRegistered#HookHas this deployer already called register?
useManagerDeploymentBlockNumber#HookRead the manager clone's immutable DEPLOYMENT_BLOCK_NUMBER — the block at which the factory deployed this clone via LibClone.
useManagerFee#HookRead the manager clone's immutable FEE (in wei for FeeType.Gas, in basis points for FeeType.DistributionToken).
useManagerFeeInfo#HookResolves { feeType, fee } — caller passes the right branch to useClaim.
useManagerFeeType#HookRead the manager clone's immutable FEE_TYPE (FeeType.Gas or FeeType.DistributionToken).
useManagerIsPausable#HookRead whether the manager clone has pause/unpause enabled (immutable).
useManagerIsSplitEnabled#HookRead whether the manager clone has split-vesting enabled (immutable).
useManagerMaxBatchSize#HookRead the manager clone's maxBatchSize — upper bound for batchCreateVesting.
useManagerMaxRevokeBatchSize#HookRead the manager clone's maxRevokeBatchSize — upper bound for batchRevokeVesting.
useManagerPaused#HookRead whether the manager clone is currently paused.
useManagerToken#HookThe manager clone's immutable underlying token address.
usePartialClaim#HookClaim less than the unlocked amount — leaves the remainder encrypted on the clone.
usePause#HookPauser: pause the manager clone — blocks claim, partialClaim, createVesting, etc.
usePause#HookAdmin: pause all disperse operations on the singleton.
usePendingVestingTransfer#HookRead the pending transfer (if any) on a vesting — returns { newRecipient, initiatedAt, expiresAt }.
usePredictAirdropAddress#HookCREATE2 the airdrop clone address before deploying.
usePredictManagerAddress#HookCREATE2 the manager clone address before deploying — pre-flight UI flows.
usePredictWallets#HookCompute the deterministic subwallet addresses for a deployer without registering.
usePreflightDisperse#HookDry-run validator — checks operator + balance + paused state before broadcasting.
useRecipientVestings#HookRead all vesting IDs owned by recipient.
useRecipientVestingsLength#HookRead the number of vesting schedules owned by recipient.
useRecipientVestingsSliced#HookRead a [start, end) slice of recipient's vesting IDs.
useRecoverERC20FromWallets#HookRecover ERC-20 tokens accidentally sent to the caller's registered wallets.
useRecoverFromWallets#HookRecover residual confidential ERC-7984 tokens from the caller's registered wallets to to.
useRegister#HookFirst-time setup for a deployer — singleton creates the two ERC-1167 subwallets.
useRenounceRole#HookAccessControl: renounce role from msg.sender.
useRescueConfidentialTokens#HookSweep stranded confidential tokens out of a subwallet (admin-only).
useRescueERC20#HookSweep stranded plain ERC-20 tokens (e.g. someone sent the wrong token).
useResetGasFee#HookAdmin: reset the factory's default gas fee to its bytecode-encoded baseline.
useResetTokenFee#HookAdmin: reset the factory's default token fee to its bytecode-encoded baseline.
useRevokeRole#HookAccessControl: revoke role from accountTarget.
useRevokeRole#HookAccessControl: revoke role from accountTarget on the singleton.
useRevokeTokenOnWallets#HookRevoke operator approval on the subwallets (rollback).
useRevokeVesting#HookAdmin revocation — clears the schedule (revocable variants only) and returns funds.
useRoleConstants#HookRead all eight AccessControl role hashes off the manager in one fan-out.
UserRejectedSignatureError#ErrorUser rejected the wallet signature prompt.
useSetCustomFee#HookAdmin: install a per-creator fee override on the factory.
useSetCustomFee#HookAdmin: install a per-creator gas-fee override on the factory.
useSetCustomFee#HookAdmin: install a per-user fee override (gas fee in wei, token fee in BPS).
useSetDefaultFeeType#HookAdmin: set the factory's default fee model (FeeType.Gas or FeeType.DistributionToken) for new manager clones.
useSetDefaultGasFee#HookAdmin: set the factory-wide default gas fee (in wei).
useSetDefaultGasFee#HookAdmin: change the factory-wide default per-claim gas fee.
useSetDefaultTokenFee#HookAdmin: set the factory-wide default token fee (basis points).
useSetFeeCollector#HookAdmin: set the factory's fee collector address.
useSetFeeCollector#HookAdmin: change the factory's fee collector address.
useSetFeeConfig#HookAdmin: update the global fee configuration — enable/disable gas and token fees, set the defaults.
useSetMaxBatchSize#HookAdmin: bump or lower maxBatchSize (cap for useBatchCreateVesting).
useSetMaxBatchSizeDirect#HookAdmin: set the maximum batch size for "direct" mode disperses.
useSetMaxBatchSizeHolding#HookAdmin: set the maximum batch size for "wallet" mode disperses.
useSetMaxBatchSizeTokenFee#HookAdmin: set the maximum batch size for "wallet-token-fee" mode disperses.
useSetMaxRevokeBatchSize#HookAdmin: bump or lower maxRevokeBatchSize (cap for useBatchRevokeVesting).
useSetPaused#HookAdmin: pause or unpause claims on this airdrop clone.
useSignClaimAuthorization#HookAdmin signs the off-chain EIP-712 Claim(recipient, encryptedAmountHandle) message.
useSplitVesting#HookSplit one vesting into two with custom proportions; both stay encrypted.
useTransferFeeCollectorRole#HookTransfer the FEE_COLLECTOR_ROLE to newCollector.
useUnpause#HookPauser: unpause the manager clone.
useUnpause#HookAdmin: unpause the singleton.
useVestingInfo#HookPlaintext schedule shape (start / end / cliff / interval) + encrypted-handle metadata.
useWalletImplementation#HookRead the WALLET_IMPLEMENTATION address — the singleton clones this deterministically (Clones.cloneDeterministic) for each registered user to derive their wallet pair.
useWithdraw#HookAdmin: withdraw all confidential tokens from the airdrop to recipient.
useWithdrawAdmin#HookAdmin: withdraw an encrypted amount of the manager's distribution token to msg.sender.
useWithdrawGasFee#HookFee collector: withdraw collected gas-fee ETH (FeeType.Gas managers).
useWithdrawGasFee#HookFee-collector: withdraw amount wei of accumulated ETH gas fees from the singleton to to.
useWithdrawOtherConfidentialToken#HookAdmin: rescue an ERC-7984 (confidential) token other than this manager's configured token.
useWithdrawOtherConfidentialToken#HookAdmin: rescue accidentally sent ERC-7984 confidential tokens (other than this airdrop's configured TOKEN).
useWithdrawOtherToken#HookAdmin: rescue an ERC-20 (non-confidential) other than this manager's configured token.
useWithdrawOtherToken#HookAdmin: rescue accidentally sent ERC-20 (non-confidential) tokens.
useWithdrawTokenFee#HookFee collector: withdraw collected distribution-token fees (FeeType.DistributionToken managers).
useWithdrawTokenFee#HookFee-collector: withdraw accumulated encrypted token fees.
VestingExpiredError#ErrorSchedule passed its end timestamp; nothing left to claim.
VestingId#TypeBranded Hex for a vesting position.
VestingInfo#TypePlaintext schedule shape + encrypted-handle metadata.
VestingNotFoundError#ErrorvestingId not registered on the manager.
VestingNotRevocableError#ErroruseRevokeVesting on a vesting created with isRevocable=false.
VestingParams#TypeConstructor args for createVesting.
VestingRevokedError#ErrorOperator revoked this vesting — claims return revoked state.
WalletChainMismatchError#ErrorWallet chain differs from the SDK client's chain.
WalletRejectedError#ErrorUser rejected the tx prompt at the wallet.
withTelemetry#FunctionWrap an SDK client with an SdkTelemetry adapter.