@wireio/stake 0.5.0 → 0.5.2

package/src/networks/ethereum/ethereum.ts

@@ -16,6 +16,8 @@ import { PretokenClient } from './clients/pretoken.client';
 import { OPPClient } from './clients/opp.client';
 import { ReceiptClient } from './clients/receipt.client';
 
+export const INITIAL_TRANCHE_SUPPLY = 35000;
+
 export class EthereumStakingClient implements IStakingClient {
     private readonly provider: ethers.providers.Web3Provider | ethers.providers.JsonRpcProvider;
     public readonly pubKey?: WirePubKey;
@@ -154,8 +156,8 @@ export class EthereumStakingClient implements IStakingClient {
      * actual  = liqETH token balance (ERC-20)
      * tracked = liqETH tracked balance (protocol/accounting view)
      */
-    async getPortfolio(): Promise<Portfolio> {
-        this.ensureUser();
+    async getPortfolio(): Promise<Portfolio | null> {
+        if (!this.signer) return Promise.resolve(null);
 
         const walletAddress = await this.signer!.getAddress();
 
@@ -199,7 +201,7 @@ export class EthereumStakingClient implements IStakingClient {
             currentIndex = BigInt(indexBn.toString());
             totalShares = BigInt(totalSharesBn.toString());
             userShares = BigInt(userSharesBn.toString());
-        } catch {}
+        } catch { }
 
         // sharesToTokens(userShares, currentIndex) = userShares * currentIndex / indexScale
         let estimatedClaim = BigInt(0);
@@ -287,10 +289,18 @@ export class EthereumStakingClient implements IStakingClient {
     // READ-ONLY Public Methods
     // ---------------------------------------------------------------------
 
-    // Estimated total APY for staking yeild
+    // Protocol-wide ETH staking APY in percent, e.g. 3.0 => "3.00%"
     async getSystemAPY(): Promise<number> {
+        // NOTE: despite the name, this value is effectively *annual* BPS on-chain.
+        // e.g. 300 => 3% APY
         const annualBpsBn = await this.contract.DepositManager.dailyRateBPS();
-        return annualBpsBn.toNumber() / 10000; // 0.04 for 4%
+        const annualBps = annualBpsBn.toNumber(); // e.g. 300 for 3%
+
+        // Convert basis points (1/100 of 1%) to percent:
+        // 10,000 bps = 100% ⇒ 100 bps = 1% ⇒ divide by 100.
+        const apyPercent = annualBps / 100;
+
+        return apyPercent; // 3 => "3.00%"
     }
 
     // Protocol fee charged for deposit from Native to LIQ
@@ -339,7 +349,7 @@ export class EthereumStakingClient implements IStakingClient {
 
 
             // Fetch all required contract data
-            const [totalSharesBn, indexBn, trancheNumberBn, trancheSupplyBn, tranchePriceWadBn, totalSupplyBn, supplyGrowthBps, priceIncrementUsd, minPriceUsd, maxPriceUsd] = await Promise.all([
+            const [totalSharesBn, indexBn, trancheNumberBn, trancheSupplyBn, tranchePriceWadBn, totalSupplyBn, supplyGrowthBps, priceGrowthCents, minPriceUsd, maxPriceUsd] = await Promise.all([
                 this.contract.Depositor.totalShares(blockTag),
                 this.contract.Depositor.index(blockTag),
                 this.contract.Pretoken.trancheNumber(blockTag),
@@ -362,11 +372,7 @@ export class EthereumStakingClient implements IStakingClient {
             let ethPriceUsd: bigint = BigInt(answer.toString());
             let nativePriceTimestamp: number = Number(updatedAt);
 
-            // ! Placeholder from hoodi deployment - don't think this can be fetched dynamically
-            const initialTrancheSupply = BigInt(70000) * BigInt(1e8);
-
-            console.log('priceIncrementUsd',priceIncrementUsd);
-            
+            const initialTrancheSupply = BigInt(INITIAL_TRANCHE_SUPPLY) * BigInt(1e8);
 
             return buildEthereumTrancheSnapshot({
                 chainID,
@@ -378,7 +384,7 @@ export class EthereumStakingClient implements IStakingClient {
                 totalTrancheSupply,
                 initialTrancheSupply,
                 supplyGrowthBps,
-                priceIncrementUsd,
+                priceGrowthCents,
                 minPriceUsd,
                 maxPriceUsd,
 
@@ -390,11 +396,81 @@ export class EthereumStakingClient implements IStakingClient {
         }
         catch (err: any) {
             console.log(err);
-            
+
             throw new Error(`Error fetching Ethereum tranche snapshot: ${err?.message || err}`);
         }
     }
 
+    /**
+     * Estimate a conservative native ETH buffer (in wei) to leave in the wallet
+     * so the user can pay gas for the current deposit and at least one more tx.
+     *
+     * Typical usage in UI:
+     *   const buffer = await client.estimateGasBuffer();
+     *   const maxSpendable = balanceWei > buffer ? balanceWei - buffer : 0n;
+     *
+     * @param options.txCount         How many transactions to cover (default 2: deposit + 1 more)
+     * @param options.safetyMultiplier Additional safety multiplier on top of txCount (default 1.5x)
+     * @param options.minBufferWei    Optional override minimum buffer (defaults ~0.002 ETH)
+     */
+    async estimateGasBuffer(options?: {
+        txCount?: number;
+        safetyMultiplier?: number;
+        minBufferWei?: bigint;
+    }): Promise<bigint> {
+        this.ensureUser();
+
+        const walletAddress = await this.signer!.getAddress();
+
+        // 1) Estimate a baseline gas usage using a simple self-transfer.
+        //    This is cheap and doesn't depend on your contract ABI at all.
+        const baseGas = await this.provider.estimateGas({
+            from: walletAddress,
+            to: walletAddress,
+            value: ethers.constants.Zero,
+        });
+
+        // 2) Fetch current gas price / max fee per gas.
+        const feeData = await this.provider.getFeeData();
+        let gasPrice =
+            feeData.maxFeePerGas ??
+            feeData.gasPrice ??
+            ethers.utils.parseUnits('20', 'gwei'); // conservative fallback
+
+        // 3) How many txs do we want to cover?
+        //    Default: 2 (deposit + one extra action such as stake or small follow-up).
+        const txCount = options?.txCount ?? 2;
+
+        // We also assume that contract interactions are more expensive than a simple transfer.
+        // Use a multiplier (e.g., 5x) on baseGas to approximate a more complex tx.
+        const COMPLEX_TX_MULTIPLIER = 5; // tuning knob
+        const totalGasUnits = baseGas
+            .mul(COMPLEX_TX_MULTIPLIER)
+            .mul(txCount);
+
+        const baseCost = totalGasUnits.mul(gasPrice);
+
+        // 4) Safety multiplier on top of that (e.g. 1.5x).
+        const safetyMultiplier = options?.safetyMultiplier ?? 1.5;
+        const safetyScaled = Math.round(safetyMultiplier * 100); // e.g. 150
+
+        const bufferedCost = baseCost
+            .mul(safetyScaled)
+            .div(100); // apply safety factor
+
+        let bufferWei = bufferedCost.toBigInt();
+
+        // 5) Enforce a minimum floor (e.g. ~0.002 ETH).
+        const defaultMinBufferWei = BigInt(2_000_000_000_000_000); // 0.002 ETH
+        const minBufferWei = options?.minBufferWei ?? defaultMinBufferWei;
+
+        if (bufferWei < minBufferWei) {
+            bufferWei = minBufferWei;
+        }
+
+        return bufferWei;
+    }
+
     // ---------------------------------------------------------------------
     // Internal ETH Staking client helper functions
     // ---------------------------------------------------------------------

package/src/networks/ethereum/utils.ts

@@ -157,7 +157,7 @@ export function buildEthereumTrancheLadder(options: {
     currentTrancheSupply: bigint;
     currentPriceUsd: bigint;
     supplyGrowthBps: number;
-    priceIncrementUsd: number;
+    priceGrowthCents: number;
     windowBefore?: number;
     windowAfter?: number;
 }): TrancheLadderItem[] {
@@ -167,7 +167,7 @@ export function buildEthereumTrancheLadder(options: {
         currentTrancheSupply,
         currentPriceUsd,
         supplyGrowthBps,
-        priceIncrementUsd,
+        priceGrowthCents,
         windowBefore = 5,
         windowAfter = 5,
     } = options;
@@ -190,7 +190,7 @@ export function buildEthereumTrancheLadder(options: {
         const prevCap = capacity.get(id - 1)!;
         const prevPrice = price.get(id - 1)!;
         capacity.set(id, growOnce(prevCap, supplyGrowthBps));
-        price.set(id, growOnce(prevPrice, priceIncrementUsd));
+        price.set(id, growOnce(prevPrice, priceGrowthCents));
     }
 
     // Backward (past tranches)
@@ -198,7 +198,7 @@ export function buildEthereumTrancheLadder(options: {
         const nextCap = capacity.get(id + 1)!;
         const nextPrice = price.get(id + 1)!;
         capacity.set(id, shrinkOnce(nextCap, supplyGrowthBps));
-        price.set(id, shrinkOnce(nextPrice, priceIncrementUsd));
+        price.set(id, shrinkOnce(nextPrice, priceGrowthCents));
     }
 
     const ladder: TrancheLadderItem[] = [];
@@ -240,7 +240,7 @@ export async function buildEthereumTrancheSnapshot(options: {
     totalTrancheSupply;
     initialTrancheSupply;
     supplyGrowthBps;
-    priceIncrementUsd;
+    priceGrowthCents;
     minPriceUsd;
     maxPriceUsd;
 
@@ -264,7 +264,7 @@ export async function buildEthereumTrancheSnapshot(options: {
         totalTrancheSupply,
         initialTrancheSupply,
         supplyGrowthBps,
-        priceIncrementUsd,
+        priceGrowthCents,
         minPriceUsd, 
         maxPriceUsd,
     } = options;
@@ -284,7 +284,7 @@ export async function buildEthereumTrancheSnapshot(options: {
         currentTrancheSupply,
         currentPriceUsd,
         supplyGrowthBps,
-        priceIncrementUsd,
+        priceGrowthCents,
         windowBefore: ladderWindowBefore,
         windowAfter: ladderWindowAfter,
     });
@@ -297,7 +297,7 @@ export async function buildEthereumTrancheSnapshot(options: {
         currentTranche,
         currentPriceUsd,
         supplyGrowthBps,
-        priceIncrementUsd,
+        priceGrowthCents,
         currentTrancheSupply,
         initialTrancheSupply,
         totalPretokensSold: totalTrancheSupply,

package/src/networks/solana/clients/deposit.client.ts

@@ -42,7 +42,7 @@ import {
     deriveLiqReceiptDataPda,
     deriveGlobalConfigPda,
 } from '../constants';
-import { WalletLike } from '../types';
+import { GlobalAccount, WalletLike } from '../types';
 
 export class DepositClient {
     private program: Program<LiqsolCore>;
@@ -192,23 +192,41 @@ export class DepositClient {
         );
 
         // Distribution / balance-tracking
-        // user_record is keyed by the user’s liqSOL ATA (same convention as deposit/purchase)
+        // user_record is keyed by the user’s liqSOL ATA (same convention
+        // as deposit/purchase).
         const userRecord = deriveUserRecordPda(userAta);
         const distributionState = deriveDistributionStatePda();
 
         // Reserve + stake controller PDAs
-        const global = deriveWithdrawGlobalPda();
+        const global = deriveWithdrawGlobalPda();          // withdraw operator state
         const reservePool = deriveReservePoolPda();
         const stakeAllocationState = deriveStakeAllocationStatePda();
         const stakeMetrics = deriveStakeMetricsPda();
         const maintenanceLedger = deriveMaintenanceLedgerPda();
-        const globalConfig = deriveGlobalConfigPda();
+        const globalConfig = deriveGlobalConfigPda();      // liqSOL config / roles
 
         // -------------------------------------------------------------
         // Need nextReceiptId from withdraw global state
         // -------------------------------------------------------------
-        const globalState = await this.program.account.global.fetch(global);
-        const receiptId = (globalState.nextReceiptId as BN).toBigInt();
+        const globalAcct : GlobalAccount = await this.program.account.global.fetch(global);
+
+        const rawId = globalAcct.nextReceiptId;
+        let receiptId: bigint;
+
+        if (typeof rawId === 'bigint') {
+            // New-style IDL / accounts returning bigint directly
+            receiptId = rawId;
+        } else if (rawId != null && typeof rawId === 'object' && 'toString' in rawId) {
+            // Anchor BN / bn.js or similar – normalize through string
+            receiptId = BigInt(rawId.toString());
+        } else if (typeof rawId === 'number') {
+            // Just in case someone typed it as a JS number in tests
+            receiptId = BigInt(rawId);
+        } else {
+            throw new Error(
+                `DepositClient.buildWithdrawTx: unexpected nextReceiptId type (${typeof rawId})`,
+            );
+        }
 
         // -------------------------------------------------------------
         // NFT receipt PDAs (mint, metadata, data, ATA)
@@ -265,7 +283,7 @@ export class DepositClient {
                 associatedTokenProgram: ASSOCIATED_TOKEN_PROGRAM_ID,
                 systemProgram: SystemProgram.programId,
                 rent: SYSVAR_RENT_PUBKEY,
-                globalConfig
+                globalConfig,
             })
             .instruction();
 

package/src/networks/solana/clients/distribution.client.ts

@@ -10,8 +10,9 @@ import {
     derivePayRateHistoryPda,
     deriveUserRecordPda,
 } from '../constants';
-import type { DistributionState, DistributionUserRecord, GlobalConfig, PayRateHistory } from '../types';
+import type { DistributionState, DistributionUserRecord, GlobalConfig, PayRateEntry, PayRateHistory } from '../types';
 import { getAssociatedTokenAddressSync, TOKEN_2022_PROGRAM_ID } from '@solana/spl-token';
+import { ceilDiv } from '../utils';
 
 /**
  * Distribution client – wraps the distribution portion of the liqsol_core
@@ -165,4 +166,86 @@ export class DistributionClient {
 
         return { shares: userShares, totalShares, ratio };
     }
+
+    /**
+     * Compute an average scaled pay rate over the most recent `windowSize`
+     * valid entries in the pay-rate history circular buffer.
+     *
+     * Returns a BN scaled by 1e12 (same as on-chain).
+     */
+    async getAverageScaledPayRate(windowSize = 5): Promise<BN> {
+        const history = await this.getPayRateHistory();
+        if (!history) {
+            return new BN(0);
+        }
+
+        const entries: PayRateEntry[] = history.entries ?? [];
+        if (!entries.length) {
+            return new BN(0);
+        }
+
+        const maxEntries: number =
+            typeof history.maxEntries === 'number'
+                ? history.maxEntries
+                : entries.length;
+
+        const rawTotalAdded: any = history.totalEntriesAdded ?? 0;
+        const totalAddedBn = new BN(rawTotalAdded.toString());
+
+        // No valid entries written yet
+        if (totalAddedBn.isZero()) {
+            return new BN(0);
+        }
+
+        const totalAdded = Math.min(
+            totalAddedBn.toNumber(),
+            maxEntries,
+            entries.length,
+        );
+
+        if (!totalAdded) {
+            return new BN(0);
+        }
+
+        const COUNT = Math.max(1, Math.min(windowSize, totalAdded));
+
+        const currentIndexNum = Number(history.currentIndex ?? 0);
+
+        // Most recently written entry is at currentIndex - 1 (mod maxEntries)
+        let idx =
+            currentIndexNum === 0
+                ? maxEntries - 1
+                : currentIndexNum - 1;
+
+        let sum = new BN(0);
+        let valid = 0;
+        const zero = new BN(0);
+
+        for (let i = 0; i < COUNT; i++) {
+            const entry: any = entries[idx];
+            if (entry) {
+                // Support both camelCase and snake_case (for safety)
+                const rawScaled =
+                    entry.scaledRate ??
+                    entry.scaled_rate ??
+                    0;
+
+                const rate = new BN(rawScaled.toString());
+                if (rate.gt(zero)) {
+                    sum = sum.add(rate);
+                    valid += 1;
+                }
+            }
+
+            // Walk backwards through the circular buffer
+            idx = idx === 0 ? maxEntries - 1 : idx - 1;
+        }
+
+        if (!valid) {
+            return new BN(0);
+        }
+
+        // Same behavior as the dashboard: use a ceiling-like average
+        return ceilDiv(sum, new BN(valid));
+    }
 }

package/src/networks/solana/clients/outpost.client.ts

@@ -100,34 +100,40 @@ export class OutpostClient {
 
         const pdas = await this.buildAccounts(userPk);
 
-        const [
-            globalState,
-            outpostAccount,
-            distributionState,
-            userPretokenRecord,
-            trancheState,
-        ] = await Promise.all([
-            this.program.account.globalState.fetch(pdas.globalState),
-            this.program.account.outpostAccount.fetchNullable(pdas.outpostAccount),
-            this.program.account.distributionState.fetchNullable(pdas.distributionState),
-            this.program.account.userPretokenRecord.fetchNullable(pdas.userPretokenRecord),
-            this.program.account.trancheState.fetchNullable(pdas.trancheState),
-        ]);
-
-        const [liqsolPoolBalance, userLiqsolBalance] = await Promise.all([
-            this.getTokenBalance(pdas.liqsolPoolAta),
-            this.getTokenBalance(pdas.userAta),
-        ]);
-
-        return {
-            globalState,
-            outpostAccount,
-            distributionState,
-            trancheState,
-            userPretokenRecord,
-            liqsolPoolBalance,
-            userLiqsolBalance,
-        };
+        try {
+            const [
+                globalState,
+                outpostAccount,
+                distributionState,
+                userPretokenRecord,
+                trancheState,
+            ] = await Promise.all([
+                this.program.account.globalState.fetch(pdas.globalState),
+                this.program.account.outpostAccount.fetchNullable(pdas.outpostAccount),
+                this.program.account.distributionState.fetchNullable(pdas.distributionState),
+                this.program.account.userPretokenRecord.fetchNullable(pdas.userPretokenRecord),
+                this.program.account.trancheState.fetchNullable(pdas.trancheState),
+            ]);
+
+            const [liqsolPoolBalance, userLiqsolBalance] = await Promise.all([
+                this.getTokenBalance(pdas.liqsolPoolAta),
+                this.getTokenBalance(pdas.userAta),
+            ]);
+
+            return {
+                globalState,
+                outpostAccount,
+                distributionState,
+                trancheState,
+                userPretokenRecord,
+                liqsolPoolBalance,
+                userLiqsolBalance,
+            };
+        }
+        catch (err) {
+            console.error('Error fetching Outpost wire state:', err);
+            throw err;
+        }
     }
 
     // -------------------------------------------------------------------------

package/src/networks/solana/constants.ts

@@ -89,9 +89,6 @@ export const PDA_SEEDS = {
     MINT_METADATA: 'mint_metadata',
     LIQ_RECEIPT_DATA: 'liq_receipt_data',
     WITHDRAW_MINT: 'mint',
-
-
-
 } as const;
 
 // Global Config PDA