@aspan/sdk 0.4.0 → 0.4.2

package/dist/index.d.ts

@@ -385,6 +385,20 @@ interface UnstakeClaimedEvent {
     bnbAmount: bigint;
 }
 
+/** Pharos Atlantic Testnet chain definition */
+declare const pharosTestnet: Chain;
+/** Supported chain IDs */
+declare const CHAIN_IDS: {
+    readonly BSC: 56;
+    readonly BSC_TESTNET: 97;
+    readonly PHAROS: 688689;
+};
+/**
+ * Get the viem Chain object for a given chainId.
+ * @throws if the chainId is not supported
+ */
+declare function getChainById(chainId: number): Chain;
+
 interface AspanClientConfig {
     /** Diamond contract address */
     diamondAddress: Address;
@@ -404,7 +418,7 @@ interface AspanWriteClientConfig extends AspanClientConfig {
  */
 declare class AspanReadClient {
     protected readonly publicClient: PublicClient;
-    protected readonly diamondAddress: Address;
+    readonly diamondAddress: Address;
     protected readonly chain: Chain;
     private static readonly ZERO_SUPPLY_ERROR_SIGNATURES;
     constructor(config: AspanClientConfig);
@@ -464,6 +478,16 @@ declare class AspanReadClient {
     getMaxPriceAge(): Promise<bigint>;
     getMinDepositPeriod(): Promise<bigint>;
     isPaused(): Promise<boolean>;
+    /**
+     * Check if xBNB liquidity has been bootstrapped
+     * @returns true if bootstrap has been called
+     */
+    isBootstrapped(): Promise<boolean>;
+    /**
+     * Get the amount of xBNB locked in bootstrap (burned to dead address)
+     * @returns xBNB amount in wei
+     */
+    getBootstrapXBNBAmount(): Promise<bigint>;
     getStabilityMode(): Promise<StabilityModeInfo>;
     canTriggerStabilityMode2(): Promise<StabilityMode2Info>;
     getOwner(): Promise<Address>;
@@ -521,6 +545,43 @@ declare class AspanClient extends AspanReadClient {
      * @returns Transaction hash
      */
     harvestYield(): Promise<Hash>;
+    /**
+     * Trigger Stability Mode 2 forced conversion
+     * @description Anyone can call when CR < 130%. Burns apUSD from stability pool
+     * and mints xBNB to compensate stakers.
+     * @param targetCR Target CR to restore to (in BPS, e.g., 14000 = 140%)
+     * @returns Transaction hash
+     */
+    triggerStabilityMode2(targetCR?: bigint): Promise<Hash>;
+    /**
+     * Clean underwater xBNB (burn without getting LST back)
+     * @description Only works when xBNB is underwater (price = 0)
+     * @param xBNBAmount Amount of xBNB to clean (burn)
+     * @returns Transaction hash
+     */
+    cleanXbnb(xBNBAmount: bigint): Promise<Hash>;
+    /**
+     * Set fee tiers (requires feeManager or owner role)
+     * @param tiers Array of fee tier configurations
+     * @returns Transaction hash
+     */
+    setFeeTiers(tiers: Array<{
+        minCR: bigint;
+        apUSDMintFee: number;
+        apUSDRedeemFee: number;
+        xBNBMintFee: number;
+        xBNBRedeemFee: number;
+        apUSDMintDisabled: boolean;
+    }>): Promise<Hash>;
+    /**
+     * Bootstrap xBNB liquidity (owner only)
+     * @description Initializes xBNB supply by minting to dead address, preventing extreme initial prices.
+     * Similar to Uniswap V2's MINIMUM_LIQUIDITY. Can only be called once.
+     * @param lstToken LST token address to deposit
+     * @param lstAmount Amount of LST to deposit for bootstrap
+     * @returns Transaction hash
+     */
+    bootstrap(lstToken: Address, lstAmount: bigint): Promise<Hash>;
     /**
      * Wait for transaction confirmation
      * @param hash Transaction hash
@@ -544,6 +605,33 @@ declare function createAspanTestnetReadClient(diamondAddress: Address, rpcUrl?:
  * Create a full client for BSC testnet
  */
 declare function createAspanTestnetClient(diamondAddress: Address, account: Account, rpcUrl?: string): AspanClient;
+/**
+ * Create a read-only client for Pharos Atlantic Testnet
+ */
+declare function createAspanPharosReadClient(diamondAddress: Address, rpcUrl?: string): AspanReadClient;
+/**
+ * Create a full client for Pharos Atlantic Testnet
+ */
+declare function createAspanPharosClient(diamondAddress: Address, account: Account, rpcUrl?: string): AspanClient;
+/**
+ * Create a read-only Aspan client by chainId.
+ * Defaults to BSC mainnet (chainId = 56) if chainId is not provided.
+ *
+ * @param diamondAddress Diamond contract address for the target chain.
+ * @param chainId        Target chain ID (56 = BSC, 688689 = Pharos). Defaults to 56.
+ * @param rpcUrl         Optional custom RPC endpoint.
+ */
+declare function createAspanReadClientForChain(diamondAddress: Address, chainId?: number, rpcUrl?: string): AspanReadClient;
+/**
+ * Create a write Aspan client by chainId using an external wagmi WalletClient.
+ * Defaults to BSC mainnet (chainId = 56) if chainId is not provided.
+ *
+ * @param diamondAddress Diamond contract address for the target chain.
+ * @param chainId        Target chain ID (56 = BSC, 688689 = Pharos). Defaults to 56.
+ * @param walletClient   External WalletClient from wagmi / viem.
+ * @param rpcUrl         Optional custom RPC endpoint.
+ */
+declare function createAspanWriteClientForChain(diamondAddress: Address, chainId: number | undefined, walletClient: WalletClient<Transport, Chain, Account>, rpcUrl?: string): AspanClient;
 
 interface AspanRouterClientConfig {
     /** Router contract address */
@@ -683,6 +771,33 @@ declare function createRouterTestnetReadClient(routerAddress: Address, rpcUrl?:
  * Create a full router client for BSC testnet
  */
 declare function createRouterTestnetClient(routerAddress: Address, account: Account, rpcUrl?: string): AspanRouterClient;
+/**
+ * Create a read-only router client for Pharos Atlantic Testnet
+ */
+declare function createRouterPharosReadClient(routerAddress: Address, rpcUrl?: string): AspanRouterReadClient;
+/**
+ * Create a full router client for Pharos Atlantic Testnet
+ */
+declare function createRouterPharosClient(routerAddress: Address, account: Account, rpcUrl?: string): AspanRouterClient;
+/**
+ * Create a read-only AspanRouter client by chainId.
+ * Defaults to BSC mainnet (chainId = 56) if chainId is not provided.
+ *
+ * @param routerAddress Router contract address for the target chain.
+ * @param chainId       Target chain ID (56 = BSC, 688689 = Pharos). Defaults to 56.
+ * @param rpcUrl        Optional custom RPC endpoint.
+ */
+declare function createRouterReadClientForChain(routerAddress: Address, chainId?: number, rpcUrl?: string): AspanRouterReadClient;
+/**
+ * Create a write AspanRouter client by chainId using an external wagmi WalletClient.
+ * Defaults to BSC mainnet (chainId = 56) if chainId is not provided.
+ *
+ * @param routerAddress Router contract address for the target chain.
+ * @param chainId       Target chain ID (56 = BSC, 688689 = Pharos). Defaults to 56.
+ * @param walletClient  External WalletClient from wagmi / viem.
+ * @param rpcUrl        Optional custom RPC endpoint.
+ */
+declare function createRouterWriteClientForChain(routerAddress: Address, chainId: number | undefined, walletClient: WalletClient<Transport, Chain, Account>, rpcUrl?: string): AspanRouterClient;
 
 /**
  * Combined Diamond ABI - includes all facet functions
@@ -1536,6 +1651,44 @@ declare const DiamondABI: readonly [{
         readonly internalType: "bool";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "bootstrap";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "_lstAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "xBNBAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "isBootstrapped";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getBootstrapXBNBAmount";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "getStabilityMode";
@@ -1586,6 +1739,16 @@ declare const DiamondABI: readonly [{
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "cleanXbnb";
+    readonly inputs: readonly [{
+        readonly name: "_xBNBAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
 }, {
     readonly type: "event";
     readonly name: "StabilityMode2Triggered";
@@ -1621,6 +1784,71 @@ declare const DiamondABI: readonly [{
         readonly internalType: "address";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setFeeManager";
+    readonly inputs: readonly [{
+        readonly name: "_feeManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getFeeManager";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setFeeTiers";
+    readonly inputs: readonly [{
+        readonly name: "_tiers";
+        readonly type: "tuple[]";
+        readonly internalType: "struct LibAppStorage.FeeTier[]";
+        readonly components: readonly [{
+            readonly name: "minCR";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "apUSDMintFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "apUSDRedeemFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "xBNBMintFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "xBNBRedeemFee";
+            readonly type: "uint16";
+            readonly internalType: "uint16";
+        }, {
+            readonly name: "apUSDMintDisabled";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }];
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "event";
+    readonly name: "FeeManagerSet";
+    readonly inputs: readonly [{
+        readonly name: "feeManager";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
 }];
 
 /**
@@ -2413,18 +2641,27 @@ declare const PRECISION: bigint;
 declare const BPS_PRECISION = 10000n;
 declare const PRICE_PRECISION: bigint;
 declare const BSC_ADDRESSES: {
-    readonly diamond: "0x10d25Ae0690533e0BA9E64EC7ae77dbD4fE8A46f";
-    readonly router: "0x813d3D1A3154950E2f1d8718305426a335A974A9";
-    readonly apUSD: "0x1977097E2E5697A6DD91b6732F368a14F50f6B3d";
-    readonly xBNB: "0xB78eB4d5928bAb158Eb23c3154544084cD2661d5";
-    readonly sApUSD: "0xE2BE739C4aA4126ee72D612d9548C38B1B0e5A1b";
+    readonly diamond: "0x6a11B30d3a70727d5477D6d8090e144443fA1c78";
+    readonly router: "0x29dd49b2e98674ee7531f17e4d40a7725918c3f6";
+    readonly apUSD: "0x4570047eeB5aDb4081c5d470494EB5134e34A287";
+    readonly xBNB: "0x0A0c9CD826e747D99F90D63e780B3727Da4D0d43";
+    readonly sApUSD: "0x73407A291c007a47CC926EcD5CaC256A1E2d00cF";
     readonly slisBNB: "0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B";
     readonly asBNB: "0x77734e70b6E88b4d82fE632a168EDf6e700912b6";
-    readonly wclisBNB: "0x439faaC2229559121C4Ad4fd8B3FE13Dff038046";
+    readonly wclisBNB: "0x448f7c2fa4e5135a4a5B50879602cf3CD428e108";
     readonly USDT: "0x55d398326f99059fF775485246999027B3197955";
     readonly USDC: "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d";
     readonly WBNB: "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c";
 };
+declare const PHAROS_ADDRESSES: {
+    readonly diamond: "0x67011Ce4B5E534FA78dD9922559B7005197DBcc8";
+    readonly apUSD: "0x82ac96db027772cE8a770e099370b5D7941B3ae4";
+    readonly xBNB: "0xFF43b2f50b2c6c588d14Ea4565Ee5Eb93e438576";
+    readonly sApUSD: "0xFA4B826CfD5faaAfA48E4963d8a7d6Cf9889A9A8";
+    readonly mockLST: "0xc7BB55759e8e04AfAA620De96E9E133B1FAd3e18";
+    readonly mockPriceFeed: "0xa2B41DDE7a7BB0A897DE476Ea441fB27A6978682";
+    readonly mockExchangeRate: "0xffA1938e072Ea3b144EA7e61662dd8B0818D82B9";
+};
 /**
  * Format a bigint amount to human-readable string with decimals
  * @param amount Amount in wei (18 decimals)
@@ -2465,4 +2702,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, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, 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, createAspanReadClient, createAspanTestnetClient, createAspanTestnetReadClient, createRouterClient, createRouterReadClient, createRouterTestnetClient, createRouterTestnetReadClient, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, parseAmount };
+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 };