@aspan/sdk 0.5.1 → 0.5.3

package/dist/index.d.mts

@@ -461,6 +461,21 @@ declare class AspanReadClient {
         xBNBBalance: bigint;
     }>;
     getUserStabilityPoolPosition(user: Address): Promise<UserStabilityPoolPosition>;
+    /**
+     * Get realtime exchange rate using live xBNB price (not cached xBNBToApUSDRate).
+     * Use this for accurate PnL display — the on-chain exchangeRate() only updates
+     * on deposit/withdraw and doesn't reflect xBNB price changes between operations.
+     *
+     * @returns Exchange rate in 18 decimals (e.g. 1.15e18 means 1 sApUSD = 1.15 apUSD equivalent)
+     */
+    getRealtimeExchangeRate(): Promise<{
+        exchangeRate: bigint;
+        accountedApUSD: bigint;
+        accountedXBNB: bigint;
+        xBNBPriceUSD: bigint;
+        totalValue: bigint;
+        totalSupply: bigint;
+    }>;
     getExchangeRate(): Promise<bigint>;
     getTotalStaked(): Promise<bigint>;
     previewDeposit(assets: bigint): Promise<bigint>;
@@ -2829,13 +2844,13 @@ declare const BSC_ADDRESSES: {
     readonly WBNB: "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c";
 };
 declare const PHAROS_ADDRESSES: {
-    readonly diamond: "0x67011Ce4B5E534FA78dD9922559B7005197DBcc8";
-    readonly apUSD: "0x82ac96db027772cE8a770e099370b5D7941B3ae4";
-    readonly xBNB: "0xFF43b2f50b2c6c588d14Ea4565Ee5Eb93e438576";
-    readonly sApUSD: "0xFA4B826CfD5faaAfA48E4963d8a7d6Cf9889A9A8";
-    readonly mockLST: "0xc7BB55759e8e04AfAA620De96E9E133B1FAd3e18";
-    readonly mockPriceFeed: "0xa2B41DDE7a7BB0A897DE476Ea441fB27A6978682";
-    readonly mockExchangeRate: "0xffA1938e072Ea3b144EA7e61662dd8B0818D82B9";
+    readonly diamond: "0x58C39161187ae1C0776Ad94Dd16EcA8A2a7f544d";
+    readonly satUSD: "0x7eDf43250e1C8CDFb6D1FdB5995922732992F59D";
+    readonly xPHS: "0x36b436D143DC6fEF3Aa4b3BffdE118A9CD74db58";
+    readonly sSatUSD: "0x4f10C5DD2CCDEb8e0c075363060C08f47652DcbD";
+    readonly mockLST: "0x905548C4Ad100daE91ACb75e4f3B6f1E34544EB0";
+    readonly mockPriceFeed: "0xeD33b085de75BbcF8cA27af1feD4A6910A462328";
+    readonly mockExchangeRate: "0xdB608124e56bb62036aD53c70eeda042B9121B39";
 };
 /**
  * Format a bigint amount to human-readable string with decimals

package/dist/index.d.ts

@@ -461,6 +461,21 @@ declare class AspanReadClient {
         xBNBBalance: bigint;
     }>;
     getUserStabilityPoolPosition(user: Address): Promise<UserStabilityPoolPosition>;
+    /**
+     * Get realtime exchange rate using live xBNB price (not cached xBNBToApUSDRate).
+     * Use this for accurate PnL display — the on-chain exchangeRate() only updates
+     * on deposit/withdraw and doesn't reflect xBNB price changes between operations.
+     *
+     * @returns Exchange rate in 18 decimals (e.g. 1.15e18 means 1 sApUSD = 1.15 apUSD equivalent)
+     */
+    getRealtimeExchangeRate(): Promise<{
+        exchangeRate: bigint;
+        accountedApUSD: bigint;
+        accountedXBNB: bigint;
+        xBNBPriceUSD: bigint;
+        totalValue: bigint;
+        totalSupply: bigint;
+    }>;
     getExchangeRate(): Promise<bigint>;
     getTotalStaked(): Promise<bigint>;
     previewDeposit(assets: bigint): Promise<bigint>;
