API reference · 383 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.
383
| Name | Kind | Subpath | Description |
|---|---|---|---|
| AccessDeniedError# | Error | @tokenops/sdk | Caller lacks the required RBAC role for the call. |
| AirdropId# | Type | @tokenops/sdk | Branded Hex for an airdrop clone. |
| AirdropParams# | Type | …/fhe-airdrop | Parameters for creating a confidential airdrop. |
| AlreadyClaimedError# | Error | …/fhe-airdrop | EIP-712 signature already redeemed by this recipient. |
| AlreadyInitializedError# | Error | @tokenops/sdk | Contract has already been initialized — initialize() may only run once. |
| AlreadyRegisteredError# | Error | …/fhe-disperse | The user has already registered — register(token) is single-use per user. |
| asAirdropId# | Function | …/fhe-airdrop | Mark a raw Hex value as an AirdropId. |
| asEncryptedHandle# | Function | …/fhe-airdrop | Mark a raw Hex value as an EncryptedHandle. |
| assertTestnetFaucetChain# | Function | …/testnet-faucet | Throws UnsupportedChainError off Sepolia (11155111) / local Anvil (31337). |
| BatchCreateVestingArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| BatchDiscloseHandlesArgs# | Type | …/fhe-disperse | Arguments for batchDiscloseHandlesToParty(). |
| BatchDiscloseToPartyResult# | Type | …/fhe-vesting | Result of ConfidentialVestingManagerClient.batchDiscloseToParty / ConfidentialVestingManagerClient.adminBatchDiscloseToParty. |
| BatchLimits# | Type | …/fhe-disperse | Batch size limits. |
| BatchTooLargeError# | Error | @tokenops/sdk | Batch entries exceed the contract's on-chain cap. |
| CalculatedFee# | Type | …/fhe-disperse | Calculated fee for a specific disperse call. |
| CalculateFeeArgs# | Type | …/fhe-disperse | Arguments for calculateFee(). |
| ClaimArgs# | Type | …/fhe-vesting | Discriminated union by FeeType for useClaim. |
| ClaimLockedError# | Error | …/fhe-vesting | Cliff not reached or schedule paused. |
| ClaimNotStartedError# | Error | …/fhe-airdrop | Airdrop claim window has not opened yet; startsAt timestamp is in the future. |
| ClaimWindowClosedError# | Error | …/fhe-airdrop | claim() outside [startTime, endTime]. |
| computeSubtotals# | Function | …/fhe-disperse | Function exported from @tokenops/sdk/fhe-disperse. |
| ConfidentialAirdropClient# | Client | …/fhe-airdrop | Typed wrapper around a deployed ConfidentialAirdropCloneable clone. |
| ConfidentialAirdropClientConfig# | Type | …/fhe-airdrop | Type exported from @tokenops/sdk/fhe-airdrop. |
| confidentialAirdropCloneableAbi# | Constant | …/fhe-airdrop | Constant exported from @tokenops/sdk/fhe-airdrop. |
| confidentialAirdropFactoryAbi# | Constant | …/fhe-airdrop | Constant exported from @tokenops/sdk/fhe-airdrop. |
| ConfidentialAirdropFactoryAdvancedClient# | Client | …/fhe-airdrop/advanced | Advanced extension of ConfidentialAirdropFactoryClient that re-exposes the CREATE2 address prediction read. |
| ConfidentialAirdropFactoryClient# | Client | …/fhe-airdrop | Typed wrapper around the deployed ConfidentialAirdropFactory. |
| ConfidentialAirdropFactoryClientConfig# | Type | …/fhe-airdrop | Type exported from @tokenops/sdk/fhe-airdrop. |
| ConfidentialDisperseClient# | Client | …/fhe-disperse | Typed SDK wrapper for the deployed DisperseConfidential singleton. |
| ConfidentialDisperseClientConfig# | Type | …/fhe-disperse | Type exported from @tokenops/sdk/fhe-disperse. |
| confidentialTokenopsTestTokenAbi# | Constant | …/testnet-faucet | Constant exported from @tokenops/sdk/testnet-faucet. |
| confidentialVestingFactoryAbi# | Constant | …/fhe-vesting | Constant exported from @tokenops/sdk/fhe-vesting. |
| ConfidentialVestingFactoryAdvancedClient# | Client | …/fhe-vesting/advanced | Advanced extension of ConfidentialVestingFactoryClient that re-exposes the CREATE2 address prediction read. |
| ConfidentialVestingFactoryClient# | Client | …/fhe-vesting | Typed wrapper around the deployed ConfidentialVestingFactory. |
| ConfidentialVestingFactoryClientConfig# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| confidentialVestingManagerAbi# | Constant | …/fhe-vesting | Constant exported from @tokenops/sdk/fhe-vesting. |
| ConfidentialVestingManagerClient# | Client | …/fhe-vesting | Typed wrapper around a deployed ConfidentialVestingManager clone. |
| ConfidentialVestingManagerClientConfig# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| ContractRevertError# | Error | @tokenops/sdk | Wraps an on-chain revert the SDK couldn't decode further. |
| CreateAirdropArgs# | Type | …/fhe-airdrop | Type exported from @tokenops/sdk/fhe-airdrop. |
| CreateAirdropPreflightReport# | Type | …/fhe-airdrop | Report returned by ConfidentialAirdropFactoryClient.preflightCreateAirdrop. |
| CreateAirdropResult# | Type | …/fhe-airdrop | Rich-return shape from ConfidentialAirdropFactoryClient.createConfidentialAirdrop and ConfidentialAirdropFactoryClient.createAndFundConfidentialAirdrop. |
| CreateAndFundAirdropArgs# | Type | …/fhe-airdrop | Discriminated union: provide EITHER an encryptor (the SDK encrypts amount) OR a pre-built encryptedInput. |
| createConfidentialAirdropClient# | Client | …/fhe-airdrop | Per-airdrop client — fund, sign claim, claim, extend window. |
| createConfidentialAirdropFactoryAdvancedClient# | Client | …/fhe-airdrop/advanced | Predict airdrop clone addresses before deploying. |
| createConfidentialAirdropFactoryClient# | Client | …/fhe-airdrop | Factory client — deploy per-campaign airdrop clones. |
| createConfidentialDisperseClient# | Client | …/fhe-disperse | Singleton client — register, approve, disperse, preflight, recover. |
| createConfidentialVestingFactoryAdvancedClient# | Client | …/fhe-vesting/advanced | Predict manager clone addresses before deploying. |
| createConfidentialVestingFactoryClient# | Client | …/fhe-vesting | Factory client — deploy manager clones per user. |
| createConfidentialVestingManagerClient# | Client | …/fhe-vesting | Manager client — open vestings, claim, disclose, revoke. |
| CreateManagerArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| CreateManagerResult# | Type | …/fhe-vesting | Rich-return shape from ConfidentialVestingFactoryClient.createManager. |
| createMockEncryptor# | Function | …/fhe | Local-only encryptor for Anvil + forge-fhevm tests. |
| createSepoliaEncryptor# | Function | …/fhe | Node-side encryptor wrapping the Zama relayer. |
| createSepoliaEncryptorWeb# | Function | …/fhe | Browser-side encryptor wrapping Zama RelayerWeb. |
| createTestnetFaucetClient# | Client | …/testnet-faucet | Factory helper — returns new TestnetFaucetClient(config) (viem create* convention); wires to the pre-deployed CTTT/TTT pair, no on-chain factory or deploy step. |
| CreateVestingArgs# | Type | …/fhe-vesting | Discriminated union: provide EITHER an encryptor (the SDK encrypts the plaintext amount) OR a pre-built encryptedInput. |
| CreateVestingPreflightReport# | Type | …/fhe-vesting | Report returned by ConfidentialVestingManagerClient.preflightCreateVesting. |
| CustomFee# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| DecryptionFailedError# | Error | @tokenops/sdk | User-decrypt round-trip failed (relayer, KMS, ACL). |
| DEPLOYED_ADDRESSES# | Constant | @tokenops/sdk | Per-chain factory + singleton address registry. |
| DeploymentAddressUnavailableError# | Error | @tokenops/sdk | No DEPLOYED_ADDRESSES entry for (product, contract, chainId). |
| DeploymentAddressUnavailableReason# | Type | @tokenops/sdk | Type exported from @tokenops/sdk. |
| DiscloseArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| DiscloseHandleArgs# | Type | …/fhe-disperse | Arguments for discloseHandleToParty(). |
| DiscloseToPartyResult# | Type | …/fhe-vesting | Result of ConfidentialVestingManagerClient.discloseToParty / ConfidentialVestingManagerClient.adminDiscloseToParty. |
| DisclosureResult# | Type | …/fhe-disperse | Result of discloseHandleToParty() / batchDiscloseHandlesToParty(). |
| DisclosureType# | Type | …/fhe-vesting | Which view to disclose: vested / claimable / settled / total. |
| DisperseArgs# | Type | …/fhe-disperse | Arguments for disperse(). |
| disperseConfidentialAbi# | Constant | …/fhe-disperse | Constant exported from @tokenops/sdk/fhe-disperse. |
| DisperseDistribution# | Type | …/fhe-disperse | Per-wallet (wallet modes) or single (direct mode) distribution row, parsed from a WalletDistribution / DirectDistribution event in the disperse receipt. |
| DisperseEncryptedReserveNotGrantedError# | Error | …/fhe-disperse | Thrown by getEncryptedFeeReserve() when no ACL Allowed event granting the caller access to the fee reserve handle is found in the receipt. |
| DisperseId# | Type | @tokenops/sdk | Branded Hex for a disperse subwallet. |
| DisperseMode# | Type | …/fhe-disperse | Disperse mode. |
| DisperseResult# | Type | …/fhe-disperse | Result of disperse(). |
| DisperseSubwalletNotFoundError# | Error | …/fhe-disperse | useDisperse hit a recipient with no registered subwallet. |
| disperseWalletAbi# | Constant | …/fhe-disperse | Constant exported from @tokenops/sdk/fhe-disperse. |
| EncryptedHandle# | Type | @tokenops/sdk | Branded bytes32 for an FHE ciphertext handle. |
| EncryptedInput# | Type | …/fhe-vesting | Single euint64 ciphertext: { handle: Hex; inputProof: Hex } produced by encryptUint64. |
| EncryptedInputs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| EncryptedViewResult# | Type | …/fhe-vesting | { handle, hash } returned by encrypted-view mutations. |
| EncryptionFailedError# | Error | @tokenops/sdk | Encryptor refused or returned invalid ciphertext/proof. |
| Encryptor# | Type | …/fhe-vesting | Interface for the Zama relayer abstraction. |
| EncryptorSource# | Type | …/fhe-vesting | Eager Encryptor | () => Encryptor | undefined. |
| encryptUint64# | Function | …/fhe-vesting | Encrypt a single uint64 with the given encryptor source. |
| EncryptUint64Args# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| encryptUint64Batch# | Function | …/fhe-vesting | Encrypt N uint64 values in one batch input proof. |
| EncryptUint64BatchArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| ERC7984_OPERATOR_MAX_DEADLINE# | Constant | …/fhe | Max far-future deadline for ERC-7984 operator approvals. |
| erc7984OperatorAbi# | Constant | …/fhe | Constant exported from @tokenops/sdk/fhe. |
| FaucetMetadata# | Type | …/testnet-faucet | { confidential, underlying, maxTotalSupply, rate } — consolidated faucet metadata from getMetadata(). |
| FaucetSupplyExhaustedError# | Error | …/testnet-faucet | CTTT maxTotalSupply ceiling hit; mapped from the on-chain ERC7984TotalSupplyOverflow revert. |
| FaucetTokenMetadata# | Type | …/testnet-faucet | Per-token metadata: name, symbol, decimals, address. |
| FeatureDisabledError# | Error | @tokenops/sdk | Feature disabled at clone-time (e.g. split on a non-split manager). |
| FeeConfig# | Type | …/fhe-disperse | Global fee configuration (on-chain feeConfig struct). |
| FeeType# | Type | …/fhe-vesting | Gas-side vs token-side fee discriminant. |
| feeTypeName# | Function | …/fhe-vesting | Stringify a FeeType for human-readable / JSON-output contexts. |
| FHE_SPLIT_DENOMINATOR# | Constant | …/fhe | 90_090_000 — bigint denominator for ratio scaling (LCM of 1..16 and 10_000). |
| FheHandleNotAllowedError# | Error | @tokenops/sdk | Caller lacks ACL on the handle they tried to decrypt. |
| FheValueInput# | Type | …/fhe | FHE input values, discriminated by ciphertext type. |
| FundAirdropArgs# | Type | …/fhe-airdrop | Discriminated union: provide EITHER an encryptor (the SDK encrypts amount) OR a pre-built encryptedInput. |
| GetClaimAmountArgs# | Type | …/fhe-airdrop | Args for ConfidentialAirdropClient.getClaimAmount — same shape as ClaimArgs minus value (the contract is not payable). |
| getConfidentialTestTokenAddress# | Function | @tokenops/sdk | DEPLOYED_ADDRESSES accessor for the CTTT (ConfidentialTokenopsTestToken) faucet token; exported from the root and testnet-faucet subpaths. |
| GetEncryptedFeeReserveArgs# | Type | …/fhe-disperse | Arguments for getEncryptedFeeReserve(). |
| getFheAirdropFactoryAddress# | Function | @tokenops/sdk | DEPLOYED_ADDRESSES accessor for the airdrop factory. |
| getFheDisperseSingletonAddress# | Function | @tokenops/sdk | DEPLOYED_ADDRESSES accessor for the disperse singleton. |
| getFheVestingFactoryAddress# | Function | @tokenops/sdk | DEPLOYED_ADDRESSES accessor for the vesting factory. |
| getTestTokenAddress# | Function | @tokenops/sdk | DEPLOYED_ADDRESSES accessor for the TTT (TokenopsTestToken) faucet token; exported from the root and testnet-faucet subpaths. |
| InitiateTransferArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| InsufficientBalanceError# | Error | @tokenops/sdk | Encrypted source balance is below the requested amount. |
| InsufficientFeeError# | Error | @tokenops/sdk | Native ETH (gas) fee or token fee did not match what the contract requires. |
| InsufficientGasFundsError# | Error | @tokenops/sdk | Wallet ETH balance below estimated gas + buffer. |
| InvalidArgumentError# | Error | @tokenops/sdk | Argument shape rejected by an SDK validation boundary. |
| InvalidSignatureError# | Error | @tokenops/sdk | EIP-712 signature bytes are malformed (length, s-range). |
| IsSignatureValidArgs# | Type | …/fhe-airdrop | Args for ConfidentialAirdropClient.isSignatureValid. |
| isTestnetFaucetChainId# | Function | …/testnet-faucet | Predicate: is this chain id a supported testnet faucet chain (Sepolia / local Anvil)? |
| isTokenOpsSdkError# | Error | @tokenops/sdk | Brand-based predicate. |
| MintConfidentialArgs# | Type | …/testnet-faucet | { amount: bigint; to?: Address; account? } — mintConfidential input. |
| MintConfidentialResult# | Type | …/testnet-faucet | { amount, handle, hash, to, underlyingMinted } — mintConfidential result (handle is the euint64). |
| mintMockERC7984# | Function | …/fhe | Test-only mint helper for the mock ERC-7984 token. |
| MintUnderlyingArgs# | Type | …/testnet-faucet | { amount: bigint; to?: Address; account? } — mintUnderlying input. |
| MintUnderlyingResult# | Type | …/testnet-faucet | { amount, hash, to } — mintUnderlying result. |
| MissingAccountError# | Error | @tokenops/sdk | Error exported from @tokenops/sdk. |
| MissingClientError# | Error | @tokenops/sdk | Thrown by React hooks when their headless client (factory / manager / airdrop / disperse) could not be constructed — usually because the wagmi publicClient isn't ready yet or the chain id has no resolvable address. |
| MissingEncryptorError# | Error | @tokenops/sdk | Hook requires an encryptor source but none was passed. |
| MissingPublicClientError# | Error | @tokenops/sdk | Error exported from @tokenops/sdk. |
| MissingWalletClientError# | Error | @tokenops/sdk | Error exported from @tokenops/sdk. |
| NetworkError# | Error | @tokenops/sdk | RPC/transport failure during read or write. |
| NoPendingTransferError# | Error | …/fhe-vesting | No pending transfer exists — cancel/accept fails until one is initiated. |
| NotPendingRecipientError# | Error | …/fhe-vesting | Caller is not the pending recipient of this transfer. |
| NotRegisteredError# | Error | …/fhe-disperse | The user has not yet called register(token). |
| NotVestingRecipientError# | Error | …/fhe-vesting | Caller is not the recipient of this vesting schedule. |
| OperatorNotApprovedError# | Error | @tokenops/sdk | The ERC-7984 token rejected the product contract as a spender — ERC7984UnauthorizedSpender(address holder, address spender) (selector 0x79f2cb38). |
| PartialClaimArgs# | Type | …/fhe-vesting | Discriminated union: provide EITHER an encryptor (the SDK encrypts amount) OR a pre-built encryptedInput. |
| PausedError# | Error | @tokenops/sdk | Contract is paused; write-side calls revert until unpaused. |
| PendingTransfer# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| PredictAirdropArgs# | Type | …/fhe-airdrop/advanced | Type exported from @tokenops/sdk/fhe-airdrop/advanced. |
| PredictManagerArgs# | Type | …/fhe-vesting/advanced | Type exported from @tokenops/sdk/fhe-vesting/advanced. |
| PreflightCreateAirdropArgs# | Type | …/fhe-airdrop | Arguments for ConfidentialAirdropFactoryClient.preflightCreateAirdrop. |
| PreflightDisperseArgs# | Type | …/fhe-disperse | Arguments for preflightDisperse(). |
| PreflightReport# | Type | …/fhe-disperse | Comprehensive pre-flight report returned by ConfidentialDisperseClient.preflightDisperse. |
| PreflightResult# | Type | @tokenops/sdk | { ready: boolean; blockers: TokenOpsSdkError[] }. |
| ReceiptEventAmbiguousError# | Error | @tokenops/sdk | Thrown when receipt-event extraction finds more than one matching event from the target contract. |
| ReceiptEventNotFoundError# | Error | @tokenops/sdk | Thrown when extracting an event from a transaction receipt finds zero matching entries — typically a silent revert, a misrouted log, or (most commonly for FHE flows) an ACL Allowed grant that didn't fire because the contract entrypoint t... |
| RecipientCheck# | Type | …/fhe-disperse | Per-recipient validation result inside a PreflightReport. |
| ReentrancyError# | Error | @tokenops/sdk | OpenZeppelin ReentrancyGuardTransient blocked a nested call. |
| RegisterResult# | Type | …/fhe-disperse | Result of register(). |
| RelayerUnreachableError# | Error | @tokenops/sdk | Network call to the Zama relayer failed (HTTP non-2xx, timeout, DNS, etc.). |
| requireConfidentialTestTokenAddress# | Function | @tokenops/sdk | Like getConfidentialTestTokenAddress but throws if no CTTT is registered for the chain; exported from the root and testnet-faucet subpaths. |
| requireTestTokenAddress# | Function | @tokenops/sdk | Like getTestTokenAddress but throws if no TTT is registered for the chain; exported from the root and testnet-faucet subpaths. |
| resolveEncryptor# | Function | …/fhe-vesting | Eager-or-lazy encryptor resolution helper. |
| revokeOperator# | Function | …/fhe-disperse | Revoke a previously granted ERC-7984 operator authorization. |
| RevokeOperatorArgs# | Type | …/fhe-disperse | Arguments for revokeOperator. |
| ScaledRatio# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| scaleRatio# | Function | …/fhe | Scale a fractional ratio to FHE_SPLIT_DENOMINATOR. |
| ScaleRatioArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| ScaleRatioWidth# | Type | …/fhe-vesting | Bit-width to validate the scaled numerator/denominator against. |
| SdkTelemetry# | Type | …/telemetry | Adapter interface for the SDK's event surface. |
| setOperator# | Function | …/fhe | Approve an operator for an ERC-7984 confidential token. |
| SetOperatorArgs# | Type | …/fhe-disperse | Type exported from @tokenops/sdk/fhe-disperse. |
| share# | Function | …/fhe | Compute a numerator / denominator share for FHE splits. |
| signClaimAuthorization# | Function | …/fhe-airdrop | Admin signs EIP-712 Claim(address recipient,bytes32 encryptedAmount). |
| SigningFailedError# | Error | @tokenops/sdk | Wallet signature failed for a reason other than the user explicitly rejecting it (timeout, wallet crash, malformed request, etc.). |
| SingletonNotApprovedError# | Error | …/fhe-disperse | Direct-mode disperse: the sender has not approved the singleton as an ERC-7984 operator on the token, so disperseConfidentialTokenDirect would revert with the raw ERC7984UnauthorizedSpender selector (0x79f2cb38). |
| SplitVestingArgs# | Type | …/fhe-vesting | Type exported from @tokenops/sdk/fhe-vesting. |
| SplitVestingResult# | Type | …/fhe-vesting | Result of ConfidentialVestingManagerClient.splitVesting. |
| SubwalletApprovalState# | Type | …/fhe-disperse | Approval state of a user's subwallet pair for a specific token. |
| SubwalletsNotApprovedError# | Error | …/fhe-disperse | Wallet-mode disperse: the user's registered sub-wallet pair has not (fully) approved the singleton as an ERC-7984 operator on the token, so the singleton cannot move funds held by the sub-wallets. |
| TESTNET_FAUCET_KEY# | Constant | …/testnet-faucet/react | Stable TanStack Query root segment for faucet hooks: tokenops-sdk. |
| TESTNET_FAUCET_NAMESPACE# | Constant | …/testnet-faucet/react | Stable TanStack Query namespace segment for faucet hooks: testnet-faucet. |
| TESTNET_FAUCET_SUPPORTED_CHAIN_IDS# | Constant | …/testnet-faucet | Chain ids the faucet supports: Sepolia (11155111) + local Anvil (31337). |
| TestnetFaucetClient# | Client | …/testnet-faucet | Testnet-only faucet client (no on-chain factory; construct via `new` or createTestnetFaucetClient) — open-mint plain TTT + backed confidential CTTT, read balances, rate, supply. |
| TestnetFaucetClientConfig# | Type | …/testnet-faucet | { publicClient, walletClient?, chainId?, address?, telemetry? } — TestnetFaucetClient constructor config. |
| TokenOpsContractError# | Error | …/fhe | Generic contract-interaction error thrown by SDK helpers that wrap writeContract + receipt-wait (e.g. |
| TokenOpsSdkError# | Error | @tokenops/sdk | Base class for every error the SDK throws. |
| TokenOpsSdkErrorCode# | Type | @tokenops/sdk | Stable, string-literal error codes. |
| tokenopsTestTokenAbi# | Constant | …/testnet-faucet | Constant exported from @tokenops/sdk/testnet-faucet. |
| TokenOpsValidationError# | Error | …/fhe | Free-form validation error thrown by SDK helpers that don't have a more specific typed subclass yet (e.g. |
| TransferAlreadyPendingError# | Error | …/fhe-vesting | useInitiateVestingTransfer while a prior transfer is pending. |
| TransferExpiredError# | Error | …/fhe-vesting | useAcceptVestingTransfer after the offer expired. |
| TransferFailedError# | Error | @tokenops/sdk | Native ETH or ERC-20 transfer failed at the contract layer (e.g. |
| UnknownWriteFailureError# | Error | @tokenops/sdk | Fallback for write failures the SDK could not classify against either an on-chain revert frame or a known viem non-revert error class. |
| UnsupportedChainError# | Error | @tokenops/sdk | Chain ID is not supported by @tokenops/sdk. (A chain that's supported but where the product isn't deployed yet throws DeploymentAddressUnavailableError instead.) |
| useAcceptVestingTransfer# | Hook | …/fhe-vesting/react | Accept an inbound vesting transfer (counterparty side). |
| useAccessClaimableAmount# | Hook | …/fhe-vesting/react | Submits a transaction to read the currently-claimable amount as an euint128 handle. |
| useAccessClaimAmount# | Hook | …/fhe-airdrop/react | Submits 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). |
| useAccessEncryptedFeeReserve# | Hook | …/fhe-disperse/react | MUTATION — 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. |
| useAccessSettledAmount# | Hook | …/fhe-vesting/react | Submits a transaction to read the already-claimed (settled) amount of a vesting as an euint128 handle. |
| useAccessTotalAllocation# | Hook | …/fhe-vesting/react | Submits a transaction to read the total allocation of a vesting as an euint128 handle. |
| useAccessVestedAmount# | Hook | …/fhe-vesting/react | Submits a transaction to read the vested amount at a given timestamp as an euint128 handle. |
| useAdminBatchDiscloseToParty# | Hook | …/fhe-vesting/react | Admin variant of useBatchDiscloseToParty — caller must hold DISCLOSURE_ADMIN_ROLE. |
| useAdminClaim# | Hook | …/fhe-vesting/react | Admin variant of useClaim — caller must hold CLAIMER_ROLE. |
| useAdminDiscloseToParty# | Hook | …/fhe-vesting/react | Admin variant of useDiscloseToParty — caller must hold DISCLOSURE_ADMIN_ROLE. |
| useAdminGetClaimableAmount# | Hook | …/fhe-vesting/react | Admin variant of useAccessClaimableAmount — caller must hold DISCLOSURE_ADMIN_ROLE. |
| useAdminGetSettledAmount# | Hook | …/fhe-vesting/react | Admin variant of useAccessSettledAmount — caller must hold DISCLOSURE_ADMIN_ROLE. |
| useAdminGetTokenBalance# | Hook | …/fhe-vesting/react | Admin: read the manager clone's confidential ERC-7984 token balance as an euint64 handle. |
| useAdminGetTotalAllocation# | Hook | …/fhe-vesting/react | Admin variant of useAccessTotalAllocation — caller must hold DISCLOSURE_ADMIN_ROLE. |
| useAdminGetVestedAmount# | Hook | …/fhe-vesting/react | Admin variant of useAccessVestedAmount — caller must hold DISCLOSURE_ADMIN_ROLE. |
| useAdminPartialClaim# | Hook | …/fhe-vesting/react | Admin variant of usePartialClaim — caller must hold CLAIMER_ROLE. |
| useAirdropCanExtendClaimWindow# | Hook | …/fhe-airdrop/react | Read whether the admin can extend the claim window past endTime on this airdrop clone. |
| useAirdropClaimedSignatures# | Hook | …/fhe-airdrop/react | Check whether a pre-computed claim struct hash has been consumed on this airdrop clone. |
| useAirdropClaimTypehash# | Hook | …/fhe-airdrop/react | Read the EIP-712 type hash for Claim(address recipient,bytes32 encryptedAmount). |
| useAirdropDeploymentBlockNumber# | Hook | …/fhe-airdrop/react | Read the block number at which this airdrop clone was deployed. |
| useAirdropDomainSeparator# | Hook | …/fhe-airdrop/react | Read the EIP-712 domain separator for this airdrop clone. |
| useAirdropEndTime# | Hook | …/fhe-airdrop/react | Read the airdrop clone's endTime — the unix timestamp when claims close. |
| useAirdropGasFee# | Hook | …/fhe-airdrop/react | Read the airdrop clone's immutable per-claim gas fee (in wei). |
| useAirdropGrantRole# | Hook | …/fhe-airdrop/react | AccessControl: grant role to accountTarget on this airdrop clone. |
| useAirdropHasClaimEnded# | Hook | …/fhe-airdrop/react | Read whether the current chain timestamp is past endTime on this airdrop clone. |
| useAirdropHasClaimStarted# | Hook | …/fhe-airdrop/react | Read whether the current chain timestamp is past START_TIME on this airdrop clone. |
| useAirdropHasRole# | Hook | …/fhe-airdrop/react | Read 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# | Hook | …/fhe-airdrop/react | Returns true when the current timestamp is within [startTime, endTime] AND claims are not paused. |
| useAirdropIsPaused# | Hook | …/fhe-airdrop/react | Read whether claims are currently paused by the admin on this airdrop clone. |
| useAirdropIsSignatureClaimed# | Hook | …/fhe-airdrop/react | Has this admin signature already been redeemed? |
| useAirdropIsSignatureValid# | Hook | …/fhe-airdrop/react | On-chain view that checks whether the admin signature is valid for the connected caller before paying gas — returns false for a non-admin signer or already-claimed signature; throws if the claim window is inactive or the signature bytes are malformed. |
| useAirdropRevokeRole# | Hook | …/fhe-airdrop/react | AccessControl: revoke role from accountTarget on this airdrop clone. |
| useAirdropStartTime# | Hook | …/fhe-airdrop/react | Read the airdrop clone's immutable START_TIME — the unix timestamp when claims become available. |
| useAirdropToken# | Hook | …/fhe-airdrop/react | Read the airdrop clone's immutable TOKEN. |
| useAirdropWithdrawGasFee# | Hook | …/fhe-airdrop/react | Fee collector: withdraw collected ETH gas fees from the airdrop clone. |
| useAllRecipients# | Hook | …/fhe-vesting/react | Every recipient currently registered on this manager. |
| useAllRecipientsLength# | Hook | …/fhe-vesting/react | Count of registered recipients (cheap pre-paging check). |
| useAllRecipientsSliced# | Hook | …/fhe-vesting/react | Read a [start, end) slice of the recipients set. |
| useApproveTokenOnWallets# | Hook | …/fhe-disperse/react | Approve the singleton as an ERC-7984 operator over the caller's registered subwallets for a single token. |
| useBatchCreateVesting# | Hook | …/fhe-vesting/react | Batch variant of useCreateVesting — open N vestings in one tx with one batch input proof. |
| useBatchDiscloseHandlesToParty# | Hook | …/fhe-vesting/react | Batch ACL grant across many handles in one tx. |
| useBatchDiscloseHandlesToParty# | Hook | …/fhe-disperse/react | Batch ACL grant across many handles in one tx. |
| useBatchDiscloseToParty# | Hook | …/fhe-vesting/react | Batch variant of useDiscloseToParty. |
| useBatchRevokeVesting# | Hook | …/fhe-vesting/react | Batch variant of useRevokeVesting. |
| useCalculateFee# | Hook | …/fhe-disperse/react | Quote the on-chain fee config for a given disperse batch shape (count + mode). |
| useCancelVestingTransfer# | Hook | …/fhe-vesting/react | Cancel an outbound transfer before the counterparty accepts. |
| useClaim# | Hook | …/fhe-vesting/react | Recipient-side claim. For FeeType.Gas managers pass value (read it with useManagerFeeInfo); omit value for FeeType.DistributionToken. |
| useClaim# | Hook | …/fhe-airdrop/react | Claim tokens from an airdrop using an EIP-712 admin signature. |
| useConfidentialAirdropFactoryImplementation# | Hook | …/fhe-airdrop/react | Read the FHE-airdrop factory's current implementation() address — the LibClone target every new airdrop clone delegates to. |
| useConfidentialBalance# | Hook | …/testnet-faucet/react | Read the encrypted confidential balance handle (euint64 ciphertext) for account — defaults to the connected wallet. |
| useConfidentialVestingFactoryImplementation# | Hook | …/fhe-vesting/react | Read the FHE-vesting factory's current implementation() address — the LibClone target every new manager clone delegates to. |
| useCreateAndFundConfidentialAirdrop# | Hook | …/fhe-airdrop/react | Single-flow helper: deploy + fund in one bundle. |
| useCreateAndFundConfidentialAirdropAndGetAddress# | Hook | …/fhe-airdrop/react | Same as useCreateAndFundConfidentialAirdrop but returns the clone address. |
| useCreateConfidentialAirdrop# | Hook | …/fhe-airdrop/react | Deploy an airdrop clone for a token + admin + claim window. |
| useCreateConfidentialAirdropAndGetAddress# | Hook | …/fhe-airdrop/react | Deploy an airdrop + wait for receipt + return the clone address. |
| useCreateManager# | Hook | …/fhe-vesting/react | Deploy a per-user vesting manager clone via the factory. |
| useCreateManagerAndGetAddress# | Hook | …/fhe-vesting/react | Deploy a manager and wait for the receipt — returns the deterministic clone address. |
| useCreateVesting# | Hook | …/fhe-vesting/react | Open a new vesting schedule on a manager — encrypts the amount client-side, submits the tx. |
| useDecryptedHandle# | Hook | …/fhe/react | Subscribe to a single encrypted handle and reactively decrypt via the connected wallet. |
| useDeploymentBlockNumber# | Hook | …/fhe-disperse/react | Read the block number at which the singleton was deployed — useful as the fromBlock argument to getLogs when subscribing to events. |
| useDirectVestingTransfer# | Hook | …/fhe-vesting/react | Recipient-driven one-step transfer — moves a vesting to a new owner without waiting for counterparty acceptance. |
| useDisableCustomFee# | Hook | …/fhe-vesting/react | Admin: disable the per-creator fee override for creator. |
| useDisableCustomFee# | Hook | …/fhe-airdrop/react | Admin: remove a per-creator fee override, reverting to defaultGasFee. |
| useDisableCustomFee# | Hook | …/fhe-disperse/react | Admin: remove a per-user fee override, falling back to the global defaults. |
| useDiscloseHandleToParty# | Hook | …/fhe-vesting/react | Grant ACL on a single ciphertext handle to a third party (e.g. an auditor). |
| useDiscloseHandleToParty# | Hook | …/fhe-disperse/react | Grant ACL on a single ciphertext handle to a third party (e.g. an auditor). |
| useDiscloseToParty# | Hook | …/fhe-vesting/react | Grant ACL on a single encrypted field of a vesting (total allocation, settled, vested, or claimable) to a third party. |
| useDisperse# | Hook | …/fhe-disperse/react | Multi-recipient confidential transfer in one tx — batch-encrypts amounts + per-recipient ACL. |
| useEnsureOperator# | Hook | …/fhe-vesting/react | Ensure spender is an ERC-7984 operator for the connected account on token, sending a setOperator transaction only when the grant is missing. |
| useEnsureOperator# | Hook | …/fhe-airdrop/react | Ensure spender is an ERC-7984 operator for the connected account on token, sending a setOperator transaction only when the grant is missing. |
| useEnsureOperator# | Hook | …/fhe-disperse/react | Ensure spender is an ERC-7984 operator for the connected account on token, sending a setOperator transaction only when the grant is missing. |
| useEnsureOperator# | Hook | …/fhe/react | Ensure spender is an ERC-7984 operator for the connected account on token, sending a setOperator transaction only when the grant is missing. |
| useExtendClaimWindow# | Hook | …/fhe-airdrop/react | Admin extends the claim deadline. |
| useFactoryCustomFee# | Hook | …/fhe-vesting/react | Read the per-creator fee override set on the factory for creator. |
| useFactoryCustomFee# | Hook | …/fhe-airdrop/react | Read the per-creator fee override set on the factory for creator. |
| useFactoryDefaultFeeType# | Hook | …/fhe-vesting/react | Read the factory-wide default fee model (FeeType.Gas or FeeType.DistributionToken) applied to newly-created manager clones. |
| useFactoryDefaultGasFee# | Hook | …/fhe-vesting/react | Read the factory-wide default gas fee (in wei) — applied to new FeeType.Gas manager clones at deployment. |
| useFactoryDefaultGasFee# | Hook | …/fhe-airdrop/react | Read 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# | Hook | …/fhe-vesting/react | Read the factory-wide default token fee in basis points — applied to new FeeType.DistributionToken manager clones at deployment. |
| useFactoryFeeCollector# | Hook | …/fhe-vesting/react | Read the factory's current fee collector address. |
| useFactoryFeeCollector# | Hook | …/fhe-airdrop/react | Read the factory's current fee collector address — the account authorized to call withdrawGasFee on each deployed airdrop clone. |
| useFactoryInitCodeHash# | Hook | …/fhe-vesting/react | Read the init-code hash the factory would use to CREATE2 a manager clone with the given token + deployer (+ optional immutable flags). |
| useFactoryInitCodeHash# | Hook | …/fhe-airdrop/react | Read the init-code hash the factory would use to CREATE2 an airdrop clone with the given params + gasFee. |
| useFaucetDecimals# | Hook | …/testnet-faucet/react | Read the decimals of the confidential token (CTTT) — 6. |
| useFaucetMetadata# | Hook | …/testnet-faucet/react | Read consolidated faucet metadata in a single hook — both tokens' name/symbol/decimals/address, the conversion rate, and the maxTotalSupply ceiling. |
| useFaucetRate# | Hook | …/testnet-faucet/react | Read the decimal-conversion rate between underlying and confidential units: 1 CTTT 6-decimal unit is backed by rate TTT 18-decimal base units (10^(18-6) = 10^12). |
| useFundConfidentialAirdrop# | Hook | …/fhe-airdrop/react | Encrypt the funding amount and transferFromConfidential into the clone. |
| useGetBatchLimits# | Hook | …/fhe-disperse/react | Read the maximum batch size for each of the three disperse modes ("wallet", "direct", "wallet-token-fee"). |
| useGetClaimableAmount# | Hook | …/fhe-vesting/react | Encrypted-view read: min(vested, balance) - settled. Pair with useDecryptedHandle. |
| useGetClaimAmount# | Hook | …/fhe-airdrop/react | Submits 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# | Hook | …/fhe-disperse/react | @deprecated — Renamed to useAccessEncryptedFeeReserve; will be removed in the next major. MUTATION — 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# | Hook | …/fhe-disperse/react | Read the singleton's { gasFeeEnabled, tokenFeeEnabled, defaultGasFee, defaultTokenFee } fee config. |
| useGetFees# | Hook | …/fhe-disperse/react | Read consolidated fee information for user — combines per-user resolved fees (getFeeAmounts) with the global feeConfig toggles in one read. |
| useGetSettledAmount# | Hook | …/fhe-vesting/react | Encrypted-view read: running settled total. Pair with useDecryptedHandle. |
| useGetTotalAllocation# | Hook | …/fhe-vesting/react | Encrypted-view read: original allocation. Pair with useDecryptedHandle. |
| useGetVestedAmount# | Hook | …/fhe-vesting/react | Encrypted-view read: time-unlocked total. Pair with useDecryptedHandle. |
| useGetWallets# | Hook | …/fhe-disperse/react | Read the deployer's two registered subwallet addresses. |
| useGrantRole# | Hook | …/fhe-vesting/react | AccessControl: grant role to accountTarget. |
| useGrantRole# | Hook | …/fhe-disperse/react | AccessControl: grant role to accountTarget on the singleton. |
| useHasApprovedSubwallets# | Hook | …/fhe-disperse/react | Check whether a user's registered subwallets have approved the singleton as an ERC-7984 operator for token. |
| useHasRole# | Hook | …/fhe-vesting/react | Read 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# | Hook | …/fhe-disperse/react | Read 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. |
| useInferredTotalSupply# | Hook | …/testnet-faucet/react | Read the wrapper's inferred total supply: underlying held in custody divided by rate, an upper bound on the confidential total supply, in CTTT 6-decimal units. |
| useInitiateVestingTransfer# | Hook | …/fhe-vesting/react | Recipient initiates a two-step transfer of a vesting position to another recipient. |
| useIsOperator# | Hook | …/fhe-vesting/react | Read spender's ERC-7984 operator status for holder on token. |
| useIsOperator# | Hook | …/fhe-airdrop/react | Read spender's ERC-7984 operator status for holder on token. |
| useIsOperator# | Hook | …/fhe-disperse/react | Read spender's ERC-7984 operator status for holder on token. |
| useIsOperator# | Hook | …/fhe/react | Read spender's ERC-7984 operator status for holder on token. |
| useIsPaused# | Hook | …/fhe-disperse/react | Read the singleton's paused flag. |
| useIsRecipient# | Hook | …/fhe-vesting/react | Read whether account is currently a recipient on this manager clone. |
| useIsRegistered# | Hook | …/fhe-disperse/react | Has this deployer already called register? |
| useManagerDeploymentBlockNumber# | Hook | …/fhe-vesting/react | Read the manager clone's immutable DEPLOYMENT_BLOCK_NUMBER — the block at which the factory deployed this clone via LibClone. |
| useManagerFee# | Hook | …/fhe-vesting/react | Read the manager clone's immutable FEE (in wei for FeeType.Gas, in basis points for FeeType.DistributionToken). |
| useManagerFeeInfo# | Hook | …/fhe-vesting/react | Resolves { feeType, fee } — caller passes the right branch to useClaim. |
| useManagerFeeType# | Hook | …/fhe-vesting/react | Read the manager clone's immutable FEE_TYPE (FeeType.Gas or FeeType.DistributionToken). |
| useManagerIsPausable# | Hook | …/fhe-vesting/react | Read whether the manager clone has pause/unpause enabled (immutable). |
| useManagerIsSplitEnabled# | Hook | …/fhe-vesting/react | Read whether the manager clone has split-vesting enabled (immutable). |
| useManagerMaxBatchSize# | Hook | …/fhe-vesting/react | Read the manager clone's maxBatchSize — upper bound for batchCreateVesting. |
| useManagerMaxRevokeBatchSize# | Hook | …/fhe-vesting/react | Read the manager clone's maxRevokeBatchSize — upper bound for batchRevokeVesting. |
| useManagerPaused# | Hook | …/fhe-vesting/react | Read whether the manager clone is currently paused. |
| useManagerToken# | Hook | …/fhe-vesting/react | The manager clone's immutable underlying token address. |
| useMaxTotalSupply# | Hook | …/testnet-faucet/react | Read the max confidential total supply the wrapper supports (type(uint64).max). |
| useMintConfidential# | Hook | …/testnet-faucet/react | Mint backed confidential test tokens (CTTT) to a recipient. |
| useMintUnderlying# | Hook | …/testnet-faucet/react | Mint standard (non-confidential) ERC-20 test tokens (TTT) to a recipient. |
| usePartialClaim# | Hook | …/fhe-vesting/react | Claim less than the unlocked amount — leaves the remainder encrypted on the clone. |
| usePause# | Hook | …/fhe-vesting/react | Pauser: pause the manager clone — blocks claim, partialClaim, splitVesting, initiateVestingTransfer, acceptVestingTransfer, and directVestingTransfer. |
| usePause# | Hook | …/fhe-disperse/react | Admin: pause all disperse operations on the singleton. |
| usePendingVestingTransfer# | Hook | …/fhe-vesting/react | Read the pending transfer (if any) on a vesting — returns { newRecipient, initiatedAt, expiresAt }. |
| usePredictAirdropAddress# | Hook | …/fhe-airdrop/advanced/react | CREATE2 the airdrop clone address before deploying. |
| usePredictManagerAddress# | Hook | …/fhe-vesting/advanced/react | CREATE2 the manager clone address before deploying — pre-flight UI flows. |
| usePredictWallets# | Hook | …/fhe-disperse/react | Compute the deterministic subwallet addresses for a deployer without registering. |
| usePreflightCreateAirdrop# | Hook | …/fhe-airdrop/react | Read-only preflight for useCreateConfidentialAirdrop / useCreateAndFundConfidentialAirdrop — wraps ConfidentialAirdropFactoryClient.preflightCreateAirdrop as a TanStack query. |
| usePreflightCreateVesting# | Hook | …/fhe-vesting/react | Read-only preflight for useCreateVesting / useBatchCreateVesting — wraps ConfidentialVestingManagerClient.preflightCreateVesting as a TanStack query. |
| usePreflightDisperse# | Hook | …/fhe-disperse/react | Dry-run validator — checks operator + balance + paused state before broadcasting. |
| UserDecryptNotAllowedError# | Error | @tokenops/sdk | Zama ACL refused to grant decryption for the caller on the requested handle. |
| useRecipientVestings# | Hook | …/fhe-vesting/react | Read all vesting IDs owned by recipient. |
| useRecipientVestingsLength# | Hook | …/fhe-vesting/react | Read the number of vesting schedules owned by recipient. |
| useRecipientVestingsSliced# | Hook | …/fhe-vesting/react | Read a [start, end) slice of recipient's vesting IDs. |
| useRecoverERC20FromWallets# | Hook | …/fhe-disperse/react | Recover ERC-20 tokens accidentally sent to the caller's registered wallets. |
| useRecoverFromWallets# | Hook | …/fhe-disperse/react | Recover residual confidential ERC-7984 tokens from the caller's registered wallets to to. |
| useRegister# | Hook | …/fhe-disperse/react | First-time setup for a deployer — singleton creates the two ERC-1167 subwallets. |
| useRenounceRole# | Hook | …/fhe-vesting/react | AccessControl: renounce role from msg.sender. |
| useRescueConfidentialTokens# | Hook | …/fhe-disperse/react | Sweep stranded confidential tokens out of the singleton contract (admin-only). |
| useRescueERC20# | Hook | …/fhe-disperse/react | Sweep stranded plain ERC-20 tokens (e.g. someone sent the wrong token). |
| useResetGasFee# | Hook | …/fhe-vesting/react | Admin: reset the factory's default gas fee to zero. |
| useResetTokenFee# | Hook | …/fhe-vesting/react | Admin: reset the factory's default token fee to zero. |
| useRevokeRole# | Hook | …/fhe-vesting/react | AccessControl: revoke role from accountTarget. |
| useRevokeRole# | Hook | …/fhe-disperse/react | AccessControl: revoke role from accountTarget on the singleton. |
| useRevokeTokenOnWallets# | Hook | …/fhe-disperse/react | Revoke operator approval on the subwallets (rollback). |
| useRevokeVesting# | Hook | …/fhe-vesting/react | Admin revocation — clears the schedule (revocable variants only) and returns funds. |
| UserFees# | Type | …/fhe-disperse | Resolved fee configuration for a given user. |
| useRoleConstants# | Hook | …/fhe-vesting/react | Read all eight AccessControl role hashes off the manager in one fan-out. |
| UserRejectedSignatureError# | Error | @tokenops/sdk | User rejected the wallet signature prompt. |
| useSetCustomFee# | Hook | …/fhe-vesting/react | Admin: install a per-creator fee override on the factory. |
| useSetCustomFee# | Hook | …/fhe-airdrop/react | Admin: install a per-creator gas-fee override on the factory. |
| useSetCustomFee# | Hook | …/fhe-disperse/react | Admin: install a per-user fee override (gas fee in wei, token fee in BPS). |
| useSetDefaultFeeType# | Hook | …/fhe-vesting/react | Admin: set the factory's default fee model (FeeType.Gas or FeeType.DistributionToken) for new manager clones. |
| useSetDefaultGasFee# | Hook | …/fhe-vesting/react | Admin: set the factory-wide default gas fee (in wei). |
| useSetDefaultGasFee# | Hook | …/fhe-airdrop/react | Admin: change the factory-wide default per-claim gas fee. |
| useSetDefaultTokenFee# | Hook | …/fhe-vesting/react | Admin: set the factory-wide default token fee (basis points). |
| useSetFeeCollector# | Hook | …/fhe-vesting/react | Admin: set the factory's fee collector address. |
| useSetFeeCollector# | Hook | …/fhe-airdrop/react | Admin: change the factory's fee collector address. |
| useSetFeeConfig# | Hook | …/fhe-disperse/react | Admin: update the global fee configuration — enable/disable gas and token fees, set the defaults. |
| useSetMaxBatchSize# | Hook | …/fhe-vesting/react | Admin: bump or lower maxBatchSize (cap for useBatchCreateVesting). |
| useSetMaxBatchSizeDirect# | Hook | …/fhe-disperse/react | Admin: set the maximum batch size for "direct" mode disperses. |
| useSetMaxBatchSizeHolding# | Hook | …/fhe-disperse/react | Admin: set the maximum batch size for "wallet" mode disperses. |
| useSetMaxBatchSizeTokenFee# | Hook | …/fhe-disperse/react | Admin: set the maximum batch size for "wallet-token-fee" mode disperses. |
| useSetMaxRevokeBatchSize# | Hook | …/fhe-vesting/react | Admin: bump or lower maxRevokeBatchSize (cap for useBatchRevokeVesting). |
| useSetPaused# | Hook | …/fhe-airdrop/react | Admin: pause or unpause claims on this airdrop clone. |
| useSignClaimAuthorization# | Hook | …/fhe-airdrop/react | Admin signs the off-chain EIP-712 Claim(address recipient,bytes32 encryptedAmount) message. |
| useSplitVesting# | Hook | …/fhe-vesting/react | Split one vesting into two with custom proportions; both stay encrypted. |
| useTransferFeeCollectorRole# | Hook | …/fhe-vesting/react | Transfer the FEE_COLLECTOR_ROLE to newCollector. |
| useUnderlyingBalance# | Hook | …/testnet-faucet/react | Read the plaintext underlying TokenopsTestToken (TTT) balance for account (defaults to the connected wallet), in TTT 18-decimal base units. |
| useUnderlyingDecimals# | Hook | …/testnet-faucet/react | Read the decimals of the underlying token (TTT) — 18. |
| useUnderlyingTokenAddress# | Hook | …/testnet-faucet/react | Read the underlying TokenopsTestToken (TTT) address backing the CTTT wrapper. |
| useUnpause# | Hook | …/fhe-vesting/react | Pauser: unpause the manager clone. |
| useUnpause# | Hook | …/fhe-disperse/react | Admin: unpause the singleton. |
| useVestingInfo# | Hook | …/fhe-vesting/react | Plaintext schedule shape (start / end / cliff / interval) + encrypted-handle metadata. |
| useWalletImplementation# | Hook | …/fhe-disperse/react | Read the WALLET_IMPLEMENTATION address — the singleton clones this deterministically (Clones.cloneDeterministic) for each registered user to derive their wallet pair. |
| useWithdraw# | Hook | …/fhe-airdrop/react | Admin: withdraw all confidential tokens from the airdrop to recipient. |
| useWithdrawAdmin# | Hook | …/fhe-vesting/react | Admin: withdraw an encrypted amount of the manager's distribution token to msg.sender. |
| useWithdrawGasFee# | Hook | …/fhe-vesting/react | Fee collector: withdraw collected gas-fee ETH (FeeType.Gas managers). |
| useWithdrawGasFee# | Hook | …/fhe-disperse/react | Fee-collector: withdraw amount wei of accumulated ETH gas fees from the singleton to to. |
| useWithdrawOtherConfidentialToken# | Hook | …/fhe-vesting/react | Admin: rescue an ERC-7984 (confidential) token other than this manager's configured token. |
| useWithdrawOtherConfidentialToken# | Hook | …/fhe-airdrop/react | Admin: rescue accidentally sent ERC-7984 confidential tokens (other than this airdrop's configured TOKEN). |
| useWithdrawOtherToken# | Hook | …/fhe-vesting/react | Admin: rescue an ERC-20 (non-confidential) other than this manager's configured token. |
| useWithdrawOtherToken# | Hook | …/fhe-airdrop/react | Admin: rescue accidentally sent ERC-20 (non-confidential) tokens. |
| useWithdrawTokenFee# | Hook | …/fhe-vesting/react | Fee collector: withdraw collected distribution-token fees (FeeType.DistributionToken managers). |
| useWithdrawTokenFee# | Hook | …/fhe-disperse/react | Fee-collector: withdraw accumulated encrypted token fees. |
| VestingExpiredError# | Error | …/fhe-vesting | Schedule passed its end timestamp; nothing left to claim. |
| VestingId# | Type | @tokenops/sdk | Branded Hex for a vesting position. |
| VestingInfo# | Type | …/fhe-vesting | Plaintext schedule shape + encrypted-handle metadata. |
| VestingNotFoundError# | Error | …/fhe-vesting | vestingId not registered on the manager. |
| VestingNotRevocableError# | Error | …/fhe-vesting | useRevokeVesting on a vesting created with isRevocable=false. |
| VestingParams# | Type | …/fhe-vesting | Constructor args for createVesting. |
| VestingRevokedError# | Error | …/fhe-vesting | Operator revoked this vesting — claims return revoked state. |
| WalletChainMismatchError# | Error | @tokenops/sdk | Wallet chain differs from the SDK client's chain. |
| WalletRejectedError# | Error | @tokenops/sdk | User rejected the tx prompt at the wallet. |
| WithdrawTokenFeeResult# | Type | …/fhe-disperse | Result of withdrawTokenFee(). |
| withTelemetry# | Function | …/telemetry | Wrap an SDK client with an SdkTelemetry adapter. |