w3wallets 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,39 @@
+# w3wallets
+
+Web3 wallets for Playwright.
+
+> [!IMPORTANT]
+> This is Alpha!
+
+This library provides methods for interacting with Web3 wallets using Playwright.
+
+```sh
+npm install -D w3wallets
+```
+
+## Getting Started
+
+Only the `Backpack` wallet is supported at this point.
+
+#### 1. Download wallets
+
+```sh
+npx w3wallets
+```
+
+#### 2. Wrap your fixture `withWallets`
+
+```ts
+import { test as base } from "@playwright/test";
+import { withWallets } from "../src/withWallets";
+
+const test = withWallets(base, { backpack: true });
+
+test("has title", async ({ page, backpack }) => {
+  await page.goto("https://playwright.dev/");
+
+  await backpack.onboard(
+    "4wDJd9Ds5ueTdS95ReAZGSBVkjMcNKbgZk47xcmqzpUJjCt7VoB2Cs7hqwXWRnopzXqE4mCP6BEDHCYrFttEcBw2",
+  );
+});
+```

package/dist/index.d.mts

@@ -1,11 +1,19 @@
 import * as playwright_test from 'playwright/test';
-import { test, BrowserContext } from '@playwright/test';
+import { Page, test, BrowserContext } from '@playwright/test';
+
+declare class Backpack {
+    private page;
+    constructor(page: Page);
+    onboard(privateKey: string): Promise<void>;
+}
 
 type Config = {
     backpack: boolean;
 };
