valar-pczt 0.5.1

Valar Group fork of pczt with shielded-voting getters, maintained until the getters are upstreamed to zcash/librustzcash.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! The Prover role (capability holders can contribute).
//!
//! - Needs all private information for a single spend or output.
//! - In practice, the Updater that adds a given spend or output will either act as
//!   the Prover themselves, or add the necessary data, offload to the Prover, and
//!   then receive back the PCZT with private data stripped and proof added.

use crate::Pczt;

#[cfg(feature = "orchard")]
mod orchard;
#[cfg(feature = "orchard")]
pub use orchard::OrchardError;

#[cfg(feature = "sapling")]
mod sapling;
#[cfg(feature = "sapling")]
pub use sapling::SaplingError;

pub struct Prover {
    pczt: Pczt,
}

impl Prover {
    /// Instantiates the Prover role with the given PCZT.
    pub fn new(pczt: Pczt) -> Self {
        Self { pczt }
    }

    /// Returns `true` if this PCZT contains Sapling Spends or Outputs that are missing
    /// proofs.
    pub fn requires_sapling_proofs(&self) -> bool {
        let sapling_bundle = self.pczt.sapling();

        sapling_bundle.spends().iter().any(|s| s.zkproof.is_none())
            || sapling_bundle.outputs().iter().any(|o| o.zkproof.is_none())
    }

    /// Returns `true` if this PCZT contains Orchard Actions but no Orchard proof.
    pub fn requires_orchard_proof(&self) -> bool {
        !self.pczt.orchard().actions().is_empty() && self.pczt.orchard().zkproof.is_none()
    }

    /// Finishes the Prover role, returning the updated PCZT.
    pub fn finish(self) -> Pczt {
        self.pczt
    }
}