@wireio/stake 0.5.2 → 0.7.0

package/lib/stake.d.ts

@@ -25,12 +25,6 @@ interface IStakingClient {
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio | null>;
     getSystemAPY(): Promise<number>;
-    /**
-     * Protocol fee charged for deposit from Native to LIQ
-     * in Solana: amount in lamports
-     * in Ethereum: amount in wei
-     */
-    getDepositFee(amount: bigint): Promise<bigint>;
     /**
      * Program-level prelaunch WIRE/tranche snapshot for this chain.
      *
@@ -43,15 +37,22 @@ interface IStakingClient {
         windowBefore?: number;
         windowAfter?: number;
     }): Promise<TrancheSnapshot | null>;
+    /**
+     * Protocol fee charged for deposit from Native to LIQ
+     * in Solana: amount in lamports
+     * in Ethereum: amount in wei
+     */
+    getDepositFee(amount: bigint): Promise<bigint>;
     /**
      * Estimate a conservative ETH(wei) / SOL(lamports) buffer to leave in the wallet
      * so the user can pay fees for the current deposit and at least one
      * more transaction, plus a bit extra for future interactions.
     */
-    estimateGasBuffer(options?: {
+    getDepositBuffer(options?: {
         txCount?: number;
         safetyMultiplier?: number;
-        minBuffer?: bigint;
+        minBufferLamports?: bigint;
+        balanceOverrideLamports?: bigint;
     }): Promise<bigint>;
 }
 /**
@@ -455,10 +456,11 @@ declare class EthereumStakingClient implements IStakingClient {
      * @param options.safetyMultiplier Additional safety multiplier on top of txCount (default 1.5x)
      * @param options.minBufferWei    Optional override minimum buffer (defaults ~0.002 ETH)
      */
-    estimateGasBuffer(options?: {
+    getDepositBuffer(options?: {
         txCount?: number;
         safetyMultiplier?: number;
         minBufferWei?: bigint;
+        balanceOverrideLamports?: bigint;
     }): Promise<bigint>;
     private updateMockAggregatorPrice;
 }
@@ -9107,6 +9109,21 @@ declare class SolanaStakingClient implements IStakingClient {
      * Used by balance-correction flows and debugging.
      */
     getUserRecord(): Promise<DistributionUserRecord | null>;
+    /**
+     * Unified, chain-agnostic tranche snapshot for Solana.
+     *
+     * Uses:
+     *  - liqsol_core.globalState (currentIndex, totalShares, etc.)
+     *  - liqsol_core.trancheState (price, supply, total sold, etc.)
+     *  - PriceHistory/Chainlink SOL/USD via TokenClient.getSolPriceUsdSafe()
+     *
+     * This is READ-ONLY and works even with no connected wallet.
+     */
+    getTrancheSnapshot(options?: {
+        chainID?: ChainID;
+        windowBefore?: number;
+        windowAfter?: number;
+    }): Promise<TrancheSnapshot>;
     /**
      * Returns the system APY (percent) for Solana,
      * using compound interest per epoch and a
@@ -9141,39 +9158,23 @@ declare class SolanaStakingClient implements IStakingClient {
      */
     getDepositFee(amountLamports: bigint, windowSize?: number): Promise<bigint>;
     /**
-     * Unified, chain-agnostic tranche snapshot for Solana.
-     *
-     * Uses:
-     *  - liqsol_core.globalState (currentIndex, totalShares, etc.)
-     *  - liqsol_core.trancheState (price, supply, total sold, etc.)
-     *  - PriceHistory/Chainlink SOL/USD via TokenClient.getSolPriceUsdSafe()
-     *
-     * This is READ-ONLY and works even with no connected wallet.
-     */
-    getTrancheSnapshot(options?: {
-        chainID?: ChainID;
-        windowBefore?: number;
-        windowAfter?: number;
-    }): Promise<TrancheSnapshot>;
-    /**
-     * Estimate a conservative SOL buffer (lamports) to leave in the wallet
-     * so the user can pay fees for the current deposit and at least one
-     * more transaction, plus a bit extra for future interactions.
+     * Compute a conservative "deposit buffer" in lamports that should be left
+     * in the wallet so that a MAX deposit (balance - buffer) will succeed.
      *
-     * Intended usage in UI:
-     *   const bufferLamports = await client.estimateGasBuffer();
-     *   const maxSpendable = balanceLamports > bufferLamports
-     *       ? balanceLamports - bufferLamports
-     *       : 0n;
+     * It accounts for:
+     *   - Runtime tx fees (via a dummy self-transfer)
+     *   - Protocol deposit fee (via getDepositFee(amount))
      *
-     * @param options.txCount          How many transactions to cover (default 2)
-     * @param options.safetyMultiplier Extra safety multiplier (default 3x)
-     * @param options.minBufferLamports Optional override minimum buffer (default ~0.01 SOL)
+     * Intended UI usage:
+     *   const buffer = await client.getDepositBuffer();
+     *   const balance = portfolio.native.amount;
+     *   const maxDeposit = balance > buffer ? balance - buffer : BigInt(0);
      */
-    estimateGasBuffer(options?: {
+    getDepositBuffer(options?: {
         txCount?: number;
         safetyMultiplier?: number;
         minBufferLamports?: bigint;
+        balanceOverrideLamports?: bigint;
     }): Promise<bigint>;
     /**
      * Send a signed transaction over HTTP RPC and wait for confirmation.