temp 1

Author: thunderbiscuit

wallet/src/wallet/mod.rs

@@ -76,6 +76,9 @@ use crate::wallet::{
 };
 
 // re-exports
+#[cfg(feature = "std")]
+use crate::wallet::utils::TxDetails;
+
 pub use bdk_chain::Balance;
 pub use changeset::ChangeSet;
 pub use params::*;
@@ -821,6 +824,45 @@ impl Wallet {
             .map(|((k, i), full_txo)| new_local_utxo(k, i, full_txo))
     }
 
+    /// Build a [`TxDetails`] struct for a given transaction.
+    ///
+    /// If the transaction with txid [`Txid`] cannot be found in the wallet's transaction graph,
+    /// None is returned.
+    // #[cfg(feature = "std")]
+    pub fn get_tx_details(&self, txid: Txid) -> Option<TxDetails> {
+        let tx_graph = self.indexed_graph.graph();
+        let tx_index = &self.indexed_graph.index;
+
+        // It should be impossible to have more than 1 right? In which case I can use the `find()`
+        // method on the collection instead of collecting into a vector.
+
+        // This relies on the impossibility of having 2 transactions with the same Txid in the list
+        // canonical transactions but let me know if this is wrong!
+        let optional_tx: Option<CanonicalTx<Arc<Transaction>, ConfirmationBlockTime>> = tx_graph
+            .list_canonical_txs(&self.chain, self.chain.tip().block_id())
+            .filter(|c_tx| tx_index.is_tx_relevant(&c_tx.tx_node.tx))
+            .find(|tx| tx.tx_node.compute_txid() == txid);
+
+        let tx = optional_tx?;
+
+        let (sent, received) = self.sent_and_received(&tx.tx_node.tx);
+        let fee = self.calculate_fee(&tx.tx_node.tx).unwrap();
+        let fee_rate = self.calculate_fee_rate(&tx.tx_node.tx).unwrap();
+        let chain_position = tx.chain_position;
+
+        let tx_details: TxDetails = TxDetails {
+            txid,
+            received,
+            sent,
+            fee,
+            fee_rate,
+            chain_position,
+            tx: tx.tx_node.tx,
+        };
+
+        Some(tx_details)
+    }
+
     /// List all relevant outputs (includes both spent and unspent, confirmed and unconfirmed).
     ///
     /// To list only unspent outputs (UTXOs), use [`Wallet::list_unspent`] instead.

wallet/src/wallet/utils.rs

@@ -9,9 +9,10 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
+use alloc::sync::Arc;
 use bitcoin::secp256k1::{All, Secp256k1};
-use bitcoin::{absolute, relative, Amount, Script, Sequence};
-
+use bitcoin::{absolute, relative, Amount, FeeRate, Script, Sequence, Transaction, Txid};
+use chain::{ChainPosition, ConfirmationBlockTime};
 use miniscript::{MiniscriptKey, Satisfier, ToPublicKey};
 
 use rand_core::RngCore;
@@ -133,6 +134,18 @@ pub(crate) fn shuffle_slice<T>(list: &mut [T], rng: &mut impl RngCore) {
 
 pub(crate) type SecpCtx = Secp256k1<All>;
 
+/// Details about a transaction the wallet knows about.
+#[derive(Debug)]
+pub struct TxDetails {
+    pub txid: Txid,
+    pub received: Amount,
+    pub sent: Amount,
+    pub fee: Amount,
+    pub fee_rate: FeeRate,
+    pub chain_position: ChainPosition<ConfirmationBlockTime>,
+    pub tx: Arc<Transaction>,
+}
+
 #[cfg(test)]
 mod test {
     // When nSequence is lower than this flag the timelock is interpreted as block-height-based,

wallet/tests/wallet.rs

@@ -4306,3 +4306,17 @@ fn test_wallet_transactions_relevant() {
     assert!(full_tx_count_before < full_tx_count_after);
     assert!(canonical_tx_count_before < canonical_tx_count_after);
 }
+
+#[test]
+fn test_tx_details_method() {
+    let (test_wallet, txid_1) = get_funded_wallet_wpkh();
+    let tx_details_1 = test_wallet.get_tx_details(txid_1);
+    // dbg!(&tx_details);
+
+    // Transaction id not part of the TxGraph
+    let txid_2 = Txid::from_raw_hash(Hash::all_zeros());
+    let tx_details_2 = test_wallet.get_tx_details(txid_2);
+
+    assert!(tx_details_1.is_some());
+    assert!(tx_details_2.is_none());
+}