Struct SaplingIncomingViewingKey

pub struct SaplingIncomingViewingKey(/* private fields */);

A Sapling Incoming Viewing Key (IVK), which allows detection and decryption of incoming transactions to a Sapling shielded address.

SaplingIncomingViewingKey is a 32-byte key that enables a wallet to detect when funds have been sent to its associated Sapling address and to decrypt the incoming transaction details, without granting the ability to spend those funds.

Zcash Concept Relation

In Zcash’s Sapling protocol, the privacy features rely on a system of keys with different capabilities:

• Full Viewing Keys can detect both incoming and outgoing transactions
• Incoming Viewing Keys (derived from full viewing keys) can only detect incoming transactions
• Spending Keys provide full control, including spending capability

IVKs enable “watch-only” wallet functionality, where users can monitor their funds without risking theft if the wallet is compromised.

Data Preservation

During wallet migration, incoming viewing keys are preserved exactly as they exist in the source wallet, maintaining the ability to detect and view incoming transactions in the migrated wallet.

Examples

use zewif::sapling::SaplingIncomingViewingKey;
use zewif::Blob;

// Wrap the raw bytes of an encoded Sapling incoming viewing key.
let raw_bytes = [0u8; 32]; // In practice, this would be actual key material
let ivk = SaplingIncomingViewingKey::new(raw_bytes);

// The key can be converted to CBOR for storage or transmission
let hex: dcbor::CBOR = ivk.into();

Implementations

impl SaplingIncomingViewingKey

pub fn new(data: [u8; 32]) -> Self

Creates a new instance from a fixed-size byte array.

This is the primary constructor when you have an exact-sized array available.

pub fn len(&self) -> usize

Returns the length of this blob in bytes.

This will always return $size for this type.

pub fn is_empty(&self) -> bool

Returns true if this blob contains no bytes.

This will always return false for this type (unless $size is 0).

pub fn to_vec(&self) -> Vec<u8>

Converts this blob to a Vec<u8>, creating a copy of the data.

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

Exposes the underlying byte array as a slice.

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

Exposes the underlying byte array.

pub fn from_slice(data: &[u8]) -> Result<Self, TryFromSliceError>

Creates an instance from a slice of bytes.

Errors

Returns an error if the slice’s length doesn’t match the expected size ($size).

pub fn from_vec(data: Vec<u8>) -> Result<Self, TryFromSliceError>

Creates an instance from a Vec<u8>.

Errors

Returns an error if the vector’s length doesn’t match the expected size ($size).

pub fn from_hex(hex: &str) -> Result<Self, HexParseError>

Parses an instance from a hex string.

pub fn from_reversed_hex(hex: &str) -> Result<Self, HexParseError>

Parses an instance from a hex string in reversed byte order, such as is used for transaction identifiers and block hashes.

pub fn to_hex(&self) -> String

Formats the bytes of this object as a hex string.

Trait Implementations

impl AsRef<[u8]> for SaplingIncomingViewingKey

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SaplingIncomingViewingKey

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaplingIncomingViewingKey

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

Formats the value using the given formatter.

impl Display for SaplingIncomingViewingKey

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

Formats the value using the given formatter.

impl From<&[u8]> for SaplingIncomingViewingKey

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&SaplingIncomingViewingKey> for CBOR

fn from(data: &SaplingIncomingViewingKey) -> Self

Converts to this type from the input type.

impl From<&SaplingIncomingViewingKey> for Vec<u8>

fn from(blob: &SaplingIncomingViewingKey) -> Vec<u8>

Converts to this type from the input type.

impl From<SaplingIncomingViewingKey> for CBOR

fn from(data: SaplingIncomingViewingKey) -> Self

Converts to this type from the input type.

impl From<SaplingIncomingViewingKey> for Envelope

fn from(value: SaplingIncomingViewingKey) -> Self

Converts to this type from the input type.

impl From<SaplingIncomingViewingKey> for Vec<u8>

fn from(blob: SaplingIncomingViewingKey) -> Vec<u8>

Converts to this type from the input type.

impl From<Vec<u8>> for SaplingIncomingViewingKey

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for SaplingIncomingViewingKey

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SaplingIncomingViewingKey

fn eq(&self, other: &Self) -> 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<CBOR> for SaplingIncomingViewingKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Envelope> for SaplingIncomingViewingKey

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 Copy for SaplingIncomingViewingKey

impl Eq for SaplingIncomingViewingKey