miden-node-proto 0.17.1

Miden node message definitions (Store, Block Producer and RPC)
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

//! Protocol configuration validation at RPC boundaries.

use miden_protocol::block::BlockHeader;
use miden_protocol::protocol_config::ProtocolConfig;

use crate::DecodeMessageExt;
use crate::errors::{ConversionError, ConversionResultExt};
use crate::generated::protocol_config::ProtocolConfig as ProtoProtocolConfig;

/// Ensures protocol configuration is present and matches the protocol configuration commitment in
/// the header.
pub fn ensure_protocol_config_is_present_and_matches_header(
    config: Option<ProtoProtocolConfig>,
    header: &BlockHeader,
) -> Result<ProtocolConfig, ConversionError> {
    let config = config
        .ok_or_else(|| ConversionError::message("protocol config is missing"))?
        .decode_and_verify()
        .context("protocol_config")?;
    verify_protocol_config_commitment(config, header)
}

/// Check that the configuration matches the header commitment.
pub(super) fn verify_protocol_config_commitment(
    config: ProtocolConfig,
    header: &BlockHeader,
) -> Result<ProtocolConfig, ConversionError> {
    let calculated = config.to_commitment();
    let expected = header.protocol_config_commitment();
    if calculated != expected {
        return Err(ConversionError::message(format!(
            "protocol config commitment {calculated} does not match header commitment {expected}"
        )));
    }
    Ok(config)
}

#[cfg(test)]
mod tests {
    use miden_protocol::Word;
    use miden_protocol::asset::AssetId;
    use miden_protocol::block::FeeParameters;
    use miden_protocol::testing::account_id::ACCOUNT_ID_PUBLIC_FUNGIBLE_FAUCET_1;

    use super::*;

    #[test]
    fn accepts_only_present_valid_matching_config() {
        let config = ProtocolConfig::current(AssetId::new_fungible(
            ACCOUNT_ID_PUBLIC_FUNGIBLE_FAUCET_1.try_into().unwrap(),
        ))
        .unwrap();
        let other_header = BlockHeader::mock(0, None, None, &[]);
        let header = BlockHeader::new(
            Word::empty(),
            0.into(),
            Word::empty(),
            Word::empty(),
            Word::empty(),
            Word::empty(),
            Word::empty(),
            other_header.validator_config().clone(),
            FeeParameters::new(0),
            config.to_commitment(),
            None,
            0,
        );
        assert!(ensure_protocol_config_is_present_and_matches_header(None, &header).is_err());
        assert!(
            ensure_protocol_config_is_present_and_matches_header(
                Some(ProtoProtocolConfig::default()),
                &header
            )
            .is_err()
        );
        assert_eq!(
            ensure_protocol_config_is_present_and_matches_header(Some((&config).into()), &header)
                .unwrap(),
            config
        );
        assert!(
            ensure_protocol_config_is_present_and_matches_header(
                Some(config.into()),
                &other_header
            )
            .is_err()
        );
    }
}