Struct zcash_proofs::prover::LocalTxProver

pub struct LocalTxProver { /* fields omitted */ }

This is supported on crate features local-prover or bundled-prover only.

An implementation of TxProver using Sapling Spend and Output parameters from locally-accessible paths.

Implementations

impl LocalTxProver

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_proofs::prover::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.

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_proofs::prover::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.

pub fn with_default_location() -> Option<Self>

This is supported on crate feature local-prover only.

Attempts to create a LocalTxProver using parameters from the default local location.

Returns None if any of the parameters cannot be found in the default local location.

Examples

use zcash_proofs::prover::LocalTxProver;

match LocalTxProver::with_default_location() {
    Some(tx_prover) => (),
    None => println!("Please run zcash-fetch-params or fetch-params.sh to download the parameters."),
}

Panics

This function will panic if the parameters in the default local location do not have the expected hashes.

pub fn bundled() -> Self

This is supported on crate feature bundled-prover only.

Creates a LocalTxProver using Sapling parameters bundled inside the binary.

This requires the bundled-prover feature, which will increase the binary size by around 50 MiB.

Trait Implementations

impl TxProver for LocalTxProver

type SaplingProvingContext = SaplingProvingContext

Type for persisting any necessary context across multiple Sapling proofs.

fn new_sapling_proving_context(&self) -> Self::SaplingProvingContext

Instantiate a new Sapling proving context.

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.

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.

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.