@tokenops/sdk 1.0.0

package/dist/fhe-vesting/react/index.d.cts

@@ -0,0 +1,123 @@
+/**
+ * React/wagmi hooks for `@tokenops/sdk/fhe-vesting`.
+ *
+ * Every public method on the headless `ConfidentialVestingFactoryClient` and
+ * `ConfidentialVestingManagerClient` is wrapped as a hook here. Hooks compose
+ * with wagmi (`usePublicClient`, `useWalletClient`) and TanStack Query
+ * (`useQuery`, `useMutation`) — no extra provider needed beyond the standard
+ * wagmi `<WagmiProvider>` + `<QueryClientProvider>`.
+ *
+ * **Encryptor.** For methods that submit encrypted inputs, pass an explicit
+ * `encryptor` source (eager `Encryptor` or `() => Encryptor | undefined`).
+ * `useZamaSDK()` returns `ZamaSDK`; the encrypt-capable interface lives on
+ * `.relayer`. Wire it as a lazy factory so the SDK picks up the live React
+ * context at submit time (CLAUDE.md Pitfall #3):
+ *
+ * ```ts
+ * import { useZamaSDK } from "@zama-fhe/react-sdk";
+ *
+ * function Component({ managerAddress }) {
+ *   const zamaSDK = useZamaSDK();
+ *   const create = useCreateVesting({
+ *     address: managerAddress,
+ *     encryptor: () => zamaSDK.relayer,
+ *   });
+ *   ...
+ * }
+ * ```
+ *
+ * `@zama-fhe/react-sdk` is an **OPTIONAL** peer dep — install it explicitly
+ * (`pnpm add @zama-fhe/react-sdk`) for FHE flows. The hook surface here never
+ * imports it at top level; consumers without FHE pay no cost.
+ *
+ * Mutations do NOT auto-invalidate read queries — that's a consumer decision.
+ * Each mutation's TSDoc documents the recommended `queryClient.invalidateQueries`.
+ */
+export { useConfidentialVestingFactoryImplementation } from "./useConfidentialVestingFactoryImplementation.js";
+export { useFactoryDefaultGasFee } from "./useFactoryDefaultGasFee.js";
+export { useFactoryDefaultTokenFee } from "./useFactoryDefaultTokenFee.js";
+export { useFactoryDefaultFeeType } from "./useFactoryDefaultFeeType.js";
+export { useFactoryFeeCollector } from "./useFactoryFeeCollector.js";
+export { useFactoryCustomFee, type UseFactoryCustomFeeArgs } from "./useFactoryCustomFee.js";
+export { useFactoryInitCodeHash, type UseFactoryInitCodeHashArgs, } from "./useFactoryInitCodeHash.js";
+export { useCreateManagerAndGetAddress } from "./useCreateManagerAndGetAddress.js";
+export { useCreateManager } from "./useCreateManager.js";
+export { useSetDefaultGasFee, type UseSetDefaultGasFeeArgs } from "./useSetDefaultGasFee.js";
+export { useSetDefaultTokenFee, type UseSetDefaultTokenFeeArgs } from "./useSetDefaultTokenFee.js";
+export { useSetDefaultFeeType, type UseSetDefaultFeeTypeArgs } from "./useSetDefaultFeeType.js";
+export { useResetGasFee, type UseResetGasFeeArgs } from "./useResetGasFee.js";
+export { useResetTokenFee, type UseResetTokenFeeArgs } from "./useResetTokenFee.js";
+export { useSetCustomFee, type UseSetCustomFeeArgs } from "./useSetCustomFee.js";
+export { useDisableCustomFee, type UseDisableCustomFeeArgs } from "./useDisableCustomFee.js";
+export { useSetFeeCollector, type UseSetFeeCollectorArgs } from "./useSetFeeCollector.js";
+export { useManagerToken } from "./useManagerToken.js";
+export { useManagerFeeType } from "./useManagerFeeType.js";
+export { useManagerFee } from "./useManagerFee.js";
+export { useManagerFeeInfo, type ManagerFeeInfo } from "./useManagerFeeInfo.js";
+export { useManagerDeploymentBlockNumber } from "./useManagerDeploymentBlockNumber.js";
+export { useManagerIsSplitEnabled } from "./useManagerIsSplitEnabled.js";
+export { useManagerIsPausable } from "./useManagerIsPausable.js";
+export { useManagerPaused } from "./useManagerPaused.js";
+export { useManagerMaxBatchSize } from "./useManagerMaxBatchSize.js";
+export { useManagerMaxRevokeBatchSize } from "./useManagerMaxRevokeBatchSize.js";
+export { useVestingInfo, type UseVestingInfoArgs } from "./useVestingInfo.js";
+export { useAllRecipients } from "./useAllRecipients.js";
+export { useAllRecipientsLength } from "./useAllRecipientsLength.js";
+export { useAllRecipientsSliced, type UseAllRecipientsSlicedArgs, } from "./useAllRecipientsSliced.js";
+export { useIsRecipient, type UseIsRecipientArgs } from "./useIsRecipient.js";
+export { useRecipientVestings, type UseRecipientVestingsArgs } from "./useRecipientVestings.js";
+export { useRecipientVestingsLength, type UseRecipientVestingsLengthArgs, } from "./useRecipientVestingsLength.js";
+export { useRecipientVestingsSliced, type UseRecipientVestingsSlicedArgs, } from "./useRecipientVestingsSliced.js";
+export { usePendingVestingTransfer, type UsePendingVestingTransferArgs, } from "./usePendingVestingTransfer.js";
+export { useHasRole, type UseHasRoleArgs } from "./useHasRole.js";
+export { useRoleConstants, type RoleConstants } from "./useRoleConstants.js";
+export { useGetVestedAmount, type UseGetVestedAmountArgs } from "./useGetVestedAmount.js";
+export { useGetClaimableAmount, type UseGetClaimableAmountArgs } from "./useGetClaimableAmount.js";
+export { useGetTotalAllocation, type UseGetTotalAllocationArgs } from "./useGetTotalAllocation.js";
+export { useGetSettledAmount, type UseGetSettledAmountArgs } from "./useGetSettledAmount.js";
+export { useAdminGetVestedAmount, type UseAdminGetVestedAmountArgs, } from "./useAdminGetVestedAmount.js";
+export { useAdminGetClaimableAmount, type UseAdminGetClaimableAmountArgs, } from "./useAdminGetClaimableAmount.js";
+export { useAdminGetTotalAllocation, type UseAdminGetTotalAllocationArgs, } from "./useAdminGetTotalAllocation.js";
+export { useAdminGetSettledAmount, type UseAdminGetSettledAmountArgs, } from "./useAdminGetSettledAmount.js";
+export { useAdminGetTokenBalance, type UseAdminGetTokenBalanceArgs, } from "./useAdminGetTokenBalance.js";
+export { useCreateVesting } from "./useCreateVesting.js";
+export { useBatchCreateVesting } from "./useBatchCreateVesting.js";
+export { useClaim } from "./useClaim.js";
+export { useAdminClaim } from "./useAdminClaim.js";
+export { usePartialClaim } from "./usePartialClaim.js";
+export { useAdminPartialClaim } from "./useAdminPartialClaim.js";
+export { useRevokeVesting, type UseRevokeVestingArgs } from "./useRevokeVesting.js";
+export { useBatchRevokeVesting, type UseBatchRevokeVestingArgs } from "./useBatchRevokeVesting.js";
+export { useSplitVesting } from "./useSplitVesting.js";
+export { useInitiateVestingTransfer } from "./useInitiateVestingTransfer.js";
+export { useAcceptVestingTransfer, type UseAcceptVestingTransferArgs, } from "./useAcceptVestingTransfer.js";
+export { useCancelVestingTransfer, type UseCancelVestingTransferArgs, } from "./useCancelVestingTransfer.js";
+export { useDirectVestingTransfer, type UseDirectVestingTransferArgs, } from "./useDirectVestingTransfer.js";
+export { useDiscloseToParty } from "./useDiscloseToParty.js";
+export { useBatchDiscloseToParty, type UseBatchDiscloseToPartyArgs, } from "./useBatchDiscloseToParty.js";
+export { useAdminDiscloseToParty } from "./useAdminDiscloseToParty.js";
+export { useAdminBatchDiscloseToParty, type UseAdminBatchDiscloseToPartyArgs, } from "./useAdminBatchDiscloseToParty.js";
+export { useDiscloseHandleToParty, type UseDiscloseHandleToPartyArgs, } from "./useDiscloseHandleToParty.js";
+export { useBatchDiscloseHandlesToParty, type UseBatchDiscloseHandlesToPartyArgs, } from "./useBatchDiscloseHandlesToParty.js";
+export { useWithdrawAdmin, type UseWithdrawAdminArgs } from "./useWithdrawAdmin.js";
+export { useWithdrawOtherToken, type UseWithdrawOtherTokenArgs } from "./useWithdrawOtherToken.js";
+export { useWithdrawOtherConfidentialToken, type UseWithdrawOtherConfidentialTokenArgs, } from "./useWithdrawOtherConfidentialToken.js";
+export { useWithdrawGasFee, type UseWithdrawGasFeeArgs } from "./useWithdrawGasFee.js";
+export { useWithdrawTokenFee, type UseWithdrawTokenFeeArgs } from "./useWithdrawTokenFee.js";
+export { useSetMaxBatchSize, type UseSetMaxBatchSizeArgs } from "./useSetMaxBatchSize.js";
+export { useSetMaxRevokeBatchSize, type UseSetMaxRevokeBatchSizeArgs, } from "./useSetMaxRevokeBatchSize.js";
+export { useTransferFeeCollectorRole, type UseTransferFeeCollectorRoleArgs, } from "./useTransferFeeCollectorRole.js";
+export { usePause, type UsePauseArgs } from "./usePause.js";
+export { useUnpause, type UseUnpauseArgs } from "./useUnpause.js";
+export { useGrantRole, type UseGrantRoleArgs } from "./useGrantRole.js";
+export { useRevokeRole, type UseRevokeRoleArgs } from "./useRevokeRole.js";
+export { useRenounceRole, type UseRenounceRoleArgs } from "./useRenounceRole.js";
+export type { BaseHookOptions, ManagerHookOptions } from "./_shared.js";
+export { encryptUint64, encryptUint64Batch, resolveEncryptor, type Encryptor, type EncryptorSource, type EncryptUint64Args, type EncryptUint64BatchArgs, type FheValueInput, } from "../encryption.js";
+export { DisclosureType, FeeType, type CustomFee, type EncryptedInput, type EncryptedInputs, type PendingTransfer, type VestingInfo, type VestingParams, } from "../types.js";
+export type { BatchCreateVestingArgs, ClaimArgs, CreateVestingArgs, DiscloseArgs, EncryptedViewResult, InitiateTransferArgs, PartialClaimArgs, SplitVestingArgs, } from "../manager.js";
+export type { CreateManagerResult, CreateManagerArgs, PredictManagerArgs } from "../factory.js";
+export { scaleRatio, type ScaleRatioArgs, type ScaledRatio } from "../../fhe/scale-ratio.js";
+export { TokenOpsSdkError, isTokenOpsSdkError, DeploymentAddressUnavailableError, UnsupportedChainError, MissingAccountError, MissingClientError, MissingEncryptorError, MissingPublicClientError, MissingWalletClientError, InvalidArgumentError, ReceiptEventAmbiguousError, ReceiptEventNotFoundError, ContractRevertError, PausedError, AccessDeniedError, InsufficientFeeError, InsufficientBalanceError, BatchTooLargeError, FeatureDisabledError, TransferFailedError, FheHandleNotAllowedError, AlreadyInitializedError, ReentrancyError, InvalidSignatureError, WalletRejectedError, WalletChainMismatchError, NetworkError, InsufficientGasFundsError, UnknownWriteFailureError, UserRejectedSignatureError, SigningFailedError, RelayerUnreachableError, EncryptionFailedError, DecryptionFailedError, UserDecryptNotAllowedError, type DeploymentAddressUnavailableReason, type TokenOpsSdkErrorCode, } from "../../core/errors.js";
+export { type PreflightResult } from "../../core/preflight.js";
+export { VestingNotFoundError, NotVestingRecipientError, ClaimLockedError, VestingRevokedError, VestingNotRevocableError, VestingExpiredError, TransferAlreadyPendingError, NoPendingTransferError, NotPendingRecipientError, TransferExpiredError, } from "../errors.js";