@@ -2829,13 +2844,13 @@ declare const BSC_ADDRESSES: {
     readonly WBNB: "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c";
 };
 declare const PHAROS_ADDRESSES: {
-    readonly diamond: "0x67011Ce4B5E534FA78dD9922559B7005197DBcc8";
-    readonly apUSD: "0x82ac96db027772cE8a770e099370b5D7941B3ae4";
-    readonly xBNB: "0xFF43b2f50b2c6c588d14Ea4565Ee5Eb93e438576";
-    readonly sApUSD: "0xFA4B826CfD5faaAfA48E4963d8a7d6Cf9889A9A8";
-    readonly mockLST: "0xc7BB55759e8e04AfAA620De96E9E133B1FAd3e18";
-    readonly mockPriceFeed: "0xa2B41DDE7a7BB0A897DE476Ea441fB27A6978682";
-    readonly mockExchangeRate: "0xffA1938e072Ea3b144EA7e61662dd8B0818D82B9";
+    readonly diamond: "0x58C39161187ae1C0776Ad94Dd16EcA8A2a7f544d";
+    readonly satUSD: "0x7eDf43250e1C8CDFb6D1FdB5995922732992F59D";
+    readonly xPHS: "0x36b436D143DC6fEF3Aa4b3BffdE118A9CD74db58";
+    readonly sSatUSD: "0x4f10C5DD2CCDEb8e0c075363060C08f47652DcbD";
+    readonly mockLST: "0x905548C4Ad100daE91ACb75e4f3B6f1E34544EB0";
+    readonly mockPriceFeed: "0xeD33b085de75BbcF8cA27af1feD4A6910A462328";
+    readonly mockExchangeRate: "0xdB608124e56bb62036aD53c70eeda042B9121B39";
 };
 /**
  * Format a bigint amount to human-readable string with decimals

package/dist/index.js

@@ -773,6 +773,20 @@ var SApUSDABI = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "accountedApUSD",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "accountedXBNB",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "xBNBToApUSDRate",
@@ -1269,6 +1283,48 @@ var AspanReadClient = class _AspanReadClient {
     ]);
     return { shares, balance };
   }
+  /**
+   * Get realtime exchange rate using live xBNB price (not cached xBNBToApUSDRate).
+   * Use this for accurate PnL display — the on-chain exchangeRate() only updates
+   * on deposit/withdraw and doesn't reflect xBNB price changes between operations.
+   *
+   * @returns Exchange rate in 18 decimals (e.g. 1.15e18 means 1 sApUSD = 1.15 apUSD equivalent)
+   */
+  async getRealtimeExchangeRate() {
+    const sApUSDAddress = await this.getSApUSD();
+    const PRECISION2 = 10n ** 18n;
+    const VIRTUAL_ASSETS = 10n ** 6n;
+    const VIRTUAL_SHARES = 10n ** 6n;
+    const [accountedApUSD, accountedXBNB, totalSupply, xBNBPriceUSD] = await Promise.all([
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "accountedApUSD"
+      }),
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "accountedXBNB"
+      }),
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "totalSupply"
+      }),
+      this.getXBNBPriceUSD()
+    ]);
+    const totalValue = accountedXBNB === 0n || xBNBPriceUSD === 0n ? accountedApUSD : accountedApUSD + accountedXBNB * xBNBPriceUSD / PRECISION2;
+    const supply = totalSupply + VIRTUAL_SHARES;
+    const exchangeRate = supply === 0n ? PRECISION2 : (totalValue + VIRTUAL_ASSETS) * PRECISION2 / supply;
+    return {
+      exchangeRate,
+      accountedApUSD,
+      accountedXBNB,
+      xBNBPriceUSD,
+      totalValue,
+      totalSupply
+    };
+  }
   async getExchangeRate() {
     try {
       return await this.publicClient.readContract({
@@ -3015,13 +3071,13 @@ var BSC_ADDRESSES = {
   WBNB: "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c"
 };
 var PHAROS_ADDRESSES = {
-  diamond: "0x67011Ce4B5E534FA78dD9922559B7005197DBcc8",
-  apUSD: "0x82ac96db027772cE8a770e099370b5D7941B3ae4",
-  xBNB: "0xFF43b2f50b2c6c588d14Ea4565Ee5Eb93e438576",
-  sApUSD: "0xFA4B826CfD5faaAfA48E4963d8a7d6Cf9889A9A8",
-  mockLST: "0xc7BB55759e8e04AfAA620De96E9E133B1FAd3e18",
-  mockPriceFeed: "0xa2B41DDE7a7BB0A897DE476Ea441fB27A6978682",
-  mockExchangeRate: "0xffA1938e072Ea3b144EA7e61662dd8B0818D82B9"
+  diamond: "0x58C39161187ae1C0776Ad94Dd16EcA8A2a7f544d",
+  satUSD: "0x7eDf43250e1C8CDFb6D1FdB5995922732992F59D",
+  xPHS: "0x36b436D143DC6fEF3Aa4b3BffdE118A9CD74db58",
+  sSatUSD: "0x4f10C5DD2CCDEb8e0c075363060C08f47652DcbD",
+  mockLST: "0x905548C4Ad100daE91ACb75e4f3B6f1E34544EB0",
+  mockPriceFeed: "0xeD33b085de75BbcF8cA27af1feD4A6910A462328",
+  mockExchangeRate: "0xdB608124e56bb62036aD53c70eeda042B9121B39"
 };
 function formatAmount(amount, decimals = 4) {
   const divisor = 10n ** BigInt(18 - decimals);

package/dist/index.mjs

@@ -715,6 +715,20 @@ var SApUSDABI = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "accountedApUSD",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "accountedXBNB",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "xBNBToApUSDRate",
@@ -1211,6 +1225,48 @@ var AspanReadClient = class _AspanReadClient {
     ]);
     return { shares, balance };
   }
+  /**
+   * Get realtime exchange rate using live xBNB price (not cached xBNBToApUSDRate).
+   * Use this for accurate PnL display — the on-chain exchangeRate() only updates
+   * on deposit/withdraw and doesn't reflect xBNB price changes between operations.
+   *
+   * @returns Exchange rate in 18 decimals (e.g. 1.15e18 means 1 sApUSD = 1.15 apUSD equivalent)
+   */
+  async getRealtimeExchangeRate() {
+    const sApUSDAddress = await this.getSApUSD();
+    const PRECISION2 = 10n ** 18n;
+    const VIRTUAL_ASSETS = 10n ** 6n;
+    const VIRTUAL_SHARES = 10n ** 6n;
+    const [accountedApUSD, accountedXBNB, totalSupply, xBNBPriceUSD] = await Promise.all([
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "accountedApUSD"
+      }),
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "accountedXBNB"
+      }),
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "totalSupply"
+      }),
+      this.getXBNBPriceUSD()
+    ]);
+    const totalValue = accountedXBNB === 0n || xBNBPriceUSD === 0n ? accountedApUSD : accountedApUSD + accountedXBNB * xBNBPriceUSD / PRECISION2;
+    const supply = totalSupply + VIRTUAL_SHARES;
+    const exchangeRate = supply === 0n ? PRECISION2 : (totalValue + VIRTUAL_ASSETS) * PRECISION2 / supply;
+    return {
+      exchangeRate,
+      accountedApUSD,
+      accountedXBNB,
+      xBNBPriceUSD,
+      totalValue,
+      totalSupply
+    };
+  }
   async getExchangeRate() {
     try {
       return await this.publicClient.readContract({
@@ -2962,13 +3018,13 @@ var BSC_ADDRESSES = {
   WBNB: "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c"
 };
 var PHAROS_ADDRESSES = {
-  diamond: "0x67011Ce4B5E534FA78dD9922559B7005197DBcc8",
-  apUSD: "0x82ac96db027772cE8a770e099370b5D7941B3ae4",
-  xBNB: "0xFF43b2f50b2c6c588d14Ea4565Ee5Eb93e438576",
-  sApUSD: "0xFA4B826CfD5faaAfA48E4963d8a7d6Cf9889A9A8",
-  mockLST: "0xc7BB55759e8e04AfAA620De96E9E133B1FAd3e18",
-  mockPriceFeed: "0xa2B41DDE7a7BB0A897DE476Ea441fB27A6978682",
-  mockExchangeRate: "0xffA1938e072Ea3b144EA7e61662dd8B0818D82B9"
+  diamond: "0x58C39161187ae1C0776Ad94Dd16EcA8A2a7f544d",
+  satUSD: "0x7eDf43250e1C8CDFb6D1FdB5995922732992F59D",
+  xPHS: "0x36b436D143DC6fEF3Aa4b3BffdE118A9CD74db58",
+  sSatUSD: "0x4f10C5DD2CCDEb8e0c075363060C08f47652DcbD",
+  mockLST: "0x905548C4Ad100daE91ACb75e4f3B6f1E34544EB0",
+  mockPriceFeed: "0xeD33b085de75BbcF8cA27af1feD4A6910A462328",
+  mockExchangeRate: "0xdB608124e56bb62036aD53c70eeda042B9121B39"
 };
 function formatAmount(amount, decimals = 4) {
   const divisor = 10n ** BigInt(18 - decimals);

package/package.json

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

package/src/abi/sApUSD.ts

@@ -64,6 +64,20 @@ export const SApUSDABI = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "accountedApUSD",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "accountedXBNB",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "xBNBToApUSDRate",

package/src/bot/services/risk-keeper.ts

@@ -318,11 +318,25 @@ export class RiskKeeperService {
 
       this.state.isProcessing = true;
 
-      // Calculate amount to clean (X% of total)
-      const cleanAmount = (vaultState.xBNBAmount * BigInt(this.TWAP_PERCENTAGE)) / 100n;
+      // Contract allows full clean when vault xBNB <= 10 xBNB (dust exemption)
+      // Otherwise capped at 10% per call (MAX_CLEAN_PERCENT_BPS = 1000)
+      const DUST_THRESHOLD = 10n * 10n ** 18n; // 10 xBNB — must match contract DUST_CLEAN_THRESHOLD
+      const FULL_CLEAN_THRESHOLD = 1n * 10n ** 18n; // 1 xBNB — below this, clean everything
+      let cleanAmount: bigint;
+
+      if (vaultState.xBNBAmount <= FULL_CLEAN_THRESHOLD) {
+        // Less than 1 xBNB remaining — clean all to avoid infinite tiny trades
+        cleanAmount = vaultState.xBNBAmount;
+        console.log(`[RiskKeeper] Below 1 xBNB (${Number(vaultState.xBNBAmount) / 1e18}), cleaning all in one shot`);
+      } else if (vaultState.xBNBAmount <= DUST_THRESHOLD) {
+        cleanAmount = vaultState.xBNBAmount;
+        console.log(`[RiskKeeper] Dust amount (${Number(vaultState.xBNBAmount) / 1e18} xBNB <= 10), cleaning all in one shot`);
+      } else {
+        cleanAmount = (vaultState.xBNBAmount * BigInt(this.TWAP_PERCENTAGE)) / 100n;
+      }
 
       if (cleanAmount === 0n) {
-        console.log("[RiskKeeper] Clean amount too small, skipping");
+        console.log("[RiskKeeper] Clean amount rounds to 0, skipping");
         return;
       }
 

package/src/client.ts

@@ -551,6 +551,66 @@ export class AspanReadClient {
     return { shares, balance };
   }
 
+  /**
+   * Get realtime exchange rate using live xBNB price (not cached xBNBToApUSDRate).
+   * Use this for accurate PnL display — the on-chain exchangeRate() only updates
+   * on deposit/withdraw and doesn't reflect xBNB price changes between operations.
+   *
+   * @returns Exchange rate in 18 decimals (e.g. 1.15e18 means 1 sApUSD = 1.15 apUSD equivalent)
+   */
+  async getRealtimeExchangeRate(): Promise<{
+    exchangeRate: bigint;
+    accountedApUSD: bigint;
+    accountedXBNB: bigint;
+    xBNBPriceUSD: bigint;
+    totalValue: bigint;
+    totalSupply: bigint;
+  }> {
+    const sApUSDAddress = await this.getSApUSD();
+    const PRECISION = 10n ** 18n;
+    const VIRTUAL_ASSETS = 10n ** 6n;
+    const VIRTUAL_SHARES = 10n ** 6n;
+
+    const [accountedApUSD, accountedXBNB, totalSupply, xBNBPriceUSD] = await Promise.all([
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "accountedApUSD",
+      }) as Promise<bigint>,
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "accountedXBNB",
+      }) as Promise<bigint>,
+      this.publicClient.readContract({
+        address: sApUSDAddress,
+        abi: SApUSDABI,
+        functionName: "totalSupply",
+      }) as Promise<bigint>,
+      this.getXBNBPriceUSD(),
+    ]);
+
+    // _totalValue = accountedApUSD + (accountedXBNB * xBNBPrice) / 1e18
+    const totalValue = accountedXBNB === 0n || xBNBPriceUSD === 0n
+      ? accountedApUSD
+      : accountedApUSD + (accountedXBNB * xBNBPriceUSD) / PRECISION;
+
+    // exchangeRate = (totalValue + VIRTUAL_ASSETS) * 1e18 / (totalSupply + VIRTUAL_SHARES)
+    const supply = totalSupply + VIRTUAL_SHARES;
+    const exchangeRate = supply === 0n
+      ? PRECISION
+      : ((totalValue + VIRTUAL_ASSETS) * PRECISION) / supply;
+
+    return {
+      exchangeRate,
+      accountedApUSD,
+      accountedXBNB,
+      xBNBPriceUSD,
+      totalValue,
+      totalSupply,
+    };
+  }
+
   async getExchangeRate(): Promise<bigint> {
     try {
       return await this.publicClient.readContract({

package/src/index.ts

@@ -134,13 +134,13 @@ export const BSC_ADDRESSES = {
 } as const;
 
 export const PHAROS_ADDRESSES = {
-  diamond: "0x67011Ce4B5E534FA78dD9922559B7005197DBcc8" as const,
-  apUSD: "0x82ac96db027772cE8a770e099370b5D7941B3ae4" as const,
-  xBNB: "0xFF43b2f50b2c6c588d14Ea4565Ee5Eb93e438576" as const,
-  sApUSD: "0xFA4B826CfD5faaAfA48E4963d8a7d6Cf9889A9A8" as const,
-  mockLST: "0xc7BB55759e8e04AfAA620De96E9E133B1FAd3e18" as const,
-  mockPriceFeed: "0xa2B41DDE7a7BB0A897DE476Ea441fB27A6978682" as const,
-  mockExchangeRate: "0xffA1938e072Ea3b144EA7e61662dd8B0818D82B9" as const,
+  diamond: "0x58C39161187ae1C0776Ad94Dd16EcA8A2a7f544d" as const,
+  satUSD: "0x7eDf43250e1C8CDFb6D1FdB5995922732992F59D" as const,
+  xPHS: "0x36b436D143DC6fEF3Aa4b3BffdE118A9CD74db58" as const,
+  sSatUSD: "0x4f10C5DD2CCDEb8e0c075363060C08f47652DcbD" as const,
+  mockLST: "0x905548C4Ad100daE91ACb75e4f3B6f1E34544EB0" as const,
+  mockPriceFeed: "0xeD33b085de75BbcF8cA27af1feD4A6910A462328" as const,
+  mockExchangeRate: "0xdB608124e56bb62036aD53c70eeda042B9121B39" as const,
 } as const;
 
 // ============ Utility Functions ============