From 224be27aa8242b0c02d937c7a4a198b205789bf3 Mon Sep 17 00:00:00 2001 From: Alekos Filini Date: Fri, 4 Jun 2021 15:53:15 +0200 Subject: [PATCH] Fix example/doctests format --- src/descriptor/template.rs | 2 +- src/keys/mod.rs | 10 +++++----- src/wallet/coin_selection.rs | 29 ++++++++++++++++++----------- src/wallet/tx_builder.rs | 14 +++++++++----- 4 files changed, 33 insertions(+), 22 deletions(-) diff --git a/src/descriptor/template.rs b/src/descriptor/template.rs index bba756c1..9b5d025e 100644 --- a/src/descriptor/template.rs +++ b/src/descriptor/template.rs @@ -37,7 +37,7 @@ pub type DescriptorTemplateOut = (ExtendedDescriptor, KeyMap, ValidNetworks); /// /// ``` /// use bdk::descriptor::error::Error as DescriptorError; -/// use bdk::keys::{KeyError, IntoDescriptorKey}; +/// use bdk::keys::{IntoDescriptorKey, KeyError}; /// use bdk::miniscript::Legacy; /// use bdk::template::{DescriptorTemplate, DescriptorTemplateOut}; /// diff --git a/src/keys/mod.rs b/src/keys/mod.rs index 36ba2c40..1fbeada7 100644 --- a/src/keys/mod.rs +++ b/src/keys/mod.rs @@ -192,7 +192,7 @@ impl ExtScriptContext for Ctx { /// ``` /// use bdk::bitcoin::PublicKey; /// -/// use bdk::keys::{DescriptorKey, KeyError, ScriptContext, IntoDescriptorKey}; +/// use bdk::keys::{DescriptorKey, IntoDescriptorKey, KeyError, ScriptContext}; /// /// pub struct MyKeyType { /// pubkey: PublicKey, @@ -211,8 +211,8 @@ impl ExtScriptContext for Ctx { /// use bdk::bitcoin::PublicKey; /// /// use bdk::keys::{ -/// mainnet_network, DescriptorKey, DescriptorPublicKey, DescriptorSinglePub, KeyError, -/// ScriptContext, IntoDescriptorKey, +/// mainnet_network, DescriptorKey, DescriptorPublicKey, DescriptorSinglePub, +/// IntoDescriptorKey, KeyError, ScriptContext, /// }; /// /// pub struct MyKeyType { @@ -237,7 +237,7 @@ impl ExtScriptContext for Ctx { /// ``` /// use bdk::bitcoin::PublicKey; /// -/// use bdk::keys::{DescriptorKey, ExtScriptContext, KeyError, ScriptContext, IntoDescriptorKey}; +/// use bdk::keys::{DescriptorKey, ExtScriptContext, IntoDescriptorKey, KeyError, ScriptContext}; /// /// pub struct MyKeyType { /// is_legacy: bool, @@ -266,7 +266,7 @@ impl ExtScriptContext for Ctx { /// use bdk::bitcoin::PublicKey; /// use std::str::FromStr; /// -/// use bdk::keys::{DescriptorKey, KeyError, IntoDescriptorKey}; +/// use bdk::keys::{DescriptorKey, IntoDescriptorKey, KeyError}; /// /// pub struct MySegwitOnlyKeyType { /// pubkey: PublicKey, diff --git a/src/wallet/coin_selection.rs b/src/wallet/coin_selection.rs index f2e2ca5f..e3729bbc 100644 --- a/src/wallet/coin_selection.rs +++ b/src/wallet/coin_selection.rs @@ -46,17 +46,25 @@ //! let mut selected_amount = 0; //! let mut additional_weight = 0; //! let all_utxos_selected = required_utxos -//! .into_iter().chain(optional_utxos) -//! .scan((&mut selected_amount, &mut additional_weight), |(selected_amount, additional_weight), weighted_utxo| { -//! **selected_amount += weighted_utxo.utxo.txout().value; -//! **additional_weight += TXIN_BASE_WEIGHT + weighted_utxo.satisfaction_weight; -//! Some(weighted_utxo.utxo) -//! }) +//! .into_iter() +//! .chain(optional_utxos) +//! .scan( +//! (&mut selected_amount, &mut additional_weight), +//! |(selected_amount, additional_weight), weighted_utxo| { +//! **selected_amount += weighted_utxo.utxo.txout().value; +//! **additional_weight += TXIN_BASE_WEIGHT + weighted_utxo.satisfaction_weight; +//! Some(weighted_utxo.utxo) +//! }, +//! ) //! .collect::>(); //! let additional_fees = additional_weight as f32 * fee_rate.as_sat_vb() / 4.0; -//! let amount_needed_with_fees = (fee_amount + additional_fees).ceil() as u64 + amount_needed; -//! if amount_needed_with_fees > selected_amount { -//! return Err(bdk::Error::InsufficientFunds{ needed: amount_needed_with_fees, available: selected_amount }); +//! let amount_needed_with_fees = +//! (fee_amount + additional_fees).ceil() as u64 + amount_needed; +//! if amount_needed_with_fees > selected_amount { +//! return Err(bdk::Error::InsufficientFunds { +//! needed: amount_needed_with_fees, +//! available: selected_amount, +//! }); //! } //! //! Ok(CoinSelectionResult { @@ -72,8 +80,7 @@ //! let to_address = Address::from_str("2N4eQYCbKUHCCTUjBJeHcJp9ok6J2GZsTDt").unwrap(); //! let (psbt, details) = { //! let mut builder = wallet.build_tx().coin_selection(AlwaysSpendEverything); -//! builder -//! .add_recipient(to_address.script_pubkey(), 50_000); +//! builder.add_recipient(to_address.script_pubkey(), 50_000); //! builder.finish()? //! }; //! diff --git a/src/wallet/tx_builder.rs b/src/wallet/tx_builder.rs index f7eb6c59..92718c88 100644 --- a/src/wallet/tx_builder.rs +++ b/src/wallet/tx_builder.rs @@ -87,9 +87,9 @@ impl TxBuilderContext for BumpFee {} /// let (psbt1, details) = { /// let mut builder = wallet.build_tx(); /// builder -/// .ordering(TxOrdering::Untouched) -/// .add_recipient(addr1.script_pubkey(), 50_000) -/// .add_recipient(addr2.script_pubkey(), 50_000); +/// .ordering(TxOrdering::Untouched) +/// .add_recipient(addr1.script_pubkey(), 50_000) +/// .add_recipient(addr2.script_pubkey(), 50_000); /// builder.finish()? /// }; /// @@ -103,7 +103,10 @@ impl TxBuilderContext for BumpFee {} /// builder.finish()? /// }; /// -/// assert_eq!(psbt1.global.unsigned_tx.output[..2], psbt2.global.unsigned_tx.output[..2]); +/// assert_eq!( +/// psbt1.global.unsigned_tx.output[..2], +/// psbt2.global.unsigned_tx.output[..2] +/// ); /// # Ok::<(), bdk::Error>(()) /// ``` /// @@ -246,7 +249,8 @@ impl<'a, B, D: BatchDatabase, Cs: CoinSelectionAlgorithm, Ctx: TxBuilderConte /// let mut path = BTreeMap::new(); /// path.insert("aabbccdd".to_string(), vec![0, 1]); /// - /// let builder = wallet.build_tx() + /// let builder = wallet + /// .build_tx() /// .add_recipient(to_address.script_pubkey(), 50_000) /// .policy_path(path, KeychainKind::External); ///