@wireio/stake 0.4.0 → 0.4.2

package/lib/stake.d.ts

@@ -10,7 +10,7 @@ import { BN, AnchorProvider, Program } from '@coral-xyz/anchor';
 
 type StakerConfig = {
     network: ExternalNetwork;
-    provider: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
+    provider?: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
     pubKey?: PublicKey;
 };
 interface IStakingClient {
@@ -24,6 +24,8 @@ interface IStakingClient {
     buy(amount: bigint): Promise<string>;
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio>;
+    getSystemAPY(): Promise<number>;
+    getDepositFee(amount: bigint): Promise<bigint>;
     /**
      * Program-level prelaunch WIRE/tranche snapshot for this chain.
      *
@@ -192,6 +194,37 @@ interface TrancheSnapshot {
      */
     ladder: TrancheLadderItem[];
 }
+declare enum PurchaseAsset {
+    SOL = "SOL",
+    LIQSOL = "LIQSOL",
+    ETH = "ETH",
+    LIQETH = "LIQETH",
+    YIELD = "YIELD"
+}
+interface PurchaseQuote {
+    purchaseAsset: PurchaseAsset;
+    amountIn: bigint;
+    /** Expected pretoken “shares” (pretokens) and decimals */
+    wireShares: bigint;
+    wireDecimals: number;
+    /** Current price + notional in USD (1e8 scale) */
+    wirePriceUsd: bigint;
+    notionalUsd: bigint;
+}
+interface OPPAssertion {
+    type: 'liq_pretoken_purchase' | 'yield_pretoken_purchase' | 'pretoken_purchase' | 'stake' | 'unstake' | 'bonded_actor' | 'unbonded_actor' | 'unknown';
+    data: any;
+    chain: 'ETH' | 'SOL';
+    timestamp: number | null;
+    from: string | null;
+    to: string | null;
+    txHash: string;
+    raw: any;
+}
+declare enum ReceiptNFTKind {
+    STAKE = 0,
+    PRETOKEN_PURCHASE = 1
+}
 
 declare class Staker {
     selectedChainID?: ChainID;
@@ -213,7 +246,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"];
+declare const CONTRACT_NAMES: readonly ["Accounting", "DepositManager", "LiqEth", "StakingModule", "WithdrawalQueue", "WithdrawalVault", "Depositor", "ReceiptNFT", "OutpostManager", "BAR", "OPP", "OPPCommon", "OPPInbound", "Pretoken", "Aggregator", "EthUsdPriceConsumer", "Pool"];
 type ContractName = typeof CONTRACT_NAMES[number];
 type AddressBook = Record<ContractName, string>;
 interface Result {
@@ -299,14 +332,15 @@ declare namespace types$1 {
 
 declare class EthereumStakingClient implements IStakingClient {
     private config;
-    readonly pubKey?: PublicKey;
     private readonly provider;
-    private readonly signer;
+    readonly pubKey?: PublicKey;
+    private readonly signer?;
     private readonly contractService;
-    private depositClient;
-    private liqClient;
+    private convertClient;
     private pretokenClient;
     private stakeClient;
+    private oppClient;
+    private receiptClient;
     get contract(): {
         Accounting: ethers.Contract;
         DepositManager: ethers.Contract;
@@ -324,6 +358,7 @@ declare class EthereumStakingClient implements IStakingClient {
         Pretoken: ethers.Contract;
         Aggregator: ethers.Contract;
         EthUsdPriceConsumer: ethers.Contract;
+        Pool: ethers.Contract;
     };
     get network(): _wireio_core.ExternalNetwork;
     constructor(config: StakerConfig);
@@ -342,8 +377,7 @@ declare class EthereumStakingClient implements IStakingClient {
     withdraw(amount: bigint): Promise<string>;
     /**
      * Stake liqETH via DepositManager.
-     * @param amount  Amount in wei
-     *                Keep this as a bigint / string in the caller; avoid JS floats.
+     * @param amount  Amount in wei - Keep this as a bigint / string in the caller; avoid JS floats.
      * @returns transaction hash
      */
     stake(amount: bigint): Promise<string>;
@@ -356,14 +390,6 @@ declare class EthereumStakingClient implements IStakingClient {
      */
     unstakePrelaunch(tokenId: bigint, recipient: string): Promise<string>;
     buy(amount: bigint): Promise<string>;
-    getOPPStatus(): Promise<any>;
-    /**
-     * ETH Prelaunch function to list the ReceiptNFTs owned by a specific user
-     * @param address address to query the receipts for
-     * @returns array of receipts
-     */
-    fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]>;
-    getEthStats(): Promise<any>;
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -372,8 +398,22 @@ declare class EthereumStakingClient implements IStakingClient {
      * tracked = liqETH tracked balance (protocol/accounting view)
      */
     getPortfolio(): Promise<Portfolio>;
+    /**
+     * ETH Prelaunch function to list the Stake ReceiptNFTs owned by a specific user
+     * @param address address to query the receipts for
+     * @returns array of receipts
+     */
+    fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]>;
+    getOPPMessages(address?: string): Promise<OPPAssertion[]>;
+    private ensureUser;
+    getSystemAPY(): Promise<number>;
+    getDepositFee(amount: bigint): Promise<bigint>;
+    getOPPStatus(): Promise<any>;
+    getEthStats(): Promise<any>;
     /**
      * Program-level prelaunch WIRE / tranche snapshot for Ethereum
+     *
+     * SUPPORTS READ-ONLY ACcESS
      */
     getTrancheSnapshot(options?: {
         chainID?: ChainID;
@@ -7399,6 +7439,13 @@ declare class SolanaStakingClient implements IStakingClient {
      *  - extras: useful internal addresses and raw state for debugging/UX
      */
     getPortfolio(): Promise<Portfolio>;
+    /**
+     * Convenience helper to fetch the distribution userRecord for the current user.
+     * Used by balance-correction flows and debugging.
+     */
+    getUserRecord(): Promise<DistributionUserRecord | null>;
+    getSystemAPY(): Promise<number>;
+    getDepositFee(amount: bigint): Promise<bigint>;
     /**
      * Unified, chain-agnostic tranche snapshot for Solana.
      *
@@ -7414,11 +7461,6 @@ declare class SolanaStakingClient implements IStakingClient {
         windowBefore?: number;
         windowAfter?: number;
     }): Promise<TrancheSnapshot>;
-    /**
-     * Convenience helper to fetch the distribution userRecord for the current user.
-     * Used by balance-correction flows and debugging.
-     */
-    getUserRecord(): Promise<DistributionUserRecord | null>;
     /**
      * Send a signed transaction over HTTP RPC and wait for confirmation.
      * Throws if the transaction fails.
@@ -7446,7 +7488,7 @@ declare class SolanaStakingClient implements IStakingClient {
      * Guard for all write operations (deposit/withdraw/stake/unstake/buy).
      * Ensures we have a Wire pubKey and an Anchor wallet pubKey, and that they match.
      */
-    ensureWriteAccess(): void;
+    ensureUser(): void;
 }
 
 /**
@@ -7598,5 +7640,5 @@ declare const INDEX_SCALE: bigint;
 declare const lamportsToSol: (lamports: number | bigint) => number;
 declare const solToLamports: (sol: number) => bigint;
 
-export { ADDRESSES, CHAINLINK_FEED, CHAINLINK_PROGRAM, CONTRACTS, DEFAULT_AVERAGE_PAY_RATE, DEFAULT_PAY_RATE_LOOKBACK, DepositClient, DistributionClient, EPHEMERAL_RENT_EXEMPTION, ERC1155Abi, ERC20Abi, ERC721Abi, types$1 as ETH, EthereumContractService, EthereumStakingClient, INDEX_SCALE, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, types as SOL, SolanaStakingClient, Staker, TRANSFER_HOOK, TokenClient, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, calculateExpectedFee, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveExtraAccountMetaListPda, deriveLeaderboardStatePda, deriveLiqReceiptDataPda, deriveLiqsolMintAuthorityPda, deriveLiqsolMintPda, deriveMaintenanceLedgerPda, deriveOutpostAccountPda, deriveOutpostGlobalStatePda, deriveOutpostPoolAuthorityPda, derivePayRateHistoryPda, derivePayoutStatePda, derivePriceHistoryPda, deriveReservePoolPda, deriveStakeAllocationStatePda, deriveStakeControllerStatePda, deriveStakeControllerVaultPda, deriveStakeMetricsPda, deriveTrancheStatePda, deriveUserPretokenRecordPda, deriveUserRecordPda, deriveValidatorRecordPda, deriveVaultPda, deriveWithdrawGlobalPda, deriveWithdrawMintAuthorityPda, deriveWithdrawMintMetadataPda, deriveWithdrawNftMintPda, generateRandomDepositAmount, generateTestKeypair, getAveragePayRate, getBucketLiqSolBalance, getEpochSnapshot, getErrorMessage, getLiqsolCoreProgram, getPayoutStateRaw, getReservePoolBalance, getStakeControllerStateRaw, getUserLiqSolBalance, getUserRecordRaw, lamportsToSol, msToEpochEnd, previewDepositEffects, scheduledInstruction, sleep, solToLamports, toBigint, tokensToShares, waitForConfirmation, waitUntilSafeToExecuteFunction };
-export type { BalanceView, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OutpostAccounts, Portfolio, ScheduleConfig, StakerConfig, TrancheLadderItem, TrancheSnapshot, YieldView };
+export { ADDRESSES, CHAINLINK_FEED, CHAINLINK_PROGRAM, CONTRACTS, DEFAULT_AVERAGE_PAY_RATE, DEFAULT_PAY_RATE_LOOKBACK, DepositClient, DistributionClient, EPHEMERAL_RENT_EXEMPTION, ERC1155Abi, ERC20Abi, ERC721Abi, types$1 as ETH, EthereumContractService, EthereumStakingClient, INDEX_SCALE, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, PurchaseAsset, ReceiptNFTKind, types as SOL, SolanaStakingClient, Staker, TRANSFER_HOOK, TokenClient, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, calculateExpectedFee, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveExtraAccountMetaListPda, deriveLeaderboardStatePda, deriveLiqReceiptDataPda, deriveLiqsolMintAuthorityPda, deriveLiqsolMintPda, deriveMaintenanceLedgerPda, deriveOutpostAccountPda, deriveOutpostGlobalStatePda, deriveOutpostPoolAuthorityPda, derivePayRateHistoryPda, derivePayoutStatePda, derivePriceHistoryPda, deriveReservePoolPda, deriveStakeAllocationStatePda, deriveStakeControllerStatePda, deriveStakeControllerVaultPda, deriveStakeMetricsPda, deriveTrancheStatePda, deriveUserPretokenRecordPda, deriveUserRecordPda, deriveValidatorRecordPda, deriveVaultPda, deriveWithdrawGlobalPda, deriveWithdrawMintAuthorityPda, deriveWithdrawMintMetadataPda, deriveWithdrawNftMintPda, generateRandomDepositAmount, generateTestKeypair, getAveragePayRate, getBucketLiqSolBalance, getEpochSnapshot, getErrorMessage, getLiqsolCoreProgram, getPayoutStateRaw, getReservePoolBalance, getStakeControllerStateRaw, getUserLiqSolBalance, getUserRecordRaw, lamportsToSol, msToEpochEnd, previewDepositEffects, scheduledInstruction, sleep, solToLamports, toBigint, tokensToShares, waitForConfirmation, waitUntilSafeToExecuteFunction };
+export type { BalanceView, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OPPAssertion, OutpostAccounts, Portfolio, PurchaseQuote, ScheduleConfig, StakerConfig, TrancheLadderItem, TrancheSnapshot, YieldView };