@wireio/stake 2.2.1 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wireio/stake",
-    "version": "2.2.1",
+    "version": "2.3.0",
     "description": "LIQ Staking Module for Wire Network",
     "homepage": "https://gitea.gitgo.app/Wire/sdk-stake",
     "license": "FSL-1.1-Apache-2.0",
@@ -64,7 +64,7 @@
         "@types/node": "^18.19.0",
         "@typescript-eslint/eslint-plugin": "^5.60.0",
         "@typescript-eslint/parser": "^5.60.0",
-        "@wireio/core": "^0.3.0",
+        "@wireio/core": "^0.3.1",
         "assert": "^2.0.0",
         "chai": "^4.3.6",
         "esbuild": "^0.25.8",

package/src/index.ts

@@ -13,8 +13,8 @@ export * as SOL from './networks/solana/types';
 export * from './networks/solana/utils';
 
 // CLIENTS
-export * from './networks/solana/clients/deposit.client';
+export * from './networks/solana/clients/convert.client';
 export * from './networks/solana/clients/distribution.client';
 export * from './networks/solana/clients/leaderboard.client';
 export * from './networks/solana/clients/outpost.client';
-export * from './networks/solana/clients/token.client';
+export * from './networks/solana/clients/token.client';

package/src/networks/ethereum/clients/receipt.client.ts

@@ -1,7 +1,7 @@
 import { BigNumber } from "ethers";
-import { preLaunchReceipt, WithdrawReceipt } from "../types";
+import { preLaunchReceipt } from "../types";
+import { WithdrawReceipt, ReceiptNFTKind } from "../../../types";
 import { EthereumContractService } from "../contract";
