Merge pull request #50 from BitGo/BTC-1829.fix-taproot

feat: improve taproot descriptors support

Author: OttoAllmendinger

packages/wasm-miniscript/.prettierignore

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

packages/wasm-miniscript/src/try_into_js_value.rs

@@ -208,10 +208,7 @@ impl<Pk: MiniscriptKey + TryIntoJsValue> TryIntoJsValue for WshInner<Pk> {
 
 impl<Pk: MiniscriptKey + TryIntoJsValue> TryIntoJsValue for Tr<Pk> {
     fn try_to_js_value(&self) -> Result<JsValue, JsError> {
-        js_obj!(
-            "internalKey" => self.internal_key(),
-            "tree" => self.tap_tree()
-        )
+        Ok(js_arr!(self.internal_key(), self.tap_tree()))
     }
 }
 

packages/wasm-miniscript/test/descriptorFixtures.ts

@@ -345,6 +345,12 @@ export const fixtures = {
       script: "a914767e9119ff3b3ac0cb6dcfe21de1842ccf85f1c487",
       checksumRequired: false,
     },
+    {
+      descriptor:
+        "tr(50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0,multi_a(2,xpub661MyMwAqRbcFXS2qwsTkaFc7PEpwDXWgY1Hx2MS7XywhW24sTjQzxiUgnGNW5v6DsW9Z8JcAqf8a22v21jDSA3DwLbbpt2ra3WbP83QNvP/0/0,xpub661MyMwAqRbcGfiaWcoeKLerFu3qRfy6zSYAwnmxSKW8JSauRajFsAsRHs2pV4q5rxkb4ynx4Bm8t54McTCp8V27s7XsdpD8T4s56etpjro/0/0,xpub661MyMwAqRbcH4HzWiCwmYajy1SXZngxHvpYDNEX4xjrDAneAm6rnpPuPPXcBRsSgxupDBmH2tzPHkikNrnLbsvTHemPFHSFbZxonZcCwFi/0/0))#82q34xv2",
+      script: "51207e8c409f0ab01197f9676efc3a9505f1f09ed0f21693e46a3aa3b6b54d437aa2",
+      checksumRequired: true,
+    },
   ],
   invalid: [
     {

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"
+          }
+        }
+      }
+    }
+  }
+}