@aspan/sdk 0.4.3 → 0.4.5

package/src/abi/sApUSD.ts

@@ -25,6 +25,18 @@ export const SApUSDABI = [
     outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "previewRedeemMulti",
+    inputs: [
+      { name: "shares", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "assets", type: "address[]", internalType: "address[]" },
+      { name: "amounts", type: "uint256[]", internalType: "uint256[]" }
+    ],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "hasStabilityConversion",
@@ -35,6 +47,30 @@ export const SApUSDABI = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "totalValue",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "underlyingBalances",
+    inputs: [{ name: "_user", type: "address", internalType: "address" }],
+    outputs: [
+      { name: "apUSDBalance", type: "uint256", internalType: "uint256" },
+      { name: "xBNBBalance", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "xBNBToApUSDRate",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "exchangeRate",

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> {
@@ -599,6 +614,37 @@ export class AspanReadClient {
     }
   }
 
+  /**
+   * Preview withdraw with multi-asset support (apUSD + xBNB)
+   * @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;
+  }> {
+    const sApUSDAddress = await this.getSApUSD();
+    const [result, conversion] = await Promise.all([
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "previewRedeemMulti",
+        args: [shares],
+      }) as Promise<[Address[], bigint[]]>,
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "hasStabilityConversion",
+      }) as Promise<[boolean, bigint]>,
+    ]);
+    return {
+      apUSD: result[1][0],
+      xBNB: result[1][1],
+      hasXBNB: conversion[0],
+    };
+  }
+
   async getPendingYield(): Promise<bigint> {
     try {
       return await this.publicClient.readContract({
@@ -770,6 +816,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({
@@ -1115,22 +1277,36 @@ export class AspanClient extends AspanReadClient {
   }
 
   /**
-   * Clean underwater xBNB (burn without getting LST back)
-   * @description Only works when xBNB is underwater (price = 0)
-   * @param xBNBAmount Amount of xBNB to clean (burn)
+   * Clean xBNB from sApUSD vault by converting back to apUSD
+   * @param xBNBAmount Amount of xBNB to clean
+   * @param minApUSDOut Minimum apUSD to receive (slippage protection)
    * @returns Transaction hash
    */
-  async cleanXbnb(xBNBAmount: bigint): Promise<Hash> {
+  async cleanVaultXBNB(xBNBAmount: bigint, minApUSDOut: bigint = 0n): Promise<Hash> {
     return this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account!,
       address: this.diamondAddress,
       abi: DiamondABI,
-      functionName: "cleanXbnb",
-      args: [xBNBAmount],
+      functionName: "cleanVaultXBNB",
+      args: [xBNBAmount, minApUSDOut],
     });
   }
 
+  /**
+   * Preview how much apUSD would be minted from cleaning xBNB
+   * @param xBNBAmount Amount of xBNB to preview
+   * @returns apUSD amount that would be minted
+   */
+  async previewCleanVaultXBNB(xBNBAmount: bigint): Promise<bigint> {
+    return this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "previewCleanVaultXBNB",
+      args: [xBNBAmount],
+    }) as Promise<bigint>;
+  }
+
   // ============ Fee Management Functions ============
 
   /**

package/src/index.ts

@@ -120,7 +120,7 @@ export const BSC_ADDRESSES = {
   router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6" as const,
   apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287" as const,
   xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43" as const,
-  sApUSD: "0x73407A291c007a47CC926EcD5CaC256A1E2d00cF" as const,
+  sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB" as const,
   // LSTs
   slisBNB: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B" as const,
   asBNB: "0x77734e70b6E88b4d82fE632a168EDf6e700912b6" as const,