@aspan/sdk 0.1.4

package/dist/index.d.ts

@@ -0,0 +1,1324 @@
+import * as viem from 'viem';
+import { Address, Hash, PublicClient, Chain, Account } from 'viem';
+
+/**
+ * Aspan SDK Type Definitions
+ */
+
+/** BigInt formatted as string for serialization */
+type BigIntString = string;
+/** Token addresses */
+interface TokenAddresses {
+    apUSD: Address;
+    xBNB: Address;
+    sApUSD: Address;
+}
+/** LST (Liquid Staking Token) info */
+interface LSTInfo {
+    isAccepted: boolean;
+    priceFeed: Address;
+    manualPriceUSD: bigint;
+    collateralAmount: bigint;
+    decimals: number;
+    exchangeRateProvider: Address;
+    useIntrinsicValue: boolean;
+}
+/** LST yield tracking info */
+interface LSTYieldInfo {
+    lastExchangeRate: bigint;
+    lastUpdateTimestamp: bigint;
+}
+/** Fee tier configuration */
+interface FeeTier {
+    minCR: bigint;
+    apUSDMintFee: number;
+    apUSDRedeemFee: number;
+    xBNBMintFee: number;
+    xBNBRedeemFee: number;
+    apUSDMintDisabled: boolean;
+}
+/** Current fee tier with CR */
+interface CurrentFeeTier extends FeeTier {
+    currentCR: bigint;
+}
+/** Current fees with tier info */
+interface CurrentFees {
+    currentCR: bigint;
+    tierMinCR: bigint;
+    apUSDMintFee: number;
+    apUSDRedeemFee: number;
+    xBNBMintFee: number;
+    xBNBRedeemFee: number;
+    apUSDMintDisabled: boolean;
+}
+/** Oracle bounds */
+interface OracleBounds {
+    minPrice: bigint;
+    maxPrice: bigint;
+}
+/** Stability mode info */
+interface StabilityModeInfo {
+    mode: number;
+    currentCR: bigint;
+}
+/** Stability mode 2 trigger info */
+interface StabilityMode2Info {
+    canTrigger: boolean;
+    currentCR: bigint;
+    potentialConversion: bigint;
+}
+/** Parameters for minting apUSD */
+interface MintApUSDParams {
+    lstToken: Address;
+    lstAmount: bigint;
+}
+/** Parameters for redeeming apUSD */
+interface RedeemApUSDParams {
+    lstToken: Address;
+    apUSDAmount: bigint;
+}
+/** Parameters for minting xBNB */
+interface MintXBNBParams {
+    lstToken: Address;
+    lstAmount: bigint;
+}
+/** Parameters for redeeming xBNB */
+interface RedeemXBNBParams {
+    lstToken: Address;
+    xBNBAmount: bigint;
+}
+/** Parameters for depositing to stability pool */
+interface DepositParams {
+    apUSDAmount: bigint;
+}
+/** Parameters for withdrawing from stability pool */
+interface WithdrawParams {
+    shares: bigint;
+}
+/** Parameters for withdrawing assets from stability pool */
+interface WithdrawAssetsParams {
+    assets: bigint;
+}
+/** Overall protocol statistics */
+interface ProtocolStats {
+    tvlInBNB: bigint;
+    tvlInUSD: bigint;
+    collateralRatio: bigint;
+    apUSDSupply: bigint;
+    xBNBSupply: bigint;
+    xBNBPriceBNB: bigint;
+    xBNBPriceUSD: bigint;
+    effectiveLeverage: bigint;
+}
+/** Stability pool statistics */
+interface StabilityPoolStats {
+    totalStaked: bigint;
+    exchangeRate: bigint;
+    pendingYield: bigint;
+}
+/** Yield statistics */
+interface YieldStats {
+    totalYieldGenerated: bigint;
+    pendingYield: bigint;
+    lastHarvestTimestamp: bigint;
+    minHarvestInterval: bigint;
+    previewedHarvest: bigint;
+}
+/** User's position in the stability pool */
+interface UserStabilityPoolPosition {
+    shares: bigint;
+    balance: bigint;
+}
+/** ApUSD minted event */
+interface ApUSDMintedEvent {
+    user: Address;
+    lstToken: Address;
+    lstAmount: bigint;
+    apUSDAmount: bigint;
+    feeBPS: bigint;
+}
+/** ApUSD redeemed event */
+interface ApUSDRedeemedEvent {
+    user: Address;
+    lstToken: Address;
+    apUSDAmount: bigint;
+    lstAmount: bigint;
+    feeBPS: bigint;
+}
+/** xBNB minted event */
+interface XBNBMintedEvent {
+    user: Address;
+    lstToken: Address;
+    lstAmount: bigint;
+    xBNBAmount: bigint;
+    feeBPS: bigint;
+}
+/** xBNB redeemed event */
+interface XBNBRedeemedEvent {
+    user: Address;
+    lstToken: Address;
+    xBNBAmount: bigint;
+    lstAmount: bigint;
+    feeBPS: bigint;
+}
+/** Deposited to stability pool event */
+interface DepositedEvent {
+    user: Address;
+    apUSDAmount: bigint;
+    sharesReceived: bigint;
+}
+/** Withdrawn from stability pool event */
+interface WithdrawnEvent {
+    user: Address;
+    sharesRedeemed: bigint;
+    apUSDReceived: bigint;
+}
+/** Yield harvested event */
+interface YieldHarvestedEvent {
+    yieldUSD: bigint;
+}
+/** Result of a transaction */
+interface TransactionResult {
+    hash: Hash;
+    wait: () => Promise<TransactionReceipt>;
+}
+/** Transaction receipt */
+interface TransactionReceipt {
+    blockHash: Hash;
+    blockNumber: bigint;
+    transactionHash: Hash;
+    status: "success" | "reverted";
+}
+
+interface AspanClientConfig {
+    /** Diamond contract address */
+    diamondAddress: Address;
+    /** Chain to connect to */
+    chain?: Chain;
+    /** RPC URL (optional, uses default if not provided) */
+    rpcUrl?: string;
+}
+interface AspanWriteClientConfig extends AspanClientConfig {
+    /** Account for signing transactions */
+    account: Account;
+}
+/**
+ * Read-only client for querying Aspan Protocol state
+ */
+declare class AspanReadClient {
+    protected readonly publicClient: PublicClient;
+    protected readonly diamondAddress: Address;
+    protected readonly chain: Chain;
+    private static readonly ZERO_SUPPLY_ERROR_SIGNATURES;
+    constructor(config: AspanClientConfig);
+    /**
+     * Check if error is a known zero supply error from the contract
+     */
+    protected isZeroSupplyError(error: unknown): boolean;
+    /**
+     * Get comprehensive protocol statistics
+     */
+    getProtocolStats(): Promise<ProtocolStats>;
+    /**
+     * Get stability pool statistics
+     */
+    getStabilityPoolStats(): Promise<StabilityPoolStats>;
+    /**
+     * Get yield statistics
+     */
+    getYieldStats(): Promise<YieldStats>;
+    getTVLInBNB(): Promise<bigint>;
+    getTVLInUSD(): Promise<bigint>;
+    getCollateralRatio(): Promise<bigint>;
+    getXBNBPriceBNB(): Promise<bigint>;
+    getXBNBPriceUSD(): Promise<bigint>;
+    getEffectiveLeverage(): Promise<bigint>;
+    getApUSDSupply(): Promise<bigint>;
+    getXBNBSupply(): Promise<bigint>;
+    getLSTCollateral(lstToken: Address): Promise<bigint>;
+    getCurrentFees(): Promise<CurrentFees>;
+    getBNBPriceUSD(): Promise<bigint>;
+    getLSTPriceUSD(lstToken: Address): Promise<bigint>;
+    getLSTInfo(lstToken: Address): Promise<LSTInfo>;
+    getSupportedLSTs(): Promise<readonly Address[]>;
+    isLSTSupported(lstToken: Address): Promise<boolean>;
+    getBNBPriceFeed(): Promise<Address>;
+    getOracleBounds(priceFeed: Address): Promise<OracleBounds>;
+    getShares(user: Address): Promise<bigint>;
+    getBalance(user: Address): Promise<bigint>;
+    getUserStabilityPoolPosition(user: Address): Promise<UserStabilityPoolPosition>;
+    getExchangeRate(): Promise<bigint>;
+    getTotalStaked(): Promise<bigint>;
+    previewDeposit(assets: bigint): Promise<bigint>;
+    previewRedeem(shares: bigint): Promise<bigint>;
+    getPendingYield(): Promise<bigint>;
+    getTotalYieldGenerated(): Promise<bigint>;
+    getLSTYieldInfo(lstToken: Address): Promise<LSTYieldInfo>;
+    getMinHarvestInterval(): Promise<bigint>;
+    getLastHarvestTimestamp(): Promise<bigint>;
+    previewHarvest(): Promise<bigint>;
+    getTokens(): Promise<TokenAddresses>;
+    getSApUSD(): Promise<Address>;
+    getStabilityPool(): Promise<Address>;
+    getTreasury(): Promise<Address>;
+    getFeeTierCount(): Promise<bigint>;
+    getFeeTier(index: bigint): Promise<FeeTier>;
+    getCurrentFeeTier(): Promise<CurrentFeeTier>;
+    getMaxPriceAge(): Promise<bigint>;
+    getMinDepositPeriod(): Promise<bigint>;
+    isPaused(): Promise<boolean>;
+    getStabilityMode(): Promise<StabilityModeInfo>;
+    canTriggerStabilityMode2(): Promise<StabilityMode2Info>;
+    getOwner(): Promise<Address>;
+}
+/**
+ * Full client with write capabilities for interacting with Aspan Protocol
+ */
+declare class AspanClient extends AspanReadClient {
+    private readonly walletClient;
+    constructor(config: AspanWriteClientConfig);
+    /**
+     * Mint apUSD by depositing LST
+     * @param params Mint parameters
+     * @returns Transaction hash
+     */
+    mintApUSD(params: MintApUSDParams): Promise<Hash>;
+    /**
+     * Redeem apUSD for LST
+     * @param params Redeem parameters
+     * @returns Transaction hash
+     */
+    redeemApUSD(params: RedeemApUSDParams): Promise<Hash>;
+    /**
+     * Mint xBNB by depositing LST
+     * @param params Mint parameters
+     * @returns Transaction hash
+     */
+    mintXBNB(params: MintXBNBParams): Promise<Hash>;
+    /**
+     * Redeem xBNB for LST
+     * @param params Redeem parameters
+     * @returns Transaction hash
+     */
+    redeemXBNB(params: RedeemXBNBParams): Promise<Hash>;
+    /**
+     * Deposit apUSD to stability pool to earn yield
+     * @param params Deposit parameters
+     * @returns Transaction hash
+     */
+    deposit(params: DepositParams): Promise<Hash>;
+    /**
+     * Withdraw from stability pool by shares
+     * @param params Withdraw parameters
+     * @returns Transaction hash
+     */
+    withdraw(params: WithdrawParams): Promise<Hash>;
+    /**
+     * Withdraw from stability pool by asset amount
+     * @param params Withdraw parameters
+     * @returns Transaction hash
+     */
+    withdrawAssets(params: WithdrawAssetsParams): Promise<Hash>;
+    /**
+     * Harvest yield from LSTs
+     * @returns Transaction hash
+     */
+    harvestYield(): Promise<Hash>;
+    /**
+     * Wait for transaction confirmation
+     * @param hash Transaction hash
+     * @returns Transaction receipt
+     */
+    waitForTransaction(hash: Hash): Promise<viem.TransactionReceipt>;
+}
+/**
+ * Create a read-only client for BSC mainnet
+ */
+declare function createAspanReadClient(diamondAddress: Address, rpcUrl?: string): AspanReadClient;
+/**
+ * Create a full client for BSC mainnet
+ */
+declare function createAspanClient(diamondAddress: Address, account: Account, rpcUrl?: string): AspanClient;
+/**
+ * Create a read-only client for BSC testnet
+ */
+declare function createAspanTestnetReadClient(diamondAddress: Address, rpcUrl?: string): AspanReadClient;
+/**
+ * Create a full client for BSC testnet
+ */
+declare function createAspanTestnetClient(diamondAddress: Address, account: Account, rpcUrl?: string): AspanClient;
+
+/**
+ * Combined Diamond ABI - includes all facet functions
+ * This ABI is used to interact with the Aspan Diamond contract
+ */
+declare const DiamondABI: readonly [{
+    readonly type: "function";
+    readonly name: "mintApUSD";
+    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: "apUSDAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemApUSD";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "_apUSDAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "lstAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "mintXBNB";
+    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: "redeemXBNB";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "_xBNBAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "lstAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getXBNBPriceBNB";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getXBNBPriceUSD";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTVLInBNB";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTVLInUSD";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getCollateralRatio";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getCurrentFees";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "currentCR";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "tierMinCR";
+        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 stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getEffectiveLeverage";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getApUSDSupply";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getXBNBSupply";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getLSTCollateral";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "event";
+    readonly name: "ApUSDMinted";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "lstToken";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "lstAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "apUSDAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "feeBPS";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "ApUSDRedeemed";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "lstToken";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "apUSDAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "lstAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "feeBPS";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "XBNBMinted";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "lstToken";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "lstAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "xBNBAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "feeBPS";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "XBNBRedeemed";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "lstToken";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "xBNBAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "lstAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "feeBPS";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "function";
+    readonly name: "getBNBPriceUSD";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getLSTPriceUSD";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getLSTInfo";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "isAccepted";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "manualPriceUSD";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "collateralAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "decimals";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "exchangeRateProvider";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "useIntrinsicValue";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getSupportedLSTs";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isLSTSupported";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "bnbPriceFeed";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getOracleBounds";
+    readonly inputs: readonly [{
+        readonly name: "_priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "minPrice";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "maxPrice";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "deposit";
+    readonly inputs: readonly [{
+        readonly name: "_apUSDAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "withdraw";
+    readonly inputs: readonly [{
+        readonly name: "_shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "assets";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "withdrawAssets";
+    readonly inputs: readonly [{
+        readonly name: "_assets";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getShares";
+    readonly inputs: readonly [{
+        readonly name: "_user";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getBalance";
+    readonly inputs: readonly [{
+        readonly name: "_user";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getExchangeRate";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTotalStaked";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "previewDeposit";
+    readonly inputs: readonly [{
+        readonly name: "_assets";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "previewRedeem";
+    readonly inputs: readonly [{
+        readonly name: "_shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getPendingYield";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "harvestYield";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "yieldAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "event";
+    readonly name: "Deposited";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "apUSDAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "sharesReceived";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "Withdrawn";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "sharesRedeemed";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "apUSDReceived";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "YieldHarvested";
+    readonly inputs: readonly [{
+        readonly name: "yieldUSD";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "function";
+    readonly name: "getTotalYieldGenerated";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getLSTYieldInfo";
+    readonly inputs: readonly [{
+        readonly name: "_lstToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "lastExchangeRate";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "lastUpdateTimestamp";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getMinHarvestInterval";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getLastHarvestTimestamp";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "previewHarvest";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "totalYieldUSD";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTokens";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "apUSD";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "xBNB";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getSApUSD";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getStabilityPool";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTreasury";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getFeeTierCount";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getFeeTier";
+    readonly inputs: readonly [{
+        readonly name: "_index";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: 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 stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getCurrentFeeTier";
+    readonly inputs: readonly [];
+    readonly outputs: 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 name: "currentCR";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getMaxPriceAge";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getMinDepositPeriod";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isPaused";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getStabilityMode";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "mode";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "currentCR";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "canTriggerStabilityMode2";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "canTrigger";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }, {
+        readonly name: "currentCR";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "potentialConversion";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "triggerStabilityMode2";
+    readonly inputs: readonly [{
+        readonly name: "_targetCR";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "apUSDBurned";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "xBNBMinted";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "event";
+    readonly name: "StabilityMode2Triggered";
+    readonly inputs: readonly [{
+        readonly name: "currentCR";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "targetCR";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "apUSDBurned";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "xBNBMinted";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "function";
+    readonly name: "owner";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}];
+
+/**
+ * Aspan SDK
+ * TypeScript SDK for interacting with the Aspan Protocol on BNB Chain
+ *
+ * @packageDocumentation
+ */
+
+declare const PRECISION: bigint;
+declare const BPS_PRECISION = 10000n;
+declare const PRICE_PRECISION: bigint;
+/**
+ * Format a bigint amount to human-readable string with decimals
+ * @param amount Amount in wei (18 decimals)
+ * @param decimals Number of decimal places to show
+ * @returns Formatted string
+ */
+declare function formatAmount(amount: bigint, decimals?: number): string;
+/**
+ * Parse a human-readable amount to bigint (18 decimals)
+ * @param amount Human-readable amount string
+ * @returns Amount in wei
+ */
+declare function parseAmount(amount: string): bigint;
+/**
+ * Format a fee in basis points to percentage string
+ * @param bps Fee in basis points
+ * @returns Percentage string (e.g., "0.25%")
+ */
+declare function formatFeeBPS(bps: number): string;
+/**
+ * Format collateral ratio to percentage string
+ * @param cr Collateral ratio (18 decimals, 1e18 = 100%)
+ * @returns Percentage string (e.g., "150%")
+ */
+declare function formatCR(cr: bigint): string;
+/**
+ * Format price (8 decimals) to USD string
+ * @param price Price in 8 decimals
+ * @returns USD string (e.g., "$583.25")
+ */
+declare function formatPriceUSD(price: bigint): string;
+/**
+ * Calculate effective APY from exchange rate change
+ * @param previousRate Previous exchange rate
+ * @param currentRate Current exchange rate
+ * @param periodDays Number of days between rates
+ * @returns Annualized percentage yield
+ */
+declare function calculateAPY(previousRate: bigint, currentRate: bigint, periodDays: number): number;
+
+export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, type AspanWriteClientConfig, BPS_PRECISION, type BigIntString, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemApUSDParams, type RedeemXBNBParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UserStabilityPoolPosition, type WithdrawAssetsParams, type WithdrawParams, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanReadClient, createAspanTestnetClient, createAspanTestnetReadClient, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, parseAmount };