@tokenops/sdk 1.0.0

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

@@ -0,0 +1,82 @@
+/**
+ * React/wagmi hooks for `@tokenops/sdk/fhe-disperse`.
+ *
+ * Every public method on the headless `ConfidentialDisperseClient` 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>`.
+ *
+ * The singleton address is resolved per-chain via
+ * {@link getFheDisperseSingletonAddress}. Pass `address` to
+ * {@link DisperseHookOptions} to override (e.g. for forks or redeployments).
+ *
+ * **Encryptor.** For methods that submit encrypted inputs ({@link useDisperse},
+ * {@link useWithdrawTokenFee}), 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() {
+ *   const zamaSDK = useZamaSDK();
+ *   const disperse = useDisperse({ 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 { useIsRegistered, type UseIsRegisteredArgs } from "./useIsRegistered.js";
+export { useGetWallets, type UseGetWalletsArgs } from "./useGetWallets.js";
+export { usePredictWallets, type UsePredictWalletsArgs } from "./usePredictWallets.js";
+export { useGetFees, type UseGetFeesArgs } from "./useGetFees.js";
+export { useGetFeeConfig } from "./useGetFeeConfig.js";
+export { useGetBatchLimits } from "./useGetBatchLimits.js";
+export { useCalculateFee, type UseCalculateFeeArgs } from "./useCalculateFee.js";
+export { useHasApprovedSubwallets, type UseHasApprovedSubwalletsArgs, } from "./useHasApprovedSubwallets.js";
+export { useHasRole, type UseHasRoleArgs } from "./useHasRole.js";
+export { useIsPaused } from "./useIsPaused.js";
+export { useDeploymentBlockNumber } from "./useDeploymentBlockNumber.js";
+export { useWalletImplementation } from "./useWalletImplementation.js";
+export { usePreflightDisperse, type UsePreflightDisperseArgs } from "./usePreflightDisperse.js";
+export { useRegister, type UseRegisterArgs } from "./useRegister.js";
+export { useApproveTokenOnWallets, type UseApproveTokenOnWalletsArgs, } from "./useApproveTokenOnWallets.js";
+export { useRevokeTokenOnWallets, type UseRevokeTokenOnWalletsArgs, } from "./useRevokeTokenOnWallets.js";
+export { useRecoverFromWallets, type UseRecoverFromWalletsArgs } from "./useRecoverFromWallets.js";
+export { useRecoverERC20FromWallets, type UseRecoverERC20FromWalletsArgs, } from "./useRecoverERC20FromWallets.js";
+export { useDisperse } from "./useDisperse.js";
+export { useAccessEncryptedFeeReserve, useGetEncryptedFeeReserve, } from "./useAccessEncryptedFeeReserve.js";
+export { useDiscloseHandleToParty } from "./useDiscloseHandleToParty.js";
+export { useBatchDiscloseHandlesToParty } from "./useBatchDiscloseHandlesToParty.js";
+export { usePause, type UsePauseArgs } from "./usePause.js";
+export { useUnpause, type UseUnpauseArgs } from "./useUnpause.js";
+export { useSetFeeConfig, type UseSetFeeConfigArgs } from "./useSetFeeConfig.js";
+export { useSetCustomFee, type UseSetCustomFeeArgs } from "./useSetCustomFee.js";
+export { useDisableCustomFee, type UseDisableCustomFeeArgs } from "./useDisableCustomFee.js";
+export { useSetMaxBatchSizeHolding, type UseSetMaxBatchSizeHoldingArgs, } from "./useSetMaxBatchSizeHolding.js";
+export { useSetMaxBatchSizeDirect, type UseSetMaxBatchSizeDirectArgs, } from "./useSetMaxBatchSizeDirect.js";
+export { useSetMaxBatchSizeTokenFee, type UseSetMaxBatchSizeTokenFeeArgs, } from "./useSetMaxBatchSizeTokenFee.js";
+export { useWithdrawGasFee, type UseWithdrawGasFeeArgs } from "./useWithdrawGasFee.js";
+export { useWithdrawTokenFee, type UseWithdrawTokenFeeArgs, type UseWithdrawTokenFeePlaintextArgs, type UseWithdrawTokenFeePreEncryptedArgs, } from "./useWithdrawTokenFee.js";
+export { useRescueConfidentialTokens, type UseRescueConfidentialTokensArgs, } from "./useRescueConfidentialTokens.js";
+export { useRescueERC20, type UseRescueERC20Args } from "./useRescueERC20.js";
+export { useGrantRole, type UseGrantRoleArgs } from "./useGrantRole.js";
+export { useRevokeRole, type UseRevokeRoleArgs } from "./useRevokeRole.js";
+export type { BaseHookOptions, DisperseHookOptions } from "./_shared.js";
+export { FHE_DISPERSE_KEY, FHE_DISPERSE_NAMESPACE } from "./_shared.js";
+export { FEE_COLLECTOR_ROLE, FEE_MANAGER_ROLE, PAUSER_ROLE, WITHDRAWER_ROLE, DEFAULT_ADMIN_ROLE, } from "../index.js";
+export { computeSubtotals, } from "../singleton.js";
+export { encryptUint64, encryptUint64Batch, resolveEncryptor, type Encryptor, type EncryptorSource, type EncryptUint64Args, type EncryptUint64BatchArgs, type FheValueInput, } from "../encryption.js";
+export { DisperseSubwalletNotFoundError, DisperseEncryptedReserveNotGrantedError, type BatchDiscloseHandlesArgs, type BatchLimits, type CalculateFeeArgs, type CalculatedFee, type DiscloseHandleArgs, type DisperseArgs, type DisperseMode, type DisperseResult, type EncryptedInput, type EncryptedInputs, type EncryptedViewResult, type FeeConfig, type GetEncryptedFeeReserveArgs, type PreflightDisperseArgs, type PreflightReport, type RecipientCheck, type RegisterResult, type SubwalletApprovalState, type UserFees, } from "../types.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 { NotRegisteredError, AlreadyRegisteredError } from "../errors.js";

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

@@ -0,0 +1,82 @@
+/**
+ * React/wagmi hooks for `@tokenops/sdk/fhe-disperse`.
+ *
+ * Every public method on the headless `ConfidentialDisperseClient` 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>`.
+ *
+ * The singleton address is resolved per-chain via
+ * {@link getFheDisperseSingletonAddress}. Pass `address` to
+ * {@link DisperseHookOptions} to override (e.g. for forks or redeployments).
+ *
+ * **Encryptor.** For methods that submit encrypted inputs ({@link useDisperse},
+ * {@link useWithdrawTokenFee}), 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() {
+ *   const zamaSDK = useZamaSDK();
+ *   const disperse = useDisperse({ 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 { useIsRegistered, type UseIsRegisteredArgs } from "./useIsRegistered.js";
+export { useGetWallets, type UseGetWalletsArgs } from "./useGetWallets.js";
+export { usePredictWallets, type UsePredictWalletsArgs } from "./usePredictWallets.js";
+export { useGetFees, type UseGetFeesArgs } from "./useGetFees.js";
+export { useGetFeeConfig } from "./useGetFeeConfig.js";
+export { useGetBatchLimits } from "./useGetBatchLimits.js";
+export { useCalculateFee, type UseCalculateFeeArgs } from "./useCalculateFee.js";
+export { useHasApprovedSubwallets, type UseHasApprovedSubwalletsArgs, } from "./useHasApprovedSubwallets.js";
+export { useHasRole, type UseHasRoleArgs } from "./useHasRole.js";
+export { useIsPaused } from "./useIsPaused.js";
+export { useDeploymentBlockNumber } from "./useDeploymentBlockNumber.js";
+export { useWalletImplementation } from "./useWalletImplementation.js";
+export { usePreflightDisperse, type UsePreflightDisperseArgs } from "./usePreflightDisperse.js";
+export { useRegister, type UseRegisterArgs } from "./useRegister.js";
+export { useApproveTokenOnWallets, type UseApproveTokenOnWalletsArgs, } from "./useApproveTokenOnWallets.js";
+export { useRevokeTokenOnWallets, type UseRevokeTokenOnWalletsArgs, } from "./useRevokeTokenOnWallets.js";
+export { useRecoverFromWallets, type UseRecoverFromWalletsArgs } from "./useRecoverFromWallets.js";
+export { useRecoverERC20FromWallets, type UseRecoverERC20FromWalletsArgs, } from "./useRecoverERC20FromWallets.js";
+export { useDisperse } from "./useDisperse.js";
+export { useAccessEncryptedFeeReserve, useGetEncryptedFeeReserve, } from "./useAccessEncryptedFeeReserve.js";
+export { useDiscloseHandleToParty } from "./useDiscloseHandleToParty.js";
+export { useBatchDiscloseHandlesToParty } from "./useBatchDiscloseHandlesToParty.js";
+export { usePause, type UsePauseArgs } from "./usePause.js";
+export { useUnpause, type UseUnpauseArgs } from "./useUnpause.js";
+export { useSetFeeConfig, type UseSetFeeConfigArgs } from "./useSetFeeConfig.js";
+export { useSetCustomFee, type UseSetCustomFeeArgs } from "./useSetCustomFee.js";
+export { useDisableCustomFee, type UseDisableCustomFeeArgs } from "./useDisableCustomFee.js";
+export { useSetMaxBatchSizeHolding, type UseSetMaxBatchSizeHoldingArgs, } from "./useSetMaxBatchSizeHolding.js";
+export { useSetMaxBatchSizeDirect, type UseSetMaxBatchSizeDirectArgs, } from "./useSetMaxBatchSizeDirect.js";
+export { useSetMaxBatchSizeTokenFee, type UseSetMaxBatchSizeTokenFeeArgs, } from "./useSetMaxBatchSizeTokenFee.js";
+export { useWithdrawGasFee, type UseWithdrawGasFeeArgs } from "./useWithdrawGasFee.js";
+export { useWithdrawTokenFee, type UseWithdrawTokenFeeArgs, type UseWithdrawTokenFeePlaintextArgs, type UseWithdrawTokenFeePreEncryptedArgs, } from "./useWithdrawTokenFee.js";
+export { useRescueConfidentialTokens, type UseRescueConfidentialTokensArgs, } from "./useRescueConfidentialTokens.js";
+export { useRescueERC20, type UseRescueERC20Args } from "./useRescueERC20.js";
+export { useGrantRole, type UseGrantRoleArgs } from "./useGrantRole.js";
+export { useRevokeRole, type UseRevokeRoleArgs } from "./useRevokeRole.js";
+export type { BaseHookOptions, DisperseHookOptions } from "./_shared.js";
+export { FHE_DISPERSE_KEY, FHE_DISPERSE_NAMESPACE } from "./_shared.js";
+export { FEE_COLLECTOR_ROLE, FEE_MANAGER_ROLE, PAUSER_ROLE, WITHDRAWER_ROLE, DEFAULT_ADMIN_ROLE, } from "../index.js";
+export { computeSubtotals, } from "../singleton.js";
+export { encryptUint64, encryptUint64Batch, resolveEncryptor, type Encryptor, type EncryptorSource, type EncryptUint64Args, type EncryptUint64BatchArgs, type FheValueInput, } from "../encryption.js";
+export { DisperseSubwalletNotFoundError, DisperseEncryptedReserveNotGrantedError, type BatchDiscloseHandlesArgs, type BatchLimits, type CalculateFeeArgs, type CalculatedFee, type DiscloseHandleArgs, type DisperseArgs, type DisperseMode, type DisperseResult, type EncryptedInput, type EncryptedInputs, type EncryptedViewResult, type FeeConfig, type GetEncryptedFeeReserveArgs, type PreflightDisperseArgs, type PreflightReport, type RecipientCheck, type RegisterResult, type SubwalletApprovalState, type UserFees, } from "../types.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 { NotRegisteredError, AlreadyRegisteredError } from "../errors.js";