Add OutputIdProof to response for /api/core/v3/outputs/{outputId} (#1763

)

sdk/examples/client/02_address_balance.rs

@@ -59,10 +59,10 @@ async fn main() -> Result<()> {
     let mut total_amount = 0;
     let mut total_native_tokens = NativeTokensBuilder::new();
     for output in outputs {
-        if let Some(native_token) = output.native_token() {
+        if let Some(native_token) = output.output.native_token() {
             total_native_tokens.add_native_token(*native_token)?;
         }
-        total_amount += output.amount();
+        total_amount += output.output.amount();
     }
 
     println!(

sdk/src/client/node_api/core/mod.rs

@@ -7,18 +7,21 @@ pub mod routes;
 
 use crate::{
     client::{node_api::error::Error as NodeApiError, Client, Error, Result},
-    types::block::output::{Output, OutputId, OutputMetadata, OutputWithMetadata},
+    types::{
+        api::core::OutputResponse,
+        block::output::{OutputId, OutputMetadata, OutputWithMetadata},
+    },
 };
 
 impl Client {
     /// Requests outputs by their output ID in parallel.
-    pub async fn get_outputs(&self, output_ids: &[OutputId]) -> Result<Vec<Output>> {
+    pub async fn get_outputs(&self, output_ids: &[OutputId]) -> Result<Vec<OutputResponse>> {
         futures::future::try_join_all(output_ids.iter().map(|id| self.get_output(id))).await
     }
 
     /// Requests outputs by their output ID in parallel, ignoring outputs not found.
     /// Useful to get data about spent outputs, that might not be pruned yet.
-    pub async fn get_outputs_ignore_not_found(&self, output_ids: &[OutputId]) -> Result<Vec<Output>> {
+    pub async fn get_outputs_ignore_not_found(&self, output_ids: &[OutputId]) -> Result<Vec<OutputResponse>> {
         futures::future::join_all(output_ids.iter().map(|id| self.get_output(id)))
             .await
             .into_iter()

sdk/src/client/node_api/core/routes.rs

@@ -17,12 +17,12 @@ use crate::{
     types::{
         api::core::{
             BlockMetadataResponse, BlockWithMetadataResponse, CommitteeResponse, CongestionResponse, InfoResponse,
-            IssuanceBlockHeaderResponse, ManaRewardsResponse, PeerResponse, RoutesResponse, SubmitBlockResponse,
-            UtxoChangesResponse, ValidatorResponse, ValidatorsResponse,
+            IssuanceBlockHeaderResponse, ManaRewardsResponse, OutputResponse, PeerResponse, RoutesResponse,
+            SubmitBlockResponse, UtxoChangesResponse, ValidatorResponse, ValidatorsResponse,
         },
         block::{
             address::ToBech32Ext,
-            output::{AccountId, Output, OutputId, OutputMetadata, OutputWithMetadata},
+            output::{AccountId, OutputId, OutputMetadata, OutputWithMetadata},
             payload::signed_transaction::TransactionId,
             slot::{EpochIndex, SlotCommitment, SlotCommitmentId, SlotIndex},
             Block, BlockDto, BlockId,
@@ -234,7 +234,7 @@ impl ClientInner {
 
     /// Finds an output by its ID and returns it as object.
     /// GET /api/core/v3/outputs/{outputId}
-    pub async fn get_output(&self, output_id: &OutputId) -> Result<Output> {
+    pub async fn get_output(&self, output_id: &OutputId) -> Result<OutputResponse> {
         let path = &format!("api/core/v3/outputs/{output_id}");
 
         self.get_request(path, None, false, true).await

sdk/src/types/api/core.rs

@@ -14,7 +14,7 @@ use crate::{
     types::block::{
         address::Bech32Address,
         core::Parents,
-        output::{Output, OutputId, OutputMetadata, OutputWithMetadata},
+        output::{Output, OutputId, OutputIdProof, OutputMetadata, OutputWithMetadata},
         payload::signed_transaction::TransactionId,
         protocol::{ProtocolParameters, ProtocolParametersHash},
         semantic::TransactionFailureReason,
@@ -529,11 +529,10 @@ pub struct UtxoChangesResponse {
     pub consumed_outputs: Vec<OutputId>,
 }
 
-// TODO use for outputs route https://github.com/iotaledger/iota-sdk/issues/1686
-// /// Contains the generic [`Output`] with associated [`OutputIdProof`].
-// #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
-// #[serde(rename_all = "camelCase")]
-// pub struct OutputResponse {
-//     pub output: Output,
-//     pub output_id_proof: OutputIdProof,
-// }
+/// Contains the generic [`Output`] with associated [`OutputIdProof`].
+#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct OutputResponse {
+    pub output: Output,
+    pub output_id_proof: OutputIdProof,
+}

sdk/src/wallet/core/mod.rs

@@ -391,9 +391,9 @@ where
 
         // Foundry was not found in the wallet, try to get it from the node
         let foundry_output_id = self.client().foundry_output_id(foundry_id).await?;
-        let output = self.client().get_output(&foundry_output_id).await?;
+        let output_response = self.client().get_output(&foundry_output_id).await?;
 
-        Ok(output)
+        Ok(output_response.output)
     }
 
     /// Save the wallet to the database, accepts the updated wallet data as option so we don't need to drop it before

sdk/src/wallet/operations/syncing/foundries.rs

@@ -41,7 +41,7 @@ where
 
         // Update account with new foundries.
         for foundry in results.into_iter().flatten() {
-            if let Output::Foundry(foundry) = foundry {
+            if let Output::Foundry(foundry) = foundry.output {
                 foundries.insert(foundry.id(), foundry);
             }
         }

sdk/tests/client/node_api/core.rs

@@ -163,7 +163,7 @@ async fn test_get_output_raw() {
     )
     .unwrap();
 
-    assert_eq!(output, output_raw);
+    assert_eq!(output.output, output_raw);
 }
 
 #[ignore]