@wireio/stake 0.2.0 → 0.2.2

package/src/networks/ethereum/ethereum.ts

@@ -1,8 +1,12 @@
-import { BigNumber, BigNumberish, ethers } from 'ethers';
+import { BigNumber, ethers } from 'ethers';
 import { IStakingClient, Portfolio, StakerConfig } from '../../staker/types';
 import { PublicKey as WirePubKey } from '@wireio/core';
-import { ERC20Abi, EthereumContractService } from './contract'; // TODO replace with staking contract ABI
-import { DepositEvent, DepositResult } from './types';
+import { EthereumContractService } from './contract';
+import { preLaunchReceipt, WithdrawRequestedEvent, WithdrawResult } from './types';
+import { DepositClient } from './clients/deposit.client';
+import { StakeClient } from './clients/stake.client';
+
+
 
 export class EthereumStakingClient implements IStakingClient {
     public readonly pubKey: WirePubKey;
@@ -10,6 +14,9 @@ export class EthereumStakingClient implements IStakingClient {
     private readonly signer: ethers.Signer;
     private readonly contractService: EthereumContractService;
 
+    private depositClient: DepositClient;
+    private stakeClient: StakeClient;
+
     get contract() { return this.contractService.contract; }
     get network() { return this.config.network; }
 
@@ -23,6 +30,8 @@ export class EthereumStakingClient implements IStakingClient {
                 provider: this.provider,
                 signer: this.signer,
             });
+            this.depositClient = new DepositClient(this.contractService);
+            this.stakeClient = new StakeClient(this.contractService);
         }   
         catch (error) {
             // console.error('Error initializing EthereumStakingClient:', error);
@@ -45,25 +54,67 @@ export class EthereumStakingClient implements IStakingClient {
             ? amount
             : BigNumber.from(amount);
 
-        const result = await this.performDeposit(amountWei);
+        const result = await this.depositClient.performDeposit(amountWei);
         return result.txHash;
     }
 
-    // TODO
-    async withdraw(): Promise<string> {
-        throw new Error("Method not yet implemented.");
+
+    // TODO - In progress
+    async withdraw(amount: number | string | bigint | BigNumber): Promise<string> {
+        const amountWei = BigNumber.isBigNumber(amount)
+            ? amount
+            : BigNumber.from(amount);
+
+        const result = await this.requestWithdraw(amountWei);
+        return result.txHash;
     }
 
-    // TODO
-    async stake(): Promise<string> {
-        throw new Error("Method not yet implemented.");
+
+    // TODO - In progress
+    async stake(amount: bigint): Promise<string> {
+        const walletAddress = await this.signer.getAddress();
+        const amountWei = BigNumber.from(amount);
+
+        const result = await this.stakeClient.performStake(amountWei, walletAddress);
+        return result.txHash;
     }
 
+
     // TODO
     async unstake(): Promise<string> {
         throw new Error("Method not yet implemented.");
     }
 
+    // TODO
+    async unstakePrelaunch(tokenId: bigint, recipient: string): Promise<string> {
+        const tokenIdBigNum = BigNumber.from(tokenId)
+        const result = await this.stakeClient.performWithdrawStake(tokenIdBigNum, recipient);
+        return result.txHash;
+    }
+
+
+    async fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]> {
+        if(address === undefined) address = await this.signer.getAddress();
+        
+        let receipts = await this.stakeClient.fetchPreLaunchReceipts(address);
+        return receipts
+    }
+
+    
+    
+    async getEthStats(): Promise<any> {
+        let withdrawDelay = await this.contract.DepositManager.withdrawDelay();
+        let minDeposit = await this.contract.DepositManager.minDeposit();
+        let rewardCooldown = await this.contract.DepositManager.rewardCooldown();
+
+        return {
+            withdrawDelay,
+            minDeposit,
+            rewardCooldown,
+        }
+    }
+
+    
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -74,21 +125,21 @@ export class EthereumStakingClient implements IStakingClient {
     async getPortfolio(): Promise<Portfolio> {
         const walletAddress = await this.signer.getAddress();
         // console.log('getPortfolio() wallet address', walletAddress)
+
+
         // 1) Native ETH balance
         const nativeBalance = await this.provider.getBalance(walletAddress);
-        // console.log('nativeBalance', nativeBalance);
         const nativeDecimals = this.network?.nativeCurrency?.decimals ?? 18;
         const nativeSymbol = this.network?.nativeCurrency?.symbol ?? 'ETH';
 
-        
-
         // 2) liqETH ERC-20 balance (actual)
         const liqBalance: ethers.BigNumber = await this.contract.LiqEth.balanceOf(walletAddress);
-        // console.log('liqBalance', liqBalance);
-        
-        const liqDecimals = this.network?.nativeCurrency?.decimals ?? 18;
         const liqSymbol = 'Liq' + (this.network?.nativeCurrency?.symbol ?? 'ETH');
 
+        // 3) staked liqEth ERC-20 balance (actual)
+        const stakedLiqBalance = await this.contract.Depositor.sharesOf(walletAddress);
+
+
         const portfolio: Portfolio = {
             native: {
                 amount: nativeBalance.toBigInt(),
@@ -97,17 +148,17 @@ export class EthereumStakingClient implements IStakingClient {
             },
             liq: {
                 amount: liqBalance.toBigInt(),
-                decimals: liqDecimals,
+                decimals: nativeDecimals,
                 symbol: liqSymbol,
             },
             tracked: {
                 amount: liqBalance.toBigInt(),
-                decimals: liqDecimals,
+                decimals: nativeDecimals,
                 symbol: liqSymbol,
             },
-            staked: { // TODO fetch staked balance from outpost
-                amount: BigNumber.from(0).toBigInt(),
-                decimals: liqDecimals,
+            staked: {
+                amount: stakedLiqBalance.toBigInt(),
+                decimals: nativeDecimals,
                 symbol: liqSymbol,
             },
             chainID: this.network.chainId
@@ -121,63 +172,76 @@ export class EthereumStakingClient implements IStakingClient {
     // Internal ETH Staking client helper functions
     // ---------------------------------------------------------------------
 
-    /**
-     * Simulate a deposit via callStatic.
-     *
-     * Useful for pre-flight checks; will throw with the same revert
-     * reason as a real tx if it would fail.
-     */
-    async simulateDeposit(amount: number | string | bigint | BigNumber): Promise<void> {
-        const amountWei = BigNumber.isBigNumber(amount)
-            ? amount
-            : BigNumber.from(amount);
-
-        // callStatic executes the function locally without sending a tx.
-        // deposit() doesn't return anything, so we only care if it reverts.
-        await this.contract.DepositManager.callStatic.deposit({
-            value: amountWei,
-        });
-    }
-
-    private async performDeposit(amountWei: BigNumber): Promise<DepositResult> {
-        // Pre-check minDeposit
-        const minDeposit: BigNumber = await this.contract.DepositManager.minDeposit();
-        if (amountWei.lt(minDeposit)) {
-            throw new Error(
-                `Deposit amount below minDeposit: ` +
-                `amount=${ethers.utils.formatEther(amountWei)} ETH, ` +
-                `min=${ethers.utils.formatEther(minDeposit)} ETH`
-            );
-        }
-
-        // Send the payable tx
-        const tx = await this.contract.DepositManager.deposit({
+    private async requestWithdraw(amountWei: BigNumber): Promise<WithdrawResult> {
+        // deadline is a period of time in the future that the signature is valid for
+        const deadline = Math.floor(Date.now() / 1000) + 3600;
+        const liqEth = this.contract.LiqEth;
+        const owner = await this.signer.getAddress();
+        const liqEthAddress = this.contractService.getAddress('LiqEth');
+
+        const nonce: BigNumber = await liqEth.nonces(owner);
+        const chainId = this.network?.chainId ?? (await this.provider.getNetwork()).chainId;
+        const domain = {
+            name: await liqEth.name(),
+            version: '1',
+            chainId,
+            verifyingContract: liqEthAddress,
+        } as any;
+
+        const types = {
+            Permit: [
+                { name: 'owner', type: 'address' },
+                { name: 'spender', type: 'address' },
+                { name: 'value', type: 'uint256' },
+                { name: 'nonce', type: 'uint256' },
+                { name: 'deadline', type: 'uint256' },
+            ],
+        } as any;
+
+        const values = {
+            owner,
+            spender: this.contractService.getAddress('DepositManager'),
             value: amountWei,
-        });
-
-        // Wait for 1 confirmation 
+            nonce: nonce,
+            deadline,
+        } as any;
+
+        const signature = await (this.signer as any)._signTypedData(domain, types, values);
+        const split = ethers.utils.splitSignature(signature);
+
+        const tx = await this.contract.DepositManager.requestWithdrawal(
+            amountWei,
+            deadline,
+            split.v,
+            split.r,
+            split.s
+        );
+
+        // wait for 1 confirmation
         const receipt = await tx.wait(1);
 
-        // Parse Deposited event if present
-        let deposited: DepositEvent | undefined;
-        const ev = receipt.events?.find((e) => e.event === 'Deposited');
+        // if WithdrawRequested event exists, parse it and get arguments
+        let withdrawRequested: WithdrawRequestedEvent | undefined;
+        const ev = receipt.events?.find((e) => e.event === 'WithdrawRequested');
 
         if (ev && ev.args) {
-            const { user, netEth, fee, shares } = ev.args;
-            deposited = {
+            const { user, ethAmount, nftId, readyAt } = ev.args;
+            withdrawRequested = {
                 user,
-                netEth: BigNumber.from(netEth),
-                fee: BigNumber.from(fee),
-                shares: BigNumber.from(shares),
+                ethAmount: BigNumber.from(ethAmount),
+                nftId: BigNumber.from(nftId),
+                readyAt: readyAt,
             };
         }
 
         return {
             txHash: tx.hash,
             receipt,
-            deposited,
-        };
+            withdrawRequested,
+        } as WithdrawResult;
     }
 
-    // TODO: implement withdraw, claimRewards, etc.
+
+
+    // TODO: implement claimRewards, etc.
 }

package/src/networks/ethereum/types.ts

@@ -1,22 +1,43 @@
 import { BigNumber, ethers } from 'ethers';
+import { BalanceView } from '../../staker/types';
 
 export const CONTRACT_NAMES = [
     'Accounting',
     'DepositManager',
     'LiqEth',
-    'LiqEthBurn',
-    'LiqEthMint',
+    // 'LiqEthBurn',
+    // 'LiqEthMint',
     // 'RewardsERC20',
     'StakingModule',
     // 'ValidatorBalance',
     'WithdrawalQueue',
     'WithdrawalVault',
     // 'Yield',
+
+    //Outpost contracts
+    'Depositor',
+    'ReceiptNFT',
+    'OutpostManager',
+    'BAR',
+    'OPP',
+    'OPPCommon',
+    'OPPInbound',
+    'Warrant',
+
 ] as const;
 
 export type ContractName = typeof CONTRACT_NAMES[number];
 export type AddressBook  = Record<ContractName, string>;
 
+
+interface Result {
+    /** EVM transaction hash */
+    txHash: string;
+    /** Full receipt, if you want it */
+    receipt: ethers.providers.TransactionReceipt;
+}
+
+
 export interface DepositEvent {
     user: string;
     netEth: BigNumber;
@@ -24,11 +45,57 @@ export interface DepositEvent {
     shares: BigNumber;
 }
 
-export interface DepositResult {
-    /** EVM transaction hash */
-    txHash: string;
-    /** Full receipt, if you want it */
-    receipt: ethers.providers.TransactionReceipt;
+export interface DepositResult extends Result {
     /** Parsed Deposited event, if present */
     deposited?: DepositEvent;
+}
+
+export interface WithdrawRequestedEvent {
+    user: string;
+    ethAmount: BigNumber;
+    nftId: BigNumber;
+    readyAt: string;
+}
+
+export interface WithdrawResult extends Result {
+    /** Parsed WithdrawRequested event, if present */
+    withdrawRequested?: WithdrawRequestedEvent;
+}
+
+
+export interface StakedEvent {
+    user: string;
+    amountLiq: BigNumber;
+    shares: BigNumber;
+    tokenId: BigNumber;
+}
+
+export interface StakedResult extends Result {
+    /** Parsed Staked event, if present */
+    staked?: StakedEvent;
+}
+
+
+export interface WithdrawnStakeEvent {
+    user: string;
+    tokenId: BigNumber;
+    tokenOut: BigNumber;
+}
+export interface WithdrawnStakeResult extends Result {
+    /** Parsed WithdrawnStake event, if present */
+    withdrawnstake?: WithdrawnStakeEvent;
+
+}
+
+export interface preLaunchReceipt {
+    tokenId: bigint;
+    receipt: {
+        account: string,
+        currency: number,
+        kind: number,
+        indexAtMint: BalanceView,
+        principal: BalanceView,
+        shares: BalanceView,
+        timestamp: string,
+    }
 }

package/src/assets/ethereum/ABI/liqEth/LiqEthCommon.sol/ILiqEthBurn.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/d79f4e283230a26eb6886de970dd65fb.json"
-}

package/src/assets/ethereum/ABI/liqEth/LiqEthCommon.sol/ILiqEthBurn.json

@@ -1,24 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "ILiqEthBurn",
-  "sourceName": "contracts/liqEth/LiqEthCommon.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "uint256",
-          "name": "amount",
-          "type": "uint256"
-        }
-      ],
-      "name": "burn",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/liqEth/LiqEthCommon.sol/ILiqEthMint.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/d79f4e283230a26eb6886de970dd65fb.json"
-}

package/src/assets/ethereum/ABI/liqEth/liqEthBurn.sol/LiqEthBurn.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/d79f4e283230a26eb6886de970dd65fb.json"
-}