@wireio/stake 0.9.0 → 0.9.2

package/lib/stake.d.ts

@@ -2,7 +2,7 @@ import * as _wireio_core from '@wireio/core';
 import { ExternalNetwork, PublicKey, ChainID } from '@wireio/core';
 import { BaseSignerWalletAdapter } from '@solana/wallet-adapter-base';
 import * as _solana_web3_js from '@solana/web3.js';
-import { PublicKey as PublicKey$1, Transaction, VersionedTransaction, TokenAmount, Connection, Keypair, TransactionInstruction, TransactionSignature } from '@solana/web3.js';
+import { PublicKey as PublicKey$1, Transaction, VersionedTransaction, TokenAmount, Connection, TransactionInstruction, Keypair, TransactionSignature } from '@solana/web3.js';
 import { ethers, BigNumber, Signer, Contract } from 'ethers';
 import { JsonFragment } from '@ethersproject/abi';
 import { ErrorDescription } from '@ethersproject/abi/lib/interface';
@@ -12,6 +12,13 @@ type StakerConfig = {
     network: ExternalNetwork;
     provider?: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
     pubKey?: PublicKey;
+    extras?: {
+        squadsX?: SquadsXConfig;
+    };
+};
+type SquadsXConfig = {
+    multisigPDA: string;
+    vaultIndex?: number;
 };
 interface IStakingClient {
     pubKey?: PublicKey;
@@ -326,15 +333,29 @@ interface preLaunchReceipt {
         timestamp: string;
     };
 }
+interface ClaimedEvent {
+    sender: string;
+    ethAmount: BigNumber;
+}
+interface WithdrawReceipt {
+    tokenId: bigint;
+    receipt: {
+        ethAmount: BigNumber;
+        ethBalance: BalanceView;
+        readyAt: number;
+    };
+}
 
 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_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_WithdrawReceipt = WithdrawReceipt;
 type types$1_WithdrawRequestedEvent = WithdrawRequestedEvent;
 type types$1_WithdrawResult = WithdrawResult;
 type types$1_WithdrawnStakeEvent = WithdrawnStakeEvent;
@@ -342,7 +363,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_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 };
+  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_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;
@@ -399,6 +420,18 @@ declare class EthereumStakingClient implements IStakingClient {
      * @returns transaction hash
      */
     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
+     */
+    loadPendingWithdraws(): 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 amount  Amount in wei (or something convertible to BigNumber).
+     * @returns transaction hash
+     */
+    claimWithdraw(tokenId: bigint): Promise<string>;
     /**
      * Stake liqETH via DepositManager.
      * @param amount  Amount in wei - Keep this as a bigint / string in the caller; avoid JS floats.
@@ -864,7 +897,7 @@ type GlobalState = {
      */
     roleWarmupDuration: BN;
     /** Wire lifecycle state (preLaunch / postLaunch / refund) */
-    wireState: WireState;
+    wireState: WireState | any;
     /** PDA bump */
     bump: number;
 };
@@ -1143,7 +1176,7 @@ type LeaderboardState = {
      * Per-validator scores (i64 on-chain).
      * Index corresponds to `registryIndex` in ValidatorRecord.
      */
-    scores: BN[];
+    scores: number[];
     /**
      * Sorted indices into `scores[]` / `voteAccounts[]`,
      * typically highest score first.
@@ -1154,7 +1187,9 @@ type LeaderboardState = {
      * `voteAccounts[i]` is the vote account for validator with
      * `registryIndex == i`.
      */
-    voteAccounts: PublicKey$1[];
+    voteAccounts: {
+        bytes: number[];
+    }[];
     /**
      * Number of active validators currently tracked in the leaderboard.
      * Only the first `numValidators` entries of the arrays are meaningful.
@@ -1166,7 +1201,7 @@ type LeaderboardState = {
      * Reserved padding / future-proofing on-chain (u64[8]).
      * Not used by client logic, but surfaced for completeness.
      */
-    padding: BN[];
+    padding: number[];
 };
 /**
  * Per-validator record tying Solana vote account to
@@ -1269,13 +1304,36 @@ declare namespace types {
 declare class DepositClient {
     private provider;
     private program;
+    get connection(): Connection;
     get wallet(): WalletLike;
     constructor(provider: AnchorProvider);
     /**
      * Build a deposit transaction:
      *   SOL -> liqSOL via liqsol_core::deposit.
      */
