zcash_primitives 0.23.1

Rust implementations of the Zcash primitives
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

use blake2b_simd::Hash as Blake2bHash;

use super::{
    sighash_v4::v4_signature_hash, sighash_v5::v5_signature_hash, Authorization, TransactionData,
    TxDigests, TxVersion,
};
use ::sapling::bundle::GrothProofBytes;

#[cfg(zcash_unstable = "zfuture")]
use {crate::extensions::transparent::Precondition, zcash_protocol::value::Zatoshis};

#[deprecated(note = "use `::zcash_transparent::sighash::SIGHASH_ALL` instead.")]
pub const SIGHASH_ALL: u8 = ::transparent::sighash::SIGHASH_ALL;
#[deprecated(note = "use `::zcash_transparent::sighash::SIGHASH_NONE` instead.")]
pub const SIGHASH_NONE: u8 = ::transparent::sighash::SIGHASH_NONE;
#[deprecated(note = "use `::zcash_transparent::sighash::SIGHASH_SINGLE` instead.")]
pub const SIGHASH_SINGLE: u8 = ::transparent::sighash::SIGHASH_SINGLE;
#[deprecated(note = "use `::zcash_transparent::sighash::SIGHASH_MASK` instead.")]
pub const SIGHASH_MASK: u8 = ::transparent::sighash::SIGHASH_MASK;
#[deprecated(note = "use `::zcash_transparent::sighash::SIGHASH_ANYONECANPAY` instead.")]
pub const SIGHASH_ANYONECANPAY: u8 = ::transparent::sighash::SIGHASH_ANYONECANPAY;

#[deprecated(note = "use `::zcash_transparent::sighash::SighashType` instead.")]
pub type SighashType = ::transparent::sighash::SighashType;

pub enum SignableInput<'a> {
    Shielded,
    Transparent(transparent::sighash::SignableInput<'a>),
    #[cfg(zcash_unstable = "zfuture")]
    Tze {
        index: usize,
        precondition: &'a Precondition,
        value: Zatoshis,
    },
}

impl SignableInput<'_> {
    pub fn hash_type(&self) -> u8 {
        match self {
            SignableInput::Shielded => ::transparent::sighash::SIGHASH_ALL,
            SignableInput::Transparent(input) => input.hash_type().encode(),
            #[cfg(zcash_unstable = "zfuture")]
            SignableInput::Tze { .. } => ::transparent::sighash::SIGHASH_ALL,
        }
    }
}

pub struct SignatureHash(Blake2bHash);

impl AsRef<[u8; 32]> for SignatureHash {
    fn as_ref(&self) -> &[u8; 32] {
        self.0.as_ref().try_into().unwrap()
    }
}

/// Computes the signature hash for an input to a transaction, given
/// the full data of the transaction, the input being signed, and the
/// set of precomputed hashes produced in the construction of the
/// transaction ID.
pub fn signature_hash<
    TA: ::transparent::sighash::TransparentAuthorizingContext,
    SA: sapling::bundle::Authorization<SpendProof = GrothProofBytes, OutputProof = GrothProofBytes>,
    A: Authorization<SaplingAuth = SA, TransparentAuth = TA>,
>(
    tx: &TransactionData<A>,
    signable_input: &SignableInput,
    txid_parts: &TxDigests<Blake2bHash>,
) -> SignatureHash {
    SignatureHash(match tx.version {
        TxVersion::Sprout(_) | TxVersion::V3 | TxVersion::V4 => {
            v4_signature_hash(tx, signable_input)
        }

        TxVersion::V5 => v5_signature_hash(tx, signable_input, txid_parts),

        #[cfg(zcash_unstable = "nu7")]
        TxVersion::V6 => todo!(),
        #[cfg(zcash_unstable = "zfuture")]
        TxVersion::ZFuture => v5_signature_hash(tx, signable_input, txid_parts),
    })
}