brk_types 0.2.2

Structs used throughout BRK
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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::{BlockHash, Height};

/// Block status indicating whether block is in the best chain
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct BlockStatus {
    /// Whether this block is in the best chain
    pub in_best_chain: bool,

    /// Block height (only if in best chain)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub height: Option<Height>,

    /// Hash of the next block in the best chain (only if in best chain and not tip)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_best: Option<BlockHash>,
}

impl BlockStatus {
    pub fn in_best_chain(height: Height, next_best: Option<BlockHash>) -> Self {
        Self {
            in_best_chain: true,
            height: Some(height),
            next_best,
        }
    }

    pub fn not_in_best_chain() -> Self {
        Self {
            in_best_chain: false,
            height: None,
            next_best: None,
        }
    }
}