@tokenops/sdk 1.0.0

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

@@ -0,0 +1,10 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseResetGasFeeArgs {
+    account?: Account | Address;
+}
+/**
+ * Admin: reset the factory's default gas fee to its bytecode-encoded baseline.
+ */
+export declare function useResetGasFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseResetGasFeeArgs | undefined>;

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

@@ -0,0 +1,10 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseResetTokenFeeArgs {
+    account?: Account | Address;
+}
+/**
+ * Admin: reset the factory's default token fee to its bytecode-encoded baseline.
+ */
+export declare function useResetTokenFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseResetTokenFeeArgs | undefined>;

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

@@ -0,0 +1,15 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseRevokeRoleArgs {
+    role: Hex;
+    accountTarget: Address;
+    account?: Account | Address;
+}
+/**
+ * AccessControl: revoke `role` from `accountTarget`. Caller must be a member
+ * of the role's admin role.
+ *
+ * After success, invalidate `useHasRole({ role, account: accountTarget })`.
+ */
+export declare function useRevokeRole(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseRevokeRoleArgs>;

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

@@ -0,0 +1,15 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseRevokeVestingArgs {
+    vestingId: Hex;
+    account?: Account | Address;
+}
+/**
+ * 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.
+ */
+export declare function useRevokeVesting(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseRevokeVestingArgs>;

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

@@ -0,0 +1,19 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import type { Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface RoleConstants {
+    DEFAULT_ADMIN_ROLE: Hex;
+    VESTING_CREATOR_ROLE: Hex;
+    REVOKER_ROLE: Hex;
+    WITHDRAWER_ROLE: Hex;
+    CLAIMER_ROLE: Hex;
+    FEE_COLLECTOR_ROLE: Hex;
+    PAUSER_ROLE: Hex;
+    DISCLOSURE_ADMIN_ROLE: Hex;
+}
+/**
+ * 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 {@link useHasRole} for membership checks.
+ */
+export declare function useRoleConstants(options: ManagerHookOptions): UseQueryResult<RoleConstants, Error>;

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

@@ -0,0 +1,18 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type FeeType } from "../types.js";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetCustomFeeArgs {
+    creator: Address;
+    feeType: FeeType;
+    gasFee: bigint;
+    tokenFee: bigint;
+    account?: Account | Address;
+}
+/**
+ * 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.
+ */
+export declare function useSetCustomFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetCustomFeeArgs>;

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

@@ -0,0 +1,14 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type FeeType } from "../types.js";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetDefaultFeeTypeArgs {
+    feeType: FeeType;
+    account?: Account | Address;
+}
+/**
+ * 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"]`.
+ */
+export declare function useSetDefaultFeeType(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetDefaultFeeTypeArgs>;

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

@@ -0,0 +1,12 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetDefaultGasFeeArgs {
+    fee: bigint;
+    account?: Account | Address;
+}
+/**
+ * Admin: set the factory-wide default gas fee (in wei). After success, invalidate
+ * `["tokenops-sdk", "fhe-vesting", "factory:defaultGasFee"]` to refresh the read hook.
+ */
+export declare function useSetDefaultGasFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetDefaultGasFeeArgs>;

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

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetDefaultTokenFeeArgs {
+    /** Basis points (1 bps = 0.01 %). */
+    feeBps: bigint;
+    account?: Account | Address;
+}
+/**
+ * Admin: set the factory-wide default token fee (basis points). After success,
+ * invalidate `["tokenops-sdk", "fhe-vesting", "factory:defaultTokenFee"]`.
+ */
+export declare function useSetDefaultTokenFee(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetDefaultTokenFeeArgs>;

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

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type BaseHookOptions } from "./_shared.js";
+export interface UseSetFeeCollectorArgs {
+    newCollector: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: set the factory's fee collector address.
+ *
+ * After success, invalidate `useFactoryFeeCollector()`.
+ */
+export declare function useSetFeeCollector(options?: BaseHookOptions): UseMutationResult<Hex, Error, UseSetFeeCollectorArgs>;

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

@@ -0,0 +1,12 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseSetMaxBatchSizeArgs {
+    newMax: bigint;
+    account?: Account | Address;
+}
+/**
+ * Admin: bump or lower `maxBatchSize` (cap for `useBatchCreateVesting`).
+ * After success, invalidate `useManagerMaxBatchSize`.
+ */
+export declare function useSetMaxBatchSize(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseSetMaxBatchSizeArgs>;

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

@@ -0,0 +1,12 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseSetMaxRevokeBatchSizeArgs {
+    newMax: bigint | number;
+    account?: Account | Address;
+}
+/**
+ * Admin: bump or lower `maxRevokeBatchSize` (cap for `useBatchRevokeVesting`).
+ * After success, invalidate `useManagerMaxRevokeBatchSize`.
+ */
+export declare function useSetMaxRevokeBatchSize(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseSetMaxRevokeBatchSizeArgs>;

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

@@ -0,0 +1,28 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { SplitVestingArgs, SplitVestingResult } from "../manager.js";
+import { type ManagerHookOptions } from "./_shared.js";
+/**
+ * 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 {@link 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.
+ *
+ * @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",
+ * });
+ */
+export declare function useSplitVesting(options: ManagerHookOptions): UseMutationResult<SplitVestingResult, Error, SplitVestingArgs>;

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

@@ -0,0 +1,12 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseTransferFeeCollectorRoleArgs {
+    newCollector: Address;
+    account?: Account | Address;
+}
+/**
+ * Transfer the `FEE_COLLECTOR_ROLE` to `newCollector`. The current
+ * fee-collector calls this; the new collector gains immediate role membership.
+ */
+export declare function useTransferFeeCollectorRole(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseTransferFeeCollectorRoleArgs>;

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

@@ -0,0 +1,11 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseUnpauseArgs {
+    account?: Account | Address;
+}
+/**
+ * Pauser: unpause the manager clone. After success, invalidate
+ * `useManagerPaused`.
+ */
+export declare function useUnpause(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseUnpauseArgs | undefined>;

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

@@ -0,0 +1,19 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { TxHash } from "../../core/brands.js";
+import type { ClaimArgs } from "../manager.js";
+import { type ManagerHookOptions } from "./_shared.js";
+/**
+ * Claim the currently-claimable amount on a vesting schedule.
+ *
+ * **For `FeeType.Gas` managers**, pass `args.value = fee` — use
+ * {@link useManagerFeeInfo} to read it. For `FeeType.DistributionToken`,
+ * omit `value`.
+ *
+ * After success, invalidate `useAccessClaimableAmount` (the encrypted view) and
+ * any UI counts you computed off it.
+ *
+ * @example
+ * const claim = useVestingClaim({ address: managerAddress });
+ * claim.mutate({ vestingId, value: gasFee });
+ */
+export declare function useVestingClaim(options: ManagerHookOptions): UseMutationResult<TxHash, Error, ClaimArgs>;

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

@@ -0,0 +1,25 @@
+import { type UseQueryResult } from "@tanstack/react-query";
+import type { Hex } from "viem";
+import { type VestingInfo } from "../types.js";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseVestingInfoArgs extends ManagerHookOptions {
+    vestingId?: Hex;
+}
+/**
+ * Read the plaintext snapshot of a vesting schedule — recipient, timestamps,
+ * unlock bps, revocability flag. **Amounts are encrypted and NOT in this
+ * payload** — use {@link useGetTotalAllocation} / {@link useGetVestedAmount}
+ * for encrypted-amount handles.
+ *
+ * @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.
+ */
+export declare function useVestingInfo(args: UseVestingInfoArgs): UseQueryResult<VestingInfo, Error>;

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

@@ -0,0 +1,17 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import type { EncryptedInput } from "../types.js";
+import type { Encryptor } from "../encryption.js";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseWithdrawAdminArgs {
+    amount: bigint;
+    encryptor?: Encryptor;
+    encryptedInput?: EncryptedInput;
+    account?: Account | Address;
+}
+/**
+ * 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).
+ */
+export declare function useWithdrawAdmin(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseWithdrawAdminArgs>;

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

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseWithdrawGasFeeArgs {
+    to: Address;
+    amount: bigint;
+    account?: Account | Address;
+}
+/**
+ * Fee collector: withdraw collected gas-fee ETH (`FeeType.Gas` managers).
+ * Caller must hold `FEE_COLLECTOR_ROLE`.
+ */
+export declare function useWithdrawGasFee(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseWithdrawGasFeeArgs>;

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

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseWithdrawOtherConfidentialTokenArgs {
+    token: Address;
+    to: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: rescue an ERC-7984 (confidential) token other than this manager's
+ * configured token. Caller must hold `WITHDRAWER_ROLE`.
+ */
+export declare function useWithdrawOtherConfidentialToken(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseWithdrawOtherConfidentialTokenArgs>;

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

@@ -0,0 +1,13 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseWithdrawOtherTokenArgs {
+    token: Address;
+    to: Address;
+    account?: Account | Address;
+}
+/**
+ * Admin: rescue an ERC-20 (non-confidential) other than this manager's
+ * configured token. Caller must hold `WITHDRAWER_ROLE`.
+ */
+export declare function useWithdrawOtherToken(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseWithdrawOtherTokenArgs>;

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

@@ -0,0 +1,18 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import type { Account, Address, Hex } from "viem";
+import type { EncryptedInput } from "../types.js";
+import type { Encryptor } from "../encryption.js";
+import { type ManagerHookOptions } from "./_shared.js";
+export interface UseWithdrawTokenFeeArgs {
+    to: Address;
+    amount: bigint;
+    encryptor?: Encryptor;
+    encryptedInput?: EncryptedInput;
+    account?: Account | Address;
+}
+/**
+ * Fee collector: withdraw collected distribution-token fees
+ * (`FeeType.DistributionToken` managers). SDK encrypts `amount` (or pass
+ * `encryptedInput`). Caller must hold `FEE_COLLECTOR_ROLE`.
+ */
+export declare function useWithdrawTokenFee(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseWithdrawTokenFeeArgs>;

package/dist/fhe-vesting/types.d.ts

@@ -0,0 +1,72 @@
+import type { Address } from "viem";
+export type { EncryptedInput, EncryptedInputs, EncryptedViewResult } from "../fhe/types.js";
+/**
+ * Plaintext mirror of `IConfidentialVestingManagerTypes.VestingParams`. Field
+ * names and order match the contract struct so viem can encode it as a tuple.
+ */
+export interface VestingParams {
+    recipient: Address;
+    startTimestamp: number;
+    endTimestamp: number;
+    cliffSeconds: number;
+    releaseIntervalSecs: number;
+    timelockSeconds: number;
+    initialUnlockBps: number;
+    cliffAmountBps: number;
+    isRevocable: boolean;
+}
+/** Read-only snapshot returned by `getVestingInfo`. */
+export interface VestingInfo {
+    recipient: Address;
+    startTimestamp: number;
+    endTimestamp: number;
+    revokeTimestamp: number;
+    cliffReleaseTimestamp: number;
+    releaseIntervalSecs: number;
+    timelock: number;
+    initialUnlockBps: number;
+    cliffAmountBps: number;
+    isRevocable: boolean;
+}
+/** Factory fee model. */
+export declare enum FeeType {
+    Gas = 0,
+    DistributionToken = 1
+}
+/**
+ * Stringify a {@link FeeType} for human-readable / JSON-output contexts.
+ *
+ * `FeeType` is a numeric enum so it serialises to `0` / `1` in JSON payloads,
+ * which is ergonomic on the wire but confusing in SIEM/Slack/Datadog scrapes
+ * of a CI script's `summary.json`. This helper returns `"Gas"` /
+ * `"DistributionToken"` for inclusion in human-readable envelopes without
+ * forcing the consumer to write `FeeType[value]` reverse-lookup boilerplate
+ * (which is also less type-safe — the reverse lookup returns
+ * `string | undefined`).
+ *
+ * R22 devops-integrator MINOR-2; R25 close.
+ *
+ * @example
+ * const { feeType, fee } = await manager.getFeeInfo();
+ * const summary = { fee: fee.toString(), feeType, feeTypeName: feeTypeName(feeType) };
+ * // summary.feeType === 0, summary.feeTypeName === "Gas"
+ */
+export declare function feeTypeName(feeType: FeeType): "Gas" | "DistributionToken";
+/** Selector for `discloseToParty` / `adminDiscloseToParty`. */
+export declare enum DisclosureType {
+    TotalAllocation = 0,
+    SettledAmount = 1,
+    VestedAmount = 2,
+    ClaimableAmount = 3
+}
+export interface CustomFee {
+    enabled: boolean;
+    preferredFeeType: FeeType;
+    gasFee: bigint;
+    tokenFee: bigint;
+}
+export interface PendingTransfer {
+    newRecipient: Address;
+    initiatedAt: number;
+    expiresAt: number;
+}