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>, unknown: Vec<(u32, Vec<u8>)>, expiry_height: Option<BlockHeight>, expiry_time: Option<u64>, unknown_metadata: Vec<(u32, Vec<u8>)>, ) -> UnifiedIncomingViewingKey

Available on crate features test-dependencies only.

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, UnifiedDecodingError>

where P: Parameters,

Parses a UnifiedIncomingViewingKey from its ZIP 316 string encoding at any revision.

Errors

• UnifiedDecodingError::Parse if the string is not a valid UIVK.
• UnifiedDecodingError::NetworkMismatch if the key is for a network other than that of params.
• UnifiedDecodingError::InvalidItem if an item’s data is not a valid key of its type.

pub fn encode_revision<P>( &self, params: &P, revision: Revision, ) -> Result<String, UnifiedEncodingError>

where P: Parameters,

Returns the ZIP 316 string encoding of this UnifiedIncomingViewingKey for the given network at the given revision.

Returns UnifiedEncodingError::NotRepresentable if this key has no encoding at revision: Revision::R0 cannot encode expiry metadata, a P2SH viewing key item, or a key whose only data items are transparent.

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

where P: Parameters,

Returns the ZIP 316 string encoding of this UnifiedIncomingViewingKey for the given network at the most widely supported revision that can represent it: Revision::R0 if possible, and Revision::R2 otherwise. Use encode_revision to encode at a specific revision.

Returns UnifiedEncodingError::NotRepresentable if this key has no encoding at either revision.

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>

👎Deprecated:

Use UnifiedIncomingViewingKey::p2pkh instead.

Available on crate feature transparent-inputs only.

Returns the transparent external IVK, if present.

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

Available on crate feature transparent-inputs only.

Returns the transparent external IVK, if present.

Returns None if the key has no transparent component, or carries a P2SH viewing key item instead; the two are mutually exclusive.

pub fn p2sh(&self) -> Option<&P2shIncomingViewingKey>

Available on crate feature transparent-inputs only.

Returns the P2SH viewing key item of this key, if present.

Returns None if the key has no transparent component, or carries a P2PKH viewing key instead; the two are mutually exclusive.

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>

Available on crate feature sapling only.

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>

Available on crate feature orchard only.

Returns the Orchard IVK, if present.

pub fn expiry_height(&self) -> Option<BlockHeight>

Returns the expiry height metadata for this key, if present.

pub fn expiry_time(&self) -> Option<u64>

Returns the expiry time metadata for this key, if present.

pub fn subsumes(&self, other: &UnifiedIncomingViewingKey) -> bool

Returns true if this UIVK subsumes other: every IVK item present in other has a matching item in self. This key may have additional items representing capabilities not present in other.

For unknown items, exact equality of (typecode, data) is required. Future revisions may apply more specific semantics for known metadata typecodes.

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.

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.

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

pub fn decrypt_diversifiers( &self, ua: &UnifiedAddress, ) -> BTreeSet<DiversifierIndex>

Attempts to recover a diversifier index for each of the receivers of the given UnifiedAddress.

Returns the empty set if no shielded receiver of ua can be attributed to this key. Transparent receivers are not considered here, as recovering a diversifier index from a transparent receiver alone is not possible without additional context.

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, ReceiverRequirementError>

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

A key that has nothing but a transparent item describes a transparent-only account, and yields ReceiverRequirements::TRANSPARENT_ONLY; addresses generated from it are representable as ZIP 316 Revision 2 transparent-including (tu) unified addresses.

Returns an error if this key has no item for which a receiver can be derived, and also if the only receiver it can derive is transparent but the key has a data item that this build cannot interpret. A metadata item never prevents address generation.

pub fn default_transparent_address( &self, ) -> Option<(TransparentAddress, NonHardenedChildIndex)>

Available on crate feature transparent-inputs and (crate features test-dependencies) only.

Returns the default external transparent address using the transparent account pubkey.

See ExternalIvk::default_address for more information.

Trait Implementations

impl Clone for UnifiedIncomingViewingKey

fn clone(&self) -> UnifiedIncomingViewingKey

Returns a duplicate 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.

impl Eq for UnifiedIncomingViewingKey

impl PartialEq for UnifiedIncomingViewingKey

fn eq(&self, other: &UnifiedIncomingViewingKey) -> bool

Equality operator ==.

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

Inequality operator !=.