keys-bip39 only.Expand description
keys-bip39 only.Expand description
BIP-0039
Structs
A mnemonic code.
Enums
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/bip39/struct.Mnemonic.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/bip39/struct.Mnemonic.html index d4138d6425..c69d25ac64 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/bip39/struct.Mnemonic.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/bip39/struct.Mnemonic.html @@ -51,18 +51,18 @@ Use Trait ImplementationsConsume self and turn it into an ExtendedKey Read more
fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
+
Consume self and turn it into an ExtendedKey Read more
fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path Read more
impl<'de> Deserialize<'de> for Mnemonic
impl<'de> Deserialize<'de> for Mnemonic
pub fn deserialize<D>(
deserializer: D
) -> Result<Mnemonic, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<Mnemonic, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
fn generate_with_entropy(
(word_count, language): Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
fn generate_with_entropy(
(word_count, language): Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Generate a key given the options with a random entropy
+fn generate_with_entropy(
(word_count, language): Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
fn generate_with_entropy(
(word_count, language): Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
+This method returns an Ordering between self and other. Read more
Create an instance given a secret key and a set of valid networks
Override the computed set of valid networks
Trait Implementations
The âidentityâ conversion is used internally by some bdk::fragments
Turn the key into a DescriptorKey within the requested ScriptContext
The âidentityâ conversion is used internally by some bdk::fragments
Turn the key into a DescriptorKey within the requested ScriptContext
Auto Trait Implementations
impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx> where
Ctx: RefUnwindSafe,
impl<Ctx> Send for DescriptorKey<Ctx> where
Ctx: Send,
impl<Ctx> Sync for DescriptorKey<Ctx> where
Ctx: Sync,
impl<Ctx> Unpin for DescriptorKey<Ctx> where
Ctx: Unpin,
impl<Ctx> UnwindSafe for DescriptorKey<Ctx> where
Ctx: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorPublicKey.html index a96770cc13..00298181bf 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorPublicKey.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorPublicKey.html @@ -36,7 +36,7 @@ some function which has access to secret key data.pub fn from_str(
s: &str
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>
pub fn from_str(
s: &str
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>
Parses a string s to return a value of this type. Read more
impl Hash for DescriptorPublicKey
impl Hash for DescriptorPublicKey
Turn the key into a DescriptorKey within the requested ScriptContext
Turn the key into a DescriptorKey within the requested ScriptContext
impl MiniscriptKey for DescriptorPublicKey
impl MiniscriptKey for DescriptorPublicKey
type Hash = DescriptorPublicKey
type Hash = DescriptorPublicKey
The associated Hash type with the publicKey
pub fn is_uncompressed(&self) -> bool
pub fn is_uncompressed(&self) -> bool
Check if the publicKey is uncompressed. The default implementation returns false Read more
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorSecretKey.html index 770dfa8968..ccf4513ca2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorSecretKey.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.DescriptorSecretKey.html @@ -22,7 +22,7 @@ for more details.impl Display for DescriptorSecretKey
impl Display for DescriptorSecretKey
impl FromStr for DescriptorSecretKey
impl FromStr for DescriptorSecretKey
type Err = DescriptorKeyParseError
type Err = DescriptorKeyParseError
The associated error which can be returned from parsing.
pub fn from_str(
s: &str
) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>
pub fn from_str(
s: &str
) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>
Parses a string s to return a value of this type. Read more
Turn the key into a DescriptorKey within the requested ScriptContext
Turn the key into a DescriptorKey within the requested ScriptContext
Auto Trait Implementations
impl RefUnwindSafe for DescriptorSecretKey
impl Send for DescriptorSecretKey
impl Sync for DescriptorSecretKey
impl Unpin for DescriptorSecretKey
impl UnwindSafe for DescriptorSecretKey
Blanket Implementations
Mutably borrows from an owned value. Read more
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.KeyError.html index f1c0ab2e30..e3c84ddf6a 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.KeyError.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/enum.KeyError.html @@ -6,7 +6,7 @@
KeyError
pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -20,14 +20,14 @@
Message(String)
Custom error message
Bip32(Error)
BIP32 error
Miniscript(Error)
Miniscript error
-Trait Implementations
The lower-level source of this error, if any. Read more
+Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for KeyError
impl UnwindSafe for KeyError
Blanket Implementations
Gets the TypeId of self. Read more

Module keys
Expand description
Expand description
Key formats
Modules
keys-bip39BIP-0039
Structs
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.GeneratedKey.html index 4f4154ce44..05e4da6c82 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.GeneratedKey.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.GeneratedKey.html @@ -4,16 +4,18 @@GeneratedKey
Struct bdk::keys::GeneratedKey
source · [−]pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }Expand description
Output of a GeneratableKey key generation
Implementations
Trait Implementations
type Target = K
type Target = K
The resulting type after dereferencing.
+Trait Implementations
impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: DerivableKey<Ctx>,
impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: DerivableKey<Ctx>,
Consume self and turn it into an ExtendedKey Read more
fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
+
impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: DerivableKey<Ctx>,
impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: DerivableKey<Ctx>,
Consume self and turn it into an ExtendedKey Read more
fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path Read more
impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: IntoDescriptorKey<Ctx>,
impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: IntoDescriptorKey<Ctx>,
Turn the key into a DescriptorKey within the requested ScriptContext
impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: IntoDescriptorKey<Ctx>,
impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: IntoDescriptorKey<Ctx>,
Turn the key into a DescriptorKey within the requested ScriptContext
Auto Trait Implementations
impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx> where
Ctx: RefUnwindSafe,
K: RefUnwindSafe,
impl<K, Ctx> Send for GeneratedKey<K, Ctx> where
Ctx: Send,
K: Send,
impl<K, Ctx> Sync for GeneratedKey<K, Ctx> where
Ctx: Sync,
K: Sync,
impl<K, Ctx> Unpin for GeneratedKey<K, Ctx> where
Ctx: Unpin,
K: Unpin,
impl<K, Ctx> UnwindSafe for GeneratedKey<K, Ctx> where
Ctx: UnwindSafe,
K: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
@@ -25,6 +27,9 @@ key origin and derivation pathDereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
The type returned in the event of a conversion error.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.PrivateKeyGenerateOptions.html index e8c837329a..cf471dd144 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.PrivateKeyGenerateOptions.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/struct.PrivateKeyGenerateOptions.html @@ -6,16 +6,16 @@
PrivateKeyGenerateOptions
Struct bdk::keys::PrivateKeyGenerateOptions
source · [−]pub struct PrivateKeyGenerateOptions {
+ Struct bdk::keys::PrivateKeyGenerateOptions
source · [−]pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields
compressed: boolWhether the generated key should be âcompressedâ or not
-Trait Implementations
Returns a copy of the value. Read more
+Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for PrivateKeyGenerateOptions
impl Send for PrivateKeyGenerateOptions
impl Sync for PrivateKeyGenerateOptions
impl Unpin for PrivateKeyGenerateOptions
impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations
Auto Trait Implementations
impl RefUnwindSafe for PrivateKeyGenerateOptions
impl Send for PrivateKeyGenerateOptions
impl Sync for PrivateKeyGenerateOptions
impl Unpin for PrivateKeyGenerateOptions
impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html index 6dfa1d644f..726d114514 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/keys/trait.DerivableKey.html @@ -4,7 +4,7 @@DerivableKey
Trait bdk::keys::DerivableKey
source · [−]pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -105,6 +105,6 @@ like Mnemonic when the let xprv = xkey.into_xprv(Network::Bitcoin).unwrap(); Provided methods
fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
Implementations on Foreign Types
impl<Ctx: ScriptContext> DerivableKey<Ctx> for [u8; 64]
This is supported on crate feature keys-bip39 only.
impl<Ctx: ScriptContext> DerivableKey<Ctx> for [u8; 64]
keys-bip39 only.fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors
impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: DerivableKey<Ctx>,
Identity conversion
-impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic
keys-bip39 only.impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase
keys-bip39 only.Implementations on Foreign Types
impl<Ctx: ScriptContext> DerivableKey<Ctx> for [u8; 64]
This is supported on crate feature keys-bip39 only.
impl<Ctx: ScriptContext> DerivableKey<Ctx> for [u8; 64]
keys-bip39 only.fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
impl<Ctx: ScriptContext> DerivableKey<Ctx> for (GeneratedKey<Mnemonic, Ctx>, Option<String>)
This is supported on crate feature keys-bip39 only.
impl<Ctx: ScriptContext> DerivableKey<Ctx> for (GeneratedKey<Mnemonic, Ctx>, Option<String>)
keys-bip39 only.fn into_descriptor_key(
self,
source: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors
impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx> where
Ctx: ScriptContext,
K: DerivableKey<Ctx>,
Identity conversion
+impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic
keys-bip39 only.impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase
keys-bip39 only.