Add getmininginfo v30 support

Redefine the type in v30 for the changes and remove TODO from table.

Update the export, into function and test feature gate.

Author: jamillambert

integration_test/tests/mining.rs

@@ -37,7 +37,6 @@ fn mining__get_block_template__modelled() {
 }
 
 #[test]
-#[cfg(feature = "v29_and_below")]
 fn mining__get_mining_info() {
     let node = Node::with_wallet(Wallet::Default, &[]);
 

types/src/model/mining.rs

@@ -8,7 +8,8 @@
 use std::collections::BTreeMap;
 
 use bitcoin::{
-    block, Amount, BlockHash, CompactTarget, SignedAmount, Target, Transaction, Txid, Weight, Wtxid,
+    block, Amount, BlockHash, CompactTarget, FeeRate, SignedAmount, Target, Transaction, Txid,
+    Weight, Wtxid,
 };
 use serde::{Deserialize, Serialize};
 
@@ -115,6 +116,8 @@ pub struct GetMiningInfo {
     pub network_hash_ps: i64,
     /// The size of the mempool.
     pub pooled_tx: i64,
+    /// Minimum feerate of packages selected for block inclusion.
+    pub block_min_tx_fee: Option<FeeRate>,
     /// Current network name as defined in BIP70 (main, test, regtest).
     pub chain: String,
     /// The block challenge (aka. block script).

types/src/v17/mining/into.rs

@@ -100,6 +100,7 @@ impl GetMiningInfo {
             target: None,
             network_hash_ps: self.network_hash_ps,
             pooled_tx: self.pooled_tx,
+            block_min_tx_fee: None,
             chain: self.chain,
             signet_challenge: None,
             next: None,

types/src/v28/mining.rs

@@ -53,6 +53,7 @@ impl GetMiningInfo {
             target: None,
             network_hash_ps: self.network_hash_ps,
             pooled_tx: self.pooled_tx,
+            block_min_tx_fee: None,
             chain: self.chain,
             signet_challenge: None,
             next: None,

types/src/v29/mining/into.rs

@@ -25,6 +25,7 @@ impl GetMiningInfo {
             target: Some(target),
             network_hash_ps: self.network_hash_ps,
             pooled_tx: self.pooled_tx,
+            block_min_tx_fee: None,
             chain: self.chain,
             signet_challenge: self.signet_challenge,
             next: Some(next),

types/src/v30/mining/error.rs

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use core::fmt;
+
+use bitcoin::amount::ParseAmountError;
+use bitcoin::error::UnprefixedHexError;
+
+use super::NextBlockInfoError;
+use crate::error::write_err;
+
+/// Error when converting a `GetMiningInfo` type into the model type.
+#[derive(Debug)]
+pub enum GetMiningInfoError {
+    /// Conversion of the `bits` field failed.
+    Bits(UnprefixedHexError),
+    /// Conversion of the `target` field failed.
+    Target(UnprefixedHexError),
+    /// Conversion of the `block_min_tx_fee` field failed.
+    BlockMinTxFee(ParseAmountError),
+    /// Conversion of one of the items in field `next` failed.
+    Next(NextBlockInfoError),
+}
+
+impl fmt::Display for GetMiningInfoError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match *self {
+            Self::Bits(ref e) => write_err!(f, "conversion of the `bits` field failed"; e),
+            Self::Target(ref e) => write_err!(f, "conversion of the `target` field failed"; e),
+            Self::BlockMinTxFee(ref e) =>
+                write_err!(f, "conversion of the `block_min_tx_fee` field failed"; e),
+            Self::Next(ref e) =>
+                write_err!(f, "conversion of one of the items in field `next` failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for GetMiningInfoError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        match *self {
+            Self::Bits(ref e) => Some(e),
+            Self::Target(ref e) => Some(e),
+            Self::BlockMinTxFee(ref e) => Some(e),
+            Self::Next(ref e) => Some(e),
+        }
+    }
+}

types/src/v30/mining/into.rs

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use bitcoin::{CompactTarget, Target, Weight};
+
+use super::{GetMiningInfo, GetMiningInfoError};
+use crate::model;
+
+impl GetMiningInfo {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetMiningInfo, GetMiningInfoError> {
+        use GetMiningInfoError as E;
+
+        let current_block_weight = self.current_block_weight.map(Weight::from_wu);
+        let bits = CompactTarget::from_unprefixed_hex(&self.bits).map_err(E::Bits)?;
+        let target = Target::from_unprefixed_hex(self.target.as_ref()).map_err(E::Target)?;
+        let block_min_tx_fee =
+            crate::btc_per_kb(self.block_min_tx_fee).map_err(E::BlockMinTxFee)?;
+
+        let next = self.next.into_model().map_err(E::Next)?;
+
+        Ok(model::GetMiningInfo {
+            blocks: self.blocks,
+            current_block_weight,
+            current_block_tx: self.current_block_tx,
+            bits: Some(bits),
+            difficulty: self.difficulty,
+            target: Some(target),
+            network_hash_ps: self.network_hash_ps,
+            pooled_tx: self.pooled_tx,
+            block_min_tx_fee,
+            chain: self.chain,
+            signet_challenge: self.signet_challenge,
+            next: Some(next),
+            warnings: self.warnings,
+        })
+    }
+}

types/src/v30/mining/mod.rs

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v29` - mining.
+//!
+//! Types for methods found under the `== Mining ==` section of the API docs.
+
+mod error;
+mod into;
+
+use serde::{Deserialize, Serialize};
+
+pub use self::error::GetMiningInfoError;
+pub use super::{NextBlockInfo, NextBlockInfoError};
+
+/// Result of the JSON-RPC method `getmininginfo`.
+///
+/// > getmininginfo
+/// >
+/// > Returns a json object containing mining-related information.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
+pub struct GetMiningInfo {
+    /// The current block.
+    pub blocks: u64,
+    /// The block weight (including reserved weight for block header, txs count and coinbase tx) of
+    /// the last assembled block (only present if a block was ever assembled).
+    #[serde(rename = "currentblockweight")]
+    pub current_block_weight: Option<u64>,
+    /// The number of block transactions (excluding coinbase) of the last assembled block (only
+    /// present if a block was ever assembled).
+    #[serde(rename = "currentblocktx")]
+    pub current_block_tx: Option<i64>,
+    /// The current nBits, compact representation of the block difficulty target.
+    pub bits: String,
+    /// The current difficulty.
+    pub difficulty: f64,
+    /// The current target.
+    pub target: String,
+    /// The network hashes per second.
+    #[serde(rename = "networkhashps")]
+    pub network_hash_ps: i64,
+    /// The size of the mempool.
+    #[serde(rename = "pooledtx")]
+    pub pooled_tx: i64,
+    /// Minimum feerate of packages selected for block inclusion in BTC/kvB.
+    #[serde(rename = "blockmintxfee")]
+    pub block_min_tx_fee: f64,
+    /// Current network name as defined in BIP70 (main, test, regtest).
+    pub chain: String,
+    /// The block challenge (aka. block script), in hexadecimal (only present if the current network
+    /// is a signet).
+    pub signet_challenge: Option<String>,
+    /// The next block.
+    pub next: NextBlockInfo,
+    /// Any network and blockchain warnings.
+    pub warnings: Vec<String>,
+}

types/src/v30/mod.rs

@@ -86,7 +86,7 @@
 //! | JSON-RPC Method Name               | Returns         | Notes                                  |
 //! |:-----------------------------------|:---------------:|:--------------------------------------:|
 //! | getblocktemplate                   | version + model |                                        |
-//! | getmininginfo                      | version + model | TODO                                   |
+//! | getmininginfo                      | version + model |                                        |
 //! | getnetworkhashps                   | returns boolean |                                        |
 //! | getprioritisedtransactions         | version + model |                                        |
 //! | prioritisetransaction              | returns boolean |                                        |
@@ -243,9 +243,13 @@
 //! </details>
 
 mod blockchain;
+mod mining;
 
 #[doc(inline)]
-pub use self::{blockchain::GetMempoolInfo};
+pub use self::{
+    blockchain::GetMempoolInfo,
+    mining::{GetMiningInfo, GetMiningInfoError},
+};
 #[doc(inline)]
 pub use crate::{
     v17::{
@@ -301,12 +305,11 @@ pub use crate::{
     },
     v24::{
         DecodePsbt, DecodePsbtError, GetMempoolAncestors, GetMempoolAncestorsVerbose,
-        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry,
-        GetRawMempoolVerbose, GetTransactionDetail, GetTxSpendingPrevout,
-        GetTxSpendingPrevoutError, GlobalXpub, ListUnspent, ListUnspentItem, MempoolEntry,
-        MigrateWallet, Proprietary, PsbtInput, PsbtOutput, SendAll, SendAllError,
-        SimulateRawTransaction, TaprootBip32Deriv, TaprootLeaf, TaprootScript,
-        TaprootScriptPathSig,
+        GetMempoolDescendants, GetMempoolDescendantsVerbose, GetMempoolEntry, GetRawMempoolVerbose,
+        GetTransactionDetail, GetTxSpendingPrevout, GetTxSpendingPrevoutError, GlobalXpub,
+        ListUnspent, ListUnspentItem, MempoolEntry, MigrateWallet, Proprietary, PsbtInput,
+        PsbtOutput, SendAll, SendAllError, SimulateRawTransaction, TaprootBip32Deriv, TaprootLeaf,
+        TaprootScript, TaprootScriptPathSig,
     },
     v25::{
         GenerateBlock, GenerateBlockError, GetBlockStats, ListDescriptors, MempoolAcceptanceError,
@@ -334,7 +337,7 @@ pub use crate::{
         GetBlockHeaderVerbose, GetBlockHeaderVerboseError, GetBlockVerboseOne,
         GetBlockVerboseOneError, GetBlockchainInfo, GetBlockchainInfoError, GetChainStates,
         GetChainStatesError, GetDescriptorActivity, GetDescriptorActivityError, GetDescriptorInfo,
-        GetMiningInfo, GetMiningInfoError, MempoolAcceptance, NextBlockInfo, NextBlockInfoError,
-        ReceiveActivity, SpendActivity, TestMempoolAccept,
+        MempoolAcceptance, NextBlockInfo, NextBlockInfoError, ReceiveActivity, SpendActivity,
+        TestMempoolAccept,
     },
 };