Skip to content

Commit

Permalink
doc: Document that list_transactions() might return unsorted txs, sho…
Browse files Browse the repository at this point in the history
…w how to sort them if needed
  • Loading branch information
w0xlt committed Aug 3, 2022
1 parent 6bae52e commit 7fdacdb
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/wallet/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -438,11 +438,22 @@ where
self.database.borrow().get_tx(txid, include_raw)
}

/// Return the list of transactions made and received by the wallet
/// Return an unsorted list of transactions made and received by the wallet
///
/// Optionally fill the [`TransactionDetails::transaction`] field with the raw transaction if
/// `include_raw` is `true`.
///
/// To sort transactions, the following code can be used:
/// ```no_run
/// # let mut tx_list: Vec<bdk::TransactionDetails> = vec![];
/// tx_list.sort_by(|a, b| {
/// b.confirmation_time
/// .as_ref()
/// .map(|t| t.height)
/// .cmp(&a.confirmation_time.as_ref().map(|t| t.height))
/// });
/// ```
///
/// Note that this methods only operate on the internal database, which first needs to be
/// [`Wallet::sync`] manually.
pub fn list_transactions(&self, include_raw: bool) -> Result<Vec<TransactionDetails>, Error> {
Expand Down

0 comments on commit 7fdacdb

Please sign in to comment.