miden-node-rpc 0.17.0-rc.3

Miden node's front-end RPC server
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

use miden_node_proto::generated as proto;
use miden_node_store::StateSyncError;
use miden_node_tracing::{debug, miden_instrument};
use miden_protocol::block::BlockNumber;

use super::RpcService;
use super::error_codes::{SyncChainMmrErrorCode, internal_error};
use crate::{COMPONENT, LOG_TARGET};

#[tonic::async_trait]
impl proto::server::rpc_api::SyncChainMmr for RpcService {
    type Input = proto::rpc::SyncChainMmrRequest;
    type Output = proto::rpc::SyncChainMmrResponse;

    fn decode(request: proto::rpc::SyncChainMmrRequest) -> tonic::Result<Self::Input> {
        Ok(request)
    }

    fn encode(output: Self::Output) -> tonic::Result<proto::rpc::SyncChainMmrResponse> {
        Ok(output)
    }

    #[miden_instrument(
        target = COMPONENT,
        name = "sync_chain_mmr",
        fields(
            current_client_block_height = request.current_client_block_height,
            finality_level = request.finality_level()
        ),
        err,
    )]
    async fn handle(
        &self,
        request: Self::Input,
        _metadata: &tonic::metadata::MetadataMap,
        _extensions: &tonic::codegen::http::Extensions,
    ) -> tonic::Result<Self::Output> {
        debug!(target: LOG_TARGET, "Syncing chain MMR");

        let current_client_block_height = BlockNumber::from(request.current_client_block_height);

        // Read the target tip before creating the view: tips are monotonic and each committed tip
        // is published after its snapshot, so the view below is guaranteed to be able to serve
        // `sync_target`.
        let sync_target = match request.finality_level() {
            proto::rpc::FinalityLevel::Committed | proto::rpc::FinalityLevel::Unspecified => {
                self.state.committed_tip()
            },
            proto::rpc::FinalityLevel::Proven => self.state.proven_tip(),
        };

        if current_client_block_height > sync_target {
            return Err(SyncChainMmrErrorCode::FutureBlock.invalid_argument(format!(
                "start block is not known: current client block height {current_client_block_height} is greater than chain tip {sync_target}"
            )));
        }

        let block_range = current_client_block_height..=sync_target;
        let view = self.state.view();
        let (mmr_delta, block_header, block_signatures) =
            view.sync_chain_mmr(block_range.clone()).await.map_err(|err| match err {
                StateSyncError::RangeBeyondTip(_) => {
                    SyncChainMmrErrorCode::FutureBlock.invalid_argument(err)
                },
                _ => internal_error(err.to_string()),
            })?;

        let protocol_config_required = if current_client_block_height == BlockNumber::GENESIS {
            true
        } else if current_client_block_height == sync_target {
            false
        } else {
            let commitment_at_start = view
                .get_protocol_config_commitment_at(current_client_block_height)
                .await
                .map_err(|err| internal_error(err.to_string()))?;
            let commitment_at_start = commitment_at_start.ok_or_else(|| {
                internal_error("starting protocol configuration activation is missing")
            })?;
            commitment_at_start != block_header.protocol_config_commitment()
        };

        let protocol_config = if protocol_config_required {
            Some(super::load_protocol_config(&view, &block_header).await?.into())
        } else {
            None
        };

        Ok(proto::rpc::SyncChainMmrResponse {
            protocol_config,
            block_range: Some(proto::rpc::BlockRange {
                block_from: block_range.start().as_u32(),
                block_to: block_range.end().as_u32(),
            }),
            mmr_delta: Some(mmr_delta.into()),
            block_header: Some(block_header.into()),
            block_signatures: block_signatures.as_signatures().iter().map(Into::into).collect(),
        })
    }
}