@wireio/stake 0.2.4 → 0.3.0

package/lib/stake.d.ts

@@ -11,17 +11,17 @@ import { BN, AnchorProvider, Program } from '@coral-xyz/anchor';
 type StakerConfig = {
     network: ExternalNetwork;
     provider: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
-    pubKey: PublicKey;
+    pubKey?: PublicKey;
 };
 interface IStakingClient {
-    pubKey: PublicKey;
+    pubKey?: PublicKey;
     network: ExternalNetwork;
     /** Amount is in the chain's smallest unit (lamports/wei, etc.) */
     deposit(amount: bigint): Promise<string>;
     withdraw(amount: bigint): Promise<string>;
     stake(amount: bigint): Promise<string>;
     unstake(amount: bigint): Promise<string>;
-    buy(amount: bigint, asset: PurchaseAsset): Promise<string>;
+    buy(amount: bigint): Promise<string>;
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio>;
     /**
@@ -36,8 +36,6 @@ interface IStakingClient {
         windowBefore?: number;
         windowAfter?: number;
     }): Promise<TrancheSnapshot | null>;
-    /**  */
-    getBuyQuote(amount: bigint, asset: PurchaseAsset): Promise<PurchaseQuote>;
 }
 interface Portfolio {
     /** Native balance on chain: ETH, SOL */
@@ -46,7 +44,7 @@ interface Portfolio {
     liq: BalanceView;
     /** Outpost Staked balance */
     staked: BalanceView;
-    /** Prelaunch WIRE “shares” (warrants/pretokens) */
+    /** Prelaunch WIRE “shares” (pretokens) */
     wire: BalanceView;
     /** SOL ONLY!
      * Tracked liqSOL balance from distribution program */
@@ -74,6 +72,18 @@ interface TrancheLadderItem {
     /** Price for this tranche in USD (1e8 scale) */
     priceUsd: bigint;
 }
+interface TrancheLadderItem {
+    /** On-chain tranche id, 0-based (0,1,2,...) */
+    id: number;
+    /** Total capacity for this tranche (pretokens, 1e8 scale) */
+    capacity: bigint;
+    /** Sold amount in this tranche (1e8 scale) */
+    sold: bigint;
+    /** Remaining = capacity - sold (1e8 scale) */
+    remaining: bigint;
+    /** Price for this tranche in USD (1e8 scale) */
+    priceUsd: bigint;
+}
 /**
  * Unified pretoken/tranche snapshot for any chain.
  * ETH / other chains just fill the same shape from their own contracts.
@@ -88,16 +98,13 @@ interface TrancheSnapshot {
     currentTranche: number;
     /** Current tranche price in USD (1e8 scale) */
     currentPriceUsd: bigint;
-    /** Optional min/max bounds for price validation (1e8 scale) */
-    minPriceUsd?: bigint;
-    maxPriceUsd?: bigint;
     /** Tranche curve config (per-chain) */
     supplyGrowthBps: number;
     priceGrowthBps: number;
     /** Current tranche supply state (1e8 scale) */
     currentTrancheSupply: bigint;
     initialTrancheSupply: bigint;
-    totalWarrantsSold: bigint;
+    totalPretokensSold: bigint;
     /** Native token → USD price if available (SOL/USD, ETH/USD, etc, 1e8 scale) */
     nativePriceUsd?: bigint;
     /** Optional timestamp (sec) for the last recorded native price */
@@ -108,24 +115,6 @@ interface TrancheSnapshot {
      */
     ladder: TrancheLadderItem[];
 }
-/** Purchase asset selection used by staking client(s) */
-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;
-}
 
 declare class Staker {
     selectedChainID?: ChainID;
@@ -147,7 +136,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", "Warrant"];
+declare const CONTRACT_NAMES: readonly ["Accounting", "DepositManager", "LiqEth", "StakingModule", "WithdrawalQueue", "WithdrawalVault", "Depositor", "ReceiptNFT", "OutpostManager", "BAR", "OPP", "OPPCommon", "OPPInbound", "Pretoken", "Aggregator", "EthUsdPriceConsumer"];
 type ContractName = typeof CONTRACT_NAMES[number];
 type AddressBook = Record<ContractName, string>;
 interface Result {
@@ -195,6 +184,11 @@ interface WithdrawnStakeResult extends Result {
     /** Parsed WithdrawnStake event, if present */
     withdrawnstake?: WithdrawnStakeEvent;
 }
+interface SharesBurnedEvent {
+    from: string;
+    shares: BigNumber;
+    tokenValue: BigNumber;
+}
 interface preLaunchReceipt {
     tokenId: bigint;
     receipt: {
@@ -213,6 +207,7 @@ declare const types$1_CONTRACT_NAMES: typeof CONTRACT_NAMES;
 type types$1_ContractName = ContractName;
 type types$1_DepositEvent = DepositEvent;
 type types$1_DepositResult = DepositResult;
+type types$1_SharesBurnedEvent = SharesBurnedEvent;
 type types$1_StakedEvent = StakedEvent;
 type types$1_StakedResult = StakedResult;
 type types$1_WithdrawRequestedEvent = WithdrawRequestedEvent;
@@ -222,16 +217,18 @@ type types$1_WithdrawnStakeResult = WithdrawnStakeResult;
 type types$1_preLaunchReceipt = preLaunchReceipt;
 declare namespace types$1 {
   export { types$1_CONTRACT_NAMES as CONTRACT_NAMES };
-  export type { types$1_AddressBook as AddressBook, types$1_ContractName as ContractName, types$1_DepositEvent as DepositEvent, types$1_DepositResult as DepositResult, types$1_StakedEvent as StakedEvent, types$1_StakedResult as StakedResult, types$1_WithdrawRequestedEvent as WithdrawRequestedEvent, types$1_WithdrawResult as WithdrawResult, types$1_WithdrawnStakeEvent as WithdrawnStakeEvent, types$1_WithdrawnStakeResult as WithdrawnStakeResult, types$1_preLaunchReceipt as preLaunchReceipt };
+  export type { types$1_AddressBook as AddressBook, types$1_ContractName as ContractName, types$1_DepositEvent as DepositEvent, types$1_DepositResult as DepositResult, types$1_SharesBurnedEvent as SharesBurnedEvent, types$1_StakedEvent as StakedEvent, types$1_StakedResult as StakedResult, types$1_WithdrawRequestedEvent as WithdrawRequestedEvent, types$1_WithdrawResult as WithdrawResult, types$1_WithdrawnStakeEvent as WithdrawnStakeEvent, types$1_WithdrawnStakeResult as WithdrawnStakeResult, types$1_preLaunchReceipt as preLaunchReceipt };
 }
 
 declare class EthereumStakingClient implements IStakingClient {
     private config;
-    readonly pubKey: PublicKey;
+    readonly pubKey?: PublicKey;
     private readonly provider;
     private readonly signer;
     private readonly contractService;
     private depositClient;
+    private liqClient;
+    private pretokenClient;
     private stakeClient;
     get contract(): {
         Accounting: ethers.Contract;
@@ -247,7 +244,9 @@ declare class EthereumStakingClient implements IStakingClient {
         OPP: ethers.Contract;
         OPPCommon: ethers.Contract;
         OPPInbound: ethers.Contract;
-        Warrant: ethers.Contract;
+        Pretoken: ethers.Contract;
+        Aggregator: ethers.Contract;
+        EthUsdPriceConsumer: ethers.Contract;
     };
     get network(): _wireio_core.ExternalNetwork;
     constructor(config: StakerConfig);
@@ -258,14 +257,36 @@ declare class EthereumStakingClient implements IStakingClient {
      * @returns transaction hash
      */
     deposit(amount: number | string | bigint | BigNumber): Promise<string>;
-    withdraw(amount: number | string | bigint | BigNumber): Promise<string>;
+    /**
+     * Withdraw native ETH from the liqETH protocol via the liqeth safeBurn function, which burns the LiqETH and adds the user to the withdrawal queue.
+     * @param amount  Amount in wei (or something convertible to BigNumber).
+     * @returns transaction hash
+     */
+    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.
+     * @returns transaction hash
+     */
     stake(amount: bigint): Promise<string>;
     unstake(): Promise<string>;
+    /**
+     * ETH Prelaunch function to unstake liqEth
+     * @param tokenId ReceiptNFT tokenId for the owned NFT that will be burned
+     * @param recipient Address to receive the liqEth funds linked to the burned NFT
+     * @returns the transaction hash
+     */
     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>;
-    buy(amount: bigint, purchaseAsset: PurchaseAsset): Promise<string>;
-    getBuyQuote(amount: bigint, purchaseAsset: PurchaseAsset): Promise<PurchaseQuote>;
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -275,12 +296,14 @@ declare class EthereumStakingClient implements IStakingClient {
      */
     getPortfolio(): Promise<Portfolio>;
     /**
-     * Program-level prelaunch WIRE / tranche snapshot for Solana.
-     * Uses the same OutpostWireStateSnapshot primitive as getPortfolio().
-     * TODO! for eth
+     * Program-level prelaunch WIRE / tranche snapshot for Ethereum
      */
-    getTrancheSnapshot(): Promise<TrancheSnapshot | null>;
-    private requestWithdraw;
+    getTrancheSnapshot(options?: {
+        chainID?: ChainID;
+        windowBefore?: number;
+        windowAfter?: number;
+    }): Promise<TrancheSnapshot>;
+    private updateMockAggregatorPrice;
 }
 
 declare const ERC20Abi: ({
@@ -559,7 +582,7 @@ type GlobalState = {
 type UserWarrantRecord = {
     user: PublicKey$1;
     totalSolDeposited: BN;
-    totalWarrantsPurchased: BN;
+    totalPretokensPurchased: BN;
     lastTrancheNumber: BN;
     lastTranchePriceUsd: BN;
     bump: number;
@@ -569,7 +592,8 @@ type TrancheState = {
     currentTrancheNumber: BN;
     currentTrancheSupply: BN;
     currentTranchePriceUsd: BN;
-    totalWarrantsSold: BN;
+    totalPretokensSold?: BN;
+    totalWarrantsSold?: BN;
     initialTrancheSupply: BN;
     supplyGrowthBps: number;
     priceGrowthBps: number;
@@ -630,7 +654,7 @@ declare namespace types {
  */
 declare class SolanaStakingClient implements IStakingClient {
     private config;
-    pubKey: PublicKey;
+    pubKey?: PublicKey;
     connection: Connection;
     anchor: AnchorProvider;
     private depositClient;
@@ -670,7 +694,7 @@ declare class SolanaStakingClient implements IStakingClient {
      *
      * ETH / LIQETH are not valid on Solana.
      */
-    buy(amountLamports: bigint, purchaseAsset: PurchaseAsset): Promise<string>;
+    buy(amountLamports: bigint): Promise<string>;
     /**
      * Aggregate view of the user’s balances on Solana:
      *  - native: SOL wallet balance
@@ -692,25 +716,14 @@ declare class SolanaStakingClient implements IStakingClient {
      * windowBefore/windowAfter control how many ladder rows we precompute
      * around the current tranche for UI, but you can pass nothing if you
      * only need current tranche info.
+     *
+     * READ-ONLY allowed
      */
     getTrancheSnapshot(options?: {
         chainID?: ChainID;
         windowBefore?: number;
         windowAfter?: number;
     }): Promise<TrancheSnapshot>;
-    /**
-     * Approximate prelaunch WIRE quote for a given amount & asset.
-     *
-     * Uses TrancheSnapshot + SOL/USD price for:
-     *  - SOL: amount is lamports
-     *  - LIQSOL: amount is liqSOL base units (decimals = 9)
-     *  - YIELD: amount is treated as SOL lamports-equivalent of yield
-     *
-     * NOTE: On-chain rounding may differ slightly (this is UI-only).
-     */
-    getBuyQuote(amount: bigint, asset: PurchaseAsset, opts?: {
-        chainID?: ChainID;
-    }): Promise<PurchaseQuote>;
     /**
      * Convenience helper to fetch the distribution userRecord for the current user.
      * Used by balance-correction flows and debugging.
@@ -745,6 +758,7 @@ declare class SolanaStakingClient implements IStakingClient {
         blockhash: string;
         lastValidBlockHeight: number;
     }>;
+    ensureWriteAccess(): void;
 }
 
 /**
@@ -5310,7 +5324,7 @@ declare function buildSolanaTrancheLadder(options: {
     currentTranche: number;
     initialTrancheSupply: bigint;
     currentTrancheSupply: bigint;
-    totalWarrantsSold: bigint;
+    totalPretokensSold: bigint;
     currentPriceUsd: bigint;
     supplyGrowthBps: number;
     priceGrowthBps: number;
@@ -5677,5 +5691,5 @@ declare class TokenClient {
     getSolPriceUsd(): Promise<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, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, PurchaseAsset, types as SOL, SolanaStakingClient, Staker, TokenClient, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, calculateExpectedFee, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveLeaderboardStatePda, deriveLiqsolMintAuthorityPda, deriveLiqsolMintPda, deriveOutpostGlobalStatePda, deriveOutpostPoolAuthorityPda, derivePayRateHistoryPda, derivePayoutStatePda, derivePoolUserRecordPda, derivePriceHistoryPda, deriveReservePoolPda, deriveSolBucketPda, deriveStakeControllerStatePda, deriveStakeControllerVaultPda, deriveTrancheStatePda, deriveUserRecordPda, deriveUserUserRecordPda, deriveUserWarrantRecordPda, deriveValidatorRecordPda, deriveVaultPda, deriveWireReceiptPda, 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, PurchaseQuote, ScheduleConfig, StakerConfig, TrancheLadderItem, TrancheSnapshot };
+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, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, types as SOL, SolanaStakingClient, Staker, TokenClient, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, calculateExpectedFee, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveLeaderboardStatePda, deriveLiqsolMintAuthorityPda, deriveLiqsolMintPda, deriveOutpostGlobalStatePda, deriveOutpostPoolAuthorityPda, derivePayRateHistoryPda, derivePayoutStatePda, derivePoolUserRecordPda, derivePriceHistoryPda, deriveReservePoolPda, deriveSolBucketPda, deriveStakeControllerStatePda, deriveStakeControllerVaultPda, deriveTrancheStatePda, deriveUserRecordPda, deriveUserUserRecordPda, deriveUserWarrantRecordPda, deriveValidatorRecordPda, deriveVaultPda, deriveWireReceiptPda, 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 };