Struct Output 

pub struct Output { /* private fields */ }

Information about a Sapling output within a transaction.

This struct is for representing Sapling outputs in a partially-created transaction. If you have a fully-created transaction, use the regular OutputDescription struct.

Implementations

impl Output

pub fn parse( cv: [u8; 32], cmu: [u8; 32], ephemeral_key: [u8; 32], enc_ciphertext: Vec<u8>, out_ciphertext: Vec<u8>, zkproof: Option<GrothProofBytes>, recipient: Option<[u8; 43]>, value: Option<u64>, rseed: Option<[u8; 32]>, rcv: Option<[u8; 32]>, ock: Option<[u8; 32]>, zip32_derivation: Option<Zip32Derivation>, user_address: Option<String>, proprietary: BTreeMap<String, Vec<u8>>, ) -> Result<Self, ParseError>

Parses a PCZT output from its component parts.

impl Output

pub fn verify_cv(&self) -> Result<(), VerifyError>

Verifies that the cv field is consistent with the note fields.

Requires that the following optional fields are set:

• value
• rcv

pub fn verify_note_commitment(&self) -> Result<(), VerifyError>

Verifies that the cmu field is consistent with the note fields.

Requires that the following optional fields are set:

• recipient
• value
• rseed

impl Output

pub fn cv(&self) -> &ValueCommitment

A commitment to the value created by this output.

pub fn cmu(&self) -> &ExtractedNoteCommitment

A commitment to the new note being created.

pub fn ephemeral_key(&self) -> &EphemeralKeyBytes

The ephemeral key used to encrypt the note plaintext.

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

The encrypted note plaintext for the output.

Once we have memo bundles, we will be able to set memos independently of Outputs. For now, the Constructor sets both at the same time.

pub fn out_ciphertext(&self) -> &[u8; 80]

The encrypted output plaintext for the output.

pub fn zkproof(&self) -> &Option<GrothProofBytes>

The Output proof.

This is set by the Prover.

pub fn recipient(&self) -> &Option<PaymentAddress>

The address that will receive the output.

• This is set by the Constructor.
• This is required by the Prover.
• The Signer can use recipient and rseed (if present) to verify that enc_ciphertext is correctly encrypted (and contains a note plaintext matching the public commitments), and to confirm the value of the memo.

pub fn value(&self) -> &Option<NoteValue>

The value of the output.

This may be used by Signers to verify that the value matches cv, and to confirm the values and change involved in the transaction.

This exposes the output value to all participants. For Signers who don’t need this information, or after signatures have been applied, this can be redacted.

pub fn rseed(&self) -> &Option<[u8; 32]>

The seed randomness for the output.

• This is set by the Constructor.
• This is required by the Prover.
• The Signer can use recipient and rseed (if present) to verify that enc_ciphertext is correctly encrypted (and contains a note plaintext matching the public commitments), and to confirm the value of the memo.

pub fn rcv(&self) -> &Option<ValueCommitTrapdoor>

The value commitment randomness.

• This is set by the Constructor.
• The IO Finalizer compresses it into the bsk.
• This is required by the Prover.
• This may be used by Signers to verify that the value correctly matches cv.

This opens cv for all participants. For Signers who don’t need this information, or after proofs / signatures have been applied, this can be redacted.

pub fn ock(&self) -> &Option<OutgoingCipherKey>

The ock value used to encrypt out_ciphertext.

This enables Signers to verify that out_ciphertext is correctly encrypted.

This may be None if the Constructor added the output using an OVK policy of “None”, to make the output unrecoverable from the chain by the sender.

pub fn zip32_derivation(&self) -> &Option<Zip32Derivation>

The ZIP 32 derivation path at which the spending key can be found for the output.

pub fn user_address(&self) -> &Option<String>

The user-facing address to which this output is being sent, if any.

• This is set by an Updater.
• Signers must parse this address (if present) and confirm that it contains recipient (either directly, or e.g. as a receiver within a Unified Address).

pub fn proprietary(&self) -> &BTreeMap<String, Vec<u8>>

Proprietary fields related to the note being created.

Trait Implementations

impl Debug for Output

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

Formats the value using the given formatter.