@wireio/stake 0.9.1 → 0.9.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wireio/stake",
-    "version": "0.9.1",
+    "version": "0.9.2",
     "description": "LIQ Staking Module for Wire Network",
     "homepage": "https://gitea.gitgo.app/Wire/sdk-stake",
     "license": "FSL-1.1-Apache-2.0",
@@ -33,7 +33,7 @@
         "lint:fix": "eslint 'src/**/*.{js,ts}' --fix"
     },
     "peerDependencies": {
-        "@wireio/core": ">=0.1.0 <0.3.0"
+        "@wireio/core": ">=0.1.0 <0.4.0"
     },
     "dependencies": {
         "@coral-xyz/anchor": "^0.31.1",
@@ -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.2.9",
+        "@wireio/core": "^0.3.0",
         "assert": "^2.0.0",
         "chai": "^4.3.6",
         "esbuild": "^0.25.8",

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

@@ -1,5 +1,5 @@
 import { BigNumber, ethers } from "ethers";
-import { DepositEvent, DepositResult, SharesBurnedEvent } from "../types";
+import { ClaimedEvent, DepositEvent, DepositResult, SharesBurnedEvent } from "../types";
 import { EthereumContractService } from "../contract";
 import { formatContractErrors } from "../utils";
 
@@ -114,6 +114,34 @@ export class ConvertClient {
     }
 
 
+    public async claimWithdraw(tokenId: BigNumber): Promise<any> {
+        let tx, receipt;
+        try {
+            tx = await this.contract.DepositManager.claim(tokenId);
+            receipt = await tx.wait(1);
+        } catch (err: any) {
+            let errorObj = formatContractErrors(err);
+            throw new Error(errorObj.name ?? errorObj.raw)
+        }
+
+        // Parse Claimed event if present
+        let event: ClaimedEvent | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'Claimed');
+
+        if (ev && ev.args) {
+            const { sender, ethAmount } = ev.args;
+            event = {
+                sender,
+                ethAmount: BigNumber.from(ethAmount),
+            };
+        }
+
+        return {
+            txHash: tx.hash,
+            receipt,
+            event,
+        };
+    }
     
     /*
     // OLD - this was replaced with LiqEth.safeBurn() on 1/13/26

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

@@ -1,5 +1,5 @@
 import { BigNumber } from "ethers";
-import { preLaunchReceipt } from "../types";
+import { preLaunchReceipt, WithdrawReceipt } from "../types";
 import { EthereumContractService } from "../contract";
 import { ReceiptNFTKind } from "../../../types";
 
@@ -45,7 +45,7 @@ export class ReceiptClient {
         const receiptContract = this.contract.ReceiptNFT;
 
         // first figure out which tokenIds this address owns, from events
-        const tokenIds = await this.getOwnedTokenIdsFor(address);
+        const tokenIds = await this.getOwnedReceiptNFTsFor(address);
 
         const results: preLaunchReceipt[] = [];
 
@@ -90,7 +90,7 @@ export class ReceiptClient {
 
 
 
-    private async getOwnedTokenIdsFor(
+    private async getOwnedReceiptNFTsFor(
         owner: string,
         fromBlock = 0,
         toBlock: number | string = "latest"
@@ -132,5 +132,83 @@ export class ReceiptClient {
     }
 
 
+    /**
+     * 
+     * @param address (string) to fetch receipts for
+     * @returns preLaunchReceipt[]
+     */
+    async fetchWithdrawReceipts(address: string): Promise<WithdrawReceipt[]> {
+        // first figure out which tokenIds this address owns, from events
+        const tokenIds = await this.getOwnedWithdrawReceiptsFor(address);
+        const results: WithdrawReceipt[] = [];
+
+        // next fetch on-chain token data just for those ids
+        for (const idBN of tokenIds) {
+            try {
+                const receiptData = await this.contract.WithdrawalQueue.info(idBN);
+
+                results.push({ 
+                    tokenId: idBN.toBigInt(), 
+                    receipt: {
+                        ethAmount: receiptData.ethAmount,
+                        ethBalance: {
+                            amount: receiptData.ethAmount.toBigInt(),
+                            decimals: 18,
+                            symbol: "ETH"
+                        },
+                        readyAt: new Date(Number(receiptData.readyAt.toString()) * 1000).valueOf(),
+                    }
+                });
+            } 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;
+            }
+        }
+
+        return results;
+    }
+
+
+
+    private async getOwnedWithdrawReceiptsFor(
+        owner: string,
+        fromBlock = 0,
+        toBlock: number | string = "latest"
+    ): Promise<BigNumber[]> {
+        const contract = this.contract.WithdrawalQueue;
+
+        // Logs where address received tokens
+        const toLogs = await contract.queryFilter(
+            contract.filters.Transfer(null, owner),
+            fromBlock,
+            toBlock
+        );
+
+        // Logs where address sent tokens (including burns from owner → 0)
+        const fromLogs = await contract.queryFilter(
+            contract.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));
+    }
 }

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

