UnifiedFullViewingKey class

Represents a unified full viewing key (UFVK) for transparent, Sapling, and Orchard components.

Constructors

UnifiedFullViewingKey({Bip32Slip10Secp256k1? transparent, SaplingDiversifiableFullViewingKey? sapling, OrchardFullViewingKey? orchard, ReceiverUnknown? unknown, required ZcashNetwork network})
factory
UnifiedFullViewingKey.fromSaplingExtendedFullViewKey({required String uskBytes, required ZcashNetwork network})
factory
UnifiedFullViewingKey.fromUnifiedFullViewKey({required String ufvk, required ZcashNetwork network, required ZCryptoContext context})
factory

Properties

config → ZIP32CoinConfig
ZIP32 coin configuration used for key derivation.
final
hashCode → int
The hash code for this object.
no setterinherited
orchard → OrchardFullViewingKey?
Orchard full viewing key component.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sapling → SaplingDiversifiableFullViewingKey?
Sapling diversifiable full viewing key component.
final
transparent → Bip32Slip10Secp256k1?
Transparent component of the UFVK (BIP32/SLIP-10 secp256k1).
final
unknown → ReceiverUnknown?
Placeholder for unknown or unsupported components.
final

Methods

address({required DiversifierIndex index, required ZCryptoContext context, UnifiedAddressRequest request = const UnifiedAddressRequest.defaultRequest(), Bip44Changes scope = Bip44Changes.chainExt}) → UnifiedDerivedAddress
Returns the unified address derived from this UFVK at the given index, context, scope, and request configuration.
defaultAddress({required ZCryptoContext context, Bip44Changes scope = Bip44Changes.chainExt, UnifiedAddressRequest request = const UnifiedAddressRequest.defaultRequest()}) → UnifiedDerivedAddress
Returns the default unified address for this UFVK using the specified context, scope, and request.
defaultTransparentAddress(ZCryptoContext context, {Bip44Changes scope = Bip44Changes.chainExt, PubKeyModes pubKeyMode = PubKeyModes.compressed, List<int>? transparentScriptHash, TransparentAddressRequestType transparentAddressType = TransparentAddressRequestType.p2pkh}) → TransparentDerivedAddress
Returns the default transparent-derived address for this UFVK using the specified context, scope, and address parameters.
encode() → String
Encodes this unified full viewing key (UFVK) into a Zcash-compatible unified string.
findAddress({required DiversifierIndex from, required ZCryptoContext context, UnifiedAddressRequest request = const UnifiedAddressRequest.defaultRequest(), Bip44Changes scope = Bip44Changes.chainExt}) → UnifiedDerivedAddress
Finds the first unified address from the given index using this UFVK, context, scope, and request configuration.
getOrchard() → OrchardFullViewingKey
Returns the Orchard component of this UFVK, or throws if missing.
getSapling() → SaplingDiversifiableFullViewingKey
Returns the Sapling component of this UFVK, or throws if missing.
getTransparent() → Bip32Slip10Secp256k1
Returns the transparent component of this UFVK, or throws if missing.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
toUnifiedIncomingViewingKey(ZCryptoContext context, {Bip44Changes scope = Bip44Changes.chainExt}) → UnifiedIncomingViewingKey
Converts this UFVK into a unified incoming viewing key (UIVK) for the specified derivation scope.

Operators

operator ==(Object other) → bool
The equality operator.
inherited