Enum SeedMaterial

pub enum SeedMaterial {
    Bip39Mnemonic(Bip39Mnemonic),
    Seed(Seed),
}

Source material used to generate cryptographic keys in a Zcash wallet.

SeedMaterial represents the fundamental secret data from which a wallet derives all its cryptographic keys. It can be either a BIP-39 mnemonic phrase (seed words) or a raw 32-byte seed that predates the BIP-39 standard.

Zcash Concept Relation

In Zcash wallet systems:

• BIP-39 Mnemonics: Human-readable seed phrases (typically 12 or 24 words) that encode entropy in a memorable format. These phrases are used to generate HD wallet hierarchical deterministic keys following BIP-32/BIP-44 derivation paths.

• Pre-BIP39 Seeds: Raw 32-byte seeds from older wallet implementations that predate the BIP-39 standard. These are typically stored as binary data and lack the mnemonic recovery mechanism.

Wallet implementations use this seed material as the root of their key derivation, generating both transparent and shielded keys from this source.

Data Preservation

During wallet migration, the seed material is the most critical component to preserve:

• Mnemonic Phrases: The complete, unmodified word sequence in the correct order
• Raw Seeds: The exact 32-byte value without any modification

Preserving this data ensures a wallet can be reconstructed with all its derivable keys and addresses intact, providing access to all funds.

Security Considerations

Seed material is extremely sensitive information that provides complete control over all wallet funds. It must be handled with appropriate security precautions:

• Never transmit unencrypted over networks
• Store encrypted at rest
• Ensure secure memory handling to prevent leaks

Examples

// Create from a BIP-39 mnemonic phrase
let language = MnemonicLanguage::English;
let mnemonic = SeedMaterial::Bip39Mnemonic(
    Bip39Mnemonic::new("abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about", Some(language))
);

// Create from a pre-BIP39 raw seed
let raw_seed = [0u8; 32];
let seed = Seed::new(raw_seed);
let binary_seed = SeedMaterial::Seed(seed);

Variants

Bip39Mnemonic(Bip39Mnemonic)

A BIP-39 mnemonic phrase (typically 12 or 24 words) used as a human-readable seed

Seed(Seed)

A raw 32-byte seed predating the BIP-39 standard

Trait Implementations

impl Clone for SeedMaterial

fn clone(&self) -> SeedMaterial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SeedMaterial

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

Formats the value using the given formatter.

impl Display for SeedMaterial

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

Formats the value using the given formatter.

impl From<SeedMaterial> for Envelope

fn from(value: SeedMaterial) -> Self

Converts to this type from the input type.

impl PartialEq for SeedMaterial

fn eq(&self, other: &SeedMaterial) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Envelope> for SeedMaterial

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for SeedMaterial