@permissionless-technologies/upd-sdk 0.1.0

package/dist/react/index.d.cts

@@ -0,0 +1,339 @@
+import { Address, Hash } from 'viem';
+import { P as PriceAttestationQuery } from '../types-DySv82My.cjs';
+import { S as SystemHealth } from '../health-DPxBqH7b.cjs';
+
+interface UseUPDConfig {
+    tokenAddress: Address;
+    userAddress?: Address;
+}
+interface UseUPDReturn {
+    balance: bigint | undefined;
+    totalSupply: bigint | undefined;
+    isLoading: boolean;
+}
+declare function useUPD(config: UseUPDConfig): UseUPDReturn;
+
+interface UseCollateralConfig {
+    reporterAddress: Address;
+    tokenAddress: Address;
+}
+interface UseCollateralReturn {
+    totalStEthCollateral: bigint | undefined;
+    totalUPDSupply: bigint | undefined;
+    isLoading: boolean;
+}
+declare function useCollateral(config: UseCollateralConfig): UseCollateralReturn;
+
+interface UseStabilizerConfig {
+    stabilizerNFTAddress: Address;
+    tokenId?: bigint;
+}
+interface UseStabilizerReturn {
+    positionEscrowAddress: Address | undefined;
+    stabilizerEscrowAddress: Address | undefined;
+    isLoading: boolean;
+}
+declare function useStabilizer(config: UseStabilizerConfig): UseStabilizerReturn;
+
+interface UseEthUsdPriceConfig {
+    /** Oracle service URL. Defaults to oracle.upd.io. */
+    oracleUrl?: string;
+    /** Refetch interval in milliseconds. Defaults to 10000 (10s). */
+    refetchInterval?: number;
+    /** Whether to enable the query. Defaults to true. */
+    enabled?: boolean;
+}
+interface UseEthUsdPriceReturn {
+    /** Raw price in 18 decimals (e.g. 2000e18 = $2000). */
+    price: bigint | undefined;
+    /** Human-readable formatted price string (e.g. "$2,000.00"). */
+    priceFormatted: string;
+    /** Full signed attestation, ready to pass to mint/burn. */
+    attestation: PriceAttestationQuery | undefined;
+    /** Whether the initial fetch is loading. */
+    isLoading: boolean;
+    /** Error from the most recent fetch, if any. */
+    error: Error | null;
+    /** Manually trigger a refetch. */
+    refetch: () => void;
+}
+declare function useEthUsdPrice(config?: UseEthUsdPriceConfig): UseEthUsdPriceReturn;
+
+interface UseMintQuoteConfig extends UseEthUsdPriceConfig {
+}
+interface UseMintQuoteReturn {
+    /** Expected UPD amount for the given ETH input (18 decimals). */
+    updAmount: bigint | undefined;
+    /** Current ETH/USD price used for the quote (18 decimals). */
+    ethUsdPrice: bigint | undefined;
+    /** Whether the price is still loading. */
+    isLoading: boolean;
+}
+/**
+ * Real-time mint quote hook — composes oracle price + pure math.
+ *
+ * @param ethAmount - ETH amount to quote (in wei). Pass 0n to disable.
+ * @param config - Optional oracle configuration.
+ *
+ * @example
+ * ```tsx
+ * const { updAmount, isLoading } = useMintQuote(parseEther('1'))
+ * // updAmount ≈ 2000e18 (at $2000/ETH)
+ * ```
+ */
+declare function useMintQuote(ethAmount: bigint, config?: UseMintQuoteConfig): UseMintQuoteReturn;
+
+interface UseBurnQuoteConfig extends UseEthUsdPriceConfig {
+}
+interface UseBurnQuoteReturn {
+    /** Expected stETH amount for the given UPD input (in wei). */
+    stEthAmount: bigint | undefined;
+    /** Current ETH/USD price used for the quote (18 decimals). */
+    ethUsdPrice: bigint | undefined;
+    /** Whether the price is still loading. */
+    isLoading: boolean;
+}
+/**
+ * Real-time burn quote hook — composes oracle price + pure math.
+ *
+ * @param updAmount - UPD amount to quote (18 decimals). Pass 0n to disable.
+ * @param config - Optional oracle configuration.
+ *
+ * @example
+ * ```tsx
+ * const { stEthAmount, isLoading } = useBurnQuote(parseUnits('2000', 18))
+ * // stEthAmount ≈ 1e18 (at $2000/ETH)
+ * ```
+ */
+declare function useBurnQuote(updAmount: bigint, config?: UseBurnQuoteConfig): UseBurnQuoteReturn;
+
+interface UseMintUPDConfig {
+    /** Address of the StabilizerNFT contract. */
+    stabilizerNFTAddress: Address;
+}
+interface UseMintUPDReturn {
+    /** Execute the mint transaction. */
+    mint: (params: {
+        to: Address;
+        ethAmount: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    /** Whether the transaction is being sent. */
+    isPending: boolean;
+    /** Transaction hash once submitted. */
+    txHash: Hash | undefined;
+    /** Whether we're waiting for confirmation. */
+    isConfirming: boolean;
+    /** Whether the transaction is confirmed. */
+    isConfirmed: boolean;
+    /** Error from the transaction, if any. */
+    error: Error | null;
+    /** Reset the mutation state. */
+    reset: () => void;
+}
+/**
+ * Write hook for minting UPD by depositing ETH.
+ *
+ * @example
+ * ```tsx
+ * const { mint, isPending, isConfirmed, error } = useMintUPD({
+ *   stabilizerNFTAddress: deployment.contracts.StabilizerNFT,
+ * })
+ *
+ * // Use with useEthUsdPrice to get attestation
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => mint({ to: userAddress, ethAmount: parseEther('1'), attestation })}>
+ *   Mint UPD
+ * </button>
+ * ```
+ */
+declare function useMintUPD(config: UseMintUPDConfig): UseMintUPDReturn;
+
+interface UseBurnUPDConfig {
+    /** Address of the StabilizerNFT contract. */
+    stabilizerNFTAddress: Address;
+}
+interface UseBurnUPDReturn {
+    /** Execute the burn transaction. */
+    burn: (params: {
+        updAmount: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    /** Whether the transaction is being sent. */
+    isPending: boolean;
+    /** Transaction hash once submitted. */
+    txHash: Hash | undefined;
+    /** Whether we're waiting for confirmation. */
+    isConfirming: boolean;
+    /** Whether the transaction is confirmed. */
+    isConfirmed: boolean;
+    /** Error from the transaction, if any. */
+    error: Error | null;
+    /** Reset the mutation state. */
+    reset: () => void;
+}
+/**
+ * Write hook for burning UPD to receive stETH.
+ *
+ * @example
+ * ```tsx
+ * const { burn, isPending, isConfirmed } = useBurnUPD({
+ *   stabilizerNFTAddress: deployment.contracts.StabilizerNFT,
+ * })
+ *
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => burn({ updAmount: parseUnits('1000', 18), attestation })}>
+ *   Burn 1000 UPD
+ * </button>
+ * ```
+ */
+declare function useBurnUPD(config: UseBurnUPDConfig): UseBurnUPDReturn;
+
+interface UseSystemHealthConfig {
+    /** Address of the OvercollateralizationReporter contract. */
+    reporterAddress: Address;
+    /** Address of the UPD token. */
+    tokenAddress: Address;
+    /** Oracle service URL. */
+    oracleUrl?: string;
+    /** Minimum collateral ratio in basis points (default: 12500 = 125%). */
+    minRatioBps?: bigint;
+}
+interface UseSystemHealthReturn {
+    /** Computed system health metrics, or undefined if still loading. */
+    health: SystemHealth | undefined;
+    /** Whether any underlying data is still loading. */
+    isLoading: boolean;
+}
+/**
+ * System health hook — composes useCollateral + useEthUsdPrice + computeSystemHealth.
+ *
+ * @example
+ * ```tsx
+ * const { health, isLoading } = useSystemHealth({
+ *   reporterAddress: deployment.contracts.OvercollateralizationReporter,
+ *   tokenAddress: deployment.contracts.UPDToken,
+ * })
+ *
+ * if (health && !health.isHealthy) {
+ *   return <Alert>System undercollateralized: {health.systemCollateralRatioBps} bps</Alert>
+ * }
+ * ```
+ */
+declare function useSystemHealth(config: UseSystemHealthConfig): UseSystemHealthReturn;
+
+interface UseSUPDConfig {
+    /** Address of the sUPD contract. */
+    supdAddress: Address;
+    /** User address to read balance for (optional). */
+    userAddress?: Address;
+}
+interface UseSUPDReturn {
+    /** User's sUPD balance (18 decimals). */
+    balance: bigint | undefined;
+    /** Total sUPD shares outstanding. */
+    totalSupply: bigint | undefined;
+    /** Current share value with accrued yield (18 decimals). */
+    shareValue: bigint | undefined;
+    /** Annual yield in basis points (e.g. 800 = 8%). */
+    annualYieldBps: bigint | undefined;
+    /** Total USD liability of all outstanding sUPD. */
+    totalLiabilityUSD: bigint | undefined;
+    /** Whether any read is still loading. */
+    isLoading: boolean;
+}
+/**
+ * Read hook for sUPD — share value, APY, balances, and total liability.
+ *
+ * @example
+ * ```tsx
+ * const { balance, shareValue, annualYieldBps, isLoading } = useSUPD({
+ *   supdAddress: deployment.contracts.sUPD,
+ *   userAddress: account.address,
+ * })
+ * ```
+ */
+declare function useSUPD(config: UseSUPDConfig): UseSUPDReturn;
+
+interface UseStakeUPDConfig {
+    /** Address of the sUPD contract. */
+    supdAddress: Address;
+}
+interface UseStakeUPDReturn {
+    /** Execute the stake transaction. User must approve UPD transfer to sUPD first. */
+    stake: (params: {
+        updAmount: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    isPending: boolean;
+    txHash: Hash | undefined;
+    isConfirming: boolean;
+    isConfirmed: boolean;
+    error: Error | null;
+    reset: () => void;
+}
+/**
+ * Write hook for staking UPD → sUPD.
+ *
+ * Note: The user must first approve the sUPD contract to spend their UPD tokens
+ * (via UPDToken.approve or EIP-3009 transferWithAuthorization).
+ *
+ * @example
+ * ```tsx
+ * const { stake, isPending } = useStakeUPD({
+ *   supdAddress: deployment.contracts.sUPD,
+ * })
+ *
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => stake({ updAmount: parseUnits('1000', 18), attestation })}>
+ *   Stake 1000 UPD
+ * </button>
+ * ```
+ */
+declare function useStakeUPD(config: UseStakeUPDConfig): UseStakeUPDReturn;
+
+interface UseUnstakeUPDConfig {
+    /** Address of the sUPD contract. */
+    supdAddress: Address;
+}
+interface UseUnstakeUPDReturn {
+    /** Execute the unstake transaction (unstakeToUPD — full redemption). */
+    unstake: (params: {
+        shares: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    isPending: boolean;
+    txHash: Hash | undefined;
+    isConfirming: boolean;
+    isConfirmed: boolean;
+    error: Error | null;
+    reset: () => void;
+}
+/**
+ * Write hook for unstaking sUPD → UPD.
+ *
+ * Calls `unstakeToUPD(shares, priceQuery)` which gathers stETH from sUPD's
+ * stabilizer escrows and mints fresh UPD to the caller.
+ *
+ * For advanced unstake variants (pro-rata, queued, with-extra-UPD), use the
+ * contract ABI directly.
+ *
+ * @example
+ * ```tsx
+ * const { unstake, isPending } = useUnstakeUPD({
+ *   supdAddress: deployment.contracts.sUPD,
+ * })
+ *
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => unstake({ shares: myShares, attestation })}>
+ *   Unstake
+ * </button>
+ * ```
+ */
+declare function useUnstakeUPD(config: UseUnstakeUPDConfig): UseUnstakeUPDReturn;
+
+export { type UseBurnQuoteConfig, type UseBurnQuoteReturn, type UseBurnUPDConfig, type UseBurnUPDReturn, type UseCollateralConfig, type UseCollateralReturn, type UseEthUsdPriceConfig, type UseEthUsdPriceReturn, type UseMintQuoteConfig, type UseMintQuoteReturn, type UseMintUPDConfig, type UseMintUPDReturn, type UseSUPDConfig, type UseSUPDReturn, type UseStabilizerConfig, type UseStabilizerReturn, type UseStakeUPDConfig, type UseStakeUPDReturn, type UseSystemHealthConfig, type UseSystemHealthReturn, type UseUPDConfig, type UseUPDReturn, type UseUnstakeUPDConfig, type UseUnstakeUPDReturn, useBurnQuote, useBurnUPD, useCollateral, useEthUsdPrice, useMintQuote, useMintUPD, useSUPD, useStabilizer, useStakeUPD, useSystemHealth, useUPD, useUnstakeUPD };

package/dist/react/index.d.ts

@@ -0,0 +1,339 @@
+import { Address, Hash } from 'viem';
+import { P as PriceAttestationQuery } from '../types-DySv82My.js';
+import { S as SystemHealth } from '../health-BUb4ItNt.js';
+
+interface UseUPDConfig {
+    tokenAddress: Address;
+    userAddress?: Address;
+}
+interface UseUPDReturn {
+    balance: bigint | undefined;
+    totalSupply: bigint | undefined;
+    isLoading: boolean;
+}
+declare function useUPD(config: UseUPDConfig): UseUPDReturn;
+
+interface UseCollateralConfig {
+    reporterAddress: Address;
+    tokenAddress: Address;
+}
+interface UseCollateralReturn {
+    totalStEthCollateral: bigint | undefined;
+    totalUPDSupply: bigint | undefined;
+    isLoading: boolean;
+}
+declare function useCollateral(config: UseCollateralConfig): UseCollateralReturn;
+
+interface UseStabilizerConfig {
+    stabilizerNFTAddress: Address;
+    tokenId?: bigint;
+}
+interface UseStabilizerReturn {
+    positionEscrowAddress: Address | undefined;
+    stabilizerEscrowAddress: Address | undefined;
+    isLoading: boolean;
+}
+declare function useStabilizer(config: UseStabilizerConfig): UseStabilizerReturn;
+
+interface UseEthUsdPriceConfig {
+    /** Oracle service URL. Defaults to oracle.upd.io. */
+    oracleUrl?: string;
+    /** Refetch interval in milliseconds. Defaults to 10000 (10s). */
+    refetchInterval?: number;
+    /** Whether to enable the query. Defaults to true. */
+    enabled?: boolean;
+}
+interface UseEthUsdPriceReturn {
+    /** Raw price in 18 decimals (e.g. 2000e18 = $2000). */
+    price: bigint | undefined;
+    /** Human-readable formatted price string (e.g. "$2,000.00"). */
+    priceFormatted: string;
+    /** Full signed attestation, ready to pass to mint/burn. */
+    attestation: PriceAttestationQuery | undefined;
+    /** Whether the initial fetch is loading. */
+    isLoading: boolean;
+    /** Error from the most recent fetch, if any. */
+    error: Error | null;
+    /** Manually trigger a refetch. */
+    refetch: () => void;
+}
+declare function useEthUsdPrice(config?: UseEthUsdPriceConfig): UseEthUsdPriceReturn;
+
+interface UseMintQuoteConfig extends UseEthUsdPriceConfig {
+}
+interface UseMintQuoteReturn {
+    /** Expected UPD amount for the given ETH input (18 decimals). */
+    updAmount: bigint | undefined;
+    /** Current ETH/USD price used for the quote (18 decimals). */
+    ethUsdPrice: bigint | undefined;
+    /** Whether the price is still loading. */
+    isLoading: boolean;
+}
+/**
+ * Real-time mint quote hook — composes oracle price + pure math.
+ *
+ * @param ethAmount - ETH amount to quote (in wei). Pass 0n to disable.
+ * @param config - Optional oracle configuration.
+ *
+ * @example
+ * ```tsx
+ * const { updAmount, isLoading } = useMintQuote(parseEther('1'))
+ * // updAmount ≈ 2000e18 (at $2000/ETH)
+ * ```
+ */
+declare function useMintQuote(ethAmount: bigint, config?: UseMintQuoteConfig): UseMintQuoteReturn;
+
+interface UseBurnQuoteConfig extends UseEthUsdPriceConfig {
+}
+interface UseBurnQuoteReturn {
+    /** Expected stETH amount for the given UPD input (in wei). */
+    stEthAmount: bigint | undefined;
+    /** Current ETH/USD price used for the quote (18 decimals). */
+    ethUsdPrice: bigint | undefined;
+    /** Whether the price is still loading. */
+    isLoading: boolean;
+}
+/**
+ * Real-time burn quote hook — composes oracle price + pure math.
+ *
+ * @param updAmount - UPD amount to quote (18 decimals). Pass 0n to disable.
+ * @param config - Optional oracle configuration.
+ *
+ * @example
+ * ```tsx
+ * const { stEthAmount, isLoading } = useBurnQuote(parseUnits('2000', 18))
+ * // stEthAmount ≈ 1e18 (at $2000/ETH)
+ * ```
+ */
+declare function useBurnQuote(updAmount: bigint, config?: UseBurnQuoteConfig): UseBurnQuoteReturn;
+
+interface UseMintUPDConfig {
+    /** Address of the StabilizerNFT contract. */
+    stabilizerNFTAddress: Address;
+}
+interface UseMintUPDReturn {
+    /** Execute the mint transaction. */
+    mint: (params: {
+        to: Address;
+        ethAmount: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    /** Whether the transaction is being sent. */
+    isPending: boolean;
+    /** Transaction hash once submitted. */
+    txHash: Hash | undefined;
+    /** Whether we're waiting for confirmation. */
+    isConfirming: boolean;
+    /** Whether the transaction is confirmed. */
+    isConfirmed: boolean;
+    /** Error from the transaction, if any. */
+    error: Error | null;
+    /** Reset the mutation state. */
+    reset: () => void;
+}
+/**
+ * Write hook for minting UPD by depositing ETH.
+ *
+ * @example
+ * ```tsx
+ * const { mint, isPending, isConfirmed, error } = useMintUPD({
+ *   stabilizerNFTAddress: deployment.contracts.StabilizerNFT,
+ * })
+ *
+ * // Use with useEthUsdPrice to get attestation
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => mint({ to: userAddress, ethAmount: parseEther('1'), attestation })}>
+ *   Mint UPD
+ * </button>
+ * ```
+ */
+declare function useMintUPD(config: UseMintUPDConfig): UseMintUPDReturn;
+
+interface UseBurnUPDConfig {
+    /** Address of the StabilizerNFT contract. */
+    stabilizerNFTAddress: Address;
+}
+interface UseBurnUPDReturn {
+    /** Execute the burn transaction. */
+    burn: (params: {
+        updAmount: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    /** Whether the transaction is being sent. */
+    isPending: boolean;
+    /** Transaction hash once submitted. */
+    txHash: Hash | undefined;
+    /** Whether we're waiting for confirmation. */
+    isConfirming: boolean;
+    /** Whether the transaction is confirmed. */
+    isConfirmed: boolean;
+    /** Error from the transaction, if any. */
+    error: Error | null;
+    /** Reset the mutation state. */
+    reset: () => void;
+}
+/**
+ * Write hook for burning UPD to receive stETH.
+ *
+ * @example
+ * ```tsx
+ * const { burn, isPending, isConfirmed } = useBurnUPD({
+ *   stabilizerNFTAddress: deployment.contracts.StabilizerNFT,
+ * })
+ *
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => burn({ updAmount: parseUnits('1000', 18), attestation })}>
+ *   Burn 1000 UPD
+ * </button>
+ * ```
+ */
+declare function useBurnUPD(config: UseBurnUPDConfig): UseBurnUPDReturn;
+
+interface UseSystemHealthConfig {
+    /** Address of the OvercollateralizationReporter contract. */
+    reporterAddress: Address;
+    /** Address of the UPD token. */
+    tokenAddress: Address;
+    /** Oracle service URL. */
+    oracleUrl?: string;
+    /** Minimum collateral ratio in basis points (default: 12500 = 125%). */
+    minRatioBps?: bigint;
+}
+interface UseSystemHealthReturn {
+    /** Computed system health metrics, or undefined if still loading. */
+    health: SystemHealth | undefined;
+    /** Whether any underlying data is still loading. */
+    isLoading: boolean;
+}
+/**
+ * System health hook — composes useCollateral + useEthUsdPrice + computeSystemHealth.
+ *
+ * @example
+ * ```tsx
+ * const { health, isLoading } = useSystemHealth({
+ *   reporterAddress: deployment.contracts.OvercollateralizationReporter,
+ *   tokenAddress: deployment.contracts.UPDToken,
+ * })
+ *
+ * if (health && !health.isHealthy) {
+ *   return <Alert>System undercollateralized: {health.systemCollateralRatioBps} bps</Alert>
+ * }
+ * ```
+ */
+declare function useSystemHealth(config: UseSystemHealthConfig): UseSystemHealthReturn;
+
+interface UseSUPDConfig {
+    /** Address of the sUPD contract. */
+    supdAddress: Address;
+    /** User address to read balance for (optional). */
+    userAddress?: Address;
+}
+interface UseSUPDReturn {
+    /** User's sUPD balance (18 decimals). */
+    balance: bigint | undefined;
+    /** Total sUPD shares outstanding. */
+    totalSupply: bigint | undefined;
+    /** Current share value with accrued yield (18 decimals). */
+    shareValue: bigint | undefined;
+    /** Annual yield in basis points (e.g. 800 = 8%). */
+    annualYieldBps: bigint | undefined;
+    /** Total USD liability of all outstanding sUPD. */
+    totalLiabilityUSD: bigint | undefined;
+    /** Whether any read is still loading. */
+    isLoading: boolean;
+}
+/**
+ * Read hook for sUPD — share value, APY, balances, and total liability.
+ *
+ * @example
+ * ```tsx
+ * const { balance, shareValue, annualYieldBps, isLoading } = useSUPD({
+ *   supdAddress: deployment.contracts.sUPD,
+ *   userAddress: account.address,
+ * })
+ * ```
+ */
+declare function useSUPD(config: UseSUPDConfig): UseSUPDReturn;
+
+interface UseStakeUPDConfig {
+    /** Address of the sUPD contract. */
+    supdAddress: Address;
+}
+interface UseStakeUPDReturn {
+    /** Execute the stake transaction. User must approve UPD transfer to sUPD first. */
+    stake: (params: {
+        updAmount: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    isPending: boolean;
+    txHash: Hash | undefined;
+    isConfirming: boolean;
+    isConfirmed: boolean;
+    error: Error | null;
+    reset: () => void;
+}
+/**
+ * Write hook for staking UPD → sUPD.
+ *
+ * Note: The user must first approve the sUPD contract to spend their UPD tokens
+ * (via UPDToken.approve or EIP-3009 transferWithAuthorization).
+ *
+ * @example
+ * ```tsx
+ * const { stake, isPending } = useStakeUPD({
+ *   supdAddress: deployment.contracts.sUPD,
+ * })
+ *
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => stake({ updAmount: parseUnits('1000', 18), attestation })}>
+ *   Stake 1000 UPD
+ * </button>
+ * ```
+ */
+declare function useStakeUPD(config: UseStakeUPDConfig): UseStakeUPDReturn;
+
+interface UseUnstakeUPDConfig {
+    /** Address of the sUPD contract. */
+    supdAddress: Address;
+}
+interface UseUnstakeUPDReturn {
+    /** Execute the unstake transaction (unstakeToUPD — full redemption). */
+    unstake: (params: {
+        shares: bigint;
+        attestation: PriceAttestationQuery;
+    }) => void;
+    isPending: boolean;
+    txHash: Hash | undefined;
+    isConfirming: boolean;
+    isConfirmed: boolean;
+    error: Error | null;
+    reset: () => void;
+}
+/**
+ * Write hook for unstaking sUPD → UPD.
+ *
+ * Calls `unstakeToUPD(shares, priceQuery)` which gathers stETH from sUPD's
+ * stabilizer escrows and mints fresh UPD to the caller.
+ *
+ * For advanced unstake variants (pro-rata, queued, with-extra-UPD), use the
+ * contract ABI directly.
+ *
+ * @example
+ * ```tsx
+ * const { unstake, isPending } = useUnstakeUPD({
+ *   supdAddress: deployment.contracts.sUPD,
+ * })
+ *
+ * const { attestation } = useEthUsdPrice()
+ *
+ * <button onClick={() => unstake({ shares: myShares, attestation })}>
+ *   Unstake
+ * </button>
+ * ```
+ */
+declare function useUnstakeUPD(config: UseUnstakeUPDConfig): UseUnstakeUPDReturn;
+
+export { type UseBurnQuoteConfig, type UseBurnQuoteReturn, type UseBurnUPDConfig, type UseBurnUPDReturn, type UseCollateralConfig, type UseCollateralReturn, type UseEthUsdPriceConfig, type UseEthUsdPriceReturn, type UseMintQuoteConfig, type UseMintQuoteReturn, type UseMintUPDConfig, type UseMintUPDReturn, type UseSUPDConfig, type UseSUPDReturn, type UseStabilizerConfig, type UseStabilizerReturn, type UseStakeUPDConfig, type UseStakeUPDReturn, type UseSystemHealthConfig, type UseSystemHealthReturn, type UseUPDConfig, type UseUPDReturn, type UseUnstakeUPDConfig, type UseUnstakeUPDReturn, useBurnQuote, useBurnUPD, useCollateral, useEthUsdPrice, useMintQuote, useMintUPD, useSUPD, useStabilizer, useStakeUPD, useSystemHealth, useUPD, useUnstakeUPD };