@wireio/stake 1.0.1 → 2.0.0

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';
@@ -48,6 +48,7 @@ export class EthereumStakingClient implements IStakingClient {
             this.contractService = new EthereumContractService({
                 provider: this.provider,
                 signer: this.signer,
+                chainId: config.network.chainId as EvmChainID,
             });
 
             this.convertClient = new ConvertClient(this.contractService);
@@ -98,6 +99,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 tokenId  The ID of the withdrawal request NFT
+     * @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.
@@ -160,100 +186,106 @@ export class EthereumStakingClient implements IStakingClient {
      * tracked = liqETH tracked balance (protocol/accounting view)
      */
     async getPortfolio(): Promise<Portfolio | null> {
-        if (!this.signer) return Promise.resolve(null);
 
-        const walletAddress = await this.signer!.getAddress();
+        try {
+            if (!this.signer) return Promise.resolve(null);
 
-        // 1) Native ETH balance
-        const nativeBalance = await this.provider.getBalance(walletAddress);
-        const nativeDecimals = this.network?.nativeCurrency?.decimals ?? 18;
-        const nativeSymbol = this.network?.nativeCurrency?.symbol ?? 'ETH';
+            const walletAddress = await this.signer!.getAddress();
 
-        // 2) liqETH ERC-20 balance (actual)
-        const liqBalance: ethers.BigNumber = await this.contract.LiqEthToken.balanceOf(walletAddress);
-        const liqSymbol = 'Liq' + (this.network?.nativeCurrency?.symbol ?? 'ETH');
+            // 1) Native ETH balance
+            const nativeBalance = await this.provider.getBalance(walletAddress);
+            const nativeDecimals = this.network?.nativeCurrency?.decimals ?? 18;
+            const nativeSymbol = this.network?.nativeCurrency?.symbol ?? 'ETH';
 
-        // 3) staked liqEth ERC-20 balance (calculate from receipts)
-        let stakeReceipts = await this.receiptClient.stakeReceipts(walletAddress);
-        let stakeBalanceBN = BigNumber.from(0);
-        for (let r of stakeReceipts) {
-            stakeBalanceBN = stakeBalanceBN.add(BigNumber.from(r.receipt.principal.amount));
-        }
-        let stakeSharesBN = BigNumber.from(0);
-        for (let r of stakeReceipts) {
-            stakeSharesBN = stakeSharesBN.add(BigNumber.from(r.receipt.shares.amount));
-        }
+            // 2) liqETH ERC-20 balance (actual)
+            const liqBalance: ethers.BigNumber = await this.contract.LiqEthToken.balanceOf(walletAddress);
+            const liqSymbol = 'Liq' + (this.network?.nativeCurrency?.symbol ?? 'ETH');
+
+            // 3) staked liqEth ERC-20 balance (calculate from receipts)
+            let stakeReceipts = await this.receiptClient.stakeReceipts(walletAddress);
 
-        // 4) WIRE pretoken balance
-        const wireBalance: ethers.BigNumber = await this.contract.Pretoken.balanceOf(walletAddress);
+            let stakeBalanceBN = BigNumber.from(0);
+            for (let r of stakeReceipts) {
+                stakeBalanceBN = stakeBalanceBN.add(BigNumber.from(r.receipt.principal.amount));
+            }
+            let stakeSharesBN = BigNumber.from(0);
+            for (let r of stakeReceipts) {
+                stakeSharesBN = stakeSharesBN.add(BigNumber.from(r.receipt.shares.amount));
+            }
 
+            // 4) WIRE pretoken balance
+            const wireBalance: ethers.BigNumber = await this.contract.Pretoken.balanceOf(walletAddress);
+
+            // 5) Calculate staking yield 
+            let currentIndex = BigInt(0);
+            let totalShares = BigInt(0);
+            let userShares = BigInt(0);
+            const indexScale = BigInt(1e27);
+            try {
+                // These may throw if not implemented on contract
+                const [indexBn, totalSharesBn] = await Promise.all([
+                    this.contract.Depositor.index().catch(() => BigNumber.from(0)),
+                    this.contract.Depositor.totalShares().catch(() => BigNumber.from(0)),
+                ]);
+
+                const userSharesBn = stakeSharesBN;
+                currentIndex = BigInt(indexBn.toString());
+                totalShares = BigInt(totalSharesBn.toString());
+                userShares = BigInt(userSharesBn.toString());
+            } catch (error) {
+                console.log('Error fetching staking index/shares:', error);
+            }
+
+            // 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();
+                }
+            }
 
-        // 5) Calculate staking yield 
-        let currentIndex = BigInt(0);
-        let totalShares = BigInt(0);
-        let userShares = BigInt(0);
-        const indexScale = BigInt(1e27);
-        try {
-            // These may throw if not implemented on contract
-            const [indexBn, totalSharesBn] = await Promise.all([
-                this.contract.Depositor.index().catch(() => BigNumber.from(0)),
-                this.contract.Depositor.totalShares().catch(() => BigNumber.from(0)),
-            ]);
 
-            const userSharesBn = stakeSharesBN;
-            currentIndex = BigInt(indexBn.toString());
-            totalShares = BigInt(totalSharesBn.toString());
-            userShares = BigInt(userSharesBn.toString());
-        } catch { }
-
-        // sharesToTokens(userShares, currentIndex) = userShares * currentIndex / indexScale
-        let estimatedClaim = BigInt(0);
-        let estimatedYield = BigInt(0);
-
-        // 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: {
-                amount: nativeBalance.toBigInt(),
-                decimals: nativeDecimals,
-                symbol: nativeSymbol,
-            },
-            liq: {
-                amount: liqBalance.toBigInt(),
-                decimals: nativeDecimals,
-                symbol: liqSymbol,
-            },
-            staked: {
-                amount: stakeBalanceBN.toBigInt(),
-                decimals: nativeDecimals,
-                symbol: liqSymbol,
-            },
-            wire: {
-                amount: wireBalance.toBigInt(),
-                decimals: 18,
-                symbol: '$WIRE',
-            },
-
-            yield: {
-                currentIndex,
-                indexScale,
-                totalShares,
-                userShares,
-                estimatedClaim,
-                estimatedYield,
-            },
-            chainID: this.network.chainId
+            const portfolio: Portfolio = {
+                native: {
+                    amount: nativeBalance.toBigInt(),
+                    decimals: nativeDecimals,
+                    symbol: nativeSymbol,
+                },
+                liq: {
+                    amount: liqBalance.toBigInt(),
+                    decimals: nativeDecimals,
+                    symbol: liqSymbol,
+                },
+                staked: {
+                    amount: stakeBalanceBN.toBigInt(),
+                    decimals: nativeDecimals,
+                    symbol: liqSymbol,
+                },
+                wire: {
+                    amount: wireBalance.toBigInt(),
+                    decimals: 18,
+                    symbol: '$WIRE',
+                },
+
+                yield: {
+                    currentIndex,
+                    indexScale,
+                    totalShares,
+                    userShares,
+                    estimatedClaim,
+                    estimatedYield,
+                },
+                chainID: this.network.chainId
+            }
+            return portfolio;
+        }
+        catch (error) {
+            // console.log('Error fetching Ethereum portfolio:', error);
+            throw error;
         }
