frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Various fixes to the docs

Browse Source
This commit is contained in:
Alekos Filini 2020-12-10 11:38:42 +01:00
parent a1db9f633b
commit 9bafdfe2d4
No known key found for this signature in database
GPG Key ID: 5E8AFC3034FDFA4F
5 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/blockchain/mod.rs
View File

@ -95,7 +95,7 @@ pub trait BlockchainMarker {}
/// The [`BlockchainMarker`] marker trait is automatically implemented for [`Blockchain`] types /// The [`BlockchainMarker`] marker trait is automatically implemented for [`Blockchain`] types
impl<T: Blockchain> BlockchainMarker for T {} impl<T: Blockchain> BlockchainMarker for T {}
/// Type that only implements [`Blockchain`] and is always "offline" /// Type that only implements [`BlockchainMarker`] and is always "offline"
pub struct OfflineBlockchain; pub struct OfflineBlockchain;
impl BlockchainMarker for OfflineBlockchain {} impl BlockchainMarker for OfflineBlockchain {}

3
src/descriptor/dsl.rs
View File

@ -201,7 +201,8 @@ macro_rules! impl_sortedmulti {
/// Macro to write full descriptors with code /// Macro to write full descriptors with code
/// ///
/// This macro expands to an object of type `Result<(Descriptor<DescriptorPublicKey>, KeyMap, ValidNetworks), Error>`. /// This macro expands to a `Result` of
/// [`DescriptorTemplateOut`](super::template::DescriptorTemplateOut) and [`Error`](crate::Error)
/// ///
/// ## Example /// ## Example
/// ///

5
src/descriptor/mod.rs
View File

@ -52,7 +52,8 @@ pub mod template;
pub use self::checksum::get_checksum; pub use self::checksum::get_checksum;
use self::error::Error; use self::error::Error;
pub use self::policy::Policy; pub use self::policy::Policy;
use crate::keys::{KeyError, ToDescriptorKey, ValidNetworks}; use self::template::DescriptorTemplateOut;
use crate::keys::{KeyError, ToDescriptorKey};
use crate::wallet::signer::SignersContainer; use crate::wallet::signer::SignersContainer;
use crate::wallet::utils::{descriptor_to_pk_ctx, SecpCtx}; use crate::wallet::utils::{descriptor_to_pk_ctx, SecpCtx};
@ -151,7 +152,7 @@ impl ToWalletDescriptor for (ExtendedDescriptor, KeyMap) {
} }
} }
impl ToWalletDescriptor for (ExtendedDescriptor, KeyMap, ValidNetworks) { impl ToWalletDescriptor for DescriptorTemplateOut {
fn to_wallet_descriptor( fn to_wallet_descriptor(
self, self,
network: Network, network: Network,

5
src/keys/bip39.rs
View File

@ -36,8 +36,10 @@ use bip39::{Language, Mnemonic, MnemonicType, Seed};
use super::{any_network, DerivableKey, DescriptorKey, GeneratableKey, GeneratedKey, KeyError}; use super::{any_network, DerivableKey, DescriptorKey, GeneratableKey, GeneratedKey, KeyError};
/// Type for a BIP39 mnemonic with an optional passphrase
pub type MnemonicWithPassphrase = (Mnemonic, Option<String>); pub type MnemonicWithPassphrase = (Mnemonic, Option<String>);
#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
impl<Ctx: ScriptContext> DerivableKey<Ctx> for Seed { impl<Ctx: ScriptContext> DerivableKey<Ctx> for Seed {
fn add_metadata( fn add_metadata(
self, self,
@ -54,6 +56,7 @@ impl<Ctx: ScriptContext> DerivableKey<Ctx> for Seed {
} }
} }
#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase { impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase {
fn add_metadata( fn add_metadata(
self, self,
@ -66,6 +69,7 @@ impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase {
} }
} }
#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic { impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic {
fn add_metadata( fn add_metadata(
self, self,
@ -76,6 +80,7 @@ impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic {
} }
} }
#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Mnemonic { impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Mnemonic {
type Entropy = [u8; 32]; type Entropy = [u8; 32];

5
src/wallet/coin_selection.rs
View File

@ -257,8 +257,9 @@ impl OutputGroup {
} }
} }
/// Branch and bound coin selection. Code adapted from Bitcoin Core's implementation and from Mark /// Branch and bound coin selection
/// Erhardt Master's Thesis (http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf) ///
/// Code adapted from Bitcoin Core's implementation and from Mark Erhardt Master's Thesis: <http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf>
#[derive(Debug)] #[derive(Debug)]
pub struct BranchAndBoundCoinSelection { pub struct BranchAndBoundCoinSelection {
size_of_change: u64, size_of_change: u64,