package/dist/fhe-vesting/react/index.d.ts

@@ -0,0 +1,123 @@
+/**
+ * React/wagmi hooks for `@tokenops/sdk/fhe-vesting`.
+ *
+ * Every public method on the headless `ConfidentialVestingFactoryClient` and
+ * `ConfidentialVestingManagerClient` is wrapped as a hook here. Hooks compose
+ * with wagmi (`usePublicClient`, `useWalletClient`) and TanStack Query
+ * (`useQuery`, `useMutation`) — no extra provider needed beyond the standard
+ * wagmi `<WagmiProvider>` + `<QueryClientProvider>`.
+ *
+ * **Encryptor.** For methods that submit encrypted inputs, pass an explicit
+ * `encryptor` source (eager `Encryptor` or `() => Encryptor | undefined`).
+ * `useZamaSDK()` returns `ZamaSDK`; the encrypt-capable interface lives on
+ * `.relayer`. Wire it as a lazy factory so the SDK picks up the live React
+ * context at submit time (CLAUDE.md Pitfall #3):
+ *
+ * ```ts
+ * import { useZamaSDK } from "@zama-fhe/react-sdk";
+ *
+ * function Component({ managerAddress }) {
+ *   const zamaSDK = useZamaSDK();
+ *   const create = useCreateVesting({
+ *     address: managerAddress,
+ *     encryptor: () => zamaSDK.relayer,
+ *   });
+ *   ...
+ * }
+ * ```
+ *
+ * `@zama-fhe/react-sdk` is an **OPTIONAL** peer dep — install it explicitly
+ * (`pnpm add @zama-fhe/react-sdk`) for FHE flows. The hook surface here never
+ * imports it at top level; consumers without FHE pay no cost.
+ *
+ * Mutations do NOT auto-invalidate read queries — that's a consumer decision.
+ * Each mutation's TSDoc documents the recommended `queryClient.invalidateQueries`.
+ */
+export { useConfidentialVestingFactoryImplementation } from "./useConfidentialVestingFactoryImplementation.js";
+export { useFactoryDefaultGasFee } from "./useFactoryDefaultGasFee.js";
+export { useFactoryDefaultTokenFee } from "./useFactoryDefaultTokenFee.js";
+export { useFactoryDefaultFeeType } from "./useFactoryDefaultFeeType.js";
+export { useFactoryFeeCollector } from "./useFactoryFeeCollector.js";
+export { useFactoryCustomFee, type UseFactoryCustomFeeArgs } from "./useFactoryCustomFee.js";
+export { useFactoryInitCodeHash, type UseFactoryInitCodeHashArgs, } from "./useFactoryInitCodeHash.js";
+export { useCreateManagerAndGetAddress } from "./useCreateManagerAndGetAddress.js";
+export { useCreateManager } from "./useCreateManager.js";
+export { useSetDefaultGasFee, type UseSetDefaultGasFeeArgs } from "./useSetDefaultGasFee.js";
+export { useSetDefaultTokenFee, type UseSetDefaultTokenFeeArgs } from "./useSetDefaultTokenFee.js";
+export { useSetDefaultFeeType, type UseSetDefaultFeeTypeArgs } from "./useSetDefaultFeeType.js";
+export { useResetGasFee, type UseResetGasFeeArgs } from "./useResetGasFee.js";
+export { useResetTokenFee, type UseResetTokenFeeArgs } from "./useResetTokenFee.js";
+export { useSetCustomFee, type UseSetCustomFeeArgs } from "./useSetCustomFee.js";
+export { useDisableCustomFee, type UseDisableCustomFeeArgs } from "./useDisableCustomFee.js";
+export { useSetFeeCollector, type UseSetFeeCollectorArgs } from "./useSetFeeCollector.js";
+export { useManagerToken } from "./useManagerToken.js";
+export { useManagerFeeType } from "./useManagerFeeType.js";
+export { useManagerFee } from "./useManagerFee.js";
+export { useManagerFeeInfo, type ManagerFeeInfo } from "./useManagerFeeInfo.js";
+export { useManagerDeploymentBlockNumber } from "./useManagerDeploymentBlockNumber.js";
+export { useManagerIsSplitEnabled } from "./useManagerIsSplitEnabled.js";
+export { useManagerIsPausable } from "./useManagerIsPausable.js";
+export { useManagerPaused } from "./useManagerPaused.js";
+export { useManagerMaxBatchSize } from "./useManagerMaxBatchSize.js";
+export { useManagerMaxRevokeBatchSize } from "./useManagerMaxRevokeBatchSize.js";
+export { useVestingInfo, type UseVestingInfoArgs } from "./useVestingInfo.js";
+export { useAllRecipients } from "./useAllRecipients.js";
+export { useAllRecipientsLength } from "./useAllRecipientsLength.js";
+export { useAllRecipientsSliced, type UseAllRecipientsSlicedArgs, } from "./useAllRecipientsSliced.js";
+export { useIsRecipient, type UseIsRecipientArgs } from "./useIsRecipient.js";
+export { useRecipientVestings, type UseRecipientVestingsArgs } from "./useRecipientVestings.js";
+export { useRecipientVestingsLength, type UseRecipientVestingsLengthArgs, } from "./useRecipientVestingsLength.js";
+export { useRecipientVestingsSliced, type UseRecipientVestingsSlicedArgs, } from "./useRecipientVestingsSliced.js";
+export { usePendingVestingTransfer, type UsePendingVestingTransferArgs, } from "./usePendingVestingTransfer.js";
+export { useHasRole, type UseHasRoleArgs } from "./useHasRole.js";
+export { useRoleConstants, type RoleConstants } from "./useRoleConstants.js";
+export { useGetVestedAmount, type UseGetVestedAmountArgs } from "./useGetVestedAmount.js";
+export { useGetClaimableAmount, type UseGetClaimableAmountArgs } from "./useGetClaimableAmount.js";
+export { useGetTotalAllocation, type UseGetTotalAllocationArgs } from "./useGetTotalAllocation.js";
+export { useGetSettledAmount, type UseGetSettledAmountArgs } from "./useGetSettledAmount.js";
+export { useAdminGetVestedAmount, type UseAdminGetVestedAmountArgs, } from "./useAdminGetVestedAmount.js";
+export { useAdminGetClaimableAmount, type UseAdminGetClaimableAmountArgs, } from "./useAdminGetClaimableAmount.js";
+export { useAdminGetTotalAllocation, type UseAdminGetTotalAllocationArgs, } from "./useAdminGetTotalAllocation.js";
+export { useAdminGetSettledAmount, type UseAdminGetSettledAmountArgs, } from "./useAdminGetSettledAmount.js";
+export { useAdminGetTokenBalance, type UseAdminGetTokenBalanceArgs, } from "./useAdminGetTokenBalance.js";
+export { useCreateVesting } from "./useCreateVesting.js";
+export { useBatchCreateVesting } from "./useBatchCreateVesting.js";
+export { useClaim } from "./useClaim.js";
+export { useAdminClaim } from "./useAdminClaim.js";
+export { usePartialClaim } from "./usePartialClaim.js";
+export { useAdminPartialClaim } from "./useAdminPartialClaim.js";
+export { useRevokeVesting, type UseRevokeVestingArgs } from "./useRevokeVesting.js";
+export { useBatchRevokeVesting, type UseBatchRevokeVestingArgs } from "./useBatchRevokeVesting.js";
+export { useSplitVesting } from "./useSplitVesting.js";
+export { useInitiateVestingTransfer } from "./useInitiateVestingTransfer.js";
+export { useAcceptVestingTransfer, type UseAcceptVestingTransferArgs, } from "./useAcceptVestingTransfer.js";
+export { useCancelVestingTransfer, type UseCancelVestingTransferArgs, } from "./useCancelVestingTransfer.js";
+export { useDirectVestingTransfer, type UseDirectVestingTransferArgs, } from "./useDirectVestingTransfer.js";
+export { useDiscloseToParty } from "./useDiscloseToParty.js";
+export { useBatchDiscloseToParty, type UseBatchDiscloseToPartyArgs, } from "./useBatchDiscloseToParty.js";
+export { useAdminDiscloseToParty } from "./useAdminDiscloseToParty.js";
+export { useAdminBatchDiscloseToParty, type UseAdminBatchDiscloseToPartyArgs, } from "./useAdminBatchDiscloseToParty.js";
+export { useDiscloseHandleToParty, type UseDiscloseHandleToPartyArgs, } from "./useDiscloseHandleToParty.js";
+export { useBatchDiscloseHandlesToParty, type UseBatchDiscloseHandlesToPartyArgs, } from "./useBatchDiscloseHandlesToParty.js";
+export { useWithdrawAdmin, type UseWithdrawAdminArgs } from "./useWithdrawAdmin.js";
+export { useWithdrawOtherToken, type UseWithdrawOtherTokenArgs } from "./useWithdrawOtherToken.js";
+export { useWithdrawOtherConfidentialToken, type UseWithdrawOtherConfidentialTokenArgs, } from "./useWithdrawOtherConfidentialToken.js";
+export { useWithdrawGasFee, type UseWithdrawGasFeeArgs } from "./useWithdrawGasFee.js";
+export { useWithdrawTokenFee, type UseWithdrawTokenFeeArgs } from "./useWithdrawTokenFee.js";
+export { useSetMaxBatchSize, type UseSetMaxBatchSizeArgs } from "./useSetMaxBatchSize.js";
+export { useSetMaxRevokeBatchSize, type UseSetMaxRevokeBatchSizeArgs, } from "./useSetMaxRevokeBatchSize.js";
+export { useTransferFeeCollectorRole, type UseTransferFeeCollectorRoleArgs, } from "./useTransferFeeCollectorRole.js";
+export { usePause, type UsePauseArgs } from "./usePause.js";
+export { useUnpause, type UseUnpauseArgs } from "./useUnpause.js";
+export { useGrantRole, type UseGrantRoleArgs } from "./useGrantRole.js";
+export { useRevokeRole, type UseRevokeRoleArgs } from "./useRevokeRole.js";
+export { useRenounceRole, type UseRenounceRoleArgs } from "./useRenounceRole.js";
+export type { BaseHookOptions, ManagerHookOptions } from "./_shared.js";
+export { encryptUint64, encryptUint64Batch, resolveEncryptor, type Encryptor, type EncryptorSource, type EncryptUint64Args, type EncryptUint64BatchArgs, type FheValueInput, } from "../encryption.js";
+export { DisclosureType, FeeType, type CustomFee, type EncryptedInput, type EncryptedInputs, type PendingTransfer, type VestingInfo, type VestingParams, } from "../types.js";
+export type { BatchCreateVestingArgs, ClaimArgs, CreateVestingArgs, DiscloseArgs, EncryptedViewResult, InitiateTransferArgs, PartialClaimArgs, SplitVestingArgs, } from "../manager.js";
+export type { CreateManagerResult, CreateManagerArgs, PredictManagerArgs } from "../factory.js";
+export { scaleRatio, type ScaleRatioArgs, type ScaledRatio } from "../../fhe/scale-ratio.js";
+export { TokenOpsSdkError, isTokenOpsSdkError, DeploymentAddressUnavailableError, UnsupportedChainError, MissingAccountError, MissingClientError, MissingEncryptorError, MissingPublicClientError, MissingWalletClientError, InvalidArgumentError, ReceiptEventAmbiguousError, ReceiptEventNotFoundError, ContractRevertError, PausedError, AccessDeniedError, InsufficientFeeError, InsufficientBalanceError, BatchTooLargeError, FeatureDisabledError, TransferFailedError, FheHandleNotAllowedError, AlreadyInitializedError, ReentrancyError, InvalidSignatureError, WalletRejectedError, WalletChainMismatchError, NetworkError, InsufficientGasFundsError, UnknownWriteFailureError, UserRejectedSignatureError, SigningFailedError, RelayerUnreachableError, EncryptionFailedError, DecryptionFailedError, UserDecryptNotAllowedError, type DeploymentAddressUnavailableReason, type TokenOpsSdkErrorCode, } from "../../core/errors.js";
+export { type PreflightResult } from "../../core/preflight.js";
+export { VestingNotFoundError, NotVestingRecipientError, ClaimLockedError, VestingRevokedError, VestingNotRevocableError, VestingExpiredError, TransferAlreadyPendingError, NoPendingTransferError, NotPendingRecipientError, TransferExpiredError, } from "../errors.js";