feat: add AST dump utility for descriptor tests

Add helper to write descriptor AST to JSON files for test fixtures.

Issue: BTC-1829

Author: OttoAllmendinger

packages/wasm-miniscript/.prettierignore

@@ -1,2 +1,3 @@
 js/wasm
-target/
+test/fixtures/
+target/

packages/wasm-miniscript/test/descriptorUtil.ts

@@ -1,4 +1,24 @@
+import * as fs from "fs/promises";
 import * as utxolib from "@bitgo/utxo-lib";
+import { Descriptor } from "../js";
+import * as assert from "node:assert";
+
+async function assertEqualJSON(path: string, value: unknown): Promise<void> {
+  try {
+    const data = JSON.parse(await fs.readFile(path, "utf8"));
+    assert.deepStrictEqual(data, value);
+  } catch (e: any) {
+    if (e.code === "ENOENT") {
+      await fs.writeFile(path, JSON.stringify(value, null, 2));
+      throw new Error("Expected file not found, wrote it instead");
+    }
+    throw e;
+  }
+}
+
+export async function assertEqualAst(path: string, descriptor: Descriptor): Promise<void> {
+  await assertEqualJSON(path, { descriptor: descriptor.toString(), ast: descriptor.node() });
+}
 
 /** Expand a template with the given root wallet keys and chain code */
 function expand(template: string, rootWalletKeys: utxolib.bitgo.RootWalletKeys, chainCode: number) {

packages/wasm-miniscript/test/fixtures/0.json

@@ -0,0 +1,12 @@
+{
+  "descriptor": "pk(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd)#9pcxlpvx",
+  "ast": {
+    "Bare": {
+      "Check": {
+        "PkK": {
+          "Single": "03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd"
+        }
+      }
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/1.json

@@ -0,0 +1,12 @@
+{
+  "descriptor": "pk(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd)#9pcxlpvx",
+  "ast": {
+    "Bare": {
+      "Check": {
+        "PkK": {
+          "Single": "03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd"
+        }
+      }
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/10.json

@@ -0,0 +1,8 @@
+{
+  "descriptor": "pkh(04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235)#9907vvwz",
+  "ast": {
+    "Pkh": {
+      "Single": "04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235"
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/11.json

@@ -0,0 +1,8 @@
+{
+  "descriptor": "pkh(04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235)#9907vvwz",
+  "ast": {
+    "Pkh": {
+      "Single": "04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235"
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/12.json

@@ -0,0 +1,14 @@
+{
+  "descriptor": "sh(pk(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd))#s53ls94y",
+  "ast": {
+    "Sh": {
+      "Ms": {
+        "Check": {
+          "PkK": {
+            "Single": "03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd"
+          }
+        }
+      }
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/13.json

@@ -0,0 +1,14 @@
+{
+  "descriptor": "sh(pk(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd))#s53ls94y",
+  "ast": {
+    "Sh": {
+      "Ms": {
+        "Check": {
+          "PkK": {
+            "Single": "03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd"
+          }
+        }
+      }
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/14.json

@@ -0,0 +1,14 @@
+{
+  "descriptor": "sh(pkh(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd))#dr3u9ynx",
+  "ast": {
+    "Sh": {
+      "Ms": {
+        "Check": {
+          "PkH": {
+            "Single": "03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd"
+          }
+        }
+      }
+    }
+  }
+}

packages/wasm-miniscript/test/fixtures/15.json

@@ -0,0 +1,14 @@
+{
+  "descriptor": "sh(pkh(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd))#dr3u9ynx",
+  "ast": {
+    "Sh": {
+      "Ms": {
+        "Check": {
+          "PkH": {
+            "Single": "03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd"
+          }
+        }
+      }
+    }
+  }
+}