zcash_primitives::transaction::builder

Struct Builder

Source 
pub struct Builder<'a, P, U: ProverProgress> { /* private fields */ }
Expand description

Generates a Transaction from its inputs and outputs.

Implementations§

Source§

impl<P: Parameters, U: ProverProgress> Builder<'_, P, U>

Source

pub fn mock_build<R: RngCore>( self, transparent_signing_set: &TransparentSigningSet, sapling_extsks: &[ExtendedSpendingKey], orchard_saks: &[SpendAuthorizingKey], rng: R, ) -> Result<BuildResult, Error<FeeError>>

Available on crate feature test-dependencies only.

Build the transaction using mocked randomness and proving capabilities. DO NOT USE EXCEPT FOR UNIT TESTING.

Source§

impl<P, U: ProverProgress> Builder<'_, P, U>

Source

pub fn params(&self) -> &P

Returns the network parameters that the builder has been configured for.

Source

pub fn target_height(&self) -> BlockHeight

Returns the target height of the transaction under construction.

Source

pub fn transparent_inputs(&self) -> &[TransparentInputInfo]

Available on crate feature transparent-inputs only.

Returns the set of transparent inputs currently committed to be consumed by the transaction.

Source

pub fn transparent_outputs(&self) -> &[TxOut]

Returns the set of transparent outputs currently set to be produced by the transaction.

Source

pub fn sapling_inputs(&self) -> &[SpendInfo]

Returns the set of Sapling inputs currently committed to be consumed by the transaction.

Source

pub fn sapling_outputs(&self) -> &[OutputInfo]

Returns the set of Sapling outputs currently set to be produced by the transaction.

Source§

impl<'a, P: Parameters> Builder<'a, P, ()>

Source

pub fn new( params: P, target_height: BlockHeight, build_config: BuildConfig, ) -> Self

Creates a new Builder targeted for inclusion in the block with the given height, using default values for general transaction fields.

§Default values

The expiry height will be set to the given height plus the default transaction expiry delta (20 blocks).

Source

pub fn with_progress_notifier( self, _progress_notifier: Sender<Progress>, ) -> Builder<'a, P, Sender<Progress>>

Available on crate feature std only.

Sets the notifier channel, where progress of building the transaction is sent.

An update is sent after every Sapling Spend or Output is computed, and the u32 sent represents the total steps completed so far. It will eventually send number of spends + outputs. If there’s an error building the transaction, the channel is closed.

Source§

impl<P: Parameters, U: ProverProgress> Builder<'_, P, U>

Source

pub fn add_orchard_spend<FE>( &mut self, fvk: FullViewingKey, note: Note, merkle_path: MerklePath, ) -> Result<(), Error<FE>>

Adds an Orchard note to be spent in this bundle.

Returns an error if the given Merkle path does not have the required anchor for the given note.

Source

pub fn add_orchard_output<FE>( &mut self, ovk: Option<OutgoingViewingKey>, recipient: Address, value: u64, memo: MemoBytes, ) -> Result<(), Error<FE>>

Adds an Orchard recipient to the transaction.

Source

pub fn add_sapling_spend<FE>( &mut self, fvk: FullViewingKey, note: Note, merkle_path: MerklePath, ) -> Result<(), Error<FE>>

Adds a Sapling note to be spent in this transaction.

Returns an error if the given Merkle path does not have the same anchor as the paths for previous Sapling notes.

Source

pub fn add_sapling_output<FE>( &mut self, ovk: Option<OutgoingViewingKey>, to: PaymentAddress, value: Zatoshis, memo: MemoBytes, ) -> Result<(), Error<FE>>

Adds a Sapling address to send funds to.

Source

pub fn add_transparent_input( &mut self, pubkey: PublicKey, utxo: OutPoint, coin: TxOut, ) -> Result<(), Error>

Available on crate feature transparent-inputs only.

Adds a transparent coin to be spent in this transaction.

Source

pub fn add_transparent_output( &mut self, to: &TransparentAddress, value: Zatoshis, ) -> Result<(), Error>

Adds a transparent address to send funds to.

Source

pub fn get_fee<FR: FeeRule>( &self, fee_rule: &FR, ) -> Result<Zatoshis, FeeError<FR::Error>>

Reports the calculated fee given the specified fee rule.

This fee is a function of the spends and outputs that have been added to the builder, pursuant to the specified FeeRule.

Source

pub fn build<R: RngCore + CryptoRng, SP: SpendProver, OP: OutputProver, FR: FeeRule>( self, transparent_signing_set: &TransparentSigningSet, sapling_extsks: &[ExtendedSpendingKey], orchard_saks: &[SpendAuthorizingKey], rng: R, spend_prover: &SP, output_prover: &OP, fee_rule: &FR, ) -> Result<BuildResult, Error<FR::Error>>

Available on crate feature circuits only.

Builds a transaction from the configured spends and outputs.

Upon success, returns a tuple containing the final transaction, and the [SaplingMetadata] generated during the build process.

Source

pub fn build_for_pczt<R: RngCore + CryptoRng, FR: FeeRule>( self, rng: R, fee_rule: &FR, ) -> Result<PcztResult<P>, Error<FR::Error>>

Builds a PCZT from the configured spends and outputs.

Upon success, returns a struct containing the PCZT components, and the [SaplingMetadata] and [orchard::builder::BundleMetadata] generated during the build process.

Auto Trait Implementations§

§

impl<'a, P, U> Freeze for Builder<'a, P, U>
where P: Freeze, U: Freeze,

§

impl<'a, P, U> RefUnwindSafe for Builder<'a, P, U>
where P: RefUnwindSafe, U: RefUnwindSafe,

§

impl<'a, P, U> Send for Builder<'a, P, U>
where P: Send, U: Send,

§

impl<'a, P, U> Sync for Builder<'a, P, U>
where P: Sync, U: Sync,

§

impl<'a, P, U> Unpin for Builder<'a, P, U>
where P: Unpin, U: Unpin,

§

impl<'a, P, U> UnwindSafe for Builder<'a, P, U>
where P: UnwindSafe, U: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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>, 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>, 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>, 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>, 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
Source§

impl<T> Same for T

Source§

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<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

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

Mutable access to the BorrowMut<B> 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<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

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

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, 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> 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
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more