Skip to main content

UnifiedFullViewingKey

A Zcash viewing key

This is a wrapper around the zcash_keys::keys::ViewingKey type. UFVKs should be generated from a spending key by calling to_unified_full_viewing_key They can also be encoded and decoded to a canonical string representation

Index

Constructors

Methods

Constructors

constructor

  • Construct a UFVK from its encoded string representation

    Arguments

    • network - Must be either "main" or "test"
    • encoding - The encoded string representation of the UFVK

    Parameters

    • network: string
    • encoding: string

    Returns UnifiedFullViewingKey

Methods

encode

  • encode(network: string): string

  • Encode the UFVK to a string

    Arguments

    • network - Must be either "main" or "test"

    Parameters

    • network: string

    Returns string

free

  • free(): void

  • Returns void

get_transparent_address

  • get_transparent_address(network: string): string

  • Get the default transparent address derived from this UFVK.

    This can be used before creating an account to detect the wallet birthday by querying for transactions to this address.

    Arguments

    • network - Must be either "main" or "test"

    Returns

    The transparent address as a string, or None if this UFVK has no transparent component.

    Parameters

    • network: string

    Returns string