@aspan/sdk 0.2.0 → 0.2.2

package/src/router.ts

@@ -27,9 +27,7 @@ import type {
   RouterRedeemApUSDParams,
   RouterRedeemXBNBParams,
   RouterRedeemAndSwapParams,
-  RouterRedeemAndUnstakeParams,
   WithdrawalRequestInfo,
-  ExpectedOutput,
 } from "./types";
 
 // ============ Configuration ============
@@ -119,25 +117,51 @@ export class AspanRouterReadClient {
   }
 
   /**
-   * Get expected output from a swap and mint operation
+   * Preview apUSD mint output for a given LST amount
    */
-  async getExpectedOutput(
-    inputToken: Address,
-    inputAmount: bigint,
-    targetLST: Address,
-    mintXBNB: boolean
-  ): Promise<ExpectedOutput> {
-    const result = await this.publicClient.readContract({
+  async previewMintApUSD(lst: Address, lstAmount: bigint): Promise<bigint> {
+    return this.publicClient.readContract({
       address: this.routerAddress,
       abi: RouterABI,
-      functionName: "getExpectedOutput",
-      args: [inputToken, inputAmount, targetLST, mintXBNB],
+      functionName: "previewMintApUSD",
+      args: [lst, lstAmount],
     });
+  }
 
-    return {
-      expectedLST: result[0],
-      expectedMint: result[1],
-    };
+  /**
+   * Preview xBNB mint output for a given LST amount
+   */
+  async previewMintXBNB(lst: Address, lstAmount: bigint): Promise<bigint> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "previewMintXBNB",
+      args: [lst, lstAmount],
+    });
+  }
+
+  /**
+   * Preview LST output for redeeming apUSD
+   */
+  async previewRedeemApUSD(lst: Address, apUSDAmount: bigint): Promise<bigint> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "previewRedeemApUSD",
+      args: [lst, apUSDAmount],
+    });
+  }
+
+  /**
+   * Preview LST output for redeeming xBNB
+   */
+  async previewRedeemXBNB(lst: Address, xBNBAmount: bigint): Promise<bigint> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "previewRedeemXBNB",
+      args: [lst, xBNBAmount],
+    });
   }
 
   /**
@@ -245,7 +269,7 @@ export class AspanRouterReadClient {
  * Full client with write capabilities for AspanRouter
  */
 export class AspanRouterClient extends AspanRouterReadClient {
-  private readonly walletClient: WalletClient;
+  public readonly walletClient: WalletClient;
 
   constructor(config: AspanRouterWriteClientConfig) {
     super(config);
@@ -287,10 +311,8 @@ export class AspanRouterClient extends AspanRouterReadClient {
           targetLST: params.swapParams.targetLST,
           minLSTOut: params.swapParams.minLSTOut,
           poolFee: params.swapParams.poolFee,
-          useV2: params.swapParams.useV2,
         },
         {
-          mintXBNB: params.mintParams.mintXBNB,
           minMintOut: params.mintParams.minMintOut,
           recipient: params.mintParams.recipient,
           deadline: params.mintParams.deadline,
@@ -322,10 +344,8 @@ export class AspanRouterClient extends AspanRouterReadClient {
           targetLST: params.swapParams.targetLST,
           minLSTOut: params.swapParams.minLSTOut,
           poolFee: params.swapParams.poolFee,
-          useV2: params.swapParams.useV2,
         },
         {
-          mintXBNB: params.mintParams.mintXBNB,
           minMintOut: params.mintParams.minMintOut,
           recipient: params.mintParams.recipient,
           deadline: params.mintParams.deadline,
@@ -347,7 +367,7 @@ export class AspanRouterClient extends AspanRouterReadClient {
       functionName: "stakeAndMint",
       args: [
         params.targetLST,
-        params.mintXBNB,
+        params.isXBNB,
         params.minMintOut,
         params.deadline,
       ],
@@ -494,7 +514,8 @@ export class AspanRouterClient extends AspanRouterReadClient {
   // ============ Redeem and Swap Functions ============
 
   /**
-   * Redeem apUSD and swap LST to output token
+   * Redeem apUSD and swap LST to output token via V3 path
+   * @param params.path - PancakeSwap V3 encoded path (use encodeV3Path helper)
    */
   async redeemApUSDAndSwap(params: RouterRedeemAndSwapParams): Promise<Hash> {
     return this.walletClient.writeContract({
@@ -506,17 +527,16 @@ export class AspanRouterClient extends AspanRouterReadClient {
       args: [
         params.lst,
         params.amount,
-        params.outputToken,
+        params.path,
         params.minOut,
         params.deadline,
-        params.useV2,
-        params.poolFee,
       ],
     });
   }
 
   /**
-   * Redeem xBNB and swap LST to output token
+   * Redeem xBNB and swap LST to output token via V3 path
+   * @param params.path - PancakeSwap V3 encoded path (use encodeV3Path helper)
    */
   async redeemXBNBAndSwap(params: RouterRedeemAndSwapParams): Promise<Hash> {
     return this.walletClient.writeContract({
@@ -528,47 +548,13 @@ export class AspanRouterClient extends AspanRouterReadClient {
       args: [
         params.lst,
         params.amount,
-        params.outputToken,
+        params.path,
         params.minOut,
         params.deadline,
-        params.useV2,
-        params.poolFee,
       ],
     });
   }
 
-  /**
-   * Redeem apUSD and instantly unstake LST to native BNB via DEX
-   */
-  async redeemApUSDAndUnstake(
-    params: RouterRedeemAndUnstakeParams
-  ): Promise<Hash> {
-    return this.walletClient.writeContract({
-      chain: this.chain,
-      account: this.walletClient.account!,
-      address: this.routerAddress,
-      abi: RouterABI,
-      functionName: "redeemApUSDAndUnstake",
-      args: [params.lst, params.amount, params.minBNBOut, params.deadline],
-    });
-  }
-
-  /**
-   * Redeem xBNB and instantly unstake LST to native BNB via DEX
-   */
-  async redeemXBNBAndUnstake(
-    params: RouterRedeemAndUnstakeParams
-  ): Promise<Hash> {
-    return this.walletClient.writeContract({
-      chain: this.chain,
-      account: this.walletClient.account!,
-      address: this.routerAddress,
-      abi: RouterABI,
-      functionName: "redeemXBNBAndUnstake",
-      args: [params.lst, params.amount, params.minBNBOut, params.deadline],
-    });
-  }
-
   // ============ Native Unstake Functions ============
 
   /**

package/src/types.ts

@@ -258,14 +258,10 @@ export interface RouterSwapParams {
   minLSTOut: bigint;
   /** PancakeSwap V3 pool fee tier (500, 2500, 10000) */
   poolFee: number;
-  /** true = PancakeSwap V2, false = V3 */
-  useV2: boolean;
 }
 
 /** Router mint parameters */
 export interface RouterMintParams {
-  /** true = mint xBNB, false = mint apUSD */
-  mintXBNB: boolean;
   /** Minimum output to receive (slippage protection) */
   minMintOut: bigint;
   /** Recipient of minted tokens (address(0) = msg.sender) */
@@ -285,7 +281,7 @@ export interface StakeAndMintParams {
   /** Target LST (slisBNB, asBNB, wclisBNB) */
   targetLST: Address;
   /** true = mint xBNB, false = mint apUSD */
-  mintXBNB: boolean;
+  isXBNB: boolean;
   /** Minimum output to receive */
   minMintOut: bigint;
   /** Transaction deadline timestamp */
@@ -348,22 +344,42 @@ export interface RouterRedeemXBNBParams {
   minOut?: bigint;
 }
 
-/** Parameters for redeemAndSwap functions */
+/** Parameters for redeemAndSwap functions (uses PancakeSwap V3 path) */
 export interface RouterRedeemAndSwapParams {
   /** LST to redeem */
   lst: Address;
   /** Amount to redeem (apUSD or xBNB) */
   amount: bigint;
-  /** Output token (address(0) for native BNB) */
-  outputToken: Address;
+  /**
+   * PancakeSwap V3 encoded swap path (LST → ... → outputToken)
+   * Use encodeV3Path() helper or get from PancakeSwap Quoter
+   * Example: slisBNB → WBNB → USDT
+   */
+  path: `0x${string}`;
   /** Minimum output to receive */
   minOut: bigint;
   /** Transaction deadline timestamp */
   deadline: bigint;
-  /** true = PancakeSwap V2, false = V3 */
-  useV2: boolean;
-  /** V3 pool fee tier (ignored if useV2) */
-  poolFee: number;
+}
+
+/**
+ * Encode a PancakeSwap V3 swap path
+ * @param tokens Array of token addresses in order
+ * @param fees Array of pool fees between each token pair
+ * @returns Encoded path bytes
+ */
+export function encodeV3Path(tokens: Address[], fees: number[]): `0x${string}` {
+  if (tokens.length < 2) throw new Error("Path must have at least 2 tokens");
+  if (fees.length !== tokens.length - 1) throw new Error("Fees length must be tokens.length - 1");
+
+  let path = tokens[0].toLowerCase().slice(2); // Remove 0x prefix
+  for (let i = 0; i < fees.length; i++) {
+    // Fee is 3 bytes (uint24)
+    const feeHex = fees[i].toString(16).padStart(6, "0");
+    path += feeHex;
+    path += tokens[i + 1].toLowerCase().slice(2);
+  }
+  return `0x${path}`;
 }
 
 /** Parameters for redeemAndUnstake functions */