Skip to main content

celestia_types/
extended_header.rs

1use std::fmt::{Display, Formatter};
2#[cfg(any(
3    not(any(target_arch = "wasm32", target_arch = "riscv32")),
4    feature = "wasm-bindgen"
5))]
6use std::time::Duration;
7
8use celestia_proto::header::pb::ExtendedHeader as RawExtendedHeader;
9use serde::{Deserialize, Deserializer, Serialize, Serializer};
10#[cfg(all(feature = "wasm-bindgen", target_arch = "wasm32"))]
11use serde_wasm_bindgen::to_value;
12use tendermint::block::Commit;
13use tendermint::block::header::Header;
14use tendermint::chain::id::Id;
15use tendermint::{Time, validator};
16use tendermint_proto::Protobuf;
17#[cfg(all(feature = "wasm-bindgen", target_arch = "wasm32"))]
18use wasm_bindgen::prelude::*;
19
20use crate::hash::Hash;
21use crate::trust_level::DEFAULT_TRUST_LEVEL;
22use crate::validator_set::ValidatorSetExt;
23use crate::{
24    DataAvailabilityHeader, Error, Result, ValidateBasic, bail_validation, bail_verification,
25};
26
27/// Information about a tendermint validator.
28pub type Validator = validator::Info;
29/// A collection of the tendermint validators.
30pub type ValidatorSet = validator::Set;
31
32#[cfg(any(
33    not(any(target_arch = "wasm32", target_arch = "riscv32")),
34    feature = "wasm-bindgen"
35))]
36const VERIFY_CLOCK_DRIFT: Duration = Duration::from_secs(10);
37
38/// Block header together with the relevant Data Availability metadata.
39///
40/// [`ExtendedHeader`]s are used to announce and describe the blocks
41/// in the Celestia network.
42///
43/// Before being used, each header should be validated and verified with a header you trust.
44///
45/// # Example
46///
47/// ```
48/// # use celestia_types::ExtendedHeader;
49/// # fn trusted_genesis_header() -> ExtendedHeader {
50/// #     let s = include_str!("../test_data/chain1/extended_header_block_1.json");
51/// #     serde_json::from_str(s).unwrap()
52/// # }
53/// # fn some_untrusted_header() -> ExtendedHeader {
54/// #     let s = include_str!("../test_data/chain1/extended_header_block_27.json");
55/// #     serde_json::from_str(s).unwrap()
56/// # }
57/// let genesis_header = trusted_genesis_header();
58///
59/// // fetch new header
60/// let fetched_header = some_untrusted_header();
61///
62/// fetched_header.validate().expect("Invalid block header");
63/// genesis_header.verify(&fetched_header).expect("Malicious header received");
64/// ```
65#[derive(Debug, Clone, PartialEq, Eq)]
66#[cfg_attr(
67    all(feature = "wasm-bindgen", target_arch = "wasm32"),
68    wasm_bindgen(inspectable)
69)]
70pub struct ExtendedHeader {
71    /// Tendermint block header.
72    #[cfg_attr(
73        all(feature = "wasm-bindgen", target_arch = "wasm32"),
74        wasm_bindgen(skip)
75    )]
76    pub header: Header,
77    /// Commit metadata and signatures from validators committing the block.
78    #[cfg_attr(
79        all(feature = "wasm-bindgen", target_arch = "wasm32"),
80        wasm_bindgen(skip)
81    )]
82    pub commit: Commit,
83    /// Information about the set of validators commiting the block.
84    #[cfg_attr(
85        all(feature = "wasm-bindgen", target_arch = "wasm32"),
86        wasm_bindgen(skip)
87    )]
88    pub validator_set: ValidatorSet,
89    /// Header of the block data availability.
90    #[cfg_attr(
91        all(feature = "wasm-bindgen", target_arch = "wasm32"),
92        wasm_bindgen(getter_with_clone)
93    )]
94    pub dah: DataAvailabilityHeader,
95}
96
97impl Display for ExtendedHeader {
98    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
99        write!(f, "hash: {}; height: {}", self.hash(), self.height())
100    }
101}
102
103impl ExtendedHeader {
104    /// Decode protobuf encoded header and then validate it.
105    pub fn decode_and_validate(bytes: &[u8]) -> Result<Self> {
106        let header = ExtendedHeader::decode(bytes)?;
107        header.validate()?;
108        Ok(header)
109    }
110
111    /// Get the app version.
112    pub fn app_version(&self) -> u64 {
113        self.header.version.app
114    }
115
116    /// Get the block chain id.
117    pub fn chain_id(&self) -> &Id {
118        &self.header.chain_id
119    }
120
121    /// Get the block height.
122    pub fn height(&self) -> u64 {
123        self.header.height.value()
124    }
125
126    /// Get the block time.
127    pub fn time(&self) -> Time {
128        self.header.time
129    }
130
131    /// Get the block hash.
132    pub fn hash(&self) -> Hash {
133        self.commit.block_id.hash
134    }
135
136    /// Get the hash of the previous header.
137    pub fn last_header_hash(&self) -> Hash {
138        self.header
139            .last_block_id
140            .map(|block_id| block_id.hash)
141            .unwrap_or_default()
142    }
143
144    /// Get the block's extended data square width.
145    pub fn square_width(&self) -> u16 {
146        self.dah.square_width()
147    }
148
149    /// Validate header.
150    ///
151    /// Performs a consistency check of the data included in the header.
152    ///
153    /// # Errors
154    ///
155    /// If validation fails, this function will return an error with a reason of failure.
156    ///
157    /// ```
158    /// # use celestia_types::{ExtendedHeader, DataAvailabilityHeader};
159    /// #
160    /// # fn get_header(_: usize) -> ExtendedHeader {
161    /// #     let s = include_str!("../test_data/chain1/extended_header_block_27.json");
162    /// #     serde_json::from_str(s).unwrap()
163    /// # }
164    /// // fetch new header
165    /// let mut fetched_header = get_header(15);
166    ///
167    /// assert!(fetched_header.validate().is_ok());
168    ///
169    /// fetched_header.dah = DataAvailabilityHeader::new_unchecked(vec![], vec![]);
170    ///
171    /// assert!(fetched_header.validate().is_err());
172    /// ```
173    pub fn validate(&self) -> Result<()> {
174        self.header.validate_basic()?;
175        self.commit.validate_basic()?;
176        self.validator_set.validate_basic()?;
177
178        // make sure the validator set is consistent with the header
179        if self.validator_set.hash() != self.header.validators_hash {
180            bail_validation!(
181                "validator_set hash ({}) != header validators_hash ({})",
182                self.validator_set.hash(),
183                self.header.validators_hash,
184            )
185        }
186
187        // ensure data root from raw header matches computed root
188        if self.dah.hash() != self.header.data_hash.unwrap_or_default() {
189            bail_validation!(
190                "dah hash ({}) != header dah hash ({})",
191                self.dah.hash(),
192                self.header.data_hash.unwrap_or_default(),
193            )
194        }
195
196        // Make sure the header is consistent with the commit.
197        if self.commit.height.value() != self.height() {
198            bail_validation!(
199                "commit height ({}) != header height ({})",
200                self.commit.height,
201                self.height(),
202            )
203        }
204
205        if self.commit.block_id.hash != self.header.hash() {
206            bail_validation!(
207                "commit block_id hash ({}) != header hash ({})",
208                self.commit.block_id.hash,
209                self.header.hash(),
210            )
211        }
212
213        self.validator_set.verify_commit_light(
214            &self.header.chain_id,
215            &self.header.height,
216            &self.commit,
217        )?;
218
219        self.dah.validate_basic()?;
220
221        Ok(())
222    }
223
224    /// Verify an untrusted header.
225    ///
226    /// Ensures that the untrusted header can be trusted by verifying it against `self`.
227    ///
228    /// # Note
229    ///
230    /// This method does not do validation for optimization purposes.
231    /// Validation should be done from before and ideally with
232    /// [`ExtendedHeader::decode_and_validate`].
233    ///
234    /// # Errors
235    ///
236    /// If verification fails, this function will return an error with a reason of failure.
237    ///
238    /// Please note that if verifying unadjacent headers, the verification will always
239    /// fail if the validator set commiting those blocks was changed. If that is the case,
240    /// consider verifying the untrusted header with a more recent or even previous header.
241    pub fn verify(&self, untrusted: &ExtendedHeader) -> Result<()> {
242        if untrusted.height() <= self.height() {
243            bail_verification!(
244                "untrusted header height({}) <= current trusted header({})",
245                untrusted.height(),
246                self.height()
247            );
248        }
249
250        if untrusted.chain_id() != self.chain_id() {
251            bail_verification!(
252                "untrusted header has different chain {}, not {}",
253                untrusted.chain_id(),
254                self.chain_id()
255            );
256        }
257
258        if !untrusted.time().after(self.time()) {
259            bail_verification!(
260                "untrusted header time ({}) must be after current trusted header ({})",
261                untrusted.time(),
262                self.time()
263            );
264        }
265
266        #[cfg(any(
267            not(any(target_arch = "wasm32", target_arch = "riscv32")),
268            feature = "wasm-bindgen"
269        ))]
270        {
271            let now = Time::now();
272            let valid_until = now.checked_add(VERIFY_CLOCK_DRIFT).unwrap();
273
274            if !untrusted.time().before(valid_until) {
275                bail_verification!(
276                    "new untrusted header has a time from the future {} (now: {}, clock_drift: {:?})",
277                    untrusted.time(),
278                    now,
279                    VERIFY_CLOCK_DRIFT
280                );
281            }
282        }
283
284        // Optimization: If we are verifying an adjacent header we can avoid
285        // `verify_commit_light_trusting` because we can just check the hash
286        // of next validators and last header.
287        if self.height() + 1 == untrusted.height() {
288            if untrusted.header.validators_hash != self.header.next_validators_hash {
289                bail_verification!(
290                    "expected old header next validators ({}) to match those from new header ({})",
291                    self.header.next_validators_hash,
292                    untrusted.header.validators_hash,
293                );
294            }
295
296            if untrusted.last_header_hash() != self.hash() {
297                bail_verification!(
298                    "expected new header to point to last header hash ({}), but got {}",
299                    self.hash(),
300                    untrusted.last_header_hash()
301                );
302            }
303
304            return Ok(());
305        }
306
307        self.validator_set.verify_commit_light_trusting(
308            self.chain_id(),
309            &untrusted.commit,
310            DEFAULT_TRUST_LEVEL,
311        )?;
312
313        Ok(())
314    }
315
316    /// Verify an untrusted header and make sure they are adjacent to `self`.
317    ///
318    /// Ensures that the untrusted header is adjacent and can be trusted
319    /// by verifying it against `self`.
320    ///
321    /// # Note
322    ///
323    /// This method does not do validation for optimization purposes.
324    /// Validation should be done from before and ideally with
325    /// [`ExtendedHeader::decode_and_validate`].
326    ///
327    /// # Errors
328    ///
329    /// If verification fails, this function will return an error with a reason of failure.
330    pub fn verify_adjacent(&self, untrusted: &ExtendedHeader) -> Result<()> {
331        // Check is first untrusted is adjacent to `self`.
332        if self.height() + 1 != untrusted.height() {
333            bail_verification!(
334                "untrusted header height ({}) not adjacent to the current trusted ({})",
335                untrusted.height(),
336                self.height(),
337            );
338        }
339
340        self.verify(untrusted)
341    }
342
343    /// Verify a chain of adjacent untrusted headers.
344    ///
345    /// # Note
346    ///
347    /// This method does not do validation for optimization purposes.
348    /// Validation should be done from before and ideally with
349    /// [`ExtendedHeader::decode_and_validate`].
350    ///
351    /// # Errors
352    ///
353    /// If verification fails, this function will return an error with a reason of failure.
354    /// This function will also return an error if untrusted headers are not adjacent
355    /// to each other.
356    ///
357    /// # Example
358    ///
359    /// ```
360    /// # use std::ops::Range;
361    /// # use celestia_types::ExtendedHeader;
362    /// # let s = include_str!("../test_data/chain3/extended_header_block_1_to_256.json");
363    /// # let headers: Vec<ExtendedHeader> = serde_json::from_str(s).unwrap();
364    /// # let trusted_genesis = || headers[0].clone();
365    /// # // substract one as heights start from 1
366    /// # let get_headers_range = |r: Range<usize>| (&headers[r.start - 1..r.end - 1]).to_vec();
367    /// let genesis_header = trusted_genesis();
368    /// let next_headers = get_headers_range(5..50);
369    ///
370    /// assert!(genesis_header.verify_range(&next_headers).is_ok());
371    /// ```
372    pub fn verify_range(&self, untrusted: &[ExtendedHeader]) -> Result<()> {
373        let mut trusted = self;
374
375        for (i, untrusted) in untrusted.iter().enumerate() {
376            // All headers in `untrusted` must be adjacent to their previous
377            // one. However we do not check if the first untrusted is adjacent
378            // to `self`. This check is done in `verify_adjacent_range`.
379            if i != 0 && trusted.height() + 1 != untrusted.height() {
380                bail_verification!(
381                    "untrusted header height ({}) not adjacent to the current trusted ({})",
382                    untrusted.height(),
383                    trusted.height(),
384                );
385            }
386
387            trusted.verify(untrusted)?;
388            trusted = untrusted;
389        }
390
391        Ok(())
392    }
393
394    /// Verify a chain of adjacent untrusted headers and make sure
395    /// they are adjacent to `self`.
396    ///
397    /// # Note
398    ///
399    /// This method does not do validation for optimization purposes.
400    /// Validation should be done from before and ideally with
401    /// [`ExtendedHeader::decode_and_validate`].
402    ///
403    /// # Errors
404    ///
405    /// If verification fails, this function will return an error with a reason of failure.
406    /// This function will also return an error if untrusted headers and `self` don't form contiguous range
407    ///
408    /// # Example
409    ///
410    /// ```
411    /// # use std::ops::Range;
412    /// # use celestia_types::ExtendedHeader;
413    /// # let s = include_str!("../test_data/chain3/extended_header_block_1_to_256.json");
414    /// # let headers: Vec<ExtendedHeader> = serde_json::from_str(s).unwrap();
415    /// # let trusted_genesis = || headers[0].clone();
416    /// # // substract one as heights start from 1
417    /// # let get_headers_range = |r: Range<usize>| (&headers[r.start - 1..r.end - 1]).to_vec();
418    /// let genesis_header = trusted_genesis();
419    /// let next_headers = get_headers_range(5..50);
420    ///
421    /// // fails, not adjacent to genesis
422    /// assert!(genesis_header.verify_adjacent_range(&next_headers).is_err());
423    ///
424    /// let next_headers = get_headers_range(2..50);
425    ///
426    /// // succeeds
427    /// genesis_header.verify_adjacent_range(&next_headers).unwrap();
428    /// ```
429    pub fn verify_adjacent_range(&self, untrusted: &[ExtendedHeader]) -> Result<()> {
430        if untrusted.is_empty() {
431            return Ok(());
432        }
433
434        // Check is first untrusted is adjacent to `self`.
435        if self.height() + 1 != untrusted[0].height() {
436            bail_verification!(
437                "untrusted header height ({}) not adjacent to the current trusted ({})",
438                untrusted[0].height(),
439                self.height(),
440            );
441        }
442
443        self.verify_range(untrusted)
444    }
445}
446
447#[cfg(all(feature = "wasm-bindgen", target_arch = "wasm32"))]
448#[wasm_bindgen]
449impl ExtendedHeader {
450    /// Clone a header producing a deep copy of it.
451    #[wasm_bindgen(js_name = clone)]
452    pub fn js_clone(&self) -> Self {
453        self.clone()
454    }
455
456    /// Get the block height.
457    #[wasm_bindgen(js_name = height)]
458    pub fn js_height(&self) -> u64 {
459        self.height()
460    }
461
462    /// Get the block time.
463    #[wasm_bindgen(js_name = time)]
464    pub fn js_time(&self) -> Result<f64, JsValue> {
465        Ok(self
466            .time()
467            .duration_since(Time::unix_epoch())
468            .map_err(|e| JsError::new(&e.to_string()))?
469            .as_secs_f64()
470            * 1000.0)
471    }
472
473    /// Get the block hash.
474    #[wasm_bindgen(js_name = hash)]
475    pub fn js_hash(&self) -> String {
476        self.hash().to_string()
477    }
478
479    /// Get the hash of the previous header.
480    #[wasm_bindgen(js_name = previousHeaderHash)]
481    pub fn js_previous_header_hash(&self) -> String {
482        self.last_header_hash().to_string()
483    }
484
485    /// Tendermint block header.
486    #[wasm_bindgen(getter, js_name = header)]
487    pub fn js_header(&self) -> Result<JsValue, serde_wasm_bindgen::Error> {
488        to_value(&self.header)
489    }
490
491    /// Commit metadata and signatures from validators committing the block.
492    #[wasm_bindgen(getter, js_name = commit)]
493    pub fn js_commit(&self) -> Result<JsValue, serde_wasm_bindgen::Error> {
494        to_value(&self.commit)
495    }
496
497    /// Information about the set of validators commiting the block.
498    #[wasm_bindgen(getter, js_name = validatorSet)]
499    pub fn js_validator_set(&self) -> Result<JsValue, serde_wasm_bindgen::Error> {
500        to_value(&self.validator_set)
501    }
502
503    /// Decode protobuf encoded header and then validate it.
504    #[wasm_bindgen(js_name = validate)]
505    pub fn js_validate(&self) -> Result<(), JsValue> {
506        Ok(self.validate()?)
507    }
508
509    /// Verify a chain of adjacent untrusted headers and make sure
510    /// they are adjacent to `self`.
511    ///
512    /// # Errors
513    ///
514    /// If verification fails, this function will return an error with a reason of failure.
515    /// This function will also return an error if untrusted headers and `self` don't form contiguous range
516    #[wasm_bindgen(js_name = verify)]
517    pub fn js_verify(&self, untrusted: &ExtendedHeader) -> Result<(), JsValue> {
518        Ok(self.verify(untrusted)?)
519    }
520
521    /// Verify a chain of adjacent untrusted headers.
522    ///
523    /// # Note
524    ///
525    /// Provided headers will be consumed by this method, meaning
526    /// they will no longer be accessible. If this behavior is not desired,
527    /// consider using `ExtendedHeader.clone()`.
528    ///
529    /// ```js
530    /// const genesis = hdr0;
531    /// const headers = [hrd1, hdr2, hdr3];
532    /// genesis.verifyRange(headers.map(h => h.clone()));
533    /// ```
534    ///
535    /// # Errors
536    ///
537    /// If verification fails, this function will return an error with a reason of failure.
538    /// This function will also return an error if untrusted headers are not adjacent
539    /// to each other.
540    #[wasm_bindgen(js_name = verifyRange)]
541    pub fn js_verify_range(&self, untrusted: Vec<ExtendedHeader>) -> Result<(), JsValue> {
542        Ok(self.verify_range(&untrusted)?)
543    }
544
545    /// Verify a chain of adjacent untrusted headers and make sure
546    /// they are adjacent to `self`.
547    ///
548    /// # Note
549    ///
550    /// Provided headers will be consumed by this method, meaning
551    /// they will no longer be accessible. If this behavior is not desired,
552    /// consider using `ExtendedHeader.clone()`.
553    ///
554    /// ```js
555    /// const genesis = hdr0;
556    /// const headers = [hrd1, hdr2, hdr3];
557    /// genesis.verifyAdjacentRange(headers.map(h => h.clone()));
558    /// ```
559    ///
560    /// # Errors
561    ///
562    /// If verification fails, this function will return an error with a reason of failure.
563    /// This function will also return an error if untrusted headers and `self` don't form contiguous range
564    #[wasm_bindgen(js_name = verifyAdjacentRange)]
565    pub fn js_verify_adjacent_range(&self, untrusted: Vec<ExtendedHeader>) -> Result<(), JsValue> {
566        Ok(self.verify_adjacent_range(&untrusted)?)
567    }
568}
569
570impl Protobuf<RawExtendedHeader> for ExtendedHeader {}
571
572impl TryFrom<RawExtendedHeader> for ExtendedHeader {
573    type Error = Error;
574
575    fn try_from(value: RawExtendedHeader) -> Result<Self, Self::Error> {
576        let header = value.header.ok_or(Error::MissingHeader)?.try_into()?;
577        let commit = value.commit.ok_or(Error::MissingCommit)?.try_into()?;
578        let validator_set = value
579            .validator_set
580            .ok_or(Error::MissingValidatorSet)?
581            .try_into()?;
582        let dah = value
583            .dah
584            .ok_or(Error::MissingDataAvailabilityHeader)?
585            .try_into()?;
586
587        let eh = ExtendedHeader {
588            header,
589            commit,
590            validator_set,
591            dah,
592        };
593
594        eh.validate()?;
595
596        Ok(eh)
597    }
598}
599
600impl From<ExtendedHeader> for RawExtendedHeader {
601    fn from(value: ExtendedHeader) -> RawExtendedHeader {
602        RawExtendedHeader {
603            header: Some(value.header.into()),
604            commit: Some(value.commit.into()),
605            validator_set: Some(value.validator_set.into()),
606            dah: Some(value.dah.into()),
607        }
608    }
609}
610
611// TODO: get rid of this after a release or two
612// https://github.com/eigerco/lumina/issues/683
613mod custom_serde {
614    use celestia_proto::celestia::core::v1::da::DataAvailabilityHeader;
615    use celestia_proto::header::pb::ExtendedHeader as RawExtendedHeader;
616    use serde::{Deserialize, Serialize};
617    use tendermint_proto::v0_38::types::Commit as RawCommit;
618    use tendermint_proto::v0_38::types::{BlockId, CommitSig, Header, ValidatorSet};
619
620    #[derive(Deserialize, Serialize)]
621    pub(super) struct SerdeExtendedHeader {
622        header: Option<Header>,
623        commit: Option<SerdeCommit>,
624        validator_set: Option<ValidatorSet>,
625        dah: Option<DataAvailabilityHeader>,
626    }
627
628    #[derive(Deserialize, Serialize)]
629    pub(super) struct SerdeCommit {
630        #[serde(with = "celestia_proto::serializers::maybe_quoted")]
631        height: i64,
632        round: i32,
633        block_id: Option<BlockId>,
634        #[serde(with = "tendermint_proto::serializers::nullable")]
635        signatures: Vec<CommitSig>,
636    }
637
638    impl From<RawExtendedHeader> for SerdeExtendedHeader {
639        fn from(value: RawExtendedHeader) -> Self {
640            SerdeExtendedHeader {
641                header: value.header,
642                commit: value.commit.map(|commit| commit.into()),
643                validator_set: value.validator_set,
644                dah: value.dah,
645            }
646        }
647    }
648
649    impl From<SerdeExtendedHeader> for RawExtendedHeader {
650        fn from(value: SerdeExtendedHeader) -> Self {
651            RawExtendedHeader {
652                header: value.header,
653                commit: value.commit.map(|commit| commit.into()),
654                validator_set: value.validator_set,
655                dah: value.dah,
656            }
657        }
658    }
659
660    impl From<RawCommit> for SerdeCommit {
661        fn from(value: RawCommit) -> Self {
662            SerdeCommit {
663                height: value.height,
664                round: value.round,
665                block_id: value.block_id,
666                signatures: value.signatures,
667            }
668        }
669    }
670
671    impl From<SerdeCommit> for RawCommit {
672        fn from(value: SerdeCommit) -> Self {
673            RawCommit {
674                height: value.height,
675                round: value.round,
676                block_id: value.block_id,
677                signatures: value.signatures,
678            }
679        }
680    }
681
682    #[cfg(test)]
683    mod tests {
684        use super::SerdeCommit;
685
686        #[test]
687        fn deserialize_quoted_and_unquoted_commit_height() {
688            let unquoted = r#"{
689                "height": 27,
690                "round": 0,
691                "block_id": {
692                  "hash": "6F754536418C0574629379BA6F145C62C86DAEAA8F5772FA1AD5D5AEB4FE5B97",
693                  "parts": {
694                    "total": 1,
695                    "hash": "791BF8972B46DA4582779629D7E3D925510178D3930A4F6CA82FB88636FDA2C6"
696                  }
697                },
698                "signatures": [
699                  {
700                    "block_id_flag": 2,
701                    "validator_address": "F1F83230835AA69A1AD6EA68C6D894A4106B8E53",
702                    "timestamp": "2023-06-23T10:47:18.421006821Z",
703                    "signature": "/2U/PzplnCuSi2jjlOxCdwfVh2+wPQZQoWYOH/AMzwR1iQ/G68yxmamZbaen2c4Z06KUVJMcP7WtbBKtciy5AA=="
704                  }
705                ]
706            }"#;
707            serde_json::from_str::<SerdeCommit>(unquoted).unwrap();
708
709            let quoted = r#"{
710                "height": "27",
711                "round": 0,
712                "block_id": {
713                  "hash": "6F754536418C0574629379BA6F145C62C86DAEAA8F5772FA1AD5D5AEB4FE5B97",
714                  "parts": {
715                    "total": 1,
716                    "hash": "791BF8972B46DA4582779629D7E3D925510178D3930A4F6CA82FB88636FDA2C6"
717                  }
718                },
719                "signatures": [
720                  {
721                    "block_id_flag": 2,
722                    "validator_address": "F1F83230835AA69A1AD6EA68C6D894A4106B8E53",
723                    "timestamp": "2023-06-23T10:47:18.421006821Z",
724                    "signature": "/2U/PzplnCuSi2jjlOxCdwfVh2+wPQZQoWYOH/AMzwR1iQ/G68yxmamZbaen2c4Z06KUVJMcP7WtbBKtciy5AA=="
725                  }
726                ]
727            }"#;
728            serde_json::from_str::<SerdeCommit>(quoted).unwrap();
729        }
730    }
731}
732
733impl Serialize for ExtendedHeader {
734    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
735    where
736        S: Serializer,
737    {
738        let pb: RawExtendedHeader = self.clone().into();
739        let custom_ser: custom_serde::SerdeExtendedHeader = pb.into();
740        custom_ser.serialize(serializer)
741    }
742}
743
744impl<'de> Deserialize<'de> for ExtendedHeader {
745    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
746    where
747        D: Deserializer<'de>,
748    {
749        let custom_de = custom_serde::SerdeExtendedHeader::deserialize(deserializer)?;
750        let pb: RawExtendedHeader = custom_de.into();
751        ExtendedHeader::try_from(pb).map_err(serde::de::Error::custom)
752    }
753}
754
755#[cfg(test)]
756mod tests {
757    use super::*;
758    use crate::test_utils::{invalidate, unverify};
759
760    #[cfg(target_arch = "wasm32")]
761    use wasm_bindgen_test::wasm_bindgen_test as test;
762
763    fn sample_eh_chain_1_block_1() -> ExtendedHeader {
764        let s = include_str!("../test_data/chain1/extended_header_block_1.json");
765        serde_json::from_str(s).unwrap()
766    }
767
768    fn sample_eh_chain_1_block_27() -> ExtendedHeader {
769        let s = include_str!("../test_data/chain1/extended_header_block_27.json");
770        serde_json::from_str(s).unwrap()
771    }
772
773    fn sample_eh_chain_2_block_1() -> ExtendedHeader {
774        let s = include_str!("../test_data/chain2/extended_header_block_1.json");
775        serde_json::from_str(s).unwrap()
776    }
777
778    fn sample_eh_chain_2_block_27() -> ExtendedHeader {
779        let s = include_str!("../test_data/chain2/extended_header_block_27.json");
780        serde_json::from_str(s).unwrap()
781    }
782
783    fn sample_eh_chain_2_block_28() -> ExtendedHeader {
784        let s = include_str!("../test_data/chain2/extended_header_block_28.json");
785        serde_json::from_str(s).unwrap()
786    }
787
788    fn sample_eh_chain_2_block_35() -> ExtendedHeader {
789        let s = include_str!("../test_data/chain2/extended_header_block_35.json");
790        serde_json::from_str(s).unwrap()
791    }
792
793    fn sample_eh_chain_3_block_1_to_256() -> Vec<ExtendedHeader> {
794        let s = include_str!("../test_data/chain3/extended_header_block_1_to_256.json");
795        serde_json::from_str(s).unwrap()
796    }
797
798    #[test]
799    fn validate_correct() {
800        sample_eh_chain_1_block_1().validate().unwrap();
801        sample_eh_chain_1_block_27().validate().unwrap();
802
803        sample_eh_chain_2_block_1().validate().unwrap();
804        sample_eh_chain_2_block_27().validate().unwrap();
805        sample_eh_chain_2_block_28().validate().unwrap();
806        sample_eh_chain_2_block_35().validate().unwrap();
807    }
808
809    #[test]
810    fn validate_validator_hash_mismatch() {
811        let mut eh = sample_eh_chain_1_block_27();
812        eh.header.validators_hash = Hash::None;
813
814        eh.validate().unwrap_err();
815    }
816
817    #[test]
818    fn validate_dah_hash_mismatch() {
819        let mut eh = sample_eh_chain_1_block_27();
820        eh.header.data_hash = Some(Hash::Sha256([0; 32]));
821
822        eh.validate().unwrap_err();
823    }
824
825    #[test]
826    fn validate_commit_height_mismatch() {
827        let mut eh = sample_eh_chain_1_block_27();
828        eh.commit.height = 0xdeadbeefu32.into();
829
830        eh.validate().unwrap_err();
831    }
832
833    #[test]
834    fn validate_commit_block_hash_mismatch() {
835        let mut eh = sample_eh_chain_1_block_27();
836        eh.commit.block_id.hash = Hash::None;
837
838        eh.validate().unwrap_err();
839    }
840
841    #[test]
842    fn verify() {
843        let eh_block_1 = sample_eh_chain_1_block_1();
844        let eh_block_27 = sample_eh_chain_1_block_27();
845
846        eh_block_1.verify(&eh_block_27).unwrap();
847
848        let eh_block_1 = sample_eh_chain_2_block_1();
849        let eh_block_27 = sample_eh_chain_2_block_27();
850
851        eh_block_1.verify(&eh_block_27).unwrap();
852    }
853
854    #[test]
855    fn verify_adjacent() {
856        let eh_block_27 = sample_eh_chain_2_block_27();
857        let eh_block_28 = sample_eh_chain_2_block_28();
858
859        eh_block_27.verify(&eh_block_28).unwrap();
860    }
861
862    #[test]
863    fn verify_invalid_validator() {
864        let eh_block_27 = sample_eh_chain_2_block_27();
865        let mut eh_block_28 = sample_eh_chain_2_block_28();
866
867        eh_block_28.header.validators_hash = Hash::None;
868
869        eh_block_27.verify(&eh_block_28).unwrap_err();
870    }
871
872    #[test]
873    fn verify_invalid_last_block_hash() {
874        let eh_block_27 = sample_eh_chain_2_block_27();
875        let mut eh_block_28 = sample_eh_chain_2_block_28();
876
877        eh_block_28.header.last_block_id.as_mut().unwrap().hash = Hash::None;
878
879        eh_block_27.verify(&eh_block_28).unwrap_err();
880    }
881
882    #[test]
883    fn verify_invalid_adjacent() {
884        let eh_block_27 = sample_eh_chain_1_block_27();
885        let eh_block_28 = sample_eh_chain_2_block_28();
886
887        eh_block_27.verify(&eh_block_28).unwrap_err();
888    }
889
890    #[test]
891    fn verify_same_chain_id_but_different_chain() {
892        let eh_block_1 = sample_eh_chain_1_block_1();
893        let eh_block_27 = sample_eh_chain_2_block_27();
894
895        eh_block_1.verify(&eh_block_27).unwrap_err();
896    }
897
898    #[test]
899    fn verify_invalid_height() {
900        let eh_block_27 = sample_eh_chain_1_block_27();
901        eh_block_27.verify(&eh_block_27).unwrap_err();
902    }
903
904    #[test]
905    fn verify_invalid_chain_id() {
906        let eh_block_1 = sample_eh_chain_1_block_1();
907        let mut eh_block_27 = sample_eh_chain_1_block_27();
908
909        eh_block_27.header.chain_id = "1112222".parse().unwrap();
910        eh_block_1.verify(&eh_block_27).unwrap_err();
911    }
912
913    #[test]
914    fn verify_invalid_time() {
915        let eh_block_1 = sample_eh_chain_1_block_1();
916        let mut eh_block_27 = sample_eh_chain_1_block_27();
917
918        eh_block_27.header.time = eh_block_1.header.time;
919        eh_block_1.verify(&eh_block_27).unwrap_err();
920    }
921
922    #[test]
923    fn verify_time_from_the_future() {
924        let eh_block_1 = sample_eh_chain_1_block_1();
925        let mut eh_block_27 = sample_eh_chain_1_block_27();
926
927        eh_block_27.header.time = Time::now().checked_add(Duration::from_secs(60)).unwrap();
928        eh_block_1.verify(&eh_block_27).unwrap_err();
929    }
930
931    #[test]
932    fn verify_range() {
933        let eh_chain = sample_eh_chain_3_block_1_to_256();
934
935        eh_chain[0].verify_range(&eh_chain[1..]).unwrap();
936        eh_chain[0].verify_range(&eh_chain[..]).unwrap_err();
937        eh_chain[0].verify_range(&eh_chain[10..]).unwrap();
938
939        eh_chain[10].verify_range(&eh_chain[11..]).unwrap();
940        eh_chain[10].verify_range(&eh_chain[100..]).unwrap();
941        eh_chain[10].verify_range(&eh_chain[..9]).unwrap_err();
942        eh_chain[10].verify_range(&eh_chain[10..]).unwrap_err();
943    }
944
945    #[test]
946    fn verify_range_missing_height() {
947        let eh_chain = sample_eh_chain_3_block_1_to_256();
948
949        let mut headers = eh_chain[10..15].to_vec();
950        headers.remove(2);
951        eh_chain[0].verify_range(&headers).unwrap_err();
952    }
953
954    #[test]
955    fn verify_range_duplicate_height() {
956        let eh_chain = sample_eh_chain_3_block_1_to_256();
957
958        let mut headers = eh_chain[10..15].to_vec();
959        headers.insert(2, eh_chain[12].clone());
960        eh_chain[0].verify_range(&headers).unwrap_err();
961    }
962
963    #[test]
964    fn verify_range_bad_header_in_middle() {
965        let eh_chain = sample_eh_chain_3_block_1_to_256();
966
967        let mut headers = eh_chain[10..15].to_vec();
968
969        unverify(&mut headers[2]);
970
971        eh_chain[0].verify_range(&headers).unwrap_err();
972    }
973
974    #[test]
975    fn verify_range_allow_invalid_header_in_middle() {
976        let eh_chain = sample_eh_chain_3_block_1_to_256();
977
978        let mut headers = eh_chain[10..15].to_vec();
979
980        invalidate(&mut headers[2]);
981
982        eh_chain[0].verify_range(&headers).unwrap();
983    }
984
985    #[test]
986    fn verify_adjacent_range() {
987        let eh_chain = sample_eh_chain_3_block_1_to_256();
988
989        eh_chain[0].verify_adjacent_range(&eh_chain[1..]).unwrap();
990        eh_chain[0]
991            .verify_adjacent_range(&eh_chain[..])
992            .unwrap_err();
993        eh_chain[0]
994            .verify_adjacent_range(&eh_chain[10..])
995            .unwrap_err();
996
997        eh_chain[10].verify_adjacent_range(&eh_chain[11..]).unwrap();
998        eh_chain[10]
999            .verify_adjacent_range(&eh_chain[100..])
1000            .unwrap_err();
1001        eh_chain[10]
1002            .verify_adjacent_range(&eh_chain[..9])
1003            .unwrap_err();
1004        eh_chain[10]
1005            .verify_adjacent_range(&eh_chain[10..])
1006            .unwrap_err();
1007    }
1008}