Merge pull request #210 from lidofinance/add-wrap-unwrap-tests

Tests for wrap/unwrap transactions

.github/workflows/test.yml

@@ -23,7 +23,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     environment: test
     env:
       TEST_BRANCH: ${{ github.event.inputs.branch }}

playwright-tests/pages/components/index.ts

@@ -4,3 +4,4 @@ export * from './wallet-list-modal';
 export * from './wallet-modal';
 export * from './toast';
 export * from './stake-block';
+export * from './wrap-unwrap-block';

playwright-tests/pages/components/stats.ts

@@ -1,4 +1,6 @@
 import { Locator, Page } from '@playwright/test';
+import { TIMEOUT } from '@test-data';
+import { waitForCallback } from '@services';
 
 export class StatsBlock {
   page: Page;
@@ -22,4 +24,43 @@ export class StatsBlock {
     this.wstethBalance = this.mainComponent.getByTestId('wstETH');
     this.amountInput = this.mainComponent.getByTestId('amountInput');
   }
+
+  async getEthBalance() {
+    return await waitForCallback(
+      async (locator: Locator) => {
+        return await locator.evaluate((element) => {
+          const balance = parseFloat(element.textContent);
+          return balance || balance == 0 ? String(balance) : null;
+        });
+      },
+      this.ethBalance,
+      TIMEOUT.RPC_WAIT,
+    );
+  }
+
+  async getStEthBalance() {
+    return await waitForCallback(
+      async (locator: Locator) => {
+        return await locator.evaluate((element) => {
+          const balance = parseFloat(element.textContent);
+          return balance || balance == 0 ? String(balance) : null;
+        });
+      },
+      this.stethBalance,
+      TIMEOUT.RPC_WAIT,
+    );
+  }
+
+  async getWstEthBalance() {
+    return await waitForCallback(
+      async (locator: Locator) => {
+        return await locator.evaluate((element) => {
+          const balance = parseFloat(element.textContent);
+          return balance || balance == 0 ? String(balance) : null;
+        });
+      },
+      this.wstethBalance,
+      TIMEOUT.RPC_WAIT,
+    );
+  }
 }

playwright-tests/pages/components/wrap-unwrap-block.ts

@@ -0,0 +1,49 @@
+import { Locator, Page, test } from '@playwright/test';
+
+export class WrapUnwrapBlock {
+  page: Page;
+  mainComponent: Locator;
+  wrapBtn: Locator;
+  unwrapBtn: Locator;
+  txTypeSelector: Locator;
+
+  constructor(page: Page) {
+    this.page = page;
+    this.mainComponent = this.page
+      .getByTestId('WrapBlock')
+      .or(this.page.getByTestId('UnwrapBlock'));
+    this.wrapBtn = this.mainComponent.locator('button :has-text("Wrap")');
+    this.unwrapBtn = this.mainComponent.locator('button :has-text("Unwrap")');
+    this.txTypeSelector = this.mainComponent.locator('label');
+  }
+
+  async selectWrapEthTxType() {
+    await test.step('Select the Wrap ETH tx type', async () => {
+      await this.txTypeSelector.click();
+      await this.page
+        .locator('id=lido-ui-modal-root')
+        .locator('button', { hasText: 'Wrap ETH' })
+        .click();
+    });
+  }
+
+  async selectWrapStEthTxType() {
+    await test.step('Select the Wrap stETH tx type', async () => {
+      await this.txTypeSelector.click();
+      await this.page
+        .locator('id=lido-ui-modal-root')
+        .locator('button', { hasText: 'Wrap stETH' })
+        .click();
+    });
+  }
+
+  async selectUnwrapTxType() {
+    await test.step('Select the Unwrap tx type', async () => {
+      await this.txTypeSelector.click();
+      await this.page
+        .locator('id=lido-ui-modal-root')
+        .locator('button', { hasText: 'Unwrap' })
+        .click();
+    });
+  }
+}

