Merge #315: Improve GetPeerInfo

0d93ad7 node: Use get_peer_info method (Tobin C. Harding)
d561e5c Explicitly check type of GetPeerInfo vector element (Tobin C. Harding)
8a26cd0 Improve GetPeerInfo (Tobin C. Harding)

Pull request description:

  In #310 I got mixed up and added fields to the v17 types `GetPeerInfo` struct that do not appear in the docs.

  This was masked by using `Option`. And not helped by the fact that a bunch of other `Option`s are used because the docs do not match what Core returns.

  These bugs propagated up through the version numbers. Go over them all and sort it out.

  Note also that we were incorrectly re-exporting `PeerInfo` from v19 even though the `PeerInfo` struct that was actually being used is found in the version specific file along with `GetPeerInfo` - face palm.

  And finally, remove all the 'vXY and later' docs, this is implied by the module. These sorts of comments should only be found in `model`.

ACKs for top commit:
  jamillambert:
    ACK 0d93ad7

Tree-SHA512: a9565d056abc63a7b35d1041756f9f01e3dc98d357c3b911c531e4eb254747a28a4b4bdb8a36022d76807ec8849a5e3572688a148f6dae9d0d8716e442c2c9bf

Author: tcharding

integration_test/tests/network.rs

@@ -120,6 +120,10 @@ fn get_peer_info_three_node_network() {
     node2.mine_a_block();
     node3.mine_a_block();
 
+    let json: GetPeerInfo = node1.client.get_peer_info().expect("getpeerinfo");
+    // This verifies that we re-exported the correct `PeerInfo` type at the module level.
+    let _: PeerInfo = json.0[0];
+
     // FIXME: Fails if we use equal to 2 ???
     assert!(node1.peers_connected() >= 1);
     assert!(node2.peers_connected() >= 1);

node/src/lib.rs

@@ -918,10 +918,8 @@ mod test {
     }
 
     fn peers_connected(client: &Client) -> usize {
-        // FIXME: Once client implements get_peer_info use it.
-        // This is kinda cool, it shows we can call any RPC method using the client.
-        let result: Vec<serde_json::Value> = client.call("getpeerinfo", &[]).unwrap();
-        result.len()
+        let json = client.get_peer_info().expect("get_peer_info");
+        json.0.len()
     }
 
     fn init() -> String {

types/src/v17/network/mod.rs

@@ -196,8 +196,6 @@ pub struct PeerInfo {
     /// 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.
@@ -252,16 +250,14 @@ pub struct PeerInfo {
     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).
+    /// Whether the peer is whitelisted.
     pub whitelisted: Option<bool>,
     /// 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>,
 }
 
 /// Result of JSON-RPC method `listbanned`.

types/src/v18/network/mod.rs

@@ -57,8 +57,6 @@ pub struct PeerInfo {
     /// 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.
@@ -113,17 +111,15 @@ pub struct PeerInfo {
     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).
+    /// Whether the peer is whitelisted.
     pub whitelisted: Option<bool>,
     /// The minimum fee rate for transactions this peer accepts.
     #[serde(rename = "minfeefilter")]
-    pub min_fee_filter: Option<f64>,
+    pub min_fee_filter: 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/v19/network/mod.rs

@@ -30,7 +30,7 @@ pub struct GetNetworkInfo {
     /// The services we offer to the network (hex string).
     #[serde(rename = "localservices")]
     pub local_services: String,
-    /// The services we offer to the network. v0.19 and later only.
+    /// The services we offer to the network.
     #[serde(rename = "localservicesnames")]
     pub local_services_names: Vec<String>,
     /// `true` if transaction relay is requested from peers.
@@ -83,11 +83,9 @@ pub struct PeerInfo {
     /// 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,
-    /// The services offered, in human-readable form. v0.19 and later only.
+    /// The services offered, in human-readable form.
     #[serde(rename = "servicesnames")]
     pub services_names: Vec<String>,
     /// Whether peer has asked us to relay transactions to it.
@@ -144,17 +142,15 @@ pub struct PeerInfo {
     pub inflight: Vec<u64>,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
-    /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
-    #[serde(rename = "minfeefilter")]
-    pub minimum_fee_filter: f64,
-    /// Whether the peer is whitelisted (deprecated in v0.21).
+    /// Whether the peer is whitelisted.
     pub whitelisted: Option<bool>,
+    /// The minimum fee rate for transactions this peer accepts.
+    #[serde(rename = "minfeefilter")]
+    pub min_fee_filter: 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/v21/mod.rs

@@ -245,7 +245,7 @@ pub use self::{
         SoftforkType,
     },
     generating::GenerateBlock,
-    network::{GetNetworkInfo, GetPeerInfo},
+    network::{GetNetworkInfo, GetPeerInfo, PeerInfo},
     util::{GetIndexInfo, GetIndexInfoName},
     wallet::{
         ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
@@ -298,8 +298,7 @@ pub use crate::{
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfoError,
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
-        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
-        SetWalletFlag,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, SetWalletFlag,
     },
     v20::{
         Banned, CreateMultisig, GenerateToDescriptor, GetTransaction, GetTransactionDetail,

types/src/v21/network/mod.rs

@@ -91,7 +91,7 @@ pub struct PeerInfo {
     pub network: Option<String>,
     /// The services offered.
     pub services: String,
-    /// The services offered, in human-readable form. v0.19 and later only.
+    /// The services offered, in human-readable form.
     #[serde(rename = "servicesnames")]
     pub services_names: Vec<String>,
     /// Whether peer has asked us to relay transactions to it.
@@ -141,9 +141,6 @@ pub struct PeerInfo {
     /// 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.
@@ -159,11 +156,11 @@ pub struct PeerInfo {
     pub addresses_rate_limited: usize,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
-    /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
-    #[serde(rename = "minfeefilter")]
-    pub minimum_fee_filter: f64,
-    /// Whether the peer is whitelisted (deprecated in v0.21).
+    /// Whether the peer is whitelisted.
     pub whitelisted: Option<bool>,
+    /// The minimum fee rate for transactions this peer accepts.
+    #[serde(rename = "minfeefilter")]
+    pub min_fee_filter: Option<f64>, // Docs rekon this exists.
     /// The total bytes sent aggregated by message type.
     #[serde(rename = "bytessent_per_msg")]
     pub bytes_sent_per_message: BTreeMap<String, u64>,

types/src/v22/mod.rs

@@ -254,7 +254,7 @@ mod wallet;
 pub use self::{
     blockchain::GetMempoolInfo,
     control::Logging,
-    network::{Banned, GetPeerInfo, ListBanned},
+    network::{Banned, GetPeerInfo, ListBanned, PeerInfo},
     raw_transactions::{DecodeScript, DecodeScriptError},
     signer::EnumerateSigners,
     wallet::{ListDescriptors, WalletDisplayAddress},
@@ -305,8 +305,7 @@ pub use crate::{
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfoError,
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
-        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
-        SetWalletFlag,
+        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, SetWalletFlag,
     },
     v20::{CreateMultisig, GenerateToDescriptor, GetTransaction, GetTransactionDetail},
     v21::{

types/src/v22/network.rs

@@ -61,7 +61,7 @@ pub struct PeerInfo {
     pub network: Option<String>,
     /// The services offered.
     pub services: String,
-    /// The services offered, in human-readable form. v0.19 and later only.
+    /// The services offered, in human-readable form.
     #[serde(rename = "servicesnames")]
     pub services_names: Vec<String>,
     /// Whether peer has asked us to relay transactions to it.
@@ -105,19 +105,16 @@ pub struct PeerInfo {
     pub subversion: String,
     /// Inbound (true) or Outbound (false).
     pub inbound: bool,
-    /// Whether we selected peer as (compact blocks) high-bandwidth peer. v22 and later only.
+    /// Whether we selected peer as (compact blocks) high-bandwidth peer.
     pub bip152_hb_to: bool,
-    /// Whether peer selected us as (compact blocks) high-bandwidth peer. v22 and later only.
+    /// Whether peer selected us as (compact blocks) high-bandwidth peer.
     pub bip152_hb_from: 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.
@@ -133,11 +130,11 @@ pub struct PeerInfo {
     pub addresses_rate_limited: usize,
     /// Any special permissions that have been granted to this peer. v0.19 and later only.
     pub permissions: Vec<String>,
-    /// The minimum fee rate for transactions this peer accepts. v0.19 and later only.
-    #[serde(rename = "minfeefilter")]
-    pub minimum_fee_filter: f64,
-    /// Whether the peer is whitelisted (deprecated in v0.21).
+    /// Whether the peer is whitelisted.
     pub whitelisted: Option<bool>,
+    /// The minimum fee rate for transactions this peer accepts.
+    #[serde(rename = "minfeefilter")]
+    pub min_fee_filter: Option<f64>, // Docs rekon this exists.
     /// The total bytes sent aggregated by message type.
     #[serde(rename = "bytessent_per_msg")]
     pub bytes_sent_per_message: BTreeMap<String, u64>,

types/src/v23/mod.rs

@@ -250,7 +250,7 @@ pub use self::{
         GetDeploymentInfoError, GetMempoolEntry, SaveMempool,
     },
     control::Logging,
-    network::GetPeerInfo,
+    network::{GetPeerInfo, PeerInfo},
     raw_transactions::{
         DecodePsbt, DecodePsbtError, DecodeScript, DecodeScriptError, GlobalXpub, Proprietary,
         PsbtInput, PsbtOutput,
@@ -304,8 +304,8 @@ pub use crate::{
         GetBlockFilterError, GetBlockchainInfoError, GetChainTxStats, GetDescriptorInfo,
         GetMempoolAncestors, GetMempoolAncestorsVerbose, GetMempoolDescendants,
         GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError, MempoolEntry,
-        MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo, SetWalletFlag,
-        Softfork, SoftforkType,
+        MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, SetWalletFlag, Softfork,
+        SoftforkType,
     },
     v20::{GenerateToDescriptor, GetTransactionDetail},
     v21::{