Struct UnifiedFullViewingKey

pub struct UnifiedFullViewingKey { /* private fields */ }

A ZIP 316 unified full viewing key.

Implementations

impl UnifiedFullViewingKey

pub fn new( transparent: Option<AccountPubKey>, sapling: Option<DiversifiableFullViewingKey>, orchard: Option<FullViewingKey>, ) -> Result<UnifiedFullViewingKey, DerivationError>

Construct a new unified full viewing key.

This method is only available when the test-dependencies feature is enabled, as derivation from the USK or deserialization from the serialized form should be used instead.

pub fn from_sapling_extended_full_viewing_key( sapling: ExtendedFullViewingKey, ) -> Result<UnifiedFullViewingKey, DerivationError>

pub fn decode<P>( params: &P, encoding: &str, ) -> Result<UnifiedFullViewingKey, String>

where P: Parameters,

Parses a UnifiedFullViewingKey from its ZIP 316 string encoding.

pub fn parse(ufvk: &Ufvk) -> Result<UnifiedFullViewingKey, DecodingError>

Parses a UnifiedFullViewingKey from its ZIP 316 string encoding.

pub fn encode<P>(&self, params: &P) -> String

where P: Parameters,

Returns the string encoding of this UnifiedFullViewingKey for the given network.

pub fn to_unified_incoming_viewing_key(&self) -> UnifiedIncomingViewingKey

Derives a Unified Incoming Viewing Key from this Unified Full Viewing Key.

pub fn transparent(&self) -> Option<&AccountPubKey>

Returns the transparent component of the unified key at the BIP44 path m/44'/<coin_type>'/<account>'.

pub fn sapling(&self) -> Option<&DiversifiableFullViewingKey>

Returns the Sapling diversifiable full viewing key component of this unified key.

pub fn orchard(&self) -> Option<&FullViewingKey>

Returns the Orchard full viewing key component of this unified key.

pub fn address( &self, j: DiversifierIndex, request: UnifiedAddressRequest, ) -> Result<UnifiedAddress, AddressGenerationError>

Attempts to derive the Unified Address for the given diversifier index and receiver types. If request is None, the address should be derived to contain a receiver for each item in this UFVK.

Returns None if the specified index does not produce a valid diversifier.

pub fn find_address( &self, j: DiversifierIndex, request: UnifiedAddressRequest, ) -> Result<(UnifiedAddress, DiversifierIndex), AddressGenerationError>

Searches the diversifier space starting at diversifier index j for one which will produce a valid diversifier, and return the Unified Address constructed using that diversifier along with the index at which the valid diversifier was found. If request is None, the address should be derived to contain a receiver for each item in this UFVK.

Returns an Err(AddressGenerationError) if no valid diversifier exists or if the features required to satisfy the unified address request are not properly enabled.

pub fn default_address( &self, request: UnifiedAddressRequest, ) -> Result<(UnifiedAddress, DiversifierIndex), AddressGenerationError>

Find the Unified Address corresponding to the smallest valid diversifier index, along with that index. If request is None, the address should be derived to contain a receiver for each item in this UFVK.

Returns an Err(AddressGenerationError) if no valid diversifier exists or if the features required to satisfy the unified address request are not properly enabled.

Trait Implementations

impl Clone for UnifiedFullViewingKey

fn clone(&self) -> UnifiedFullViewingKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiedFullViewingKey

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

Formats the value using the given formatter.