@wireio/stake 2.2.2 → 2.3.1

package/lib/stake.d.ts

@@ -28,6 +28,8 @@ declare enum SupportedSolChainID {
     Mainnet = "mainnet-beta",
     Devnet = "devnet"
 }
+type ChainSymbol = 'ETH' | 'SOL';
+type WithdrawStatus = 'queued' | 'ready' | 'claimed';
 interface IStakingClient {
     pubKey?: PublicKey;
     network: ExternalNetwork;
@@ -37,6 +39,12 @@ interface IStakingClient {
     stake(amount: bigint): Promise<string>;
     unstake(amount: bigint): Promise<string>;
     buy(amount: bigint): Promise<string>;
+    /** Claim a withdrawal receipt (burn NFT + receive ETH/SOL) via claim_withdraw. */
+    claimWithdraw(tokenId: bigint): Promise<string>;
+    /** Solana only: claim accrued liqSOL distribution rewards. */
+    claimLiqsolRewards?(): Promise<string>;
+    /** Enumerate withdrawal receipt NFTs held by the user (queued/ready/claimed). */
+    getPendingWithdraws(): Promise<WithdrawReceipt$1[]>;
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio | null>;
     getSystemAPY(): Promise<number>;
@@ -65,7 +73,6 @@ interface IStakingClient {
         minBufferLamports?: bigint;
         balanceOverrideLamports?: bigint;
     }): Promise<bigint>;
-    validatorDeposit(): Promise<string>;
 }
 /**
  * Cross-chain portfolio view for a single account/wallet.
@@ -86,6 +93,11 @@ interface Portfolio {
     native: BalanceView;
     /** Liquid staking token balance (LiqETH, LiqSOL, etc.). */
     liq: BalanceView;
