Merge #267: Add missing return fields in v20 and v21

51ebe64 Run the formatter (Jamil Lambert, PhD)
4c32f09 Add missing fields to getnetworkinfo, getpeerinfo (Jamil Lambert, PhD)
56ffb4f Add missing fields to getmempoolinfo (Jamil Lambert, PhD)
0e97a48 Add missing fields to getblockchaininfo (Jamil Lambert, PhD)
d65d26c Add missing return fields to createmultisig (Jamil Lambert, PhD)

Pull request description:

  Some of the types in v20 and v21 had missing return fields.

  For each of the following RPCs that were missing a return field in v20 or v21 check for further changes up to v29 and implement them:

  -  `createmultisig`
  - `getblockchaininfo`
  - `getmempoolinfo`
  - `getnetworkinfo`
  - `getpeerinfo`

  Add all of the missing fields update the models, into function and reexports accordingly. Redefinitions of the types and into functions are modified copies of the most recent version of the RPC that had fields added.

  Run the formatter in a separate commit to make the changes to the reexports easier to review.

ACKs for top commit:
  tcharding:
    ACK 51ebe64

Tree-SHA512: c24cd5eea554e01fa78aad4fdbafc2206ad3b0999b8f5e45b984c3900e7e6e8a49638972803318793fb450c8fbfa400a007a756da425f39efe84334404e2ca8c

Author: tcharding

types/src/model/blockchain.rs

@@ -84,6 +84,8 @@ pub struct GetBlockchainInfo {
     pub target: Option<Target>, // Only from v29 onwards
     /// The current difficulty.
     pub difficulty: f64,
+    /// The block time expressed in UNIX epoch time. v23 and later only.
+    pub time: Option<u32>,
     /// Median time for the current best block.
     pub median_time: u32,
     /// Estimate of verification progress (between 0 and 1).
@@ -151,6 +153,8 @@ pub struct Bip9SoftforkInfo {
     pub timeout: u32,
     /// Height of the first block to which the status applies.
     pub since: u32,
+    /// Minimum height of blocks for which the rules may be enforced. v0.21 and later only.
+    pub min_activation_height: Option<i64>,
     /// Numeric statistics about BIP-9 signalling for a softfork (only for "started" status).
     pub statistics: Option<Bip9SoftforkStatistics>,
 }
@@ -450,6 +454,9 @@ pub struct GetMempoolInfo {
     pub bytes: u32,
     /// Total memory usage for the mempool.
     pub usage: u32,
+    /// Total fees for the mempool in BTC, ignoring modified fees through prioritisetransaction. v23
+    /// and later only.
+    pub total_fee: Option<f64>,
     /// Maximum memory usage for the mempool.
     pub max_mempool: u32,
     /// Minimum fee rate in BTC/kB for a transaction to be accepted.
@@ -458,6 +465,13 @@ pub struct GetMempoolInfo {
     pub mempool_min_fee: Option<FeeRate>,
     /// Current minimum relay fee for transactions.
     pub min_relay_tx_fee: Option<FeeRate>,
+    /// Minimum fee rate increment for mempool limiting or replacement in BTC/kvB. v24 and later only.
+    pub incremental_relay_fee: Option<FeeRate>,
+    ///  Current number of transactions that haven't passed initial broadcast yet. v21 and later only.
+    pub unbroadcast_count: Option<u32>,
+    /// True if the mempool accepts RBF without replaceability signaling inspection. v24 and later
+    /// only.
+    pub full_rbf: Option<bool>,
 }
 
 /// Models the result of JSON-RPC method `getrawmempool` with verbose set to false.

types/src/model/network.rs

@@ -28,6 +28,10 @@ pub struct GetNetworkInfo {
     pub time_offset: isize,
     /// The total number of connections.
     pub connections: usize,
+    /// The number of inbound connections. v28 and later only.
+    pub connections_in: Option<usize>,
+    /// The number of outbound connections. v28 and later only.
+    pub connections_out: Option<usize>,
     /// Whether p2p networking is enabled.
     pub network_active: bool,
     /// Information per network.

types/src/model/util.rs

@@ -16,6 +16,10 @@ pub struct CreateMultisig {
     pub address: Address<NetworkUnchecked>,
     /// The string value of the hex-encoded redemption script.
     pub redeem_script: ScriptBuf,
+    /// The descriptor for this multisig. v0.20 and later only.
+    pub descriptor: Option<String>,
+    /// Any warnings resulting from the creation of this multisig. v23 and later only.
+    pub warnings: Option<Vec<String>>,
 }
 
 /// Models the result of JSON-RPC method `estimatesmartfee`.

types/src/v17/blockchain/into.rs

@@ -104,6 +104,7 @@ impl GetBlockchainInfo {
             bits: None,
             target: None,
             difficulty: self.difficulty,
+            time: None,
             median_time: crate::to_u32(self.median_time, "median_time")?,
             verification_progress: self.verification_progress,
             initial_block_download: self.initial_block_download,
@@ -462,9 +463,13 @@ impl GetMempoolInfo {
             size,
             bytes,
             usage,
+            total_fee: None,
             max_mempool,
             mempool_min_fee,
             min_relay_tx_fee,
+            incremental_relay_fee: None,
+            unbroadcast_count: None,
+            full_rbf: None,
         })
     }
 }

types/src/v17/network/into.rs

@@ -21,6 +21,8 @@ impl GetNetworkInfo {
             local_relay: self.local_relay,
             time_offset: self.time_offset,
             connections: self.connections,
+            connections_in: None,
+            connections_out: None,
             network_active: self.network_active,
             networks: self.networks.into_iter().map(|n| n.into_model()).collect(),
             relay_fee,

types/src/v17/util/into.rs

@@ -17,7 +17,7 @@ impl CreateMultisig {
         let address = self.address.parse::<Address<_>>().map_err(E::Address)?;
         let redeem_script = ScriptBuf::from_hex(&self.redeem_script).map_err(E::RedeemScript)?;
 
-        Ok(model::CreateMultisig { address, redeem_script })
+        Ok(model::CreateMultisig { address, redeem_script, descriptor: None, warnings: None })
     }
 }
 

types/src/v19/blockchain/into.rs

@@ -39,6 +39,7 @@ impl GetBlockchainInfo {
             bits: None,
             target: None,
             difficulty: self.difficulty,
+            time: None,
             median_time: crate::to_u32(self.median_time, "median_time")?,
             verification_progress: self.verification_progress,
             initial_block_download: self.initial_block_download,
@@ -225,9 +226,13 @@ impl GetMempoolInfo {
             size,
             bytes,
             usage,
+            total_fee: None,
             max_mempool,
             mempool_min_fee,
             min_relay_tx_fee,
+            incremental_relay_fee: None,
+            unbroadcast_count: None,
+            full_rbf: None,
         })
     }
 }