-        return portfolio;
     }
 
     /**
@@ -333,24 +365,14 @@ export class EthereumStakingClient implements IStakingClient {
      * 
      * SUPPORTS READ-ONLY ACcESS
      */
-    async getTrancheSnapshot(options?: {
-        chainID?: ChainID;
-        windowBefore?: number;
-        windowAfter?: number;
-    }): Promise<TrancheSnapshot> {
-        const {
-            chainID = EvmChainID.Ethereum,
-            windowBefore,
-            windowAfter,
-        } = options ?? {};
+    async getTrancheSnapshot(chainID: ChainID): Promise<TrancheSnapshot> {
 
+        console.log('getTrancheSnapshot', chainID);
 
         try {
-
             const blockNumber = await this.provider.getBlockNumber();
             const blockTag = { blockTag: blockNumber };
 
-
             // Fetch all required contract data
             const [totalSharesBn, indexBn, trancheNumberBn, trancheSupplyBn, tranchePriceUsdBn, totalSupplyBn, supplyGrowthBps, priceGrowthCents, minPriceUsd, maxPriceUsd] = await Promise.all([
                 this.contract.Depositor.totalShares(blockTag),
@@ -368,7 +390,6 @@ export class EthereumStakingClient implements IStakingClient {
             const totalTrancheSupply = BigInt(totalSupplyBn.toString()) / BigInt(1e10);
             const currentTrancheSupply = BigInt(trancheSupplyBn.toString()) / BigInt(1e10);
 
-
             // fetch price and timestamp from aggregator
             // const [roundId, answer, startedAt, updatedAt, answeredInRound] = await this.contract.MockAggregator.latestRoundData();
             //originally fetched ethPrice from aggregator - pulling from EthUsdPriceConsumer instead - this is where the actual price gets pulled from when purchasing pretokens.
@@ -394,11 +415,7 @@ export class EthereumStakingClient implements IStakingClient {
                 priceGrowthCents,
                 minPriceUsd,
                 maxPriceUsd,
-
                 ethPriceUsd,
-                // nativePriceTimestamp,
-                ladderWindowBefore: windowBefore,
-                ladderWindowAfter: windowAfter,
             });
         }
         catch (err: any) {
@@ -422,7 +439,7 @@ export class EthereumStakingClient implements IStakingClient {
         txCount?: number;
         safetyMultiplier?: number;
         minBufferWei?: bigint;
-        balanceOverrideLamports?: bigint; 
+        balanceOverrideLamports?: bigint;
     }): Promise<bigint> {
         this.ensureUser();
 

package/src/networks/ethereum/types.ts

@@ -11,7 +11,7 @@ export const CONTRACT_NAMES = [
     "DepositManager",
     "WithdrawalVault",
     "StakingModule",
-    "YieldOracle",
+    // "YieldOracle",
 
     //Outpost contracts
     "OutpostManagerAuthority",
@@ -29,7 +29,7 @@ export const CONTRACT_NAMES = [
     "Pretoken",
     "OPPInbound",
     "Depositor",
-    // "MockAggregator",
+    "MockAggregator",
 ] as const;
 
 export type ContractName = typeof CONTRACT_NAMES[number];
@@ -110,4 +110,19 @@ export interface preLaunchReceipt {
         shares: BalanceView,
         timestamp: string,
     }
+}
+
+export interface ClaimedEvent {
+    user: string;
+    amount: BigNumber;
+}
+
+
+export interface WithdrawReceipt {
+    tokenId: bigint;
+    receipt: {
+        ethAmount: BigNumber;
+        ethBalance: BalanceView;
+        readyAt: number;
+    }
 }