+    /**
+     * Solana-only liqSOL rewards currently claimable from the distribution bucket.
+     * Not populated on Ethereum.
+     */
+    claimable?: BalanceView;
     /**
      * Outpost-staked balance:
      *  - On Solana: liqSOL staked via `synd` (stakedLiqsol, in lamports).
@@ -252,6 +264,33 @@ declare enum ReceiptNFTKind {
     STAKE = 0,
     PRETOKEN_PURCHASE = 1
 }
+/**
+ * Unified cross-chain withdraw receipt (ETH + SOL).
+ *
+ * tokenId   – NFT id (ERC721 on ETH, PDA-seeded mint on SOL)
+ * receipt   – chain-specific data normalized for UI
+ */
+interface WithdrawReceipt$1 {
+    tokenId: bigint;
+    receipt: {
+        /** Display balance (wei or lamports) with symbol/decimals. */
+        amount: BalanceView;
+        /** Claimable time in ms since epoch (readyAt on ETH; ETA from epoch on SOL). */
+        readyAt: number;
+        /** Chain discriminator. */
+        chain: ChainSymbol;
+        /** Solana-only: epoch when claimable. */
+        epoch?: bigint;
+        /** queued | ready | claimed */
+        status?: WithdrawStatus;
+        /** NFT mint (SOL) or ERC721 contract address (ETH queue address). */
+        mint?: string;
+        /** Owner token account (SOL) for the NFT. */
+        ownerAta?: string;
+        /** Optional explicit contract address for ETH queue NFT. */
+        contractAddress?: string;
+    };
+}
 
 declare class Staker {
     selectedChainID?: ChainID;
@@ -326,6 +365,9 @@ interface SharesBurnedEvent {
     shares: BigNumber;
     tokenValue: BigNumber;
 }
+/**
+ * Legacy stake/pretoken receipt (kept for compatibility; not used in withdraw UI).
+ */
 interface preLaunchReceipt {
     tokenId: bigint;
     receipt: {
@@ -342,14 +384,7 @@ interface ClaimedEvent {
     user: string;
     amount: BigNumber;
 }
-interface WithdrawReceipt {
-    tokenId: bigint;
-    receipt: {
-        ethAmount: BigNumber;
-        ethBalance: BalanceView;
-        readyAt: number;
-    };
-}
+type WithdrawReceipt = WithdrawReceipt$1;
 interface ValidatorDepositedEvent {
     sender: string;
     amount: BigNumber;
@@ -417,6 +452,7 @@ declare class EthereumStakingClient implements IStakingClient {
         MockAggregator: ethers.Contract;
     };
     get network(): _wireio_core.ExternalNetwork;
+    get address(): Promise<string> | undefined;
     constructor(config: StakerConfig);
     /**
      * Deposit native ETH into the liqETH protocol via DepositManager.
@@ -436,7 +472,7 @@ declare class EthereumStakingClient implements IStakingClient {
      * @param amount  Amount in wei (or something convertible to BigNumber).
      * @returns transaction hash
      */
-    loadPendingWithdraws(): Promise<WithdrawReceipt[]>;
+    getPendingWithdraws(): Promise<WithdrawReceipt[]>;
     /**
      * 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 tokenId  The ID of the withdrawal request NFT
@@ -1299,6 +1335,24 @@ type ValidatorRecord = {
      */
     bump: number;
 };
+/**
+ * IDL: `receiptData`
+ *
+ * Withdrawal receipt data structure tracking pending withdrawals.
+ * Each receipt represents a user's request to withdraw liqSOL,
+ * with the withdrawal contingent on sufficient encumbered funds
+ * being available at the serviceable epoch.
+ */
+type ReceiptData = {
+    /** Unique receipt identifier (monotonically increasing, u64) */
+    receiptId: bigint;
+    /** Amount of liqSOL requested for withdrawal (Token-2022 raw amount, u64) */
+    liqports: bigint;
+    /** Epoch at which this receipt becomes claimable (u64) */
+    epoch: bigint;
+    /** Flag indicating whether this receipt has been fulfilled/claimed (bool) */
+    fulfilled: boolean;
+};
 
 type types_DistributionState = DistributionState;
 type types_DistributionUserRecord = DistributionUserRecord;
@@ -1312,6 +1366,7 @@ type types_ParsedAccountInfo = ParsedAccountInfo;
 type types_PayRateEntry = PayRateEntry;
 type types_PayRateHistory = PayRateHistory;
 type types_PriceHistory = PriceHistory;
+type types_ReceiptData = ReceiptData;
 type types_Role = Role;
 type types_SharesPreview = SharesPreview;
 type types_SolanaTransaction = SolanaTransaction;
@@ -1324,7 +1379,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_GlobalAccount as GlobalAccount, 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 };
+  export type { types_DistributionState as DistributionState, types_DistributionUserRecord as DistributionUserRecord, types_GlobalAccount as GlobalAccount, 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_ReceiptData as ReceiptData, 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 };
 }
 
 /**
@@ -15387,7 +15442,14 @@ declare class SolanaProgramService {
     deriveEphemeralStakeAddress(user: PublicKey$1, seed: number): Promise<PublicKey$1>;
 }
 
-declare class DepositClient {
+/**
+ * ConvertClient (Solana):
+ * - deposit SOL -> liqSOL
+ * - request withdraw (liqSOL burn -> NFT receipt)
+ * - list withdrawal receipts owned by a user
+ * - build claim_withdraw instruction
+ */
+declare class ConvertClient {
     private readonly provider;
     private readonly pgs;
     private program;
@@ -15395,20 +15457,25 @@ declare class DepositClient {
     get wallet(): WalletLike;
     constructor(provider: AnchorProvider, pgs: SolanaProgramService);
     /**
-     * Build a deposit transaction:
-     *   SOL -> liqSOL via liqsol_core::deposit.
+     * Build a deposit instruction (SOL -> liqSOL).
      */
     buildDepositTx(amount: bigint, user?: PublicKey$1): Promise<TransactionInstruction>;
     /**
-     * Build a withdraw-request transaction:
-     *   liqSOL -> SOL via liqsol_core::requestWithdraw.
-     *
-     * This:
-     *  - burns liqSOL from the user
-     *  - increments totalEncumberedFunds in global state
-     *  - mints an NFT receipt (liqReceiptData + NFT ATA for owner)
+     * Build a withdraw-request instruction (liqSOL burn -> NFT receipt).
      */
     buildWithdrawTx(amount: bigint, user?: PublicKey$1): Promise<TransactionInstruction>;
+    /**
+     * Enumerate withdrawal receipt NFTs owned by `owner`.
+     */
+    fetchWithdrawReceipts(owner: PublicKey$1): Promise<WithdrawReceipt$1[]>;
+    /**
+     * Build the claim_withdraw instruction for a given receiptId.
+     */
+    buildClaimWithdrawTx(receiptId: bigint, user: PublicKey$1): Promise<TransactionInstruction>;
+    /**
+     * Estimate ready time for target epoch using recent slot time.
+     */
+    private estimateEpochEta;
 }
 
 /**
@@ -15435,6 +15502,7 @@ declare class DistributionClient {
     private program;
     constructor(provider: AnchorProvider, pgs: SolanaProgramService);
     get connection(): _solana_web3_js.Connection;
+    private getTokenBalance;
     /**
      * Fetch the global distribution state account.
      *
@@ -15477,6 +15545,19 @@ declare class DistributionClient {
         totalShares: BN;
         ratio: number;
     }>;
+    /**
+     * Compute claimable liqSOL for a wallet:
+     * claimable = max(0, entitled - actual)
+     * entitled = floor(shares * syncedIndex / 1e12)
+     *
+     * `syncedIndex` mirrors on-chain `sync_index` behavior by incorporating any
+     * unsynced bucket delta (bucket_balance - last_bucket_balance).
+     */
+    getClaimableLiqsol(user: PublicKey$1): Promise<BN>;
+    /**
+     * Build claim_rewards instruction for a wallet.
+     */
+    buildClaimRewardsIx(user: PublicKey$1): Promise<TransactionInstruction>;
     /**
      * Compute an average scaled pay rate over the most recent `windowSize`
      * valid entries in the pay-rate history circular buffer.
@@ -15617,6 +15698,7 @@ interface ScheduleConfig {
     late?: number;
 }
 declare function ceilDiv(n: BN, d: BN): BN;
+declare function normalizeToBigInt(x: any): bigint;
 
 /**
  * OutpostClient
@@ -15759,7 +15841,7 @@ declare class SolanaStakingClient implements IStakingClient {
     pubKey?: PublicKey;
     connection: Connection;
     anchor: AnchorProvider;
-    depositClient: DepositClient;
+    convertClient: ConvertClient;
     distributionClient: DistributionClient;
     leaderboardClient: LeaderboardClient;
     outpostClient: OutpostClient;
@@ -15788,6 +15870,19 @@ declare class SolanaStakingClient implements IStakingClient {
      * Actual SOL payout happens later via the operator-side flow.
      */
     withdraw(amountLamports: bigint): Promise<string>;
+    /**
+     * Enumerate withdrawal receipt NFTs held by the user (queued/ready/claimed).
+     * Mirrors the ETH getPendingWithdraws helper for UI parity.
+     */
+    getPendingWithdraws(): Promise<WithdrawReceipt$1[]>;
+    /**
+     * Claim a withdrawal receipt (burn NFT + receive SOL) via claim_withdraw.
+     */
+    claimWithdraw(tokenId: bigint): Promise<string>;
+    /**
+     * Claim accrued liqSOL distribution rewards (liqsol_core::claim_rewards).
+     */
+    claimLiqsolRewards(): Promise<string>;
     /**
      * Stake liqSOL into Outpost (liqSOL → pool) via liqsol_core::synd.
      */
@@ -15923,5 +16018,5 @@ declare class SolanaStakingClient implements IStakingClient {
     private getSingleTxFeeLamports;
 }
 
-export { ADDRESSES, ADDRESS_BOOK_BY_CHAIN, CHAINLINK_FEED, CHAINLINK_PROGRAM, CONTRACTS_BY_CHAIN, DEFAULT_AVERAGE_PAY_RATE, DEFAULT_PAY_RATE_LOOKBACK, DepositClient, DistributionClient, EPHEMERAL_RENT_EXEMPTION, ERC1155Abi, ERC20Abi, ERC721Abi, types$1 as ETH, EthereumContractService, EthereumStakingClient, HOODI_ADDRESSES, INDEX_SCALE, INITIAL_TRANCHE_SUPPLY, LAMPORTS_PER_SOL, LeaderboardClient, MAINNET_ADDRESSES, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS_BY_CHAIN, PurchaseAsset, ReceiptNFTKind, SCALE, types as SOL, SolanaStakingClient, Staker, SupportedEvmChainID, SupportedSolChainID, TokenClient, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, ceilDiv, deriveEphemeralStakeAddress, generateRandomDepositAmount, generateTestKeypair, getEpochSnapshot, getErrorMessage, getProgramIds, lamportsToSol, msToEpochEnd, scheduledInstruction, sleep, solToLamports, toBigint, tokensToShares, waitForConfirmation, waitUntilSafeToExecuteFunction };
-export type { BalanceView, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OPPAssertion, OutpostAccounts, Portfolio, PurchaseQuote, ScheduleConfig, SolanaProgramIds, SquadsXConfig, StakerConfig, TrancheLadderItem, TrancheSnapshot, YieldView };
+export { ADDRESSES, ADDRESS_BOOK_BY_CHAIN, CHAINLINK_FEED, CHAINLINK_PROGRAM, CONTRACTS_BY_CHAIN, ConvertClient, DEFAULT_AVERAGE_PAY_RATE, DEFAULT_PAY_RATE_LOOKBACK, DistributionClient, EPHEMERAL_RENT_EXEMPTION, ERC1155Abi, ERC20Abi, ERC721Abi, types$1 as ETH, EthereumContractService, EthereumStakingClient, HOODI_ADDRESSES, INDEX_SCALE, INITIAL_TRANCHE_SUPPLY, LAMPORTS_PER_SOL, LeaderboardClient, MAINNET_ADDRESSES, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS_BY_CHAIN, PurchaseAsset, ReceiptNFTKind, SCALE, types as SOL, SolanaStakingClient, Staker, SupportedEvmChainID, SupportedSolChainID, TokenClient, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, ceilDiv, deriveEphemeralStakeAddress, generateRandomDepositAmount, generateTestKeypair, getEpochSnapshot, getErrorMessage, getProgramIds, lamportsToSol, msToEpochEnd, normalizeToBigInt, scheduledInstruction, sleep, solToLamports, toBigint, tokensToShares, waitForConfirmation, waitUntilSafeToExecuteFunction };
+export type { BalanceView, ChainSymbol, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OPPAssertion, OutpostAccounts, Portfolio, PurchaseQuote, ScheduleConfig, SolanaProgramIds, SquadsXConfig, StakerConfig, TrancheLadderItem, TrancheSnapshot, WithdrawReceipt$1 as WithdrawReceipt, WithdrawStatus, YieldView };