feat: add desc_type method to Descriptor type

Author: thunderbiscuit

bdk-ffi/src/bdk.udl

@@ -1098,6 +1098,9 @@ interface Descriptor {
   /// "parallel" paths. For regular descriptors it will just return itself.
   [Throws=MiniscriptError]
   sequence<Descriptor> to_single_descriptors();
+
+  /// Get the DescriptorType of Descriptor
+  DescriptorType desc_type();
 };
 
 // ------------------------------------------------------------------------
@@ -1460,3 +1463,23 @@ dictionary OutPoint {
   string txid;
   u32 vout;
 };
+
+// ------------------------------------------------------------------------
+// bdk_wallet crate - miniscript re-exports
+// ------------------------------------------------------------------------
+
+/// Descriptor Type of the descriptor.
+[Remote]
+enum DescriptorType {
+    "Bare",
+    "Sh",
+    "Pkh",
+    "Wpkh",
+    "Wsh",
+    "ShWsh",
+    "ShWpkh",
+    "ShSortedMulti",
+    "WshSortedMulti",
+    "ShWshSortedMulti",
+    "Tr",
+};

bdk-ffi/src/descriptor.rs

@@ -15,6 +15,7 @@ use bdk_wallet::template::{
 use bdk_wallet::KeychainKind;
 
 use crate::error::MiniscriptError;
+use bdk_wallet::miniscript::descriptor::DescriptorType;
 use std::fmt::Display;
 use std::str::FromStr;
 use std::sync::Arc;
@@ -290,6 +291,10 @@ impl Descriptor {
                     .collect()
             })
     }
+
+    pub(crate) fn desc_type(&self) -> DescriptorType {
+        self.extended_descriptor.desc_type()
+    }
 }
 
 impl Display for Descriptor {

bdk-ffi/src/lib.rs

@@ -91,6 +91,7 @@ use crate::wallet::Wallet;
 
 use bdk_wallet::bitcoin::Network;
 use bdk_wallet::keys::bip39::WordCount;
+use bdk_wallet::miniscript::descriptor::DescriptorType;
 use bdk_wallet::tx_builder::ChangeSpendPolicy;
 use bdk_wallet::ChangeSet;
 use bdk_wallet::KeychainKind;

bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/OfflineDescriptorTest.kt

@@ -15,4 +15,68 @@ class OfflineDescriptorTest {
             actual = descriptor.toString()
         )
     }
+
+    @Test
+    fun testDescriptorTypes() {
+        // Taken from the BIPs: https://github.com/bitcoin/bips/blob/master/bip-0380.mediawiki
+
+        val descriptor1 = Descriptor("pk(L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1)", Network.SIGNET)
+        val descriptor2 = Descriptor("pkh([deadbeef/1/2'/3/4']L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1)", Network.SIGNET)
+        val descriptor3 = Descriptor("sh(pk(03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd))", Network.SIGNET)
+        val descriptor4 = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET)
+        val descriptor5 = Descriptor("sh(wpkh(xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi/10/20/30/40/*h))", Network.BITCOIN)
+        val descriptor6 = Descriptor("multi(1,L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1,5KYZdUEo39z3FPrtuX2QbbwGnNP5zTd7yyr2SC1j299sBCnWjss)", Network.BITCOIN)
+        // val descriptor7 = Descriptor("sortedmulti(1,04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235,03a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd)", Network.BITCOIN)
+        // val descriptor8 = Descriptor("combo(04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235)", Network.BITCOIN)
+        // val descriptor9 = Descriptor("raw(512103a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd4104a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea23552ae)", Network.BITCOIN)
+        // val descriptor10 = Descriptor("addr(3PUNyaW7M55oKWJ3kDukwk9bsKvryra15j)", Network.BITCOIN)
+        val descriptor11 = Descriptor("tr(a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd)", Network.BITCOIN)
+        val descriptor12 = Descriptor("sh(multi(2,[00000000/111'/222]xprvA1RpRA33e1JQ7ifknakTFpgNXPmW2YvmhqLQYMmrj4xJXXWYpDPS3xz7iAxn8L39njGVyuoseXzU6rcxFLJ8HFsTjSyQbLYnMpCqE2VbFWc,xprv9uPDJpEQgRQfDcW7BkF7eTya6RPxXeJCqCJGHuCJ4GiRVLzkTXBAJMu2qaMWPrS7AANYqdq6vcBcBUdJCVVFceUvJFjaPdGZ2y9WACViL4L/0))", Network.BITCOIN)
+
+        println(descriptor1.descType())
+        println(descriptor2.descType())
+        println(descriptor3.descType())
+        println(descriptor4.descType())
+        println(descriptor5.descType())
+        println(descriptor6.descType())
+        // println(descriptor7.descType())
+        // println(descriptor8.descType())
+        // println(descriptor9.descType())
+        // println(descriptor10.descType())
+        println(descriptor11.descType())
+        println(descriptor12.descType())
+
+        assertEquals(
+            expected = DescriptorType.BARE,
+            actual = descriptor1.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.PKH,
+            actual = descriptor2.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.SH,
+            actual = descriptor3.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.WPKH,
+            actual = descriptor4.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.SH_WPKH,
+            actual = descriptor5.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.BARE,
+            actual = descriptor6.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.TR,
+            actual = descriptor11.descType()
+        )
+        assertEquals(
+            expected = DescriptorType.SH,
+            actual = descriptor12.descType()
+        )
+    }
 }