@aspan/sdk 0.4.2 → 0.4.4

package/dist/index.d.mts

@@ -554,12 +554,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
@@ -1741,14 +1747,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 +2673,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

@@ -554,12 +554,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
@@ -1741,14 +1747,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 +2673,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.js

@@ -592,11 +592,27 @@ var DiamondABI = [
   },
   {
     type: "function",
-    name: "cleanXbnb",
-    inputs: [{ name: "_xBNBAmount", type: "uint256", internalType: "uint256" }],
-    outputs: [],
+    name: "cleanVaultXBNB",
+    inputs: [
+      { name: "_xBNBAmount", type: "uint256", internalType: "uint256" },
+      { name: "_minApUSDOut", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "apUSDMinted", type: "uint256", internalType: "uint256" }
+    ],
     stateMutability: "nonpayable"
   },
+  {
+    type: "function",
+    name: "previewCleanVaultXBNB",
+    inputs: [
+      { name: "_xBNBAmount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "apUSDOut", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "view"
+  },
   // ============ StabilityModeFacet Events ============
   {
     type: "event",
@@ -1569,18 +1585,31 @@ var AspanClient = class 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) {
+  async cleanVaultXBNB(xBNBAmount, minApUSDOut = 0n) {
     return this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account,
       address: this.diamondAddress,
       abi: DiamondABI,
-      functionName: "cleanXbnb",
+      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) {
+    return this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "previewCleanVaultXBNB",
       args: [xBNBAmount]
     });
   }
@@ -2494,7 +2523,7 @@ var BSC_ADDRESSES = {
   router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6",
   apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287",
   xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43",
-  sApUSD: "0x73407A291c007a47CC926EcD5CaC256A1E2d00cF",
+  sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB",
   // LSTs
   slisBNB: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B",
   asBNB: "0x77734e70b6E88b4d82fE632a168EDf6e700912b6",

package/dist/index.mjs

@@ -534,11 +534,27 @@ var DiamondABI = [
   },
   {
     type: "function",
-    name: "cleanXbnb",
-    inputs: [{ name: "_xBNBAmount", type: "uint256", internalType: "uint256" }],
-    outputs: [],
+    name: "cleanVaultXBNB",
+    inputs: [
+      { name: "_xBNBAmount", type: "uint256", internalType: "uint256" },
+      { name: "_minApUSDOut", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "apUSDMinted", type: "uint256", internalType: "uint256" }
+    ],
     stateMutability: "nonpayable"
   },
+  {
+    type: "function",
+    name: "previewCleanVaultXBNB",
+    inputs: [
+      { name: "_xBNBAmount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "apUSDOut", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "view"
+  },
   // ============ StabilityModeFacet Events ============
   {
     type: "event",
@@ -1511,18 +1527,31 @@ var AspanClient = class 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) {
+  async cleanVaultXBNB(xBNBAmount, minApUSDOut = 0n) {
     return this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account,
       address: this.diamondAddress,
       abi: DiamondABI,
-      functionName: "cleanXbnb",
+      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) {
+    return this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DiamondABI,
+      functionName: "previewCleanVaultXBNB",
       args: [xBNBAmount]
     });
   }
@@ -2441,7 +2470,7 @@ var BSC_ADDRESSES = {
   router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6",
   apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287",
   xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43",
-  sApUSD: "0x73407A291c007a47CC926EcD5CaC256A1E2d00cF",
+  sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB",
   // LSTs
   slisBNB: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B",
   asBNB: "0x77734e70b6E88b4d82fE632a168EDf6e700912b6",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspan/sdk",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "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

@@ -536,11 +536,27 @@ export const DiamondABI = [
   },
   {
     type: "function",
-    name: "cleanXbnb",
-    inputs: [{ name: "_xBNBAmount", type: "uint256", internalType: "uint256" }],
-    outputs: [],
+    name: "cleanVaultXBNB",
+    inputs: [
+      { name: "_xBNBAmount", type: "uint256", internalType: "uint256" },
+      { name: "_minApUSDOut", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "apUSDMinted", type: "uint256", internalType: "uint256" }
+    ],
     stateMutability: "nonpayable"
   },
+  {
+    type: "function",
+    name: "previewCleanVaultXBNB",
+    inputs: [
+      { name: "_xBNBAmount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      { name: "apUSDOut", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "view"
+  },
 
   // ============ StabilityModeFacet Events ============
   {

package/src/client.ts

@@ -1115,22 +1115,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,