Rename is_ranged to is_wildcard, to match rust-bitcoin's terminology

Author: shesek

README.md

@@ -318,7 +318,7 @@ You can associate the wallets to their parent xpub using the `bip32_origins` fie
 
 - `desc` - the output script descriptor tracked by this wallet
 - `network` - the network this wallet belongs to (`bitcoin`, `testnet` or `regtest`)
-- `is_ranged` - a boolean indicating whether the descriptor is ranged
+- `is_wildcard` - a boolean indicating whether the descriptor includes wildcard keys (`xpub../*`)
 - `bip32_origins` - bip32 origin information for the keys contained in the descriptor
 - `gap_limit` - the gap limited configured for this wallet
 - `initial_import_size` - the gap limit used during the initial import
@@ -344,28 +344,28 @@ $ curl localhost:3060/wallets
   "xjm8w0el": {
     "desc": "wpkh(xpub661MyMwAqRbcEhsxS9g2qyYKSGA3seqWVNhmVhU27ddQx952PaZ6G4V26msGKrqYBjoBRwFyzaucPUkhw7DNaeMVUYJV1bqosxzVxToJdcy/0/*)#xjm8w0el",
     "network": "bitcoin",
-    "is_ranged": true,
+    "is_wildcard": true,
     "bip32_origins": [ "80e042a9/0" ],
     ...
   },
   "k38panl4": {
     "desc": "wsh(multi(2,xpub661MyMwAqRbcEuy9nKLTbGCi2NhqTWeQPT3gd2QdfmeaieDHLHiwTnSnw1GrP2xdaJwEDQJLasfw6LNK7hVADcCN9d1M1RtxitrR3CwvtjV/0/*,[16eabcf7/2]xpub684GUXwH4bY8Pf3fgSunTGz3hwJZhJzaNwgT55aWGWQM7KsiUFEXWLYPy1Q19gAEvc9LG5TN5PdmGPoyocmkkpKCCMV27ugL7XqHeHRwJzH/1/*))#k38panl4",
     "network": "bitcoin",
-    "is_ranged": true,
+    "is_wildcard": true,
     "bip32_origins": [ "367e5b47/0", "16eabcf7/2/1" ],
     ...
   },
   "cletf5fc": {
     "desc": "pkh(xpub661MyMwAqRbcEoHAdGB6AaGRhLmHVemxe6acQikhJgfV3sr1SmapjQv8ZfBwWa1YKmFbyR6ta96TKiCNTctvZix58hAR7mDtjdWK2E18PjR/0/*)#cletf5fc",
     "network": "bitcoin",
-    "is_ranged": true,
+    "is_wildcard": true,
     "bip32_origins": [ "7a32efaa/0" ],
     ...
   },
   "ftu25peq": {
     "desc": "pkh(xpub661MyMwAqRbcEoHAdGB6AaGRhLmHVemxe6acQikhJgfV3sr1SmapjQv8ZfBwWa1YKmFbyR6ta96TKiCNTctvZix58hAR7mDtjdWK2E18PjR/1/*)#ftu25peq",
     "network": "bitcoin",
-    "is_ranged": true,
+    "is_wildcard": true,
     "bip32_origins": [ "7a32efaa/1" ],
     ...
   }
