@aspan/sdk 0.4.3 → 0.4.5

package/dist/index.d.mts

@@ -457,11 +457,28 @@ declare class AspanReadClient {
     getOracleBounds(priceFeed: Address): Promise<OracleBounds>;
     getShares(user: Address): Promise<bigint>;
     getBalance(user: Address): Promise<bigint>;
+    /**
+     * Get user's underlying balances (apUSD + xBNB) from sApUSD vault
+     */
+    getBalanceMulti(user: Address): Promise<{
+        apUSDBalance: bigint;
+        xBNBBalance: bigint;
+    }>;
     getUserStabilityPoolPosition(user: Address): Promise<UserStabilityPoolPosition>;
     getExchangeRate(): Promise<bigint>;
     getTotalStaked(): Promise<bigint>;
     previewDeposit(assets: bigint): Promise<bigint>;
     previewRedeem(shares: bigint): Promise<bigint>;
+    /**
+     * 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
+     */
+    previewRedeemMulti(shares: bigint): Promise<{
+        apUSD: bigint;
+        xBNB: bigint;
+        hasXBNB: boolean;
+    }>;
     getPendingYield(): Promise<bigint>;
     getTotalYieldGenerated(): Promise<bigint>;
     getLSTYieldInfo(lstToken: Address): Promise<LSTYieldInfo>;
@@ -474,6 +491,39 @@ declare class AspanReadClient {
     getTreasury(): Promise<Address>;
     getFeeTierCount(): Promise<bigint>;
     getFeeTier(index: bigint): Promise<FeeTier>;
+    /**
+     * Get all fee tiers
+     * @returns Array of fee tiers sorted by minCR descending
+     */
+    getAllFeeTiers(): Promise<FeeTier[]>;
+    /**
+     * Get comprehensive vault (sApUSD) info for frontend display
+     * @returns Vault state including TVL, exchange rate, xBNB status
+     */
+    getVaultInfo(): Promise<{
+        totalSupply: bigint;
+        totalAssets: bigint;
+        exchangeRate: bigint;
+        hasXBNB: boolean;
+        xBNBAmount: bigint;
+    }>;
+    /**
+     * Get full protocol dashboard data in one call (for frontend overview page)
+     * Batches all key metrics into a single multicall
+     */
+    getProtocolOverview(): Promise<{
+        collateralRatio: bigint;
+        tvlBNB: bigint;
+        tvlUSD: bigint;
+        apUSDSupply: bigint;
+        xBNBSupply: bigint;
+        xBNBPriceUSD: bigint;
+        xBNBPriceBNB: bigint;
+        bnbPriceUSD: bigint;
+        currentFees: CurrentFeeTier;
+        stabilityMode: StabilityModeInfo;
+        totalStaked: bigint;
+    }>;
     getCurrentFeeTier(): Promise<CurrentFeeTier>;
     getMaxPriceAge(): Promise<bigint>;
     getMinDepositPeriod(): Promise<bigint>;
@@ -554,12 +604,18 @@ declare class AspanClient extends AspanReadClient {
      */
     triggerStabilityMode2(targetCR?: bigint): Promise<Hash>;
     /**
-     * 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
      */
-    cleanXbnb(xBNBAmount: bigint): Promise<Hash>;
+    cleanVaultXBNB(xBNBAmount: bigint, minApUSDOut?: bigint): Promise<Hash>;
+    /**
+     * Preview how much apUSD would be minted from cleaning xBNB
+     * @param xBNBAmount Amount of xBNB to preview
+     * @returns apUSD amount that would be minted
+     */
+    previewCleanVaultXBNB(xBNBAmount: bigint): Promise<bigint>;
     /**
      * Set fee tiers (requires feeManager or owner role)
      * @param tiers Array of fee tier configurations
@@ -1523,6 +1579,16 @@ declare const DiamondABI: readonly [{
         readonly internalType: "address";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setSApUSD";
+    readonly inputs: readonly [{
+        readonly name: "_sApUSD";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
     readonly name: "getStabilityPool";
@@ -1553,6 +1619,41 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getAllFeeTiers";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "tuple[]";
+        readonly internalType: "struct LibAppStorage.FeeTier[]";
+        readonly components: readonly [{
+            readonly name: "minCR";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "apUSDMintFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "apUSDRedeemFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "xBNBMintFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "xBNBRedeemFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "apUSDMintDisabled";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }];
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "getFeeTier";
@@ -1741,14 +1842,36 @@ declare const DiamondABI: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
-    readonly name: "cleanXbnb";
+    readonly name: "cleanVaultXBNB";
     readonly inputs: readonly [{
         readonly name: "_xBNBAmount";
         readonly type: "uint256";
         readonly internalType: "uint256";
+    }, {
+        readonly name: "_minApUSDOut";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "apUSDMinted";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "previewCleanVaultXBNB";
+    readonly inputs: readonly [{
+        readonly name: "_xBNBAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "apUSDOut";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "event";
     readonly name: "StabilityMode2Triggered";
@@ -2645,7 +2768,7 @@ declare const BSC_ADDRESSES: {
     readonly router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6";
     readonly apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287";
     readonly xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43";
-    readonly sApUSD: "0x73407A291c007a47CC926EcD5CaC256A1E2d00cF";
+    readonly sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB";
     readonly slisBNB: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B";
     readonly asBNB: "0x77734e70b6E88b4d82fE632a168EDf6e700912b6";
     readonly wclisBNB: "0x448f7c2fa4e5135a4a5B50879602cf3CD428e108";

package/dist/index.d.ts

@@ -457,11 +457,28 @@ declare class AspanReadClient {
     getOracleBounds(priceFeed: Address): Promise<OracleBounds>;
     getShares(user: Address): Promise<bigint>;
     getBalance(user: Address): Promise<bigint>;
+    /**
+     * Get user's underlying balances (apUSD + xBNB) from sApUSD vault
+     */
+    getBalanceMulti(user: Address): Promise<{
+        apUSDBalance: bigint;
+        xBNBBalance: bigint;
+    }>;
     getUserStabilityPoolPosition(user: Address): Promise<UserStabilityPoolPosition>;
     getExchangeRate(): Promise<bigint>;
     getTotalStaked(): Promise<bigint>;
     previewDeposit(assets: bigint): Promise<bigint>;
     previewRedeem(shares: bigint): Promise<bigint>;
+    /**
+     * 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
+     */
+    previewRedeemMulti(shares: bigint): Promise<{
+        apUSD: bigint;
+        xBNB: bigint;
+        hasXBNB: boolean;
+    }>;
     getPendingYield(): Promise<bigint>;
     getTotalYieldGenerated(): Promise<bigint>;
     getLSTYieldInfo(lstToken: Address): Promise<LSTYieldInfo>;
@@ -474,6 +491,39 @@ declare class AspanReadClient {
     getTreasury(): Promise<Address>;
     getFeeTierCount(): Promise<bigint>;
     getFeeTier(index: bigint): Promise<FeeTier>;
+    /**
+     * Get all fee tiers
+     * @returns Array of fee tiers sorted by minCR descending
+     */
+    getAllFeeTiers(): Promise<FeeTier[]>;
+    /**
+     * Get comprehensive vault (sApUSD) info for frontend display
+     * @returns Vault state including TVL, exchange rate, xBNB status
+     */
+    getVaultInfo(): Promise<{
+        totalSupply: bigint;
+        totalAssets: bigint;
+        exchangeRate: bigint;
+        hasXBNB: boolean;
+        xBNBAmount: bigint;
+    }>;
+    /**
+     * Get full protocol dashboard data in one call (for frontend overview page)
+     * Batches all key metrics into a single multicall
+     */
+    getProtocolOverview(): Promise<{
+        collateralRatio: bigint;
+        tvlBNB: bigint;
+        tvlUSD: bigint;
+        apUSDSupply: bigint;
+        xBNBSupply: bigint;
+        xBNBPriceUSD: bigint;
+        xBNBPriceBNB: bigint;
+        bnbPriceUSD: bigint;
+        currentFees: CurrentFeeTier;
+        stabilityMode: StabilityModeInfo;
+        totalStaked: bigint;
+    }>;
     getCurrentFeeTier(): Promise<CurrentFeeTier>;
     getMaxPriceAge(): Promise<bigint>;
     getMinDepositPeriod(): Promise<bigint>;
@@ -554,12 +604,18 @@ declare class AspanClient extends AspanReadClient {
      */
     triggerStabilityMode2(targetCR?: bigint): Promise<Hash>;
     /**
-     * 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
      */
-    cleanXbnb(xBNBAmount: bigint): Promise<Hash>;
+    cleanVaultXBNB(xBNBAmount: bigint, minApUSDOut?: bigint): Promise<Hash>;
+    /**
+     * Preview how much apUSD would be minted from cleaning xBNB
+     * @param xBNBAmount Amount of xBNB to preview
+     * @returns apUSD amount that would be minted
+     */
+    previewCleanVaultXBNB(xBNBAmount: bigint): Promise<bigint>;
     /**
      * Set fee tiers (requires feeManager or owner role)
      * @param tiers Array of fee tier configurations
@@ -1523,6 +1579,16 @@ declare const DiamondABI: readonly [{
         readonly internalType: "address";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setSApUSD";
+    readonly inputs: readonly [{
+        readonly name: "_sApUSD";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
     readonly name: "getStabilityPool";
@@ -1553,6 +1619,41 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getAllFeeTiers";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "tuple[]";
+        readonly internalType: "struct LibAppStorage.FeeTier[]";
+        readonly components: readonly [{
+            readonly name: "minCR";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "apUSDMintFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "apUSDRedeemFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "xBNBMintFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "xBNBRedeemFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "apUSDMintDisabled";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }];
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "getFeeTier";
@@ -1741,14 +1842,36 @@ declare const DiamondABI: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
-    readonly name: "cleanXbnb";
+    readonly name: "cleanVaultXBNB";
     readonly inputs: readonly [{
         readonly name: "_xBNBAmount";
         readonly type: "uint256";
         readonly internalType: "uint256";
+    }, {
+        readonly name: "_minApUSDOut";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "apUSDMinted";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "previewCleanVaultXBNB";
+    readonly inputs: readonly [{
+        readonly name: "_xBNBAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "apUSDOut";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "event";
     readonly name: "StabilityMode2Triggered";
@@ -2645,7 +2768,7 @@ declare const BSC_ADDRESSES: {
     readonly router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6";
     readonly apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287";
     readonly xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43";
-    readonly sApUSD: "0x73407A291c007a47CC926EcD5CaC256A1E2d00cF";
+    readonly sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB";
     readonly slisBNB: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B";
     readonly asBNB: "0x77734e70b6E88b4d82fE632a168EDf6e700912b6";
     readonly wclisBNB: "0x448f7c2fa4e5135a4a5B50879602cf3CD428e108";