@aspan/sdk 0.2.1 → 0.3.0

package/README.md

@@ -16,7 +16,8 @@ pnpm add @aspan/sdk
 | Contract | Address |
 |----------|---------|
 | **Diamond (Main Entry)** | `0x10d25Ae0690533e0BA9E64EC7ae77dbD4fE8A46f` |
-| **Router** | `0x46d4Bb3bB2d0A0a85739A6d467eFB3025388AE2E` |
+| **Router** | `0xf63f34f7e9608ae7d3a6f5b06ce423d9f9043648` |
+| **wclisBNB** | `0x439faaC2229559121C4Ad4fd8B3FE13Dff038046` |
 | **ApUSD** | `0x1977097E2E5697A6DD91b6732F368a14F50f6B3d` |
 | **XBNB** | `0xB78eB4d5928bAb158Eb23c3154544084cD2661d5` |
 | **SApUSD** | `0xE2BE739C4aA4126ee72D612d9548C38B1B0e5A1b` |
@@ -97,7 +98,7 @@ import { createRouterClient, AspanRouterClient } from "@aspan/sdk";
 import { privateKeyToAccount } from "viem/accounts";
 import { zeroAddress } from "viem";
 
-const ROUTER = "0x46d4Bb3bB2d0A0a85739A6d467eFB3025388AE2E";
+const ROUTER = "0xf63f34f7e9608ae7d3a6f5b06ce423d9f9043648";
 
 // Node.js
 const account = privateKeyToAccount("0x...");
