Merge rust-bitcoin#251: Add missing return fields in v18

9c37a4b Run the formatter (Jamil Lambert, PhD)
97e8906 Add missing listunspent field in v18 (Jamil Lambert, PhD)
4c88282 Add missing getpeerinfo field in v18 (Jamil Lambert, PhD)
3636ffc Add missing getmempoolentry field in v18 (Jamil Lambert, PhD)

Pull request description:

  Some of the types in v18 had missing return fields.

  Add all of the missing fields 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 9c37a4b

Tree-SHA512: 148581b52193e8e2cef35c859e8c45b2f05e0b5a06e9fbfece5e35a64172b66f33fbaae375f666efe919a46ccc9161e00a6e68e6d7d6283df606c248c38ce142

Author: tcharding

types/src/model/blockchain.rs

@@ -414,6 +414,8 @@ pub struct MempoolEntry {
     pub depends: Vec<Txid>,
     /// Unconfirmed transactions spending outputs from this transaction (child transaction id).
     pub spent_by: Vec<Txid>,
+    /// Whether this transaction could be replaced due to BIP125 (replace-by-fee)
+    pub bip125_replaceable: Option<bool>,
 }
 
 /// (No docs in Core v0.17.)

types/src/model/wallet.rs

@@ -610,6 +610,8 @@ pub struct ListUnspentItem {
     pub spendable: bool,
     /// Whether we know how to spend this output, ignoring the lack of keys.
     pub solvable: bool,
+    /// A descriptor for spending this output (only when solvable)
+    pub descriptor: Option<String>,
     /// Whether this output is considered safe to spend. Unconfirmed transactions from outside keys
     /// and unconfirmed replacement transactions are considered unsafe and are not eligible for
     /// spending by fundrawtransaction and sendtoaddress.

types/src/v17/blockchain/into.rs

@@ -425,6 +425,7 @@ impl MempoolEntry {
             fees,
             depends,
             spent_by,
+            bip125_replaceable: None,
         })
     }
 }

types/src/v17/wallet/into.rs

@@ -668,6 +668,7 @@ impl ListUnspentItem {
             redeem_script,
             spendable: self.spendable,
             solvable: self.solvable,
+            descriptor: None,
             safe: self.safe,
         })
     }

types/src/v18/blockchain/into.rs

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use bitcoin::{Txid, Wtxid};
+
+use super::{GetMempoolEntry, MempoolEntry, MempoolEntryError};
+use crate::model;
+
+impl GetMempoolEntry {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetMempoolEntry, MempoolEntryError> {
+        Ok(model::GetMempoolEntry(self.0.into_model()?))
+    }
+}
+
+impl MempoolEntry {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::MempoolEntry, MempoolEntryError> {
+        use MempoolEntryError as E;
+
+        let size = Some(crate::to_u32(self.size, "size")?);
+        let weight = None;
+        let time = crate::to_u32(self.time, "time")?;
+        let height = crate::to_u32(self.height, "height")?;
+        let descendant_count = crate::to_u32(self.descendant_count, "descendant_count")?;
+        let descendant_size = crate::to_u32(self.descendant_size, "descendant_size")?;
+        let ancestor_count = crate::to_u32(self.ancestor_count, "ancestor_count")?;
+        let ancestor_size = crate::to_u32(self.ancestor_size, "ancestor_size")?;
+        let wtxid = self.wtxid.parse::<Wtxid>().map_err(E::Wtxid)?;
+        let fees = self.fees.into_model().map_err(E::Fees)?;
+        let depends = self
+            .depends
+            .iter()
+            .map(|txid| txid.parse::<Txid>())
+            .collect::<Result<Vec<_>, _>>()
+            .map_err(E::Depends)?;
+        let spent_by = self
+            .spent_by
+            .iter()
+            .map(|txid| txid.parse::<Txid>())
+            .collect::<Result<Vec<_>, _>>()
+            .map_err(E::SpentBy)?;
+
+        Ok(model::MempoolEntry {
+            size,
+            weight,
+            time,
+            height,
+            descendant_count,
+            descendant_size,
+            ancestor_count,
+            ancestor_size,
+            wtxid,
+            fees,
+            depends,
+            spent_by,
+            bip125_replaceable: Some(self.bip125_replaceable),
+        })
+    }
+}

