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
49
50
51
52

//! The Redactor role (anyone can execute).
//!
//! - Removes information that is unnecessary for subsequent entities to proceed.
//! - This can be useful e.g. when creating a transaction that has inputs from multiple
//!   independent Signers; each can receive a PCZT with just the information they need
//!   to sign, but (e.g.) not the `alpha` values for other Signers.

use crate::{Pczt, common::Global};

pub mod orchard;
pub mod sapling;
pub mod transparent;

pub struct Redactor {
    pczt: Pczt,
}

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

    /// Redacts the global transaction details with the given closure.
    pub fn redact_global_with<F>(mut self, f: F) -> Self
    where
        F: FnOnce(GlobalRedactor<'_>),
    {
        f(GlobalRedactor(&mut self.pczt.global));
        self
    }

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

/// An Redactor for the global transaction details.
pub struct GlobalRedactor<'a>(&'a mut Global);

impl GlobalRedactor<'_> {
    /// Redacts the proprietary value at the given key.
    pub fn redact_proprietary(&mut self, key: &str) {
        self.0.proprietary.remove(key);
    }

    /// Removes all proprietary values.
    pub fn clear_proprietary(&mut self) {
        self.0.proprietary.clear();
    }
}