@wireio/stake 0.4.3 → 0.5.0

package/lib/stake.d.ts

@@ -25,6 +25,11 @@ interface IStakingClient {
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio>;
     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.
@@ -181,7 +186,7 @@ interface TrancheSnapshot {
     currentPriceUsd: bigint;
     /** Tranche curve config (per-chain) */
     supplyGrowthBps: number;
-    priceGrowthBps: number;
+    priceIncrementUsd: number;
     totalPretokensSold: bigint;
     /** Current tranche supply state (1e8 scale) */
     currentTrancheSupply: bigint;
@@ -248,7 +253,7 @@ declare class Staker {
     setChain(chainID: ChainID): boolean;
 }
 
-declare const CONTRACT_NAMES: readonly ["Accounting", "DepositManager", "LiqEth", "StakingModule", "WithdrawalQueue", "WithdrawalVault", "Depositor", "ReceiptNFT", "OutpostManager", "BAR", "OPP", "OPPCommon", "OPPInbound", "Pretoken", "Aggregator", "EthUsdPriceConsumer", "Pool"];
+declare const CONTRACT_NAMES: readonly ["LiqEthAuthority", "BeaconState", "WithdrawalQueue", "LiqEthToken", "Accounting", "DepositManager", "WithdrawalVault", "StakingModule", "YieldOracle", "OutpostManagerAuthority", "iodata", "Base58", "sysio_merkle", "ReceiptNFT", "MockAggregator", "Pool", "OutpostManager", "sysio_write", "EthUsdPriceConsumer", "BAR", "OPPCommon", "OPP", "Pretoken", "OPPInbound", "Depositor"];
 type ContractName = typeof CONTRACT_NAMES[number];
 type AddressBook = Record<ContractName, string>;
 interface Result {
@@ -344,23 +349,31 @@ declare class EthereumStakingClient implements IStakingClient {
     private oppClient;
     private receiptClient;
     get contract(): {
+        LiqEthAuthority: ethers.Contract;
+        BeaconState: ethers.Contract;
+        WithdrawalQueue: ethers.Contract;
+        LiqEthToken: ethers.Contract;
         Accounting: ethers.Contract;
         DepositManager: ethers.Contract;
-        LiqEth: ethers.Contract;
-        StakingModule: ethers.Contract;
-        WithdrawalQueue: ethers.Contract;
         WithdrawalVault: ethers.Contract;
-        Depositor: ethers.Contract;
+        StakingModule: ethers.Contract;
+        YieldOracle: ethers.Contract;
+        OutpostManagerAuthority: ethers.Contract;
+        iodata: ethers.Contract;
+        Base58: ethers.Contract;
+        sysio_merkle: ethers.Contract;
         ReceiptNFT: ethers.Contract;
+        MockAggregator: ethers.Contract;
+        Pool: ethers.Contract;
         OutpostManager: ethers.Contract;
+        sysio_write: ethers.Contract;
+        EthUsdPriceConsumer: ethers.Contract;
         BAR: ethers.Contract;
-        OPP: ethers.Contract;
         OPPCommon: ethers.Contract;
-        OPPInbound: ethers.Contract;
+        OPP: ethers.Contract;
         Pretoken: ethers.Contract;
-        Aggregator: ethers.Contract;
-        EthUsdPriceConsumer: ethers.Contract;
-        Pool: ethers.Contract;
+        OPPInbound: ethers.Contract;
+        Depositor: ethers.Contract;
     };
     get network(): _wireio_core.ExternalNetwork;
     constructor(config: StakerConfig);
@@ -425,6 +438,12 @@ declare class EthereumStakingClient implements IStakingClient {
     private updateMockAggregatorPrice;
 }
 
+/**
+ * @module EthereumContractService
+ *
+ * Provides a unified service for interacting with Ethereum smart contracts using ethers.js.
+ */
+
 declare const ERC20Abi: ({
     inputs: {
         internalType: string;
@@ -825,6 +844,108 @@ type GlobalState = {
     /** PDA bump */
     bump: number;
 };
+/**
+ * IDL: `globalConfig`
+ *
+ * Zero-copy global config PDA.
+ * Authority is taken from StakeControllerState, not stored here.
+ */
+type GlobalConfig = {
+    /** PDA bump */
+    bump: number;
+    /** 7-byte padding (unused) */
+    padding: number[];
+    /** 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
@@ -1099,6 +1220,7 @@ type ValidatorRecord = {
 type types_DistributionState = DistributionState;
 type types_DistributionUserRecord = DistributionUserRecord;
 type types_Global = Global;
+type types_GlobalConfig = GlobalConfig;
 type types_GlobalState = GlobalState;
 type types_LeaderboardState = LeaderboardState;
 type types_OutpostAccount = OutpostAccount;
@@ -1119,7 +1241,7 @@ type types_WalletLike = WalletLike;
 type types_WireReceipt = WireReceipt;
 type types_WireState = WireState;
 declare namespace types {
-  export type { types_DistributionState as DistributionState, types_DistributionUserRecord as DistributionUserRecord, types_Global as Global, types_GlobalState as GlobalState, types_LeaderboardState as LeaderboardState, types_OutpostAccount as OutpostAccount, types_OutpostWireStateSnapshot as OutpostWireStateSnapshot, types_ParsedAccountInfo as ParsedAccountInfo, types_PayRateEntry as PayRateEntry, types_PayRateHistory as PayRateHistory, types_PriceHistory as PriceHistory, types_Role as Role, types_SharesPreview as SharesPreview, types_SolanaTransaction as SolanaTransaction, types_TrancheState as TrancheState, types_UserPretokenRecord as UserPretokenRecord, types_ValidatorRecord as ValidatorRecord, types_ValidatorReputation as ValidatorReputation, types_ValidatorState as ValidatorState, types_WalletLike as WalletLike, types_WireReceipt as WireReceipt, types_WireState as WireState };
+  export type { types_DistributionState as DistributionState, types_DistributionUserRecord as DistributionUserRecord, types_Global as Global, types_GlobalConfig as GlobalConfig, types_GlobalState as GlobalState, types_LeaderboardState as LeaderboardState, types_OutpostAccount as OutpostAccount, types_OutpostWireStateSnapshot as OutpostWireStateSnapshot, types_ParsedAccountInfo as ParsedAccountInfo, types_PayRateEntry as PayRateEntry, types_PayRateHistory as PayRateHistory, types_PriceHistory as PriceHistory, types_Role as Role, types_SharesPreview as SharesPreview, types_SolanaTransaction as SolanaTransaction, types_TrancheState as TrancheState, types_UserPretokenRecord as UserPretokenRecord, types_ValidatorRecord as ValidatorRecord, types_ValidatorReputation as ValidatorReputation, types_ValidatorState as ValidatorState, types_WalletLike as WalletLike, types_WireReceipt as WireReceipt, types_WireState as WireState };
 }
 
 declare class DepositClient {
@@ -1173,6 +1295,18 @@ declare class DistributionClient {
      * IDL account name: "distributionState"
      */
     getDistributionState(): Promise<DistributionState | null>;
+    /**
+     * Fetch the global payRateHistory account (circular buffer of scaled pay rates).
+     *
+     * IDL account name: "payRateHistory"
+     */
+    getPayRateHistory(): Promise<PayRateHistory | null>;
+    /**
+     * Fetch the globalConfig account (contains depositFeeMultiplier, etc).
+     *
+     * IDL account name: "globalConfig"
+     */
+    getGlobalConfig(): Promise<GlobalConfig | null>;
     /**
      * Fetch a user's distribution userRecord (or null if missing).
      *
@@ -8057,7 +8191,17 @@ declare class SolanaStakingClient implements IStakingClient {
      */
     getUserRecord(): Promise<DistributionUserRecord | null>;
     getSystemAPY(): Promise<number>;
-    getDepositFee(amount: bigint): Promise<bigint>;
+    /**
+     * 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.
+     */
+    getDepositFee(amountLamports: bigint, windowSize?: number): Promise<bigint>;
     /**
      * Unified, chain-agnostic tranche snapshot for Solana.
      *
@@ -8101,6 +8245,7 @@ declare class SolanaStakingClient implements IStakingClient {
      * Ensures we have a Wire pubKey and an Anchor wallet pubKey, and that they match.
      */
     ensureUser(): void;
+    private ceilDiv;
 }
 
 /**