fhe-vesting/react
Interfaces
PredictManagerArgs
Defined in: fhe-vesting/factory.ts:70
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
token | `0x${(...)}` | - | fhe-vesting/factory.ts:71 |
userSalt | `0x${(...)}` | - | fhe-vesting/factory.ts:72 |
deployer | `0x${(...)}` | - | fhe-vesting/factory.ts:73 |
splitEnabled? | ... | ... | ... | - | fhe-vesting/factory.ts:74 |
pausableEnabled? | ... | ... | ... | - | fhe-vesting/factory.ts:75 |
blockNumber | bigint | Block number to read at. Required for stable prediction on a live chain. The factory packs the deployment block number into the clone's immutable args, so the predicted address depends on the block the prediction runs against. To get the address an upcoming createManager tx will produce, you must know the block it will mine in — which you don't, until after it mines. In practice predicting an address is only useful for historical reads (verifying a clone deployed at a known past block) or tightly-coupled same-tx flows. For the "deploy a clone and learn its address" flow, prefer ConfidentialVestingFactoryClient.createManager. It parses the ManagerCreated event from the tx receipt and returns the address authoritatively — no block guessing required. The actual predictManagerAddress read lives on ConfidentialVestingFactoryAdvancedClient from @tokenops/sdk/fhe-vesting/advanced — this type is exported from both subpaths. | fhe-vesting/factory.ts:96 |
BaseHookOptions
Defined in: fhe-vesting/react/_shared.ts:33
Common per-hook overrides — every public hook accepts these alongside its own args.
Extended by
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
address? | ... | ... | Override the on-chain contract address. Defaults to getFheVestingFactoryAddress keyed by chain id. | fhe-vesting/react/_shared.ts:35 |
chainId? | ... | ... | Override the chain id used for default address resolution. Defaults to usePublicClient().chain?.id. | fhe-vesting/react/_shared.ts:37 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from factory.* writes flow through whichever sink the consumer wires up (PostHog, OTel, Sentry, custom). | fhe-vesting/react/_shared.ts:43 |
ManagerHookOptions
Defined in: fhe-vesting/react/_shared.ts:47
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extended by
UseVestingInfoArgsUseAllRecipientsSlicedArgsUseIsRecipientArgsUseRecipientVestingsArgsUseRecipientVestingsLengthArgsUseRecipientVestingsSlicedArgsUsePendingVestingTransferArgsUseHasRoleArgs
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
address | `0x${(...)}` | - | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | fhe-vesting/react/_shared.ts:76 |
UseAcceptVestingTransferArgs
Defined in: fhe-vesting/react/useAcceptVestingTransfer.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useAcceptVestingTransfer.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useAcceptVestingTransfer.ts:9 |
UseAdminBatchDiscloseToPartyArgs
Defined in: fhe-vesting/react/useAdminBatchDiscloseToParty.ts:9
Properties
| Property | Type | Defined in |
|---|---|---|
vestingIds | readonly ...[] | fhe-vesting/react/useAdminBatchDiscloseToParty.ts:10 |
disclosureTypes | readonly ...[] | fhe-vesting/react/useAdminBatchDiscloseToParty.ts:11 |
party | `0x${(...)}` | fhe-vesting/react/useAdminBatchDiscloseToParty.ts:12 |
account? | ... | ... | ... | fhe-vesting/react/useAdminBatchDiscloseToParty.ts:13 |
UseAdminGetClaimableAmountArgs
Defined in: fhe-vesting/react/useAdminGetClaimableAmount.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useAdminGetClaimableAmount.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useAdminGetClaimableAmount.ts:10 |
UseAdminGetSettledAmountArgs
Defined in: fhe-vesting/react/useAdminGetSettledAmount.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useAdminGetSettledAmount.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useAdminGetSettledAmount.ts:10 |
UseAdminGetTokenBalanceArgs
Defined in: fhe-vesting/react/useAdminGetTokenBalance.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
account? | ... | ... | ... | fhe-vesting/react/useAdminGetTokenBalance.ts:9 |
UseAdminGetTotalAllocationArgs
Defined in: fhe-vesting/react/useAdminGetTotalAllocation.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useAdminGetTotalAllocation.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useAdminGetTotalAllocation.ts:10 |
UseAdminGetVestedAmountArgs
Defined in: fhe-vesting/react/useAdminGetVestedAmount.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useAdminGetVestedAmount.ts:9 |
timestamp | number | fhe-vesting/react/useAdminGetVestedAmount.ts:10 |
account? | ... | ... | ... | fhe-vesting/react/useAdminGetVestedAmount.ts:11 |
UseAllRecipientsSlicedArgs
Defined in: fhe-vesting/react/useAllRecipientsSliced.ts:6
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
start? | ... | ... | - | - | fhe-vesting/react/useAllRecipientsSliced.ts:7 |
end? | ... | ... | - | - | fhe-vesting/react/useAllRecipientsSliced.ts:8 |
UseBatchDiscloseHandlesToPartyArgs
Defined in: fhe-vesting/react/useBatchDiscloseHandlesToParty.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
handles | readonly ...[] | fhe-vesting/react/useBatchDiscloseHandlesToParty.ts:8 |
party | `0x${(...)}` | fhe-vesting/react/useBatchDiscloseHandlesToParty.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useBatchDiscloseHandlesToParty.ts:10 |
UseBatchDiscloseToPartyArgs
Defined in: fhe-vesting/react/useBatchDiscloseToParty.ts:9
Properties
| Property | Type | Defined in |
|---|---|---|
vestingIds | readonly ...[] | fhe-vesting/react/useBatchDiscloseToParty.ts:10 |
disclosureTypes | readonly ...[] | fhe-vesting/react/useBatchDiscloseToParty.ts:11 |
party | `0x${(...)}` | fhe-vesting/react/useBatchDiscloseToParty.ts:12 |
account? | ... | ... | ... | fhe-vesting/react/useBatchDiscloseToParty.ts:13 |
UseBatchRevokeVestingArgs
Defined in: fhe-vesting/react/useBatchRevokeVesting.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
vestingIds | readonly ...[] | fhe-vesting/react/useBatchRevokeVesting.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useBatchRevokeVesting.ts:9 |
UseCancelVestingTransferArgs
Defined in: fhe-vesting/react/useCancelVestingTransfer.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useCancelVestingTransfer.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useCancelVestingTransfer.ts:9 |
UseDirectVestingTransferArgs
Defined in: fhe-vesting/react/useDirectVestingTransfer.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useDirectVestingTransfer.ts:8 |
newOwner | `0x${(...)}` | fhe-vesting/react/useDirectVestingTransfer.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useDirectVestingTransfer.ts:10 |
UseDisableCustomFeeArgs
Defined in: fhe-vesting/react/useDisableCustomFee.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
creator | `0x${(...)}` | fhe-vesting/react/useDisableCustomFee.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useDisableCustomFee.ts:9 |
UseDiscloseHandleToPartyArgs
Defined in: fhe-vesting/react/useDiscloseHandleToParty.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
handle | `0x${(...)}` | fhe-vesting/react/useDiscloseHandleToParty.ts:8 |
party | `0x${(...)}` | fhe-vesting/react/useDiscloseHandleToParty.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useDiscloseHandleToParty.ts:10 |
UseFactoryCustomFeeArgs
Defined in: fhe-vesting/react/useFactoryCustomFee.ts:7
Common per-hook overrides — every public hook accepts these alongside its own args.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address? | ... | ... | Override the on-chain contract address. Defaults to getFheVestingFactoryAddress keyed by chain id. | BaseHookOptions.address | fhe-vesting/react/_shared.ts:35 |
chainId? | ... | ... | Override the chain id used for default address resolution. Defaults to usePublicClient().chain?.id. | BaseHookOptions.chainId | fhe-vesting/react/_shared.ts:37 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from factory.* writes flow through whichever sink the consumer wires up (PostHog, OTel, Sentry, custom). | BaseHookOptions.telemetry | fhe-vesting/react/_shared.ts:43 |
creator? | ... | ... | Address whose per-creator fee override to read. Hook is disabled until set. | - | fhe-vesting/react/useFactoryCustomFee.ts:9 |
UseFactoryInitCodeHashArgs
Defined in: fhe-vesting/react/useFactoryInitCodeHash.ts:6
Common per-hook overrides — every public hook accepts these alongside its own args.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address? | ... | ... | Override the on-chain contract address. Defaults to getFheVestingFactoryAddress keyed by chain id. | BaseHookOptions.address | fhe-vesting/react/_shared.ts:35 |
chainId? | ... | ... | Override the chain id used for default address resolution. Defaults to usePublicClient().chain?.id. | BaseHookOptions.chainId | fhe-vesting/react/_shared.ts:37 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from factory.* writes flow through whichever sink the consumer wires up (PostHog, OTel, Sentry, custom). | BaseHookOptions.telemetry | fhe-vesting/react/_shared.ts:43 |
token? | ... | ... | - | - | fhe-vesting/react/useFactoryInitCodeHash.ts:7 |
deployer? | ... | ... | - | - | fhe-vesting/react/useFactoryInitCodeHash.ts:8 |
splitEnabled? | ... | ... | ... | - | - | fhe-vesting/react/useFactoryInitCodeHash.ts:9 |
pausableEnabled? | ... | ... | ... | - | - | fhe-vesting/react/useFactoryInitCodeHash.ts:10 |
UseGetClaimableAmountArgs
Defined in: fhe-vesting/react/useGetClaimableAmount.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useGetClaimableAmount.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useGetClaimableAmount.ts:10 |
UseGetSettledAmountArgs
Defined in: fhe-vesting/react/useGetSettledAmount.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useGetSettledAmount.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useGetSettledAmount.ts:10 |
UseGetTotalAllocationArgs
Defined in: fhe-vesting/react/useGetTotalAllocation.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useGetTotalAllocation.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useGetTotalAllocation.ts:10 |
UseGetVestedAmountArgs
Defined in: fhe-vesting/react/useGetVestedAmount.ts:8
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
vestingId | `0x${(...)}` | - | fhe-vesting/react/useGetVestedAmount.ts:9 |
timestamp | number | Unix timestamp (seconds) — Math.floor(Date.now() / 1000) for "now". | fhe-vesting/react/useGetVestedAmount.ts:11 |
account? | ... | ... | ... | - | fhe-vesting/react/useGetVestedAmount.ts:12 |
UseGrantRoleArgs
Defined in: fhe-vesting/react/useGrantRole.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
role | `0x${(...)}` | fhe-vesting/react/useGrantRole.ts:8 |
accountTarget | `0x${(...)}` | fhe-vesting/react/useGrantRole.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useGrantRole.ts:10 |
UseHasRoleArgs
Defined in: fhe-vesting/react/useHasRole.ts:6
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
role? | ... | ... | - | - | fhe-vesting/react/useHasRole.ts:7 |
account? | ... | ... | - | - | fhe-vesting/react/useHasRole.ts:8 |
UseIsRecipientArgs
Defined in: fhe-vesting/react/useIsRecipient.ts:6
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
account? | ... | ... | - | - | fhe-vesting/react/useIsRecipient.ts:7 |
ManagerFeeInfo
Defined in: fhe-vesting/react/useManagerFeeInfo.ts:12
Immutable fee configuration baked into a manager clone's bytecode.
Pass fee as value on useClaim/useAdminClaim/usePartialClaim calls
when feeType === FeeType.Gas.
Properties
| Property | Type | Defined in |
|---|---|---|
feeType | FeeType | fhe-vesting/react/useManagerFeeInfo.ts:13 |
fee | bigint | fhe-vesting/react/useManagerFeeInfo.ts:14 |
UsePauseArgs
Defined in: fhe-vesting/react/usePause.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
account? | ... | ... | ... | fhe-vesting/react/usePause.ts:8 |
UsePendingVestingTransferArgs
Defined in: fhe-vesting/react/usePendingVestingTransfer.ts:7
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
vestingId? | ... | ... | - | - | fhe-vesting/react/usePendingVestingTransfer.ts:8 |
UseRecipientVestingsArgs
Defined in: fhe-vesting/react/useRecipientVestings.ts:6
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
recipient? | ... | ... | - | - | fhe-vesting/react/useRecipientVestings.ts:7 |
UseRecipientVestingsLengthArgs
Defined in: fhe-vesting/react/useRecipientVestingsLength.ts:6
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
recipient? | ... | ... | - | - | fhe-vesting/react/useRecipientVestingsLength.ts:7 |
UseRecipientVestingsSlicedArgs
Defined in: fhe-vesting/react/useRecipientVestingsSliced.ts:6
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
recipient? | ... | ... | - | - | fhe-vesting/react/useRecipientVestingsSliced.ts:7 |
start? | ... | ... | - | - | fhe-vesting/react/useRecipientVestingsSliced.ts:8 |
end? | ... | ... | - | - | fhe-vesting/react/useRecipientVestingsSliced.ts:9 |
UseRenounceRoleArgs
Defined in: fhe-vesting/react/useRenounceRole.ts:7
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
role | `0x${(...)}` | - | fhe-vesting/react/useRenounceRole.ts:8 |
callerConfirm | `0x${(...)}` | Per OpenZeppelin AccessControl semantics — this MUST equal msg.sender. | fhe-vesting/react/useRenounceRole.ts:10 |
account? | ... | ... | ... | - | fhe-vesting/react/useRenounceRole.ts:11 |
UseResetGasFeeArgs
Defined in: fhe-vesting/react/useResetGasFee.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
account? | ... | ... | ... | fhe-vesting/react/useResetGasFee.ts:8 |
UseResetTokenFeeArgs
Defined in: fhe-vesting/react/useResetTokenFee.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
account? | ... | ... | ... | fhe-vesting/react/useResetTokenFee.ts:8 |
UseRevokeRoleArgs
Defined in: fhe-vesting/react/useRevokeRole.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
role | `0x${(...)}` | fhe-vesting/react/useRevokeRole.ts:8 |
accountTarget | `0x${(...)}` | fhe-vesting/react/useRevokeRole.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useRevokeRole.ts:10 |
UseRevokeVestingArgs
Defined in: fhe-vesting/react/useRevokeVesting.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
vestingId | `0x${(...)}` | fhe-vesting/react/useRevokeVesting.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useRevokeVesting.ts:9 |
RoleConstants
Defined in: fhe-vesting/react/useRoleConstants.ts:6
Properties
| Property | Type | Defined in |
|---|---|---|
DEFAULT_ADMIN_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:7 |
VESTING_CREATOR_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:8 |
REVOKER_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:9 |
WITHDRAWER_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:10 |
CLAIMER_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:11 |
FEE_COLLECTOR_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:12 |
PAUSER_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:13 |
DISCLOSURE_ADMIN_ROLE | `0x${(...)}` | fhe-vesting/react/useRoleConstants.ts:14 |
UseSetCustomFeeArgs
Defined in: fhe-vesting/react/useSetCustomFee.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
creator | `0x${(...)}` | fhe-vesting/react/useSetCustomFee.ts:9 |
feeType | FeeType | fhe-vesting/react/useSetCustomFee.ts:10 |
gasFee | bigint | fhe-vesting/react/useSetCustomFee.ts:11 |
tokenFee | bigint | fhe-vesting/react/useSetCustomFee.ts:12 |
account? | ... | ... | ... | fhe-vesting/react/useSetCustomFee.ts:13 |
UseSetDefaultFeeTypeArgs
Defined in: fhe-vesting/react/useSetDefaultFeeType.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
feeType | FeeType | fhe-vesting/react/useSetDefaultFeeType.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useSetDefaultFeeType.ts:10 |
UseSetDefaultGasFeeArgs
Defined in: fhe-vesting/react/useSetDefaultGasFee.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
fee | bigint | fhe-vesting/react/useSetDefaultGasFee.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useSetDefaultGasFee.ts:9 |
UseSetDefaultTokenFeeArgs
Defined in: fhe-vesting/react/useSetDefaultTokenFee.ts:7
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
feeBps | bigint | Basis points (1 bps = 0.01 %). | fhe-vesting/react/useSetDefaultTokenFee.ts:9 |
account? | ... | ... | ... | - | fhe-vesting/react/useSetDefaultTokenFee.ts:10 |
UseSetFeeCollectorArgs
Defined in: fhe-vesting/react/useSetFeeCollector.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
newCollector | `0x${(...)}` | fhe-vesting/react/useSetFeeCollector.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useSetFeeCollector.ts:9 |
UseSetMaxBatchSizeArgs
Defined in: fhe-vesting/react/useSetMaxBatchSize.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
newMax | bigint | fhe-vesting/react/useSetMaxBatchSize.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useSetMaxBatchSize.ts:9 |
UseSetMaxRevokeBatchSizeArgs
Defined in: fhe-vesting/react/useSetMaxRevokeBatchSize.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
newMax | ... | ... | fhe-vesting/react/useSetMaxRevokeBatchSize.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useSetMaxRevokeBatchSize.ts:9 |
UseTransferFeeCollectorRoleArgs
Defined in: fhe-vesting/react/useTransferFeeCollectorRole.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
newCollector | `0x${(...)}` | fhe-vesting/react/useTransferFeeCollectorRole.ts:8 |
account? | ... | ... | ... | fhe-vesting/react/useTransferFeeCollectorRole.ts:9 |
UseUnpauseArgs
Defined in: fhe-vesting/react/useUnpause.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
account? | ... | ... | ... | fhe-vesting/react/useUnpause.ts:8 |
UseVestingInfoArgs
Defined in: fhe-vesting/react/useVestingInfo.ts:7
Per-hook overrides for FHE-vesting manager hooks — address is required (per-user clone).
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
address | `0x${(...)}` | - | ManagerHookOptions.address | fhe-vesting/react/_shared.ts:48 |
encryptor? | ... | ... | Lazy or eager encryptor source. Optional at hook level; required at call time for methods that submit encrypted inputs (useCreateVesting, useBatchCreateVesting, usePartialClaim, useAdminPartialClaim, useSplitVesting, useWithdrawAdmin, useWithdrawTokenFee). Recommended in React: capture useZamaSDK() once at the top of your component and wire encryptor: () => sdk.relayer — the SDK calls this per-encryption so it picks up the live ZamaSDK instance rather than a stale capture (CLAUDE.md Pitfall #3). An eager Encryptor instance also type-checks and is appropriate for server-side or test code. The SDK does NOT call useZamaSDK() automatically — calling a React hook from inside a mutation body would violate the rules of hooks. If encryptor is omitted and a method that needs one runs, the SDK throws TokenOpsSdkError("Missing encryptor — pass ..."). | ManagerHookOptions.encryptor | fhe-vesting/react/_shared.ts:66 |
aclAddress? | ... | ... | Override the FHEVM ACL address (defaults to chain-id lookup). | ManagerHookOptions.aclAddress | fhe-vesting/react/_shared.ts:68 |
chainId? | ... | ... | Override the chain id used for ACL/public-client lookup. Defaults to usePublicClient().chain?.id. | ManagerHookOptions.chainId | fhe-vesting/react/_shared.ts:70 |
telemetry? | ... | ... | Optional telemetry adapter. Forwarded into the headless client so spans and *.client.init events from manager.* writes flow through whichever sink the consumer wires up. | ManagerHookOptions.telemetry | fhe-vesting/react/_shared.ts:76 |
vestingId? | ... | ... | - | - | fhe-vesting/react/useVestingInfo.ts:8 |
UseWithdrawAdminArgs
Defined in: fhe-vesting/react/useWithdrawAdmin.ts:9
Properties
| Property | Type | Defined in |
|---|---|---|
amount | bigint | fhe-vesting/react/useWithdrawAdmin.ts:10 |
encryptor? | ... | ... | fhe-vesting/react/useWithdrawAdmin.ts:11 |
encryptedInput? | ... | ... | fhe-vesting/react/useWithdrawAdmin.ts:12 |
account? | ... | ... | ... | fhe-vesting/react/useWithdrawAdmin.ts:13 |
UseWithdrawGasFeeArgs
Defined in: fhe-vesting/react/useWithdrawGasFee.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
to | `0x${(...)}` | fhe-vesting/react/useWithdrawGasFee.ts:8 |
amount | bigint | fhe-vesting/react/useWithdrawGasFee.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useWithdrawGasFee.ts:10 |
UseWithdrawOtherConfidentialTokenArgs
Defined in: fhe-vesting/react/useWithdrawOtherConfidentialToken.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
token | `0x${(...)}` | fhe-vesting/react/useWithdrawOtherConfidentialToken.ts:8 |
to | `0x${(...)}` | fhe-vesting/react/useWithdrawOtherConfidentialToken.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useWithdrawOtherConfidentialToken.ts:10 |
UseWithdrawOtherTokenArgs
Defined in: fhe-vesting/react/useWithdrawOtherToken.ts:7
Properties
| Property | Type | Defined in |
|---|---|---|
token | `0x${(...)}` | fhe-vesting/react/useWithdrawOtherToken.ts:8 |
to | `0x${(...)}` | fhe-vesting/react/useWithdrawOtherToken.ts:9 |
account? | ... | ... | ... | fhe-vesting/react/useWithdrawOtherToken.ts:10 |
UseWithdrawTokenFeeArgs
Defined in: fhe-vesting/react/useWithdrawTokenFee.ts:9
Properties
| Property | Type | Defined in |
|---|---|---|
to | `0x${(...)}` | fhe-vesting/react/useWithdrawTokenFee.ts:10 |
amount | bigint | fhe-vesting/react/useWithdrawTokenFee.ts:11 |
encryptor? | ... | ... | fhe-vesting/react/useWithdrawTokenFee.ts:12 |
encryptedInput? | ... | ... | fhe-vesting/react/useWithdrawTokenFee.ts:13 |
account? | ... | ... | ... | fhe-vesting/react/useWithdrawTokenFee.ts:14 |
Functions
useAcceptVestingTransfer()
function useAcceptVestingTransfer(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAcceptVestingTransfer.ts:16
Accept a pending vesting transfer — called by the proposed newRecipient
before expiresAt.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminBatchDiscloseToParty()
function useAdminBatchDiscloseToParty(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminBatchDiscloseToParty.ts:20
Admin variant of useBatchDiscloseToParty — caller must hold
DISCLOSURE_ADMIN_ROLE. Same { hash, handles } receipt-parsed result.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminClaim()
function useAdminClaim(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminClaim.ts:12
Admin variant of useClaim — caller must hold CLAIMER_ROLE. Useful
for sweep / forced-claim flows initiated by a treasury.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminDiscloseToParty()
function useAdminDiscloseToParty(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminDiscloseToParty.ts:11
Admin variant of useDiscloseToParty — caller must hold
DISCLOSURE_ADMIN_ROLE. Same { hash, handle } receipt-parsed result.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminGetClaimableAmount()
function useAdminGetClaimableAmount(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminGetClaimableAmount.ts:17
Admin variant of useGetClaimableAmount — caller must hold
DISCLOSURE_ADMIN_ROLE. Submits a tx; returns an euint128 handle.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminGetSettledAmount()
function useAdminGetSettledAmount(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminGetSettledAmount.ts:17
Admin variant of useGetSettledAmount — caller must hold
DISCLOSURE_ADMIN_ROLE. Submits a tx; returns an euint128 handle.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminGetTokenBalance()
function useAdminGetTokenBalance(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminGetTokenBalance.ts:17
Admin: read the manager clone's confidential ERC-7984 token balance as an
euint64 handle. Submits a tx and parses the handle from the ACL Allowed
event.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminGetTotalAllocation()
function useAdminGetTotalAllocation(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminGetTotalAllocation.ts:17
Admin variant of useGetTotalAllocation — caller must hold
DISCLOSURE_ADMIN_ROLE. Submits a tx; returns an euint128 handle.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminGetVestedAmount()
function useAdminGetVestedAmount(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminGetVestedAmount.ts:19
Admin variant of useGetVestedAmount — caller must hold
DISCLOSURE_ADMIN_ROLE. Submits a tx; returns an euint128 handle granted
to the admin caller. Pass data.handle to the Zama relayer's userDecrypt.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAdminPartialClaim()
function useAdminPartialClaim(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useAdminPartialClaim.ts:11
Admin variant of usePartialClaim — caller must hold CLAIMER_ROLE.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useAllRecipients()
function useAllRecipients(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useAllRecipients.ts:10
Read the manager clone's full recipients set. For large vestings, prefer useAllRecipientsSliced to keep payloads bounded.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useAllRecipientsLength()
function useAllRecipientsLength(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useAllRecipientsLength.ts:8
Read the total number of unique recipients on this manager clone.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useAllRecipientsSliced()
function useAllRecipientsSliced(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useAllRecipientsSliced.ts:16
Read a [start, end) slice of the recipients set. Both start and end
must be set for the query to be enabled. Pair with useAllRecipientsLength
for paginated UIs.
Parameters
| Parameter | Type |
|---|---|
args | UseAllRecipientsSlicedArgs |
Returns
UseQueryResult<..., ...>
useBatchCreateVesting()
function useBatchCreateVesting(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useBatchCreateVesting.ts:27
Batch-create confidential vesting schedules. All amounts are encrypted
together under one input proof, saving gas vs. N separate useCreateVesting
calls.
Respect useManagerMaxBatchSize before submitting large lists.
After success, invalidate ["tokenops-sdk", "fhe-vesting"] (broad) or the
narrower recipient/vesting query keys.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const batch = useBatchCreateVesting({ address: managerAddress, encryptor: () => useZamaSDK() });
batch.mutate({
items: [
{ params: paramsA, amount: 100_000n },
{ params: paramsB, amount: 200_000n },
],
});
useBatchDiscloseHandlesToParty()
function useBatchDiscloseHandlesToParty(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useBatchDiscloseHandlesToParty.ts:17
Batch variant of useDiscloseHandleToParty. The SDK throws if
handles is empty.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useBatchDiscloseToParty()
function useBatchDiscloseToParty(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useBatchDiscloseToParty.ts:22
Recipient batch-discloses N encrypted fields across N vestings to a single
party. vestingIds.length must equal disclosureTypes.length. Returns
{ hash, handles } — handles[i] is the granted euint128 for
vestingIds[i], parsed from the receipt's AmountDisclosed events.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useBatchRevokeVesting()
function useBatchRevokeVesting(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useBatchRevokeVesting.ts:16
Batch-revoke up to maxRevokeBatchSize vestings. Caller must hold
REVOKER_ROLE. The SDK throws if vestingIds is empty.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useCancelVestingTransfer()
function useCancelVestingTransfer(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useCancelVestingTransfer.ts:16
Cancel a pending vesting transfer — called by the initiator before the recipient accepts.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useClaim()
function useClaim(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useClaim.ts:22
Claim the currently-claimable amount on a vesting schedule.
For FeeType.Gas managers, pass args.value = fee — use
useManagerFeeInfo to read it. For FeeType.DistributionToken,
omit value.
After success, invalidate useGetClaimableAmount (the encrypted view) and
any UI counts you computed off it.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const claim = useClaim({ address: managerAddress });
claim.mutate({ vestingId, value: gasFee });
useConfidentialVestingFactoryImplementation()
function useConfidentialVestingFactoryImplementation(options?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useConfidentialVestingFactoryImplementation.ts:13
Read the FHE-vesting factory's current implementation() address — the
LibClone target every new manager clone delegates to.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseQueryResult<..., ...>
Example
const { data: implementation } = useConfidentialVestingFactoryImplementation();
useCreateManager()
function useCreateManager(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useCreateManager.ts:35
Deploy a new ConfidentialVestingManager clone via the factory.
Returns only a tx hash — not the manager address. The factory packs the deployment block number into the clone's immutable args, so the address is only knowable after the tx mines.
For the common "deploy a clone and use its address" flow, prefer
useCreateManagerAndGetAddress — same submission, but it parses the
ManagerCreated event from the receipt and returns the address in one call.
After a successful create, you should invalidate any factory-level queries
that depend on per-creator state (e.g. useFactoryCustomFee({ creator })):
const queryClient = useQueryClient();
const create = useCreateManager();
create.mutate(args, {
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-vesting"] });
},
});
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const create = useCreateManager();
create.mutate({ token, userSalt });
useCreateManagerAndGetAddress()
function useCreateManagerAndGetAddress(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useCreateManagerAndGetAddress.ts:34
Recommended factory entry point. Deploy a new
ConfidentialVestingManager clone and resolve its address from the
ManagerCreated event in the tx receipt — in one call.
Internally: createManager → waitForTransactionReceipt →
parseEventLogs({ eventName: "ManagerCreated" }).
After a successful create, invalidate factory queries that depend on per-creator state:
const queryClient = useQueryClient();
const create = useCreateManagerAndGetAddress();
create.mutate(args, {
onSuccess: ({ manager }) => {
queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-vesting"] });
navigate(`/manager/${manager}`);
},
});
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const create = useCreateManagerAndGetAddress();
create.mutate({ token, userSalt });
// create.data → { hash, manager }
useCreateVesting()
function useCreateVesting(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useCreateVesting.ts:41
Create a single confidential vesting schedule. The SDK encrypts the
plaintext amount into an externalEuint64 and submits it with an input
proof — callers never handle ciphertext.
Encryptor resolution. The hook-level encryptor (from
ManagerHookOptions) is forwarded lazily to the SDK client. You can also
pass encryptor per-mutation via args.encryptor to override it. If
neither is present, the SDK throws Missing encryptor — pass encryptor…
verbatim.
After a successful create, invalidate read queries that depend on recipient/vesting state:
const queryClient = useQueryClient();
const create = useCreateVesting({ address: managerAddress });
create.mutate(args, {
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-vesting"] });
},
});
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const create = useCreateVesting({ address: managerAddress, encryptor: () => useZamaSDK() });
create.mutate({
params: { recipient, startTimestamp, endTimestamp, cliffSeconds: 0,
releaseIntervalSecs: 86400, timelockSeconds: 0,
initialUnlockBps: 0, cliffAmountBps: 0, isRevocable: false },
amount: 1_000_000n,
});
useDirectVestingTransfer()
function useDirectVestingTransfer(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useDirectVestingTransfer.ts:17
Directly transfer a vesting to newOwner — one-step variant. The contract
gates this on appropriate role membership.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useDisableCustomFee()
function useDisableCustomFee(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useDisableCustomFee.ts:18
Admin: disable the per-creator fee override for creator. New managers from
that creator will fall back to the factory defaults.
After success, invalidate useFactoryCustomFee({ creator }).
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useDiscloseHandleToParty()
function useDiscloseHandleToParty(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useDiscloseHandleToParty.ts:18
Grant party decrypt access to an arbitrary already-allowed handle you
own. Typical use: forward a handle returned by useGetClaimableAmount to
an auditor without leaking plaintext.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useDiscloseToParty()
function useDiscloseToParty(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useDiscloseToParty.ts:17
Recipient discloses a single encrypted field of their own vesting to a
party — grants ACL persistently so the party can userDecrypt the handle.
disclosureType selects which field (total / settled / vested / claimable).
Returns { hash, handle } — handle is the granted euint128, parsed from
the receipt's AmountDisclosed event. Pass it to the Zama relayer's
userDecrypt from the party side to obtain the plaintext.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useFactoryCustomFee()
function useFactoryCustomFee(args?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useFactoryCustomFee.ts:20
Read the per-creator fee override set on the factory for creator. Returns
{ enabled: false, ... } when no override exists.
Parameters
| Parameter | Type |
|---|---|
args | UseFactoryCustomFeeArgs |
Returns
UseQueryResult<..., ...>
Example
const { data: customFee } = useFactoryCustomFee({ creator });
if (customFee?.enabled) { ... use customFee.gasFee/tokenFee ... }
useFactoryDefaultFeeType()
function useFactoryDefaultFeeType(options?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useFactoryDefaultFeeType.ts:13
Read the factory-wide default fee model (FeeType.Gas or
FeeType.DistributionToken) applied to newly-created manager clones.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseQueryResult<..., ...>
Example
const { data: defaultFeeType } = useFactoryDefaultFeeType();
useFactoryDefaultGasFee()
function useFactoryDefaultGasFee(options?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useFactoryDefaultGasFee.ts:12
Read the factory-wide default gas fee (in wei) — applied to new
FeeType.Gas manager clones at deployment.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseQueryResult<..., ...>
Example
const { data: defaultGasFee } = useFactoryDefaultGasFee();
useFactoryDefaultTokenFee()
function useFactoryDefaultTokenFee(options?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useFactoryDefaultTokenFee.ts:12
Read the factory-wide default token fee in basis points — applied to new
FeeType.DistributionToken manager clones at deployment.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseQueryResult<..., ...>
Example
const { data: defaultTokenFee } = useFactoryDefaultTokenFee();
useFactoryFeeCollector()
function useFactoryFeeCollector(options?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useFactoryFeeCollector.ts:12
Read the factory's current fee collector address.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseQueryResult<..., ...>
Example
const { data: feeCollector } = useFactoryFeeCollector();
useFactoryInitCodeHash()
function useFactoryInitCodeHash(args?): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useFactoryInitCodeHash.ts:21
Read the init-code hash the factory would use to CREATE2 a manager clone
with the given token + deployer (+ optional immutable flags). Mirrors
Solidity's getInitCodeHash / getInitCodeHashWithOptions selector.
Parameters
| Parameter | Type |
|---|---|
args | UseFactoryInitCodeHashArgs |
Returns
UseQueryResult<..., ...>
Example
const { data: initCodeHash } = useFactoryInitCodeHash({ token, deployer });
useGetClaimableAmount()
function useGetClaimableAmount(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useGetClaimableAmount.ts:17
Submits a transaction to read the currently-claimable amount as an
euint128 handle. Pass data.handle to the Zama relayer's userDecrypt.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useGetSettledAmount()
function useGetSettledAmount(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useGetSettledAmount.ts:18
Submits a transaction to read the already-claimed (settled) amount of a
vesting as an euint128 handle. Pass data.handle to the Zama relayer's
userDecrypt.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useGetTotalAllocation()
function useGetTotalAllocation(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useGetTotalAllocation.ts:17
Submits a transaction to read the total allocation of a vesting as an
euint128 handle. Pass data.handle to the Zama relayer's userDecrypt.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useGetVestedAmount()
function useGetVestedAmount(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useGetVestedAmount.ts:29
Submits a transaction to read the vested amount at a given timestamp as
an euint128 handle. The contract performs FHE.allow(handle, msg.sender)
so persistent ACL is granted to the caller; the SDK parses the handle from
the receipt's ACL.Allowed event (NOT from simulation — that returns a
different, ACL-less handle).
Pass data.handle to the Zama relayer's userDecrypt to get the plaintext.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const getVested = useGetVestedAmount({ address: managerAddress });
getVested.mutate({ vestingId, timestamp: Math.floor(Date.now() / 1000) });
// getVested.data → { handle: "0x...", hash: "0x..." }
useGrantRole()
function useGrantRole(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useGrantRole.ts:19
AccessControl: grant role to accountTarget. Caller must be a member of
the role's admin role (typically DEFAULT_ADMIN_ROLE).
After success, invalidate useHasRole({ role, account: accountTarget }).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useHasRole()
function useHasRole(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useHasRole.ts:17
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.
Parameters
| Parameter | Type |
|---|---|
args | UseHasRoleArgs |
Returns
UseQueryResult<..., ...>
useInitiateVestingTransfer()
function useInitiateVestingTransfer(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useInitiateVestingTransfer.ts:15
Initiate a two-step transfer of a vesting to a new owner. The new owner
must call useAcceptVestingTransfer within transferDurationSeconds
or the transfer expires.
After success, invalidate usePendingVestingTransfer({ vestingId }).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useIsRecipient()
function useIsRecipient(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useIsRecipient.ts:13
Read whether account is currently a recipient on this manager clone.
Parameters
| Parameter | Type |
|---|---|
args | UseIsRecipientArgs |
Returns
UseQueryResult<..., ...>
useManagerDeploymentBlockNumber()
function useManagerDeploymentBlockNumber(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerDeploymentBlockNumber.ts:9
Read the manager clone's immutable DEPLOYMENT_BLOCK_NUMBER — the block at
which the factory deployed this clone via LibClone.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerFee()
function useManagerFee(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerFee.ts:9
Read the manager clone's immutable FEE (in wei for FeeType.Gas, in basis
points for FeeType.DistributionToken).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerFeeInfo()
function useManagerFeeInfo(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerFeeInfo.ts:21
Read the manager clone's { feeType, fee } in one round-trip. Both fields
are immutable, so the result can be cached for the manager's lifetime.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerFeeType()
function useManagerFeeType(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerFeeType.ts:9
Read the manager clone's immutable FEE_TYPE (FeeType.Gas or FeeType.DistributionToken).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerIsPausable()
function useManagerIsPausable(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerIsPausable.ts:8
Read whether the manager clone has pause/unpause enabled (immutable).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerIsSplitEnabled()
function useManagerIsSplitEnabled(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerIsSplitEnabled.ts:8
Read whether the manager clone has split-vesting enabled (immutable).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerMaxBatchSize()
function useManagerMaxBatchSize(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerMaxBatchSize.ts:8
Read the manager clone's maxBatchSize — upper bound for batchCreateVesting.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerMaxRevokeBatchSize()
function useManagerMaxRevokeBatchSize(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerMaxRevokeBatchSize.ts:8
Read the manager clone's maxRevokeBatchSize — upper bound for batchRevokeVesting.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerPaused()
function useManagerPaused(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerPaused.ts:8
Read whether the manager clone is currently paused.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useManagerToken()
function useManagerToken(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useManagerToken.ts:13
Read the manager clone's immutable TOKEN_ADDRESS. Result is cacheable for
the manager's lifetime — the field is baked into the clone's bytecode.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
Example
const { data: token } = useManagerToken({ address: managerAddress });
usePartialClaim()
function usePartialClaim(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/usePartialClaim.ts:18
Partial-claim a specific encrypted amount from a vesting. The SDK encrypts
the plaintext amount (or use args.encryptedInput to bypass).
After success, invalidate useGetClaimableAmount and useGetSettledAmount.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const partial = usePartialClaim({ address: managerAddress, encryptor: () => useZamaSDK() });
partial.mutate({ vestingId, amount: 50_000n, value: gasFee });
usePause()
function usePause(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/usePause.ts:16
Pauser: pause the manager clone — blocks claim, partialClaim,
createVesting, etc. Requires useManagerIsPausable === true and
caller holding PAUSER_ROLE. After success, invalidate useManagerPaused.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
usePendingVestingTransfer()
function usePendingVestingTransfer(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/usePendingVestingTransfer.ts:23
Read the pending transfer (if any) on a vesting — returns
{ newRecipient, initiatedAt, expiresAt }. Zero values when no transfer is pending.
Parameters
| Parameter | Type |
|---|---|
args | UsePendingVestingTransferArgs |
Returns
UseQueryResult<..., ...>
Remarks
Read-after-write race on load-balanced RPCs. Same caveat as
useVestingInfo — immediately after initiateVestingTransfer /
cancelVestingTransfer / acceptVestingTransfer confirm, this hook may
return the pre-write state on providers that fan reads across replicas.
Parse the relevant event (VestingTransferInitiated, etc.) from the write
receipt for immediate post-mutation state.
useRecipientVestings()
function useRecipientVestings(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useRecipientVestings.ts:14
Read all vesting IDs owned by recipient. For large lists, prefer
useRecipientVestingsSliced + useRecipientVestingsLength.
Parameters
| Parameter | Type |
|---|---|
args | UseRecipientVestingsArgs |
Returns
UseQueryResult<..., ...>
useRecipientVestingsLength()
function useRecipientVestingsLength(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useRecipientVestingsLength.ts:13
Read the number of vesting schedules owned by recipient.
Parameters
| Parameter | Type |
|---|---|
args | UseRecipientVestingsLengthArgs |
Returns
UseQueryResult<..., ...>
useRecipientVestingsSliced()
function useRecipientVestingsSliced(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useRecipientVestingsSliced.ts:15
Read a [start, end) slice of recipient's vesting IDs.
Parameters
| Parameter | Type |
|---|---|
args | UseRecipientVestingsSlicedArgs |
Returns
UseQueryResult<..., ...>
useRenounceRole()
function useRenounceRole(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useRenounceRole.ts:20
AccessControl: renounce role from msg.sender. The callerConfirm
address MUST equal the caller (OpenZeppelin's anti-typo guard).
After success, invalidate useHasRole({ role, account: callerConfirm }).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useResetGasFee()
function useResetGasFee(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useResetGasFee.ts:14
Admin: reset the factory's default gas fee to its bytecode-encoded baseline.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useResetTokenFee()
function useResetTokenFee(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useResetTokenFee.ts:14
Admin: reset the factory's default token fee to its bytecode-encoded baseline.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useRevokeRole()
function useRevokeRole(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useRevokeRole.ts:19
AccessControl: revoke role from accountTarget. Caller must be a member
of the role's admin role.
After success, invalidate useHasRole({ role, account: accountTarget }).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useRevokeVesting()
function useRevokeVesting(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useRevokeVesting.ts:19
Revoke a vesting. Caller must hold REVOKER_ROLE and the vesting must have
been created with isRevocable: true.
After success, invalidate useVestingInfo({ vestingId }) and any encrypted
views for that vestingId.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useRoleConstants()
function useRoleConstants(options): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useRoleConstants.ts:22
Read all eight AccessControl role hashes off the manager in one fan-out. Each hash is bytecode-immutable, so this is cacheable indefinitely. Pair with useHasRole for membership checks.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseQueryResult<..., ...>
useSetCustomFee()
function useSetCustomFee(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetCustomFee.ts:22
Admin: install a per-creator fee override on the factory. Takes precedence
over factory defaults for all managers creator deploys after the override.
After success, invalidate useFactoryCustomFee({ creator }) to refresh.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSetDefaultFeeType()
function useSetDefaultFeeType(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetDefaultFeeType.ts:18
Admin: set the factory's default fee model (FeeType.Gas or
FeeType.DistributionToken) for new manager clones. After success, invalidate
["tokenops-sdk", "fhe-vesting", "factory:defaultFeeType"].
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSetDefaultGasFee()
function useSetDefaultGasFee(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetDefaultGasFee.ts:16
Admin: set the factory-wide default gas fee (in wei). After success, invalidate
["tokenops-sdk", "fhe-vesting", "factory:defaultGasFee"] to refresh the read hook.
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSetDefaultTokenFee()
function useSetDefaultTokenFee(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetDefaultTokenFee.ts:17
Admin: set the factory-wide default token fee (basis points). After success,
invalidate ["tokenops-sdk", "fhe-vesting", "factory:defaultTokenFee"].
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSetFeeCollector()
function useSetFeeCollector(options?): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetFeeCollector.ts:17
Admin: set the factory's fee collector address.
After success, invalidate useFactoryFeeCollector().
Parameters
| Parameter | Type |
|---|---|
options | BaseHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSetMaxBatchSize()
function useSetMaxBatchSize(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetMaxBatchSize.ts:16
Admin: bump or lower maxBatchSize (cap for useBatchCreateVesting).
After success, invalidate useManagerMaxBatchSize.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSetMaxRevokeBatchSize()
function useSetMaxRevokeBatchSize(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSetMaxRevokeBatchSize.ts:16
Admin: bump or lower maxRevokeBatchSize (cap for useBatchRevokeVesting).
After success, invalidate useManagerMaxRevokeBatchSize.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useSplitVesting()
function useSplitVesting(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useSplitVesting.ts:31
Split a vesting into two positions by encrypted numerator/denominator share.
The SDK auto-scales the plaintext ratio via scaleRatio to the universal
privacy-preserving constant FHE_SPLIT_DENOMINATOR (90_090_000
= LCM(1..16, 10_000)) unless args.preScaled is set. The SDK encrypts
numerator — pass plaintext.
For exact-integer ratios use the share builder:
share.fraction(1, 7) (m ≤ 16) or share.basisPoints(250) (bps ≤ 10_000),
then pass preScaled: true.
Returns { hash, newVestingId } — the id of the split-off vesting, parsed
from the receipt's VestingSplit event. Required for any follow-up call
(claim, transfer, disclose) on the new position.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
Example
const split = useSplitVesting({ address: managerAddress, encryptor: () => useZamaSDK() });
const { newVestingId } = await split.mutateAsync({
vestingId,
numerator: 1n, denominator: 2n, // 50% split, SDK scales automatically
newRecipient: "0xNewRecipient",
});
useTransferFeeCollectorRole()
function useTransferFeeCollectorRole(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useTransferFeeCollectorRole.ts:16
Transfer the FEE_COLLECTOR_ROLE to newCollector. The current
fee-collector calls this; the new collector gains immediate role membership.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useUnpause()
function useUnpause(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useUnpause.ts:15
Pauser: unpause the manager clone. After success, invalidate
useManagerPaused.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useVestingInfo()
function useVestingInfo(args): UseQueryResult<..., ...>;
Defined in: fhe-vesting/react/useVestingInfo.ts:28
Read the plaintext snapshot of a vesting schedule — recipient, timestamps, unlock bps, revocability flag. Amounts are encrypted and NOT in this payload — use useGetTotalAllocation / useGetVestedAmount for encrypted-amount handles.
Parameters
| Parameter | Type |
|---|---|
args | UseVestingInfoArgs |
Returns
UseQueryResult<..., ...>
Remarks
Read-after-write race on load-balanced RPCs. Calling this hook
immediately after a write tx's receipt confirms (e.g. createVesting,
initiateVestingTransfer) can return stale zero values on providers that
fan out across read-replicas (Alchemy, Infura, public-RPC pools): the write
has confirmed on one node but the replica serving this read hasn't caught
up. For post-mutation state, prefer parsing the relevant event from the
write's receipt (VestingCreated, VestingTransferInitiated, etc.) and
invalidating the query on the next render — the replica lag is usually
< 1 block by then.
useWithdrawAdmin()
function useWithdrawAdmin(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useWithdrawAdmin.ts:21
Admin: withdraw an encrypted amount of the manager's distribution token to
msg.sender. Caller must hold WITHDRAWER_ROLE. The SDK encrypts amount
(or pass encryptedInput to bypass).
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useWithdrawGasFee()
function useWithdrawGasFee(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useWithdrawGasFee.ts:17
Fee collector: withdraw collected gas-fee ETH (FeeType.Gas managers).
Caller must hold FEE_COLLECTOR_ROLE.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useWithdrawOtherConfidentialToken()
function useWithdrawOtherConfidentialToken(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useWithdrawOtherConfidentialToken.ts:17
Admin: rescue an ERC-7984 (confidential) token other than this manager's
configured token. Caller must hold WITHDRAWER_ROLE.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useWithdrawOtherToken()
function useWithdrawOtherToken(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useWithdrawOtherToken.ts:17
Admin: rescue an ERC-20 (non-confidential) other than this manager's
configured token. Caller must hold WITHDRAWER_ROLE.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>
useWithdrawTokenFee()
function useWithdrawTokenFee(options): UseMutationResult<..., ..., ...>;
Defined in: fhe-vesting/react/useWithdrawTokenFee.ts:22
Fee collector: withdraw collected distribution-token fees
(FeeType.DistributionToken managers). SDK encrypts amount (or pass
encryptedInput). Caller must hold FEE_COLLECTOR_ROLE.
Parameters
| Parameter | Type |
|---|---|
options | ManagerHookOptions |
Returns
UseMutationResult<..., ..., ...>