@aspan/sdk 0.1.8 → 0.2.0

package/src/types.ts

@@ -243,3 +243,221 @@ export interface TransactionReceipt {
   transactionHash: Hash;
   status: "success" | "reverted";
 }
+
+// ============ Router Types ============
+
+/** Router swap parameters */
+export interface RouterSwapParams {
+  /** Input token address (address(0) for native BNB) */
+  inputToken: Address;
+  /** Amount of input token */
+  inputAmount: bigint;
+  /** Target LST address (address(0) uses default LST) */
+  targetLST: Address;
+  /** Minimum LST to receive from swap (slippage protection) */
+  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) */
+  recipient: Address;
+  /** Transaction deadline timestamp */
+  deadline: bigint;
+}
+
+/** Parameters for swapAndMint functions */
+export interface SwapAndMintParams {
+  swapParams: RouterSwapParams;
+  mintParams: RouterMintParams;
+}
+
+/** Parameters for stakeAndMint function */
+export interface StakeAndMintParams {
+  /** Target LST (slisBNB, asBNB, wclisBNB) */
+  targetLST: Address;
+  /** true = mint xBNB, false = mint apUSD */
+  mintXBNB: boolean;
+  /** Minimum output to receive */
+  minMintOut: bigint;
+  /** Transaction deadline timestamp */
+  deadline: bigint;
+  /** Native BNB amount to stake */
+  value: bigint;
+}
+
+/** Parameters for simplified swap and mint functions */
+export interface SwapAndMintDefaultParams {
+  /** Input token address (address(0) for native BNB) */
+  inputToken: Address;
+  /** Amount of input token */
+  inputAmount: bigint;
+  /** Minimum output to receive */
+  minMintOut: bigint;
+  /** Transaction deadline timestamp */
+  deadline: bigint;
+  /** Native BNB amount (if inputToken is address(0)) */
+  value?: bigint;
+}
+
+/** Parameters for router direct mint functions */
+export interface RouterMintApUSDParams {
+  /** LST token address */
+  lst: Address;
+  /** Amount of LST to deposit */
+  lstAmount: bigint;
+  /** Minimum apUSD to receive */
+  minOut?: bigint;
+}
+
+/** Parameters for router direct mint xBNB functions */
+export interface RouterMintXBNBParams {
+  /** LST token address */
+  lst: Address;
+  /** Amount of LST to deposit */
+  lstAmount: bigint;
+  /** Minimum xBNB to receive */
+  minOut?: bigint;
+}
+
+/** Parameters for router redeem apUSD functions */
+export interface RouterRedeemApUSDParams {
+  /** LST token to receive */
+  lst: Address;
+  /** Amount of apUSD to redeem */
+  apUSDAmount: bigint;
+  /** Minimum LST to receive */
+  minOut?: bigint;
+}
+
+/** Parameters for router redeem xBNB functions */
+export interface RouterRedeemXBNBParams {
+  /** LST token to receive */
+  lst: Address;
+  /** Amount of xBNB to redeem */
+  xBNBAmount: bigint;
+  /** Minimum LST to receive */
+  minOut?: bigint;
+}
+
+/** Parameters for redeemAndSwap functions */
+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;
+  /** 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;
+}
+
+/** Parameters for redeemAndUnstake functions */
+export interface RouterRedeemAndUnstakeParams {
+  /** LST to redeem */
+  lst: Address;
+  /** Amount to redeem (apUSD or xBNB) */
+  amount: bigint;
+  /** Minimum BNB to receive */
+  minBNBOut: bigint;
+  /** Transaction deadline timestamp */
+  deadline: bigint;
+}
+
+/** Withdrawal request status */
+export interface WithdrawalRequestInfo {
+  /** Whether the request can be claimed */
+  isClaimable: boolean;
+  /** Amount of BNB to receive */
+  bnbAmount: bigint;
+}
+
+/** Expected output from swap and mint */
+export interface ExpectedOutput {
+  /** Expected LST from swap */
+  expectedLST: bigint;
+  /** Expected apUSD/xBNB from mint */
+  expectedMint: bigint;
+}
+
+// ============ Router Event Types ============
+
+/** SwapAndMint event */
+export interface SwapAndMintEvent {
+  user: Address;
+  inputToken: Address;
+  inputAmount: bigint;
+  targetLST: Address;
+  lstAmount: bigint;
+  mintedToken: Address;
+  mintedAmount: bigint;
+}
+
+/** StakeAndMint event */
+export interface StakeAndMintEvent {
+  user: Address;
+  bnbAmount: bigint;
+  targetLST: Address;
+  lstAmount: bigint;
+  mintedToken: Address;
+  mintedAmount: bigint;
+}
+
+/** Router Mint event */
+export interface RouterMintEvent {
+  user: Address;
+  lst: Address;
+  lstAmount: bigint;
+  mintedToken: Address;
+  mintedAmount: bigint;
+}
+
+/** Router Redeem event */
+export interface RouterRedeemEvent {
+  user: Address;
+  redeemedToken: Address;
+  redeemedAmount: bigint;
+  lst: Address;
+  lstAmount: bigint;
+}
+
+/** RedeemAndSwap event */
+export interface RedeemAndSwapEvent {
+  user: Address;
+  redeemedToken: Address;
+  redeemedAmount: bigint;
+  lst: Address;
+  lstAmount: bigint;
+  outputToken: Address;
+  outputAmount: bigint;
+}
+
+/** UnstakeRequested event */
+export interface UnstakeRequestedEvent {
+  user: Address;
+  requestIndex: bigint;
+  redeemedToken: Address;
+  redeemedAmount: bigint;
+  slisBNBAmount: bigint;
+}
+
+/** UnstakeClaimed event */
+export interface UnstakeClaimedEvent {
+  user: Address;
+  requestIndex: bigint;
+  bnbAmount: bigint;
+}