don't require pkcs key format; simplify key loading and add docs

docs/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contribution Guide
+
+## End-to-end Tests
+
+### How to run
+
+To run end-to-end tests with chromium, run `pnpm test:e2e` in terminal.
+
+**Before you begin**, you need to setup some environment variables/secrets in `tests/.env`.
+
+1. Copy `tests/.env.example` to `tests/.env`
+2. Update `tests/.env` with your secrets.
+
+| Environment Variable         | Description                                                 | Is secret? |
+| ---------------------------- | ----------------------------------------------------------- | ---------- |
+| `WALLET_URL_ORIGIN`          | URL of the wallet (e.g. https://rafiki.money)               | No         |
+| `WALLET_USERNAME`            | Login email for the wallet                                  | No         |
+| `WALLET_PASSWORD`            | Login password for the wallet                               | Yes        |
+| `CONNECT_WALLET_ADDRESS_URL` | Your wallet address that will be connected to extension     | No         |
+| `CONNECT_KEY_ID`             | ID of the key that will be connected to extension (UUID v4) | No         |
+| `CONNECT_PRIVATE_KEY`        | Private key (hex-encoded Ed25519 private key)               | Yes        |
+| `CONNECT_PUBLIC_KEY`         | Public key (base64-encoded Ed25519 public key)              | No         |
+
+To get the `CONNECT_KEY_ID`, `CONNECT_PRIVATE_KEY` and `CONNECT_PUBLIC_KEY`:
+
+1. Load the extension in browser (via `chrome://extensions/`)
+   - Once the extension is loaded, it'll generate a key-pair that we will need to connect with our wallet.
+1. Inspect service worker with "Inspect views service worker"
+1. Run following in devtools console to copy keys to your clipboard, and paste it in `tests/.env`:
+   ```js
+   // 1. Gets generated keys from extension storage.
+   // 2. Converts result to `CONNECT_{X}="VAL"` format for use in .env file.
+   // 3. Copies result to clipboard.
+   copy(
+     Object.entries(
+       await chrome.storage.local.get(['privateKey', 'publicKey', 'keyId']),
+     )
+       .map(
+         ([k, v]) =>
+           `CONNECT_${k.replace(/([A-Z])/g, '_$1').toUpperCase()}="${v}"`,
+       )
+       .join('\n'),
+   );
+   ```
+
+Then copy `CONNECT_PUBLIC_KEY` key to https://rafiki.money/settings/developer-keys under your wallet address.
+
+Now you're ready to run the tests.

package.json

@@ -17,7 +17,7 @@
     "format:fix": "prettier . --write --cache --cache-location='node_modules/.cache/prettiercache' --log-level=warn",
     "typecheck": "tsc --noEmit",
     "test": "jest --maxWorkers=2 --passWithNoTests",
-    "test:e2e": "playwright test",
+    "test:e2e": "playwright test --project=chromium",
     "test:ci": "pnpm test -- --reporters=default --reporters=github-actions"
   },
   "dependencies": {
@@ -76,7 +76,6 @@
     "jest-chrome": "^0.8.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-transform-stub": "^2.0.0",
-    "jose": "^5.8.0",
     "postcss": "^8.4.41",
     "prettier": "^3.3.3",
     "prettier-plugin-tailwindcss": "^0.6.6",

tests/.env.example

@@ -8,12 +8,8 @@ WALLET_PASSWORD=some-password
 
 # To connect extension to wallet
 CONNECT_WALLET_ADDRESS_URL="https://ilp.rafiki.money/something"
-# ...generate a key-pair at https://rafiki.money/settings/developer-keys
-# ...we'll make extension use this key-pair consistently
+
+# We'll make extension use this key-pair consistently. See docs/CONTRIBUTING.md
 CONNECT_KEY_ID=uuid-v4-key-id
-CONNECT_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----
-PUBLIC-KEY-CONTENTS
------END PUBLIC KEY-----"
-CONNECT_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
-PRIVATE-KEY-CONTENTS
------END PRIVATE KEY-----"
+CONNECT_PUBLIC_KEY="BASE-64-KEY=="
+CONNECT_PRIVATE_KEY="hex-encodedkey"

tests/fixtures/helpers.ts

@@ -224,43 +224,23 @@ export function getExtensionId(browserName: string, background: Worker) {
 export type KeyInfo = {
   /** UUID-v4 */
   keyId: string;
-  /** Format: -----BEGIN PRIVATE KEY-----  */
+  /** Format: Hex encoded Ed25519 private key */
   privateKey: string;
-  /** Format: -----BEGIN PUBLIC KEY----- */
+  /** Format: Base64 encoded Ed25519 public key */
   publicKey: string;
 };
 
 export async function loadKeysToExtension(
   background: Background,
   keyInfo: KeyInfo,
 ) {
-  const { importSPKI, importPKCS8, exportJWK } = await import('jose');
-  const { bytesToHex } = await import('@noble/hashes/utils');
-
-  const keyId = keyInfo.keyId;
-  const privateKey = await importPKCS8(keyInfo.privateKey, 'Ed25519').then(
-    (keyLike) => {
-      const bytes = (keyLike as KeyObject).export({
-        type: 'pkcs8',
-        format: 'der',
-      });
-      return bytesToHex(bytes);
-    },
-  );
-  const publicKey = await importSPKI(keyInfo.publicKey, 'Ed25519')
-    .then((r) => exportJWK(r))
-    .then((r) => btoa(JSON.stringify(r)));
-
-  await background.evaluate(
-    async ({ privateKey, publicKey, keyId }) => {
-      return await chrome.storage.local.set({
-        privateKey,
-        publicKey,
-        keyId,
-      });
-    },
-    { keyId, privateKey, publicKey },
-  );
+  await background.evaluate(async ({ privateKey, publicKey, keyId }) => {
+    return await chrome.storage.local.set({
+      privateKey,
+      publicKey,
+      keyId,
+    });
+  }, keyInfo);
 
   const res = await background.evaluate(() => {
     return chrome.storage.local.get(['privateKey', 'publicKey', 'keyId']);