@aspan/sdk 0.4.4 → 0.4.6

package/src/client.ts

@@ -54,6 +54,7 @@ export function getChainById(chainId: number): Chain {
   return chain;
 }
 import { DiamondABI } from "./abi/diamond";
+import { SApUSDABI } from "./abi/sApUSD";
 import type {
   LSTInfo,
   LSTYieldInfo,
@@ -525,6 +526,20 @@ export class AspanReadClient {
     });
   }
 
+  /**
+   * Get user's underlying balances (apUSD + xBNB) from sApUSD vault
+   */
+  async getBalanceMulti(user: Address): Promise<{ apUSDBalance: bigint; xBNBBalance: bigint }> {
+    const sApUSDAddress = await this.getSApUSD();
+    const [apUSDBalance, xBNBBalance] = await this.publicClient.readContract({
+      address: sApUSDAddress,
+      abi: SApUSDABI,
+      functionName: "underlyingBalances",
+      args: [user],
+    });
+    return { apUSDBalance, xBNBBalance };
+  }
+
   async getUserStabilityPoolPosition(
     user: Address
   ): Promise<UserStabilityPoolPosition> {
@@ -583,20 +598,35 @@ export class AspanReadClient {
     }
   }
 
-  async previewRedeem(shares: bigint): Promise<bigint> {
-    try {
-      return await this.publicClient.readContract({
-        address: this.diamondAddress,
-        abi: DiamondABI,
-        functionName: "previewRedeem",
-        args: [shares],
-      });
-    } catch (error) {
-      if (this.isZeroSupplyError(error)) {
-        return shares; // 1:1 when pool is empty
-      }
-      throw error;
-    }
+  /**
+   * Preview withdraw with multi-asset support (apUSD + xBNB)
+   * Replaces previewRedeem — works for both clean and dirty pools.
+   * @param shares Amount of sApUSD shares to redeem
+   * @returns Object with apUSD and xBNB amounts, plus whether vault has xBNB
+   */
+  async previewRedeemMulti(shares: bigint): Promise<{
+    apUSD: bigint;
+    xBNB: bigint;
+    hasXBNB: boolean;
+    assets: Address[];
+    amounts: bigint[];
+  }> {
+    // Use Diamond's previewRedeemMulti (forwards to SApUSD)
+    const [assets, amounts] = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "previewRedeemMulti",
+      args: [shares],
+    }) as [Address[], bigint[]];
+
+    const hasXBNB = amounts.length > 1 && amounts[1] > 0n;
+    return {
+      apUSD: amounts[0] ?? 0n,
+      xBNB: amounts[1] ?? 0n,
+      hasXBNB,
+      assets,
+      amounts,
+    };
   }
 
   async getPendingYield(): Promise<bigint> {
@@ -770,6 +800,122 @@ export class AspanReadClient {
     };
   }
 
+  /**
+   * Get all fee tiers
+   * @returns Array of fee tiers sorted by minCR descending
+   */
+  async getAllFeeTiers(): Promise<FeeTier[]> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "getAllFeeTiers",
+    }) as unknown as Array<{
+      minCR: bigint;
+      apUSDMintFee: number;
+      apUSDRedeemFee: number;
+      xBNBMintFee: number;
+      xBNBRedeemFee: number;
+      apUSDMintDisabled: boolean;
+    }>;
+    return result.map((tier) => ({
+      minCR: tier.minCR,
+      apUSDMintFee: tier.apUSDMintFee,
+      apUSDRedeemFee: tier.apUSDRedeemFee,
+      xBNBMintFee: tier.xBNBMintFee,
+      xBNBRedeemFee: tier.xBNBRedeemFee,
+      apUSDMintDisabled: tier.apUSDMintDisabled,
+    }));
+  }
+
+  /**
+   * Get comprehensive vault (sApUSD) info for frontend display
+   * @returns Vault state including TVL, exchange rate, xBNB status
+   */
+  async getVaultInfo(): Promise<{
+    totalSupply: bigint;
+    totalAssets: bigint;
+    exchangeRate: bigint;
+    hasXBNB: boolean;
+    xBNBAmount: bigint;
+  }> {
+    const sApUSDAddress = await this.getSApUSD();
+    const [totalSupply, totalAssets, exchangeRate, conversion] = await Promise.all([
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "totalSupply",
+      }) as Promise<bigint>,
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "totalAssets",
+      }) as Promise<bigint>,
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "exchangeRate",
+      }) as Promise<bigint>,
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "hasStabilityConversion",
+      }) as Promise<[boolean, bigint]>,
+    ]);
+    return {
+      totalSupply,
+      totalAssets,
+      exchangeRate,
+      hasXBNB: conversion[0],
+      xBNBAmount: conversion[1],
+    };
+  }
+
+  /**
+   * Get full protocol dashboard data in one call (for frontend overview page)
+   * Batches all key metrics into a single multicall
+   */
+  async getProtocolOverview(): Promise<{
+    collateralRatio: bigint;
+    tvlBNB: bigint;
+    tvlUSD: bigint;
+    apUSDSupply: bigint;
+    xBNBSupply: bigint;
+    xBNBPriceUSD: bigint;
+    xBNBPriceBNB: bigint;
+    bnbPriceUSD: bigint;
+    currentFees: CurrentFeeTier;
+    stabilityMode: StabilityModeInfo;
+    totalStaked: bigint;
+  }> {
+    const [cr, tvlBNB, tvlUSD, apUSD, xBNB, xPriceUSD, xPriceBNB, bnbPrice, fees, sm, staked] =
+      await Promise.all([
+        this.getCollateralRatio(),
+        this.getTVLInBNB(),
+        this.getTVLInUSD(),
+        this.getApUSDSupply(),
+        this.getXBNBSupply(),
+        this.getXBNBPriceUSD(),
+        this.getXBNBPriceBNB(),
+        this.getBNBPriceUSD(),
+        this.getCurrentFeeTier(),
+        this.getStabilityMode(),
+        this.getTotalStaked(),
+      ]);
+    return {
+      collateralRatio: cr,
+      tvlBNB,
+      tvlUSD,
+      apUSDSupply: apUSD,
+      xBNBSupply: xBNB,
+      xBNBPriceUSD: xPriceUSD,
+      xBNBPriceBNB: xPriceBNB,
+      bnbPriceUSD: bnbPrice,
+      currentFees: fees,
+      stabilityMode: sm,
+      totalStaked: staked,
+    };
+  }
+
   async getCurrentFeeTier(): Promise<CurrentFeeTier> {
     try {
       const result = await this.publicClient.readContract({