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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

// Copyright (c) 2023 MASSA LABS <info@massa.net>
//
//! ## **Overview**
//!
//! This Rust module is a gRPC API for providing services for the Massa blockchain.
//! It implements gRPC services defined in the [massa_proto_rs] crate.
//!
//! ## **Structure**
//!
//! * `api.rs`: implements gRPC service methods without streams.
//! * `handler.rs`: defines the logic for handling incoming gRPC requests.
//! * `server`: initializes the gRPC service and serve It.
//! * `stream/`: contains the gRPC streaming methods implementations files.

#![warn(missing_docs)]
#![warn(unused_crate_dependencies)]

use error::GrpcError;
use massa_models::slot::Slot;
use massa_proto_rs::massa::model::v1 as grpc_model;
use std::hash::Hash;
use tonic_health as _;
use tonic_reflection as _;
use tonic_web as _;

#[cfg(feature = "execution-trace")]
use serde_json as _;

/// gRPC configuration
pub mod config;
/// models error
pub mod error;
/// gRPC API implementation
pub mod handler;
/// business code for node management methods
pub mod private;
/// business code for non stream methods
pub mod public;
/// gRPC service initialization and serve
pub mod server;
/// business code for stream methods
pub mod stream;

#[cfg(test)]
/// gRPC tests
pub mod tests;

/// Slot range type
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
pub struct SlotRange {
    // Start lot
    start_slot: Option<Slot>,
    // End slot
    end_slot: Option<Slot>,
}

impl SlotRange {
    /// Check if the slot range is valid
    pub fn check(&self) -> Result<(), GrpcError> {
        match (self.start_slot, self.end_slot) {
            (None, None) => Err(GrpcError::InvalidArgument(
                "Invalid slot range: both start slot and end slot are empty".to_string(),
            )),
            (Some(s_slot), Some(e_slot)) if s_slot > e_slot => {
                Err(GrpcError::InvalidArgument(format!(
                    "Invalid slot range: start slot {} is greater than end slot {}",
                    s_slot, e_slot
                )))
            }
            (Some(s_slot), Some(e_slot)) if e_slot < s_slot => {
                Err(GrpcError::InvalidArgument(format!(
                    "Invalid slot range: end slot {} is lower to start slot {}",
                    s_slot, e_slot
                )))
            }
            (Some(s_slot), Some(e_slot)) if s_slot == e_slot => {
                Err(GrpcError::InvalidArgument(format!(
                    "Invalid slot range: start slot {} is equal to end slot {}",
                    s_slot, e_slot
                )))
            }
            _ => Ok(()),
        }
    }
}

// Slot draw
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
struct SlotDraw {
    /// Slot
    slot: Option<Slot>,
    /// Block producer address (Optional)
    block_producer: Option<String>,
    /// Endorsement draws
    endorsement_draws: Vec<EndorsementDraw>,
}

// Endorsement draw
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
struct EndorsementDraw {
    /// Endorsement index
    index: u64,
    /// Producer address
    producer: String,
}

impl From<SlotDraw> for grpc_model::SlotDraw {
    fn from(value: SlotDraw) -> Self {
        grpc_model::SlotDraw {
            slot: value.slot.map(Into::into),
            block_producer: value.block_producer,
            endorsement_draws: value
                .endorsement_draws
                .into_iter()
                .map(Into::into)
                .collect(),
        }
    }
}

impl From<EndorsementDraw> for grpc_model::EndorsementDraw {
    fn from(value: EndorsementDraw) -> Self {
        grpc_model::EndorsementDraw {
            index: value.index,
            producer: value.producer,
        }
    }
}