Implement UTXO Return Address RPC

cli/src/modules/rpc.rs

@@ -269,6 +269,21 @@ impl Rpc {
                 let result = rpc.get_current_block_color_call(None, GetCurrentBlockColorRequest { hash }).await?;
                 self.println(&ctx, result);
             }
+            RpcApiOps::GetUtxoReturnAddress => {
+                if argv.is_empty() || argv.len() != 2 {
+                    return Err(Error::custom("Please specify a txid and a accepting_block_daa_score"));
+                }
+
+                let txid = argv.remove(0);
+                let txid = RpcHash::from_hex(txid.as_str())?;
+
+                let accepting_block_daa_score = argv.remove(0).parse::<u64>()?;
+
+                let result =
+                    rpc.get_utxo_return_address_call(None, GetUtxoReturnAddressRequest { txid, accepting_block_daa_score }).await?;
+
+                self.println(&ctx, result);
+            }
             _ => {
                 tprintln!(ctx, "rpc method exists but is not supported by the cli: '{op_str}'\r\n");
                 return Ok(());

components/consensusmanager/Cargo.toml

@@ -14,6 +14,7 @@ duration-string.workspace = true
 futures-util.workspace = true
 futures.workspace = true
 itertools.workspace = true
+kaspa-addresses.workspace=true
 kaspa-consensus-core.workspace = true
 kaspa-consensus-notify.workspace = true
 kaspa-core.workspace = true

components/consensusmanager/src/session.rs

@@ -2,6 +2,7 @@
 //!
 //! We use newtypes in order to simplify changing the underlying lock in the future
 
+use kaspa_addresses::Address;
 use kaspa_consensus_core::{
     acceptance_data::AcceptanceData,
     api::{BlockCount, BlockValidationFutures, ConsensusApi, ConsensusStats, DynConsensus},
@@ -11,6 +12,7 @@ use kaspa_consensus_core::{
     errors::consensus::ConsensusResult,
     header::Header,
     pruning::{PruningPointProof, PruningPointTrustedData, PruningPointsList},
+    return_address::ReturnAddressError,
     trusted::{ExternalGhostdagData, TrustedBlock},
     tx::{MutableTransaction, Transaction, TransactionOutpoint, UtxoEntry},
     BlockHashSet, BlueWorkType, ChainPath, Hash,
@@ -313,6 +315,14 @@ impl ConsensusSessionOwned {
         self.clone().spawn_blocking(|c| c.get_chain_block_samples()).await
     }
 
+    pub async fn async_get_utxo_return_script_public_key(
+        &self,
+        txid: Hash,
+        accepting_block_daa_score: u64,
+    ) -> Result<Address, ReturnAddressError> {
+        self.clone().spawn_blocking(move |c| c.get_utxo_return_address(txid, accepting_block_daa_score)).await
+    }
+
     /// Returns the antipast of block `hash` from the POV of `context`, i.e. `antipast(hash) ∩ past(context)`.
     /// Since this might be an expensive operation for deep blocks, we allow the caller to specify a limit
     /// `max_traversal_allowed` on the maximum amount of blocks to traverse for obtaining the answer

consensus/Cargo.toml

@@ -18,6 +18,7 @@ faster-hex.workspace = true
 futures-util.workspace = true
 indexmap.workspace = true
 itertools.workspace = true
+kaspa-addresses.workspace = true
 kaspa-consensus-core.workspace = true
 kaspa-consensus-notify.workspace = true
 kaspa-consensusmanager.workspace = true

consensus/core/src/api/mod.rs

@@ -1,4 +1,5 @@
 use futures_util::future::BoxFuture;
+use kaspa_addresses::Address;
 use kaspa_muhash::MuHash;
 use std::sync::Arc;
 
@@ -18,6 +19,7 @@ use crate::{
     },
     header::Header,
     pruning::{PruningPointProof, PruningPointTrustedData, PruningPointsList, PruningProofMetadata},
+    return_address::ReturnAddressError,
     trusted::{ExternalGhostdagData, TrustedBlock},
     tx::{MutableTransaction, Transaction, TransactionOutpoint, UtxoEntry},
     BlockHashSet, BlueWorkType, ChainPath,
@@ -170,6 +172,10 @@ pub trait ConsensusApi: Send + Sync {
         unimplemented!()
     }
 
+    fn get_utxo_return_address(&self, txid: Hash, daa_score: u64) -> Result<Address, ReturnAddressError> {
+        unimplemented!()
+    }
+
     fn get_virtual_parents(&self) -> BlockHashSet {
         unimplemented!()
     }

consensus/core/src/lib.rs

@@ -30,6 +30,7 @@ pub mod merkle;
 pub mod muhash;
 pub mod network;
 pub mod pruning;
+pub mod return_address;
 pub mod sign;
 pub mod subnets;
 pub mod trusted;

consensus/core/src/return_address.rs

@@ -0,0 +1,15 @@
+use thiserror::Error;
+
+#[derive(Error, Debug, Clone)]
+pub enum ReturnAddressError {
+    #[error("Transaction is already pruned")]
+    AlreadyPruned,
+    #[error("Transaction return address is coinbase")]
+    TxFromCoinbase,
+    #[error("Transaction not found at given accepting daa score")]
+    NoTxAtScore,
+    #[error("Transaction was found but not standard")]
+    NonStandard,
+    #[error("Transaction return address not found: {0}")]
+    NotFound(String),
+}

consensus/src/consensus/mod.rs

@@ -41,6 +41,7 @@ use crate::{
         window::{WindowManager, WindowType},
     },
 };
+use kaspa_addresses::Address;
 use kaspa_consensus_core::{
     acceptance_data::AcceptanceData,
     api::{
@@ -65,6 +66,7 @@ use kaspa_consensus_core::{
     muhash::MuHashExtensions,
     network::NetworkType,
     pruning::{PruningPointProof, PruningPointTrustedData, PruningPointsList, PruningProofMetadata},
+    return_address::ReturnAddressError,
     trusted::{ExternalGhostdagData, TrustedBlock},
     tx::{MutableTransaction, Transaction, TransactionOutpoint, UtxoEntry},
     BlockHashSet, BlueWorkType, ChainPath, HashMapCustomHasher,
@@ -687,6 +689,10 @@ impl ConsensusApi for Consensus {
         sample_headers
     }
 
+    fn get_utxo_return_address(&self, txid: Hash, target_daa_score: u64) -> Result<Address, ReturnAddressError> {
+        self.virtual_processor.get_utxo_return_address(txid, target_daa_score, self.get_source(), &self.config)
+    }
+
     fn get_virtual_parents(&self) -> BlockHashSet {
         self.lkg_virtual_state.load().parents.iter().copied().collect()
     }