[docs] Format code in docs with '--config format_code_in_doc_comments=true'

diff --git a/src/blockchain/any.rs b/src/blockchain/any.rs
index 04d6df04bb18dc8e0942953e7ce3283742c009b3..640819607de52d549eaa969b7c9bf39d2c48c274 100644 (file)
--- a/src/blockchain/any.rs
+++ b/src/blockchain/any.rs
@@ -75,7 +75,13 @@
 //! # use bdk::Wallet;
 //! let config = serde_json::from_str("...")?;
 //! let blockchain = AnyBlockchain::from_config(&config)?;
-//! let wallet = Wallet::new("...", None, Network::Testnet, MemoryDatabase::default(), blockchain)?;
+//! let wallet = Wallet::new(
+//!     "...",
+//!     None,
+//!     Network::Testnet,
+//!     MemoryDatabase::default(),
+//!     blockchain,
+//! )?;
 //! # Ok::<(), bdk::Error>(())
 //! ```
 

diff --git a/src/blockchain/compact_filters/mod.rs b/src/blockchain/compact_filters/mod.rs
index c925d9385559387e0e8fe6c961cfd0edc30a5f46..fc9b4cf5927b37fd30a4bf1033377555f0899f2f 100644 (file)
--- a/src/blockchain/compact_filters/mod.rs
+++ b/src/blockchain/compact_filters/mod.rs
@@ -50,11 +50,13 @@
 //!
 //! let mempool = Arc::new(Mempool::default());
 //! let peers = (0..num_threads)
-//!     .map(|_| Peer::connect(
-//!         "btcd-mainnet.lightning.computer:8333",
-//!         Arc::clone(&mempool),
-//!         Network::Bitcoin,
-//!     ))
+//!     .map(|_| {
+//!         Peer::connect(
+//!             "btcd-mainnet.lightning.computer:8333",
+//!             Arc::clone(&mempool),
+//!             Network::Bitcoin,
+//!         )
+//!     })
 //!     .collect::<Result<_, _>>()?;
 //! let blockchain = CompactFiltersBlockchain::new(peers, "./wallet-filters", Some(500_000))?;
 //! # Ok::<(), CompactFiltersError>(())

diff --git a/src/blockchain/utils.rs b/src/blockchain/utils.rs
index 977a561d069f9cca98136fa7bd9036c621ddfb2a..2e32ed1b46e6f4cad75b4c85d1be7c0b17a5f16b 100644 (file)
--- a/src/blockchain/utils.rs
+++ b/src/blockchain/utils.rs
@@ -370,7 +370,7 @@ fn save_transaction_details_and_utxos<D: BatchDatabase>(
         sent: outgoing,
         height,
         timestamp,
-        fees: inputs_sum.saturating_sub(outputs_sum), // if the tx is a coinbase, fees would be negative
+        fees: inputs_sum.saturating_sub(outputs_sum), /* if the tx is a coinbase, fees would be negative */
     };
     updates.set_tx(&tx_details)?;
 

diff --git a/src/database/any.rs b/src/database/any.rs
index 067ae7bbc9f71a9701ef07d5314dc7bb8923fe3c..0e842b3de3d6392f316c103696c8f84a31391e0a 100644 (file)
--- a/src/database/any.rs
+++ b/src/database/any.rs
@@ -36,12 +36,14 @@
 //! # use bdk::database::{AnyDatabase, MemoryDatabase};
 //! # use bdk::{Wallet, OfflineWallet};
 //! let memory = MemoryDatabase::default().into();
-//! let wallet_memory: OfflineWallet<AnyDatabase> = Wallet::new_offline("...", None, Network::Testnet, memory)?;
+//! let wallet_memory: OfflineWallet<AnyDatabase> =
+//!     Wallet::new_offline("...", None, Network::Testnet, memory)?;
 //!
 //! # #[cfg(feature = "key-value-db")]
 //! # {
 //! let sled = sled::open("my-database")?.open_tree("default_tree")?.into();
-//! let wallet_sled: OfflineWallet<AnyDatabase> = Wallet::new_offline("...", None, Network::Testnet, sled)?;
+//! let wallet_sled: OfflineWallet<AnyDatabase> =
+//!     Wallet::new_offline("...", None, Network::Testnet, sled)?;
 //! # }
 //! # Ok::<(), bdk::Error>(())
 //! ```