-import { ReceiptNFTKind } from "../../../types";
 
 export class ReceiptClient {
 
@@ -13,8 +13,7 @@ export class ReceiptClient {
         this.contractService = contract;
     }
 
-
-
+    // NOTE: Stake/pretoken receipts intentionally ignored for withdraw view.
     async allReceipts(address: string): Promise<preLaunchReceipt[]> {
         return this.fetchPreLaunchReceipts(address);
     }
@@ -23,9 +22,7 @@ export class ReceiptClient {
         try {
             const receipts = await this.fetchPreLaunchReceipts(address, ReceiptNFTKind.STAKE);
             return receipts;
-        }
-        catch (err) {
-            // console.log('Error fetching stake receipts:', err);
+        } catch (err) {
             return [];
         }
     }
@@ -34,28 +31,20 @@ export class ReceiptClient {
         return this.fetchPreLaunchReceipts(address, ReceiptNFTKind.PRETOKEN_PURCHASE);
     }
 
-
-
     /**
-     * 
-     * @param address (string) to fetch receipts for
-     * @returns preLaunchReceipt[]
+     * Fetch ReceiptNFT data (stake/pretoken) for an address, optionally filtered by kind.
      */
     async fetchPreLaunchReceipts(address: string, type?: ReceiptNFTKind): Promise<preLaunchReceipt[]> {
         const receiptContract = this.contract.ReceiptNFT;
 
-        // first figure out which tokenIds this address owns, from events
         const tokenIds = await this.getOwnedReceiptNFTsFor(address);
-
         const results: preLaunchReceipt[] = [];
 
-        // next fetch on-chain receipt data just for those ids
         for (const idBN of tokenIds) {
             try {
                 const receiptData = await receiptContract.getReceipt(idBN);
 
-                //skip any receipt not of the requested type
-                if(type !== undefined && receiptData.kind !== type) continue;
+                if (type !== undefined && receiptData.kind !== type) continue;
 
                 results.push({ 
                     tokenId: idBN.toBigInt(), 
@@ -78,7 +67,6 @@ export class ReceiptClient {
                     }
                 });
             } catch (err) {
-                // in case of any mismatch or race, just skip this id
                 console.warn(`Failed to load receipt for tokenId=${idBN.toString()}`, err);
                 continue;
             }
@@ -88,50 +76,6 @@ export class ReceiptClient {
     }
 
 
-
-
-    private async getOwnedReceiptNFTsFor(
-        owner: string,
-        fromBlock = 0,
-        toBlock: number | string = "latest"
-    ): Promise<BigNumber[]> {
-        const receiptContract = this.contract.ReceiptNFT;
-
-        // Logs where address received tokens
-        const toLogs = await receiptContract.queryFilter(
-            receiptContract.filters.Transfer(null, owner),
-            fromBlock,
-            toBlock
-        );
-
-        // Logs where address sent tokens (including burns from owner → 0)
-        const fromLogs = await receiptContract.queryFilter(
-            receiptContract.filters.Transfer(owner, null),
-            fromBlock,
-            toBlock
-        );
-
-        const owned = new Set<string>();
-
-        // Add all received tokenIds
-        for (const e of toLogs) {
-            const tokenId = e.args?.tokenId;
-            if (!tokenId) continue;
-            owned.add(tokenId.toString());
-        }
-
-        // Remove all sent tokenIds
-        for (const e of fromLogs) {
-            const tokenId = e.args?.tokenId;
-            if (!tokenId) continue;
-            owned.delete(tokenId.toString());
-        }
-
-        // Convert to BigNumbers
-        return Array.from(owned).map((id) => BigNumber.from(id));
-    }
-
-
     /**
      * 
      * @param address (string) to fetch receipts for
@@ -147,16 +91,21 @@ export class ReceiptClient {
             try {
                 const receiptData = await this.contract.WithdrawalQueue.info(idBN);
 
-                results.push({ 
-                    tokenId: idBN.toBigInt(), 
+                // status: ready if readyAt <= now; otherwise queued
+                const readyAtMs = Number(receiptData.readyAt) * 1000;
+                const status = readyAtMs <= Date.now() ? 'ready' : 'queued';
+
+                results.push({
+                    tokenId: idBN.toBigInt(),
                     receipt: {
-                        ethAmount: receiptData.ethAmount,
-                        ethBalance: {
+                        amount: {
                             amount: receiptData.ethAmount.toBigInt(),
                             decimals: 18,
-                            symbol: "ETH"
+                            symbol: "ETH",
                         },
-                        readyAt: new Date(Number(receiptData.readyAt.toString()) * 1000).valueOf(),
+                        readyAt: readyAtMs,
+                        chain: 'ETH',
+                        status,
                     }
                 });
             } catch (err) {
@@ -211,4 +160,40 @@ export class ReceiptClient {
         // Convert to BigNumbers
         return Array.from(owned).map((id) => BigNumber.from(id));
     }
-}
+
+    private async getOwnedReceiptNFTsFor(
+        owner: string,
+        fromBlock = 0,
+        toBlock: number | string = "latest"
+    ): Promise<BigNumber[]> {
+        const receiptContract = this.contract.ReceiptNFT;
+
+        const toLogs = await receiptContract.queryFilter(
+            receiptContract.filters.Transfer(null, owner),
+            fromBlock,
+            toBlock
+        );
+
+        const fromLogs = await receiptContract.queryFilter(
+            receiptContract.filters.Transfer(owner, null),
+            fromBlock,
+            toBlock
+        );
+
+        const owned = new Set<string>();
+
+        for (const e of toLogs) {
+            const tokenId = e.args?.tokenId;
+            if (!tokenId) continue;
+            owned.add(tokenId.toString());
+        }
+
+        for (const e of fromLogs) {
+            const tokenId = e.args?.tokenId;
+            if (!tokenId) continue;
+            owned.delete(tokenId.toString());
+        }
+
+        return Array.from(owned).map((id) => BigNumber.from(id));
+    }
+}

package/src/networks/ethereum/clients/validator.client.ts

@@ -0,0 +1,61 @@
+import { BigNumber, ethers } from "ethers";
+import { ClaimedEvent, DepositEvent, DepositResult, SharesBurnedEvent, ValidatorDepositedEvent } from "../types";
+import { EthereumContractService } from "../contract";
+import { formatContractErrors } from "../utils";
+
+export class ValidatorClient {
+
+    private readonly contractService: EthereumContractService;
+    
+    get contract() { return this.contractService.contract; }
+
+    constructor(contract: EthereumContractService) {
+        this.contractService = contract;
+    }
+
+
+    /**
+     * 
+     * @param amountWei an amount of liqETH (in WEI) to stake to the Outpost
+     * @returns txHash (hash of the transaction), receipt, Staked event
+     */
+    async validatorDepositAndLockBond(): Promise<any> {
+        const amountWei: BigNumber = ethers.utils.parseEther("32");
+
+        // simulate call first
+        try {
+            await this.contract.DepositManager.callStatic.validatorDepositAndLockBond({ value: amountWei });
+        } catch (err: any) {
+            let errorObj = formatContractErrors(err);
+            throw new Error(errorObj.name ?? errorObj.raw)
+        }
+
+
+        // send the tx to stake liqeth
+        const tx = await this.contract.DepositManager.validatorDepositAndLockBond({ value: amountWei });
+
+        // Wait for 1 confirmation 
+        const receipt = await tx.wait(1);
+
+        // Parse ValidatorDeposited event if present
+        let staked: ValidatorDepositedEvent | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'Staked');
+
+        if (ev && ev.args) {
+            const { sender, amount, shares } = ev.args;
+            staked = {
+                sender,
+                amount: BigNumber.from(amount),
+                shares: BigNumber.from(shares),
+            };
+        }
+
+        return {
+            txHash: tx.hash,
+            receipt,
+            staked,
+        };
+    }
+
+
+}

package/src/networks/ethereum/ethereum.ts

@@ -15,6 +15,7 @@ import { StakeClient } from './clients/stake.client';
 import { PretokenClient } from './clients/pretoken.client';
 import { OPPClient } from './clients/opp.client';
 import { ReceiptClient } from './clients/receipt.client';
+import { ValidatorClient } from './clients/validator.client';
 
 export const INITIAL_TRANCHE_SUPPLY = 35000;
 
@@ -29,6 +30,7 @@ export class EthereumStakingClient implements IStakingClient {
     private stakeClient: StakeClient;
     private oppClient: OPPClient;
     private receiptClient: ReceiptClient;
+    private validatorClient: ValidatorClient;
 
 
     get contract() { return this.contractService.contract; }
@@ -56,6 +58,7 @@ export class EthereumStakingClient implements IStakingClient {
             this.stakeClient = new StakeClient(this.contractService);
             this.oppClient = new OPPClient(this.contractService);
             this.receiptClient = new ReceiptClient(this.contractService);
+            this.validatorClient = new ValidatorClient(this.contractService)
         }
         catch (error) {
             // console.error('Error initializing EthereumStakingClient:', error);
@@ -104,7 +107,7 @@ export class EthereumStakingClient implements IStakingClient {
      * @param amount  Amount in wei (or something convertible to BigNumber).
      * @returns transaction hash
      */
-    async loadPendingWithdraws(): Promise<WithdrawReceipt[]> {
+    async getPendingWithdraws(): Promise<WithdrawReceipt[]> {
         this.ensureUser();
         const address = await this.signer!.getAddress();
 
@@ -178,6 +181,21 @@ export class EthereumStakingClient implements IStakingClient {
     }
 
 
+    /**
+     * Validator functions
+     */
+    async validatorDeposit(): Promise<string> {
+        this.ensureUser();
+
+        let result = await this.validatorClient.validatorDepositAndLockBond();
+        return result && result.txHash ? result.txHash : "Error - no resulting txHash";
+    }
+    
+
+
+
+
+
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -310,6 +328,8 @@ export class EthereumStakingClient implements IStakingClient {
         return await this.oppClient.getMessages(address);
     }
 
+
+
     // Ensure that signer wallet is available for write operations
     private ensureUser() {
         if (!this.signer) {

package/src/networks/ethereum/types.ts

@@ -1,5 +1,5 @@
 import { BigNumber, ethers } from 'ethers';
-import { BalanceView } from '../../types';
+import { BalanceView, ChainSymbol, WithdrawReceipt as UnifiedWithdrawReceipt } from '../../types';
 
 export const CONTRACT_NAMES = [
     // LiqETH contracts
@@ -99,17 +99,20 @@ export interface SharesBurnedEvent {
     tokenValue: BigNumber;
 }
 
+/**
+ * Legacy stake/pretoken receipt (kept for compatibility; not used in withdraw UI).
+ */
 export interface preLaunchReceipt {
     tokenId: bigint;
     receipt: {
-        account: string,
-        currency: number,
-        kind: number,
-        indexAtMint: BalanceView,
-        principal: BalanceView,
-        shares: BalanceView,
-        timestamp: string,
-    }
+        account: string;
+        currency: number;
+        kind: number;
+        indexAtMint: BalanceView;
+        principal: BalanceView;
+        shares: BalanceView;
+        timestamp: string;
+    };
 }
 
 export interface ClaimedEvent {
@@ -117,12 +120,13 @@ export interface ClaimedEvent {
     amount: BigNumber;
 }
 
+// Unified withdraw receipt type is defined centrally in src/types.ts
+export type WithdrawReceipt = UnifiedWithdrawReceipt;
 
-export interface WithdrawReceipt {
-    tokenId: bigint;
-    receipt: {
-        ethAmount: BigNumber;
-        ethBalance: BalanceView;
-        readyAt: number;
-    }
-}
+
+
+export interface ValidatorDepositedEvent {
+    sender: string;
+    amount: BigNumber;
+    shares: BigNumber
+}