Struct IncomingViewingKey 

pub struct IncomingViewingKey { /* private fields */ }

A key that provides the capability to detect and decrypt incoming notes from the block chain, without being able to spend the notes or detect when they are spent.

This key is useful in situations where you only need the capability to detect inbound payments, such as merchant terminals.

This key is not suitable for use on its own in a wallet, as it cannot maintain accurate balance. You should use a FullViewingKey instead.

Defined in Zcash Protocol Spec § 5.6.4.3: Orchard Raw Incoming Viewing Keys.

Implementations

impl IncomingViewingKey

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

Serializes an Orchard incoming viewing key to its raw encoding as specified in Zcash Protocol Spec § 5.6.4.3: Orchard Raw Incoming Viewing Keys

pub fn from_bytes(bytes: &[u8; 64]) -> CtOption<IncomingViewingKey>

Parses an Orchard incoming viewing key from its raw encoding.

pub fn diversifier_index(&self, addr: &Address) -> Option<DiversifierIndex>

Checks whether the given address was derived from this incoming viewing key, and returns the diversifier index used to derive the address if so. Returns None if the address was not derived from this key.

pub fn address_at(&self, j: impl Into<DiversifierIndex>) -> Address

Returns the payment address for this key at the given index.

pub fn address(&self, d: Diversifier) -> Address

Returns the payment address for this key corresponding to the given diversifier.

Trait Implementations

impl Clone for IncomingViewingKey

fn clone(&self) -> IncomingViewingKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingViewingKey

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

Formats the value using the given formatter.

impl Ord for IncomingViewingKey

fn cmp(&self, other: &IncomingViewingKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IncomingViewingKey

fn eq(&self, other: &IncomingViewingKey) -> 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 PartialOrd for IncomingViewingKey

fn partial_cmp(&self, other: &IncomingViewingKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for IncomingViewingKey

impl StructuralPartialEq for IncomingViewingKey