@@ -126,10 +127,8 @@ const params: SwapAndMintParams = {
     targetLST: zeroAddress,           // Use default LST
     minLSTOut: 0n,                    // Or set slippage protection
     poolFee: 2500,                    // 0.25% V3 pool fee
-    useV2: true,                      // Use PancakeSwap V2
   },
   mintParams: {
-    mintXBNB: false,                  // Mint apUSD
     minMintOut: parseAmount("99"),    // Min 99 apUSD (1% slippage)
     recipient: zeroAddress,           // Send to msg.sender
     deadline: BigInt(Math.floor(Date.now() / 1000) + 3600),
@@ -212,29 +211,35 @@ const hash = await router.redeemApUSD({
 });
 ```
 
-### Redeem + Swap to USDT/BNB
+### Redeem + Swap to USDT/BNB (V3 Path)
 
 ```typescript
-// Redeem apUSD and swap LST to USDT
+import { encodeV3Path } from "@aspan/sdk";
+
+const SLISBNB = "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B";
+const WBNB = "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c";
+const USDT = "0x55d398326f99059fF775485246999027B3197955";
+
+// Encode V3 swap path: slisBNB → WBNB → USDT
+// Use encodeV3Path helper or get optimal path from PancakeSwap Quoter
+const path = encodeV3Path(
+  [SLISBNB, WBNB, USDT],  // tokens
+  [500, 500]              // pool fees (0.05% each hop)
+);
+
+// Redeem apUSD and swap LST to USDT via V3 path
 const hash = await router.redeemApUSDAndSwap({
-  lst: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B",
+  lst: SLISBNB,
   amount: parseAmount("100"),      // 100 apUSD
-  outputToken: USDT,               // Get USDT
+  path,                            // V3 encoded path
   minOut: parseAmount("99"),       // Min 99 USDT
   deadline: BigInt(Math.floor(Date.now() / 1000) + 3600),
-  useV2: true,
-  poolFee: 2500,
-});
-
-// Redeem and get native BNB instantly (via DEX swap)
-const hash = await router.redeemApUSDAndUnstake({
-  lst: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B",
-  amount: parseAmount("100"),
-  minBNBOut: parseAmount("0.1"),
-  deadline: BigInt(Math.floor(Date.now() / 1000) + 3600),
 });
 ```
 
+> **Note**: For optimal swap paths and quotes, use PancakeSwap V3 Quoter contract:
+> `0xB048Bbc1Ee6b733FFfCFb9e9CeF7375518e25997` (BSC Mainnet)
+
 ### Native Unstake (7-15 Day Unbonding)
 
 For no-slippage BNB redemption, use Lista's native unstake:
@@ -264,27 +269,7 @@ const defaultLST = await router.getDefaultLST();
 const isSupported = await router.isSupportedInputToken(USDT);
 const isLSTSupported = await router.isSupportedLST(slisBNB);
 
-// Preview swap + mint output (accurate calculation with fees)
-const mintOutput = await router.getExpectedMintOutput(
-  USDT,                  // inputToken
-  parseAmount("100"),    // inputAmount
-  zeroAddress,           // targetLST (use default)
-  false                  // isXBNB (false = apUSD)
-);
-console.log("Expected LST from swap:", formatAmount(mintOutput.expectedLST));
-console.log("Expected apUSD after mint:", formatAmount(mintOutput.expectedMint));
-
-// Preview redeem + swap output
-const redeemOutput = await router.getExpectedRedeemOutput(
-  false,                 // isXBNB (false = apUSD)
-  parseAmount("100"),    // redeemAmount
-  slisBNB,               // LST to redeem
-  USDT                   // outputToken
-);
-console.log("Expected LST from redeem:", formatAmount(redeemOutput.expectedLST));
-console.log("Expected USDT from swap:", formatAmount(redeemOutput.expectedMint));
-
-// Preview mint/redeem with LST (no swap, accurate with fees)
+// Preview mint/redeem with LST (accurate with fees)
 const apUSDOut = await router.previewMintApUSD(slisBNB, parseAmount("1"));
 const xBNBOut = await router.previewMintXBNB(slisBNB, parseAmount("1"));
 const lstFromApUSD = await router.previewRedeemApUSD(slisBNB, parseAmount("100"));
@@ -294,6 +279,7 @@ const lstFromXBNB = await router.previewRedeemXBNB(slisBNB, parseAmount("10"));
 const wbnb = await router.getWBNB();
 const usdt = await router.getUSDT();
 const slisBNB = await router.getSlisBNB();
+const wclisBNB = await router.getWclisBNB();
 ```
 
 ---
@@ -779,9 +765,7 @@ displayDashboard();
 | Category | Methods |
 |----------|---------|
 | **Config** | `getDefaultLST()`, `isSupportedInputToken()`, `isSupportedLST()`, `getDiamond()` |
-| **Preview Swap+Mint** | `getExpectedMintOutput()` (swap → LST → mint) |
-| **Preview Redeem+Swap** | `getExpectedRedeemOutput()` (redeem → LST → swap) |
-| **Preview Direct** | `previewMintApUSD()`, `previewMintXBNB()`, `previewRedeemApUSD()`, `previewRedeemXBNB()` |
+| **Preview** | `previewMintApUSD()`, `previewMintXBNB()`, `previewRedeemApUSD()`, `previewRedeemXBNB()` |
 | **Unstake** | `getUserWithdrawalIndices()`, `getWithdrawalStatus()` |
 | **Addresses** | `getWBNB()`, `getUSDT()`, `getUSDC()`, `getSlisBNB()`, `getAsBNB()`, `getWclisBNB()`, `getApUSD()`, `getXBNB()` |
 
@@ -792,7 +776,7 @@ displayDashboard();
 | **Swap+Mint** | `swapAndMintApUSD()`, `swapAndMintXBNB()`, `swapAndMintApUSDDefault()`, `swapAndMintXBNBDefault()` |
 | **Stake+Mint** | `stakeAndMint()`, `stakeAndMintApUSD()`, `stakeAndMintXBNB()` |
 | **Direct** | `mintApUSD()`, `mintXBNB()`, `redeemApUSD()`, `redeemXBNB()` |
-| **Redeem+Swap** | `redeemApUSDAndSwap()`, `redeemXBNBAndSwap()`, `redeemApUSDAndUnstake()`, `redeemXBNBAndUnstake()` |
+| **Redeem+Swap** | `redeemApUSDAndSwap()`, `redeemXBNBAndSwap()` (V3 path) |
 | **Native Unstake** | `redeemApUSDAndRequestUnstake()`, `redeemXBNBAndRequestUnstake()`, `claimUnstake()` |
 
 ---