@wireio/stake 0.5.1 → 0.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wireio/stake",
-    "version": "0.5.1",
+    "version": "0.5.2",
     "description": "LIQ Staking Module for Wire Network",
     "homepage": "https://gitea.gitgo.app/Wire/sdk-stake",
     "license": "FSL-1.1-Apache-2.0",

package/src/networks/solana/solana.ts

@@ -3,6 +3,7 @@ import {
     ComputeBudgetProgram,
     Connection,
     ConnectionConfig,
+    PerfSample,
     PublicKey as SolPubKey,
     SystemProgram,
     Transaction,
@@ -40,8 +41,10 @@ import { TokenClient } from './clients/token.client';
 import {
     deriveLiqsolMintPda,
     deriveReservePoolPda,
+    deriveStakeMetricsPda,
     deriveVaultPda,
     INDEX_SCALE,
+    PAY_RATE_SCALE_FACTOR,
 } from './constants';
 
 import { buildSolanaTrancheSnapshot, ceilDiv } from './utils';
@@ -73,6 +76,7 @@ export class SolanaStakingClient implements IStakingClient {
     public leaderboardClient: LeaderboardClient;
     public outpostClient: OutpostClient;
     public tokenClient: TokenClient;
+    public program: SolanaProgramService
 
     get solPubKey(): SolPubKey {
         if (!this.pubKey) throw new Error('pubKey is undefined');
@@ -186,6 +190,7 @@ export class SolanaStakingClient implements IStakingClient {
         this.leaderboardClient = new LeaderboardClient(this.anchor);
         this.outpostClient = new OutpostClient(this.anchor);
         this.tokenClient = new TokenClient(this.anchor);
+        this.program = new SolanaProgramService(this.anchor);
     }
 
     // ---------------------------------------------------------------------
@@ -477,27 +482,114 @@ export class SolanaStakingClient implements IStakingClient {
     // READ-ONLY Public Methods
     // ---------------------------------------------------------------------
 
-    // Estimated total APY for staking yield (percent, e.g. 7.23)
+    /**
+     * Returns the system APY (percent) for Solana,
+     * using compound interest per epoch and a
+     * cluster-derived epochs-per-year.
+     */
     async getSystemAPY(): Promise<number> {
-        // Reuse same window as the dashboard (5 most recent valid entries)
-        const avgPayRate = await this.distributionClient.getAverageScaledPayRate(5);
+        // 1) Per-epoch rate (decimal) from on-chain stakeMetrics
+        const ratePerEpoch = await this.getEpochRateDecimalFromProgram();
+        console.log('epochRateDecimal', ratePerEpoch);
 
-        if (avgPayRate.isZero()) {
-            return 0;
-        }
+        // 2) Live epochs-per-year estimate from cluster
+        const epochsPerYear = await this.getEpochsPerYearFromCluster();
+        console.log('epochsPerYear', epochsPerYear);
 
-        // 10^12, same scale used on-chain and in the dashboard
-        const SCALE = new BN('1000000000000');
-        const EPOCHS_PER_YEAR = 365; // matches DEFAULT_PAY_RATE semantics
+        // 3) Compound: (1 + r)^N - 1
+        const apyDecimal = Math.pow(1 + ratePerEpoch, epochsPerYear) - 1;
+        console.log('apyDecimal', apyDecimal);
 
-        // Safe: pay rate is well below 1e12, so .toNumber() won't overflow
-        const ratePerPeriod = avgPayRate.toNumber() / SCALE.toNumber(); // e.g. 0.0001917…
-        const apyDecimal = ratePerPeriod * EPOCHS_PER_YEAR;             // e.g. ~0.07
-        const apyPercent = apyDecimal * 100;                            // e.g. 7
+        // 4) Convert to percent
+        const apyPercent = apyDecimal * 100;
+        console.log('apyPercent', apyPercent);
 
         return apyPercent;
     }
 
+    /**
+     * Reads the liqsol_core stakeMetrics account and returns the
+     * Solana per-epoch system rate as a **decimal** (not BPS),
+     * de-scaled using PAY_RATE_SCALE_FACTOR (1e12).
+     */
+    private async getEpochRateDecimalFromProgram(): Promise<number> {
+        const liqSolCoreProgram = this.program.getProgram('liqsolCore');
+        const stakeMetricsPda = deriveStakeMetricsPda();
+        const stakeMetrics =
+            await liqSolCoreProgram.account.stakeMetrics.fetch(stakeMetricsPda);
+
+        // solSystemPayRate is stored on-chain with PAY_RATE_SCALE_FACTOR (1e12)
+        const raw = BigInt(stakeMetrics.solSystemPayRate.toString());
+
+        // Convert to JS number in **decimal per epoch** units
+        const rateDecimal = Number(raw) / Number(PAY_RATE_SCALE_FACTOR);
+
+        console.log('solSystemPayRate(raw)', raw.toString());
+        console.log('epochRateDecimal(computed)', rateDecimal);
+
+        return rateDecimal;
+    }
+
+    // Simple cache so we don’t hammer RPC
+    private epochsPerYearCache?: { value: number; fetchedAt: number };
+    private static readonly EPOCHS_PER_YEAR_TTL_MS = 10 * 60 * 1000; // 10 minutes
+
+    /**
+     * Derive "epochs per year" from the live Solana cluster.
+     *
+     * Uses:
+     *  - getRecentPerformanceSamples() to estimate slots/second
+     *  - getEpochInfo() to read slotsInEpoch
+     */
+    private async getEpochsPerYearFromCluster(): Promise<number> {
+        const now = Date.now();
+
+        if (
+            this.epochsPerYearCache &&
+            now - this.epochsPerYearCache.fetchedAt <
+            SolanaStakingClient.EPOCHS_PER_YEAR_TTL_MS
+        ) {
+            return this.epochsPerYearCache.value;
+        }
+
+        const connection = this.anchor.connection;
+
+        // 1) Estimate slots/second from recent performance samples
+        const samples: PerfSample[] = await connection.getRecentPerformanceSamples(
+            60,
+        );
+        if (!samples.length) {
+            throw new Error('No performance samples available from cluster');
+        }
+
+        const totalSlots = samples.reduce((acc, s) => acc + s.numSlots, 0);
+        const totalSecs = samples.reduce((acc, s) => acc + s.samplePeriodSecs, 0);
+
+        if (totalSecs === 0) {
+            throw new Error(
+                'Cluster returned zero samplePeriodSecs in performance samples',
+            );
+        }
+
+        const slotsPerSecond = totalSlots / totalSecs;
+
+        // 2) Slots per epoch from cluster
+        const epochInfo = await connection.getEpochInfo(); // finalized commitment by default
+        const slotsPerEpoch = epochInfo.slotsInEpoch;
+
+        const secondsPerEpoch = slotsPerEpoch / slotsPerSecond;
+        const secondsPerYear = 365 * 24 * 60 * 60;
+
+        const epochsPerYear = secondsPerYear / secondsPerEpoch;
+
+        this.epochsPerYearCache = {
+            value: epochsPerYear,
+            fetchedAt: now,
+        };
+
+        return epochsPerYear;
+    }
+
     // ---------------------------------------------
     // Deposit fee calculation (SOL -> liqSOL)
     // ---------------------------------------------
@@ -520,7 +612,7 @@ export class SolanaStakingClient implements IStakingClient {
             return BigInt(0);
         }
 
-        const [avgPayRate, globalConfig] : [BN, GlobalConfig] = await Promise.all([
+        const [avgPayRate, globalConfig]: [BN, GlobalConfig] = await Promise.all([
             this.distributionClient.getAverageScaledPayRate(windowSize),
             this.distributionClient.getGlobalConfig(),
         ]);
@@ -756,4 +848,5 @@ export class SolanaStakingClient implements IStakingClient {
             );
         }
     }
+
 }

package/src/staker.ts

@@ -36,7 +36,7 @@ export class Staker {
 
         config.forEach((cfg) => {
             switch (cfg.network.chainId) {
-                case SolChainID.WireTestnet:
+                case SolChainID.Devnet:
                     this.clients.set(cfg.network.chainId, new SolanaStakingClient(cfg));
                     break;