Merge branch 'release/v1.0.32'

andreashuber69 · andreashuber69 · commit 868a0ff0d717 · 2024-03-27T17:03:25.000+01:00
diff --git a/README.md b/README.md
@@ -130,9 +130,9 @@ COLDCARD copy correctly derives the seed but then generates addresses from a dif
 ``` shell_session cSpell:disable
 $ npx verify-coldcard-dice-seed@latest
 Need to install the following packages:
-  verify-coldcard-dice-seed@1.0.31
+  verify-coldcard-dice-seed@1.0.32
 Ok to proceed? (y) y
-*** Verify COLDCARD Dice Seed v1.0.31 ***
+*** Verify COLDCARD Dice Seed v1.0.32 ***
 (tested with COLDCARD Mk4 firmware v5.2.2)
 
 This application guides you through verifying that your COLDCARD
diff --git a/index.html b/index.html
@@ -6,6 +6,10 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Verify COLDCARD Dice Seed</title>
   <meta name="description" content="Verify COLDCARD Dice Seed">
+  <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
+  <link rel="icon" type="image/png" sizes="48x48" href="favicon-48x48.png">
+  <link rel="icon" type="image/png" sizes="192x192" href="favicon-192x192.png">
   <script type="module" src="src/site/main.tsx"></script>
   <link rel="stylesheet" href="node_modules/@picocss/pico/css/pico.min.css">
   <style>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "verify-coldcard-dice-seed",
-  "version": "1.0.31",
+  "version": "1.0.32",
   "description": "Verify whether your COLDCARD correctly generates seeds and addresses from dice rolls.",
   "keywords": [
     "bitcoin",
@@ -42,7 +42,7 @@
     "lint": "eslint --ext .cjs,.ts,.tsx --report-unused-disable-directives '.'",
     "build": "tsc -p './tsconfig.json' && tsc -p './src/package/tsconfig.json' && tsc -p './src/site/tsconfig.json' && tsc -p './scripts/tsconfig.json'",
     "postbuild": "vite build",
-    "test-no-coverage": "node --import tsx --test src/common/*.spec.ts",
+    "test-no-coverage": "node --import tsx --test src/common/*.spec.ts src/site/*.spec.ts",
     "test-no-coverage-built": "node --test dist/common/*.spec.js",
     "test": "c8 --exclude 'src/common/*.spec.ts' --reporter=text --reporter=lcov npm run test-no-coverage",
     "test-built": "c8 --exclude 'dist/common/*.spec.js' --reporter=text --reporter=lcov npm run test-no-coverage-built",
@@ -65,12 +65,12 @@
     "@andreashuber69/eslint-config": "^1.2.6",
     "@picocss/pico": "^1.5.13",
     "@preact/preset-vite": "^2.8.2",
-    "@tsconfig/node20": "^20.1.3",
-    "@tsconfig/strictest": "^2.0.4",
+    "@tsconfig/node20": "^20.1.4",
+    "@tsconfig/strictest": "^2.0.5",
     "@types/node": "^20.11.30",
     "c8": "^9.1.0",
     "coveralls": "^3.1.1",
-    "cspell": "^8.6.0",
+    "cspell": "^8.6.1",
     "markdownlint-cli": "^0.39.0",
     "node-fetch": "^3.3.2",
     "preact": "^10.20.1",
diff --git a/public/favicon-16x16.png b/public/favicon-16x16.png
diff --git a/public/favicon-192x192.png b/public/favicon-192x192.png
diff --git a/public/favicon-32x32.png b/public/favicon-32x32.png
diff --git a/public/favicon-48x48.png b/public/favicon-48x48.png
diff --git a/scripts/encoding.ts b/scripts/encoding.ts
@@ -1 +1,2 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 export const encoding = { encoding: "utf8" } as const;
diff --git a/scripts/exec.ts b/scripts/exec.ts
@@ -1,3 +1,4 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 import { exec as nodeExec } from "node:child_process";
 import { promisify } from "node:util";
 import { encoding } from "./encoding.js";
diff --git a/scripts/preversion.ts b/scripts/preversion.ts
@@ -1,3 +1,4 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 import { writeFile } from "node:fs/promises";
 import { version } from "../package.json";
 import { encoding } from "./encoding.js";
diff --git a/scripts/version.ts b/scripts/version.ts
@@ -1,3 +1,4 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 import { readFile, rm, writeFile } from "node:fs/promises";
 import { version } from "../package.json";
 import { encoding } from "./encoding.js";
diff --git a/src/common/getAddressesForRoot.spec.ts b/src/common/getAddressesForRoot.spec.ts
@@ -1,11 +1,11 @@
 // https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 import assert from "node:assert";
 import { describe, it } from "node:test";
-import { getAddresses } from "./getAddresses.js";
+import { getAddressesForRoot } from "./getAddressesForRoot.js";
 import { getRoot } from "./getRoot.js";
 
 const getBatch = async (mnemonic: string, passphrase: string, accountRootPath: string, startIndex: number) =>
-    getAddresses(await getRoot(mnemonic, passphrase), accountRootPath, startIndex, 10);
+    getAddressesForRoot(await getRoot(mnemonic, passphrase), accountRootPath, startIndex, 10);
 
 const rootPath = "m/84'/0'/0'/0";
 const getPath = (index: number) => `${rootPath}/${index}`;
@@ -24,7 +24,7 @@ const expectBatch = async (mnemonic: string, expected: readonly string[]) => {
     );
 };
 
-await describe(getAddresses.name, async () => {
+await describe(getAddressesForRoot.name, async () => {
     await describe("should calculate the expected addresses", async () => {
         // https://en.bitcoin.it/wiki/BIP_0084
         await expectBatch(
diff --git a/src/common/getAddressesForRoot.ts b/src/common/getAddressesForRoot.ts
@@ -6,7 +6,7 @@ type GrowToSize<T, N extends number, A extends T[]> = A["length"] extends N ? A
 
 type Batch<N extends number> = GrowToSize<[string, string], N, []>;
 
-export const getAddresses = <N extends number>(
+export const getAddressesForRoot = <N extends number>(
     root: BIP32Interface,
     accountRootPath: string,
     startIndex: number,
diff --git a/src/common/getRoot.ts b/src/common/getRoot.ts
@@ -1,3 +1,4 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 import { BIP32Factory } from "bip32";
 import { mnemonicToSeed } from "bip39";
 // eslint-disable-next-line import/no-namespace
diff --git a/src/package/main.ts b/src/package/main.ts
@@ -33,10 +33,10 @@ try {
     stdout.write("correctly derives seeds and addresses from dice rolls.\r\n");
     stdout.write("\r\n");
     stdout.write("CAUTION: The very point of a COLDCARD is that the seed of a real wallet\r\n");
-    stdout.write("is never entered outside of a coldcard. You should therefore only use\r\n");
-    stdout.write("this application to verify the seed and address derivation of your\r\n");
-    stdout.write("COLDCARD. Once you are convinced that your COLDCARD works correctly, you\r\n");
-    stdout.write("should then generate the seed of your real wallet on your COLDCARD only.\r\n");
+    stdout.write("*never* appears on any other device. You should therefore only use this\r\n");
+    stdout.write("application to verify the seed and address derivation of your COLDCARD.\r\n");
+    stdout.write("Once you are convinced that your COLDCARD works correctly, you should\r\n");
+    stdout.write("then generate the seed of your real wallet on your COLDCARD only.\r\n");
     stdout.write("\r\n");
 
     const generate24WordsPrompt = "Generate 24 instead of the standard 12 words [y, N]? ";
diff --git a/src/package/showAddresses.ts b/src/package/showAddresses.ts
@@ -1,5 +1,5 @@
 // https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
-import { getAddresses } from "../common/getAddresses.js";
+import { getAddressesForRoot } from "../common/getAddressesForRoot.js";
 import { getRoot } from "../common/getRoot.js";
 import type { InOut } from "./InOut.js";
 import { waitForUser } from "./waitForUser.js";
@@ -8,7 +8,7 @@ export const showAddresses = async ({ stdin, stdout }: InOut, words: readonly st
     stdout.write("Select 'Address Explorer' and press the 4 button on your COLDCARD.\r\n");
     await waitForUser({ stdin, stdout });
     const root = await getRoot(words.join(" "), passphrase);
-    const getBatch = (startIndex: number) => getAddresses(root, "m/84'/0'/0'/0", startIndex, 10);
+    const getBatch = (startIndex: number) => getAddressesForRoot(root, "m/84'/0'/0'/0", startIndex, 10);
 
     let batchStart = 0;
     let batch = getBatch(batchStart);
diff --git a/src/site/Addresses.tsx b/src/site/Addresses.tsx
@@ -1,23 +1,9 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 import { useEffect, useState } from "preact/hooks";
-import { getAddresses } from "../common/getAddresses.js";
-import { getRoot } from "../common/getRoot.js";
+import { getAddressesForMnemonicAndPassphrase } from "./getAddressesForMnemonicAndPassphrase.js";
+import type { GetAddressesParams } from "./GetAddressesParams.js";
 
-interface AddressesProps {
-    // False positive
-    /* eslint-disable react/no-unused-prop-types */
-    readonly mnemonic: readonly string[];
-    readonly passphrase: string;
-    readonly accountRootPath: string;
-    /* eslint-enable react/no-unused-prop-types */
-}
-
-const getAddressesForMnemonicAndPassphrase = async (
-    { mnemonic, passphrase, accountRootPath }: AddressesProps,
-): Promise<Array<[string, string]>> => (
-    mnemonic.length > 0 ? getAddresses(await getRoot(mnemonic.join(" "), passphrase), accountRootPath, 0, 50) : []
-);
-
-export const Addresses = (props: AddressesProps) => {
+export const Addresses = (props: GetAddressesParams) => {
     const [addresses, setAddresses] = useState<ReadonlyArray<readonly [string, string]>>([]);
 
     useEffect(() => {
diff --git a/src/site/GetAddressesParams.ts b/src/site/GetAddressesParams.ts
@@ -0,0 +1,6 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
+export interface GetAddressesParams {
+    readonly mnemonic: readonly string[];
+    readonly passphrase: string;
+    readonly accountRootPath: string;
+}
diff --git a/src/site/PromiseQueue.spec.ts b/src/site/PromiseQueue.spec.ts
@@ -0,0 +1,32 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
+import assert from "node:assert";
+import { describe, it } from "node:test";
+
+import { PromiseQueue } from "./PromiseQueue.js";
+
+const randomDelay = async (sequence: number[], result: number) => {
+    await new Promise<void>((resolve) => setTimeout(resolve, Math.random() * 100));
+    sequence.push(result);
+    return result;
+};
+
+await describe(PromiseQueue.name, async () => {
+    await it("should execute tasks in order", async () => {
+        const queue = new PromiseQueue();
+        const sequence = new Array<number>();
+
+        const result = await Promise.all([
+            queue.execute(async () => await randomDelay(sequence, 0)),
+            queue.execute(async () => await randomDelay(sequence, 1)),
+            queue.execute(async () => await randomDelay(sequence, 2)),
+            queue.execute(async () => await randomDelay(sequence, 3)),
+            queue.execute(async () => await randomDelay(sequence, 4)),
+            queue.execute(async () => await randomDelay(sequence, 5)),
+        ]);
+
+        for (const [index, value] of result.entries()) {
+            assert(index === value);
+            assert(index === sequence[index]);
+        }
+    });
+});
diff --git a/src/site/PromiseQueue.ts b/src/site/PromiseQueue.ts
@@ -0,0 +1,20 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
+export class PromiseQueue {
+    public async execute<T>(createAwaitable: () => Promise<T>): Promise<T> {
+        while (this.pending !== undefined) {
+            // eslint-disable-next-line no-await-in-loop
+            await this.pending;
+        }
+
+        const next = createAwaitable();
+        this.pending = next;
+
+        try {
+            return await next;
+        } finally {
+            this.pending = undefined;
+        }
+    }
+
+    private pending: PromiseLike<unknown> | undefined;
+}
diff --git a/src/site/WordLine.tsx b/src/site/WordLine.tsx
@@ -1,3 +1,4 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
 interface MnemonicProps {
     readonly index: number;
     readonly words: string[];
diff --git a/src/site/getAddressesForMnemonicAndPassphrase.ts b/src/site/getAddressesForMnemonicAndPassphrase.ts
@@ -0,0 +1,20 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
+import { once } from "node:events";
+import type { GetAddressesParams } from "./GetAddressesParams.js";
+import { PromiseQueue } from "./PromiseQueue.js";
+
+const worker = new Worker(new URL("getAddressesForMnemonicAndPassphraseImpl.js", import.meta.url), { type: "module" });
+const queue = new PromiseQueue();
+
+const getAddressesForMnemonicAndPassphraseImpl = async (params: GetAddressesParams) =>
+    await queue.execute(
+        async () => {
+            // eslint-disable-next-line unicorn/require-post-message-target-origin
+            worker.postMessage(params);
+            return ((await once(worker, "message"))[0] as MessageEvent<Array<[string, string]>>).data;
+        },
+    );
+
+export const getAddressesForMnemonicAndPassphrase = async (params: GetAddressesParams) => (
+    params.mnemonic.length > 0 ? await getAddressesForMnemonicAndPassphraseImpl(params) : new Array<[string, string]>()
+);
diff --git a/src/site/getAddressesForMnemonicAndPassphraseImpl.ts b/src/site/getAddressesForMnemonicAndPassphraseImpl.ts
@@ -0,0 +1,14 @@
+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed
+import { getAddressesForRoot } from "../common/getAddressesForRoot.js";
+import { getRoot } from "../common/getRoot.js";
+import type { GetAddressesParams } from "./GetAddressesParams.js";
+
+const getAddressesForMnemonicAndPassphraseImpl = async (
+    { mnemonic, passphrase, accountRootPath }: GetAddressesParams,
+): Promise<Array<[string, string]>> =>
+    getAddressesForRoot(await getRoot(mnemonic.join(" "), passphrase), accountRootPath, 0, 50);
+
+onmessage = async (ev: MessageEvent<GetAddressesParams>) =>
+    postMessage(await getAddressesForMnemonicAndPassphraseImpl(ev.data));
+
+
diff --git a/src/site/main.tsx b/src/site/main.tsx
@@ -20,6 +20,45 @@ const getCurrent = <T extends NonNullable<unknown>>(ref: Ref<T>) => {
 
 const getKey = (index: number) => `${index}`;
 
+const header = (
+  <>
+    <hgroup>
+      <h1>Verify COLDCARD Dice Seed</h1>
+      <p>
+        <span>v1.0.32</span> (tested with COLDCARD Mk4 firmware v5.2.2)
+      </p>
+    </hgroup>
+    <p>
+      The COLDCARD manufacturer{" "}
+      <a href="https://coldcardwallet.com/docs/verifying-dice-roll-math" rel="noreferrer" target="_blank">
+        provides instructions
+      </a> on how to verify dice seed derivation with a Python script. This site offers a more user-friendly way
+      to do the same and goes one step further: It also allows you to verify the receive and change addresses
+      derived from the seed. Step by step guidance for the COLDCARD is available through the{" "}
+      <a href="https://www.npmjs.com/package/verify-coldcard-dice-seed" rel="noreferrer" target="_blank">
+        verify-coldcard-dice-seed
+      </a> Node.js application. See{" "}
+      <a
+        href="https://www.npmjs.com/package/verify-coldcard-dice-seed#motivation"
+        rel="noreferrer" target="_blank">
+        Motivation
+      </a>
+      {" "}for technical details.
+    </p>
+    <p>
+      <mark>CAUTION: The very point of a COLDCARD is that the seed (usually expressed as a 12 word mnemonic)
+        of a real wallet <b>never</b> appears on any other device. You should therefore only use this
+        application to verify the seed and address derivation of your COLDCARD. Once you are convinced that
+        your COLDCARD works correctly, you should then generate the seed of your real wallet on your COLDCARD
+        only. Since the COLDCARD electronics has no way of knowing whether you&apos;re verifying seed
+        derivation or generating a real wallet, you can be reasonably sure that your real wallet was indeed
+        derived from the dice entropy you entered.
+      </mark>
+    </p>
+    <br />
+  </>
+);
+
 const Main = () => {
     const generate24WordsRef = useRef<HTMLInputElement>(null);
     const diceRollsRef = useRef<HTMLInputElement>(null);
@@ -50,43 +89,18 @@ const Main = () => {
     const handleInput = useCallback(() => void handleInputImpl(), [handleInputImpl]);
     useEffect(handleInput, [handleInput]);
 
+    const getAddressesSection = (change: boolean) => (
+      <section>
+        <h2>{change ? "Change" : "Receive"} Addresses</h2>
+        <Addresses
+          mnemonic={mnemonic} passphrase={passphrase} accountRootPath={`m/84'/0'/${account}'/${change ? 1 : 0}`} />
+      </section>
+    );
+
     return (
       <>
         <section>
-          <hgroup>
-            <h1>Verify COLDCARD Dice Seed</h1>
-            <p>
-              <span>v1.0.31</span> (tested with COLDCARD Mk4 firmware v5.2.2)
-            </p>
-          </hgroup>
-          <p>
-            The COLDCARD manufacturer{" "}
-            <a href="https://coldcardwallet.com/docs/verifying-dice-roll-math" rel="noreferrer" target="_blank">
-              provides instructions
-            </a> on how to verify dice seed derivation with a Python script. This site offers a
-            user-friendlier way to do the same and goes one step further: It also allows you to verify the receive
-            addresses derived from the seed. Step by step guidance for the COLDCARD is available through the{" "}
-            <a href="https://www.npmjs.com/package/verify-coldcard-dice-seed" rel="noreferrer" target="_blank">
-              verify-coldcard-dice-seed
-            </a> Node.js application. See{" "}
-            <a
-              href="https://www.npmjs.com/package/verify-coldcard-dice-seed#motivation"
-              rel="noreferrer" target="_blank">
-              Motivation
-            </a>
-            {" "}for technical details.
-          </p>
-          <p>
-            <mark>CAUTION: The very point of a COLDCARD is that the seed (usually expressed as a 12 word mnemonic)
-              of a real wallet <b>never</b> appears on any other device. You should therefore only use this
-              application to verify the seed and address derivation of your COLDCARD. Once you are convinced that
-              your COLDCARD works correctly, you should then generate the seed of your real wallet on your COLDCARD
-              only. Since the COLDCARD electronics has no way of knowing whether you&apos;re verifying seed
-              derivation or generating a real wallet, you can be reasonably sure that your real wallet was indeed
-              derived from the dice entropy you entered.
-            </mark>
-          </p>
-          <br />
+          {header}
           <form>
             <label htmlFor="generate-24-words">
               <input
@@ -120,14 +134,8 @@ const Main = () => {
             {mnemonic.map((_w, i, a) => (i % 4 === 0 ? <WordLine key={getKey(i)} index={i} words={a} /> : ""))}
           </div>
         </section>
-        <section>
-          <h2>Receive Addresses</h2>
-          <Addresses mnemonic={mnemonic} passphrase={passphrase} accountRootPath={`m/84'/0'/${account}'/0`} />
-        </section>
-        <section>
-          <h2>Change Addresses</h2>
-          <Addresses mnemonic={mnemonic} passphrase={passphrase} accountRootPath={`m/84'/0'/${account}'/1`} />
-        </section>
+        {getAddressesSection(false)}
+        {getAddressesSection(true)}
       </>
     );
 };
diff --git a/src/site/tsconfig.json b/src/site/tsconfig.json
diff --git a/vite.config.ts b/vite.config.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed`
`1`	`2`	`export const encoding = { encoding: "utf8" } as const;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// https://github.com/andreashuber69/verify-coldcard-dice-seed/blob/develop/README.md#----verify-coldcard-dice-seed`
`1`	`2`	`import { exec as nodeExec } from "node:child_process";`
`2`	`3`	`import { promisify } from "node:util";`
`3`	`4`	`import { encoding } from "./encoding.js";`