@@ -45,6 +45,7 @@ export class StakeClient {
             throw new Error("Error - Depositor is in a paused state");
         }
 
+        if (bal.lt(amountWei)) throw new Error("Insufficient LiqETH balance");
 
         // if allowance is less than the requested stake amount, request permission to spend LiqEth
         if (allowance.lt(amountWei)) {

package/src/networks/ethereum/ethereum.ts

@@ -8,7 +8,7 @@ import {
     TrancheSnapshot
 } from '../../types';
 import { EthereumContractService } from './contract';
-import { preLaunchReceipt } from './types';
+import { preLaunchReceipt, WithdrawReceipt } from './types';
 import { buildEthereumTrancheSnapshot } from './utils';
 import { ConvertClient } from './clients/convert.client';
 import { StakeClient } from './clients/stake.client';
@@ -98,6 +98,31 @@ export class EthereumStakingClient implements IStakingClient {
         return result.txHash;
     }
 
+    /**
+     * 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
+     */
+    async loadPendingWithdraws(): Promise<WithdrawReceipt[]> {
+        this.ensureUser();
+        const address = await this.signer!.getAddress();
+
+        return await this.receiptClient.fetchWithdrawReceipts(address);
+    }
+
+    /**
+     * 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
+     */
+    async claimWithdraw(tokenId: bigint): Promise<string> {
+        this.ensureUser();
+
+        const tokenIdBigNum = BigNumber.from(tokenId)
+        const result = await this.convertClient.claimWithdraw(tokenIdBigNum)
+        return result.txHash;
+    }
+
 
     /**
      * Stake liqETH via DepositManager.
@@ -213,17 +238,14 @@ export class EthereumStakingClient implements IStakingClient {
             // sharesToTokens(userShares, currentIndex) = userShares * currentIndex / indexScale
             let estimatedClaim = BigInt(0);
             let estimatedYield = BigInt(0);
+            
+            if (userShares > BigInt(0) && currentIndex > BigInt(0)) {
+                estimatedClaim = (userShares * currentIndex) / indexScale;
+                if (estimatedClaim > stakeBalanceBN.toBigInt()) {
+                    estimatedYield = estimatedClaim - stakeBalanceBN.toBigInt();
+                }
+            }
 
-            // started work on estimating the user's personal APY - not necessary at the moment
-            // let estimatedAPY: number | null = null;
-            // if (userShares > BigInt(0) && currentIndex > BigInt(0)) {
-            //     estimatedClaim = (userShares * currentIndex) / indexScale;
-            //     if (estimatedClaim > stakeBalanceBN.toBigInt()) {
-            //         estimatedYield = estimatedClaim - stakeBalanceBN.toBigInt();
-            //     }
-
-            //     estimatedAPY = null;
-            // }
 
             const portfolio: Portfolio = {
                 native: {

package/src/networks/ethereum/types.ts

@@ -110,4 +110,19 @@ export interface preLaunchReceipt {
         shares: BalanceView,
         timestamp: string,
     }
+}
+
+export interface ClaimedEvent {
+    sender: string;
+    ethAmount: BigNumber;
+}
+
+
+export interface WithdrawReceipt {
+    tokenId: bigint;
+    receipt: {
+        ethAmount: BigNumber;
+        ethBalance: BalanceView;
+        readyAt: number;
+    }
 }