mirror of https://github.com/zcash/orchard.git
Merge pull request #319 from zcash/279-update-builder-docs
Update `Builder::build` docs
This commit is contained in:
commit
39495dc94b
|
@ -291,8 +291,8 @@ impl Builder {
|
||||||
|
|
||||||
/// Builds a bundle containing the given spent notes and recipients.
|
/// Builds a bundle containing the given spent notes and recipients.
|
||||||
///
|
///
|
||||||
/// This API assumes that none of the notes being spent are controlled by (threshold)
|
/// The returned bundle will have no proof or signatures; these can be applied with
|
||||||
/// multisignatures, and immediately constructs the bundle proof.
|
/// [`Bundle::create_proof`] and [`Bundle::apply_signatures`] respectively.
|
||||||
pub fn build<V: TryFrom<i64>>(
|
pub fn build<V: TryFrom<i64>>(
|
||||||
mut self,
|
mut self,
|
||||||
mut rng: impl RngCore,
|
mut rng: impl RngCore,
|
||||||
|
@ -531,6 +531,9 @@ impl<P: fmt::Debug, V> Bundle<InProgress<P, Unauthorized>, V> {
|
||||||
|
|
||||||
impl<V> Bundle<InProgress<Proof, Unauthorized>, V> {
|
impl<V> Bundle<InProgress<Proof, Unauthorized>, V> {
|
||||||
/// Applies signatures to this bundle, in order to authorize it.
|
/// Applies signatures to this bundle, in order to authorize it.
|
||||||
|
///
|
||||||
|
/// This is a helper method that wraps [`Bundle::prepare`], [`Bundle::sign`], and
|
||||||
|
/// [`Bundle::finalize`].
|
||||||
pub fn apply_signatures<R: RngCore + CryptoRng>(
|
pub fn apply_signatures<R: RngCore + CryptoRng>(
|
||||||
self,
|
self,
|
||||||
mut rng: R,
|
mut rng: R,
|
||||||
|
|
Loading…
Reference in New Issue