test: add e2e test for BTC/BTC reverse swaps

.github/workflows/playwright.yml

@@ -0,0 +1,33 @@
+name: E2E tests
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Start regtest
+      env:
+        COMPOSE_PROFILES: ci
+      run: git submodule init && git submodule update && chmod -R 777 regtest && cd regtest && ./start.sh
+    - name: Install dependencies
+      run: npm ci
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+    - name: Run Playwright tests
+      run: |
+        npm run start &
+        sleep 10
+        npx playwright test
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -8,3 +8,7 @@ ts-out/
 coverage/
 node_modules/
 public/config.json
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "regtest"]
+	path = regtest
+	url = https://github.com/BoltzExchange/regtest.git

e2e/reverseSwap.spec.ts

@@ -0,0 +1,40 @@
+import { test, expect } from '@playwright/test';
+import { getBitcoinAddress, getBitcoinWalletTx, payInvoiceLnd } from "./utils";
+
+test('Reverse swap BTC/BTC', async ({ page }) => {
+  await page.goto('https://localhost:5173');
+
+  const receiveAmount = "0.01";
+  const inputReceiveAmount = page.locator("input[data-testid='receiveAmount']");
+  await inputReceiveAmount.fill(receiveAmount);
+
+  const inputSendAmount = page.locator("input[data-testid='sendAmount']");
+  await expect(inputSendAmount).toHaveValue('0.01005558');
+
+  const inputOnchainAddress = page.locator("input[data-testid='onchainAddress']");
+  await inputOnchainAddress.fill(await getBitcoinAddress());
+
+  const buttonCreateSwap = page.locator("button[data-testid='create-swap-button']");
+  await buttonCreateSwap.click();
+
+  const payInvoiceTitle = page.locator("h2[data-testid='pay-invoice-title']");
+  await expect(payInvoiceTitle).toHaveText("Pay this invoice about 0.01005558 BTC");
+
+  const spanLightningInvoice = page.locator("span[class='btn']");
+  await spanLightningInvoice.click();
+
+  const lightningInvoice = await page.evaluate(() => {
+    return navigator.clipboard.readText();
+  });
+  expect(lightningInvoice).toBeDefined();
+
+  await payInvoiceLnd(lightningInvoice)
+
+  const txIdLink = page.getByText("open claim transaction");
+
+  const txId = (await txIdLink.getAttribute("href")).split("/").pop();
+  expect(txId).toBeDefined();
+
+  const txInfo = JSON.parse(await getBitcoinWalletTx(txId));
+  expect(txInfo.amount.toString()).toEqual(receiveAmount);
+});

e2e/utils.ts

@@ -0,0 +1,34 @@
+import { exec } from 'child_process';
+import { promisify } from 'util';
+
+const execAsync = promisify(exec);
+
+const executeInScriptsContainer = 'docker exec boltz-scripts bash -c "source /etc/profile.d/utils.sh && ';
+
+const execCommand = async (command: string): Promise<string> => {
+    try {
+
+        const { stdout, stderr } = await execAsync(`${executeInScriptsContainer}${command}"`, { shell: '/bin/bash' });
+
+        if (stderr) {
+            throw new Error(`Error executing command: ${stderr}`);
+        }
+
+        return stdout.trim();
+    } catch (error) {
+        console.error(`Failed to execute command: ${command}`, error);
+        throw error;
+    }
+};
+
+export const getBitcoinAddress = async (): Promise<string> => {
+    return execCommand('bitcoin-cli-sim-client getnewaddress');
+};
+
+export const getBitcoinWalletTx = async (txId: string): Promise<string> => {
+    return execCommand(`bitcoin-cli-sim-client gettransaction ${txId}`);
+}
+
+export const payInvoiceLnd = async (invoice: string): Promise<string> => {
+    return execCommand(`lncli-sim 1 payinvoice -f ${invoice}`);
+};

package.json

@@ -22,11 +22,13 @@
         "@babel/plugin-transform-modules-commonjs": "^7.24.8",
         "@babel/preset-env": "^7.24.8",
         "@babel/preset-typescript": "^7.24.7",
+        "@playwright/test": "^1.45.3",
         "@solidjs/testing-library": "^0.8.9",
         "@testing-library/jest-dom": "^6.4.8",
         "@testing-library/user-event": "^14.5.2",
         "@trivago/prettier-plugin-sort-imports": "^4.3.0",
         "@types/jest": "^29.5.12",
+        "@types/node": "^22.0.2",
         "@webbtc/webln-types": "^3.0.0",
         "babel-jest": "^29.7.0",
         "babel-preset-jest": "^29.6.3",

playwright.config.ts

@@ -0,0 +1,83 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './e2e',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+    ignoreHTTPSErrors: true,
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    headless: true,
+    trace: 'on-first-retry',
+    permissions: ["clipboard-read", "clipboard-write"],
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    /* gfy
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+    */
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

src/components/PayInvoice.tsx

@@ -29,7 +29,7 @@ const PayInvoice = ({
 
     return (
         <div>
-            <h2>
+            <h2 data-testid="pay-invoice-title">
                 {t("pay_invoice_to", {
                     amount: formatAmount(
                         BigNumber(sendAmount),