-declare function withExtensions(test: typeof test, config: Config): playwright_test.TestType<playwright_test.PlaywrightTestArgs & playwright_test.PlaywrightTestOptions & {
+declare function withWallets(test: typeof test, config: Config): playwright_test.TestType<playwright_test.PlaywrightTestArgs & playwright_test.PlaywrightTestOptions & {
     context: BrowserContext;
+    backpack: Backpack;
+    extensionId: string;
 }, playwright_test.PlaywrightWorkerArgs & playwright_test.PlaywrightWorkerOptions>;
 
-export { withExtensions };
+export { withWallets as withExtensions };

package/dist/index.d.ts

@@ -1,11 +1,19 @@
 import * as playwright_test from 'playwright/test';
-import { test, BrowserContext } from '@playwright/test';
+import { Page, test, BrowserContext } from '@playwright/test';
+
+declare class Backpack {
+    private page;
+    constructor(page: Page);
+    onboard(privateKey: string): Promise<void>;
+}
 
 type Config = {
     backpack: boolean;
 };
-declare function withExtensions(test: typeof test, config: Config): playwright_test.TestType<playwright_test.PlaywrightTestArgs & playwright_test.PlaywrightTestOptions & {
+declare function withWallets(test: typeof test, config: Config): playwright_test.TestType<playwright_test.PlaywrightTestArgs & playwright_test.PlaywrightTestOptions & {
     context: BrowserContext;
+    backpack: Backpack;
+    extensionId: string;
 }, playwright_test.PlaywrightWorkerArgs & playwright_test.PlaywrightWorkerOptions>;
 
-export { withExtensions };
+export { withWallets as withExtensions };

package/dist/index.js

@@ -30,19 +30,54 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  withExtensions: () => withExtensions
+  withExtensions: () => withWallets
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/withExtension.ts
+// src/withWallets.ts
 var import_path = __toESM(require("path"));
+var import_fs = __toESM(require("fs"));
 var import_test = require("@playwright/test");
 var import_test2 = require("@playwright/test");
-function withExtensions(test, config) {
+
+// src/backpack/index.ts
+var Backpack = class {
+  constructor(page) {
+    this.page = page;
+  }
+  async onboard(privateKey) {
+    await this.page.getByRole("button", { name: "I already have a wallet" }).click();
+    await this.page.getByRole("button", { name: "Show advanced options" }).click();
+    await this.page.getByRole("button", { name: "Import with private key" }).click();
+    await this.page.getByPlaceholder("Enter private key").fill(privateKey);
+    await this.page.getByRole("button", { name: "Import" }).click();
+    await this.page.getByPlaceholder("Password", { exact: true }).fill("11111111");
+    await this.page.getByPlaceholder("Confirm Password").fill("11111111");
+    await this.page.getByRole("checkbox").click();
+    await this.page.getByRole("button", { name: "Next" }).click();
+  }
+};
+
+// src/withWallets.ts
+function withWallets(test, config) {
   const backpack = import_path.default.join(process.cwd(), "extensions", "backpack");
   return test.extend({
+    backpack: async ({ context, extensionId }, use) => {
+      const page = context.pages()[0];
+      if (!page) throw Error("No pages in context");
+      const backpack2 = new Backpack(page);
+      await page.goto(
+        `chrome-extension://${extensionId}/options.html?onboarding=true`
+      );
+      await use(backpack2);
+    },
     context: async ({}, use) => {
       const userDataDir = import_path.default.join(process.cwd(), ".tmp-user-data");
+      const backpackDownloaded = import_fs.default.existsSync(
+        import_path.default.join(backpack, "manifest.json")
+      );
+      if (!backpackDownloaded)
+        throw Error("Cannot find Backpack. download it `npx w3wallets`");
       const context = await import_test2.chromium.launchPersistentContext(userDataDir, {
         headless: false,
         args: [
@@ -52,6 +87,13 @@ function withExtensions(test, config) {
       });
       await use(context);
       await context.close();
+    },
+    extensionId: async ({ context }, use) => {
+      let [background] = context.serviceWorkers();
+      if (!background) background = await context.waitForEvent("serviceworker");
+      const extensionId = background.url().split("/")[2];
+      if (!extensionId) throw Error("No extension id");
+      await use(extensionId);
     }
   });
 }

package/dist/index.mjs

@@ -1,12 +1,47 @@
-// src/withExtension.ts
+// src/withWallets.ts
 import path from "path";
+import fs from "fs";
 import "@playwright/test";
 import { chromium } from "@playwright/test";
-function withExtensions(test, config) {
+
+// src/backpack/index.ts
+var Backpack = class {
+  constructor(page) {
+    this.page = page;
+  }
+  async onboard(privateKey) {
+    await this.page.getByRole("button", { name: "I already have a wallet" }).click();
+    await this.page.getByRole("button", { name: "Show advanced options" }).click();
+    await this.page.getByRole("button", { name: "Import with private key" }).click();
+    await this.page.getByPlaceholder("Enter private key").fill(privateKey);
+    await this.page.getByRole("button", { name: "Import" }).click();
+    await this.page.getByPlaceholder("Password", { exact: true }).fill("11111111");
+    await this.page.getByPlaceholder("Confirm Password").fill("11111111");
+    await this.page.getByRole("checkbox").click();
+    await this.page.getByRole("button", { name: "Next" }).click();
+  }
+};
+
+// src/withWallets.ts
+function withWallets(test, config) {
   const backpack = path.join(process.cwd(), "extensions", "backpack");
   return test.extend({
+    backpack: async ({ context, extensionId }, use) => {
+      const page = context.pages()[0];
+      if (!page) throw Error("No pages in context");
+      const backpack2 = new Backpack(page);
+      await page.goto(
+        `chrome-extension://${extensionId}/options.html?onboarding=true`
+      );
+      await use(backpack2);
+    },
     context: async ({}, use) => {
       const userDataDir = path.join(process.cwd(), ".tmp-user-data");
+      const backpackDownloaded = fs.existsSync(
+        path.join(backpack, "manifest.json")
+      );
+      if (!backpackDownloaded)
+        throw Error("Cannot find Backpack. download it `npx w3wallets`");
       const context = await chromium.launchPersistentContext(userDataDir, {
         headless: false,
         args: [
@@ -16,9 +51,16 @@ function withExtensions(test, config) {
       });
       await use(context);
       await context.close();
+    },
+    extensionId: async ({ context }, use) => {
+      let [background] = context.serviceWorkers();
+      if (!background) background = await context.waitForEvent("serviceworker");
+      const extensionId = background.url().split("/")[2];
+      if (!extensionId) throw Error("No extension id");
+      await use(extensionId);
     }
   });
 }
 export {
-  withExtensions
+  withWallets as withExtensions
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "w3wallets",
   "description": "browser wallets for playwright",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Max Andreev <maxick20@gmail.com>",
@@ -12,6 +12,9 @@
   "files": [
     "dist"
   ],
+  "bin": {
+    "w3wallets": "./src/scripts/download.js"
+  },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.2",
     "@changesets/cli": "^2.27.11",
@@ -30,8 +33,14 @@
     "clean": "rm -rf dist",
     "check-format": "prettier --check .",
     "check-exports": "attw --pack .",
+    "format": "prettier --write .",
     "lint": "tsc",
     "ci": "yarn lint && yarn clean && yarn build && yarn check-format && yarn check-exports",
+    "changeset": "npx changeset",
     "local-release": "changeset version && changeset publish"
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.16",
+    "follow-redirects": "^1.15.9"
   }
-}
+}

package/src/scripts/download.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+const { https } = require("follow-redirects");
+const AdmZip = require("adm-zip");
+
+const args = process.argv.slice(2);
+
+// Default configurations
+const DEFAULT_WALLET = "backpack";
+const DEFAULT_DOWNLOAD_LINK =
+  "https://github.com/coral-xyz/backpack/releases/download/0.10.1-latest-4/build-beta-4.zip";
+
+// Parse arguments
+const walletArg = args.find((arg) => arg.startsWith("--wallet="));
+const downloadArg = args.find((arg) => arg.startsWith("--version="));
+
+const wallet = walletArg ? walletArg.split("=")[1] : DEFAULT_WALLET;
+const downloadLink = downloadArg
+  ? downloadArg.split("=")[1]
+  : DEFAULT_DOWNLOAD_LINK;
+const outputDir = path.resolve(`extensions/${wallet}`);
+const zipPath = path.resolve(outputDir, `${wallet}.zip`);
+
+console.log(`Fetching ${wallet}...`);
+
+// Ensure the output directory exists
+fs.mkdirSync(outputDir, { recursive: true });
+
+// Download the zip file
+https
+  .get(downloadLink, (response) => {
+    if (response.statusCode !== 200) {
+      console.error(
+        `Failed to download file. Status Code: ${response.statusCode}`,
+      );
+      return;
+    }
+
+    const fileStream = fs.createWriteStream(zipPath);
+    response.pipe(fileStream);
+
+    fileStream.on("finish", () => {
+      fileStream.close();
+      console.log(`Downloaded to ${zipPath}`);
+
+      // Unzip the file
+      console.log("Unzipping...");
+      const zip = new AdmZip(zipPath);
+      zip.extractAllTo(outputDir, true);
+      console.log(`Extracted to ${outputDir}`);
+
+      fs.unlinkSync(zipPath);
+
+      // Check if the result is a single directory with manifest.json inside
+      const files = fs.readdirSync(outputDir);
+      if (files.length === 1) {
+        const singleDirPath = path.join(outputDir, files[0]);
+        if (
+          fs.lstatSync(singleDirPath).isDirectory() &&
+          fs.existsSync(path.join(singleDirPath, "manifest.json"))
+        ) {
+          // Move all files from the directory to the outputDir
+          const nestedFiles = fs.readdirSync(singleDirPath);
+          nestedFiles.forEach((file) => {
+            const srcPath = path.join(singleDirPath, file);
+            const destPath = path.join(outputDir, file);
+            fs.renameSync(srcPath, destPath);
+          });
+        } else {
+          throw Error("Cannot find the manifest.json file");
+        }
+      }
+    });
+  })
+  .on("error", (err) => {
+    console.error(`Error downloading the file: ${err.message}`);
+  });