From 2325a1fcc297d9420cc3b2bc72b8c5e6b9933971 Mon Sep 17 00:00:00 2001 From: Steve Myers Date: Wed, 16 Dec 2020 14:19:37 -0800 Subject: [PATCH] [docs] Format code in docs with '--config format_code_in_doc_comments=true' --- src/blockchain/any.rs | 8 ++++- src/blockchain/compact_filters/mod.rs | 12 ++++--- src/blockchain/utils.rs | 2 +- src/database/any.rs | 6 ++-- src/descriptor/dsl.rs | 12 ++++--- src/descriptor/template.rs | 51 ++++++++++++++++++++------- src/keys/mod.rs | 26 ++++++++------ src/wallet/export.rs | 7 +++- 8 files changed, 88 insertions(+), 36 deletions(-) diff --git a/src/blockchain/any.rs b/src/blockchain/any.rs index 04d6df04..64081960 100644 --- 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 c925d938..fc9b4cf5 100644 --- 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::>()?; //! 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 977a561d..2e32ed1b 100644 --- a/src/blockchain/utils.rs +++ b/src/blockchain/utils.rs @@ -370,7 +370,7 @@ fn save_transaction_details_and_utxos( 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 067ae7bb..0e842b3d 100644 --- 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 = Wallet::new_offline("...", None, Network::Testnet, memory)?; +//! let wallet_memory: OfflineWallet = +//! 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 = Wallet::new_offline("...", None, Network::Testnet, sled)?; +//! let wallet_sled: OfflineWallet = +//! Wallet::new_offline("...", None, Network::Testnet, sled)?; //! # } //! # Ok::<(), bdk::Error>(()) //! ``` diff --git a/src/descriptor/dsl.rs b/src/descriptor/dsl.rs index e75e1b58..b23517fd 100644 --- 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>(()) /// ``` #[macro_export] diff --git a/src/descriptor/template.rs b/src/descriptor/template.rs index 18a8bc3f..6b832f30 100644 --- 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); /// /// impl> DescriptorTemplate for MyP2PKH { /// fn build(self) -> Result { -/// Ok(bdk::descriptor!(pkh ( self.0 ) )?) +/// Ok(bdk::descriptor!(pkh(self.0))?) /// } /// } /// ``` @@ -85,10 +85,19 @@ impl 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>(()) /// ``` pub struct P2PKH>(pub K); @@ -109,10 +118,19 @@ impl> DescriptorTemplate for P2PKH { /// # 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>(()) /// ``` #[allow(non_camel_case_types)] @@ -134,10 +152,19 @@ impl> DescriptorTemplate for P2WPKH_P2SH { /// # 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>(()) /// ``` pub struct P2WPKH>(pub K); diff --git a/src/keys/mod.rs b/src/keys/mod.rs index 49d7c0af..b1ae504d 100644 --- a/src/keys/mod.rs +++ b/src/keys/mod.rs @@ -198,7 +198,7 @@ impl 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 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 ExtScriptContext for Ctx { /// /// impl ToDescriptorKey for MyKeyType { /// fn to_descriptor_key(self) -> Result, 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 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 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 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>(()) diff --git a/src/wallet/export.rs b/src/wallet/export.rs index fa0cd9e7..9f17e9d5 100644 --- 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>(()) //! ``` //!