types/src/v18/blockchain/mod.rs

@@ -0,0 +1,70 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v0.18` - blockchain.
+//!
+//! Types for methods found under the `== Blockchain ==` section of the API docs.
+
+mod into;
+
+use serde::{Deserialize, Serialize};
+
+use super::{MempoolEntryError, MempoolEntryFees};
+
+/// Result of JSON-RPC method `getmempoolentry`.
+///
+/// > getmempoolentry txid
+/// >
+/// > Returns mempool data for given transaction
+/// >
+/// > Arguments:
+/// > 1. "txid"                 (string, required) The transaction id (must be in mempool)
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetMempoolEntry(pub MempoolEntry);
+
+/// A relative (ancestor or descendant) transaction of a transaction in the mempool.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct MempoolEntry {
+    /// Virtual transaction size as defined in BIP 141.
+    ///
+    /// This is different from actual serialized size for witness transactions as witness data is discounted.
+    pub size: i64,
+    /// DEPRECATED: Transaction fee in BTC.
+    pub fee: f64,
+    /// DEPRECATED: Transaction fee with fee deltas used for mining priority.
+    #[serde(rename = "modifiedfee")]
+    pub modified_fee: f64,
+    /// Local time transaction entered pool in seconds since 1 Jan 1970 GMT.
+    pub time: i64,
+    /// Block height when transaction entered pool.
+    pub height: i64,
+    /// Number of in-mempool descendant transactions (including this one).
+    #[serde(rename = "descendantcount")]
+    pub descendant_count: i64,
+    /// Virtual transaction size of in-mempool descendants (including this one).
+    #[serde(rename = "descendantsize")]
+    pub descendant_size: i64,
+    /// DEPRECATED: Modified fees (see above) of in-mempool descendants (including this one).
+    #[serde(rename = "descendantfees")]
+    pub descendant_fees: f64,
+    /// Number of in-mempool ancestor transactions (including this one).
+    #[serde(rename = "ancestorcount")]
+    pub ancestor_count: i64,
+    /// Virtual transaction size of in-mempool ancestors (including this one).
+    #[serde(rename = "ancestorsize")]
+    pub ancestor_size: i64,
+    /// DEPRECATED: Modified fees (see above) of in-mempool ancestors (including this one).
+    #[serde(rename = "ancestorfees")]
+    pub ancestor_fees: f64,
+    /// Hash of serialized transaction, including witness data.
+    pub wtxid: String,
+    /// (No docs in Core v0.17.)
+    pub fees: MempoolEntryFees,
+    /// Unconfirmed transactions used as inputs for this transaction (parent transaction id).
+    pub depends: Vec<String>,
+    /// Unconfirmed transactions spending outputs from this transaction (child transaction id).
+    #[serde(rename = "spentby")]
+    pub spent_by: Vec<String>,
+    /// Whether this transaction could be replaced due to BIP125 (replace-by-fee)
+    #[serde(rename = "bip125-replaceable")]
+    pub bip125_replaceable: bool,
+}

types/src/v18/mod.rs

@@ -223,6 +223,7 @@
 //! </details>
 
 // JSON-RPC types by API section.
+mod blockchain;
 mod control;
 mod network;
 mod raw_transactions;
@@ -231,8 +232,9 @@ mod wallet;
 
 #[doc(inline)]
 pub use self::{
+    blockchain::{GetMempoolEntry, MempoolEntry},
     control::{ActiveCommand, GetRpcInfo},
-    network::{GetNodeAddresses, NodeAddress},
+    network::{GetNodeAddresses, GetPeerInfo, NodeAddress, PeerInfo},
     raw_transactions::{
         AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
         AnalyzePsbtInputMissingError, JoinPsbts, UtxoUpdatePsbt,
@@ -260,25 +262,24 @@ pub use crate::v17::{
     GetBlockchainInfo, GetBlockchainInfoError, GetChainTips, GetChainTxStats, GetChainTxStatsError,
     GetConnectionCount, GetDifficulty, GetMemoryInfoStats, GetMempoolAncestors,
     GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
-    GetMempoolEntry, GetMempoolInfo, GetMempoolInfoError, GetMiningInfo, GetNetTotals,
-    GetNetworkInfo, GetNetworkInfoAddress, GetNetworkInfoError, GetNetworkInfoNetwork,
-    GetNewAddress, GetPeerInfo, 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,
-    ListWallets, LoadWallet, Locked, Logging, MapMempoolEntryError, MempoolAcceptance,
-    MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
-    PruneBlockchain, PsbtInput, PsbtOutput, PsbtScript, RawTransaction, RawTransactionError,
-    RawTransactionInput, RawTransactionOutput, RescanBlockchain, SendMany, SendRawTransaction,
-    SendToAddress, SetNetworkActive, SignFail, SignFailError, SignMessage, SignMessageWithPrivKey,
-    SignRawTransaction, SignRawTransactionError, Softfork, SoftforkReject, TestMempoolAccept,
-    TransactionCategory, UploadTarget, ValidateAddress, ValidateAddressError, VerifyChain,
-    VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt, WalletCreateFundedPsbtError,
-    WalletProcessPsbt, WitnessUtxo,
+    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, ListReceivedByAddress, ListReceivedByAddressError,
+    ListReceivedByAddressItem, ListSinceBlock, ListSinceBlockError, ListSinceBlockTransaction,
+    ListSinceBlockTransactionError, ListTransactions, ListTransactionsItem,
+    ListTransactionsItemError, ListUnspentItemError, ListWallets, LoadWallet, Locked, Logging,
+    MapMempoolEntryError, MempoolAcceptance, MempoolEntryError, MempoolEntryFees,
+    MempoolEntryFeesError, PruneBlockchain, PsbtInput, PsbtOutput, PsbtScript, RawTransaction,
+    RawTransactionError, RawTransactionInput, RawTransactionOutput, RescanBlockchain, SendMany,
+    SendRawTransaction, SendToAddress, SetNetworkActive, SignFail, SignFailError, SignMessage,
+    SignMessageWithPrivKey, SignRawTransaction, SignRawTransactionError, Softfork, SoftforkReject,
+    TestMempoolAccept, TransactionCategory, UploadTarget, ValidateAddress, ValidateAddressError,
+    VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
+    WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
 };

types/src/v18/network/mod.rs

@@ -6,6 +6,8 @@
 
 mod into;
 
+use alloc::collections::BTreeMap;
+
 use serde::{Deserialize, Serialize};
 
 /// Result of JSON-RPC method `getnodeaddresses`.
@@ -28,3 +30,96 @@ pub struct NodeAddress {
     /// The port of the node.
     pub port: u16,
 }
+
+/// Result of JSON-RPC method `getpeerinfo`.
+///
+/// > getpeerinfo
+/// >
+/// > Returns data about each connected network node as a json array of objects.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetPeerInfo(pub Vec<PeerInfo>);
+
+/// An item from the list returned by the JSON-RPC method `getpeerinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct PeerInfo {
+    /// Peer index.
+    pub id: u32,
+    /// The IP address and port of the peer ("host:port").
+    #[serde(rename = "addr")]
+    pub address: String,
+    /// Bind address of the connection to the peer ("ip:port").
+    #[serde(rename = "addrbind")]
+    pub address_bind: String,
+    /// Local address as reported by the peer.
+    #[serde(rename = "addrlocal")]
+    pub address_local: Option<String>,
+    /// Network (ipv4, ipv6, or onion) the peer connected through.
+    pub network: Option<String>,
+    /// The services offered.
+    pub services: String,
+    /// Whether peer has asked us to relay transactions to it.
+    #[serde(rename = "relaytxes")]
+    pub relay_transactions: bool,
+    /// The time in seconds since epoch (Jan 1 1970 GMT) of the last send.
+    #[serde(rename = "lastsend")]
+    pub last_send: i64,
+    /// The time in seconds since epoch (Jan 1 1970 GMT) of the last receive.
+    #[serde(rename = "lastrecv")]
+    pub last_received: i64,
+    /// The total bytes sent.
+    #[serde(rename = "bytessent")]
+    pub bytes_sent: u64,
+    /// The total bytes received.
+    #[serde(rename = "bytesrecv")]
+    pub bytes_received: u64,
+    /// The connection time in seconds since epoch (Jan 1 1970 GMT).
+    #[serde(rename = "conntime")]
+    pub connection_time: i64,
+    /// The time offset in seconds.
+    #[serde(rename = "timeoffset")]
+    pub time_offset: i64,
+    /// Ping time (if available).
+    #[serde(rename = "pingtime")]
+    pub ping_time: Option<f64>,
+    /// Minimum observed ping time (if any at all).
+    #[serde(rename = "minping")]
+    pub minimum_ping: Option<f64>,
+    /// Ping wait (if non-zero).
+    #[serde(rename = "pingwait")]
+    pub ping_wait: Option<f64>,
+    /// The peer version, such as 70001.
+    pub version: u32,
+    /// The string version (e.g. "/Satoshi:0.8.5/").
+    #[serde(rename = "subver")]
+    pub subversion: String,
+    /// Inbound (true) or Outbound (false).
+    pub inbound: bool,
+    /// Whether connection was due to addnode/-connect or if it was an automatic/inbound connection.
+    #[serde(rename = "addnode")]
+    pub add_node: Option<bool>,
+    /// The starting height (block) of the peer.
+    #[serde(rename = "startingheight")]
+    pub starting_height: i64,
+    /// The ban score.
+    #[serde(rename = "banscore")]
+    pub ban_score: Option<i64>,
+    /// The last header we have in common with this peer.
+    pub synced_headers: i64,
+    /// The last block we have in common with this peer.
+    pub synced_blocks: i64,
+    /// The heights of blocks we're currently asking from this peer.
+    pub inflight: Vec<u64>,
+    /// Whether the peer is whitelisted (deprecated in v0.21).
+    pub whitelisted: Option<bool>,
+    /// The minimum fee rate for transactions this peer accepts.
+    #[serde(rename = "minfeefilter")]
+    pub min_fee_filter: Option<f64>,
+    /// The total bytes sent aggregated by message type.
+    #[serde(rename = "bytessent_per_msg")]
+    pub bytes_sent_per_message: BTreeMap<String, u64>,
+    /// The total bytes received aggregated by message type.
+    #[serde(rename = "bytesrecv_per_msg")]
+    pub bytes_received_per_message: BTreeMap<String, u64>,
+    /// Type of connection.
+    pub connection_type: Option<String>,
+}

types/src/v18/wallet/into.rs

@@ -72,7 +72,6 @@ impl ListUnspentItem {
             .redeem_script
             .map(|hex| ScriptBuf::from_hex(&hex).map_err(E::RedeemScript))
             .transpose()?;
-
         Ok(model::ListUnspentItem {
             txid,
             vout,
@@ -84,6 +83,7 @@ impl ListUnspentItem {
             redeem_script,
             spendable: self.spendable,
             solvable: self.solvable,
+            descriptor: self.descriptor,
             safe: self.safe,
         })
     }

types/src/v18/wallet/mod.rs

@@ -76,6 +76,9 @@ pub struct ListUnspentItem {
     pub spendable: bool,
     /// Whether we know how to spend this output, ignoring the lack of keys.
     pub solvable: bool,
+    /// A descriptor for spending this output (only when solvable)
+    #[serde(rename = "desc")]
+    pub descriptor: Option<String>,
     /// Whether this output is considered safe to spend. Unconfirmed transactions from outside keys
     /// and unconfirmed replacement transactions are considered unsafe and are not eligible for
     /// spending by fundrawtransaction and sendtoaddress.