@@ -393,7 +393,7 @@ $ curl localhost:3060/wallet/xjm8w0el
 {
   "desc": "wpkh(xpub661MyMwAqRbcEhsxS9g2qyYKSGA3seqWVNhmVhU27ddQx952PaZ6G4V26msGKrqYBjoBRwFyzaucPUkhw7DNaeMVUYJV1bqosxzVxToJdcy/0/*)#xjm8w0el",
   "network": "bitcoin",
-  "is_ranged": true,
+  "is_wildcard": true,
   "bip32_origins": [ "80e042a9/0" ],
   "rescan_policy": "now",
   "done_initial_import": true,
@@ -452,7 +452,7 @@ Issues a 307 redirection to the url of the next derivation index (`/wallet/:chec
 Note that the returned address is not marked as used until receiving funds; If you wish to skip it and generate a different
 address without receiving funds to it, you can specify an explicit derivation index instead.
 
-Non-ranged descriptors always return `0` as the next index.
+Non-wildcard descriptors always return `0` as their next index.
 
 Examples:
 ```

src/util/descriptor.rs

@@ -37,7 +37,7 @@ pub fn derive_desc_str(desc: &ExtendedDescriptor, index: u32) -> String {
 #[derive(Debug, Clone)]
 pub struct DescKeyInfo {
     pub bip32_origin: Bip32Origin,
-    pub is_ranged: bool,
+    pub is_wildcard: bool,
 }
 
 impl From<&ExtendedDescriptor> for Checksum {
@@ -77,7 +77,7 @@ impl DescKeyInfo {
 
                 keys_info.push(DescKeyInfo {
                     bip32_origin,
-                    is_ranged: desc_xpub.is_wildcard,
+                    is_wildcard: desc_xpub.is_wildcard,
                 });
 
                 valid_networks = valid_networks && xpub_matches_network(&desc_xpub.xkey, network);
@@ -86,7 +86,7 @@ impl DescKeyInfo {
                 if let Some(bip32_origin) = &desc_single.origin {
                     keys_info.push(DescKeyInfo {
                         bip32_origin: bip32_origin.into(),
-                        is_ranged: false,
+                        is_wildcard: false,
                     });
                 }
             }

src/wallet.rs

@@ -189,7 +189,7 @@ impl WalletWatcher {
 #[derive(Debug, Clone)]
 pub struct Wallet {
     desc: ExtendedDescriptor,
-    is_ranged: bool,
+    is_wildcard: bool,
     checksum: Checksum,
     keys_info: Vec<DescKeyInfo>,
     network: Network,
@@ -218,13 +218,13 @@ impl Wallet {
 
         let checksum = Checksum::from(&desc);
         let keys_info = DescKeyInfo::extract(&desc, network)?;
-        let is_ranged = keys_info.iter().any(|x| x.is_ranged);
+        let is_wildcard = keys_info.iter().any(|x| x.is_wildcard);
 
         Ok(Self {
             desc,
             checksum,
             keys_info,
-            is_ranged,
+            is_wildcard,
             network,
             gap_limit,
             // setting initial_import_size < gap_limit makes no sense, the user probably meant to increase both
@@ -281,7 +281,7 @@ impl Wallet {
 
     /// Returns the maximum index that needs to be watched
     fn watch_index(&self) -> u32 {
-        if !self.is_ranged {
+        if !self.is_wildcard {
             return 0;
         }
 
@@ -326,7 +326,7 @@ impl Wallet {
     }
 
     pub fn get_next_index(&self) -> u32 {
-        if self.is_ranged {
+        if self.is_wildcard {
             self.max_funded_index
                 .map_or(0, |max_funded_index| max_funded_index + 1)
         } else {
@@ -335,7 +335,7 @@ impl Wallet {
     }
 
     pub fn is_valid_index(&self, index: u32) -> bool {
-        if self.is_ranged {
+        if self.is_wildcard {
             // non-hardended derivation only
             index & (1 << 31) == 0
         } else {
@@ -347,7 +347,7 @@ impl Wallet {
         // return None if this wallet has no history at all
         let max_funded_index = self.max_funded_index?;
 
-        Some(if self.is_ranged {
+        Some(if self.is_wildcard {
             (0..=max_funded_index)
                 .map(|derivation_index| self.derive_address(derivation_index))
                 .fold((0, 0), |(curr_gap, max_gap), address| {
@@ -368,7 +368,7 @@ impl Wallet {
         self.keys_info
             .iter()
             .map(|i| {
-                if i.is_ranged {
+                if i.is_wildcard {
                     i.bip32_origin.child(index.into())
                 } else {
                     i.bip32_origin.clone()
@@ -485,7 +485,7 @@ impl Serialize for Wallet {
 
         rgb.serialize_field("desc", &desc_str)?;
         rgb.serialize_field("network", &self.network)?;
-        rgb.serialize_field("is_ranged", &self.is_ranged)?;
+        rgb.serialize_field("is_wildcard", &self.is_wildcard)?;
         rgb.serialize_field("bip32_origins", &bip32_origins)?;
         rgb.serialize_field("rescan_since", &self.rescan_since)?;
         rgb.serialize_field("done_initial_import", &self.done_initial_import)?;
@@ -496,7 +496,7 @@ impl Serialize for Wallet {
             &self.desc.max_satisfaction_weight(*DESC_CTX),
         )?;
 
-        if self.is_ranged {
+        if self.is_wildcard {
             rgb.serialize_field("gap_limit", &self.gap_limit)?;
             rgb.serialize_field("initial_import_size", &self.initial_import_size)?;
         }