playwright-tests/pages/reefKnot.page.ts

@@ -5,17 +5,18 @@ import {
   WalletModal,
   StakeBlock,
   Toast,
+  WrapUnwrapBlock,
 } from './components';
-import { Locator, Page, test } from '@playwright/test';
+import { Page, test } from '@playwright/test';
 import { TIMEOUT } from '@test-data';
-import { waitForCallback } from '@services';
 
 export class ReefKnotPage {
   readonly page: Page;
   header: Header;
   walletModal: WalletModal;
   statsBlock: StatsBlock;
   stakeBlock: StakeBlock;
+  wrapUnwrapBlock: WrapUnwrapBlock;
   walletListModal: WalletListModal;
   toast: Toast;
 
@@ -25,6 +26,7 @@ export class ReefKnotPage {
     this.walletModal = new WalletModal(this.page);
     this.statsBlock = new StatsBlock(this.page);
     this.stakeBlock = new StakeBlock(this.page);
+    this.wrapUnwrapBlock = new WrapUnwrapBlock(this.page);
     this.walletListModal = new WalletListModal(this.page);
     this.toast = new Toast(this.page);
   }
@@ -76,16 +78,19 @@ export class ReefKnotPage {
     return txPage;
   }
 
-  async waitForBalance(locator: Locator, timeout = TIMEOUT.RPC_WAIT) {
-    return await waitForCallback(
-      async (locator: Locator) => {
-        return await locator.evaluate((element) => {
-          const balance = parseFloat(element.textContent);
-          return balance ? String(balance) : null;
-        });
-      },
-      locator,
-      timeout,
-    );
+  async clickWrapButton() {
+    const [txPage] = await Promise.all([
+      this.waitForPage(TIMEOUT.RPC_WAIT),
+      this.wrapUnwrapBlock.wrapBtn.click(),
+    ]);
+    return txPage;
+  }
+
+  async clickUnwrapButton() {
+    const [txPage] = await Promise.all([
+      this.waitForPage(TIMEOUT.RPC_WAIT),
+      this.wrapUnwrapBlock.unwrapBtn.click(),
+    ]);
+    return txPage;
   }
 }

playwright-tests/playwright.config.ts

@@ -9,7 +9,7 @@ const config: PlaywrightTestConfig = {
   },
   fullyParallel: false,
   forbidOnly: !!process.env.CI,
-  retries: 1,
+  retries: process.env.CI ? 1 : 0,
   workers: 1,
   reporter: getReportConfig(),
   use: {

playwright-tests/services/helpers.ts

@@ -3,16 +3,22 @@
  *
  * Example:
  * ```ts
- * 0.12345 => toCut('0.12345', 3) => '0.123'
+ * 0.12345 => toСutDecimalsDigit('0.12345', 3) => '0.123'
+ * 0.101 => toСutDecimalsDigit('0.101', 2, true) => '0.1'
  * ```
  */
-export function toCut(floatAmount: string, decimalPlaces: number) {
-  const result = floatAmount.split(/\./);
+export function toCutDecimalsDigit(
+  amount: any,
+  decimalPlaces: number,
+  removeZero = false,
+) {
+  const parts = String(amount).split(/\./);
   let respLength: number;
-  if (result.length === 2) {
-    respLength = result[0].length + 1 + decimalPlaces;
+  if (parts.length === 2) {
+    respLength = parts[0].length + 1 + decimalPlaces;
   }
-  return floatAmount.slice(0, respLength);
+  const response = String(amount).slice(0, respLength);
+  return removeZero ? String(parseFloat(response)) : response;
 }
 
 /**

playwright-tests/services/sdk.service.ts

@@ -1,8 +1,8 @@
 import { LidoSDK, VIEM_CHAINS } from '@lidofinance/lido-ethereum-sdk';
 import { HDAccount } from 'viem/accounts';
-import { createWalletClient, formatEther, http } from 'viem';
+import { createWalletClient, formatEther, http, type Address } from 'viem';
 import { REEF_KNOT_CONFIG } from '@config';
-import { toCut } from './helpers';
+import { toCutDecimalsDigit } from './helpers';
 
 global.fetch = fetch;
 
@@ -26,6 +26,14 @@ export class SdkService extends LidoSDK {
     });
   }
 
+  /**
+   Get token balance from SDK without 0 in the end of number
+   Example:
+   ```ts
+   // ETH balance = 1.102
+   getBalanceByToken(stdToken.ETH, 2) => '1.1'
+   ```
+   */
   async getBalanceByToken(token: sdkToken, decimalPlaces: number) {
     let balance: string;
     switch (token) {
@@ -39,6 +47,30 @@ export class SdkService extends LidoSDK {
         balance = formatEther(await this.wsteth.balance());
         break;
     }
-    return toCut(balance, decimalPlaces);
+    return toCutDecimalsDigit(balance, decimalPlaces, true);
+  }
+
+  async exchangeStEthToWstEth(amount: any) {
+    const wstethRate = formatEther(
+      await this.wrap.convertStethToWsteth(1000000000000000000n),
+    );
+    return parseFloat(wstethRate) * parseFloat(amount);
+  }
+
+  async exchangeWstEthToStEth(amount: any) {
+    const wstethRate = formatEther(
+      await this.wrap.convertWstethToSteth(1000000000000000000n),
+    );
+    return parseFloat(wstethRate) * parseFloat(amount);
+  }
+
+  async getStEthAllowance() {
+    return parseFloat(
+      formatEther(
+        await this.steth.allowance({
+          to: REEF_KNOT_CONFIG.STAND_CONFIG.contracts.wrap as Address,
+        }),
+      ),
+    );
   }
 }

playwright-tests/test-data/matomo.data.ts

@@ -52,8 +52,8 @@ export const CONFIG_MATOMO_CLICK_TO_WALLET_EVENTS = [
     walletName: 'imToken',
   },
   {
-    eventMessage: 'xdefi clicked',
-    walletName: 'XDEFI',
+    eventMessage: 'ctrl clicked',
+    walletName: 'Ctrl',
   },
   {
     eventMessage: 'binanceWallet clicked',

playwright-tests/tests/stake-tx.spec.ts → playwright-tests/tests/transactions/stake-tx.spec.ts

@@ -1,7 +1,7 @@
 import { expect, test } from '@playwright/test';
 import { Tags, TIMEOUT } from '@test-data';
 import { BrowserService, initBrowserWithWallet } from '@browser';
-import { ReefKnotService, toCut } from '@services';
+import { ReefKnotService, toCutDecimalsDigit } from '@services';
 import { ReefKnotPage } from '@pages';
 import { qase } from 'playwright-qase-reporter';
 import { REEF_KNOT_CONFIG } from '@config';
@@ -31,20 +31,18 @@ REEF_KNOT_CONFIG.WALLETS.forEach((wallet) => {
         await browserService.teardown();
       });
 
-      test(`Stake ${stakeAmount} ETH`, async () => {
+      test(qase(444, `Stake ${stakeAmount} ETH`), async () => {
         await qase.groupParameters({
           wallet: wallet.name,
           txAmount: stakeAmount,
         });
 
         const newStEthBalance =
           await test.step('Calculate the stETH amount result', async () => {
-            const stEthBalance = parseFloat(
-              await reefKnotPage.waitForBalance(
-                reefKnotPage.statsBlock.stethBalance,
-              ),
-            );
-            return toCut(String(stEthBalance + parseFloat(stakeAmount)), 4);
+            const stethResult =
+              parseFloat(await reefKnotPage.statsBlock.getStEthBalance()) +
+              parseFloat(stakeAmount);
+            return toCutDecimalsDigit(stethResult, 4);
           });
 
         const txPage =