Struct ledger_zcash_builder::txprover::LocalTxProver
source · pub struct LocalTxProver { /* private fields */ }
Expand description
An implementation of HsmTxProver
using Sapling Spend and Output
parameters from locally-accessible paths.
Implementations§
source§impl LocalTxProver
impl LocalTxProver
sourcepub fn new(spend_path: &Path, output_path: &Path) -> Self
pub fn new(spend_path: &Path, output_path: &Path) -> Self
Creates a LocalTxProver
using parameters from the given local paths.
§Examples
ⓘ
use std::path::Path;
use zcash_hsmbuilder::LocalTxProver;
let tx_prover = LocalTxProver::new(
Path::new("/path/to/sapling-spend.params"),
Path::new("/path/to/sapling-output.params"),
);
§Panics
This function will panic if the paths do not point to valid parameter files with the expected hashes.
sourcepub fn from_bytes(spend_param_bytes: &[u8], output_param_bytes: &[u8]) -> Self
pub fn from_bytes(spend_param_bytes: &[u8], output_param_bytes: &[u8]) -> Self
Creates a LocalTxProver
using parameters specified as byte arrays.
§Examples
ⓘ
use std::path::Path;
use zcash_hsmbuilder::LocalTxProver;
let tx_prover = LocalTxProver::from_bytes(&[0u8], &[0u8]);
§Panics
This function will panic if the byte arrays do not contain valid parameters with the expected hashes.
Trait Implementations§
source§impl HsmTxProver for LocalTxProver
impl HsmTxProver for LocalTxProver
§type SaplingProvingContext = SaplingProvingContext
type SaplingProvingContext = SaplingProvingContext
Type for persisting any necessary context across multiple Sapling
proofs.
source§fn new_sapling_proving_context(&self) -> Self::SaplingProvingContext
fn new_sapling_proving_context(&self) -> Self::SaplingProvingContext
Instantiate a new Sapling proving context.
source§fn spend_proof(
&self,
ctx: &mut Self::SaplingProvingContext,
proof_generation_key: ProofGenerationKey,
diversifier: Diversifier,
rseed: Rseed,
ar: Fr,
value: u64,
anchor: Scalar,
merkle_path: MerklePath<Node>,
rcv: Fr
) -> Result<([u8; 192], ExtendedPoint, PublicKey), ()>
fn spend_proof( &self, ctx: &mut Self::SaplingProvingContext, proof_generation_key: ProofGenerationKey, diversifier: Diversifier, rseed: Rseed, ar: Fr, value: u64, anchor: Scalar, merkle_path: MerklePath<Node>, rcv: Fr ) -> Result<([u8; 192], ExtendedPoint, PublicKey), ()>
Create the value commitment, re-randomized key, and proof for a Sapling
SpendDescription
, while accumulating its value commitment randomness
inside the context for later use.source§fn output_proof(
&self,
ctx: &mut Self::SaplingProvingContext,
esk: Fr,
payment_address: PaymentAddress,
rcm: Fr,
value: u64,
rcv: Fr
) -> ([u8; 192], ExtendedPoint)
fn output_proof( &self, ctx: &mut Self::SaplingProvingContext, esk: Fr, payment_address: PaymentAddress, rcm: Fr, value: u64, rcv: Fr ) -> ([u8; 192], ExtendedPoint)
Create the value commitment and proof for a Sapling
OutputDescription
, while accumulating its value commitment
randomness inside the context for later use.source§impl TxProver for LocalTxProver
impl TxProver for LocalTxProver
§type SaplingProvingContext = <LocalTxProver as HsmTxProver>::SaplingProvingContext
type SaplingProvingContext = <LocalTxProver as HsmTxProver>::SaplingProvingContext
Type for persisting any necessary context across multiple Sapling proofs.
source§fn new_sapling_proving_context(&self) -> Self::SaplingProvingContext
fn new_sapling_proving_context(&self) -> Self::SaplingProvingContext
Instantiate a new Sapling proving context.
source§fn spend_proof(
&self,
ctx: &mut Self::SaplingProvingContext,
proof_generation_key: ProofGenerationKey,
diversifier: Diversifier,
rseed: Rseed,
ar: Fr,
value: u64,
anchor: Scalar,
merkle_path: MerklePath<Node>
) -> Result<([u8; 192], ExtendedPoint, PublicKey), ()>
fn spend_proof( &self, ctx: &mut Self::SaplingProvingContext, proof_generation_key: ProofGenerationKey, diversifier: Diversifier, rseed: Rseed, ar: Fr, value: u64, anchor: Scalar, merkle_path: MerklePath<Node> ) -> Result<([u8; 192], ExtendedPoint, PublicKey), ()>
Create the value commitment, re-randomized key, and proof for a Sapling
SpendDescription
, while accumulating its value commitment randomness inside
the context for later use.source§fn output_proof(
&self,
ctx: &mut Self::SaplingProvingContext,
esk: Fr,
payment_address: PaymentAddress,
rcm: Fr,
value: u64
) -> ([u8; 192], ExtendedPoint)
fn output_proof( &self, ctx: &mut Self::SaplingProvingContext, esk: Fr, payment_address: PaymentAddress, rcm: Fr, value: u64 ) -> ([u8; 192], ExtendedPoint)
Create the value commitment and proof for a Sapling
OutputDescription
,
while accumulating its value commitment randomness inside the context for later
use.source§fn binding_sig(
&self,
ctx: &mut Self::SaplingProvingContext,
value_balance: Amount,
sighash: &[u8; 32]
) -> Result<Signature, ()>
fn binding_sig( &self, ctx: &mut Self::SaplingProvingContext, value_balance: Amount, sighash: &[u8; 32] ) -> Result<Signature, ()>
Create the
bindingSig
for a Sapling transaction. All calls to
TxProver::spend_proof
and TxProver::output_proof
must be completed before
calling this function.Auto Trait Implementations§
impl Freeze for LocalTxProver
impl RefUnwindSafe for LocalTxProver
impl Send for LocalTxProver
impl Sync for LocalTxProver
impl Unpin for LocalTxProver
impl UnwindSafe for LocalTxProver
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.