Redefine getmempoolentry type for version changes

The return types change in v19, v21, v23 and v24.

Redefine the type for these versions with the changes.

Update into functions and reexports.

Author: jamillambert

types/src/model/blockchain.rs

@@ -383,11 +383,12 @@ 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.
+    /// Virtual transaction size as defined in BIP 141. v0.19 and later only.
     ///
     /// This is different from actual serialized size for witness transactions as witness data is discounted.
-    ///
-    /// This was deprecated with Bitcoin Core v0.19 and hence will be `None` for v0.19 and later.
+    pub vsize: Option<u32>,
+    /// Same as vsize. This was deprecated with Bitcoin Core v0.19 and hence
+    /// will be `None` for v0.19 and later.
     pub size: Option<u32>,
     /// Transaction weight as defined in BIP 141
     ///
@@ -416,6 +417,9 @@ pub struct MempoolEntry {
     pub spent_by: Vec<Txid>,
     /// Whether this transaction could be replaced due to BIP125 (replace-by-fee)
     pub bip125_replaceable: Option<bool>,
+    /// Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by
+    /// any peers). v0.21 and later only.
+    pub unbroadcast: Option<bool>,
 }
 
 /// (No docs in Core v0.17.)

types/src/v17/blockchain/into.rs

@@ -413,6 +413,7 @@ impl MempoolEntry {
             .map_err(E::SpentBy)?;
 
         Ok(model::MempoolEntry {
+            vsize: None,
             size,
             weight,
             time,
@@ -426,6 +427,7 @@ impl MempoolEntry {
             depends,
             spent_by,
             bip125_replaceable: None,
+            unbroadcast: None,
         })
     }
 }

types/src/v18/blockchain/into.rs

@@ -41,6 +41,7 @@ impl MempoolEntry {
             .map_err(E::SpentBy)?;
 
         Ok(model::MempoolEntry {
+            vsize: None,
             size,
             weight,
             time,
@@ -54,6 +55,7 @@ impl MempoolEntry {
             depends,
             spent_by,
             bip125_replaceable: Some(self.bip125_replaceable),
+            unbroadcast: None,
         })
     }
 }

types/src/v19/blockchain/into.rs

@@ -124,6 +124,7 @@ impl MempoolEntry {
     pub fn into_model(self) -> Result<model::MempoolEntry, MempoolEntryError> {
         use MempoolEntryError as E;
 
+        let vsize = Some(crate::to_u32(self.vsize, "vsize")?);
         let size = None;
         let weight = Some(crate::to_u32(self.weight, "weight")?);
         let time = crate::to_u32(self.time, "time")?;
@@ -148,6 +149,7 @@ impl MempoolEntry {
             .map_err(E::SpentBy)?;
 
         Ok(model::MempoolEntry {
+            vsize,
             size,
             weight,
             time,
@@ -161,6 +163,7 @@ impl MempoolEntry {
             depends,
             spent_by,
             bip125_replaceable: Some(self.bip125_replaceable),
+            unbroadcast: None,
         })
     }
 }

types/src/v19/blockchain/mod.rs

@@ -205,8 +205,18 @@ pub struct GetMempoolEntry(pub MempoolEntry);
 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.
+    /// This is different from actual serialized size for witness transactions as witness data is discounted.  v0.19 and later only.
+    pub vsize: i64,
+    /// DEPRECATED: same as vsize. Only returned if bitcoind is started with -deprecatedrpc=size
+    /// size will be completely removed in v0.20.
+    pub size: Option<i64>,
+    /// Transaction weight as defined in BIP 141.
     pub weight: 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.
@@ -217,15 +227,22 @@ pub struct MempoolEntry {
     /// 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.19.)
+    /// Fee object which contains the base fee, modified fee (with fee deltas), and
+    /// ancestor/descendant fee totals all in BTC.
     pub fees: MempoolEntryFees,
     /// Unconfirmed transactions used as inputs for this transaction (parent transaction id).
     pub depends: Vec<String>,
@@ -237,7 +254,10 @@ pub struct MempoolEntry {
     pub bip125_replaceable: bool,
 }
 
-/// (No docs in Core v0.19.)
+/// The `fees` field from the result of JSON-RPC method `getmempoolentry`.
+///
+/// Contains the base fee, modified fee (with fee deltas), and ancestor/descendant fee totals,
+/// all in BTC.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 pub struct MempoolEntryFees {
     /// Transaction fee in BTC.

types/src/v21/blockchain/into.rs

@@ -0,0 +1,62 @@
+// 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 vsize = Some(crate::to_u32(self.vsize, "vsize")?);
+        let size = None;
+        let weight = Some(crate::to_u32(self.weight, "weight")?);
+        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 {
+            vsize,
+            size,
+            weight,
+            time,
+            height,
+            descendant_count,
+            descendant_size,
+            ancestor_count,
+            ancestor_size,
+            wtxid,
+            fees,
+            depends,
+            spent_by,
+            bip125_replaceable: Some(self.bip125_replaceable),
+            unbroadcast: Some(self.unbroadcast),
+        })
+    }
+}

types/src/v21/blockchain/mod.rs

@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v0.21` - blockchain.
+//!
+//! Types for methods found under the `== Blockchain ==` section of the API docs.
+
+mod into;
+
+use serde::{Deserialize, Serialize};
+
+pub 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.  v0.19 and later only.
+    pub vsize: i64,
+    /// Transaction weight as defined in BIP 141.
+    pub weight: 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,
+    /// Fee object which contains the base fee, modified fee (with fee deltas), and ancestor/descendant fee totals all in BTC.
+    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,
+    /// Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by
+    /// any peers)
+    pub unbroadcast: bool,
+}

types/src/v21/mod.rs

@@ -232,10 +232,11 @@
 //! </details>
 
 // JSON-RPC types by API section.
+mod blockchain;
 mod wallet;
 
 #[doc(inline)]
-pub use self::wallet::UnloadWallet;
+pub use self::{blockchain::GetMempoolEntry, wallet::UnloadWallet};
 #[doc(inline)]
 pub use crate::{
     v17::{
@@ -283,9 +284,8 @@ pub use crate::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfo,
         GetBlockchainInfoError, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
-        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
-        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
-        SoftforkType,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, MapMempoolEntryError, MempoolEntry,
+        MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork, SoftforkType,
     },
     v20::{Banned, ListBanned, Logging},
 };

types/src/v22/mod.rs

@@ -298,10 +298,9 @@ pub use crate::{
         Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfo,
         GetBlockchainInfoError, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
-        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, MapMempoolEntryError,
-        MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
-        SoftforkType,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, MapMempoolEntryError, MempoolEntry,
+        MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork, SoftforkType,
     },
-    v21::UnloadWallet,
+    v21::{GetMempoolEntry, UnloadWallet},
     ScriptPubkey,
 };

types/src/v23/blockchain/into.rs

@@ -0,0 +1,62 @@
+// 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 vsize = Some(crate::to_u32(self.vsize, "vsize")?);
+        let size = None;
+        let weight = Some(crate::to_u32(self.weight, "weight")?);
+        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 {
+            vsize,
+            size,
+            weight,
+            time,
+            height,
+            descendant_count,
+            descendant_size,
+            ancestor_count,
+            ancestor_size,
+            wtxid,
+            fees,
+            depends,
+            spent_by,
+            bip125_replaceable: Some(self.bip125_replaceable),
+            unbroadcast: Some(self.unbroadcast),
+        })
+    }
+}