@wireio/stake 0.4.3 → 0.5.0

package/src/networks/solana/solana.ts

@@ -7,7 +7,7 @@ import {
     Transaction,
     TransactionSignature,
 } from '@solana/web3.js';
-import { AnchorProvider } from '@coral-xyz/anchor';
+import { AnchorProvider, BN } from '@coral-xyz/anchor';
 import { BaseSignerWalletAdapter } from '@solana/wallet-adapter-base';
 import {
     ASSOCIATED_TOKEN_PROGRAM_ID,
@@ -44,7 +44,7 @@ import {
 } from './constants';
 
 import { buildSolanaTrancheSnapshot } from './utils';
-import { SolanaTransaction } from './types';
+import { PayRateEntry, SolanaTransaction } from './types';
 
 const commitment: Commitment = 'confirmed';
 
@@ -479,11 +479,127 @@ export class SolanaStakingClient implements IStakingClient {
         return Promise.resolve(0);
     }
 
-    // Protocol fee charged for deposit from Native to LIQ
-    getDepositFee(amount: bigint): Promise<bigint> {
-        // Returning 1% for now, 
-        // TODO: fetch real fee from on-chain config
-        return Promise.resolve((amount * BigInt(1)) / BigInt(100));
+    // ---------------------------------------------
+    // Deposit fee calculation (SOL -> liqSOL)
+    // ---------------------------------------------
+
+    /**
+     * Estimate the protocol deposit fee in lamports for a given SOL amount,
+     * based on recent pay rates and globalConfig.depositFeeMultiplier.
+     *
+     * - amountLamports: deposit notional in lamports
+     * - windowSize: how many recent payRate entries to average (default 5)
+     *
+     * Returns 0n if payRateHistory or globalConfig is missing, or if
+     * there are no valid pay-rate entries yet.
+     */
+    async getDepositFee(
+        amountLamports: bigint,
+        windowSize = 5,
+    ): Promise<bigint> {
+        if (amountLamports <= BigInt(0)) {
+            return BigInt(0);
+        }
+
+        const [history, globalConfig] = await Promise.all([
+            this.distributionClient.getPayRateHistory(),
+            this.distributionClient.getGlobalConfig(),
+        ]);
+
+        if (!history || !globalConfig) {
+            return BigInt(0);
+        }
+
+        const entries = history.entries ?? [];
+        if (!entries.length) {
+            return BigInt(0);
+        }
+
+        const maxEntries =
+            typeof history.maxEntries === 'number'
+                ? history.maxEntries
+                : entries.length;
+
+        const totalEntriesAdded = new BN(
+            history.totalEntriesAdded.toString(),
+        );
+
+        const COUNT = Math.max(1, Math.min(windowSize, maxEntries, entries.length));
+
+        // ---------------------------------------------
+        // Walk the circular buffer from "most recent"
+        // back through COUNT entries, using the same
+        // logic as your coworker script.
+        // ---------------------------------------------
+
+        let avgPayRate = new BN(0);
+
+        if (COUNT > 0) {
+            let idx: number;
+
+            if (totalEntriesAdded.isZero()) {
+                // "Not wrapped yet" case
+                idx = 0;
+            } else if (history.currentIndex === 0) {
+                idx = maxEntries - 1;
+            } else {
+                idx = history.currentIndex - 1;
+            }
+
+            let sum = new BN(0);
+            let valid = 0;
+            const zero = new BN(0);
+
+            for (let i = 0; i < COUNT; i++) {
+                const entry: PayRateEntry | undefined = entries[idx];
+                if (entry) {
+                    const rate = new BN(entry.scaledRate.toString());
+                    if (rate.gt(zero)) {
+                        sum = sum.add(rate);
+                        valid += 1;
+                    }
+                }
+
+                // Same wrap logic as the coworker’s script:
+                if (totalEntriesAdded.isZero()) {
+                    // simple forward iteration if never wrapped
+                    idx = (idx + 1) % maxEntries;
+                } else {
+                    // walk backwards through the ring buffer
+                    idx = idx === 0 ? maxEntries - 1 : idx - 1;
+                }
+            }
+
+            if (valid > 0) {
+                avgPayRate = this.ceilDiv(sum, new BN(valid));
+            }
+        }
+
+        // If no valid pay-rate entries, no fee
+        if (avgPayRate.isZero()) {
+            return BigInt(0);
+        }
+
+        // depositFeeMultiplier may be BN or number depending on your type
+        const rawMultiplier: any = (globalConfig as any).depositFeeMultiplier;
+        const multiplier = new BN(
+            rawMultiplier?.toString?.() ?? rawMultiplier ?? 0,
+        );
+        if (multiplier.isZero()) {
+            return BigInt(0);
+        }
+
+        const amountBn = new BN(amountLamports.toString());
+
+        // 10^12 scale (matches scaledRate / index scale)
+        const SCALE = new BN('1000000000000');
+
+        const feeBn = this.ceilDiv(
+            avgPayRate.mul(multiplier).mul(amountBn),
+            SCALE,
+        );
+
+        return BigInt(feeBn.toString());
     }
 
     /**
@@ -623,4 +739,12 @@ export class SolanaStakingClient implements IStakingClient {
             );
         }
     }
+
+    private ceilDiv(n: BN, d: BN): BN {
+        if (d.isZero()) {
+            throw new Error('Division by zero in ceilDiv');
+        }
+        return n.add(d.subn(1)).div(d);
+    }
+
 }

package/src/networks/solana/types.ts

@@ -271,6 +271,135 @@ export type GlobalState = {
     bump: number;
 };
 
+
+/**
+ * IDL: `globalConfig`
+ *
+ * Zero-copy global config PDA.
+ * Authority is taken from StakeControllerState, not stored here.
+ */
+export type GlobalConfig = {
+    /** PDA bump */
+    bump: number;
+
+    /** 7-byte padding (unused) */
+    padding: number[]; // u8[7]
+
+    /** Minimum SOL amount a user can deposit (lamports, u64) */
+    minUserDeposit: BN;
+
+    /** Minimum SOL amount for an unstake/withdrawal request (lamports, u64) */
+    minUnstakeRequest: BN;
+
+    /** Minimum stake delta to trigger a stake rebalance order (lamports, u64) */
+    minRebalanceStakeDelta: BN;
+
+    /** Minimum unstake delta to trigger an unstake rebalance order (lamports, u64) */
+    minRebalanceUnstakeDelta: BN;
+
+    /** Minimum transient stake to include in effective stake calculations (lamports, u64) */
+    transientThreshold: BN;
+
+    /**
+     * Minimum slots that must have elapsed in the epoch before late epoch operations can execute (u64)
+     */
+    minLateEpochSlotGate: BN;
+
+    /** Reserved u64[2] */
+    reservedU64: BN[];
+
+    /**
+     * Epochs a validator must wait in the graveyard before it is booted.
+     * This begins after the last recorded state change (u16)
+     */
+    cooldownEpochs: number;
+
+    /**
+     * Multiplier for deposit fee calculation (u16).
+     * Typically: avg_pay_rate * expected_warmup_epochs
+     */
+    depositFeeMultiplier: number;
+
+    /**
+     * Minimum VPP score required to enter the active validator set,
+     * fallback when the validator set is very small (u16)
+     */
+    minVppEntry: number;
+
+    /**
+     * VPP score threshold below which a validator is removed from active set,
+     * fallback threshold (u16)
+     */
+    minVppExit: number;
+
+    /**
+     * Max validators for "tiny" network band (uses fixed VPP thresholds) (u16)
+     */
+    tinyNetworkThreshold: number;
+
+    /**
+     * Max validators for "small" network band (uses percentile-based selection) (u16)
+     */
+    smallNetworkThreshold: number;
+
+    /**
+     * Max validators for "medium" network band (uses percentile-based selection) (u16)
+     */
+    mediumNetworkThreshold: number;
+
+    /**
+     * Fixed rank threshold to enter active set in large networks (0-indexed, u16)
+     */
+    largeNetworkEntryRank: number;
+
+    /**
+     * Fixed rank threshold to exit active set in large networks (0-indexed, u16)
+     */
+    largeNetworkExitRank: number;
+
+    /** Reserved u16[3] */
+    reservedU16: number[];
+
+    /**
+     * Percentile rank required to enter active set in small networks (u8)
+     */
+    smallNetworkEntryPercent: number;
+
+    /**
+     * Percentile rank below which validators exit in small networks (u8)
+     */
+    smallNetworkExitPercent: number;
+
+    /**
+     * Percentile rank required to enter active set in medium networks (u8)
+     */
+    mediumNetworkEntryPercent: number;
+
+    /**
+     * Percentile rank below which validators exit in medium networks (u8)
+     */
+    mediumNetworkExitPercent: number;
+
+    /** Reserved u8[2] */
+    reservedU8: number[];
+
+    /**
+     * Feature flags (u16 bitfield):
+     *  Bit 0: DepositsEnabled
+     *  Bit 1: WithdrawalsEnabled
+     *  Bit 2: ClaimWithdrawalsEnabled
+     *  Bit 3: ProcessStakeOrdersEnabled
+     *  Bit 4: ProcessUnstakeOrdersEnabled
+     *  Bit 5: ProcessPayCycleEnabled
+     *  Bit 6: RebalancingEnabled
+     *  Bits 7–15: Reserved
+     */
+    featureFlags: number;
+
+    /** Reserved flags (u16[1]) */
+    reservedFlags: number[];
+};
+
 /**
  * ============================================================
  *  Outpost / Pretoken Accounts

package/src/types.ts

@@ -26,7 +26,11 @@ export interface IStakingClient {
     // Estimated total APY for staking yeild
     getSystemAPY(): Promise<number>;
 
-    // Protocol fee charged for deposit from Native to LIQ
+    /**
+     * Protocol fee charged for deposit from Native to LIQ
+     * in Solana: amount in lamports
+     * in Ethereum: amount in wei
+     */
     getDepositFee(amount: bigint): Promise<bigint>;
 
     /**
@@ -210,7 +214,7 @@ export interface TrancheSnapshot {
     /** Tranche curve config (per-chain) */
     // TODO make a constant?
     supplyGrowthBps: number; // e.g. 100 = +1% per tranche
-    priceGrowthBps: number;  // e.g. 200 = +2% per tranche
+    priceIncrementUsd: number;  // e.g. 200 = +2% per tranche
 
     totalPretokensSold: bigint;  // total pretokens sold across all tranches (1e8 scale)
 

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/BeaconRoots.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/b5e46b2b97b85c57c7cd2a26cf972153.json"
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/BeaconRoots.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "BeaconRoots",
-  "sourceName": "contracts/liqEth/ValidatorBalanceVerifier.sol",
-  "abi": [],
-  "bytecode": "0x60808060405234601757603a9081601d823930815050f35b600080fdfe600080fdfea26469706673582212205929e6d47abd57360b3b4a693fd02ffc914ee421946709f79543eb45d9d83cf464736f6c63430008190033",
-  "deployedBytecode": "0x600080fdfea26469706673582212205929e6d47abd57360b3b4a693fd02ffc914ee421946709f79543eb45d9d83cf464736f6c63430008190033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/SSZ.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/b5e46b2b97b85c57c7cd2a26cf972153.json"
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/SSZ.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "SSZ",
-  "sourceName": "contracts/liqEth/ValidatorBalanceVerifier.sol",
-  "abi": [],
-  "bytecode": "0x60808060405234601757603a9081601d823930815050f35b600080fdfe600080fdfea26469706673582212208e86ba8a0ca879e7aaa6715b41e1830cf4b6301e2c95453171a9c2f0e1487d9464736f6c63430008190033",
-  "deployedBytecode": "0x600080fdfea26469706673582212208e86ba8a0ca879e7aaa6715b41e1830cf4b6301e2c95453171a9c2f0e1487d9464736f6c63430008190033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/SSZExtras.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/b5e46b2b97b85c57c7cd2a26cf972153.json"
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/SSZExtras.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "SSZExtras",
-  "sourceName": "contracts/liqEth/ValidatorBalanceVerifier.sol",
-  "abi": [],
-  "bytecode": "0x60808060405234601757603a9081601d823930815050f35b600080fdfe600080fdfea26469706673582212206bffbfe494c06c048356d1409faeae745422d98713ff3b960f4da6ba1bdd203364736f6c63430008190033",
-  "deployedBytecode": "0x600080fdfea26469706673582212206bffbfe494c06c048356d1409faeae745422d98713ff3b960f4da6ba1bdd203364736f6c63430008190033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/SSZVec48.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/b5e46b2b97b85c57c7cd2a26cf972153.json"
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/SSZVec48.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "SSZVec48",
-  "sourceName": "contracts/liqEth/ValidatorBalanceVerifier.sol",
-  "abi": [],
-  "bytecode": "0x60808060405234601757603a9081601d823930815050f35b600080fdfe600080fdfea264697066735822122024a0384f9481f6f7a712a90218373b99bd388332bb381d7c3078087bbdf6bb3c64736f6c63430008190033",
-  "deployedBytecode": "0x600080fdfea264697066735822122024a0384f9481f6f7a712a90218373b99bd388332bb381d7c3078087bbdf6bb3c64736f6c63430008190033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/liqEth/ValidatorBalanceVerifier.sol/ValidatorBalanceVerifier.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/b5e46b2b97b85c57c7cd2a26cf972153.json"
-}