Merge #547: Change the type of prune_target_size field in model::GetBlockchainInfo from u32 to u64

b10dc06 Document the presence of u64 for NumericError (Razvan Pricop)
2616578 Change the type of model::GetBlockchainInfo::prune_target_size from u32 to u64 (Razvan Pricop)
7dd7876 Add to_u64 function in corepc-types (Razvan Pricop)

Pull request description:

  Solves #544

  ## Manual testing

  **Before:**

  Run `git checkout 26e3998` (the commit that introduced the integration test). Then:
  ```
  cd integration_test/
  cargo test --release --features <bitcoind_version>
  ```

  Example: `cargo test --release --features 28_1`.

  This test should fail in the commit it was introduced.

  **After:**

  Checkout back to the branch and run the same test again. Now, the test should succeed.

ACKs for top commit:
  jamillambert:
    ACK b10dc06
  tcharding:
    ACK b10dc06

Tree-SHA512: 8896dbcaf153abe257a58be40842036533953e80d5ca3d286584fcf9eebc0d401d90d70944ee18025ddbf40b031e936f1bb0ae832e4e0158e93d059bc03ef3e6

Author: tcharding

integration_test/tests/blockchain.rs

@@ -206,7 +206,7 @@ fn blockchain__get_block__modelled() {
 
 #[test]
 fn blockchain__get_blockchain_info__modelled() {
-    let node = Node::with_wallet(Wallet::None, &[]);
+    let node = Node::with_wallet(Wallet::None, &["-prune=10000"]);
 
     let json: GetBlockchainInfo = node.client.get_blockchain_info().expect("rpc");
     let model: Result<mtype::GetBlockchainInfo, GetBlockchainInfoError> = json.into_model();

types/src/lib.rs

@@ -63,11 +63,16 @@ pub fn to_u32(value: i64, field: &str) -> Result<u32, NumericError> {
     u32::try_from(value).map_err(|_| NumericError::Overflow { value, field: field.to_owned() })
 }
 
-/// Error converting an `i64` to a `u32`.
+/// Converts an `i64` numeric type to a `u64`.
+pub fn to_u64(value: i64, field: &str) -> Result<u64, NumericError> {
+    u64::try_from(value).map_err(|_| NumericError::Negative { value, field: field.to_owned() })
+}
+
+/// Error converting an `i64` to a `u32` or `u64`.
 ///
-/// If we expect a numeric value to sanely fit inside a `u32` we use that type in the `model`
-/// module, this requires converting the `i64` returned by the JSONRPC API into a `u32`, if our
-/// expectations are not met this error will be encountered.
+/// The JSONRPC API returns `i64` values. If these values match our expectations, then
+/// we convert them to either `u32` or `u64`, depending on the JSONRPC field. If our
+/// expectations are not met, this error is returned.
 #[derive(Debug)]
 pub enum NumericError {
     /// Expected an unsigned numeric value however the value was negative.

types/src/model/blockchain.rs

@@ -241,7 +241,7 @@ pub struct GetBlockchainInfo {
     /// Whether automatic pruning is enabled (only present if pruning is enabled).
     pub automatic_pruning: Option<bool>,
     /// The target size used by pruning (only present if automatic pruning is enabled).
-    pub prune_target_size: Option<u32>,
+    pub prune_target_size: Option<u64>,
     /// Status of softforks in progress, maps softfork name -> [`Softfork`] (empty from v29 onwards).
     pub softforks: BTreeMap<String, Softfork>,
     /// The block challenge (aka. block script)

types/src/v17/blockchain/into.rs

@@ -98,7 +98,7 @@ impl GetBlockchainInfo {
         let prune_height =
             self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
         let prune_target_size =
-            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+            self.prune_target_size.map(|h| crate::to_u64(h, "prune_target_size")).transpose()?;
         let softforks = BTreeMap::new(); // TODO: Handle softforks stuff.
 
         Ok(model::GetBlockchainInfo {

types/src/v19/blockchain/into.rs

@@ -29,7 +29,7 @@ impl GetBlockchainInfo {
         let prune_height =
             self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
         let prune_target_size =
-            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+            self.prune_target_size.map(|h| crate::to_u64(h, "prune_target_size")).transpose()?;
         let softforks = BTreeMap::new(); // TODO: Handle softforks stuff.
 
         Ok(model::GetBlockchainInfo {

types/src/v21/blockchain/into.rs

@@ -24,7 +24,7 @@ impl GetBlockchainInfo {
         let prune_height =
             self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
         let prune_target_size =
-            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+            self.prune_target_size.map(|h| crate::to_u64(h, "prune_target_size")).transpose()?;
         let softforks = BTreeMap::new(); // TODO: Handle softforks stuff.
 
         Ok(model::GetBlockchainInfo {

types/src/v23/blockchain/into.rs

@@ -25,7 +25,7 @@ impl GetBlockchainInfo {
         let prune_height =
             self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
         let prune_target_size =
-            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+            self.prune_target_size.map(|h| crate::to_u64(h, "prune_target_size")).transpose()?;
         let softforks = BTreeMap::new(); // TODO: Handle softforks stuff.
 
         Ok(model::GetBlockchainInfo {

types/src/v28/blockchain/into.rs

@@ -23,7 +23,7 @@ impl GetBlockchainInfo {
         let prune_height =
             self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
         let prune_target_size =
-            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+            self.prune_target_size.map(|h| crate::to_u64(h, "prune_target_size")).transpose()?;
         let softforks = BTreeMap::new(); // TODO: Handle softforks stuff.
 
         Ok(model::GetBlockchainInfo {

types/src/v29/blockchain/into.rs

@@ -267,7 +267,7 @@ impl GetBlockchainInfo {
         let prune_height =
             self.prune_height.map(|h| crate::to_u32(h, "prune_height")).transpose()?;
         let prune_target_size =
-            self.prune_target_size.map(|h| crate::to_u32(h, "prune_target_size")).transpose()?;
+            self.prune_target_size.map(|h| crate::to_u64(h, "prune_target_size")).transpose()?;
         let signet_challenge =
             self.signet_challenge.as_ref().map(|s| ScriptBuf::from_hex(s)).transpose()?;