npm - @wireio/stake - Versions diffs - 0.5.2 → 0.6.69 - Mend

@wireio/stake 0.5.2 → 0.6.69

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (587) hide show

package/src/staker.ts CHANGED Viewed

@@ -35,13 +35,27 @@ export class Staker {
         // console.log('STAKER INIT', config);
         config.forEach((cfg) => {
+            // if (+cfg.network.chainId === 31337){
+            //     console.log('ETH Wire Devnet chainId detected, remapping to hoodi for staker config');
+            //     cfg.network.chainId = EvmChainID.Hoodi; // remap local devnet to "Hoodi" chainId for now
+            // }
+            // if ((cfg.network.chainId as any) === 'devnet-wire'){
+            //     console.log('SOL Wire Devnet chainId detected, remapping to devnet-wire for staker config');
+            //     cfg.network.chainId = SolChainID.Devnet; // remap "devnet-wire" to Solana devnet chainId for now
+            // }
             switch (cfg.network.chainId) {
+                case SolChainID.Mainnet:
                 case SolChainID.Devnet:
+                case 'devnet-wire' as any:
                     this.clients.set(cfg.network.chainId, new SolanaStakingClient(cfg));
                     break;
+                case EvmChainID.Ethereum:
                 case EvmChainID.Hoodi:
-                    this.clients.set(EvmChainID.Hoodi, new EthereumStakingClient(cfg));
+                case 31337 as any:
+                    this.clients.set(cfg.network.chainId, new EthereumStakingClient(cfg));
                     break;
                 default:
@@ -52,13 +66,20 @@ export class Staker {
         this.selectedChainID = selectedChainID;
     }
     /**
      * Select a chain. Returns true if a client exists for it, false otherwise.
      * (We still record the selectedChainID so the UI can reflect the chosen chain.)
      */
     setChain(chainID: ChainID): boolean {
+        const hasClient = this.clients.has(chainID);
+        if (!hasClient) {
+            console.warn(`[Staker] setChain: no client configured for chain ${chainID}`);
+            return false;
+        }
         this.selectedChainID = chainID;
-        return this.clients.has(chainID);
+        return true;
     }
 }

package/src/types.ts CHANGED Viewed

@@ -1,14 +1,36 @@
 import { BaseSignerWalletAdapter } from '@solana/wallet-adapter-base';
 import { PublicKey as SolPubKey } from '@solana/web3.js';
-import { ChainID, ExternalNetwork, PublicKey } from '@wireio/core';
+import { ChainID, EvmChainID, ExternalNetwork, PublicKey, SolChainID } from '@wireio/core';
 import { ethers } from 'ethers';
 export type StakerConfig = {
     network: ExternalNetwork;
     provider?: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
     pubKey?: PublicKey;
+    extras?: {
+        squadsX?: SquadsXConfig;
+    }
 }
+export type SquadsXConfig = {
+    multisigPDA: string;        // REQUIRED, base58 multisig address string
+    vaultIndex?: number;        // default 0
+};
+export enum SupportedEvmChainID {
+    Ethereum = EvmChainID.Ethereum,
+    Hoodi = EvmChainID.Hoodi,
+    WireDevnet = 31337 as any,
+}
+export enum SupportedSolChainID {
+    Mainnet = SolChainID.Mainnet,
+    Devnet = SolChainID.Devnet,
+    WireDevnet = 'devnet-wire' as any,
+}
+export type ChainSymbol = 'ETH' | 'SOL';
+export type WithdrawStatus = 'queued' | 'ready' | 'claimed';
 export interface IStakingClient {
     pubKey?: PublicKey;
     network: ExternalNetwork;
@@ -16,23 +38,34 @@ export interface IStakingClient {
     /** 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>;
+    stake(amount: bigint, wireAccount?: string): 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>
+    /** 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, wireAccount?: string): 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[]>
     /** Fetch the complete user portfolio */
-    getPortfolio(): Promise<Portfolio | null>;
+    getPortfolio(address?: string): Promise<Portfolio | null>;
     // Estimated total APY for staking yeild
     getSystemAPY(): Promise<number>;
-    /**
-     * Protocol fee charged for deposit from Native to LIQ
-     * in Solana: amount in lamports
-     * in Ethereum: amount in wei
-     */
-    getDepositFee(amount: bigint): Promise<bigint>;
     /**
      * Program-level prelaunch WIRE/tranche snapshot for this chain.
      *
@@ -40,22 +73,29 @@ export interface IStakingClient {
      *  - `TrancheSnapshot` when the chain supports pretoken/tranches
      *  - `null` if this chain has no WIRE/pretoken integration
      */
-    getTrancheSnapshot(options?: {
-        chainID?: ChainID;
-        windowBefore?: number;
-        windowAfter?: number;
-    }): Promise<TrancheSnapshot | null>;
+    getTrancheSnapshot(chainId: ChainID): Promise<TrancheSnapshot | null>;
+    /**
+     * Protocol fee charged for deposit from Native to LIQ
+     * in Solana: amount in lamports
+     * in Ethereum: amount in wei
+     */
+    getDepositFee(amount: bigint): Promise<bigint>;
     /**
      * Estimate a conservative ETH(wei) / SOL(lamports) buffer to leave in the wallet
      * so the user can pay fees for the current deposit and at least one
      * more transaction, plus a bit extra for future interactions.
     */
-    estimateGasBuffer(options?: {
-        txCount?: number;
-        safetyMultiplier?: number;
-        minBuffer?: bigint;
+    getDepositBuffer(options?: {
+        txCount?: number;                // how many txs to cover in gas buffer (default 2)
+        safetyMultiplier?: number;       // safety multiplier on per-tx fee (default 3x)
+        minBufferLamports?: bigint;      // minimum gas buffer (default ~0.01 SOL)
+        balanceOverrideLamports?: bigint; // for tests/custom callers
     }): Promise<bigint>
+    // Removed : ValidatorDeposit not required for Solana
+    // validatorDeposit(): Promise<string>
 }
 /**
@@ -79,6 +119,12 @@ export interface Portfolio {
     /** 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).
@@ -284,9 +330,35 @@ export interface OPPAssertion {
     raw: any;
 }
 export 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
+ */
+export interface WithdrawReceipt {
+    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;
+    };
+}