types/src/v19/network/into.rs

@@ -20,6 +20,8 @@ impl GetNetworkInfo {
             local_relay: self.local_relay,
             time_offset: self.time_offset,
             connections: self.connections,
+            connections_in: None,
+            connections_out: None,
             network_active: self.network_active,
             networks: self.networks.into_iter().map(|n| n.into_model()).collect(),
             relay_fee,

types/src/v20/mod.rs

@@ -228,46 +228,48 @@
 // JSON-RPC types by API section.
 mod control;
 mod network;
+mod util;
 
 #[doc(inline)]
 pub use self::{
     control::Logging,
     network::{Banned, ListBanned},
+    util::CreateMultisig,
 };
 #[doc(inline)]
 pub use crate::{
     v17::{
         AbortRescan, AddMultisigAddress, AddMultisigAddressError, AddedNode, AddedNodeAddress,
         AddressInformation, BumpFee, BumpFeeError, ChainTips, ChainTipsError, ChainTipsStatus,
-        CombinePsbt, CombineRawTransaction, ConvertToPsbt, CreateMultisig, CreateMultisigError,
-        CreatePsbt, CreateRawTransaction, CreateWallet, DecodePsbt, DecodePsbtError,
-        DecodeRawTransaction, DecodeScript, DecodeScriptError, DumpPrivKey, DumpWallet,
-        EncryptWallet, EstimateSmartFee, FinalizePsbt, FinalizePsbtError, FundRawTransaction,
-        FundRawTransactionError, Generate, GenerateToAddress, GetAddedNodeInfo, GetAddressInfo,
-        GetAddressInfoEmbedded, GetAddressInfoEmbeddedError, GetAddressInfoError,
-        GetAddressInfoLabel, GetAddressesByLabel, GetBalance, GetBestBlockHash, GetBlockCount,
-        GetBlockHash, GetBlockHeader, GetBlockHeaderError, GetBlockHeaderVerbose,
-        GetBlockHeaderVerboseError, GetBlockStats, GetBlockStatsError, GetBlockTemplate,
-        GetBlockTemplateError, GetBlockVerboseOne, GetBlockVerboseOneError, 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, ListLabels, ListLockUnspent, ListLockUnspentItem,
-        ListLockUnspentItemError, ListReceivedByAddress, ListReceivedByAddressError,
-        ListReceivedByAddressItem, ListSinceBlock, ListSinceBlockError, ListSinceBlockTransaction,
-        ListSinceBlockTransactionError, ListTransactions, ListTransactionsItem,
-        ListTransactionsItemError, ListUnspentItemError, ListWallets, LoadWallet, Locked,
-        PruneBlockchain, RawTransactionError, RawTransactionInput, RawTransactionOutput,
-        RescanBlockchain, SendMany, SendRawTransaction, SendToAddress, SetNetworkActive,
-        SignMessage, SignMessageWithPrivKey, SignRawTransaction, SignRawTransactionError,
-        SoftforkReject, TestMempoolAccept, TransactionCategory, UploadTarget, ValidateAddress,
-        ValidateAddressError, VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
-        WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+        CombinePsbt, CombineRawTransaction, ConvertToPsbt, CreateMultisigError, CreatePsbt,
+        CreateRawTransaction, CreateWallet, DecodePsbt, DecodePsbtError, DecodeRawTransaction,
+        DecodeScript, DecodeScriptError, DumpPrivKey, DumpWallet, EncryptWallet, EstimateSmartFee,
+        FinalizePsbt, FinalizePsbtError, FundRawTransaction, FundRawTransactionError, Generate,
+        GenerateToAddress, GetAddedNodeInfo, GetAddressInfo, GetAddressInfoEmbedded,
+        GetAddressInfoEmbeddedError, GetAddressInfoError, GetAddressInfoLabel, GetAddressesByLabel,
+        GetBalance, GetBestBlockHash, GetBlockCount, GetBlockHash, GetBlockHeader,
+        GetBlockHeaderError, GetBlockHeaderVerbose, GetBlockHeaderVerboseError, GetBlockStats,
+        GetBlockStatsError, GetBlockTemplate, GetBlockTemplateError, GetBlockVerboseOne,
+        GetBlockVerboseOneError, 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, ListLabels, ListLockUnspent,
+        ListLockUnspentItem, ListLockUnspentItemError, ListReceivedByAddress,
+        ListReceivedByAddressError, ListReceivedByAddressItem, ListSinceBlock, ListSinceBlockError,
+        ListSinceBlockTransaction, ListSinceBlockTransactionError, ListTransactions,
+        ListTransactionsItem, ListTransactionsItemError, ListUnspentItemError, ListWallets,
+        LoadWallet, Locked, PruneBlockchain, RawTransactionError, RawTransactionInput,
+        RawTransactionOutput, RescanBlockchain, SendMany, SendRawTransaction, SendToAddress,
+        SetNetworkActive, SignMessage, SignMessageWithPrivKey, SignRawTransaction,
+        SignRawTransactionError, SoftforkReject, TestMempoolAccept, TransactionCategory,
+        UploadTarget, ValidateAddress, ValidateAddressError, VerifyChain, VerifyMessage,
+        VerifyTxOutProof, WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
+        WitnessUtxo,
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,

types/src/v20/util/into.rs

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use bitcoin::{Address, ScriptBuf};
+
+use super::{CreateMultisig, CreateMultisigError};
+use crate::model;
+
+impl CreateMultisig {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::CreateMultisig, CreateMultisigError> {
+        use CreateMultisigError as E;
+
+        let address = self.address.parse::<Address<_>>().map_err(E::Address)?;
+        let redeem_script = ScriptBuf::from_hex(&self.redeem_script).map_err(E::RedeemScript)?;
+
+        Ok(model::CreateMultisig {
+            address,
+            redeem_script,
+            descriptor: Some(self.descriptor),
+            warnings: None,
+        })
+    }
+}

types/src/v20/util/mod.rs

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v0.20` - util.
+//!
+//! Types for methods found under the `== Util ==` section of the API docs.
+
+mod into;
+
+use serde::{Deserialize, Serialize};
+
+pub use super::CreateMultisigError;
+
+/// Result of JSON-RPC method `createmultisig`.
+///
+/// > createmultisig nrequired ["key",...] ( "address_type" )
+/// >
+/// > Creates a multi-signature address with n signature of m keys required.
+/// > It returns a json object with the address and redeemScript.
+/// >
+/// > Arguments:
+/// > 1. nrequired                    (numeric, required) The number of required signatures out of the n keys.
+/// > 2. "keys"                       (string, required) A json array of hex-encoded public keys
+/// >      [
+/// >        "key"                    (string) The hex-encoded public key
+/// >        ,...
+/// >      ]
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct CreateMultisig {
+    /// The value of the new multisig address.
+    pub address: String,
+    /// The string value of the hex-encoded redemption script.
+    #[serde(rename = "redeemScript")]
+    pub redeem_script: String,
+    /// The descriptor for this multisig.
+    pub descriptor: String,
+}

types/src/v21/blockchain/into.rs

@@ -1,10 +1,55 @@
 // SPDX-License-Identifier: CC0-1.0
 
-use bitcoin::{Txid, Wtxid};
+use alloc::collections::BTreeMap;
 
-use super::{GetMempoolEntry, MempoolEntry, MempoolEntryError};
+use bitcoin::{BlockHash, Network, Txid, Work, Wtxid};
+
+use super::{
+    GetBlockchainInfo, GetBlockchainInfoError, GetMempoolEntry, GetMempoolInfo,
+    GetMempoolInfoError, MempoolEntry, MempoolEntryError,
+};
 use crate::model;
 
+impl GetBlockchainInfo {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetBlockchainInfo, GetBlockchainInfoError> {
+        use GetBlockchainInfoError as E;
+
+        let chain = Network::from_core_arg(&self.chain).map_err(E::Chain)?;
+        let best_block_hash =
+            self.best_block_hash.parse::<BlockHash>().map_err(E::BestBlockHash)?;
+        let chain_work = Work::from_unprefixed_hex(&self.chain_work).map_err(E::ChainWork)?;
+        let prune_height =
+            self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
+        let prune_target_size =
+            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+        let softforks = BTreeMap::new(); // TODO: Handle softforks stuff.
+
+        Ok(model::GetBlockchainInfo {
+            chain,
+            blocks: crate::to_u32(self.blocks, "blocks")?,
+            headers: crate::to_u32(self.headers, "headers")?,
+            best_block_hash,
+            bits: None,
+            target: None,
+            difficulty: self.difficulty,
+            time: None,
+            median_time: crate::to_u32(self.median_time, "median_time")?,
+            verification_progress: self.verification_progress,
+            initial_block_download: self.initial_block_download,
+            chain_work,
+            size_on_disk: self.size_on_disk,
+            pruned: self.pruned,
+            prune_height,
+            automatic_pruning: self.automatic_pruning,
+            prune_target_size,
+            softforks,
+            signet_challenge: None,
+            warnings: vec![self.warnings],
+        })
+    }
+}
+
 impl GetMempoolEntry {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> Result<model::GetMempoolEntry, MempoolEntryError> {
@@ -60,3 +105,30 @@ impl MempoolEntry {
         })
     }
 }
+
+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)?;
+        let unbroadcast_count = Some(crate::to_u32(self.unbroadcast_count, "unbroadcast_count")?);
+
+        Ok(model::GetMempoolInfo {
+            loaded: Some(self.loaded),
+            size,
+            bytes,
+            usage,
+            total_fee: None,
+            max_mempool,
+            mempool_min_fee,
+            min_relay_tx_fee,
+            incremental_relay_fee: None,
+            unbroadcast_count,
+            full_rbf: None,
+        })
+    }
+}