tendermint/merkle/
proof.rs

1//! Merkle proofs
2
3use serde::{Deserialize, Serialize};
4use tendermint_proto::v0_37::crypto::Proof as RawProof;
5
6use crate::{prelude::*, serializers, Hash};
7
8#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
9#[serde(try_from = "RawProof", into = "RawProof")]
10pub struct Proof {
11    // Total number of items.
12    pub total: u64,
13    // Index of the item to prove.
14    pub index: u64,
15    // Hash of item value.
16    pub leaf_hash: Hash,
17    // Hashes from leaf's sibling to a root's child.
18    pub aunts: Vec<Hash>,
19}
20
21/// Merkle proof defined by the list of ProofOps
22/// <https://github.com/tendermint/tendermint/blob/c8483531d8e756f7fbb812db1dd16d841cdf298a/crypto/merkle/merkle.proto#L26>
23#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
24pub struct ProofOps {
25    /// The list of ProofOps
26    pub ops: Vec<ProofOp>,
27}
28
29/// ProofOp defines an operation used for calculating Merkle root
30/// The data could be arbitrary format, providing necessary data
31/// for example neighbouring node hash
32/// <https://github.com/tendermint/tendermint/blob/c8483531d8e756f7fbb812db1dd16d841cdf298a/crypto/merkle/merkle.proto#L19>
33#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
34pub struct ProofOp {
35    /// Type of the ProofOp
36    #[serde(alias = "type")]
37    pub field_type: String,
38    /// Key of the ProofOp
39    #[serde(default, with = "serializers::bytes::base64string")]
40    pub key: Vec<u8>,
41    /// Actual data
42    #[serde(default, with = "serializers::bytes::base64string")]
43    pub data: Vec<u8>,
44}
45
46// =============================================================================
47// Protobuf conversions
48// =============================================================================
49
50tendermint_pb_modules! {
51    use super::{Proof, ProofOp, ProofOps};
52    use crate::{prelude::*, Error};
53    use pb::{
54        crypto::{Proof as RawProof, ProofOp as RawProofOp, ProofOps as RawProofOps},
55    };
56
57    impl Protobuf<RawProof> for Proof {}
58
59    impl TryFrom<RawProof> for Proof {
60        type Error = Error;
61
62        fn try_from(message: RawProof) -> Result<Self, Self::Error> {
63            Ok(Self {
64                total: message
65                    .total
66                    .try_into()
67                    .map_err(Error::negative_proof_total)?,
68                index: message
69                    .index
70                    .try_into()
71                    .map_err(Error::negative_proof_index)?,
72                leaf_hash: message.leaf_hash.try_into()?,
73                aunts: message
74                    .aunts
75                    .into_iter()
76                    .map(TryInto::try_into)
77                    .collect::<Result<_, _>>()?,
78            })
79        }
80    }
81
82    impl From<Proof> for RawProof {
83        fn from(value: Proof) -> Self {
84            Self {
85                total: value
86                    .total
87                    .try_into()
88                    .expect("number of items is too large"),
89                index: value.index.try_into().expect("index is too large"),
90                leaf_hash: value.leaf_hash.into(),
91                aunts: value.aunts.into_iter().map(Into::into).collect(),
92            }
93        }
94    }
95
96    impl Protobuf<RawProofOp> for ProofOp {}
97
98    impl TryFrom<RawProofOp> for ProofOp {
99        type Error = Error;
100
101        fn try_from(value: RawProofOp) -> Result<Self, Self::Error> {
102            Ok(Self {
103                field_type: value.r#type,
104                key: value.key,
105                data: value.data,
106            })
107        }
108    }
109
110    impl From<ProofOp> for RawProofOp {
111        fn from(value: ProofOp) -> Self {
112            RawProofOp {
113                r#type: value.field_type,
114                key: value.key,
115                data: value.data,
116            }
117        }
118    }
119
120    impl Protobuf<RawProofOps> for ProofOps {}
121
122    impl TryFrom<RawProofOps> for ProofOps {
123        type Error = Error;
124
125        fn try_from(value: RawProofOps) -> Result<Self, Self::Error> {
126            let ops: Result<Vec<ProofOp>, _> = value.ops.into_iter().map(ProofOp::try_from).collect();
127
128            Ok(Self { ops: ops? })
129        }
130    }
131
132    impl From<ProofOps> for RawProofOps {
133        fn from(value: ProofOps) -> Self {
134            let ops: Vec<RawProofOp> = value.ops.into_iter().map(RawProofOp::from).collect();
135
136            RawProofOps { ops }
137        }
138    }
139}
140
141#[cfg(test)]
142mod test {
143    use super::ProofOps;
144    use crate::test::test_serialization_roundtrip;
145
146    #[test]
147    fn serialization_roundtrip() {
148        let payload = r#"
149        {
150            "ops": [
151                {
152                    "type": "iavl:v",
153                    "key": "Y29uc2Vuc3VzU3RhdGUvaWJjb25lY2xpZW50LzIy",
154                    "data": "8QEK7gEKKAgIEAwYHCIgG9RAkJgHlxNjmyzOW6bUAidhiRSja0x6+GXCVENPG1oKKAgGEAUYFyIgwRns+dJvjf1Zk2BaFrXz8inPbvYHB7xx2HCy9ima5f8KKAgEEAMYFyogOr8EGajEV6fG5fzJ2fAAvVMgRLhdMJTzCPlogl9rxlIKKAgCEAIYFyIgcjzX/a+2bFbnNldpawQqZ+kYhIwz5r4wCUzuu1IFW04aRAoeY29uc2Vuc3VzU3RhdGUvaWJjb25lY2xpZW50LzIyEiAZ1uuG60K4NHJZZMuS9QX6o4eEhica5jIHYwflRiYkDBgX"
155                },
156                {
157                    "type": "multistore",
158                    "key": "aWJj",
159                    "data": "CvEECjAKBGJhbmsSKAomCIjYAxIg2MEyyonbZButYnvSRkf2bPQg+nqA+Am1MeDxG6F4p1UKLwoDYWNjEigKJgiI2AMSIN2YHczeuXNvyetrSFQpkCcJzfB6PXVCw0i/XShMgPnIChEKB3VwZ3JhZGUSBgoECIjYAwovCgNnb3YSKAomCIjYAxIgYM0TfBli7KxhY4nWgDSDPykhUJwtKFql9RU5l86WinQKLwoDaWJjEigKJgiI2AMSIFp6aJASeInQKF8y824zjmgcFORN6M+ECbgFfJkobKs8CjAKBG1haW4SKAomCIjYAxIgsZzwmLQ7PH1UeZ/vCUSqlQmfgt3CGfoMgJLkUqKCv0EKMwoHc3Rha2luZxIoCiYIiNgDEiCiBZoBLyDGj5euy3n33ik+SpqYK9eB5xbI+iY8ycYVbwo0CghzbGFzaGluZxIoCiYIiNgDEiAJz3gEYuIhdensHU3b5qH5ons2quepd6EaRgCHXab6PQoyCgZzdXBwbHkSKAomCIjYAxIglWLA5/THPTiTxAlaLHOBYFIzEJTmKPznItUwAc8zD+AKEgoIZXZpZGVuY2USBgoECIjYAwowCgRtaW50EigKJgiI2AMSIMS8dZ1j8F6JVVv+hB1rHBZC+gIFJxHan2hM8qDC64n/CjIKBnBhcmFtcxIoCiYIiNgDEiB8VIzExUHX+SvHZFz/P9NM9THnw/gTDDLVReuZX8htLgo4CgxkaXN0cmlidXRpb24SKAomCIjYAxIg3u/Nd4L+8LT8OXJCh14o8PHIJ/GLQwsmE7KYIl1GdSYKEgoIdHJhbnNmZXISBgoECIjYAw=="
160                }
161            ]
162        }"#;
163        test_serialization_roundtrip::<ProofOps>(payload);
164    }
165}
tendermint/merkle/proof.rs

tendermint/merkle/
proof.rs
