descriptors: introduce a newtype for the multipath descriptor

The multipath descriptor has very different properties than the receive
and change ones. Use a newtype to assist us in differentiating those.

Author: darosior

src/bitcoin/d/mod.rs

@@ -1,7 +1,7 @@
 ///! Implementation of the Bitcoin interface using bitcoind.
 ///!
 ///! We use the RPC interface and a watchonly descriptor wallet.
-use crate::{bitcoin::BlockChainTip, config, descriptors::InheritanceDescriptor};
+use crate::{bitcoin::BlockChainTip, config, descriptors::MultipathDescriptor};
 
 use std::{collections::HashSet, convert::TryInto, fs, io, str::FromStr, time::Duration};
 
@@ -352,7 +352,7 @@ impl BitcoinD {
     }
 
     // Import the receive and change descriptors from the multipath descriptor to bitcoind.
-    fn import_descriptor(&self, desc: &InheritanceDescriptor) -> Option<String> {
+    fn import_descriptor(&self, desc: &MultipathDescriptor) -> Option<String> {
         let descriptors = [desc.receive_descriptor(), desc.change_descriptor()]
             .iter()
             .map(|desc| {
@@ -401,7 +401,7 @@ impl BitcoinD {
     /// Create the watchonly wallet on bitcoind, and import it the main descriptor.
     pub fn create_watchonly_wallet(
         &self,
-        main_descriptor: &InheritanceDescriptor,
+        main_descriptor: &MultipathDescriptor,
     ) -> Result<(), BitcoindError> {
         // Remove any leftover. This can happen if we delete the watchonly wallet but don't restart
         // bitcoind.
@@ -441,7 +441,7 @@ impl BitcoinD {
     /// Perform various sanity checks on the bitcoind instance.
     pub fn sanity_check(
         &self,
-        main_descriptor: &InheritanceDescriptor,
+        main_descriptor: &MultipathDescriptor,
         config_network: bitcoin::Network,
     ) -> Result<(), BitcoindError> {
         // Check the minimum supported bitcoind version

src/bitcoin/poller/looper.rs

@@ -219,7 +219,7 @@ pub fn looper(
     db: sync::Arc<sync::Mutex<dyn DatabaseInterface>>,
     shutdown: sync::Arc<atomic::AtomicBool>,
     poll_interval: time::Duration,
-    desc: descriptors::InheritanceDescriptor,
+    desc: descriptors::MultipathDescriptor,
 ) {
     let mut last_poll = None;
     let mut synced = false;

src/bitcoin/poller/mod.rs

@@ -22,7 +22,7 @@ impl Poller {
         bit: sync::Arc<sync::Mutex<dyn BitcoinInterface>>,
         db: sync::Arc<sync::Mutex<dyn DatabaseInterface>>,
         poll_interval: time::Duration,
-        desc: descriptors::InheritanceDescriptor,
+        desc: descriptors::MultipathDescriptor,
     ) -> Poller {
         let shutdown = sync::Arc::from(atomic::AtomicBool::from(false));
         let handle = thread::Builder::new()

src/commands/mod.rs

@@ -174,7 +174,8 @@ impl DaemonControl {
     fn derived_desc(&self, index: bip32::ChildNumber) -> descriptors::DerivedInheritanceDescriptor {
         self.config
             .main_descriptor
-            .derive_receive(index, &self.secp)
+            .receive_descriptor()
+            .derive(index, &self.secp)
     }
 }
 
@@ -487,7 +488,7 @@ impl DaemonControl {
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct GetInfoDescriptors {
-    pub main: descriptors::InheritanceDescriptor,
+    pub main: descriptors::MultipathDescriptor,
 }
 
 /// Information about the daemon

src/config.rs

@@ -1,4 +1,4 @@
-use crate::descriptors::InheritanceDescriptor;
+use crate::descriptors::MultipathDescriptor;
 
 use std::{net::SocketAddr, path::PathBuf, str::FromStr, time::Duration};
 
@@ -92,7 +92,7 @@ pub struct Config {
         deserialize_with = "deserialize_fromstr",
         serialize_with = "serialize_to_string"
     )]
-    pub main_descriptor: InheritanceDescriptor,
+    pub main_descriptor: MultipathDescriptor,
     /// Settings for the Bitcoin interface
     pub bitcoin_config: BitcoinConfig,
     /// Settings specific to bitcoind as the Bitcoin interface
@@ -113,7 +113,7 @@ pub enum ConfigError {
     DatadirNotFound,
     FileNotFound,
     ReadingFile(String),
-    UnexpectedDescriptor(Box<InheritanceDescriptor>),
+    UnexpectedDescriptor(Box<MultipathDescriptor>),
     Unexpected(String),
 }
 

src/database/sqlite/mod.rs

@@ -18,7 +18,7 @@ use crate::{
         },
         Coin,
     },
-    descriptors::InheritanceDescriptor,
+    descriptors::MultipathDescriptor,
 };
 
 use std::{convert::TryInto, fmt, io, path};
@@ -36,7 +36,7 @@ pub enum SqliteDbError {
     FileNotFound(path::PathBuf),
     UnsupportedVersion(i64),
     InvalidNetwork(bitcoin::Network),
-    DescriptorMismatch(Box<InheritanceDescriptor>),
+    DescriptorMismatch(Box<MultipathDescriptor>),
     Rusqlite(rusqlite::Error),
 }
 
@@ -80,7 +80,7 @@ impl From<rusqlite::Error> for SqliteDbError {
 #[derive(Debug, Clone)]
 pub struct FreshDbOptions {
     pub bitcoind_network: bitcoin::Network,
-    pub main_descriptor: InheritanceDescriptor,
+    pub main_descriptor: MultipathDescriptor,
 }
 
 #[derive(Debug, Clone)]
@@ -119,7 +119,7 @@ impl SqliteDb {
     pub fn sanity_check(
         &self,
         bitcoind_network: bitcoin::Network,
-        main_descriptor: &InheritanceDescriptor,
+        main_descriptor: &MultipathDescriptor,
     ) -> Result<(), SqliteDbError> {
         let mut conn = self.connection()?;
 
@@ -240,7 +240,8 @@ impl SqliteConn {
             let next_la_index = next_index + LOOK_AHEAD_LIMIT - 1;
             let next_la_address = db_wallet
                 .main_descriptor
-                .derive_receive(next_la_index.into(), secp)
+                .receive_descriptor()
+                .derive(next_la_index.into(), secp)
                 .address(network);
             db_tx
                 .execute(
@@ -485,7 +486,7 @@ mod tests {
 
     fn dummy_options() -> FreshDbOptions {
         let desc_str = "wsh(andor(pk(tpubDEN9WSToTyy9ZQfaYqSKfmVqmq1VVLNtYfj3Vkqh67et57eJ5sTKZQBkHqSwPUsoSskJeaYnPttHe2VrkCsKA27kUaN9SDc5zhqeLzKa1rr/<0;1>/*),older(10000),pk(tpubD8LYfn6njiA2inCoxwM7EuN3cuLVcaHAwLYeups13dpevd3nHLRdK9NdQksWXrhLQVxcUZRpnp5CkJ1FhE61WRAsHxDNAkvGkoQkAeWDYjV/<0;1>/*)))#5f6qd0d9";
-        let main_descriptor = InheritanceDescriptor::from_str(desc_str).unwrap();
+        let main_descriptor = MultipathDescriptor::from_str(desc_str).unwrap();
         FreshDbOptions {
             bitcoind_network: bitcoin::Network::Bitcoin,
             main_descriptor,
@@ -534,7 +535,7 @@ mod tests {
             .contains("Database was created for network");
         fs::remove_file(&db_path).unwrap();
         let other_desc_str = "wsh(andor(pk(tpubDExU4YLJkyQ9RRbVScQq2brFxWWha7WmAUByPWyaWYwmcTv3Shx8aHp6mVwuE5n4TeM4z5DTWGf2YhNPmXtfvyr8cUDVvA3txdrFnFgNdF7/<0;1>/*),older(10000),pk(tpubD8LYfn6njiA2inCoxwM7EuN3cuLVcaHAwLYeups13dpevd3nHLRdK9NdQksWXrhLQVxcUZRpnp5CkJ1FhE61WRAsHxDNAkvGkoQkAeWDYjV/<0;1>/*)))";
-        let other_desc = InheritanceDescriptor::from_str(other_desc_str).unwrap();
+        let other_desc = MultipathDescriptor::from_str(other_desc_str).unwrap();
         let db = SqliteDb::new(db_path.clone(), Some(options.clone()), &secp).unwrap();
         db.sanity_check(bitcoin::Network::Bitcoin, &other_desc)
             .unwrap_err()
@@ -714,23 +715,26 @@ mod tests {
             // There is the index for the first index
             let addr = options
                 .main_descriptor
-                .derive_receive(0.into(), &secp)
+                .receive_descriptor()
+                .derive(0.into(), &secp)
                 .address(options.bitcoind_network);
             let db_addr = conn.db_address(&addr).unwrap();
             assert_eq!(db_addr.derivation_index, 0.into());
 
             // There is the index for the 199th index (look-ahead limit)
             let addr = options
                 .main_descriptor
-                .derive_receive(199.into(), &secp)
+                .receive_descriptor()
+                .derive(199.into(), &secp)
                 .address(options.bitcoind_network);
             let db_addr = conn.db_address(&addr).unwrap();
             assert_eq!(db_addr.derivation_index, 199.into());
 
             // And not for the 200th one.
             let addr = options
                 .main_descriptor
-                .derive_receive(200.into(), &secp)
+                .receive_descriptor()
+                .derive(200.into(), &secp)
                 .address(options.bitcoind_network);
             assert!(conn.db_address(&addr).is_none());
 

src/database/sqlite/schema.rs

@@ -1,4 +1,4 @@
-use crate::descriptors::InheritanceDescriptor;
+use crate::descriptors::MultipathDescriptor;
 
 use std::{convert::TryFrom, str::FromStr};
 
@@ -103,7 +103,7 @@ impl TryFrom<&rusqlite::Row<'_>> for DbTip {
 pub struct DbWallet {
     pub id: i64,
     pub timestamp: u32,
-    pub main_descriptor: InheritanceDescriptor,
+    pub main_descriptor: MultipathDescriptor,
     pub deposit_derivation_index: bip32::ChildNumber,
 }
 
@@ -115,7 +115,7 @@ impl TryFrom<&rusqlite::Row<'_>> for DbWallet {
         let timestamp = row.get(1)?;
 
         let desc_str: String = row.get(2)?;
-        let main_descriptor = InheritanceDescriptor::from_str(&desc_str)
+        let main_descriptor = MultipathDescriptor::from_str(&desc_str)
             .expect("Insane database: can't parse deposit descriptor");
 
         let der_idx: u32 = row.get(3)?;

src/database/sqlite/utils.rs

@@ -98,7 +98,8 @@ pub fn create_fresh_db(
         // TODO: have this as a helper in descriptors.rs
         let address = options
             .main_descriptor
-            .derive_receive(index.into(), secp)
+            .receive_descriptor()
+            .derive(index.into(), secp)
             .address(options.bitcoind_network);
         query += &format!(
             "INSERT INTO addresses (address, derivation_index) VALUES (\"{}\", {});\n",