@aspan/sdk 0.1.8 → 0.2.0

package/src/router.ts

@@ -0,0 +1,686 @@
+/**
+ * Aspan Router Client
+ * TypeScript client for interacting with the AspanRouter periphery contract
+ */
+
+import {
+  createPublicClient,
+  createWalletClient,
+  http,
+  zeroAddress,
+  type Address,
+  type PublicClient,
+  type WalletClient,
+  type Transport,
+  type Chain,
+  type Account,
+  type Hash,
+} from "viem";
+import { bsc, bscTestnet } from "viem/chains";
+import { RouterABI } from "./abi/router";
+import type {
+  SwapAndMintParams,
+  StakeAndMintParams,
+  SwapAndMintDefaultParams,
+  RouterMintApUSDParams,
+  RouterMintXBNBParams,
+  RouterRedeemApUSDParams,
+  RouterRedeemXBNBParams,
+  RouterRedeemAndSwapParams,
+  RouterRedeemAndUnstakeParams,
+  WithdrawalRequestInfo,
+  ExpectedOutput,
+} from "./types";
+
+// ============ Configuration ============
+
+export interface AspanRouterClientConfig {
+  /** Router contract address */
+  routerAddress: Address;
+  /** Chain to connect to */
+  chain?: Chain;
+  /** RPC URL (optional, uses default if not provided) */
+  rpcUrl?: string;
+}
+
+export interface AspanRouterWriteClientConfig extends AspanRouterClientConfig {
+  /** Account for signing transactions (required if walletClient not provided) */
+  account?: Account;
+  /** External wallet client (for browser environments with wagmi/rainbowkit) */
+  walletClient?: WalletClient<Transport, Chain, Account>;
+}
+
+// ============ Read-Only Client ============
+
+/**
+ * Read-only client for querying AspanRouter state
+ */
+export class AspanRouterReadClient {
+  protected readonly publicClient: PublicClient;
+  protected readonly routerAddress: Address;
+  protected readonly chain: Chain;
+
+  constructor(config: AspanRouterClientConfig) {
+    this.routerAddress = config.routerAddress;
+    this.chain = config.chain ?? bsc;
+
+    this.publicClient = createPublicClient({
+      chain: this.chain,
+      transport: http(config.rpcUrl),
+    });
+  }
+
+  // ============ View Functions ============
+
+  /**
+   * Get the default LST address
+   */
+  async getDefaultLST(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "defaultLST",
+    });
+  }
+
+  /**
+   * Check if an input token is supported
+   */
+  async isSupportedInputToken(token: Address): Promise<boolean> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "supportedInputTokens",
+      args: [token],
+    });
+  }
+
+  /**
+   * Check if an LST is supported
+   */
+  async isSupportedLST(lst: Address): Promise<boolean> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "supportedLSTs",
+      args: [lst],
+    });
+  }
+
+  /**
+   * Get the Diamond contract address
+   */
+  async getDiamond(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "diamond",
+    });
+  }
+
+  /**
+   * Get expected output from a swap and mint operation
+   */
+  async getExpectedOutput(
+    inputToken: Address,
+    inputAmount: bigint,
+    targetLST: Address,
+    mintXBNB: boolean
+  ): Promise<ExpectedOutput> {
+    const result = await this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "getExpectedOutput",
+      args: [inputToken, inputAmount, targetLST, mintXBNB],
+    });
+
+    return {
+      expectedLST: result[0],
+      expectedMint: result[1],
+    };
+  }
+
+  /**
+   * Get user's withdrawal request indices
+   */
+  async getUserWithdrawalIndices(user: Address): Promise<bigint[]> {
+    const result = await this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "getUserWithdrawalIndices",
+      args: [user],
+    });
+    return [...result];
+  }
+
+  /**
+   * Get withdrawal request status
+   */
+  async getWithdrawalStatus(
+    requestIndex: bigint
+  ): Promise<WithdrawalRequestInfo> {
+    const result = await this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "getWithdrawalStatus",
+      args: [requestIndex],
+    });
+
+    return {
+      isClaimable: result[0],
+      bnbAmount: result[1],
+    };
+  }
+
+  // ============ Token Address Getters ============
+
+  async getWBNB(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "wbnb",
+    });
+  }
+
+  async getUSDT(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "usdt",
+    });
+  }
+
+  async getUSDC(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "usdc",
+    });
+  }
+
+  async getSlisBNB(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "slisBNB",
+    });
+  }
+
+  async getAsBNB(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "asBNB",
+    });
+  }
+
+  async getWclisBNB(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "wclisBNB",
+    });
+  }
+
+  async getApUSD(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "apUSD",
+    });
+  }
+
+  async getXBNB(): Promise<Address> {
+    return this.publicClient.readContract({
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "xBNB",
+    });
+  }
+}
+
+// ============ Write Client ============
+
+/**
+ * Full client with write capabilities for AspanRouter
+ */
+export class AspanRouterClient extends AspanRouterReadClient {
+  private readonly walletClient: WalletClient;
+
+  constructor(config: AspanRouterWriteClientConfig) {
+    super(config);
+
+    if (config.walletClient) {
+      this.walletClient = config.walletClient;
+    } else if (config.account) {
+      this.walletClient = createWalletClient({
+        account: config.account,
+        chain: this.chain,
+        transport: http(config.rpcUrl),
+      });
+    } else {
+      throw new Error("Either walletClient or account must be provided");
+    }
+  }
+
+  // ============ Core Functions ============
+
+  /**
+   * Swap input token to LST and mint apUSD
+   */
+  async swapAndMintApUSD(params: SwapAndMintParams): Promise<Hash> {
+    const value =
+      params.swapParams.inputToken === zeroAddress
+        ? params.swapParams.inputAmount
+        : 0n;
+
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "swapAndMintApUSD",
+      args: [
+        {
+          inputToken: params.swapParams.inputToken,
+          inputAmount: params.swapParams.inputAmount,
+          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,
+        },
+      ],
+      value,
+    });
+  }
+
+  /**
+   * Swap input token to LST and mint xBNB
+   */
+  async swapAndMintXBNB(params: SwapAndMintParams): Promise<Hash> {
+    const value =
+      params.swapParams.inputToken === zeroAddress
+        ? params.swapParams.inputAmount
+        : 0n;
+
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "swapAndMintXBNB",
+      args: [
+        {
+          inputToken: params.swapParams.inputToken,
+          inputAmount: params.swapParams.inputAmount,
+          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,
+        },
+      ],
+      value,
+    });
+  }
+
+  /**
+   * Stake native BNB directly to LST and mint
+   */
+  async stakeAndMint(params: StakeAndMintParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "stakeAndMint",
+      args: [
+        params.targetLST,
+        params.mintXBNB,
+        params.minMintOut,
+        params.deadline,
+      ],
+      value: params.value,
+    });
+  }
+
+  // ============ Simplified Functions ============
+
+  /**
+   * Swap input token and mint apUSD using default LST
+   */
+  async swapAndMintApUSDDefault(params: SwapAndMintDefaultParams): Promise<Hash> {
+    const value =
+      params.inputToken === zeroAddress ? params.value ?? params.inputAmount : 0n;
+
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "swapAndMintApUSDDefault",
+      args: [
+        params.inputToken,
+        params.inputAmount,
+        params.minMintOut,
+        params.deadline,
+      ],
+      value,
+    });
+  }
+
+  /**
+   * Swap input token and mint xBNB using default LST
+   */
+  async swapAndMintXBNBDefault(params: SwapAndMintDefaultParams): Promise<Hash> {
+    const value =
+      params.inputToken === zeroAddress ? params.value ?? params.inputAmount : 0n;
+
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "swapAndMintXBNBDefault",
+      args: [
+        params.inputToken,
+        params.inputAmount,
+        params.minMintOut,
+        params.deadline,
+      ],
+      value,
+    });
+  }
+
+  /**
+   * Stake native BNB and mint apUSD using default LST
+   */
+  async stakeAndMintApUSD(minMintOut: bigint, value: bigint): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "stakeAndMintApUSD",
+      args: [minMintOut],
+      value,
+    });
+  }
+
+  /**
+   * Stake native BNB and mint xBNB using default LST
+   */
+  async stakeAndMintXBNB(minMintOut: bigint, value: bigint): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "stakeAndMintXBNB",
+      args: [minMintOut],
+      value,
+    });
+  }
+
+  // ============ Direct Mint/Redeem Functions ============
+
+  /**
+   * Mint apUSD by providing LST directly (no swap)
+   */
+  async mintApUSD(params: RouterMintApUSDParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "mintApUSD",
+      args: [params.lst, params.lstAmount, params.minOut ?? 0n],
+    });
+  }
+
+  /**
+   * Mint xBNB by providing LST directly (no swap)
+   */
+  async mintXBNB(params: RouterMintXBNBParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "mintXBNB",
+      args: [params.lst, params.lstAmount, params.minOut ?? 0n],
+    });
+  }
+
+  /**
+   * Redeem apUSD for LST (no swap)
+   */
+  async redeemApUSD(params: RouterRedeemApUSDParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "redeemApUSD",
+      args: [params.lst, params.apUSDAmount, params.minOut ?? 0n],
+    });
+  }
+
+  /**
+   * Redeem xBNB for LST (no swap)
+   */
+  async redeemXBNB(params: RouterRedeemXBNBParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "redeemXBNB",
+      args: [params.lst, params.xBNBAmount, params.minOut ?? 0n],
+    });
+  }
+
+  // ============ Redeem and Swap Functions ============
+
+  /**
+   * Redeem apUSD and swap LST to output token
+   */
+  async redeemApUSDAndSwap(params: RouterRedeemAndSwapParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "redeemApUSDAndSwap",
+      args: [
+        params.lst,
+        params.amount,
+        params.outputToken,
+        params.minOut,
+        params.deadline,
+        params.useV2,
+        params.poolFee,
+      ],
+    });
+  }
+
+  /**
+   * Redeem xBNB and swap LST to output token
+   */
+  async redeemXBNBAndSwap(params: RouterRedeemAndSwapParams): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "redeemXBNBAndSwap",
+      args: [
+        params.lst,
+        params.amount,
+        params.outputToken,
+        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 ============
+
+  /**
+   * Redeem apUSD and request native unstake from Lista (starts unbonding period)
+   */
+  async redeemApUSDAndRequestUnstake(apUSDAmount: bigint): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "redeemApUSDAndRequestUnstake",
+      args: [apUSDAmount],
+    });
+  }
+
+  /**
+   * Redeem xBNB and request native unstake from Lista (starts unbonding period)
+   */
+  async redeemXBNBAndRequestUnstake(xBNBAmount: bigint): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "redeemXBNBAndRequestUnstake",
+      args: [xBNBAmount],
+    });
+  }
+
+  /**
+   * Claim BNB after unbonding period completes
+   */
+  async claimUnstake(requestIndex: bigint): Promise<Hash> {
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account!,
+      address: this.routerAddress,
+      abi: RouterABI,
+      functionName: "claimUnstake",
+      args: [requestIndex],
+    });
+  }
+
+  // ============ Transaction Helpers ============
+
+  /**
+   * Wait for transaction confirmation
+   */
+  async waitForTransaction(hash: Hash) {
+    return this.publicClient.waitForTransactionReceipt({ hash });
+  }
+}
+
+// ============ Factory Functions ============
+
+/**
+ * Create a read-only router client for BSC mainnet
+ */
+export function createRouterReadClient(
+  routerAddress: Address,
+  rpcUrl?: string
+): AspanRouterReadClient {
+  return new AspanRouterReadClient({
+    routerAddress,
+    chain: bsc,
+    rpcUrl,
+  });
+}
+
+/**
+ * Create a full router client for BSC mainnet
+ */
+export function createRouterClient(
+  routerAddress: Address,
+  account: Account,
+  rpcUrl?: string
+): AspanRouterClient {
+  return new AspanRouterClient({
+    routerAddress,
+    account,
+    chain: bsc,
+    rpcUrl,
+  });
+}
+
+/**
+ * Create a read-only router client for BSC testnet
+ */
+export function createRouterTestnetReadClient(
+  routerAddress: Address,
+  rpcUrl?: string
+): AspanRouterReadClient {
+  return new AspanRouterReadClient({
+    routerAddress,
+    chain: bscTestnet,
+    rpcUrl,
+  });
+}
+
+/**
+ * Create a full router client for BSC testnet
+ */
+export function createRouterTestnetClient(
+  routerAddress: Address,
+  account: Account,
+  rpcUrl?: string
+): AspanRouterClient {
+  return new AspanRouterClient({
+    routerAddress,
+    account,
+    chain: bscTestnet,
+    rpcUrl,
+  });
+}