Merge #248: Adds importdescriptors

718ba56 Adds importdescriptors (Sergi Delgado Segura)

Pull request description:

  Adds `importdescriptors` rpc. I've renamed `ImportMultiRescanSince` to `Timestamp` given it is not being used solely for multi rescan anymore.

  Feels like `ImportMultiResult` should also be renamed, given it is now used by both `importmulti` and `importdescriptors`. I haven't found a proper name for it though.

ACKs for top commit:
  apoelstra:
    ACK 718ba56

Tree-SHA512: 16272acd1ef3be6b5ae52964ab1c597884c7d0d7379a81ab89fee1f1cc169d40885208c37ea761f3bc95454972774ddbee66db670c19706da2bb335b0180bb73

Author: apoelstra

client/src/client.rs

@@ -658,6 +658,14 @@ pub trait RpcApi: Sized {
         self.call("importmulti", handle_defaults(&mut args, &[null()]))
     }
 
+    fn import_descriptors(
+        &self,
+        req: json::ImportDescriptors,
+    ) -> Result<Vec<json::ImportMultiResult>> {
+        let json_request = vec![serde_json::to_value(req)?];
+        self.call("importdescriptors", handle_defaults(&mut [json_request.into()], &[null()]))
+    }
+
     fn set_label(&self, address: &Address, label: &str) -> Result<()> {
         self.call("setlabel", &[address.to_string().into(), label.into()])
     }

json/src/lib.rs

@@ -1132,7 +1132,7 @@ impl<'a> serde::Serialize for ImportMultiRequestScriptPubkey<'a> {
 /// Note: unlike in bitcoind, `timestamp` defaults to 0.
 #[derive(Clone, PartialEq, Eq, Debug, Default, Serialize)]
 pub struct ImportMultiRequest<'a> {
-    pub timestamp: ImportMultiRescanSince,
+    pub timestamp: Timestamp,
     /// If using descriptor, do not also provide address/scriptPubKey, scripts, or pubkeys.
     #[serde(rename = "desc", skip_serializing_if = "Option::is_none")]
     pub descriptor: Option<&'a str>,
@@ -1165,32 +1165,32 @@ pub struct ImportMultiOptions {
 }
 
 #[derive(Clone, PartialEq, Eq, Copy, Debug)]
-pub enum ImportMultiRescanSince {
+pub enum Timestamp {
     Now,
-    Timestamp(u64),
+    Time(u64),
 }
 
-impl serde::Serialize for ImportMultiRescanSince {
+impl serde::Serialize for Timestamp {
     fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
     where
         S: serde::Serializer,
     {
         match *self {
-            ImportMultiRescanSince::Now => serializer.serialize_str("now"),
-            ImportMultiRescanSince::Timestamp(timestamp) => serializer.serialize_u64(timestamp),
+            Timestamp::Now => serializer.serialize_str("now"),
+            Timestamp::Time(timestamp) => serializer.serialize_u64(timestamp),
         }
     }
 }
 
-impl<'de> serde::Deserialize<'de> for ImportMultiRescanSince {
+impl<'de> serde::Deserialize<'de> for Timestamp {
     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
     where
         D: serde::Deserializer<'de>,
     {
         use serde::de;
         struct Visitor;
         impl<'de> de::Visitor<'de> for Visitor {
-            type Value = ImportMultiRescanSince;
+            type Value = Timestamp;
 
             fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                 write!(formatter, "unix timestamp or 'now'")
@@ -1200,15 +1200,15 @@ impl<'de> serde::Deserialize<'de> for ImportMultiRescanSince {
             where
                 E: de::Error,
             {
-                Ok(ImportMultiRescanSince::Timestamp(value))
+                Ok(Timestamp::Time(value))
             }
 
             fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
             where
                 E: de::Error,
             {
                 if value == "now" {
-                    Ok(ImportMultiRescanSince::Now)
+                    Ok(Timestamp::Now)
                 } else {
                     Err(de::Error::custom(format!(
                         "invalid str '{}', expecting 'now' or unix timestamp",
@@ -1221,21 +1221,21 @@ impl<'de> serde::Deserialize<'de> for ImportMultiRescanSince {
     }
 }
 
-impl Default for ImportMultiRescanSince {
+impl Default for Timestamp {
     fn default() -> Self {
-        ImportMultiRescanSince::Timestamp(0)
+        Timestamp::Time(0)
     }
 }
 
-impl From<u64> for ImportMultiRescanSince {
-    fn from(timestamp: u64) -> Self {
-        ImportMultiRescanSince::Timestamp(timestamp)
+impl From<u64> for Timestamp {
+    fn from(t: u64) -> Self {
+        Timestamp::Time(t)
     }
 }
 
-impl From<Option<u64>> for ImportMultiRescanSince {
+impl From<Option<u64>> for Timestamp {
     fn from(timestamp: Option<u64>) -> Self {
-        timestamp.map_or(ImportMultiRescanSince::Now, ImportMultiRescanSince::Timestamp)
+        timestamp.map_or(Timestamp::Now, Timestamp::Time)
     }
 }
 
@@ -1253,6 +1253,24 @@ pub struct ImportMultiResult {
     pub error: Option<ImportMultiResultError>,
 }
 
+/// A import request for importdescriptors.
+#[derive(Clone, PartialEq, Eq, Debug, Default, Serialize)]
+pub struct ImportDescriptors<'a> {
+    #[serde(rename = "desc")]
+    pub descriptor: &'a str,
+    pub timestamp: Timestamp,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub active: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub range: Option<(usize, usize)>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub next_index: Option<usize>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub internal: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub label: Option<&'a str>,
+}
+
 /// Progress toward rejecting pre-softfork blocks
 #[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
 pub struct RejectStatus {