Struct LocalTxProver

pub struct LocalTxProver { /* private fields */ }

Available on crate features local-prover or bundled-prover only.

An implementation of [SpendProver] and [OutputProver] 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>

Available 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

Available 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.

pub fn verifying_keys(&self) -> (SpendVerifyingKey, OutputVerifyingKey)

Returns the verifying keys for the Sapling circuits.

Trait Implementations

impl OutputProver for LocalTxProver

type Proof = Proof<Bls12>

The proof type created by this prover.

fn prepare_circuit( esk: &EphemeralSecretKey, payment_address: PaymentAddress, rcm: Fr, value: NoteValue, rcv: ValueCommitTrapdoor, ) -> Output

Prepares an instance of the Sapling Output circuit for the given inputs.

fn create_proof<R: RngCore>(&self, circuit: Output, rng: &mut R) -> Self::Proof

Create the proof for a Sapling OutputDescription.

fn encode_proof(proof: Self::Proof) -> GrothProofBytes

Encodes the given Sapling OutputDescription proof, erasing its type.

impl SpendProver for LocalTxProver

type Proof = Proof<Bls12>

The proof type created by this prover.

fn prepare_circuit( proof_generation_key: ProofGenerationKey, diversifier: Diversifier, rseed: Rseed, value: NoteValue, alpha: Fr, rcv: ValueCommitTrapdoor, anchor: Scalar, merkle_path: MerklePath, ) -> Option<Spend>

Prepares an instance of the Sapling Spend circuit for the given inputs.

fn create_proof<R: RngCore>(&self, circuit: Spend, rng: &mut R) -> Self::Proof

Create the proof for a Sapling SpendDescription.

fn encode_proof(proof: Self::Proof) -> GrothProofBytes

Encodes the given Sapling SpendDescription proof, erasing its type.