Struct ExpandedSpendingKey 

pub struct ExpandedSpendingKey { /* private fields */ }

A Sapling expanded spending key

The incoming viewing key derived from an ExpandedSpendingKey is never zero.

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

Implementations

impl ExpandedSpendingKey

pub fn from_spending_key(sk: &[u8]) -> Option<Self>

Expands a spending key into its components.

Returns None if the spending key expands to ask = 0, or to a key whose incoming viewing key is zero. The protocol requires such a spending key to be discarded. This has a negligible probability of occurring.

pub fn from_parts( ask: SpendAuthorizingKey, nsk: Fr, ovk: OutgoingViewingKey, ) -> Option<Self>

Constructs an expanded spending key from its components.

Returns None if the incoming viewing key derived from the components is zero.

pub fn ask(&self) -> &SpendAuthorizingKey

Returns the spend authorizing key.

pub fn nsk(&self) -> &Fr

Returns the proof authorizing key.

pub fn ovk(&self) -> &OutgoingViewingKey

Returns the outgoing viewing key.

pub fn proof_generation_key(&self) -> ProofGenerationKey

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

Decodes the expanded spending key from its serialized representation as part of the encoding of the extended spending key as defined in ZIP 32

Returns an error if the incoming viewing key derived from the key is zero.

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

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

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

Encodes the expanded spending key to its serialized representation as part of the encoding of the extended spending key 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.

Trait Implementations

impl Clone for ExpandedSpendingKey

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 ExpandedSpendingKey

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

Formats the value using the given formatter.

impl Drop for ExpandedSpendingKey

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 Zeroize for ExpandedSpendingKey

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 ExpandedSpendingKey

Available on crate feature zeroize only.