Merge pull request #4180 from ProvableHQ/copilot/add-block-height-to-query-response

Add block height and block hash to transaction query responses via `?metadata=true`

Author: vicsn

node/rest/src/routes.rs

@@ -91,6 +91,15 @@ pub(crate) struct Commitments {
     commitments: Vec<String>,
 }
 
+/// The return value for a transaction metadata query.
+#[skip_serializing_none]
+#[derive(Serialize)]
+pub(crate) struct TransactionWithMetadata<T: Serialize, N: Network> {
+    transaction: T,
+    block_hash: Option<N::BlockHash>,
+    block_height: Option<u32>,
+}
+
 /// The return value for a `sync_status` query.
 #[skip_serializing_none]
 #[derive(Copy, Clone, Serialize)]
@@ -292,25 +301,54 @@ impl<N: Network, C: ConsensusStorage<N>, R: Routing<N>> Rest<N, C, R> {
     }
 
     /// GET /<network>/transaction/{transactionID}
+    /// GET /<network>/transaction/{transactionID}?metadata={true}
     pub(crate) async fn get_transaction(
         State(rest): State<Self>,
         Path(tx_id): Path<N::TransactionID>,
+        metadata: Query<Metadata>,
     ) -> Result<ErasedJson, RestError> {
         // Ledger returns a generic anyhow::Error, so checking the message is the only way to parse it.
-        Ok(ErasedJson::pretty(rest.ledger.get_transaction(tx_id).map_err(|err| {
+        let transaction = rest.ledger.get_transaction(tx_id).map_err(|err| {
             if err.to_string().contains("Missing") { RestError::not_found(err) } else { RestError::from(err) }
-        })?))
+        })?;
+        // Check if metadata is requested and return the transaction with metadata if so.
+        if metadata.metadata.unwrap_or(false) {
+            // Get the block hash and height for the transaction, if it exists.
+            let block_hash = rest.ledger.find_block_hash(&tx_id).ok().flatten();
+            let block_height = block_hash.and_then(|hash| rest.ledger.get_height(&hash).ok());
+            Ok(ErasedJson::pretty(TransactionWithMetadata::<_, N> { transaction, block_hash, block_height }))
+        } else {
+            Ok(ErasedJson::pretty(transaction))
+        }
     }
 
     /// GET /<network>/transaction/confirmed/{transactionID}
+    /// GET /<network>/transaction/confirmed/{transactionID}?metadata={true}
     pub(crate) async fn get_confirmed_transaction(
         State(rest): State<Self>,
         Path(tx_id): Path<N::TransactionID>,
+        metadata: Query<Metadata>,
     ) -> Result<ErasedJson, RestError> {
         // Ledger returns a generic anyhow::Error, so checking the message is the only way to parse it.
-        Ok(ErasedJson::pretty(rest.ledger.get_confirmed_transaction(tx_id).map_err(|err| {
+        let transaction = rest.ledger.get_confirmed_transaction(tx_id).map_err(|err| {
             if err.to_string().contains("Missing") { RestError::not_found(err) } else { RestError::from(err) }
-        })?))
+        })?;
+        // Check if metadata is requested and return the transaction with metadata if so.
+        if metadata.metadata.unwrap_or(false) {
+            // Get the block hash and height for the confirmed transaction.
+            let block_hash = rest
+                .ledger
+                .find_block_hash(&tx_id)?
+                .ok_or_else(|| anyhow!("Block hash not found for transaction {tx_id}"))?;
+            let block_height = rest.ledger.get_height(&block_hash)?;
+            Ok(ErasedJson::pretty(TransactionWithMetadata::<_, N> {
+                transaction,
+                block_hash: Some(block_hash),
+                block_height: Some(block_height),
+            }))
+        } else {
+            Ok(ErasedJson::pretty(transaction))
+        }
     }
 
     /// GET /<network>/transaction/unconfirmed/{transactionID}