diff --git a/src/descriptor/dsl.rs b/src/descriptor/dsl.rs
index e75e1b58ce2cc4c4fef1c609792c8856a00775b7..b23517fd399dc9dd5399e762fee5f7e7b24ff2f0 100644 (file)
--- a/src/descriptor/dsl.rs
+++ b/src/descriptor/dsl.rs
@@ -254,8 +254,11 @@ macro_rules! impl_sortedmulti {
 ///
 /// ```
 /// # use std::str::FromStr;
-/// let my_key_1 = bitcoin::PublicKey::from_str("02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c")?;
-/// let my_key_2 = bitcoin::PrivateKey::from_wif("cVt4o7BGAig1UXywgGSmARhxMdzP5qvQsxKkSsc1XEkw3tDTQFpy")?;
+/// let my_key_1 = bitcoin::PublicKey::from_str(
+///     "02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c",
+/// )?;
+/// let my_key_2 =
+///     bitcoin::PrivateKey::from_wif("cVt4o7BGAig1UXywgGSmARhxMdzP5qvQsxKkSsc1XEkw3tDTQFpy")?;
 ///
 /// let (descriptor, key_map, networks) = bdk::descriptor! {
 ///     wsh (
@@ -270,9 +273,10 @@ macro_rules! impl_sortedmulti {
 /// Native-Segwit single-sig, equivalent to: `wpkh(...)`
 ///
 /// ```
-/// let my_key = bitcoin::PrivateKey::from_wif("cVt4o7BGAig1UXywgGSmARhxMdzP5qvQsxKkSsc1XEkw3tDTQFpy")?;
+/// let my_key =
+///     bitcoin::PrivateKey::from_wif("cVt4o7BGAig1UXywgGSmARhxMdzP5qvQsxKkSsc1XEkw3tDTQFpy")?;
 ///
-/// let (descriptor, key_map, networks) = bdk::descriptor!(wpkh ( my_key ) )?;
+/// let (descriptor, key_map, networks) = bdk::descriptor!(wpkh(my_key))?;
 /// # Ok::<(), Box<dyn std::error::Error>>(())
 /// ```
 #[macro_export]

diff --git a/src/descriptor/template.rs b/src/descriptor/template.rs
index 18a8bc3f73dc267a6bd6598adbe462d6f02f4370..6b832f301648c31ff9556069fdd35064ff36c498 100644 (file)
--- a/src/descriptor/template.rs
+++ b/src/descriptor/template.rs
@@ -47,15 +47,15 @@ pub type DescriptorTemplateOut = (ExtendedDescriptor, KeyMap, ValidNetworks);
 /// ## Example
 ///
 /// ```
-/// use bdk::keys::{ToDescriptorKey, KeyError};
-/// use bdk::template::{DescriptorTemplate, DescriptorTemplateOut};
+/// use bdk::keys::{KeyError, ToDescriptorKey};
 /// use bdk::miniscript::Legacy;
+/// use bdk::template::{DescriptorTemplate, DescriptorTemplateOut};
 ///
 /// struct MyP2PKH<K: ToDescriptorKey<Legacy>>(K);
 ///
 /// impl<K: ToDescriptorKey<Legacy>> DescriptorTemplate for MyP2PKH<K> {
 ///     fn build(self) -> Result<DescriptorTemplateOut, KeyError> {
-///         Ok(bdk::descriptor!(pkh ( self.0 ) )?)
+///         Ok(bdk::descriptor!(pkh(self.0))?)
 ///     }
 /// }
 /// ```
@@ -85,10 +85,19 @@ impl<T: DescriptorTemplate> ToWalletDescriptor for T {
 /// # use bdk::database::MemoryDatabase;
 /// use bdk::template::P2PKH;
 ///
-/// let key = bitcoin::PrivateKey::from_wif("cTc4vURSzdx6QE6KVynWGomDbLaA75dNALMNyfjh3p8DRRar84Um")?;
-/// let wallet: OfflineWallet<_> = Wallet::new_offline(P2PKH(key), None, Network::Testnet, MemoryDatabase::default())?;
+/// let key =
+///     bitcoin::PrivateKey::from_wif("cTc4vURSzdx6QE6KVynWGomDbLaA75dNALMNyfjh3p8DRRar84Um")?;
+/// let wallet: OfflineWallet<_> = Wallet::new_offline(
+///     P2PKH(key),
+///     None,
+///     Network::Testnet,
+///     MemoryDatabase::default(),
+/// )?;
 ///
-/// assert_eq!(wallet.get_new_address()?.to_string(), "mwJ8hxFYW19JLuc65RCTaP4v1rzVU8cVMT");
+/// assert_eq!(
+///     wallet.get_new_address()?.to_string(),
+///     "mwJ8hxFYW19JLuc65RCTaP4v1rzVU8cVMT"
+/// );
 /// # Ok::<_, Box<dyn std::error::Error>>(())
 /// ```
 pub struct P2PKH<K: ToDescriptorKey<Legacy>>(pub K);
@@ -109,10 +118,19 @@ impl<K: ToDescriptorKey<Legacy>> DescriptorTemplate for P2PKH<K> {
 /// # use bdk::database::MemoryDatabase;
 /// use bdk::template::P2WPKH_P2SH;
 ///
-/// let key = bitcoin::PrivateKey::from_wif("cTc4vURSzdx6QE6KVynWGomDbLaA75dNALMNyfjh3p8DRRar84Um")?;
-/// let wallet: OfflineWallet<_> = Wallet::new_offline(P2WPKH_P2SH(key), None, Network::Testnet, MemoryDatabase::default())?;
+/// let key =
+///     bitcoin::PrivateKey::from_wif("cTc4vURSzdx6QE6KVynWGomDbLaA75dNALMNyfjh3p8DRRar84Um")?;
+/// let wallet: OfflineWallet<_> = Wallet::new_offline(
+///     P2WPKH_P2SH(key),
+///     None,
+///     Network::Testnet,
+///     MemoryDatabase::default(),
+/// )?;
 ///
-/// assert_eq!(wallet.get_new_address()?.to_string(), "2NB4ox5VDRw1ecUv6SnT3VQHPXveYztRqk5");
+/// assert_eq!(
+///     wallet.get_new_address()?.to_string(),
+///     "2NB4ox5VDRw1ecUv6SnT3VQHPXveYztRqk5"
+/// );
 /// # Ok::<_, Box<dyn std::error::Error>>(())
 /// ```
 #[allow(non_camel_case_types)]
@@ -134,10 +152,19 @@ impl<K: ToDescriptorKey<Segwitv0>> DescriptorTemplate for P2WPKH_P2SH<K> {
 /// # use bdk::database::MemoryDatabase;
 /// use bdk::template::P2WPKH;
 ///
-/// let key = bitcoin::PrivateKey::from_wif("cTc4vURSzdx6QE6KVynWGomDbLaA75dNALMNyfjh3p8DRRar84Um")?;
-/// let wallet: OfflineWallet<_> = Wallet::new_offline(P2WPKH(key), None, Network::Testnet, MemoryDatabase::default())?;
+/// let key =
+///     bitcoin::PrivateKey::from_wif("cTc4vURSzdx6QE6KVynWGomDbLaA75dNALMNyfjh3p8DRRar84Um")?;
+/// let wallet: OfflineWallet<_> = Wallet::new_offline(
+///     P2WPKH(key),
+///     None,
+///     Network::Testnet,
+///     MemoryDatabase::default(),
+/// )?;
 ///
-/// assert_eq!(wallet.get_new_address()?.to_string(), "tb1q4525hmgw265tl3drrl8jjta7ayffu6jf68ltjd");
+/// assert_eq!(
+///     wallet.get_new_address()?.to_string(),
+///     "tb1q4525hmgw265tl3drrl8jjta7ayffu6jf68ltjd"
+/// );
 /// # Ok::<_, Box<dyn std::error::Error>>(())
 /// ```
 pub struct P2WPKH<K: ToDescriptorKey<Segwitv0>>(pub K);

diff --git a/src/keys/mod.rs b/src/keys/mod.rs
index 49d7c0af8f5253a07556bfbb5f9d8dcc3482f8d7..b1ae504d8b3ac39c69fd1b721da6087f01eda2c6 100644 (file)
--- a/src/keys/mod.rs
+++ b/src/keys/mod.rs
@@ -198,7 +198,7 @@ impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx {
 /// ```
 /// use bdk::bitcoin::PublicKey;
 ///
-/// use bdk::keys::{ScriptContext, ToDescriptorKey, DescriptorKey, KeyError};
+/// use bdk::keys::{DescriptorKey, KeyError, ScriptContext, ToDescriptorKey};
 ///
 /// pub struct MyKeyType {
 ///     pubkey: PublicKey,
@@ -216,7 +216,10 @@ impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx {
 /// ```
 /// use bdk::bitcoin::PublicKey;
 ///
-/// use bdk::keys::{mainnet_network, ScriptContext, ToDescriptorKey, DescriptorKey, DescriptorPublicKey, DescriptorSinglePub, KeyError};
+/// use bdk::keys::{
+///     mainnet_network, DescriptorKey, DescriptorPublicKey, DescriptorSinglePub, KeyError,
+///     ScriptContext, ToDescriptorKey,
+/// };
 ///
 /// pub struct MyKeyType {
 ///     pubkey: PublicKey,
@@ -224,10 +227,13 @@ impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx {
 ///
 /// impl<Ctx: ScriptContext> ToDescriptorKey<Ctx> for MyKeyType {
 ///     fn to_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError> {
-///         Ok(DescriptorKey::from_public(DescriptorPublicKey::SinglePub(DescriptorSinglePub {
-///             origin: None,
-///             key: self.pubkey
-///         }), mainnet_network()))
+///         Ok(DescriptorKey::from_public(
+///             DescriptorPublicKey::SinglePub(DescriptorSinglePub {
+///                 origin: None,
+///                 key: self.pubkey,
+///             }),
+///             mainnet_network(),
+///         ))
 ///     }
 /// }
 /// ```
@@ -237,7 +243,7 @@ impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx {
 /// ```
 /// use bdk::bitcoin::PublicKey;
 ///
-/// use bdk::keys::{ExtScriptContext, ScriptContext, ToDescriptorKey, DescriptorKey, KeyError};
+/// use bdk::keys::{DescriptorKey, ExtScriptContext, KeyError, ScriptContext, ToDescriptorKey};
 ///
 /// pub struct MyKeyType {
 ///     is_legacy: bool,
@@ -263,10 +269,10 @@ impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx {
 /// makes the compiler (correctly) fail.
 ///
 /// ```compile_fail
-/// use std::str::FromStr;
 /// use bdk::bitcoin::PublicKey;
+/// use std::str::FromStr;
 ///
-/// use bdk::keys::{ToDescriptorKey, DescriptorKey, KeyError};
+/// use bdk::keys::{DescriptorKey, KeyError, ToDescriptorKey};
 ///
 /// pub struct MySegwitOnlyKeyType {
 ///     pubkey: PublicKey,
@@ -281,7 +287,7 @@ impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx {
 /// let key = MySegwitOnlyKeyType {
 ///     pubkey: PublicKey::from_str("...")?,
 /// };
-/// let (descriptor, _, _) = bdk::descriptor!(pkh ( key ) )?;
+/// let (descriptor, _, _) = bdk::descriptor!(pkh(key))?;
 /// //                                       ^^^^^ changing this to `wpkh` would make it compile
 ///
 /// # Ok::<_, Box<dyn std::error::Error>>(())

diff --git a/src/wallet/export.rs b/src/wallet/export.rs
index fa0cd9e7ca9421c6ba3369887283d5969d1da0e2..9f17e9d5722bba0cbf178f2a87ba7d2d7c34c7db 100644 (file)
--- a/src/wallet/export.rs
+++ b/src/wallet/export.rs
@@ -43,7 +43,12 @@
 //! }"#;
 //!
 //! let import = WalletExport::from_str(import)?;
-//! let wallet: OfflineWallet<_> = Wallet::new_offline(&import.descriptor(), import.change_descriptor().as_ref(), Network::Testnet, MemoryDatabase::default())?;
+//! let wallet: OfflineWallet<_> = Wallet::new_offline(
+//!     &import.descriptor(),
+//!     import.change_descriptor().as_ref(),
+//!     Network::Testnet,
+//!     MemoryDatabase::default(),
+//! )?;
 //! # Ok::<_, bdk::Error>(())
 //! ```
 //!