@aspan/sdk 0.4.5 → 0.4.6

package/README.md

@@ -347,6 +347,13 @@ const hash = await client.deposit({ apUSDAmount: parseAmount("1000") });
 const position = await client.getUserStabilityPoolPosition(account.address);
 console.log("sApUSD Balance:", formatAmount(position.balance));
 console.log("Earned:", formatAmount(position.balance - position.deposited));
+
+// Preview withdrawal (supports dirty pools with apUSD + xBNB)
+const preview = await client.previewRedeemMulti(position.shares);
+console.log("Will receive apUSD:", formatAmount(preview.apUSD));
+if (preview.hasXBNB) {
+  console.log("Will also receive xBNB:", formatAmount(preview.xBNB));
+}
 ```
 
 ### 5. Quick Exit: apUSD/xBNB → USDT
@@ -539,6 +546,7 @@ console.log("Leverage:", formatAmount(stats.effectiveLeverage), "x");
 | `redeemXBNB(params)` | Redeem xBNB for LST |
 | `deposit(params)` | Deposit apUSD to stability pool |
 | `withdraw(params)` | Withdraw from stability pool |
+| `previewRedeemMulti(shares)` | Preview multi-asset withdrawal (apUSD + xBNB) |
 | `harvestYield()` | Trigger yield distribution |
 
 ---

package/dist/index.d.mts

@@ -468,9 +468,9 @@ declare class AspanReadClient {
     getExchangeRate(): Promise<bigint>;
     getTotalStaked(): Promise<bigint>;
     previewDeposit(assets: bigint): Promise<bigint>;
-    previewRedeem(shares: bigint): Promise<bigint>;
     /**
      * 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
      */
@@ -478,6 +478,8 @@ declare class AspanReadClient {
         apUSD: bigint;
         xBNB: bigint;
         hasXBNB: boolean;
+        assets: Address[];
+        amounts: bigint[];
     }>;
     getPendingYield(): Promise<bigint>;
     getTotalYieldGenerated(): Promise<bigint>;
@@ -1427,6 +1429,24 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "previewRedeemMulti";
+    readonly inputs: readonly [{
+        readonly name: "_shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "assets";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "amounts";
+        readonly type: "uint256[]";
+        readonly internalType: "uint256[]";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "getPendingYield";

package/dist/index.d.ts

@@ -468,9 +468,9 @@ declare class AspanReadClient {
     getExchangeRate(): Promise<bigint>;
     getTotalStaked(): Promise<bigint>;
     previewDeposit(assets: bigint): Promise<bigint>;
-    previewRedeem(shares: bigint): Promise<bigint>;
     /**
      * 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
      */
@@ -478,6 +478,8 @@ declare class AspanReadClient {
         apUSD: bigint;
         xBNB: bigint;
         hasXBNB: boolean;
+        assets: Address[];
+        amounts: bigint[];
     }>;
     getPendingYield(): Promise<bigint>;
     getTotalYieldGenerated(): Promise<bigint>;
@@ -1427,6 +1429,24 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "previewRedeemMulti";
+    readonly inputs: readonly [{
+        readonly name: "_shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "assets";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "amounts";
+        readonly type: "uint256[]";
+        readonly internalType: "uint256[]";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "getPendingYield";

package/dist/index.js

@@ -363,6 +363,16 @@ var DiamondABI = [
     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: "getPendingYield",
@@ -1291,45 +1301,26 @@ var AspanReadClient = class _AspanReadClient {
       throw error;
     }
   }
-  async previewRedeem(shares) {
-    try {
-      return await this.publicClient.readContract({
-        address: this.diamondAddress,
-        abi: DiamondABI,
-        functionName: "previewRedeem",
-        args: [shares]
-      });
-    } catch (error) {
-      if (this.isZeroSupplyError(error)) {
-        return shares;
-      }
-      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) {
-    const sApUSDAddress = await this.getSApUSD();
-    const [result, conversion] = await Promise.all([
-      this.publicClient.readContract({
-        address: sApUSDAddress,
-        abi: SApUSDABI,
-        functionName: "previewRedeemMulti",
-        args: [shares]
-      }),
-      this.publicClient.readContract({
-        address: sApUSDAddress,
-        abi: SApUSDABI,
-        functionName: "hasStabilityConversion"
-      })
-    ]);
+    const [assets, amounts] = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "previewRedeemMulti",
+      args: [shares]
+    });
+    const hasXBNB = amounts.length > 1 && amounts[1] > 0n;
     return {
-      apUSD: result[1][0],
-      xBNB: result[1][1],
-      hasXBNB: conversion[0]
+      apUSD: amounts[0] ?? 0n,
+      xBNB: amounts[1] ?? 0n,
+      hasXBNB,
+      assets,
+      amounts
     };
   }
   async getPendingYield() {

package/dist/index.mjs

@@ -305,6 +305,16 @@ var DiamondABI = [
     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: "getPendingYield",
@@ -1233,45 +1243,26 @@ var AspanReadClient = class _AspanReadClient {
       throw error;
     }
   }
-  async previewRedeem(shares) {
-    try {
-      return await this.publicClient.readContract({
-        address: this.diamondAddress,
-        abi: DiamondABI,
-        functionName: "previewRedeem",
-        args: [shares]
-      });
-    } catch (error) {
-      if (this.isZeroSupplyError(error)) {
-        return shares;
-      }
-      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) {
-    const sApUSDAddress = await this.getSApUSD();
-    const [result, conversion] = await Promise.all([
-      this.publicClient.readContract({
-        address: sApUSDAddress,
-        abi: SApUSDABI,
-        functionName: "previewRedeemMulti",
-        args: [shares]
-      }),
-      this.publicClient.readContract({
-        address: sApUSDAddress,
-        abi: SApUSDABI,
-        functionName: "hasStabilityConversion"
-      })
-    ]);
+    const [assets, amounts] = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "previewRedeemMulti",
+      args: [shares]
+    });
+    const hasXBNB = amounts.length > 1 && amounts[1] > 0n;
     return {
-      apUSD: result[1][0],
-      xBNB: result[1][1],
-      hasXBNB: conversion[0]
+      apUSD: amounts[0] ?? 0n,
+      xBNB: amounts[1] ?? 0n,
+      hasXBNB,
+      assets,
+      amounts
     };
   }
   async getPendingYield() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspan/sdk",
-  "version": "0.4.5",
+  "version": "0.4.6",
   "description": "TypeScript SDK for Aspan Protocol - LST-backed stablecoin on BNB Chain",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/abi/diamond.ts

@@ -303,6 +303,16 @@ export const DiamondABI = [
     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: "getPendingYield",

package/src/client.ts

@@ -598,24 +598,9 @@ 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
    */
@@ -623,25 +608,24 @@ export class AspanReadClient {
     apUSD: bigint;
     xBNB: bigint;
     hasXBNB: boolean;
+    assets: Address[];
+    amounts: bigint[];
   }> {
-    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]>,
-    ]);
+    // 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: result[1][0],
-      xBNB: result[1][1],
-      hasXBNB: conversion[0],
+      apUSD: amounts[0] ?? 0n,
+      xBNB: amounts[1] ?? 0n,
+      hasXBNB,
+      assets,
+      amounts,
     };
   }