Struct UnifiedIncomingViewingKey

pub struct UnifiedIncomingViewingKey { /* private fields */ }

A ZIP 316 unified incoming viewing key.

Implementations

impl UnifiedIncomingViewingKey

pub fn new( transparent: Option<ExternalIvk>, sapling: Option<IncomingViewingKey>, orchard: Option<IncomingViewingKey>, ) -> UnifiedIncomingViewingKey

Construct a new unified incoming viewing key.

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

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

where P: Parameters,

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 has_transparent(&self) -> bool

Returns whether this uivk has a transparent key item.

This method is available irrespective of whether the transparent-inputs feature flag is enabled.

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

Returns the Transparent external IVK, if present.

pub fn has_sapling(&self) -> bool

Returns whether this uivk has a Sapling key item.

This method is available irrespective of whether the sapling feature flag is enabled.

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

Returns the Sapling IVK, if present.

pub fn has_orchard(&self) -> bool

Returns whether this uivk has an Orchard key item.

This method is available irrespective of whether the orchard feature flag is enabled.

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

Returns the Orchard IVK, if present.

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 will be derived to contain a receiver for each item in this UFVK.

Returns an error if the this key does not produce a valid receiver for a required receiver type at the given diversifier index.

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 address that conforms to the provided request, and returns that Unified Address along with the index at which the valid diversifier was found.

If None is specified for the request parameter, a default request that Requires a receiver be present for each key item enabled by the feature flags in use will be used to search the diversifier space.

Returns an Err(AddressGenerationError) if no valid diversifier exists or if the features required to satisfy the unified address request are not 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 will be derived to contain a receiver for each data item in this UFVK.

Returns an error if the this key does not produce a valid receiver for a required receiver type at any diversifier index.

pub fn receiver_requirements( &self, request: UnifiedAddressRequest, ) -> Result<ReceiverRequirements, AddressGenerationError>

Convenience method for choosing a set of receiver requirements based upon the given unified address request and the available items of this key.

Returns an error if the provided request cannot be satisfied in address generation using this key.

pub fn to_receiver_requirements(&self) -> Result<ReceiverRequirements, ()>

Constructs the ReceiverRequirements that requires a receiver for each data item of this UIVK.

Returns Err if the resulting request would not include a shielded receiver.

Trait Implementations

impl Clone for UnifiedIncomingViewingKey

fn clone(&self) -> UnifiedIncomingViewingKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiedIncomingViewingKey

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

Formats the value using the given formatter.