Merge #255: Add missing return fields in v19

7f5827b Run the formatter (Jamil Lambert, PhD)
2e040f2 Add missing return fields in v19 (Jamil Lambert, PhD)
c4cd67c Remove redundant v29 type (Jamil Lambert, PhD)

Pull request description:

  Some of the types in v19 had missing return fields.

  - Remove a redundant v29 `network::GetNetworkInfo` method that is already defined the same in v28.
  - Add all of the missing fields from v19 and update the models, into function and reexports accordingly. Redefinitions of the types and into functions are copies of the v17 versions with the missing field added.
  - Run the formatter in a separate commit to make the changes to the reexports easier to review.

ACKs for top commit:
  tcharding:
    ACK 7f5827b

Tree-SHA512: ecb84767221d733e9656cb44a7c8d40e42f7b65f5dfd7646e02b5846bab73a010ace253deaf79546f103775da4cef4dd448a66fb6cf8f75e6e8ffb983657d81a

Author: tcharding

types/src/model/blockchain.rs

@@ -346,6 +346,8 @@ pub struct GetChainTxStats {
     pub tx_count: u32,
     /// The hash of the final block in the window.
     pub window_final_block_hash: BlockHash,
+    /// The height of the final block in the window. v0.19 and later only.
+    pub window_final_block_height: Option<u32>,
     /// Size of the window in number of blocks.
     pub window_block_count: u32,
     /// The number of transactions in the window. Only returned if "window_block_count" is > 0.
@@ -438,6 +440,8 @@ pub struct MempoolEntryFees {
 /// Models the result of JSON-RPC method `getmempoolinfo` with verbose set to true.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct GetMempoolInfo {
+    /// True if the mempool is fully loaded. v0.19 and later only.
+    pub loaded: Option<bool>,
     /// Current transaction count.
     pub size: u32,
     /// Sum of all virtual transaction sizes as defined in BIP 141.

types/src/model/network.rs

@@ -20,6 +20,8 @@ pub struct GetNetworkInfo {
     pub protocol_version: usize,
     /// The services we offer to the network (hex string).
     pub local_services: String,
+    /// The services we offer to the network. v0.19 and later only.
+    pub local_services_names: Option<Vec<String>>,
     /// `true` if transaction relay is requested from peers.
     pub local_relay: bool,
     /// The time offset.

types/src/v17/blockchain/into.rs

@@ -318,6 +318,7 @@ impl GetChainTxStats {
             time: crate::to_u32(self.time, "time")?,
             tx_count: crate::to_u32(self.tx_count, "tx_count")?,
             window_final_block_hash,
+            window_final_block_height: None,
             window_block_count: crate::to_u32(self.window_block_count, "window_block_count")?,
             window_tx_count,
             window_interval,
@@ -457,6 +458,7 @@ impl GetMempoolInfo {
         let min_relay_tx_fee = crate::btc_per_kb(self.min_relay_tx_fee)?;
 
         Ok(model::GetMempoolInfo {
+            loaded: None,
             size,
             bytes,
             usage,

types/src/v17/network/into.rs

@@ -17,6 +17,7 @@ impl GetNetworkInfo {
             subversion: self.subversion,
             protocol_version: self.protocol_version,
             local_services: self.local_services,
+            local_services_names: None,
             local_relay: self.local_relay,
             time_offset: self.time_offset,
             connections: self.connections,

types/src/v19/blockchain/into.rs

@@ -10,9 +10,9 @@ use super::error::{
     MempoolEntryFeesError,
 };
 use super::{
-    GetBlockFilter, GetBlockchainInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
-    GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MempoolEntry,
-    MempoolEntryFees,
+    GetBlockFilter, GetBlockchainInfo, GetChainTxStats, GetChainTxStatsError, GetMempoolAncestors,
+    GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
+    GetMempoolEntry, GetMempoolInfo, GetMempoolInfoError, MempoolEntry, MempoolEntryFees,
 };
 use crate::model;
 
@@ -66,6 +66,34 @@ impl GetBlockFilter {
     }
 }
 
+impl GetChainTxStats {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetChainTxStats, GetChainTxStatsError> {
+        use GetChainTxStatsError as E;
+
+        let window_final_block_hash =
+            self.window_final_block_hash.parse::<BlockHash>().map_err(E::WindowFinalBlockHash)?;
+        let window_final_block_height =
+            crate::to_u32(self.window_final_block_height, "window_final_block_height")?;
+        let window_tx_count =
+            self.window_tx_count.map(|h| crate::to_u32(h, "window_tx_count")).transpose()?;
+        let window_interval =
+            self.window_interval.map(|h| crate::to_u32(h, "window_interval")).transpose()?;
+        let tx_rate = self.tx_rate.map(|h| crate::to_u32(h, "tx_rate")).transpose()?;
+
+        Ok(model::GetChainTxStats {
+            time: crate::to_u32(self.time, "time")?,
+            tx_count: crate::to_u32(self.tx_count, "tx_count")?,
+            window_final_block_hash,
+            window_final_block_height: Some(window_final_block_height),
+            window_block_count: crate::to_u32(self.window_block_count, "window_block_count")?,
+            window_tx_count,
+            window_interval,
+            tx_rate,
+        })
+    }
+}
+
 impl GetMempoolAncestors {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> Result<model::GetMempoolAncestors, hex::HexToArrayError> {
@@ -181,3 +209,25 @@ impl MempoolEntryFees {
         })
     }
 }
+
+impl GetMempoolInfo {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetMempoolInfo, GetMempoolInfoError> {
+        let size = crate::to_u32(self.size, "size")?;
+        let bytes = crate::to_u32(self.bytes, "bytes")?;
+        let usage = crate::to_u32(self.usage, "usage")?;
+        let max_mempool = crate::to_u32(self.max_mempool, "max_mempool")?;
+        let mempool_min_fee = crate::btc_per_kb(self.mempool_min_fee)?;
+        let min_relay_tx_fee = crate::btc_per_kb(self.min_relay_tx_fee)?;
+
+        Ok(model::GetMempoolInfo {
+            loaded: Some(self.loaded),
+            size,
+            bytes,
+            usage,
+            max_mempool,
+            mempool_min_fee,
+            min_relay_tx_fee,
+        })
+    }
+}

types/src/v19/blockchain/mod.rs

@@ -13,6 +13,7 @@ use serde::{Deserialize, Serialize};
 
 // TODO: Remove wildcard, use explicit types.
 pub use self::error::*;
+use super::{GetChainTxStatsError, GetMempoolInfoError};
 
 /// Result of JSON-RPC method `getblockchaininfo`.
 ///
@@ -155,6 +156,33 @@ pub struct GetBlockFilter {
     pub header: String,
 }
 
+/// Result of JSON-RPC method `getchaintxstats`.
+///
+/// > getchaintxstats ( nblocks blockhash )
+/// >
+/// > Compute statistics about the total number and rate of transactions in the chain.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetChainTxStats {
+    /// The timestamp for the final block in the window in UNIX format.
+    pub time: i64,
+    /// The total number of transactions in the chain up to that point.
+    #[serde(rename = "txcount")]
+    pub tx_count: i64,
+    /// The hash of the final block in the window.
+    pub window_final_block_hash: String,
+    /// The height of the final block in the window.
+    pub window_final_block_height: i64,
+    /// Size of the window in number of blocks.
+    pub window_block_count: i64,
+    /// The number of transactions in the window. Only returned if "window_block_count" is > 0.
+    pub window_tx_count: Option<i64>,
+    /// The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0.
+    pub window_interval: Option<i64>,
+    /// The average rate of transactions per second in the window. Only returned if "window_interval" is > 0.
+    #[serde(rename = "txrate")]
+    pub tx_rate: Option<i64>,
+}
+
 /// Result of JSON-RPC method `getmempoolancestors` with verbose set to `false`.
 ///
 /// > getmempoolancestors txid (verbose)
@@ -269,3 +297,33 @@ pub struct MempoolEntryFees {
     /// Modified fees (see above) of in-mempool descendants (including this one) in BTC.
     pub descendant: f64,
 }
+
+/// Result of JSON-RPC method `getmempoolinfo` with verbose set to `true`.
+///
+/// > getmempoolinfo
+/// >
+/// > Returns details on the active state of the TX memory pool.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetMempoolInfo {
+    /// True if the mempool is fully loaded. v0.19 and later only.
+    pub loaded: bool,
+    /// Current transaction count.
+    pub size: i64,
+    /// Sum of all virtual transaction sizes as defined in BIP 141.
+    ///
+    /// Differs from actual serialized size because witness data is discounted.
+    pub bytes: i64,
+    /// Total memory usage for the mempool.
+    pub usage: i64,
+    /// Maximum memory usage for the mempool.
+    #[serde(rename = "maxmempool")]
+    pub max_mempool: i64,
+    /// Minimum fee rate in BTC/kB for a transaction to be accepted.
+    ///
+    /// This is the maximum of `minrelaytxfee` and the minimum mempool fee.
+    #[serde(rename = "mempoolminfee")]
+    pub mempool_min_fee: f64,
+    /// Current minimum relay fee for transactions.
+    #[serde(rename = "minrelaytxfee")]
+    pub min_relay_tx_fee: f64,
+}

types/src/v19/control.rs

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v0.19` - control.
+//!
+//! Types for methods found under the `== Control ==` section of the API docs.
+
+use serde::{Deserialize, Serialize};
+
+use super::ActiveCommand;
+
+/// Result of JSON-RPC method `getrpcinfo`.
+///
+/// > getrpcinfo
+/// >
+/// > Returns details of the RPC server.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetRpcInfo {
+    /// All active commands
+    pub active_commands: Vec<ActiveCommand>,
+    /// The complete file path to the debug log
+    #[serde(rename = "logpath")]
+    pub log_path: String,
+}

types/src/v19/mod.rs

@@ -226,18 +226,23 @@
 
 // JSON-RPC types by API section.
 mod blockchain;
+mod control;
+mod network;
 mod util;
 mod wallet;
 
 #[doc(inline)]
 pub use self::{
     blockchain::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBlockFilter,
-        GetBlockFilterError, GetBlockchainInfo, GetBlockchainInfoError, GetMempoolAncestors,
-        GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
-        GetMempoolEntry, MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
-        MempoolEntryFeesError, Softfork, SoftforkType,
+        GetBlockFilterError, GetBlockchainInfo, GetBlockchainInfoError, GetChainTxStats,
+        GetMempoolAncestors, GetMempoolAncestorsVerbose, GetMempoolDescendants,
+        GetMempoolDescendantsVerbose, GetMempoolEntry, GetMempoolInfo, MapMempoolEntryError,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
+        SoftforkType,
     },
+    control::GetRpcInfo,
+    network::{GetNetworkInfo, GetPeerInfo, PeerInfo},
     util::GetDescriptorInfo,
     wallet::{GetBalances, GetBalancesMine, GetBalancesWatchOnly},
 };
@@ -254,16 +259,15 @@ pub use crate::v17::{
     GetBalance, GetBestBlockHash, GetBlockCount, GetBlockHash, GetBlockHeader, GetBlockHeaderError,
     GetBlockHeaderVerbose, GetBlockHeaderVerboseError, GetBlockStats, GetBlockStatsError,
     GetBlockTemplate, GetBlockTemplateError, GetBlockVerboseOne, GetBlockVerboseOneError,
-    GetBlockVerboseZero, GetChainTips, GetChainTxStats, GetChainTxStatsError, GetConnectionCount,
-    GetDifficulty, GetMemoryInfoStats, GetMempoolInfo, GetMempoolInfoError, GetMiningInfo,
-    GetNetTotals, GetNetworkInfo, GetNetworkInfoAddress, GetNetworkInfoError,
-    GetNetworkInfoNetwork, GetNewAddress, GetRawChangeAddress, GetRawMempool, GetRawMempoolVerbose,
-    GetRawTransaction, GetRawTransactionVerbose, GetRawTransactionVerboseError,
-    GetReceivedByAddress, GetTransaction, GetTransactionDetail, GetTransactionDetailError,
-    GetTransactionError, GetTxOut, GetTxOutError, GetTxOutSetInfo, GetTxOutSetInfoError,
-    GetUnconfirmedBalance, GetWalletInfo, GetWalletInfoError, GetZmqNotifications,
-    ListAddressGroupings, ListAddressGroupingsError, ListAddressGroupingsItem, ListBanned,
-    ListLabels, ListLockUnspent, ListLockUnspentItem, ListLockUnspentItemError,
+    GetBlockVerboseZero, GetChainTips, GetChainTxStatsError, GetConnectionCount, GetDifficulty,
+    GetMemoryInfoStats, GetMempoolInfoError, GetMiningInfo, GetNetTotals, GetNetworkInfoAddress,
+    GetNetworkInfoError, GetNetworkInfoNetwork, GetNewAddress, GetRawChangeAddress, GetRawMempool,
+    GetRawMempoolVerbose, GetRawTransaction, GetRawTransactionVerbose,
+    GetRawTransactionVerboseError, GetReceivedByAddress, GetTransaction, GetTransactionDetail,
+    GetTransactionDetailError, GetTransactionError, GetTxOut, GetTxOutError, GetTxOutSetInfo,
+    GetTxOutSetInfoError, GetUnconfirmedBalance, GetWalletInfo, GetWalletInfoError,
+    GetZmqNotifications, ListAddressGroupings, ListAddressGroupingsError, ListAddressGroupingsItem,
+    ListBanned, ListLabels, ListLockUnspent, ListLockUnspentItem, ListLockUnspentItemError,
     ListReceivedByAddress, ListReceivedByAddressError, ListReceivedByAddressItem, ListSinceBlock,
     ListSinceBlockError, ListSinceBlockTransaction, ListSinceBlockTransactionError,
     ListTransactions, ListTransactionsItem, ListTransactionsItemError, ListUnspentItemError,
@@ -277,8 +281,7 @@ pub use crate::v17::{
 #[doc(inline)]
 pub use crate::v18::{
     ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
-    AnalyzePsbtInputMissingError, DeriveAddresses, GetNodeAddresses, GetPeerInfo,
-    GetReceivedByLabel, GetRpcInfo, JoinPsbts, ListReceivedByLabel, ListReceivedByLabelError,
-    ListUnspent, ListUnspentItem, ListWalletDir, ListWalletDirWallet, NodeAddress, PeerInfo,
-    UtxoUpdatePsbt,
+    AnalyzePsbtInputMissingError, DeriveAddresses, GetNodeAddresses, GetReceivedByLabel, JoinPsbts,
+    ListReceivedByLabel, ListReceivedByLabelError, ListUnspent, ListUnspentItem, ListWalletDir,
+    ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
 };

types/src/v19/network/into.rs

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use super::{GetNetworkInfo, GetNetworkInfoError};
+use crate::model;
+
+impl GetNetworkInfo {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetNetworkInfo, GetNetworkInfoError> {
+        use GetNetworkInfoError as E;
+
+        let relay_fee = crate::btc_per_kb(self.relay_fee).map_err(E::RelayFee)?;
+        let incremental_fee = crate::btc_per_kb(self.incremental_fee).map_err(E::IncrementalFee)?;
+
+        Ok(model::GetNetworkInfo {
+            version: self.version,
+            subversion: self.subversion,
+            protocol_version: self.protocol_version,
+            local_services: self.local_services,
+            local_services_names: Some(self.local_services_names),
+            local_relay: self.local_relay,
+            time_offset: self.time_offset,
+            connections: self.connections,
+            network_active: self.network_active,
+            networks: self.networks.into_iter().map(|n| n.into_model()).collect(),
+            relay_fee,
+            incremental_fee,
+            local_addresses: self.local_addresses.into_iter().map(|a| a.into_model()).collect(),
+            warnings: vec![self.warnings],
+        })
+    }
+}