-    buildDepositTx(amount: bigint, user?: _solana_web3_js.PublicKey): Promise<Transaction>;
+    buildDepositTx(amount: bigint, user?: PublicKey$1): Promise<TransactionInstruction>;
+    buildSquadsDepositProposalTx(params: {
+        connection: Connection;
+        multisigPda: PublicKey$1;
+        amountLamports: bigint;
+        wallet: WalletLikeSigner;
+        vaultIndex?: number;
+    }): Promise<{
+        tx: Transaction;
+        transactionIndex: bigint;
+        vaultPda: PublicKey$1;
+    }>;
+    buildSquadsDepositProposalTx2(params: {
+        connection: Connection;
+        multisigPda: PublicKey$1;
+        amountLamports: bigint;
+        wallet: WalletLikeSigner;
+        vaultIndex?: number;
+    }): Promise<{
+        tx: Transaction;
+        transactionIndex: bigint;
+        vaultPda: PublicKey$1;
+    }>;
     /**
      * Build a withdraw-request transaction:
      *   liqSOL -> SOL via liqsol_core::requestWithdraw.
@@ -1285,8 +1343,18 @@ declare class DepositClient {
      *  - increments totalEncumberedFunds in global state
      *  - mints an NFT receipt (liqReceiptData + NFT ATA for owner)
      */
-    buildWithdrawTx(amount: bigint, user?: _solana_web3_js.PublicKey): Promise<Transaction>;
+    buildWithdrawTx(amount: bigint, user?: PublicKey$1): Promise<Transaction>;
+    /**
+     * Internal helper: build the liqsol_core::deposit instruction for a specific `user`.
+     * This is the exact same account wiring as buildDepositTx(), but returns the IX
+     * plus useful derived addresses/seed for Squads flows.
+     */
+    private buildDepositIxForUser;
 }
+type WalletLikeSigner = {
+    publicKey: PublicKey$1;
+    signTransaction: (tx: Transaction) => Promise<Transaction>;
+};
 
 /**
  * Distribution client – wraps the distribution portion of the liqsol_core
@@ -8627,7 +8695,7 @@ declare class SolanaProgramService {
     listProgramNames(): SolanaProgramName[];
 }
 
-declare const SCALE: any;
+declare const SCALE: BN;
 /**
  * Solana implementation of IStakingClient.
  *
@@ -8650,9 +8718,22 @@ declare class SolanaStakingClient implements IStakingClient {
     outpostClient: OutpostClient;
     tokenClient: TokenClient;
     program: SolanaProgramService;
+    private smartAccount?;
+    private signer?;
     get solPubKey(): PublicKey$1;
     get network(): ExternalNetwork;
+    get feePayer(): PublicKey$1;
+    get squadsX(): SquadsXConfig | null;
     constructor(config: StakerConfig);
+    createVaultLiqsolAtaOneShot(params: {
+        connection: Connection;
+        payer: PublicKey$1;
+        vaultPda: PublicKey$1;
+    }): Promise<{
+        tx: Transaction;
+        vaultAta: PublicKey$1;
+    } | null>;
+    private prepSquadsIxs;
     /**
      * Deposit native SOL into liqSOL (liqsol_core::deposit).
      * Handles tx build, sign, send, and confirmation.
@@ -8699,6 +8780,8 @@ declare class SolanaStakingClient implements IStakingClient {
      * Used by balance-correction flows and debugging.
      */
     getUserRecord(): Promise<DistributionUserRecord | null>;
+    get squadsMultisigPDA(): PublicKey$1 | null;
+    get squadsVaultPDA(): PublicKey$1 | null;
     /**
      * Unified, chain-agnostic tranche snapshot for Solana.
      *
@@ -8951,4 +9034,4 @@ 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, INITIAL_TRANCHE_SUPPLY, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, PurchaseAsset, ReceiptNFTKind, SCALE, types as SOL, SolanaStakingClient, Staker, TRANSFER_HOOK, TokenClient, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, buildSolanaTrancheLadder, buildSolanaTrancheSnapshot, calculateExpectedFee, ceilDiv, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveExtraAccountMetaListPda, deriveGlobalConfigPda, 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 };
+export type { BalanceView, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OPPAssertion, OutpostAccounts, Portfolio, PurchaseQuote, ScheduleConfig, SquadsXConfig, StakerConfig, TrancheLadderItem, TrancheSnapshot, YieldView };