Add missing fields to getbalances

jamillambert · jamillambert · commit 4e70a4b47888 · 2025-06-26T17:27:51.000+01:00
There is a missing return field in v26 `getbalances`.

Redefine the type for v26 with the missing fields.
Update the model, error, into functions and reexports.
diff --git a/types/src/model/wallet.rs b/types/src/model/wallet.rs
@@ -232,7 +232,11 @@ pub struct GetBalance(pub Amount);
 pub struct GetBalances {
     /// Balances from outputs that the wallet can sign.
     pub mine: GetBalancesMine,
+    /// Watchonly balances (not present if wallet does not watch anything).
     pub watch_only: Option<GetBalancesWatchOnly>,
+    /// Hash and height of the block this information was generated on. v26 and later only.
+    #[serde(rename = "lastprocessedblock")]
+    pub last_processed_block: Option<LastProcessedBlock>,
 }
 
 /// Balances from outputs that the wallet can sign.
diff --git a/types/src/v19/mod.rs b/types/src/v19/mod.rs
@@ -244,7 +244,7 @@ pub use self::{
     control::GetRpcInfo,
     network::{GetNetworkInfo, GetPeerInfo, PeerInfo},
     util::GetDescriptorInfo,
-    wallet::{GetBalances, GetBalancesMine, GetBalancesWatchOnly, GetTransaction},
+    wallet::{GetBalances, GetBalancesError, GetBalancesMine, GetBalancesWatchOnly, GetTransaction},
 };
 #[doc(inline)]
 pub use crate::v17::{
diff --git a/types/src/v19/wallet/into.rs b/types/src/v19/wallet/into.rs
@@ -21,8 +21,9 @@ impl GetBalances {
             .map(|watch_only| watch_only.into_model())
             .transpose()
             .map_err(E::WatchOnly)?;
+        let last_processed_block = None; // v26 and later only.
 
-        Ok(model::GetBalances { mine, watch_only })
+        Ok(model::GetBalances { mine, watch_only, last_processed_block })
     }
 }
 
diff --git a/types/src/v20/mod.rs b/types/src/v20/mod.rs
@@ -286,6 +286,6 @@ pub use crate::{
         GetMempoolAncestorsVerbose, GetMempoolDescendants, GetMempoolDescendantsVerbose,
         GetMempoolEntry, GetMempoolInfo, GetNetworkInfo, GetPeerInfo, GetRpcInfo,
         MapMempoolEntryError, MempoolEntry, MempoolEntryError, MempoolEntryFees,
-        MempoolEntryFeesError, PeerInfo, Softfork, SoftforkType,
+        MempoolEntryFeesError, PeerInfo, Softfork, SoftforkType, GetBalancesError,
     },
 };
diff --git a/types/src/v21/mod.rs b/types/src/v21/mod.rs
@@ -292,6 +292,7 @@ pub use crate::{
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
+        GetBalancesError,
     },
     v20::{Banned, CreateMultisig, ListBanned, Logging, GetTransaction, GetTransactionDetail},
 };
