Struct SaplingDomain 

pub struct SaplingDomain { /* private fields */ }

Implementations

impl SaplingDomain

pub fn new(zip212_enforcement: Zip212Enforcement) -> Self

Trait Implementations

impl BatchDomain for SaplingDomain

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.

fn batch_ka_agree_dec<'a>( ivk: &Self::IncomingViewingKey, epks: impl Iterator<Item = Option<&'a Self::PreparedEphemeralPublicKey>>, ) -> Vec<Option<Self::SharedSecret>>

where Self::PreparedEphemeralPublicKey: 'a,

Computes Self::ka_agree_dec on a batch of prepared ephemeral keys against a single incoming viewing key.

impl Domain for SaplingDomain

fn kdf(dhsecret: SharedSecret, epk: &EphemeralKeyBytes) -> Blake2bHash

Sapling KDF for note encryption.

Implements section 5.4.4.4 of the Zcash Protocol Specification.

type EphemeralSecretKey = EphemeralSecretKey

The ephemeral secret key used to derive the shared secret.

type EphemeralPublicKey = EphemeralPublicKey

The ephemeral public key transmitted with the output.

type PreparedEphemeralPublicKey = PreparedEphemeralPublicKey

A precomputed form of Self::EphemeralPublicKey for key agreement.

type SharedSecret = SharedSecret

The shared secret produced by Diffie-Hellman key agreement.

type SymmetricKey = Hash

The symmetric key derived from the shared secret.

type Note = Note

The note being encrypted.

type Recipient = PaymentAddress

The recipient of the note.

type DiversifiedTransmissionKey = DiversifiedTransmissionKey

The diversified transmission key of the recipient.

type IncomingViewingKey = PreparedIncomingViewingKey

The incoming viewing key used to decrypt notes by the recipient.

type OutgoingViewingKey = OutgoingViewingKey

The outgoing viewing key used to decrypt notes by the sender.

type ValueCommitment = ValueCommitment

The commitment to the value of the note.

type ExtractedCommitment = ExtractedNoteCommitment

The note commitment.

type ExtractedCommitmentBytes = [u8; 32]

The byte representation of an Self::ExtractedCommitment.

type Memo = [u8; 512]

The memo field associated with the note.

type NotePlaintextBytes = NoteBytesData<NOTE_PLAINTEXT_SIZE>

The byte representation of a note plaintext.

type NoteCiphertextBytes = NoteBytesData<ENC_CIPHERTEXT_SIZE>

The byte representation of an encrypted note.

type CompactNotePlaintextBytes = NoteBytesData<COMPACT_NOTE_SIZE>

The byte representation of a compact note plaintext.

type CompactNoteCiphertextBytes = NoteBytesData<COMPACT_NOTE_SIZE>

The byte representation of an encrypted compact note.

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 note_plaintext_bytes( note: &Self::Note, memo: &Self::Memo, ) -> Self::NotePlaintextBytes

Encodes the given Note and Memo as a note plaintext.

fn derive_ock( ovk: &Self::OutgoingViewingKey, cv: &Self::ValueCommitment, cmu_bytes: &Self::ExtractedCommitmentBytes, epk: &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 parse_note_plaintext_without_memo_ivk( &self, ivk: &Self::IncomingViewingKey, plaintext: &Self::CompactNotePlaintextBytes, ) -> 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: &Self::CompactNotePlaintextBytes, ) -> Option<(Self::Note, Self::Recipient)>

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

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

Derives the ExtractedCommitment for this note.

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

Parses the DiversifiedTransmissionKey field of the outgoing plaintext.

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

Parses the EphemeralSecretKey field of the outgoing plaintext.

fn split_plaintext_at_memo( &self, plaintext: &Self::NotePlaintextBytes, ) -> Option<(Self::CompactNotePlaintextBytes, Self::Memo)>

Splits the given note plaintext into the compact part (containing the note) and the memo field.

fn parse_note_plaintext_bytes( plaintext: &[u8], ) -> Option<Self::NotePlaintextBytes>

Parses the given note plaintext bytes.

fn parse_note_ciphertext_bytes( output: &[u8], tag: [u8; 16], ) -> Option<Self::NoteCiphertextBytes>

Parses the given note ciphertext bytes.

fn parse_compact_note_plaintext_bytes( plaintext: &[u8], ) -> Option<Self::CompactNotePlaintextBytes>

Parses the given compact note plaintext bytes.

impl DynamicUsage for SaplingDomain

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<A> ShieldedOutput<SaplingDomain> for OutputDescription<A>

fn ephemeral_key(&self) -> EphemeralKeyBytes

Exposes the ephemeral_key field of the output.

fn cmstar(&self) -> &ExtractedNoteCommitment

Exposes the cmu or cmx field of the output.

fn enc_ciphertext(&self) -> Option<&NoteCiphertextBytes>

Exposes the note ciphertext of the output. Returns None if the output is compact.

fn enc_ciphertext_compact(&self) -> NoteBytesData<COMPACT_NOTE_SIZE>

Exposes the compact note ciphertext of the output.

fn cmstar_bytes(&self) -> <D as Domain>::ExtractedCommitmentBytes

Exposes the cmu_bytes or cmx_bytes representation of the output.

fn split_ciphertext_at_tag( &self, ) -> Option<(<D as Domain>::NotePlaintextBytes, [u8; 16])>

Splits the AEAD tag from the ciphertext.

impl ShieldedOutput<SaplingDomain> for CompactOutputDescription

fn ephemeral_key(&self) -> EphemeralKeyBytes

Exposes the ephemeral_key field of the output.

fn cmstar(&self) -> &ExtractedNoteCommitment

Exposes the cmu or cmx field of the output.

fn enc_ciphertext(&self) -> Option<&NoteCiphertextBytes>

Exposes the note ciphertext of the output. Returns None if the output is compact.

fn enc_ciphertext_compact(&self) -> CompactNoteCiphertextBytes

Exposes the compact note ciphertext of the output.

fn cmstar_bytes(&self) -> <D as Domain>::ExtractedCommitmentBytes

Exposes the cmu_bytes or cmx_bytes representation of the output.

fn split_ciphertext_at_tag( &self, ) -> Option<(<D as Domain>::NotePlaintextBytes, [u8; 16])>

Splits the AEAD tag from the ciphertext.