Merge pull request #6733 from hstove-stacks/fix/add-block-height-to-get-transaction

feat: add block height to get-transaction RPC

Author: hstove-stacks

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 - Fixed an issue where `event.committed` was always equal to `true` in the block replay RPC endpoint
 - Added `result_hex` and `post_condition_aborted` to the block replay RPC endpoint
 - Added `--epoch <epoch_number>` flag to `clarity-cli` commands to specify the epoch context for evaluation.
+- In the `/v3/transaction/{txid}` RPC endpoint, added `block_height` and `is_canonical` to the response.
 
 ### Fixed
 

stacks-node/src/tests/signer/v0.rs

@@ -34,6 +34,7 @@ use madhouse::{execute_commands, prop_allof, scenario, Command, CommandWrapper};
 use pinny::tag;
 use proptest::prelude::Strategy;
 use rand::{thread_rng, Rng};
+use reqwest::header::AUTHORIZATION;
 use rusqlite::Connection;
 use stacks::address::AddressHashMode;
 use stacks::burnchains::Txid;
@@ -67,6 +68,7 @@ use stacks::core::test_util::{
 use stacks::core::{StacksEpochId, CHAIN_ID_TESTNET, HELIUM_BLOCK_LIMIT_20};
 use stacks::libstackerdb::StackerDBChunkData;
 use stacks::net::api::getsigner::GetSignerResponse;
+use stacks::net::api::gettransaction::TransactionResponse;
 use stacks::net::api::postblock_proposal::{
     BlockValidateResponse, ValidateRejectCode, TEST_REJECT_REPLAY_TXS,
     TEST_VALIDATE_DELAY_DURATION_SECS, TEST_VALIDATE_STALL,
@@ -3989,6 +3991,7 @@ fn tx_replay_btc_on_stx_invalidation() {
                 c.reset_replay_set_after_fork_blocks = 5;
             },
             |node_config| {
+                node_config.node.txindex = true;
                 node_config.miner.block_commit_delay = Duration::from_secs(1);
                 node_config.miner.replay_transactions = true;
                 node_config.miner.activated_vrf_key_path =
@@ -4001,7 +4004,7 @@ fn tx_replay_btc_on_stx_invalidation() {
 
     let conf = &signer_test.running_nodes.conf;
     let mut miner_keychain = Keychain::default(conf.node.seed.clone()).generate_op_signer();
-    let _http_origin = format!("http://{}", &conf.node.rpc_bind);
+    let http_origin = format!("http://{}", &conf.node.rpc_bind);
     let mut btc_controller = BitcoinRegtestController::new(conf.clone(), None);
     let submitted_commits = signer_test
         .running_nodes
@@ -4081,7 +4084,7 @@ fn tx_replay_btc_on_stx_invalidation() {
     signer_test.mine_nakamoto_block(Duration::from_secs(30), true);
 
     wait_for(30, || {
-        let account = get_account(&_http_origin, &recipient_addr);
+        let account = get_account(&http_origin, &recipient_addr);
         Ok(account.balance == recipient_balance.into())
     })
     .expect("Timed out waiting for balance to be updated");
@@ -4178,9 +4181,35 @@ fn tx_replay_btc_on_stx_invalidation() {
 
     assert!(found_block, "Failed to mine the tenure change block");
     // Ensure that in the 30 seconds, the nonce did not increase. This also asserts that no tx replays were mined.
-    let account = get_account(&_http_origin, &recipient_addr);
+    let account = get_account(&http_origin, &recipient_addr);
     assert_eq!(account.nonce, 0, "Expected recipient nonce to be 0");
 
+    // Call `/v3/transaction/{txid}` and verify that `is_canonical` is false
+    let get_transaction = |txid: &String| {
+        let url = &format!("{http_origin}/v3/transaction/{txid}");
+        info!("Send request: GET {url}");
+        reqwest::blocking::Client::new()
+            .get(url)
+            .header(
+                AUTHORIZATION,
+                conf.connection_options.auth_token.clone().unwrap(),
+            )
+            .send()
+            .unwrap_or_else(|e| panic!("GET request failed: {e}"))
+            .json::<TransactionResponse>()
+            .unwrap()
+    };
+
+    let transaction = get_transaction(&txid);
+    assert!(
+        !transaction.is_canonical,
+        "Expected transaction response to be non-canonical"
+    );
+    assert!(
+        transaction.block_height.is_none(),
+        "Expected block height of tx response to be none"
+    );
+
     signer_test.shutdown();
 }
 

stackslib/src/net/api/gettransaction.rs

@@ -33,6 +33,8 @@ pub struct TransactionResponse {
     pub index_block_hash: StacksBlockId,
     pub tx: String,
     pub result: String,
+    pub block_height: Option<u64>,
+    pub is_canonical: bool,
 }
 
 #[derive(Clone)]
@@ -91,7 +93,7 @@ impl RPCRequestHandler for RPCGetTransactionRequestHandler {
     fn try_handle_request(
         &mut self,
         preamble: HttpRequestPreamble,
-        _contents: HttpRequestContents,
+        contents: HttpRequestContents,
         node: &mut StacksNodeState,
     ) -> Result<(HttpResponsePreamble, HttpResponseContents), NetError> {
         if !node.txindex {
@@ -108,6 +110,13 @@ impl RPCRequestHandler for RPCGetTransactionRequestHandler {
             .take()
             .ok_or(NetError::SendError("`txid` no set".into()))?;
 
+        let tip = match node.load_stacks_chain_tip(&preamble, &contents) {
+            Ok(tip) => tip,
+            Err(error_resp) => {
+                return error_resp.try_into_contents().map_err(NetError::from);
+            }
+        };
+
         node.with_node_state(|_network, _sortdb, chainstate, _mempool, _rpc_args| {
             let index_block_hash_and_tx_hex_opt = match NakamotoChainState::get_tx_info_from_txid(
                 chainstate.index_conn().conn(),
@@ -126,11 +135,21 @@ impl RPCRequestHandler for RPCGetTransactionRequestHandler {
 
             match index_block_hash_and_tx_hex_opt {
                 Some((index_block_hash, tx_hex, result)) => {
+                    let block_height = chainstate
+                        .index_conn()
+                        .get_ancestor_block_height(&index_block_hash, &tip)?;
+                    let is_canonical = chainstate
+                        .index_conn()
+                        .get_ancestor_block_height(&index_block_hash, &tip)
+                        .map(|height_opt| height_opt.is_some())
+                        .unwrap_or(false);
                     let preamble = HttpResponsePreamble::ok_json(&preamble);
                     let body = HttpResponseContents::try_from_json(&TransactionResponse {
-                        index_block_hash,
+                        index_block_hash: index_block_hash.clone(),
                         tx: tx_hex,
                         result,
+                        block_height,
+                        is_canonical,
                     })?;
                     return Ok((preamble, body));
                 }