@wireio/stake 1.1.0 → 1.2.69

package/src/networks/ethereum/ethereum.ts

@@ -8,13 +8,15 @@ import {
     TrancheSnapshot
 } from '../../types';
 import { EthereumContractService } from './contract';
-import { preLaunchReceipt } from './types';
-import { buildEthereumTrancheSnapshot } from './utils';
+import { preLaunchReceipt, WithdrawReceipt } from './types';
+import { buildEthereumTrancheSnapshot, formatContractErrors } from './utils';
 import { ConvertClient } from './clients/convert.client';
+import { EthereumInstaswapClient } from './clients/instaswap.client';
 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,10 +31,12 @@ export class EthereumStakingClient implements IStakingClient {
     private stakeClient: StakeClient;
     private oppClient: OPPClient;
     private receiptClient: ReceiptClient;
-
+    private validatorClient: ValidatorClient;
+    public readonly instaswapClient: EthereumInstaswapClient;
 
     get contract() { return this.contractService.contract; }
     get network() { return this.config.network; }
+    get address() { return this.signer?.getAddress(); }
 
     constructor(private config: StakerConfig) {
         try {
@@ -48,6 +52,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);
@@ -55,6 +60,13 @@ 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);
+            this.instaswapClient = new EthereumInstaswapClient(
+                this.contractService,
+                this.signer,
+                config.network.chainId as number,
+                config.network.rpcUrls[0],
+            );
         }
         catch (error) {
             // console.error('Error initializing EthereumStakingClient:', error);
@@ -91,26 +103,51 @@ export class EthereumStakingClient implements IStakingClient {
     async withdraw(amount: bigint): Promise<string> {
         this.ensureUser();
 
-        const address = await this.signer!.getAddress();
+        const address = await this.address!;
         const amountWei = BigNumber.from(amount);
 
         const result = await this.convertClient.performWithdraw(address, amountWei)
         return result.txHash;
     }
 
+    /**
+     * List withdrawal queue receipts for a wallet (pending / in-progress exits after safeBurn).
+     * @param address  Owner to query; defaults to the connected wallet.
+     * @returns Withdrawal receipt NFT entries from the protocol view
+     */
+    async getPendingWithdraws(address?: string): Promise<WithdrawReceipt[]> {
+        this.ensureUser();
+        const owner = address ?? await this.address!;
+        return await this.receiptClient.fetchWithdrawReceipts(owner);
+    }
+
+    /**
+     * Claim native ETH for a matured withdrawal using the WithdrawalQueue NFT token id
+     * (via DepositManager.claim after the delay has passed).
+     * @param tokenId  Withdrawal request / queue NFT token id
+     * @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.
      * @param amount  Amount in wei - Keep this as a bigint / string in the caller; avoid JS floats.
      * @returns transaction hash
      */
-    async stake(amount: bigint): Promise<string> {
+    async stake(amount: bigint, wireAccount?: string): Promise<string> {
         this.ensureUser();
 
-        const walletAddress = await this.signer!.getAddress();
+        const walletAddress = await this.address!;
         const amountWei = BigNumber.from(amount);
 
-        const result = await this.stakeClient.performStake(amountWei, walletAddress);
+        const result = await this.stakeClient.performStakeToWire(amountWei, walletAddress, wireAccount);
         return result.txHash;
     }
 
@@ -120,6 +157,57 @@ export class EthereumStakingClient implements IStakingClient {
         throw new Error("Method not yet implemented.");
     }
 
+    /**
+     * Deposit ETH to liqETH, then stake the liqETH.
+     * @param amountWei  Amount in wei.
+     * @returns transaction hash
+     */
+    async depositAndStake(amount: bigint, wireAccount?: string): Promise<string> {
+        this.ensureUser();
+        if (!amount || amount <= BigInt(0))
+            throw new Error('Amount must be greater than zero.');
+
+
+        const walletAddress = await this.address!;
+        let amountWei = BigNumber.from(amount);
+
+
+        const result = await this.convertClient.performDeposit(amountWei);
+        console.log('result of performDeposit()', result);
+
+        const result2 = await this.stakeClient.performStakeToWire(amountWei, walletAddress, wireAccount);
+        console.log('result of performStakeToWire()', result2);
+
+        // const result = await this.stakeClient.performDepositAndStakeToWire(BigNumber.from(amountWei), wireAccount);
+        return result2.txHash;
+    }
+
+    /**
+     * Deposit ETH to liqETH, then purchase pretokens in a single transaction.
+     * @param amountWei  Amount in wei.
+     * @returns transaction hash
+     */
+    async depositAndBuy(amountWei: bigint): Promise<string> {
+        this.ensureUser();
+        if (!amountWei || amountWei <= BigInt(0))
+            throw new Error('Amount must be greater than zero.');
+
+        const result = await this.stakeClient.performDepositAndPurchase(BigNumber.from(amountWei));
+        return result.txHash;
+    }
+
+    /**
+     * Unstake liqETH, then request a withdrawal in a single transaction.
+     * @param tokenId  The ReceiptNFT token ID for the stake position
+     * @returns transaction hash
+     */
+    async unstakeAndWithdraw(tokenId: bigint): Promise<string> {
+        this.ensureUser();
+
+        const result = await this.stakeClient.performUnstakeAndRequestWithdraw(BigNumber.from(tokenId));
+        return result.txHash;
+    }
+
 
     /**
      * ETH Prelaunch function to unstake liqEth
@@ -139,19 +227,55 @@ export class EthereumStakingClient implements IStakingClient {
     async buy(amount: bigint): Promise<string> {
         this.ensureUser();
 
-        const buyer = await this.signer!.getAddress();
-
-        // ! Hoodi only - check if the mock aggregator price is stale, and if so, update it before submitting the buy request
-        // const network = await this.provider.getNetwork();
-        // const chainId = network.chainId;
-        // const allowedTestChains = new Set([560048]);
-        // if (allowedTestChains.has(chainId)) await this.updateMockAggregatorPrice();
+        const buyer = await this.address!;
 
         let result = await this.pretokenClient.purchasePretokensWithLiqETH(amount, buyer);
         return result && result.txHash ? result.txHash : "Error - no resulting txHash";
     }
 
 
+    /**
+     * Validator functions
+     */
+    async validatorDeposit(): Promise<string> {
+        this.ensureUser();
+
+        let result = await this.validatorClient.validatorDepositAndLockBond();
+        return result && result.txHash ? result.txHash : "Error - no resulting txHash";
+    }
+    
+
+
+
+
+    // ! Testnet only - check if the mock aggregator price is stale, and if so, update it before submitting the buy request
+    // async crankTestnetAggregator(): Promise<string> {
+    //     this.ensureUser();
+
+    //     const network = await this.provider.getNetwork();
+    //     const chainId = network.chainId;
+    //     const allowedTestChains = new Set([560048, 31337]);
+    //     if (!allowedTestChains.has(chainId)) return "Testnet crank is only intended for test/local networks - current chain is "+chainId+". Skipping aggregator update";
+
+    //     const [agg, opp] = await Promise.allSettled([
+    //         this.updateMockAggregatorPrice(),
+    //         this.fixOppTooManyAttestations(),
+    //     ]);
+
+    //     const fmt = (name: string, r: PromiseSettledResult<unknown>) => {
+    //         if (r.status === 'fulfilled') {
+    //             const suffix = r.value !== undefined ? ` (${String(r.value)})` : '';
+    //             return `${name}: ok${suffix}`;
+    //         }
+    //         return `${name}: failed (${String(r.reason)})`;
+    //     };
+
+    //     console.log('crankTestnetAggregator()', { agg, opp });
+    //     return `${fmt('updateMockAggregatorPrice', agg)}; ${fmt('fixOppTooManyAttestations', opp)}`;
+    // }
+
+
+
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -159,12 +283,12 @@ export class EthereumStakingClient implements IStakingClient {
      * actual  = liqETH token balance (ERC-20)
      * tracked = liqETH tracked balance (protocol/accounting view)
      */
-    async getPortfolio(): Promise<Portfolio | null> {
+    async getPortfolio(address?: string): Promise<Portfolio | null> {
 
         try {
             if (!this.signer) return Promise.resolve(null);
 
-            const walletAddress = await this.signer!.getAddress();
+            const walletAddress = address ?? await this.address!;
 
             // 1) Native ETH balance
             const nativeBalance = await this.provider.getBalance(walletAddress);
@@ -213,17 +337,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: {
@@ -273,7 +394,7 @@ export class EthereumStakingClient implements IStakingClient {
     async fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]> {
         this.ensureUser();
 
-        if (address === undefined) address = await this.signer!.getAddress();
+        if (address === undefined) address = await this.address!;
 
         //default to stake receipts
         return await this.receiptClient.stakeReceipts(address);
@@ -282,11 +403,13 @@ export class EthereumStakingClient implements IStakingClient {
     async getOPPMessages(address?: string): Promise<OPPAssertion[]> {
         this.ensureUser();
 
-        if (!address) address = await this.signer!.getAddress();
+        if (!address) address = await this.address!;
 
         return await this.oppClient.getMessages(address);
     }
 
+
+
     // Ensure that signer wallet is available for write operations
     private ensureUser() {
         if (!this.signer) {
@@ -342,24 +465,11 @@ 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> {
         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),
@@ -377,7 +487,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.
@@ -403,11 +512,7 @@ export class EthereumStakingClient implements IStakingClient {
                 priceGrowthCents,
                 minPriceUsd,
                 maxPriceUsd,
-
                 ethPriceUsd,
-                // nativePriceTimestamp,
-                ladderWindowBefore: windowBefore,
-                ladderWindowAfter: windowAfter,
             });
         }
         catch (err: any) {
@@ -435,7 +540,7 @@ export class EthereumStakingClient implements IStakingClient {
     }): Promise<bigint> {
         this.ensureUser();
 
-        const walletAddress = await this.signer!.getAddress();
+        const walletAddress = await this.address!;
 
         // 1) Estimate a baseline gas usage using a simple self-transfer.
         //    This is cheap and doesn't depend on your contract ABI at all.
@@ -490,50 +595,150 @@ export class EthereumStakingClient implements IStakingClient {
     // Internal ETH Staking client helper functions
     // ---------------------------------------------------------------------
 
-    // ! This is a temporary measure for Hoodi testnet because there is no aggregator deployed
-    // private async updateMockAggregatorPrice() {
-    //     const aggregator = this.contract.MockAggregator;
-
-    //     // read latest round & compute age
-    //     const [roundId, answer, startedAt, updatedAt, answeredInRound] = await aggregator.latestRoundData();
-    //     const now = (await this.provider.getBlock("latest")).timestamp;
-    //     const ageSec = Number(now) - Number(updatedAt);
-
-    //     const ONE_HOUR = 1 * 3600;
-    //     // const ONE_HOUR = 10;
-    //     if (ageSec > ONE_HOUR) {
-    //         // safety check - only run in non-production contexts
-    //         const network = await this.provider.getNetwork();
-    //         const chainId = network.chainId;
-    //         const allowedTestChains = new Set([560048]);
-    //         if (!allowedTestChains.has(chainId)) {
-    //             console.warn(`MockAggregator is stale (${ageSec}s) but chainId ${chainId} is not a test/local network — skipping update.`);
-    //             return;
-    //         }
+    // ! This is a temporary measure for testnet because there is no aggregator deployed
+    /*
+    private async updateMockAggregatorPrice() {
+        const aggregator = this.contract.MockAggregator;
+
+        // read latest round & compute age
+        const [roundId, answer, startedAt, updatedAt, answeredInRound] = await aggregator.latestRoundData();
+        const now = (await this.provider.getBlock("latest")).timestamp;
+        const ageSec = Number(now) - Number(updatedAt);
+
+        const ONE_HOUR = 1 * 3600;
+        // const ONE_HOUR = 10;
+        if (ageSec > ONE_HOUR) {
+            console.log('Attempt to run updateMockAggregatorPrice - MockAggregator price is stale by', ageSec, 'seconds - updating price before proceeding with buy...');
+
+            // safety check - only run in non-production contexts
+            const network = await this.provider.getNetwork();
+            const chainId = network.chainId;
+            const allowedTestChains = new Set([560048, 31337]);
+            if (!allowedTestChains.has(chainId)) {
+                console.warn(`MockAggregator is stale (${ageSec}s) but chainId ${chainId} is not a test/local network — skipping update.`);
+                return;
+            }
 
 
-    //         //fetch the current ETH / USD price
-    //         const res = await fetch('https://api.coingecko.com/api/v3/simple/price?ids=ethereum&vs_currencies=usd');
-    //         const data = await res.json();
-    //         const ethUsd = data.ethereum.usd;
+            //fetch the current ETH / USD price
+            const res = await fetch('https://api.coingecko.com/api/v3/simple/price?ids=ethereum&vs_currencies=usd');
+            const data = await res.json();
+            const ethUsd = data.ethereum.usd;
 
-    //         const currentEthPrice = ethers.utils.parseUnits(ethUsd.toString(), 8);
+            const currentEthPrice = ethers.utils.parseUnits(ethUsd.toString(), 8);
 
-    //         try {
-    //             //update to be intentionally stale
-    //             // const alttx = await aggregator.updateStale(currentEthPrice, now - 7200);
-    //             // const altreceipt = await alttx.wait(1);
-    //             // console.log('stale update receipt', altreceipt)
+            console.log('currentEthPrice', currentEthPrice.toString())
 
-    //             //update answer with current timestamp
-    //             const tx = await aggregator.updateAnswer(currentEthPrice);
-    //             const txreceipt = await tx.wait(1);
-    //             // console.log('MockAggregator answer updated - receipt:', txreceipt)
-    //         } catch (err: any) {
-    //             console.error('MockAggregator updateAnswer failed', err?.message || err);
-    //         }
-    //     } else {
-    //         console.log(`MockAggregator updated ${ageSec}s ago — no update needed`);
-    //     }
-    // }
-}
+            try {
+                //update to be intentionally stale
+                // const alttx = await aggregator.updateStale(currentEthPrice, now - 7200);
+                // const altreceipt = await alttx.wait(1);
+                // console.log('stale update receipt', altreceipt)
+
+                //update answer with current timestamp
+                const tx = await aggregator.updateAnswer(currentEthPrice);
+                const txreceipt = await tx.wait(1);
+                console.log('MockAggregator answer updated - receipt:', txreceipt)
+                return txreceipt
+            } catch (err: any) {
+                console.error('MockAggregator updateAnswer failed', err?.message || err);
+            }
+        } else {
+            console.log(`MockAggregator updated ${ageSec}s ago — no update needed`);
+        }
+    }
+
+
+    private async fixOppTooManyAttestations() {
+        const opp = this.contract.OPP;
+        const outpostManager = this.contract.OutpostManager;
+
+        const [authority, pendingCountRaw, maxRaw, sendModeTagRaw] = await Promise.all([
+            opp.authority(),
+            opp.pendingAttestationCount(),
+            opp.MESSAGE_EPOCH_MAX_ATTESTATIONS(),
+            opp.sendModeTag(),
+        ]);
+
+        const toBigInt = (v: any) => (typeof v === "bigint" ? v : BigInt(v.toString()));
+        const pendingCount = toBigInt(pendingCountRaw);
+        const maxAttestations = toBigInt(maxRaw);
+        const sendModeTag = toBigInt(sendModeTagRaw);
+
+        console.log(`OPP status: authority=${authority}, pendingAttestationCount=${pendingCount}, MESSAGE_EPOCH_MAX_ATTESTATIONS=${maxAttestations}, sendModeTag=${sendModeTag}`);
+        
+        if (sendModeTag === 0n) {
+            console.log("OPP is not in send mode.");
+            // return;
+        }
+
+        const shouldBumpMax = maxAttestations === 1n || pendingCount > maxAttestations;
+        if (!shouldBumpMax) {
+            console.log(
+                `No fix needed: pendingAttestationCount=${pendingCount} <= MESSAGE_EPOCH_MAX_ATTESTATIONS=${maxAttestations}`,
+            );
+            // return;
+        }
+
+        console.log(
+            `OPP bump needed (pending=${pendingCount}, max=${maxAttestations}) — attempting to set new max and ${sendModeTag === 0n ? 'skip' : 'call'} exitSendMode(${sendModeTag})...`
+        );
+
+        console.log(await this.provider.getNetwork());
+
+        
+
+        // safety check to only run in testnet
+        const network = await this.provider.getNetwork();
+        const chainId = toBigInt(network.chainId);
+        const allowedTestChains = new Set<bigint>([560048n, 31337n]);
+        if (!allowedTestChains.has(chainId)) {
+            console.warn(
+            `Refusing to modify OPP config on chainId ${chainId}. Add it to allowedTestChains if this is expected.`
+            );
+            return;
+        }
+
+        // minimal bump bump: set max to pendingCount (or a small default when max was 1) + buffer.
+        const base = pendingCount > 0n ? pendingCount : 1n;
+        // const newMax = base + 2n; // add a small buffer to prevent immediate recurrence
+        const newMax = 1n; // add a small buffer to prevent immediate recurrence
+
+        const encodeOppCall = (fn: string, args: any[]) =>
+            opp.interface.encodeFunctionData(fn, args);
+
+        try {
+            const data = encodeOppCall('setMessageEpochMaxAttestations', [newMax]);
+            await outpostManager.callStatic.execute(opp.address, data);
+            console.log('OutpostManager.execute(callStatic) setMessageEpochMaxAttestations passed');
+        } catch (e) {
+            console.error('OutpostManager.execute(callStatic) setMessageEpochMaxAttestations revert:', e);
+        }
+
+
+        try {
+            const data1 = encodeOppCall('setMessageEpochMaxAttestations', [newMax]);
+            const tx1 = await outpostManager.execute(opp.address, data1, {
+                gasLimit: 500_000,
+            });
+            const receipt1 = await tx1.wait(1);
+            console.log("setMessageEpochMaxAttestations confirmed:", receipt1);
+
+            if (sendModeTag !== 0n) {
+                const data2 = encodeOppCall('exitSendMode', [sendModeTag]);
+                const tx2 = await outpostManager.execute(opp.address, data2, {
+                    gasLimit: 500_000,
+                });
+                const receipt2 = await tx2.wait(1);
+                console.log("exitSendMode confirmed:", receipt2);
+                return { setMaxReceipt: receipt1, exitReceipt: receipt2 };
+            }
+
+            return { setMaxReceipt: receipt1 };
+        } catch (err: any) {
+            let errorObj = formatContractErrors(err);
+            console.error("fixOppTooManyAttestations failed:", err?.message || err, errorObj);
+        }
+    }
+    */
+}

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
@@ -11,7 +11,7 @@ export const CONTRACT_NAMES = [
     "DepositManager",
     "WithdrawalVault",
     "StakingModule",
-    "YieldOracle",
+    // "YieldOracle",
 
     //Outpost contracts
     "OutpostManagerAuthority",
@@ -90,7 +90,17 @@ export interface WithdrawnStakeEvent {
 export interface WithdrawnStakeResult extends Result {
     /** Parsed WithdrawnStake event, if present */
     withdrawnstake?: WithdrawnStakeEvent;
+}
+
+export interface DepositAndStakeResult extends Result {
+    /** Parsed Staked event, if present */
+    staked?: StakedEvent;
+}
+
+export interface DepositAndPurchaseResult extends Result {
+}
 
+export interface UnstakeAndWithdrawResult extends Result {
 }
 
 export interface SharesBurnedEvent {
@@ -99,15 +109,34 @@ 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 {
+    user: string;
+    amount: BigNumber;
+}
+
+// Unified withdraw receipt type is defined centrally in src/types.ts
+export type WithdrawReceipt = UnifiedWithdrawReceipt;
+
+
+
+export interface ValidatorDepositedEvent {
+    sender: string;
+    amount: BigNumber;
+    shares: BigNumber
+}