Struct sapling_crypto::bundle::Bundle

impl<S: InProgressSignatures, V> Bundle<InProgress<Unproven, S>, V>

pub fn create_proofs<SP: SpendProver, OP: OutputProver>( self, spend_prover: &SP, output_prover: &OP, rng: impl RngCore, progress_notifier: impl ProverProgress ) -> Bundle<InProgress<Proven, S>, V>

Creates the proofs for this bundle.

impl<P: InProgressProofs, V> Bundle<InProgress<P, Unsigned>, V>

pub fn prepare<R: RngCore + CryptoRng>( self, rng: R, sighash: [u8; 32] ) -> Bundle<InProgress<P, PartiallyAuthorized>, V>

Loads the sighash into this bundle, preparing it for signing.

This API ensures that all signatures are created over the same sighash.

impl<V> Bundle<InProgress<Proven, Unsigned>, V>

pub fn apply_signatures<R: RngCore + CryptoRng>( self, rng: R, sighash: [u8; 32], signing_keys: &[SpendAuthorizingKey] ) -> Result<Bundle<Authorized, V>, Error>

Applies signatures to this bundle, in order to authorize it.

This is a helper method that wraps Bundle::prepare, Bundle::sign, and Bundle::finalize.

impl<P: InProgressProofs, V> Bundle<InProgress<P, PartiallyAuthorized>, V>

pub fn sign<R: RngCore + CryptoRng>( self, rng: R, ask: &SpendAuthorizingKey ) -> Self

Signs this bundle with the given redjubjub::SigningKey.

This will apply signatures for all notes controlled by this spending key.

pub fn append_signatures( self, signatures: &[Signature<SpendAuth>] ) -> Result<Self, Error>

Appends externally computed redjubjub::Signatures.

Each signature will be applied to the one input for which it is valid. An error will be returned if the signature is not valid for any inputs, or if it is valid for more than one input.

impl<V> Bundle<InProgress<Proven, PartiallyAuthorized>, V>

pub fn finalize(self) -> Result<Bundle<Authorized, V>, Error>

Finalizes this bundle, enabling it to be included in a transaction.

Returns an error if any signatures are missing.

impl<A: Authorization, V> Bundle<A, V>

pub fn from_parts( shielded_spends: Vec<SpendDescription<A>>, shielded_outputs: Vec<OutputDescription<A::OutputProof>>, value_balance: V, authorization: A ) -> Option<Self>

Constructs a Bundle from its constituent parts.

pub fn shielded_spends(&self) -> &[SpendDescription<A>]

Returns the list of spends in this bundle.

pub fn shielded_outputs(&self) -> &[OutputDescription<A::OutputProof>]

Returns the list of outputs in this bundle.

pub fn value_balance(&self) -> &V

Returns the net value moved into or out of the Sapling shielded pool.

This is the sum of Sapling spends minus the sum of Sapling outputs.

pub fn authorization(&self) -> &A

Returns the authorization for this bundle.

In the case of a Bundle<Authorized>, this is the binding signature.

pub fn map_authorization<R, B: Authorization>( self, context: R, spend_proof: impl Fn(&mut R, A::SpendProof) -> B::SpendProof, output_proof: impl Fn(&mut R, A::OutputProof) -> B::OutputProof, auth_sig: impl Fn(&mut R, A::AuthSig) -> B::AuthSig, auth: impl FnOnce(&mut R, A) -> B ) -> Bundle<B, V>

Transitions this bundle from one authorization state to another.

pub fn try_map_authorization<R, B: Authorization, Error>( self, context: R, spend_proof: impl Fn(&mut R, A::SpendProof) -> Result<B::SpendProof, Error>, output_proof: impl Fn(&mut R, A::OutputProof) -> Result<B::OutputProof, Error>, auth_sig: impl Fn(&mut R, A::AuthSig) -> Result<B::AuthSig, Error>, auth: impl Fn(&mut R, A) -> Result<B, Error> ) -> Result<Bundle<B, V>, Error>

Transitions this bundle from one authorization state to another.

Trait Implementations§

impl<A: Clone + Authorization, V: Clone> Clone for Bundle<A, V>
where A::OutputProof: Clone,

fn clone(&self) -> Bundle<A, V>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<A: Debug + Authorization, V: Debug> Debug for Bundle<A, V>
where A::OutputProof: Debug,

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

Formats the value using the given formatter. Read more

impl<V: DynamicUsage> DynamicUsage for Bundle<Authorized, V>

fn dynamic_usage(&self) -> usize

Returns a best estimate of the amount of heap-allocated memory used by this type. Read more

fn dynamic_usage_bounds(&self) -> (usize, Option<usize>)

Returns the lower and upper bounds on the amount of heap-allocated memory used by this type. Read more

Auto Trait Implementations§

impl<A, V> Freeze for Bundle<A, V>
where A: Freeze, V: Freeze,

impl<A, V> RefUnwindSafe for Bundle<A, V>
where A: RefUnwindSafe, V: RefUnwindSafe, <A as Authorization>::AuthSig: RefUnwindSafe, <A as Authorization>::OutputProof: RefUnwindSafe, <A as Authorization>::SpendProof: RefUnwindSafe,

impl<A, V> Send for Bundle<A, V>
where A: Send, V: Send, <A as Authorization>::AuthSig: Send, <A as Authorization>::OutputProof: Send, <A as Authorization>::SpendProof: Send,

impl<A, V> Sync for Bundle<A, V>
where A: Sync, V: Sync, <A as Authorization>::AuthSig: Sync, <A as Authorization>::OutputProof: Sync, <A as Authorization>::SpendProof: Sync,

impl<A, V> Unpin for Bundle<A, V>
where A: Unpin, V: Unpin, <A as Authorization>::AuthSig: Unpin, <A as Authorization>::OutputProof: Unpin, <A as Authorization>::SpendProof: Unpin,

impl<A, V> UnwindSafe for Bundle<A, V>
where A: UnwindSafe, V: UnwindSafe, <A as Authorization>::AuthSig: UnwindSafe, <A as Authorization>::OutputProof: UnwindSafe, <A as Authorization>::SpendProof: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more