Struct OrchardSentOutput

pub struct OrchardSentOutput { /* private fields */ }

Represents a sent output in an Orchard shielded transaction within a Zcash wallet.

OrchardSentOutput stores the plaintext details of an Orchard note that was sent by the wallet, which are not recoverable from the blockchain after transmission. This information enables selective disclosure, allowing a sender to prove they made a payment to a specific shielded address without revealing additional transaction details.

Zcash Concept Relation

In Zcash’s Orchard protocol (introduced in Network Upgrade 5):

• Orchard represents the next-generation shielded protocol after Sapling
• Improved cryptography using the Pallas elliptic curve (instead of Jubjub in Sapling)
• Enhanced privacy with design improvements over earlier protocols
• Halo 2 proving system replaces the previous trusted setup zk-SNARKs

Each sent output contains components of the Orchard note:

• Diversifier: Part of the recipient’s shielded address derivation
• Public key: The recipient’s public key for the transaction
• Value: The amount of ZEC transferred
• Rho/Psi: Protocol-specific randomness values
• Rcm: Random commitment material

Data Preservation

During wallet migration, Orchard sent output information must be preserved to maintain the ability to generate payment proofs for regulatory compliance, auditing, or other selective disclosure purposes. The sending wallet is the only entity that has this information in plaintext form.

Examples

// Create a new Orchard sent output with all required components
let value = Amount::from_u64(10_000_000)?; // 0.1 ZEC

let sent_output = OrchardSentOutput::from_parts(
    0,
    "".to_string(),
    value,
    None
);

// Check the value was set correctly
let value_zatoshi: i64 = sent_output.value().into();
assert_eq!(value_zatoshi, 10_000_000);

Implementations

impl OrchardSentOutput

pub fn from_parts( index: usize, recipient_address: String, value: Amount, memo: Option<Memo>, ) -> Self

Creates a new OrchardSentOutput from its constituent parts.

This constructor creates an Orchard sent output with all required components for transaction reconstruction and selective disclosure.

Arguments

• value - The amount of ZEC sent

Returns

A new OrchardSentOutput instance with the provided values.

Examples

let sent_output = OrchardSentOutput::from_parts(
    0,
    "".to_string(),
    Amount::from_u64(5_000_000)?, // 0.05 ZEC
    None
);

pub fn recipient_address(&self) -> &str

Returns the string representation of the address used in construction of the output.

This will be a Unified address with an Orchard receiver. We preserve the original address string because in the case of Unified addresses, it is not otherwise possible to reconstruct the data for receivers other than the Orchard receiver, and as a consequence the recipient address in a restored wallet would appear different than in the source wallet.

pub fn set_recipient_address(&mut self, recipient_address: String)

Sets the string representation of the address used in construction of the output.

pub fn value(&self) -> Amount

Returns the value (amount) of ZEC sent in this output.

This represents the amount of ZEC transferred in this specific note, measured in zatoshis (1 ZEC = 10^8 zatoshis).

Returns

The amount of ZEC as an Amount.

Examples

let amount = sent_output.value();
let zats: i64 = amount.into();
assert_eq!(zats, 15_000_000);

pub fn set_value(&mut self, value: Amount)

Sets the value (amount) of ZEC for this sent output.

Arguments

• value - The amount of ZEC to set

Examples

let amount = Amount::from_u64(25_000_000)?; // 0.25 ZEC
sent_output.set_value(amount);

pub fn memo(&self) -> Option<&Memo>

Returns the memo associated with the output, if known.

pub fn set_memo(&mut self, memo: Option<Memo>)

Sets the memo associated with the output.

Trait Implementations

impl Clone for OrchardSentOutput

fn clone(&self) -> OrchardSentOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OrchardSentOutput

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

Formats the value using the given formatter.

impl From<OrchardSentOutput> for Envelope

fn from(value: OrchardSentOutput) -> Self

Converts to this type from the input type.

impl Indexed for OrchardSentOutput

fn index(&self) -> usize

fn set_index(&mut self, index: usize)

impl PartialEq for OrchardSentOutput

fn eq(&self, other: &OrchardSentOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Envelope> for OrchardSentOutput

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for OrchardSentOutput