change(rpc): Update getaddressbalance RPC to return received field

zebra-rpc/src/methods.rs

@@ -1026,8 +1026,9 @@ where
         let response = state.oneshot(request).await.map_misc_error()?;
 
         match response {
-            zebra_state::ReadResponse::AddressBalance { balance, .. } => Ok(AddressBalance {
+            zebra_state::ReadResponse::AddressBalance { balance, received } => Ok(AddressBalance {
                 balance: u64::from(balance),
+                received,
             }),
             _ => unreachable!("Unexpected response from state service: {response:?}"),
         }
@@ -3008,11 +3009,33 @@ impl GetBlockChainInfo {
 /// This is used for the input parameter of [`RpcServer::get_address_balance`],
 /// [`RpcServer::get_address_tx_ids`] and [`RpcServer::get_address_utxos`].
 #[derive(Clone, Debug, Eq, PartialEq, Hash, serde::Deserialize, serde::Serialize)]
+#[serde(from = "DAddressStrings")]
 pub struct AddressStrings {
     /// A list of transparent address strings.
     addresses: Vec<String>,
 }
 
+impl From<DAddressStrings> for AddressStrings {
+    fn from(address_strings: DAddressStrings) -> Self {
+        match address_strings {
+            DAddressStrings::Addresses { addresses } => AddressStrings { addresses },
+            DAddressStrings::Address(address) => AddressStrings {
+                addresses: vec![address],
+            },
+        }
+    }
+}
+
+/// An intermediate type used to deserialize [`AddressStrings`].
+#[derive(Clone, Debug, Eq, PartialEq, Hash, serde::Deserialize)]
+#[serde(untagged)]
+enum DAddressStrings {
+    /// A list of address strings.
+    Addresses { addresses: Vec<String> },
+    /// A single address string.
+    Address(String),
+}
+
 impl AddressStrings {
     /// Creates a new `AddressStrings` given a vector.
     #[cfg(test)]
@@ -3062,6 +3085,8 @@ impl AddressStrings {
 pub struct AddressBalance {
     /// The total transparent balance.
     pub balance: u64,
+    /// The total received balance, including change.
+    pub received: u64,
 }
 
 /// A hex-encoded [`ConsensusBranchId`] string.

zebra-rpc/src/methods/tests/prop.rs

@@ -647,7 +647,7 @@ proptest! {
             let state_query = state
                 .expect_request(zebra_state::ReadRequest::AddressBalance(addresses))
                 .map_ok(|responder| {
-                    responder.respond(zebra_state::ReadResponse::AddressBalance { balance, received: Default::default() })
+                    responder.respond(zebra_state::ReadResponse::AddressBalance { balance, received: balance.into() })
                 });
 
             // Await the RPC call and the state query
@@ -658,7 +658,7 @@ proptest! {
             // Check that response contains the expected balance
             let received_balance = response?;
 
-            prop_assert_eq!(received_balance, AddressBalance { balance: balance.into() });
+            prop_assert_eq!(received_balance, AddressBalance { balance: balance.into(), received: balance.into() });
 
             // Check no further requests were made during this test
             mempool.expect_no_requests().await?;

zebra-rpc/src/methods/tests/snapshots/get_address_balance@mainnet_10.snap

@@ -1,8 +1,8 @@
 ---
 source: zebra-rpc/src/methods/tests/snapshot.rs
-assertion_line: 192
 expression: address_balance
 ---
 {
-  "balance": 687500
+  "balance": 687500,
+  "received": 687500
 }

zebra-rpc/src/methods/tests/snapshots/get_address_balance@testnet_10.snap

@@ -1,8 +1,8 @@
 ---
 source: zebra-rpc/src/methods/tests/snapshot.rs
-assertion_line: 192
 expression: address_balance
 ---
 {
-  "balance": 687500
+  "balance": 687500,
+  "received": 687500
 }

zebra-rpc/tests/serialization_tests.rs

@@ -106,12 +106,14 @@ fn test_get_address_balance() -> Result<(), Box<dyn std::error::Error>> {
     // Test response
     let json = r#"
 {
-  "balance": 11290259389
+  "balance": 11290259389,
+  "received": 11290259390
 }
 "#;
     let obj: AddressBalance = serde_json::from_str(json)?;
     let new_obj = AddressBalance {
         balance: obj.balance,
+        received: obj.received,
     };
 
     assert_eq!(obj, new_obj);