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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

// Copyright (c) 2023 MASSA LABS <info@massa.net>

use massa_models::amount::Amount;
use massa_signature::KeyPair;
use massa_time::MassaTime;
use serde::Deserialize;
use std::{net::SocketAddr, path::PathBuf, time::Duration};

/// gRPC configuration.
/// the gRPC configuration
#[derive(Debug, Deserialize, Clone)]
pub struct GrpcConfig {
    /// whether to enable gRPC
    pub name: ServiceName,
    /// whether to enable gRPC
    pub enabled: bool,
    /// whether to accept HTTP/1.1 requests
    pub accept_http1: bool,
    /// whether to enable CORS. Works only if `accept_http1` is true
    pub enable_cors: bool,
    /// whether to enable gRPC health service
    pub enable_health: bool,
    /// whether to enable gRPC reflection
    pub enable_reflection: bool,
    /// whether to enable TLS
    pub enable_tls: bool,
    /// whether to enable mTLS (requires `enable_tls` to be true)
    pub enable_mtls: bool,
    /// whether to generate a self-signed certificate if none is provided(ignored if `enable_tls` is false)
    pub generate_self_signed_certificates: bool,
    /// Subject Alternative Names is an extension in X.509 certificates that allows a certificate to specify additional subject identifiers. It is used to support alternative names for a subject, other than its primary Common Name (CN), which is typically used to represent the primary domain name.
    pub subject_alt_names: Vec<String>,
    /// bind for the Massa gRPC API
    pub bind: SocketAddr,
    /// which compression encodings does the server accept for requests
    pub accept_compressed: Option<String>,
    /// which compression encodings might the server use for responses
    pub send_compressed: Option<String>,
    /// limits the maximum size of a decoded message. Defaults to 4MB
    pub max_decoding_message_size: usize,
    /// limits the maximum size of an encoded message. Defaults to 4MB
    pub max_encoding_message_size: usize,
    /// set the concurrency limit applied to on requests inbound per connection. Defaults to 32
    pub concurrency_limit_per_connection: usize,
    /// set a timeout on for all request handlers
    pub timeout: Duration,
    /// sets the SETTINGS_INITIAL_WINDOW_SIZE spec option for HTTP2 stream-level flow control. Default is 65,535
    pub initial_stream_window_size: Option<u32>,
    /// sets the max connection-level flow control for HTTP2. Default is 65,535
    pub initial_connection_window_size: Option<u32>,
    /// sets the SETTINGS_MAX_CONCURRENT_STREAMS spec option for HTTP2 connections. Default is no limit (`None`)
    pub max_concurrent_streams: Option<u32>,
    /// max number of arguments per gRPC request
    pub max_arguments: u64,
    /// set whether TCP keepalive messages are enabled on accepted connections
    pub tcp_keepalive: Option<Duration>,
    /// set the value of `TCP_NODELAY` option for accepted connections. Enabled by default
    pub tcp_nodelay: bool,
    /// set whether HTTP2 Ping frames are enabled on accepted connections. Default is no HTTP2 keepalive (`None`)
    pub http2_keepalive_interval: Option<Duration>,
    /// sets a timeout for receiving an acknowledgement of the keepalive ping. Default is 20 seconds
    pub http2_keepalive_timeout: Option<Duration>,
    /// sets whether to use an adaptive flow control. Defaults to false
    pub http2_adaptive_window: Option<bool>,
    /// sets the maximum frame size to use for HTTP2. If not set, will default from underlying transport
    pub max_frame_size: Option<u32>,
    /// thread count
    pub thread_count: u8,
    /// max operations per block
    pub max_operations_per_block: u32,
    /// endorsement count
    pub endorsement_count: u32,
    /// max endorsements per message
    pub max_endorsements_per_message: u32,
    /// max datastore value length
    pub max_datastore_value_length: u64,
    /// max op datastore entry
    pub max_op_datastore_entry_count: u64,
    /// max op datastore entries per request
    pub max_datastore_entries_per_request: u64,
    /// max datastore key length
    pub max_op_datastore_key_length: u8,
    /// max datastore value length
    pub max_op_datastore_value_length: u64,
    /// max function name length
    pub max_function_name_length: u16,
    /// max parameter size
    pub max_parameter_size: u32,
    /// max operations per message in the network to avoid sending to big data packet
    pub max_operations_per_message: u32,
    /// max gas per block
    pub max_gas_per_block: u64,
    /// `genesis_timestamp`
    pub genesis_timestamp: MassaTime,
    /// t0
    pub t0: MassaTime,
    /// periods per cycle
    pub periods_per_cycle: u64,
    /// keypair file
    pub keypair: KeyPair,
    /// limits the maximum size of streaming channel
    pub max_channel_size: usize,
    /// when looking for next draw we want to look at max `draw_lookahead_period_count`
    pub draw_lookahead_period_count: u64,
    /// last_start_period of the network, used to deserialize blocks
    pub last_start_period: u64,
    /// max denunciations in block header
    pub max_denunciations_per_block_header: u32,
    /// max number of addresses that can be included in a single request
    pub max_addresses_per_request: u32,
    /// max number of slot ranges that can be included in a single request
    pub max_slot_ranges_per_request: u32,
    /// max number of block ids that can be included in a single request
    pub max_block_ids_per_request: u32,
    /// max number of endorsement ids that can be included in a single request
    pub max_endorsement_ids_per_request: u32,
    /// max number of operation ids that can be included in a single request
    pub max_operation_ids_per_request: u32,
    /// max number of filters that can be included in a single request
    pub max_filters_per_request: u32,
    /// max number of query items that can be included in a single request
    pub max_query_items_per_request: u32,
    /// certificate authority root path
    pub certificate_authority_root_path: PathBuf,
    /// server certificate path
    pub server_certificate_path: PathBuf,
    /// server private key path
    pub server_private_key_path: PathBuf,
    /// client certificate authority root path
    pub client_certificate_authority_root_path: PathBuf,
    /// client certificate path
    pub client_certificate_path: PathBuf,
    /// client private key path
    pub client_private_key_path: PathBuf,
    /// chain id
    pub chain_id: u64,
    /// minimal fees
    pub minimal_fees: Amount,
}

/// gRPC API configuration.
#[derive(Debug, Deserialize, Clone)]
pub struct GrpcApiConfig {
    /// Public server gRPC configuration.
    pub public: GrpcConfig,
    /// Private server gRPC configuration.
    pub private: GrpcConfig,
}

/// gRPC service name
#[derive(Debug, Deserialize, Clone)]
pub enum ServiceName {
    /// Public service name
    Public,
    /// Private service name
    Private,
}