@wireio/stake 0.2.4 → 0.2.5

package/lib/stake.d.ts

@@ -74,6 +74,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.
@@ -108,7 +120,6 @@ interface TrancheSnapshot {
      */
     ladder: TrancheLadderItem[];
 }
-/** Purchase asset selection used by staking client(s) */
 declare enum PurchaseAsset {
     SOL = "SOL",
     LIQSOL = "LIQSOL",
@@ -147,7 +158,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", "Warrant", "Aggregator", "EthUsdPriceConsumer"];
 type ContractName = typeof CONTRACT_NAMES[number];
 type AddressBook = Record<ContractName, string>;
 interface Result {
@@ -233,6 +244,7 @@ declare class EthereumStakingClient implements IStakingClient {
     private readonly contractService;
     private depositClient;
     private stakeClient;
+    private pretokenClient;
     get contract(): {
         Accounting: ethers.Contract;
         DepositManager: ethers.Contract;
@@ -248,6 +260,8 @@ declare class EthereumStakingClient implements IStakingClient {
         OPPCommon: ethers.Contract;
         OPPInbound: ethers.Contract;
         Warrant: ethers.Contract;
+        Aggregator: ethers.Contract;
+        EthUsdPriceConsumer: ethers.Contract;
     };
     get network(): _wireio_core.ExternalNetwork;
     constructor(config: StakerConfig);
@@ -258,13 +272,37 @@ 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 DepositManager.
+     * @param amount  Amount in wei (or something convertible to BigNumber).
+     *                Keep this as a bigint / string in the caller; avoid JS floats.
+     * @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 +313,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: ({