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>

Available on crate features test-dependencies only.

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_orchard_fvk( orchard: FullViewingKey, ) -> Result<UnifiedFullViewingKey, DerivationError>

Available on crate feature unstable-frost only.

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

Available on crate features sapling and unstable only.

pub fn from_p2sh( p2sh: P2shFullViewingKey, ) -> Result<UnifiedFullViewingKey, DerivationError>

Available on crate feature transparent-inputs only.

Constructs a unified full viewing key for a transparent-only account defined by a ZIP 316 Revision 2 P2SH viewing key item.

This is the one unified full viewing key that cannot be derived. Every other kind is reached through UnifiedSpendingKey::to_unified_full_viewing_key, because a seed determines it; a P2SH account is instead defined by a set of cosigners’ keys, so it has no spending key to derive from and must be assembled.

The resulting key has no shielded components, so it encodes with the tu HRP and derives transparent-only unified addresses.

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

where P: Parameters,

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

Errors

• UnifiedDecodingError::Parse if the string is not a valid UFVK.
• 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 parse(ufvk: &Ufvk) -> Result<UnifiedFullViewingKey, DecodingError>

Constructs a UnifiedFullViewingKey from a parsed ZIP 316 unified container.

Returns DecodingError::KeyDataInvalid 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 UnifiedFullViewingKey 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 UnifiedFullViewingKey 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 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>

👎Deprecated:

Use UnifiedFullViewingKey::p2pkh instead.

Available on crate feature transparent-inputs only.

Returns the P2PKH component of the unified key at the BIP44 path m/44'/<coin_type>'/<account>', if present.

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

Available on crate feature transparent-inputs only.

Returns the P2PKH component of the unified key at the BIP44 path m/44'/<coin_type>'/<account>', 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<&P2shFullViewingKey>

Available on crate feature transparent-inputs only.

Returns the P2SH viewing key item of this unified 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 sapling(&self) -> Option<&DiversifiableFullViewingKey>

Available on crate feature sapling only.

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

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

Available on crate feature orchard only.

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

pub fn has_sapling(&self) -> bool

Returns whether this key has a Sapling component.

pub fn has_orchard(&self) -> bool

Returns whether this key has an Orchard component.

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_uivk(&self, other: &UnifiedIncomingViewingKey) -> bool

Returns true if this UFVK subsumes the given UIVK: every IVK item present in other has a matching item derivable from self. The UFVK may have additional items representing capabilities not present in the UIVK.

pub fn subsumes_ufvk(&self, other: &UnifiedFullViewingKey) -> bool

Returns true if this UFVK subsumes other: every FVK item in other has a matching item in self, including both incoming and outgoing viewing capability.

For unknown items, exact equality of (typecode, data) is required.

pub fn is_equivalent_to(&self, other: &UnifiedFullViewingKey) -> bool

Returns true if this UFVK and other carry the same viewing capability: each subsumes the other. Metadata items are not compared.

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 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.

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.

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_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.

pub fn select_ovk( &self, scope: Scope, input_sources: &NonEmpty<PoolType>, ) -> Option<OutgoingViewingKey>

Selects an outgoing viewing key for a transaction’s outputs based upon the type(s) of inputs spent in the transaction.

This method selects the OVK of the highest-preference item in [ZIP 316] preference order from among the item types represented by the provided input types. It will return None in the case that this FVK does not contain any items corresponding to the provided input sources; this should ordinarily never occur because in order to spend an input, a spending key of the appropriate type must be available and that spending key should be represented among this UFVK’s items.

Trait Implementations

impl Clone for UnifiedFullViewingKey

fn clone(&self) -> UnifiedFullViewingKey

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