@wireio/stake 2.5.1 → 2.6.0

package/lib/stake.d.ts

@@ -42,7 +42,12 @@ interface IStakingClient {
     /** 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>;
+    /** Atomically deposit native token to liq token, then stake that liq token. On Solana: amount in lamports. On Ethereum: amount in wei. */
+    depositAndStake(amount: bigint): Promise<string>;
+    /** Atomically deposit native token to liq token, then buy pretokens with that liq token. On Solana: amount in lamports. On Ethereum: amount in wei. */
+    depositAndBuy(amount: bigint): Promise<string>;
+    /** Atomically unstake liq token, then request withdrawal. On Solana: amount in lamports. On Ethereum: tokenId (ReceiptNFT ID). */
+    unstakeAndWithdraw(amount: bigint): Promise<string>;
     /** Enumerate withdrawal receipt NFTs held by the user (queued/ready/claimed). */
     getPendingWithdraws(address?: string): Promise<WithdrawReceipt$1[]>;
     /** Fetch the complete user portfolio */
@@ -360,6 +365,14 @@ interface WithdrawnStakeResult extends Result {
     /** Parsed WithdrawnStake event, if present */
     withdrawnstake?: WithdrawnStakeEvent;
 }
+interface DepositAndStakeResult extends Result {
+    /** Parsed Staked event, if present */
+    staked?: StakedEvent;
+}
+interface DepositAndPurchaseResult extends Result {
+}
+interface UnstakeAndWithdrawResult extends Result {
+}
 interface SharesBurnedEvent {
     from: string;
     shares: BigNumber;
@@ -395,11 +408,14 @@ type types$1_AddressBook = AddressBook;
 declare const types$1_CONTRACT_NAMES: typeof CONTRACT_NAMES;
 type types$1_ClaimedEvent = ClaimedEvent;
 type types$1_ContractName = ContractName;
+type types$1_DepositAndPurchaseResult = DepositAndPurchaseResult;
+type types$1_DepositAndStakeResult = DepositAndStakeResult;
 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_UnstakeAndWithdrawResult = UnstakeAndWithdrawResult;
 type types$1_ValidatorDepositedEvent = ValidatorDepositedEvent;
 type types$1_WithdrawReceipt = WithdrawReceipt;
 type types$1_WithdrawRequestedEvent = WithdrawRequestedEvent;
@@ -409,7 +425,7 @@ 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_ClaimedEvent as ClaimedEvent, 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_ValidatorDepositedEvent as ValidatorDepositedEvent, types$1_WithdrawReceipt as WithdrawReceipt, 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_ClaimedEvent as ClaimedEvent, types$1_ContractName as ContractName, types$1_DepositAndPurchaseResult as DepositAndPurchaseResult, types$1_DepositAndStakeResult as DepositAndStakeResult, 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_UnstakeAndWithdrawResult as UnstakeAndWithdrawResult, types$1_ValidatorDepositedEvent as ValidatorDepositedEvent, types$1_WithdrawReceipt as WithdrawReceipt, 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 const INITIAL_TRANCHE_SUPPLY = 35000;
@@ -468,14 +484,15 @@ declare class EthereumStakingClient implements IStakingClient {
      */
     withdraw(amount: bigint): 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
+     * List withdrawal queue receipts for a wallet (pending / in-progress exits after safeBurn).
+     * @param address  Owner to query; defaults to the connected wallet.
+     * @returns Withdrawal receipt NFT entries from the protocol view
      */
     getPendingWithdraws(address?: string): 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
+     * Claim native ETH for a matured withdrawal using the WithdrawalQueue NFT token id
+     * (via DepositManager.claim after the delay has passed).
+     * @param tokenId  Withdrawal request / queue NFT token id
      * @returns transaction hash
      */
     claimWithdraw(tokenId: bigint): Promise<string>;
@@ -486,6 +503,24 @@ declare class EthereumStakingClient implements IStakingClient {
      */
     stake(amount: bigint): Promise<string>;
     unstake(): Promise<string>;
+    /**
+     * Deposit ETH to liqETH, then stake liqETH in a single transaction.
+     * @param amountWei  Amount in wei.
+     * @returns transaction hash
+     */
+    depositAndStake(amountWei: bigint): Promise<string>;
+    /**
+     * Deposit ETH to liqETH, then purchase pretokens in a single transaction.
+     * @param amountWei  Amount in wei.
+     * @returns transaction hash
+     */
+    depositAndBuy(amountWei: bigint): Promise<string>;
+    /**
+     * Unstake liqETH, then request a withdrawal in a single transaction.
+     * @param tokenId  The ReceiptNFT token ID for the stake position
+     * @returns transaction hash
+     */
+    unstakeAndWithdraw(tokenId: bigint): Promise<string>;
     /**
      * ETH Prelaunch function to unstake liqEth
      * @param tokenId ReceiptNFT tokenId for the owned NFT that will be burned
@@ -703,7 +738,7 @@ declare const ERC1155Abi: ({
 declare const MAINNET_ADDRESSES: AddressBook;
 /**
  * HOODI TESTNET LATEST
- * 1/23/26
+ * 3/25/26
  */
 declare const HOODI_ADDRESSES: AddressBook;
 declare const ADDRESS_BOOK_BY_CHAIN: Record<SupportedEvmChainID, AddressBook>;
@@ -762,8 +797,8 @@ declare class EthereumContractService {
 type SolanaTransaction = Transaction | VersionedTransaction;
 type WalletLike = {
     publicKey: PublicKey$1;
-    signTransaction: (tx: Transaction) => Promise<Transaction>;
-    signAllTransactions?: (txs: Transaction[]) => Promise<Transaction[]>;
+    signTransaction: <T extends SolanaTransaction>(tx: T) => Promise<T>;
+    signAllTransactions?: <T extends SolanaTransaction>(txs: T[]) => Promise<T[]>;
 };
 type ParsedAccountInfo = {
     extensions: Array<{
@@ -1394,7 +1429,7 @@ type SolanaProgramIds = {
     LIQSOL_TOKEN: PublicKey$1;
     VALIDATOR_LEADERBOARD: PublicKey$1;
     TRANSFER_HOOK: PublicKey$1;
-    ALT_LOOKUP_TABLE: PublicKey$1;
+    ALT: PublicKey$1;
 };
 declare const PROGRAM_IDS_BY_CHAIN: Record<SupportedSolChainID, SolanaProgramIds>;
 declare const getProgramIds: (chainId: SolChainID) => SolanaProgramIds;
@@ -16872,6 +16907,12 @@ declare class SolanaStakingClient implements IStakingClient {
      * instruction under the new IDL (no more native-SOL purchase).
      */
     buy(amountLamports: bigint): Promise<string>;
+    /** Deposit SOL to liqSOL, then syndicate that liqSOL in one transaction. Requires enough SOL for the deposit fee. */
+    depositAndStake(amountLamports: bigint): Promise<string>;
+    /** Deposit SOL to liqSOL, then buy pretokens with that liqSOL in one transaction. Requires enough SOL for the deposit fee. */
+    depositAndBuy(amountLamports: bigint): Promise<string>;
+    /** Desyndicate liqSOL, then request withdraw in one transaction. */
+    unstakeAndWithdraw(amountLamports: bigint): Promise<string>;
     /**
      * Aggregate view of the user’s balances on Solana:
      *  - native: SOL wallet balance
@@ -16889,6 +16930,7 @@ declare class SolanaStakingClient implements IStakingClient {
     getUserRecord(): Promise<DistributionUserRecord | null>;
     get squadsMultisigPDA(): PublicKey$1 | undefined;
     get squadsVaultPDA(): PublicKey$1 | undefined;
+    /** Create a Squads vault transaction/proposal for one or more instructions. */
     private sendSquadsIxs;
     buildAndSendIx(ix: TransactionInstruction | TransactionInstruction[]): Promise<string>;
     /**