Struct SaplingSentOutput

pub struct SaplingSentOutput { /* private fields */ }

Represents a sent output in a Sapling shielded transaction within a Zcash wallet.

SaplingSentOutput stores the plaintext details of a Sapling 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 Sapling protocol (activated in October 2018):

• Shielded transactions encrypt transaction details on the blockchain using zk-SNARKs
• Notes are the fundamental unit of value transfer, similar to UTXOs in transparent transactions
• Sent output information is stored by the sender’s wallet to enable proofs of payment

Each sent output contains components of the Sapling 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
• Rcm: Random commitment material used to construct the note commitment

Data Preservation

During wallet migration, 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 sent output
let mut sent_output = SaplingSentOutput::new();

let value = Amount::from_u64(5000000)?; // 0.05 ZEC
sent_output.set_value(value);

// Access the components
let amount = sent_output.value();
let zats: i64 = amount.into();
assert_eq!(zats, 5000000);

Implementations

impl SaplingSentOutput

pub fn new() -> Self

Creates a new SaplingSentOutput with default values.

This constructor initializes a SaplingSentOutput with empty default values for all fields. In practical use, these values would be set using the setter methods before the object is used.

Returns

A new SaplingSentOutput instance with default values.

Examples

let sent_output = SaplingSentOutput::new();

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

Creates a new SaplingSentOutput from its constituent parts.

pub fn recipient_address(&self) -> &str

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

This will be either a Sapling address or a Unified address with a Sapling 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 Sapling 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 mut sent_output = SaplingSentOutput::new();
sent_output.set_value(Amount::from_u64(10_000_000)?); // 0.1 ZEC

let value = sent_output.value();
let zats: i64 = value.into();
assert_eq!(zats, 10_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 mut sent_output = SaplingSentOutput::new();
let amount = Amount::from_u64(50_000_000)?; // 0.5 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 SaplingSentOutput

fn clone(&self) -> SaplingSentOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaplingSentOutput

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

Formats the value using the given formatter.

impl Default for SaplingSentOutput

fn default() -> Self

Returns the “default value” for a type.

impl From<SaplingSentOutput> for Envelope

fn from(value: SaplingSentOutput) -> Self

Converts to this type from the input type.

impl Indexed for SaplingSentOutput

fn index(&self) -> usize

fn set_index(&mut self, index: usize)

impl PartialEq for SaplingSentOutput

fn eq(&self, other: &SaplingSentOutput) -> 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 SaplingSentOutput

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 Eq for SaplingSentOutput

impl StructuralPartialEq for SaplingSentOutput