Struct OrchardDomain 

pub struct OrchardDomain { /* private fields */ }

Orchard-specific note encryption logic.

Implementations

impl OrchardDomain

pub fn for_action<T>(act: &Action<T>) -> Self

Constructs a domain that can be used to trial-decrypt this action’s output note.

pub fn for_pczt_action(act: &Action) -> Self

Constructs a domain that can be used to trial-decrypt a PCZT action’s output note.

pub fn for_compact_action(act: &CompactAction) -> Self

Constructs a domain that can be used to trial-decrypt this action’s output note.

Trait Implementations

impl BatchDomain for OrchardDomain

fn batch_kdf<'a>( items: impl Iterator<Item = (Option<Self::SharedSecret>, &'a EphemeralKeyBytes)>, ) -> Vec<Option<Self::SymmetricKey>>

Computes Self::kdf on a batch of items.

fn batch_epk( ephemeral_keys: impl Iterator<Item = EphemeralKeyBytes>, ) -> Vec<(Option<Self::PreparedEphemeralPublicKey>, EphemeralKeyBytes)>

Computes Self::epk on a batch of ephemeral keys.

impl Debug for OrchardDomain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Domain for OrchardDomain

type EphemeralSecretKey = EphemeralSecretKey

type EphemeralPublicKey = EphemeralPublicKey

type PreparedEphemeralPublicKey = PreparedEphemeralPublicKey

type SharedSecret = SharedSecret

type SymmetricKey = Hash

type Note = Note

type Recipient = Address

type DiversifiedTransmissionKey = DiversifiedTransmissionKey

type IncomingViewingKey = PreparedIncomingViewingKey

type OutgoingViewingKey = OutgoingViewingKey

type ValueCommitment = ValueCommitment

type ExtractedCommitment = ExtractedNoteCommitment

type ExtractedCommitmentBytes = [u8; 32]

type Memo = [u8; 512]

fn derive_esk(note: &Self::Note) -> Option<Self::EphemeralSecretKey>

Derives the EphemeralSecretKey corresponding to this note.

fn get_pk_d(note: &Self::Note) -> Self::DiversifiedTransmissionKey

Extracts the DiversifiedTransmissionKey from the note.

fn prepare_epk( epk: Self::EphemeralPublicKey, ) -> Self::PreparedEphemeralPublicKey

Prepare an ephemeral public key for more efficient scalar multiplication.

fn ka_derive_public( note: &Self::Note, esk: &Self::EphemeralSecretKey, ) -> Self::EphemeralPublicKey

Derives EphemeralPublicKey from esk and the note’s diversifier.

fn ka_agree_enc( esk: &Self::EphemeralSecretKey, pk_d: &Self::DiversifiedTransmissionKey, ) -> Self::SharedSecret

Derives the SharedSecret from the sender’s information during note encryption.

fn ka_agree_dec( ivk: &Self::IncomingViewingKey, epk: &Self::PreparedEphemeralPublicKey, ) -> Self::SharedSecret

Derives the SharedSecret from the recipient’s information during note trial decryption.

fn kdf( secret: Self::SharedSecret, ephemeral_key: &EphemeralKeyBytes, ) -> Self::SymmetricKey

Derives the SymmetricKey used to encrypt the note plaintext.

fn note_plaintext_bytes( note: &Self::Note, memo: &Self::Memo, ) -> NotePlaintextBytes

Encodes the given Note and Memo as a note plaintext.

fn derive_ock( ovk: &Self::OutgoingViewingKey, cv: &Self::ValueCommitment, cmstar_bytes: &Self::ExtractedCommitmentBytes, ephemeral_key: &EphemeralKeyBytes, ) -> OutgoingCipherKey

Derives the OutgoingCipherKey for an encrypted note, given the note-specific public data and an OutgoingViewingKey.

fn outgoing_plaintext_bytes( note: &Self::Note, esk: &Self::EphemeralSecretKey, ) -> OutPlaintextBytes

Encodes the outgoing plaintext for the given note.

fn epk_bytes(epk: &Self::EphemeralPublicKey) -> EphemeralKeyBytes

Returns the byte encoding of the given EphemeralPublicKey.

fn epk(ephemeral_key: &EphemeralKeyBytes) -> Option<Self::EphemeralPublicKey>

Attempts to parse ephemeral_key as an EphemeralPublicKey.

fn cmstar(note: &Self::Note) -> Self::ExtractedCommitment

Derives the ExtractedCommitment for this note.

fn parse_note_plaintext_without_memo_ivk( &self, ivk: &Self::IncomingViewingKey, plaintext: &[u8], ) -> Option<(Self::Note, Self::Recipient)>

Parses the given note plaintext from the recipient’s perspective.

fn parse_note_plaintext_without_memo_ovk( &self, pk_d: &Self::DiversifiedTransmissionKey, plaintext: &NotePlaintextBytes, ) -> Option<(Self::Note, Self::Recipient)>

Parses the given note plaintext from the sender’s perspective.

fn extract_memo(&self, plaintext: &NotePlaintextBytes) -> Self::Memo

Extracts the memo field from the given note plaintext.

fn extract_pk_d( out_plaintext: &OutPlaintextBytes, ) -> Option<Self::DiversifiedTransmissionKey>

Parses the DiversifiedTransmissionKey field of the outgoing plaintext.

fn extract_esk( out_plaintext: &OutPlaintextBytes, ) -> Option<Self::EphemeralSecretKey>

Parses the EphemeralSecretKey field of the outgoing plaintext.

impl DynamicUsage for OrchardDomain

fn dynamic_usage(&self) -> usize

Returns a best estimate of the amount of heap-allocated memory used by this type.

fn dynamic_usage_bounds(&self) -> (usize, Option<usize>)

Returns the lower and upper bounds on the amount of heap-allocated memory used by this type.

impl ShieldedOutput<OrchardDomain, COMPACT_NOTE_SIZE> for CompactAction

fn ephemeral_key(&self) -> EphemeralKeyBytes

Exposes the ephemeral_key field of the output.

fn cmstar_bytes(&self) -> [u8; 32]

Exposes the cmu_bytes or cmx_bytes field of the output.

fn enc_ciphertext(&self) -> &[u8; 52]

Exposes the note ciphertext of the output.

impl ShieldedOutput<OrchardDomain, ENC_CIPHERTEXT_SIZE> for Action

fn ephemeral_key(&self) -> EphemeralKeyBytes

Exposes the ephemeral_key field of the output.

fn cmstar_bytes(&self) -> [u8; 32]

Exposes the cmu_bytes or cmx_bytes field of the output.

fn enc_ciphertext(&self) -> &[u8; 580]

Exposes the note ciphertext of the output.

impl<T> ShieldedOutput<OrchardDomain, ENC_CIPHERTEXT_SIZE> for Action<T>

fn ephemeral_key(&self) -> EphemeralKeyBytes

Exposes the ephemeral_key field of the output.

fn cmstar_bytes(&self) -> [u8; 32]

Exposes the cmu_bytes or cmx_bytes field of the output.

fn enc_ciphertext(&self) -> &[u8; 580]

Exposes the note ciphertext of the output.