Struct ExtendedSpendingKey 

pub struct ExtendedSpendingKey { /* private fields */ }

A Sapling extended spending key

The incoming viewing keys of both the external and the internal full viewing key derived from an ExtendedSpendingKey are never zero.

If the zeroize feature is enabled, the key material is zeroized on drop.

Implementations

impl ExtendedSpendingKey

pub fn master(seed: &[u8]) -> Option<Self>

Derives the master extended spending key from a seed.

Returns None if the master key is invalid: if it has ask = 0, or if the incoming viewing key of its external or internal full viewing key is zero. This has a negligible probability of occurring.

pub fn from_bytes(b: &[u8]) -> Result<Self, DecodingError>

Decodes the extended spending key from its serialized representation as defined in ZIP 32

Returns an error if the incoming viewing key of the external or internal full viewing key is zero.

pub fn read<R: Read>(reader: R) -> Result<Self>

Reads and decodes the encoded form of the extended spending key as defined in ZIP 32 from the provided reader.

pub fn to_bytes(&self) -> [u8; 169]

Encodes the extended spending key to its serialized representation as defined in ZIP 32

The returned array is secret key material; the caller is responsible for zeroizing it once it is no longer needed.

pub fn write<W: Write>(&self, writer: W) -> Result<()>

Writes the encoded form of the extended spending key as defined in ZIP 32 to the provided writer.

pub fn from_path( master: &ExtendedSpendingKey, path: &[ChildIndex], ) -> Option<Self>

Returns the child key corresponding to the path derived from the master key

Returns None if any key along the path is invalid. See Self::derive_child.

pub fn derive_child(&self, i: ChildIndex) -> Option<Self>

Derives the child key at the given (hardened) index.

Returns None if the child key is invalid: if it has ask = 0, or if the incoming viewing key of its external or internal full viewing key is zero. This has a negligible probability of occurring. ZIP 32 directs the caller to proceed with the next index in that case.

pub fn default_address(&self) -> (DiversifierIndex, PaymentAddress)

Returns the address with the lowest valid diversifier index, along with the diversifier index that generated that address.

pub fn derive_internal(&self) -> Option<Self>

Derives an internal spending key given an external spending key.

Returns None if the internal spending key does not satisfy the invariant of ExtendedSpendingKey: that is, if the incoming viewing key of the internal full viewing key derived from the internal spending key is zero. This has a negligible probability of occurring.

Specified in ZIP 32.

pub fn expsk(&self) -> &ExpandedSpendingKey

Returns the expanded spending key component of this extended spending key.

pub fn to_extended_full_viewing_key(&self) -> ExtendedFullViewingKey

👎Deprecated:

Use to_diversifiable_full_viewing_key instead.

pub fn to_diversifiable_full_viewing_key(&self) -> DiversifiableFullViewingKey

Trait Implementations

impl Clone for ExtendedSpendingKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtendedSpendingKey

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

Formats the value using the given formatter.

impl Drop for ExtendedSpendingKey

Available on crate feature zeroize only.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl PartialEq for ExtendedSpendingKey

fn eq(&self, rhs: &ExtendedSpendingKey) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Zeroize for ExtendedSpendingKey

Available on crate feature zeroize only.

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.

impl ZeroizeOnDrop for ExtendedSpendingKey

Available on crate feature zeroize only.