Initial commit

Author: gaudren

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*.{js,mjs,cjs,ts,json,html,yaml,yml}]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+/dist

.eslintrc.cjs

@@ -0,0 +1,32 @@
+module.exports = {
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:@typescript-eslint/strict",
+        "prettier",
+    ],
+    rules: {
+        "@typescript-eslint/no-unused-vars": [
+            "warn",
+            { argsIgnorePattern: "^_" },
+        ],
+    },
+    parser: "@typescript-eslint/parser",
+    plugins: ["@typescript-eslint"],
+    root: true,
+    parserOptions: {
+        project: true,
+    },
+
+    overrides: [
+        {
+            files: ["Build.js"],
+            rules: {
+                "@typescript-eslint/no-unsafe-assignment": ["off"],
+                "@typescript-eslint/no-unsafe-call": ["off"],
+                "@typescript-eslint/no-unsafe-member-access": ["off"],
+            },
+        },
+    ],
+};

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: "Continuous Integration"
+
+on:
+    workflow_dispatch:
+    push:
+        branches:
+            - "master"
+    pull_request:
+
+jobs:
+    tests:
+        name: "Tests"
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 18
+            - run: npm ci
+            - run: npm test

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+/dist

.prettierignore

@@ -0,0 +1,2 @@
+/dist
+node_modules

.prettierrc.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+    plugins: ["@trivago/prettier-plugin-sort-imports"],
+    importOrderSeparation: true,
+    importOrderSortSpecifiers: true,
+};

Build.js

@@ -0,0 +1,33 @@
+import { typecheckPlugin } from "@jgoz/esbuild-plugin-typecheck";
+import * as esbuild from "esbuild";
+import process from "node:process";
+import { URL, fileURLToPath, pathToFileURL } from "node:url";
+
+const options = {
+    plugins: [typecheckPlugin()],
+
+    absWorkingDir: fileURLToPath(new URL(".", import.meta.url)),
+
+    entryPoints: [
+        "src/index.ts",
+        "src/cli.ts",
+        "src/glue.ts",
+        "src/units.ts",
+        "src/logger.ts",
+    ],
+
+    bundle: false,
+    outbase: "src",
+    outdir: "./dist",
+    target: "es2020",
+    format: "esm",
+    platform: "node",
+    minify: false,
+    sourcemap: true,
+};
+
+if (import.meta.url === pathToFileURL(process.argv[1]).href) {
+    await esbuild.build(options);
+}
+
+export { options as default };

LICENSE

@@ -0,0 +1,22 @@
+Copyright © 2023 Binary Cake Ltd. & Contributors
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+## Wallet Test Framework: MetaMask (Android)
+
+A tool to automate the MetaMask wallet on android for use with Wallet Test Framework.
+
+## Installation
+
+### Node
+
+This project requires Nodejs version 20.6 or later.
+
+### Dependencies
+
+```bash
+npm install
+```
+
+### Android Application
+
+The glue requires the MetaMask app installed on a real device. The app can be installed from the [Play Store](https://play.google.com/store/apps/details?id=io.metamask).
+
+Note that running the tests will wipe your private keys off of the device.
+
+## Building
+
+```bash
+npm run build
+```
+
+### Tests & Linting (Optional)
+
+```bash
+npm test
+```
+
+## Running
+
+Running these tests requires launching two executables: an appium server, and the glue.
+
+### Appium
+
+Getting appium to launch properly can be difficult. Follow their guides for more information.
+
+```bash
+npx appium
+```
+
+<!-- TODO: mention installing uiautomator2 -->
+
+### Tests
+
+```bash
+npx glue-metamask-android
+```