diff --git a/types/src/v22/mod.rs b/types/src/v22/mod.rs
@@ -302,6 +302,7 @@ pub use crate::{
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
+        GetBalancesError,
     },
     v20::{CreateMultisig, GetTransaction, GetTransactionDetail},
     v21::{
diff --git a/types/src/v23/mod.rs b/types/src/v23/mod.rs
@@ -301,7 +301,7 @@ pub use crate::{
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
-        Softfork, SoftforkType,
+        Softfork, SoftforkType, GetBalancesError,
     },
     v20::GetTransactionDetail,
     v21::{GetNetworkInfo, UnloadWallet},
diff --git a/types/src/v24/mod.rs b/types/src/v24/mod.rs
@@ -301,7 +301,7 @@ pub use crate::{
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
-        Softfork, SoftforkType,
+        Softfork, SoftforkType, GetBalancesError,
     },
     v21::{GetNetworkInfo, UnloadWallet},
     v22::{Banned, ListBanned, ScriptPubkey},
diff --git a/types/src/v25/mod.rs b/types/src/v25/mod.rs
@@ -296,7 +296,7 @@ pub use crate::{
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
-        Softfork, SoftforkType,
+        Softfork, SoftforkType, GetBalancesError,
     },
     v21::GetNetworkInfo,
     v22::{Banned, ListBanned, ScriptPubkey},
diff --git a/types/src/v26/mod.rs b/types/src/v26/mod.rs
@@ -266,7 +266,7 @@ pub use self::{
         SubmitPackageTxResult, SubmitPackageTxResultError, SubmitPackageTxResultFees,
         SubmitPackageTxResultFeesError,
     },
-    wallet::{CreateWallet, GetTransaction, GetTransactionError, LastProcessedBlock, LastProcessedBlockError, LoadWallet, UnloadWallet},
+    wallet::{CreateWallet, GetTransaction, GetTransactionError, LastProcessedBlock, LastProcessedBlockError, LoadWallet, UnloadWallet, GetBalances, GetBalancesError},
 };
 #[doc(inline)]
 pub use crate::{
@@ -308,7 +308,7 @@ pub use crate::{
         ListWalletDir, ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
     },
     v19::{
-        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
+        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalancesMine,
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfoError,
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
diff --git a/types/src/v26/wallet/error.rs b/types/src/v26/wallet/error.rs
@@ -10,6 +10,43 @@ use super::GetTransactionDetailError;
 use crate::error::write_err;
 use crate::NumericError;
 
+/// Error when converting a `GetBalances` type into the model type.
+#[derive(Debug)]
+pub enum GetBalancesError {
+    /// Conversion of the `mine` field failed.
+    Mine(ParseAmountError),
+    /// Conversion of the `watchonly` field failed.
+    WatchOnly(ParseAmountError),
+    /// Conversion of the `last_processed_block` field failed.
+    LastProcessedBlock(LastProcessedBlockError),
+}
+
+impl fmt::Display for GetBalancesError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use GetBalancesError as E;
+
+        match *self {
+            E::Mine(ref e) => write_err!(f, "conversion of the `mine` field failed"; e),
+            E::WatchOnly(ref e) => write_err!(f, "conversion of the `watchonly` field failed"; e),
+            E::LastProcessedBlock(ref e) =>
+                write_err!(f, "conversion of the `last_processed_block` field failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for GetBalancesError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use GetBalancesError as E;
+
+        match *self {
+            E::Mine(ref e) => Some(e),
+            E::WatchOnly(ref e) => Some(e),
+            E::LastProcessedBlock(ref e) => Some(e),
+        }
+    }
+}
+
 /// Error when converting a `GetTransaction` type into the model type.
 #[derive(Debug)]
 pub enum GetTransactionError {
diff --git a/types/src/v26/wallet/into.rs b/types/src/v26/wallet/into.rs
@@ -4,8 +4,8 @@ use bitcoin::consensus::encode;
 use bitcoin::{BlockHash, SignedAmount, Transaction, Txid};
 
 use super::{
-    CreateWallet, GetTransaction, GetTransactionError, LastProcessedBlock, LastProcessedBlockError,
-    LoadWallet, UnloadWallet,
+    CreateWallet, GetBalances, GetBalancesError, GetTransaction, GetTransactionError,
+    LastProcessedBlock, LastProcessedBlockError, LoadWallet, UnloadWallet,
 };
 use crate::model;
 
@@ -19,6 +19,27 @@ impl CreateWallet {
     pub fn name(self) -> String { self.into_model().name }
 }
 
+impl GetBalances {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetBalances, GetBalancesError> {
+        use GetBalancesError as E;
+
+        let mine = self.mine.into_model().map_err(E::Mine)?;
+        let watch_only = self
+            .watch_only
+            .map(|watch_only| watch_only.into_model())
+            .transpose()
+            .map_err(E::WatchOnly)?;
+        let last_processed_block = self
+            .last_processed_block
+            .map(|l| l.into_model())
+            .transpose()
+            .map_err(E::LastProcessedBlock)?;
+
+        Ok(model::GetBalances { mine, watch_only, last_processed_block })
+    }
+}
+
 impl GetTransaction {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> Result<model::GetTransaction, GetTransactionError> {
diff --git a/types/src/v26/wallet/mod.rs b/types/src/v26/wallet/mod.rs
@@ -10,8 +10,11 @@ mod into;
 use bitcoin::Transaction;
 use serde::{Deserialize, Serialize};
 
-pub use self::error::{GetTransactionError, LastProcessedBlockError};
-pub use super::{Bip125Replaceable, GetTransactionDetail, GetTransactionDetailError};
+pub use self::error::{GetBalancesError, GetTransactionError, LastProcessedBlockError};
+pub use super::{
+    Bip125Replaceable, GetBalancesMine, GetBalancesWatchOnly, GetTransactionDetail,
+    GetTransactionDetailError,
+};
 
 /// Result of the JSON-RPC method `createwallet`.
 ///
@@ -38,6 +41,22 @@ pub struct CreateWallet {
     pub warnings: Option<Vec<String>>,
 }
 
+/// Result of the JSON-RPC method `getbalances`.
+///
+/// > getbalances
+/// >
+/// > Returns an object with all balances in BTC.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct GetBalances {
+    /// Balances from outputs that the wallet can sign.
+    pub mine: GetBalancesMine,
+    #[serde(rename = "watchonly")]
+    pub watch_only: Option<GetBalancesWatchOnly>,
+    /// Hash and height of the block this information was generated on. v26 and later only.
+    #[serde(rename = "lastprocessedblock")]
+    pub last_processed_block: Option<LastProcessedBlock>,
+}
+
 /// Result of the JSON-RPC method `gettransaction`.
 ///
 /// > gettransaction "txid" ( include_watchonly )
diff --git a/types/src/v27/mod.rs b/types/src/v27/mod.rs
@@ -288,7 +288,7 @@ pub use crate::{
         ListWalletDir, ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
     },
     v19::{
-        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
+        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalancesMine,
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfoError,
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
@@ -310,6 +310,6 @@ pub use crate::{
         PrioritisedTransaction, SubmitPackage, SubmitPackageError, SubmitPackageTxResult,
         SubmitPackageTxResultError, SubmitPackageTxResultFees, SubmitPackageTxResultFeesError,
         UnloadWallet, Logging, GetTransaction, GetTransactionError, LastProcessedBlock,
-        LastProcessedBlockError,
+        LastProcessedBlockError, GetBalances, GetBalancesError,
     },
 };
diff --git a/types/src/v28/mod.rs b/types/src/v28/mod.rs
@@ -309,7 +309,7 @@ pub use crate::{
         ListWalletDir, ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
     },
     v19::{
-        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
+        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalancesMine,
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetBlockchainInfoError,
         GetChainTxStats, GetDescriptorInfo, GetMempoolAncestors, GetMempoolAncestorsVerbose,
         GetMempoolDescendants, GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError,
@@ -327,6 +327,6 @@ pub use crate::{
     v26::{
         CreateWallet, DescriptorProcessPsbt, DescriptorProcessPsbtError, GetPeerInfo,
         GetPrioritisedTransactions, GetTxOutSetInfo, GetTxOutSetInfoError, LoadWallet,
-        PrioritisedTransaction, UnloadWallet, GetTransactionError, LastProcessedBlock, LastProcessedBlockError,
+        PrioritisedTransaction, UnloadWallet, GetTransactionError, LastProcessedBlock, LastProcessedBlockError, GetBalances, GetBalancesError,
     },
 };
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs
@@ -307,7 +307,7 @@ pub use crate::{
         ListWalletDir, ListWalletDirWallet, NodeAddress, UtxoUpdatePsbt,
     },
     v19::{
-        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalances, GetBalancesMine,
+        Bip9SoftforkInfo, Bip9SoftforkStatistics, Bip9SoftforkStatus, GetBalancesMine,
         GetBalancesWatchOnly, GetBlockFilter, GetBlockFilterError, GetChainTxStats,
         GetMempoolAncestors, GetMempoolAncestorsVerbose, GetMempoolDescendants,
         GetMempoolDescendantsVerbose, GetRpcInfo, MapMempoolEntryError, MempoolEntry,
@@ -326,7 +326,7 @@ pub use crate::{
         CreateWallet, DescriptorProcessPsbt, DescriptorProcessPsbtError,
         GetPrioritisedTransactions, GetTxOutSetInfo, GetTxOutSetInfoError, LoadWallet,
         PrioritisedTransaction, UnloadWallet, GetTransactionError, LastProcessedBlock,
-        LastProcessedBlockError,
+        LastProcessedBlockError, GetBalances, GetBalancesError,
     },
     v28::{
         GetNetworkInfo, GetPeerInfo, SubmitPackage, SubmitPackageError, SubmitPackageTxResult,

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,9 @@ impl GetBalances {`
`21`	`21`	`.map(\|watch_only\| watch_only.into_model())`
`22`	`22`	`.transpose()`
`23`	`23`	`.map_err(E::WatchOnly)?;`
	`24`	`+ let last_processed_block = None; // v26 and later only.`
`24`	`25`
`25`		`- Ok(model::GetBalances { mine, watch_only })`
	`26`	`+ Ok(model::GetBalances { mine, watch_only, last_processed_block })`
`26`	`27`	`}`
`27`	`28`	`}`
`28`	`29`