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

use miden_node_proto::generated::rpc::CommittedNote;
use miden_node_proto::{DecodeMessage, generated as proto};
use miden_node_store::NoteRecord;
use miden_node_tracing::{debug, miden_instrument, miden_span_record};
use miden_node_utils::limiter::QueryParamNoteIdLimit;
use miden_protocol::note::NoteId;

use super::error_codes::GetNotesByIdErrorCode;
use super::{RpcService, check, database_error_to_status};
use crate::{COMPONENT, LOG_TARGET};

#[tonic::async_trait]
impl proto::server::rpc_api::GetNotesById for RpcService {
    type Input = proto::rpc::DecodedNotesByIdRequest;
    type Output = Vec<CommittedNote>;

    fn decode(request: proto::rpc::NotesByIdRequest) -> tonic::Result<Self::Input> {
        check::<QueryParamNoteIdLimit>(request.note_ids.len())?;
        request
            .decode_fields()
            .map_err(|err| GetNotesByIdErrorCode::DeserializationFailed.invalid_argument(err))
    }

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

    #[miden_instrument(
        target = COMPONENT,
        name = "get_notes_by_id",
        err,
    )]
    async fn handle(
        &self,
        request: Self::Input,
        _metadata: &tonic::metadata::MetadataMap,
        _extensions: &tonic::codegen::http::Extensions,
    ) -> tonic::Result<Self::Output> {
        let note_ids: Vec<NoteId> = request.note_ids.verify_infallible();
        miden_span_record!(
            note.ids = &note_ids[..note_ids.len().min(10)],
            note.count = note_ids.len()
        );
        debug!(
            target: LOG_TARGET,
            "Getting notes by ID",
            note.ids = &note_ids[..note_ids.len().min(10)],
            note.count = note_ids.len()
        );

        let notes = self
            .state
            .view()
            .get_notes_by_id(note_ids)
            .await
            .map_err(|err| database_error_to_status(&err))?
            .into_iter()
            .map(note_record_to_proto)
            .collect();

        Ok(notes)
    }
}

// HELPERS
// ================================================================================================

fn note_record_to_proto(note: NoteRecord) -> proto::rpc::CommittedNote {
    let inclusion_proof = Some(proto::note::NoteInclusionProof {
        note_id: Some(note.note_id.into()),
        block_num: Some(note.block_num.into()),
        note_index_in_block: note.note_index.leaf_index_value().into(),
        inclusion_path: Some(note.inclusion_path.into()),
    });
    let note = Some(proto::note::Note {
        metadata: Some(note.metadata.into_partial_metadata().into()),
        note_details: note.details.map(Into::into),
        note_attachments: Some(note.attachments.into()),
    });
    proto::rpc::CommittedNote { inclusion_proof, note }
}