Struct Bundle 

pub struct Bundle { /* private fields */ }

PCZT fields that are specific to producing the transaction’s Orchard bundle (if any).

Implementations

impl Bundle

pub fn actions(&self) -> &Vec<Action>

The Orchard actions in this bundle.

Entries are added by the Constructor, and modified by an Updater, IO Finalizer, Signer, Combiner, or Spend Finalizer.

pub fn flags(&self) -> &u8

The flags for the Orchard bundle.

Contains:

• enableSpendsOrchard flag (bit 0)
• enableOutputsOrchard flag (bit 1)
• Reserved, zeros (bits 2..=7)

This is set by the Creator. The Constructor MUST only add spends and outputs that are consistent with these flags (i.e. are dummies as appropriate).

pub fn value_sum(&self) -> &(u64, bool)

The net value of Orchard spends minus outputs.

This is initialized by the Creator, and updated by the Constructor as spends or outputs are added to the PCZT. It enables per-spend and per-output values to be redacted from the PCZT after they are no longer necessary.

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

The Orchard anchor for this transaction.

Set by the Creator.

pub fn zkproof(&self) -> &Option<Vec<u8>>

The Orchard bundle proof.

This is None until it is set by the Prover.

impl Bundle

pub fn sole_action(&self) -> Option<&Action>

This bundle’s sole action, or None if it does not have exactly one.

pub fn value_carrying_outputs_all_pay( &self, recipient: &[u8; 43], ) -> Option<bool>

Whether every output of this bundle that carries value pays recipient, given as the raw encoding of an Orchard payment address, which is what makes the bundle a send-to-self.

Zero-valued padding dummies are excluded: a Constructor fabricates them to bring the bundle up to a required action count and they pay nobody in particular, so counting them would make every padded bundle fail. Returns None if any output has had the value or the recipient it would be judged on redacted, since the question cannot then be answered rather than answered negatively.

impl Bundle

pub fn resolve_fields(&mut self) -> Result<(), ParseError>

Available on crate feature orchard only.

Resolves fields that are optionally redacted in the PCZT but implied by other known fields.

This currently recomputes:

• Action::cv_net if it is redacted.
• Output::cmx if it is redacted.
• Output::enc_ciphertext if it is represented by memo plaintext.

For improved efficiency, callers that will pass the same bundle through multiple roles should call this once up front, not in each role. Parsing also resolves fields defensively.

Trait Implementations

impl Clone for Bundle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bundle

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

Formats the value using the given formatter.

impl From<Bundle> for Bundle

fn from(bundle: Bundle) -> Self

Converts to this type from the input type.

impl PartialEq for Bundle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Bundle

impl TryFrom<Bundle> for Bundle

type Error = EncodingError

The type returned in the event of a conversion error.

fn try_from(bundle: Bundle) -> Result<Self, Self::Error>

Performs the conversion.