Add getdeploymentinfo struct, model and test

Getdeploymentinfo returns a chain of json objects. Add structs for all
of them and a model with an into function.

Add a client macro and test.

Author: jamillambert

client/src/client_sync/v23/blockchain.rs

@@ -25,6 +25,18 @@ macro_rules! impl_client_v23__get_block_from_peer {
     };
 }
 
+/// Implements Bitcoin Core JSON-RPC API method `getdeploymentinfo`.
+#[macro_export]
+macro_rules! impl_client_v23__get_deployment_info {
+    () => {
+        impl Client {
+            pub fn get_deployment_info(&self, blockhash: &BlockHash) -> Result<GetDeploymentInfo> {
+                self.call("getdeploymentinfo", &[into_json(blockhash)?])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `savemempool`
 #[macro_export]
 macro_rules! impl_client_v23__save_mempool {

client/src/client_sync/v23/mod.rs

@@ -41,6 +41,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();

client/src/client_sync/v24/mod.rs

@@ -38,6 +38,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();

client/src/client_sync/v25/mod.rs

@@ -40,6 +40,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();

client/src/client_sync/v26/mod.rs

@@ -42,6 +42,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();

client/src/client_sync/v27/mod.rs

@@ -38,6 +38,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();

client/src/client_sync/v28/mod.rs

@@ -40,6 +40,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();

client/src/client_sync/v29/mod.rs

@@ -39,6 +39,7 @@ crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v29__get_descriptor_activity!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();

integration_test/tests/blockchain.rs

@@ -178,6 +178,17 @@ fn blockchain__get_chain_tx_stats__modelled() {
     model.unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v22_and_below"))]
+fn blockchain__get_deployment_info__modelled() {
+    let node = Node::with_wallet(Wallet::None, &[]);
+    let block_hash = node.client.best_block_hash().expect("best_block_hash failed");
+
+    let json: GetDeploymentInfo = node.client.get_deployment_info(&block_hash).expect("getdeploymentinfo");
+    let model: Result<mtype::GetDeploymentInfo, GetDeploymentInfoError> = json.into_model();
+    model.unwrap();
+}
+
 #[test]
 #[cfg(not(feature = "v28_and_below"))]
 fn blockchain__get_descriptor_activity__modelled() {

types/src/model/blockchain.rs

@@ -384,6 +384,72 @@ pub struct GetChainTxStats {
     pub tx_rate: Option<u32>,
 }
 
+/// Models the result of JSON-RPC method `getdeploymentinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GetDeploymentInfo {
+    /// Requested block hash (or tip).
+    pub hash: BlockHash,
+    /// Requested block height (or tip).
+    pub height: u32,
+    /// Deployments info, keyed by deployment name.
+    pub deployments: std::collections::BTreeMap<String, DeploymentInfo>,
+}
+
+/// Deployment info. Returned as part of `getdeploymentinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct DeploymentInfo {
+    /// One of "buried", "bip9".
+    pub deployment_type: String,
+    /// Height of the first block which the rules are or will be enforced (only for "buried" type, or "bip9" type with "active" status).
+    pub height: Option<u32>,
+    /// True if the rules are enforced for the mempool and the next block.
+    pub active: bool,
+    /// Status of bip9 softforks (only for "bip9" type).
+    pub bip9: Option<Bip9Info>,
+}
+
+/// Status of bip9 softforks. Returned as part of `getdeploymentinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Bip9Info {
+    /// The bit (0-28) in the block version field used to signal this softfork (only for "started" and "locked_in" status).
+    pub bit: Option<u8>,
+    /// The minimum median time past of a block at which the bit gains its meaning.
+    pub start_time: i64,
+    /// The median time past of a block at which the deployment is considered failed if not yet locked in.
+    pub timeout: i64,
+    /// Minimum height of blocks for which the rules may be enforced.
+    pub min_activation_height: u32,
+    /// Status of deployment at specified block (one of "defined", "started", "locked_in", "active", "failed").
+    pub status: String,
+    /// Height of the first block to which the status applies.
+    pub since: u32,
+    /// Status of deployment at the next block.
+    pub status_next: String,
+    /// Numeric statistics about signalling for a softfork (only for "started" and "locked_in" status).
+    pub statistics: Option<Bip9Statistics>,
+    /// Indicates blocks that signalled with a # and blocks that did not with a -.
+    pub signalling: Option<String>,
+}
+
+/// Numeric statistics about signalling for a softfork. Returned as part of `getdeploymentinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Bip9Statistics {
+    /// The length in blocks of the signalling period.
+    pub period: u32,
+    /// The number of blocks with the version bit set required to activate the feature (only for "started" status).
+    pub threshold: Option<u32>,
+    /// The number of blocks elapsed since the beginning of the current period.
+    pub elapsed: u32,
+    /// The number of blocks with the version bit set in the current period.
+    pub count: u32,
+    /// Returns false if there are not enough blocks left in this period to pass activation threshold (only for "started" status).
+    pub possible: Option<bool>,
+}
+
 /// Models the result of JSON-RPC method `getdifficulty`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]