Trait ScanningKeyOps 

pub trait ScanningKeyOps<D: Domain, AccountId, Nf> {
    // Required methods
    fn prepare(&self) -> D::IncomingViewingKey;
    fn account_id(&self) -> &AccountId;
    fn key_scope(&self) -> Option<Scope>;
    fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>;
}

A key that can be used to perform trial decryption and nullifier computation for a CompactSaplingOutput or CompactOrchardAction.

The purpose of this trait is to enable scan_block and related methods to be used with either incoming viewing keys or full viewing keys, with the data returned from trial decryption being dependent upon the type of key used. In the case that an incoming viewing key is used, only the note and payment address will be returned; in the case of a full viewing key, the nullifier for the note can also be obtained.

Required Methods

fn prepare(&self) -> D::IncomingViewingKey

Prepare the key for use in batch trial decryption.

fn account_id(&self) -> &AccountId

Returns the account identifier for this key. An account identifier corresponds to at most a single unified spending key’s worth of spend authority, such that both received notes and change spendable by that spending authority will be interpreted as belonging to that account.

fn key_scope(&self) -> Option<Scope>

Returns the [zip32::Scope] for which this key was derived, if known.

fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>

Produces the nullifier for the specified note and witness, if possible.

IVK-based implementations of this trait cannot successfully derive nullifiers, in which this function will always return None.

Trait Implementations

impl<D: Domain, AccountId, Nf> ScanningKeyOps<D, AccountId, Nf> for Box<dyn ScanningKeyOps<D, AccountId, Nf>>

fn prepare(&self) -> D::IncomingViewingKey

Prepare the key for use in batch trial decryption.

fn account_id(&self) -> &AccountId

Returns the account identifier for this key. An account identifier corresponds to at most a single unified spending key’s worth of spend authority, such that both received notes and change spendable by that spending authority will be interpreted as belonging to that account.

fn key_scope(&self) -> Option<Scope>

Returns the [zip32::Scope] for which this key was derived, if known.

fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>

Produces the nullifier for the specified note and witness, if possible.

impl<D: Domain, AccountId: Send + Sync, Nf> ScanningKeyOps<D, AccountId, Nf> for Box<dyn ScanningKeyOps<D, AccountId, Nf> + Send + Sync>

fn prepare(&self) -> D::IncomingViewingKey

Prepare the key for use in batch trial decryption.

fn account_id(&self) -> &AccountId

Returns the account identifier for this key. An account identifier corresponds to at most a single unified spending key’s worth of spend authority, such that both received notes and change spendable by that spending authority will be interpreted as belonging to that account.

fn key_scope(&self) -> Option<Scope>

Returns the [zip32::Scope] for which this key was derived, if known.

fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>

Produces the nullifier for the specified note and witness, if possible.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl<AccountId> ScanningKeyOps<SaplingDomain, AccountId, Nullifier> for (AccountId, SaplingIvk)

fn prepare(&self) -> PreparedIncomingViewingKey

fn nf(&self, _note: &Note, _position: Position) -> Option<Nullifier>

fn account_id(&self) -> &AccountId

fn key_scope(&self) -> Option<Scope>

impl<D: Domain, AccountId, Nf, K: ScanningKeyOps<D, AccountId, Nf>> ScanningKeyOps<D, AccountId, Nf> for &K

fn prepare(&self) -> D::IncomingViewingKey

fn account_id(&self) -> &AccountId

fn key_scope(&self) -> Option<Scope>

fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>

impl<D: Domain, AccountId, Nf> ScanningKeyOps<D, AccountId, Nf> for Box<dyn ScanningKeyOps<D, AccountId, Nf>>

fn prepare(&self) -> D::IncomingViewingKey

fn account_id(&self) -> &AccountId

fn key_scope(&self) -> Option<Scope>

fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>

impl<D: Domain, AccountId: Send + Sync, Nf> ScanningKeyOps<D, AccountId, Nf> for Box<dyn ScanningKeyOps<D, AccountId, Nf> + Send + Sync>

fn prepare(&self) -> D::IncomingViewingKey

fn account_id(&self) -> &AccountId

fn key_scope(&self) -> Option<Scope>

fn nf(&self, note: &D::Note, note_position: Position) -> Option<Nf>

Implementors

impl<AccountId> ScanningKeyOps<NoteEncryptionDomain<IronwoodVersion>, AccountId, Nullifier> for ScanningKey<IncomingViewingKey, FullViewingKey, AccountId>

Available on crate feature orchard only.

An Orchard viewing key trial-decrypts Ironwood outputs under the Ironwood note-encryption domain. The key material is the same as for Orchard; only the domain (and thus the accepted note plaintext version) differs.

impl<AccountId> ScanningKeyOps<NoteEncryptionDomain<OrchardVersion>, AccountId, Nullifier> for ScanningKey<IncomingViewingKey, FullViewingKey, AccountId>

Available on crate feature orchard only.

impl<AccountId> ScanningKeyOps<SaplingDomain, AccountId, Nullifier> for ScanningKey<SaplingIvk, NullifierDerivingKey, AccountId>