near-primitives 0.35.0

This crate provides the base set of primitives used by other nearcore crates
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use crate::merkle::MerklePath;
use crate::types::StaticSignatureDifferentiator;
use crate::validator_signer::ValidatorSigner;
use near_crypto::{PublicKey, Signature};
use near_primitives_core::hash::CryptoHash;
use near_primitives_core::types::{AccountId, MerkleHash, ShardId};

#[derive(borsh::BorshSerialize, borsh::BorshDeserialize, Debug, Clone, PartialEq, Eq, Hash)]
pub enum SpiceDataIdentifier {
    ReceiptProof { block_hash: CryptoHash, from_shard_id: ShardId, to_shard_id: ShardId },
    Witness { block_hash: CryptoHash, shard_id: ShardId },
}

impl SpiceDataIdentifier {
    pub fn block_hash(&self) -> &CryptoHash {
        match self {
            SpiceDataIdentifier::ReceiptProof { block_hash, .. } => block_hash,
            SpiceDataIdentifier::Witness { block_hash, .. } => block_hash,
        }
    }
}

#[derive(borsh::BorshSerialize, borsh::BorshDeserialize, Debug, Clone, PartialEq, Eq, Hash)]
pub struct SpiceDataCommitment {
    pub hash: CryptoHash,
    pub root: MerkleHash,
    pub encoded_length: u64,
}

#[derive(borsh::BorshSerialize, borsh::BorshDeserialize, Debug, Clone, PartialEq, Eq)]
pub struct SpiceDataPart {
    pub part_ord: u64,
    pub part: Box<[u8]>,
    pub merkle_proof: MerklePath,
}

// TODO(spice): Version this struct since it is sent over the network.
/// Partial data for spice with unverified signature.
#[derive(borsh::BorshSerialize, borsh::BorshDeserialize, Debug, Clone, PartialEq, Eq)]
pub struct SpicePartialData {
    inner: SpicePartialDataInner,
    sender: AccountId,
    signature: Signature,
}

impl SpicePartialData {
    pub fn new(
        id: SpiceDataIdentifier,
        commitment: SpiceDataCommitment,
        parts: Vec<SpiceDataPart>,
        signer: &ValidatorSigner,
    ) -> Self {
        let inner = SpicePartialDataInner { id, commitment, parts };
        let signature = signer.sign_bytes(&inner.serialize_for_signing());
        Self { inner, signature, sender: signer.validator_id().clone() }
    }

    pub fn block_hash(&self) -> &CryptoHash {
        self.inner.id.block_hash()
    }

    pub fn sender(&self) -> &AccountId {
        &self.sender
    }

    pub fn into_verified(self, public_key: &PublicKey) -> Option<SpiceVerifiedPartialData> {
        let data = self.inner.serialize_for_signing();
        if !self.signature.verify(&data, public_key) {
            return None;
        }
        Some(SpiceVerifiedPartialData {
            id: self.inner.id,
            commitment: self.inner.commitment,
            parts: self.inner.parts,
            sender: self.sender,
        })
    }
}

#[derive(borsh::BorshSerialize, borsh::BorshDeserialize, Debug, Clone, PartialEq, Eq)]
struct SpicePartialDataInner {
    // We include id to allow finding recipients and producers when receiving the data.
    id: SpiceDataIdentifier,
    commitment: SpiceDataCommitment,
    parts: Vec<SpiceDataPart>,
}

impl SpicePartialDataInner {
    fn serialize_for_signing(&self) -> Vec<u8> {
        static SIGNATURE_DIFFERENTIATOR: StaticSignatureDifferentiator = "SpicePartialData";
        let data = (self, SIGNATURE_DIFFERENTIATOR);
        borsh::to_vec(&data).unwrap()
    }
}

/// Spice partial data with verified signature.
#[derive(borsh::BorshSerialize, borsh::BorshDeserialize, Debug, Clone, PartialEq, Eq)]
pub struct SpiceVerifiedPartialData {
    pub id: SpiceDataIdentifier,
    pub commitment: SpiceDataCommitment,
    pub parts: Vec<SpiceDataPart>,
    pub sender: AccountId,
}

// Outside of tests it should be impossible to create spice partial data with invalid signature.
pub fn testonly_create_spice_partial_data(
    id: SpiceDataIdentifier,
    commitment: SpiceDataCommitment,
    parts: Vec<SpiceDataPart>,
    signature: Signature,
    sender: AccountId,
) -> SpicePartialData {
    SpicePartialData { inner: SpicePartialDataInner { id, commitment, parts }, signature, sender }
}