feat: improve erc deposit error (#170)

* feat: improve erc20 deposit error message * test: error message * fix: partially fix test * refactor: move faucet tkn step back to where it was * refactor: move deposit tkn before eth test * chore: remove unnecessary test code * ci: fix socket hangup * test: remove flaky loading checks * fix: test * Update packages/app/playwright/e2e/Bridge.test.ts Co-authored-by: Luiz Gomes - LuizAsFight.eth <[email protected]> * Update packages/app/src/systems/Chains/eth/services/txEthToFuel.ts Co-authored-by: Luiz Gomes - LuizAsFight.eth <[email protected]> * chore: lint * fix: test * fix: test to work for multiple runs * fix: wallet connect --------- Co-authored-by: Luiz Gomes - LuizAsFight.eth <[email protected]>
FuelLabs · Oct 26, 2023 · 6a773a8 · 6a773a8
1 parent 6c46cf2
commit 6a773a8
Show file tree

Hide file tree

Showing 3 changed files with 106 additions and 23 deletions.
diff --git a/packages/app/playwright/commons/fuelWallet.ts b/packages/app/playwright/commons/fuelWallet.ts
@@ -115,15 +115,13 @@ export async function walletConnect(
     await disconnectCurrenctAccountButton.click();
   }
 
-  await Promise.all(
-    accountNames.map(async (accountName) => {
-      const accountConnectionButton = getByAriaLabel(
-        walletPage,
-        accountName
-      ).getByRole('switch');
-      await accountConnectionButton.click();
-    })
-  );
+  for (const accountName of accountNames) {
+    const accountConnectionButton = getByAriaLabel(
+      walletPage,
+      `Toggle ${accountName}`
+    );
+    await accountConnectionButton.click();
+  }
 
   const nextButton = getButtonByText(walletPage, 'Next');
   await nextButton.click();

diff --git a/packages/app/playwright/e2e/Bridge.test.ts b/packages/app/playwright/e2e/Bridge.test.ts
@@ -46,6 +46,7 @@ test.describe('Bridge', () => {
     await walletSetup(context, extensionId, page);
     await addAccount(context);
     await addAccount(context);
+    await addAccount(context);
     await switchAccount(context, 'Account 1');
     client = createPublicClient({
       chain: foundry,
@@ -90,7 +91,7 @@ test.describe('Bridge', () => {
       const connectFuel = getByAriaLabel(page, 'Connect Fuel Wallet');
       await connectFuel.click();
       await getByAriaLabel(page, 'Connect to Fuel Wallet', true).click();
-      await walletConnect(context, ['Account 2']);
+      await walletConnect(context, ['Account 2', 'Account 4']);
     });
 
     const INITIATE_DEPOSIT =
@@ -351,6 +352,8 @@ test.describe('Bridge', () => {
     });
 
     await test.step('Deposit TKN to Fuel', async () => {
+      await goToBridgePage(page);
+      await clickDepositTab(page);
       const preDepositBalanceFuel = await fuelWallet.getBalance(
         VITE_FUEL_FUNGIBLE_ASSET_ID
       );
@@ -624,8 +627,6 @@ test.describe('Bridge', () => {
 
       await test.step('Change to account 2 should show loading and empty feedback', async () => {
         await switchAccount(context, 'Account 2');
-        const loading = getByAriaLabel(page, 'Loading Bridge Transactions');
-        await loading.innerText();
         const noActivity = page.getByText('No activity yet');
         await noActivity.innerText();
         const subText = page.getByText(
@@ -650,13 +651,65 @@ test.describe('Bridge', () => {
 
       await test.step('Change to account 1 should show loading and transactions', async () => {
         await switchAccount(context, 'Account 1');
-        const loading = getByAriaLabel(page, 'Loading Bridge Transactions');
-        await loading.innerText();
         await checkTxItemDone(page, depositEthTxId);
         await checkTxItemDone(page, depositERC20TxId);
         await checkTxItemDone(page, withdrawEthTxId);
         await checkTxItemDone(page, withdrawERC20TxId);
       });
     });
+
+    await test.step('Deposit TKN before Fuel wallet has ETH', async () => {
+      await switchAccount(context, 'Account 4');
+      await goToBridgePage(page);
+      await clickDepositTab(page);
+      const assetDropdown = getByAriaLabel(page, 'Coin Selector');
+      await assetDropdown.click();
+      const tknAsset = getByAriaLabel(page, 'TKN symbol');
+      await tknAsset.click();
+      const preDepositBalanceTkn = await erc20Contract.read.balanceOf([
+        account.address,
+      ]);
+
+      // Deposit asset
+      const depositAmount = '1.12345';
+      const depositInput = page.locator('input');
+      await depositInput.fill(depositAmount);
+      const depositButton = getByAriaLabel(page, 'Deposit', true);
+      await depositButton.click();
+
+      // Timeout needed until https://github.com/Synthetixio/synpress/issues/795 is fixed
+      await page.waitForTimeout(7500);
+      await metamask.confirmPermissionToSpend();
+      await metamask.confirmTransaction();
+
+      await page.locator(':nth-match(:text("Done"), 1)').waitFor();
+      await hasText(page, INITIATE_DEPOSIT);
+
+      // Check steps
+      await page.locator(':nth-match(:text("Done"), 2)').waitFor();
+
+      const postDepositBalanceTkn = await erc20Contract.read.balanceOf([
+        account.address,
+      ]);
+
+      expect(
+        parseFloat(
+          bn(preDepositBalanceTkn.toString())
+            .sub(postDepositBalanceTkn.toString())
+            .format({ precision: 6, units: 18 })
+        )
+      ).toBeCloseTo(parseFloat(depositAmount));
+
+      const confirmTransactionButton = page.getByRole('button', {
+        name: 'Confirm Transaction',
+      });
+      await confirmTransactionButton.click();
+
+      await hasText(
+        page,
+        'This transaction requires ETH on Fuel to pay for gas. Please faucet your wallet or bridge ETH.'
+      );
+      await closeTransactionPopup(page);
+    });
   });
 });
diff --git a/packages/app/src/systems/Chains/eth/services/txEthToFuel.ts b/packages/app/src/systems/Chains/eth/services/txEthToFuel.ts
@@ -1,5 +1,15 @@
-import type { BN, Message, WalletUnlocked as FuelWallet } from 'fuels';
-import { Provider as FuelProvider, Address as FuelAddress, bn } from 'fuels';
+import type {
+  BN,
+  Message,
+  WalletUnlocked as FuelWallet,
+  TransactionResponse,
+} from 'fuels';
+import {
+  Provider as FuelProvider,
+  Address as FuelAddress,
+  bn,
+  ZeroBytes32,
+} from 'fuels';
 import type { WalletClient } from 'viem';
 import { decodeEventLog } from 'viem';
 import type { PublicClient } from 'wagmi';
@@ -366,15 +376,37 @@ export class TxEthToFuelService {
     // TODO: should use the fuelProvider from input when wallet gets updated with new SDK
     const provider = await FuelProvider.create(fuelWallet.provider.url);
     const { maxGasPerTx } = await provider.getGasConfig();
-    const txMessageRelayed = await relayCommonMessage({
-      relayer: fuelWallet,
-      message: fuelMessage,
-      txParams: { gasLimit: maxGasPerTx },
-    });
+    let txMessageRelayed: TransactionResponse | undefined;
+    try {
+      txMessageRelayed = await relayCommonMessage({
+        relayer: fuelWallet,
+        message: fuelMessage,
+        txParams: { gasLimit: maxGasPerTx },
+      });
+    } catch (err) {
+      if (err instanceof Error) {
+        const messageToParse = err.message.replace(
+          'not enough coins to fit the target:',
+          ''
+        );
+        const parsedMessage = JSON.parse(messageToParse);
+        if (
+          parsedMessage.response.errors[0].message ===
+            'not enough coins to fit the target' &&
+          parsedMessage.request.variables.queryPerAsset[0].assetId ===
+            ZeroBytes32
+        ) {
+          throw new Error(
+            'This transaction requires ETH on Fuel to pay for gas. Please faucet your wallet or bridge ETH.'
+          );
+        }
+      }
+      throw err;
+    }
 
-    const txMessageRelayedResult = await txMessageRelayed.waitForResult();
+    const txMessageRelayedResult = await txMessageRelayed?.waitForResult();
 
-    if (txMessageRelayedResult.status !== 'success') {
+    if (txMessageRelayedResult?.status !== 'success') {
       throw new Error('Failed to relay message on Fuel');
     }
   }