@tbookdev/vault-react-sui 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,404 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { SuiNetwork, SuiBuildResult, SuiVaultConfig, SuiVaultPosition, SuiUserRecord } from '@tbookdev/vault-sdk-sui';
+export { SuiBuildResult, SuiNetwork, SuiUserRecord, SuiVaultConfig, SuiVaultPosition, SuiVaultState } from '@tbookdev/vault-sdk-sui';
+import { SuiClient, CoinBalance } from '@mysten/sui/client';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseQueryOptions, UseMutationResult } from '@tanstack/react-query';
+
+type SuiVaultTxBuilderMode = "local-sdk" | "gateway-api" | "custom";
+interface TBookSuiVaultStaleTimes {
+    vaultInfo: number;
+    balances: number;
+    history: number;
+    usdcBalance: number;
+}
+interface TBookSuiVaultRefetchIntervals {
+    vaultInfo: number | false;
+    balances: number | false;
+    history: number | false;
+    usdcBalance: number | false;
+}
+interface TBookSuiCustomTxBuilder {
+    buildDepositTx?: (params: {
+        sender: string;
+        amount: bigint;
+    }) => Promise<SuiBuildResult>;
+    buildQueueRedeemTx?: (params: {
+        sender: string;
+        shares: bigint;
+    }) => Promise<SuiBuildResult>;
+    buildInstantRedeemTx?: (params: {
+        sender: string;
+        shares: bigint;
+    }) => Promise<SuiBuildResult>;
+    buildClaimTx?: (params: {
+        sender: string;
+        amount?: bigint;
+    }) => Promise<SuiBuildResult>;
+    buildCancelDepositTx?: (params: {
+        sender: string;
+        recordId: string | bigint;
+    }) => Promise<SuiBuildResult>;
+}
+interface CreateSuiVaultConfigInput {
+    network: SuiNetwork;
+    vaultId?: string;
+    txBuilderMode?: SuiVaultTxBuilderMode;
+    gatewayApiBaseUrl?: string;
+    publishableKey?: string;
+    customTxBuilder?: TBookSuiCustomTxBuilder;
+    staleTimes?: Partial<TBookSuiVaultStaleTimes>;
+    refetchIntervals?: Partial<TBookSuiVaultRefetchIntervals>;
+    preflightChecks?: boolean;
+}
+interface TBookSuiVaultConfig {
+    network: SuiNetwork;
+    vaultId: string;
+    vault: SuiVaultConfig;
+    txBuilderMode: SuiVaultTxBuilderMode;
+    gatewayApiBaseUrl?: string;
+    publishableKey?: string;
+    customTxBuilder?: TBookSuiCustomTxBuilder;
+    staleTimes: TBookSuiVaultStaleTimes;
+    refetchIntervals: TBookSuiVaultRefetchIntervals;
+    preflightChecks: boolean;
+}
+declare const DEFAULT_SUI_VAULT_ID = "rcusdp-sui";
+declare const SUI_TESTNET_GATEWAY_API_BASE_URL = "https://1cm2fjkq6k.execute-api.ap-southeast-1.amazonaws.com/v1";
+declare function createSuiVaultConfig(input: CreateSuiVaultConfigInput): TBookSuiVaultConfig;
+
+interface TBookSuiVaultProviderProps extends CreateSuiVaultConfigInput {
+    children: ReactNode;
+}
+declare function TBookSuiVaultProvider({ children, ...input }: TBookSuiVaultProviderProps): react_jsx_runtime.JSX.Element;
+declare function useTBookSuiVault(): TBookSuiVaultConfig;
+
+/** Convert a decimal UI amount into raw integer units without float drift. */
+declare function parseDecimalAmount(value: string | number, decimals?: number): bigint;
+/** Convert raw integer units into a compact decimal string. */
+declare function formatRawAmount(value: bigint | string | number, decimals?: number): string;
+/** Accept raw bigint or decimal input and return raw integer units. */
+declare function toRawAmount(value: bigint | string | number, decimals?: number): bigint;
+
+declare const suiVaultQueryKeys: {
+    all: readonly ["tbook-sui"];
+    vault: (network: SuiNetwork, vaultId: string) => readonly ["tbook-sui", "vault", SuiNetwork, string];
+    vaultInfo: (network: SuiNetwork, vaultId: string) => readonly ["tbook-sui", "vault", SuiNetwork, string, "info"];
+    balances: (network: SuiNetwork, vaultId: string, address: string) => readonly ["tbook-sui", "vault", SuiNetwork, string, "balances", string];
+    history: (network: SuiNetwork, vaultId: string, address: string) => readonly ["tbook-sui", "vault", SuiNetwork, string, "history", string];
+    usdcBalance: (network: SuiNetwork, address: string, coinType: string) => readonly ["tbook-sui", "wallet", SuiNetwork, string, "usdc", string];
+};
+
+type TBookSuiVaultReactErrorCode = "WALLET_NOT_CONNECTED" | "CONFIGURATION_ERROR" | "VAULT_PAUSED" | "SETTLEMENT_ACTIVE" | "UNSUPPORTED_TX_BUILDER" | "API_ERROR";
+declare class TBookSuiVaultReactError extends Error {
+    readonly code: TBookSuiVaultReactErrorCode;
+    constructor(code: TBookSuiVaultReactErrorCode, message: string);
+}
+
+type Fetcher = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+type SuiGatewayTxType = "deposit" | "redeem" | "claim" | "cancel_deposit";
+type SuiGatewayTxFormat = "sui:tx-bytes-base64";
+interface SuiGatewayTransactionEnvelope {
+    format: SuiGatewayTxFormat;
+    data: string;
+}
+interface SuiGatewayBuildTxResponse {
+    intentId?: string;
+    vaultId: string;
+    type: SuiGatewayTxType;
+    chain: "sui";
+    rail: "direct";
+    transaction: SuiGatewayTransactionEnvelope;
+    summary?: Record<string, unknown>;
+    message: string;
+    expiresAt: string;
+}
+interface TBookSuiGatewayApiClientOptions {
+    baseUrl: string;
+    apiKey?: string;
+    fetcher?: Fetcher;
+}
+declare class TBookSuiGatewayApiClient {
+    private readonly baseUrl;
+    private readonly apiKey?;
+    private readonly fetcher;
+    constructor(options: TBookSuiGatewayApiClientOptions);
+    buildDepositTx(vaultId: string, body: {
+        user: string;
+        amount: string;
+    }): Promise<SuiGatewayBuildTxResponse>;
+    buildRedeemTx(vaultId: string, body: {
+        user: string;
+        shares: string;
+        mode?: "queued" | "instant";
+    }): Promise<SuiGatewayBuildTxResponse>;
+    buildClaimTx(vaultId: string, body: {
+        user: string;
+    }): Promise<SuiGatewayBuildTxResponse>;
+    buildCancelDepositTx(vaultId: string, body: {
+        user: string;
+        recordId: string;
+    }): Promise<SuiGatewayBuildTxResponse>;
+    confirmIntent(intentId: string, digest: string): Promise<{
+        intentId: string;
+        status: string;
+    }>;
+    private post;
+    private headers;
+}
+
+interface SuiVaultInfo {
+    totalShares: bigint;
+    pendingDeposit: bigint;
+    claimReserve: bigint;
+    rcusdpCustody: bigint;
+    pendingRedeemRcusdp: bigint;
+    reserveFund: bigint;
+    depositFeeBps: bigint;
+    mgmtFeeBps: bigint;
+    redeemFeeBps: bigint;
+    withdrawFeeBps: bigint;
+    cancelDepositFeeBps: bigint;
+    instantRedeemFeeBps: bigint;
+    paused: boolean;
+    version: bigint;
+    depositEnabled: boolean;
+    instantRedeemEnabled: boolean;
+    withdrawRcusdpEnabled: boolean;
+    cancelDepositEnabled: boolean;
+    redeemSettled: boolean;
+    raw: Record<string, unknown>;
+}
+declare function getSuiVaultInfo(client: SuiClient, cfg: SuiVaultConfig): Promise<SuiVaultInfo>;
+
+declare const useSuiVaultConfig: typeof useTBookSuiVault;
+
+interface UseSuiVaultInfoOptions extends Omit<UseQueryOptions<SuiVaultInfo>, "queryKey" | "queryFn"> {
+}
+declare function useSuiVaultInfo(options?: UseSuiVaultInfoOptions): _tanstack_react_query.UseQueryResult<SuiVaultInfo, Error>;
+
+interface UseSuiVaultBalancesOptions extends Omit<UseQueryOptions<SuiVaultPosition>, "queryKey" | "queryFn"> {
+}
+declare function useSuiVaultBalances(options?: UseSuiVaultBalancesOptions): _tanstack_react_query.UseQueryResult<SuiVaultPosition, Error>;
+
+interface UseSuiTransactionHistoryOptions extends Omit<UseQueryOptions<SuiUserRecord[]>, "queryKey" | "queryFn"> {
+}
+declare function useSuiTransactionHistory(options?: UseSuiTransactionHistoryOptions): _tanstack_react_query.UseQueryResult<SuiUserRecord[], Error>;
+
+interface UseSuiUsdcBalanceOptions extends Omit<UseQueryOptions<CoinBalance>, "queryKey" | "queryFn"> {
+}
+declare function useSuiUsdcBalance(options?: UseSuiUsdcBalanceOptions): {
+    balance: bigint;
+    decimals: number;
+    formatted: string;
+    data: CoinBalance;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<CoinBalance, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<CoinBalance>;
+} | {
+    balance: bigint;
+    decimals: number;
+    formatted: string;
+    data: CoinBalance;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<CoinBalance, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<CoinBalance>;
+} | {
+    balance: bigint;
+    decimals: number;
+    formatted: string;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<CoinBalance, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<CoinBalance>;
+} | {
+    balance: bigint;
+    decimals: number;
+    formatted: string;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<CoinBalance, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<CoinBalance>;
+} | {
+    balance: bigint;
+    decimals: number;
+    formatted: string;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<CoinBalance, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<CoinBalance>;
+} | {
+    balance: bigint;
+    decimals: number;
+    formatted: string;
+    data: CoinBalance;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<CoinBalance, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<CoinBalance>;
+};
+
+declare function useRefreshSuiVaultData(): () => Promise<void>;
+
+interface SuiDepositParams {
+    /** Raw USDC units when bigint; decimal UI units when string/number. */
+    amount: bigint | string | number;
+}
+interface SuiRedeemParams {
+    /** Raw share units when bigint; decimal UI units when string/number. */
+    shares: bigint | string | number;
+    mode?: "queued" | "instant";
+    /** Compatibility helper: USDC maps to queued, RCUSDP maps to instant. */
+    tokenType?: "USDC" | "RCUSDP";
+}
+interface SuiCancelDepositParams {
+    recordId: string | bigint;
+}
+interface SuiClaimParams {
+    amount?: bigint | string | number;
+}
+interface SuiExecutionResult {
+    digest?: string;
+    rawEffects?: number[];
+    effects?: string | {
+        bcs?: string;
+    };
+}
+declare function useSuiDeposit(): UseMutationResult<SuiExecutionResult, Error, SuiDepositParams>;
+declare function useSuiRedeem(): UseMutationResult<SuiExecutionResult, Error, SuiRedeemParams>;
+declare function useSuiClaim(): UseMutationResult<SuiExecutionResult, Error, SuiClaimParams | undefined>;
+declare function useSuiCancelDeposit(): UseMutationResult<SuiExecutionResult, Error, SuiCancelDepositParams>;
+
+export { type CreateSuiVaultConfigInput, DEFAULT_SUI_VAULT_ID, SUI_TESTNET_GATEWAY_API_BASE_URL, type SuiCancelDepositParams, type SuiClaimParams, type SuiDepositParams, type SuiExecutionResult, type SuiGatewayBuildTxResponse, type SuiGatewayTransactionEnvelope, type SuiGatewayTxFormat, type SuiGatewayTxType, type SuiRedeemParams, type SuiVaultInfo, type SuiVaultTxBuilderMode, type TBookSuiCustomTxBuilder, TBookSuiGatewayApiClient, type TBookSuiGatewayApiClientOptions, type TBookSuiVaultConfig, TBookSuiVaultProvider, type TBookSuiVaultProviderProps, TBookSuiVaultReactError, type TBookSuiVaultReactErrorCode, type TBookSuiVaultRefetchIntervals, type TBookSuiVaultStaleTimes, type UseSuiTransactionHistoryOptions, type UseSuiUsdcBalanceOptions, type UseSuiVaultBalancesOptions, type UseSuiVaultInfoOptions, createSuiVaultConfig, formatRawAmount, getSuiVaultInfo, parseDecimalAmount, suiVaultQueryKeys, toRawAmount, useRefreshSuiVaultData, useSuiCancelDeposit, useSuiClaim, useSuiDeposit, useSuiRedeem, useSuiTransactionHistory, useSuiUsdcBalance, useSuiVaultBalances, useSuiVaultConfig, useSuiVaultInfo, useTBookSuiVault };