Struct bdk::keys::bip39::Seed

pub struct Seed { /* fields omitted */ }

This is supported on crate feature keys-bip39 only.

The secret value used to derive HD wallet addresses from a Mnemonic phrase.

Because it is not possible to create a Mnemonic instance that is invalid, it is therefore impossible to have a Seed instance that is invalid. This guarantees that only a valid, intact mnemonic phrase can be used to derive HD wallet addresses.

To get the raw byte value use Seed::as_bytes(). These can be used to derive HD wallet addresses using another crate (deriving HD wallet addresses is outside the scope of this crate and the BIP39 standard).

Seed implements Zeroize, so it’s bytes will be zeroed when it’s dropped.

Implementations

impl Seed

pub fn new(mnemonic: &Mnemonic, password: &str) -> Seed

Generates the seed from the Mnemonic and the password.

pub fn as_bytes(&self) -> &[u8]

Get the seed value as a byte slice

Trait Implementations

impl AsRef<[u8]> for Seed

pub fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for Seed

pub fn clone(&self) -> Seed

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Seed

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<Ctx: ScriptContext> DerivableKey<Ctx> for Seed

fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>

Consume self and turn it into an ExtendedKey

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

impl Drop for Seed

pub fn drop(&mut self)

Executes the destructor for this type.

impl LowerHex for Seed

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl UpperHex for Seed

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Zeroize for Seed

pub fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.