Enum sapling_crypto::builder::BundleType

pub enum BundleType {
    Transactional {
        bundle_required: bool,
    },
    Coinbase,
}

An enumeration of rules for Sapling bundle construction.

Variants

Transactional

Fields

bundle_required: bool

A flag that, when set to true, indicates that the resulting bundle should be produced with the minimum required number of spends (1) and outputs (2 with padding) to be usable on its own in a transaction, irrespective of whether any spends or outputs have been requested. If no explicit spends or outputs have been added, all of the spends and outputs in the resulting bundle will be dummies.

A transactional bundle will be padded if necessary to contain at least 2 outputs, irrespective of whether any genuine outputs are required.

Coinbase

A coinbase bundle is required to have no spends. No output padding is performed.

Implementations

impl BundleType

pub const DEFAULT: BundleType = _

The default bundle type allows both spends and outputs, and does not require a bundle to be produced if no spends or outputs have been added to the bundle.

pub fn num_spends(&self, requested_spends: usize) -> Result<usize, &'static str>

Returns the number of logical spends that a builder will produce in constructing a bundle of this type, given the specified numbers of spends and outputs.

Returns an error if the specified number of spends and outputs is incompatible with this bundle type.

pub fn num_outputs( &self, requested_spends: usize, requested_outputs: usize ) -> Result<usize, &'static str>

Returns the number of logical outputs that a builder will produce in constructing a bundle of this type, given the specified numbers of spends and outputs.

Returns an error if the specified number of spends and outputs is incompatible with this bundle type.

Trait Implementations

impl Clone for BundleType

fn clone(&self) -> BundleType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BundleType

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

Formats the value using the given formatter.

impl PartialEq for BundleType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for BundleType

impl Eq for BundleType

impl StructuralPartialEq for BundleType