Struct DiversifiableFullViewingKey

pub struct DiversifiableFullViewingKey { /* private fields */ }

A Sapling key that provides the capability to view incoming and outgoing transactions.

This key is useful anywhere you need to maintain accurate balance, but do not want the ability to spend funds (such as a view-only wallet).

It comprises the subset of the ZIP 32 extended full viewing key that is used for the Sapling item in a ZIP 316 Unified Full Viewing Key.

Implementations

impl DiversifiableFullViewingKey

pub fn from_bytes(bytes: &[u8; 128]) -> Option<DiversifiableFullViewingKey>

Parses a DiversifiableFullViewingKey from its raw byte encoding.

Returns None if the bytes do not contain a valid encoding of a diversifiable Sapling full viewing key.

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

Returns the raw encoding of this DiversifiableFullViewingKey.

pub fn fvk(&self) -> &FullViewingKey

Exposes the external [FullViewingKey] component of this diversifiable full viewing key.

pub fn to_internal_fvk(&self) -> FullViewingKey

Returns the internal [FullViewingKey] component of this diversifiable full viewing key.

pub fn to_nk(&self, scope: Scope) -> NullifierDerivingKey

Derives a nullifier-deriving key for the provided scope.

This API is provided so that nullifiers for change notes can be correctly computed.

pub fn to_ivk(&self, scope: Scope) -> SaplingIvk

Derives an incoming viewing key corresponding to this full viewing key.

pub fn to_external_ivk(&self) -> IncomingViewingKey

Derives the external diversifiable incoming viewing key corresponding to this full viewing key.

pub fn to_ovk(&self, scope: Scope) -> OutgoingViewingKey

Derives an outgoing viewing key corresponding to this full viewing key.

pub fn address(&self, j: DiversifierIndex) -> Option<PaymentAddress>

Attempts to produce a valid payment address for the given diversifier index.

Returns None if the diversifier index does not produce a valid diversifier for this DiversifiableFullViewingKey.

pub fn find_address( &self, j: DiversifierIndex, ) -> Option<(DiversifierIndex, PaymentAddress)>

Finds the next valid payment address starting from the given diversifier index.

This searches the diversifier space starting at j and incrementing, to find an index which will produce a valid diversifier (a 50% probability for each index).

Returns the index at which the valid diversifier was found along with the payment address constructed using that diversifier, or None if the maximum index was reached and no valid diversifier was found.

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

Returns the payment address corresponding to the smallest valid diversifier index, along with that index.

pub fn diversified_address( &self, diversifier: Diversifier, ) -> Option<PaymentAddress>

Returns the payment address corresponding to the specified diversifier, if any.

In general, it is preferable to use find_address instead, but this method is useful in some cases for matching keys to existing payment addresses.

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

Returns the internal address corresponding to the smallest valid diversifier index, along with that index.

This address MUST NOT be encoded and exposed to end users. User interfaces should instead mark these notes as “change notes” or “internal wallet operations”.

pub fn diversified_change_address( &self, diversifier: Diversifier, ) -> Option<PaymentAddress>

Returns the change address corresponding to the specified diversifier, if any.

In general, it is preferable to use change_address instead, but this method is useful in some cases for matching keys to existing payment addresses.

pub fn decrypt_diversifier( &self, addr: &PaymentAddress, ) -> Option<(DiversifierIndex, Scope)>

Attempts to decrypt the given address’s diversifier with this full viewing key.

This method extracts the diversifier from the given address and decrypts it as a diversifier index, then verifies that this diversifier index produces the same address. Decryption is attempted using both the internal and external parts of the full viewing key.

Returns the decrypted diversifier index and its scope, or None if the address was not generated from this key.

Trait Implementations

impl Clone for DiversifiableFullViewingKey

fn clone(&self) -> DiversifiableFullViewingKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiversifiableFullViewingKey

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

Formats the value using the given formatter.

impl From<&ExtendedFullViewingKey> for DiversifiableFullViewingKey

fn from(extfvk: &ExtendedFullViewingKey) -> DiversifiableFullViewingKey

Converts to this type from the input type.

impl From<ExtendedFullViewingKey> for DiversifiableFullViewingKey

fn from(extfvk: ExtendedFullViewingKey) -> DiversifiableFullViewingKey

Converts to this type from the input type.

impl TestFvk for DiversifiableFullViewingKey

Available on crate feature test-dependencies only.

type Nullifier = Nullifier

The type of nullifier corresponding to the kind of note that this full viewing key can detect (and that its corresponding spending key can spend).

fn sapling_ovk(&self) -> Option<OutgoingViewingKey>

Returns the Sapling outgoing viewing key corresponding to this full viewing key, if any.

fn orchard_ovk(&self, _: Scope) -> Option<OutgoingViewingKey>

Available on crate feature orchard only.

Returns the Orchard outgoing viewing key corresponding to this full viewing key, if any.

fn add_spend<R: RngCore + CryptoRng>( &self, ctx: &mut CompactTx, nf: Self::Nullifier, _: &mut R, )

Adds a single spend to the given CompactTx of a note previously received by this full viewing key.

fn add_output<P: Parameters, R: RngCore + CryptoRng>( &self, ctx: &mut CompactTx, params: &P, height: BlockHeight, req: AddressType, value: Zatoshis, initial_sapling_tree_size: u32, rng: &mut R, ) -> Self::Nullifier

Adds a single output to the given CompactTx that will be received by this full viewing key.

fn add_logical_action<P: Parameters, R: RngCore + CryptoRng>( &self, ctx: &mut CompactTx, params: &P, height: BlockHeight, nf: Self::Nullifier, req: AddressType, value: Zatoshis, initial_sapling_tree_size: u32, rng: &mut R, ) -> Self::Nullifier

Adds both a spend and an output to the given CompactTx.