@aspan/sdk 0.4.5 → 0.4.7

package/README.md

@@ -22,7 +22,7 @@ import { BSC_ADDRESSES } from "@aspan/sdk";
 | Contract | Address |
 |----------|---------|
 | **Diamond (Main Entry)** | `0x6a11B30d3a70727d5477D6d8090e144443fA1c78` |
-| **Router** | `0x813d3D1A3154950E2f1d8718305426a335A974A9` |
+| **Router** | `0x34a64c4EbDe830773083BA8c9469456616F6723b` |
 | **ApUSD** | `0x4570047eeB5aDb4081c5d470494EB5134e34A287` |
 | **XBNB** | `0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43` |
 | **SApUSD** | `0xE2BE739C4aA4126ee72D612d9548C38B1B0e5A1b` |
@@ -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

@@ -103,10 +103,6 @@ interface DepositParams {
 interface WithdrawParams {
     shares: bigint;
 }
-/** Parameters for withdrawing assets from stability pool */
-interface WithdrawAssetsParams {
-    assets: bigint;
-}
 /** Overall protocol statistics */
 interface ProtocolStats {
     tvlInBNB: bigint;
@@ -468,9 +464,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 +474,8 @@ declare class AspanReadClient {
         apUSD: bigint;
         xBNB: bigint;
         hasXBNB: boolean;
+        assets: Address[];
+        amounts: bigint[];
     }>;
     getPendingYield(): Promise<bigint>;
     getTotalYieldGenerated(): Promise<bigint>;
@@ -584,12 +582,6 @@ declare class AspanClient extends AspanReadClient {
      * @returns Transaction hash
      */
     withdraw(params: WithdrawParams): Promise<Hash>;
-    /**
-     * Withdraw from stability pool by asset amount
-     * @param params Withdraw parameters
-     * @returns Transaction hash
-     */
-    withdrawAssets(params: WithdrawAssetsParams): Promise<Hash>;
     /**
      * Harvest yield from LSTs
      * @returns Transaction hash
@@ -723,6 +715,14 @@ declare class AspanRouterReadClient {
      * Check if an LST is supported
      */
     isSupportedLST(lst: Address): Promise<boolean>;
+    /**
+     * Get LST mode (0 = SYNC, 1 = ASYNC_DIRECT_ONLY)
+     */
+    getLSTMode(lst: Address): Promise<number>;
+    /**
+     * Check whether an LST supports routed flows (swap/stake/redeemAndSwap)
+     */
+    isLSTRoutable(lst: Address): Promise<boolean>;
     /**
      * Get the Diamond contract address
      */
@@ -741,6 +741,22 @@ declare class AspanRouterReadClient {
      * @param amount Amount of apUSD/xBNB to redeem
      */
     previewRedeem(lst: Address, redeemXBNB: boolean, amount: bigint): Promise<bigint>;
+    /**
+     * SDK-only preview: input token -> estimated LST -> previewMint
+     * Note: oracle-based estimation (does not include live DEX slippage/price impact)
+     */
+    previewMintByInput(inputToken: Address, inputAmount: bigint, targetLST: Address, mintXBNB: boolean): Promise<{
+        lstAmount: bigint;
+        mintedAmount: bigint;
+    }>;
+    /**
+     * SDK-only preview: previewRedeem -> estimated output token
+     * Note: oracle-based estimation (does not include live DEX slippage/price impact)
+     */
+    previewRedeemToOutput(lst: Address, redeemXBNB: boolean, amount: bigint, outputToken: Address): Promise<{
+        lstAmount: bigint;
+        outputAmount: bigint;
+    }>;
     /**
      * Get user's withdrawal request indices
      */
@@ -1337,20 +1353,6 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
-}, {
-    readonly type: "function";
-    readonly name: "withdrawAssets";
-    readonly inputs: readonly [{
-        readonly name: "_assets";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }];
-    readonly outputs: readonly [{
-        readonly name: "shares";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }];
-    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
     readonly name: "getShares";
@@ -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";
@@ -2310,6 +2330,28 @@ declare const RouterABI: readonly [{
         readonly type: "bool";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "lstModes";
+    readonly inputs: readonly [{
+        readonly name: "lst";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isLSTRoutable";
+    readonly inputs: readonly [{
+        readonly name: "lst";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "previewMint";
@@ -2765,7 +2807,7 @@ declare const BPS_PRECISION = 10000n;
 declare const PRICE_PRECISION: bigint;
 declare const BSC_ADDRESSES: {
     readonly diamond: "0x6a11B30d3a70727d5477D6d8090e144443fA1c78";
-    readonly router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6";
+    readonly router: "0x34a64c4EbDe830773083BA8c9469456616F6723b";
     readonly apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287";
     readonly xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43";
     readonly sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB";
@@ -2825,4 +2867,4 @@ declare function formatPriceUSD(price: bigint): string;
  */
 declare function calculateAPY(previousRate: bigint, currentRate: bigint, periodDays: number): number;
 
-export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawAssetsParams, type WithdrawParams, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };
+export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawParams, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };

package/dist/index.d.ts

@@ -103,10 +103,6 @@ interface DepositParams {
 interface WithdrawParams {
     shares: bigint;
 }
-/** Parameters for withdrawing assets from stability pool */
-interface WithdrawAssetsParams {
-    assets: bigint;
-}
 /** Overall protocol statistics */
 interface ProtocolStats {
     tvlInBNB: bigint;
@@ -468,9 +464,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 +474,8 @@ declare class AspanReadClient {
         apUSD: bigint;
         xBNB: bigint;
         hasXBNB: boolean;
+        assets: Address[];
+        amounts: bigint[];
     }>;
     getPendingYield(): Promise<bigint>;
     getTotalYieldGenerated(): Promise<bigint>;
@@ -584,12 +582,6 @@ declare class AspanClient extends AspanReadClient {
      * @returns Transaction hash
      */
     withdraw(params: WithdrawParams): Promise<Hash>;
-    /**
-     * Withdraw from stability pool by asset amount
-     * @param params Withdraw parameters
-     * @returns Transaction hash
-     */
-    withdrawAssets(params: WithdrawAssetsParams): Promise<Hash>;
     /**
      * Harvest yield from LSTs
      * @returns Transaction hash
@@ -723,6 +715,14 @@ declare class AspanRouterReadClient {
      * Check if an LST is supported
      */
     isSupportedLST(lst: Address): Promise<boolean>;
+    /**
+     * Get LST mode (0 = SYNC, 1 = ASYNC_DIRECT_ONLY)
+     */
+    getLSTMode(lst: Address): Promise<number>;
+    /**
+     * Check whether an LST supports routed flows (swap/stake/redeemAndSwap)
+     */
+    isLSTRoutable(lst: Address): Promise<boolean>;
     /**
      * Get the Diamond contract address
      */
@@ -741,6 +741,22 @@ declare class AspanRouterReadClient {
      * @param amount Amount of apUSD/xBNB to redeem
      */
     previewRedeem(lst: Address, redeemXBNB: boolean, amount: bigint): Promise<bigint>;
+    /**
+     * SDK-only preview: input token -> estimated LST -> previewMint
+     * Note: oracle-based estimation (does not include live DEX slippage/price impact)
+     */
+    previewMintByInput(inputToken: Address, inputAmount: bigint, targetLST: Address, mintXBNB: boolean): Promise<{
+        lstAmount: bigint;
+        mintedAmount: bigint;
+    }>;
+    /**
+     * SDK-only preview: previewRedeem -> estimated output token
+     * Note: oracle-based estimation (does not include live DEX slippage/price impact)
+     */
+    previewRedeemToOutput(lst: Address, redeemXBNB: boolean, amount: bigint, outputToken: Address): Promise<{
+        lstAmount: bigint;
+        outputAmount: bigint;
+    }>;
     /**
      * Get user's withdrawal request indices
      */
@@ -1337,20 +1353,6 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
-}, {
-    readonly type: "function";
-    readonly name: "withdrawAssets";
-    readonly inputs: readonly [{
-        readonly name: "_assets";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }];
-    readonly outputs: readonly [{
-        readonly name: "shares";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }];
-    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
     readonly name: "getShares";
@@ -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";
@@ -2310,6 +2330,28 @@ declare const RouterABI: readonly [{
         readonly type: "bool";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "lstModes";
+    readonly inputs: readonly [{
+        readonly name: "lst";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isLSTRoutable";
+    readonly inputs: readonly [{
+        readonly name: "lst";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "previewMint";
@@ -2765,7 +2807,7 @@ declare const BPS_PRECISION = 10000n;
 declare const PRICE_PRECISION: bigint;
 declare const BSC_ADDRESSES: {
     readonly diamond: "0x6a11B30d3a70727d5477D6d8090e144443fA1c78";
-    readonly router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6";
+    readonly router: "0x34a64c4EbDe830773083BA8c9469456616F6723b";
     readonly apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287";
     readonly xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43";
     readonly sApUSD: "0x896770Dba7c0481539E25aaB56bE285ECF6D65eB";
@@ -2825,4 +2867,4 @@ declare function formatPriceUSD(price: bigint): string;
  */
 declare function calculateAPY(previousRate: bigint, currentRate: bigint, periodDays: number): number;
 
-export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawAssetsParams, type WithdrawParams, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };
+export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawParams, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };