Feature/client versioning 1 (#3960)

* Add grpc endpoint to query Mip store info (versioning)

* Cargo clippy pass

* Add versioning to grpc bridge function

* Cargo fmt pass

* Add grpc fixes

* Rename some field in grpc to be coherent

* Rename versioning_mapping.rs -> grpc_mapping.rs

* Rename file in lib.rs

---------

Co-authored-by: sydhds <sydhds@gmail.com>

massa-client/Cargo.toml

@@ -28,6 +28,7 @@ massa_signature = { path = "../massa-signature" }
 massa_time = { path = "../massa-time" }
 massa_sdk = { path = "../massa-sdk" }
 massa_wallet = { path = "../massa-wallet" }
+massa_proto = { path = "../massa-proto" }
 
 [dev-dependencies]
 toml_edit = "0.19"

massa-client/src/cmds.rs

@@ -1,7 +1,7 @@
 // Copyright (c) 2022 MASSA LABS <info@massa.net>
 
 use crate::display::Output;
-use crate::{client_warning, rpc_error};
+use crate::{client_warning, grpc_error, rpc_error};
 use anyhow::{anyhow, bail, Result};
 use console::style;
 use massa_api_exports::{
@@ -22,10 +22,12 @@ use massa_models::{
     operation::{Operation, OperationId, OperationType},
     slot::Slot,
 };
+use massa_proto::massa::api::v1 as grpc;
 use massa_sdk::Client;
 use massa_signature::KeyPair;
 use massa_time::MassaTime;
 use massa_wallet::Wallet;
+
 use serde::Serialize;
 use std::collections::{BTreeMap, HashMap, HashSet};
 use std::fmt::Write as _;
@@ -769,6 +771,35 @@ impl Command {
             Command::wallet_generate_secret_key => {
                 let wallet = wallet_opt.as_mut().unwrap();
 
+                // In order to generate a KeyPair we need to get the MIP statuses and use the latest
+                // active version
+                let req = grpc::GetMipStatusRequest { id: "".to_string() };
+                let versioning_status = match client.grpc.get_mip_status(req).await {
+                    Ok(resp_) => {
+                        let resp = resp_.into_inner();
+                        resp.entry
+                    }
+                    Err(e) => {
+                        // FIXME: Should we default to the last known version - default to 0?
+                        grpc_error!(e)
+                    }
+                };
+
+                // Note: unused for now as AddressFactory is not yet merged
+                let _address_version = versioning_status
+                    .into_iter()
+                    .rev()
+                    .find_map(|entry| {
+                        let state = grpc::ComponentStateId::from_i32(entry.state_id)
+                            .unwrap_or(grpc::ComponentStateId::Error);
+                        match state {
+                            grpc::ComponentStateId::Active => Some(entry.state_id),
+                            _ => None,
+                        }
+                    })
+                    .unwrap_or(0);
+                println!("Should create address with version: {}", _address_version);
+
                 let key = KeyPair::generate();
                 let ad = wallet.add_keypairs(vec![key])?[0];
                 if json {

massa-client/src/display.rs

@@ -41,6 +41,14 @@ macro_rules! rpc_error {
     };
 }
 
+#[macro_export]
+/// bail a shinny RPC error
+macro_rules! grpc_error {
+    ($e:expr) => {
+        bail!("check if your node is running and grpc api enabled: {}", $e)
+    };
+}
+
 #[macro_export]
 /// print a yellow warning
 macro_rules! client_warning {

massa-grpc/Cargo.toml

@@ -38,6 +38,7 @@ massa_time = { path = "../massa-time" }
 massa_wallet = { path = "../massa-wallet" }
 massa_serialization = { path = "../massa-serialization" }
 massa_proto = { path = "../massa-proto" }
+massa_versioning_worker = { path = "../massa-versioning-worker" }
 
 [dev-dependencies]
 crossbeam = "0.8.2"

massa-grpc/src/api.rs

@@ -339,6 +339,29 @@ pub(crate) fn get_largest_stakers(
     })
 }
 
+// Get node version
+pub(crate) fn get_mip_status(
+    grpc: &MassaGrpc,
+    request: tonic::Request<grpc::GetMipStatusRequest>,
+) -> Result<grpc::GetMipStatusResponse, GrpcError> {
+    let mip_store_status_ = grpc.mip_store.get_mip_status();
+    let mip_store_status: Result<Vec<grpc::MipStatusEntry>, GrpcError> = mip_store_status_
+        .iter()
+        .map(|(mip_info, state_id_)| {
+            let state_id = grpc::ComponentStateId::from(state_id_);
+            Ok(grpc::MipStatusEntry {
+                mip_info: Some(grpc::MipInfo::from(mip_info)),
+                state_id: i32::from(state_id),
+            })
+        })
+        .collect();
+
+    Ok(grpc::GetMipStatusResponse {
+        id: request.into_inner().id,
+        entry: mip_store_status?,
+    })
+}
+
 /// Get next block best parents
 pub(crate) fn get_next_block_best_parents(
     grpc: &MassaGrpc,

massa-grpc/src/handler.rs

@@ -3,7 +3,7 @@
 use massa_proto::massa::api::v1 as grpc;
 
 use crate::api::{
-    get_blocks, get_blocks_by_slots, get_datastore_entries, get_largest_stakers,
+    get_blocks, get_blocks_by_slots, get_datastore_entries, get_largest_stakers, get_mip_status,
     get_next_block_best_parents, get_operations, get_sc_execution_events, get_selector_draws,
     get_transactions_throughput, get_version,
 };
@@ -55,6 +55,14 @@ impl grpc::massa_service_server::MassaService for MassaGrpc {
         Ok(tonic::Response::new(get_largest_stakers(self, request)?))
     }
 
+    /// handler for get mip status (versioning)
+    async fn get_mip_status(
+        &self,
+        request: tonic::Request<grpc::GetMipStatusRequest>,
+    ) -> Result<tonic::Response<grpc::GetMipStatusResponse>, tonic::Status> {
+        Ok(tonic::Response::new(get_mip_status(self, request)?))
+    }
+
     /// handler for get next block best parents
     async fn get_next_block_best_parents(
         &self,

massa-grpc/src/server.rs

@@ -12,6 +12,8 @@ use massa_proto::massa::api::v1::massa_service_server::MassaServiceServer;
 use massa_proto::massa::api::v1::FILE_DESCRIPTOR_SET;
 use massa_protocol_exports::ProtocolController;
 use massa_storage::Storage;
+use massa_versioning_worker::versioning::MipStore;
+
 use tokio::sync::oneshot;
 use tonic::{
     codec::CompressionEncoding,
@@ -46,6 +48,8 @@ pub struct MassaGrpc {
     pub grpc_config: GrpcConfig,
     /// node version
     pub version: massa_models::version::Version,
+    /// mip store
+    pub mip_store: MipStore,
 }
 
 impl MassaGrpc {

massa-grpc/src/tests/test.rs

@@ -10,13 +10,15 @@ use massa_models::config::{
     MAX_DENUNCIATIONS_PER_BLOCK_HEADER, MAX_ENDORSEMENTS_PER_MESSAGE, MAX_FUNCTION_NAME_LENGTH,
     MAX_OPERATIONS_PER_BLOCK, MAX_OPERATIONS_PER_MESSAGE, MAX_OPERATION_DATASTORE_ENTRY_COUNT,
     MAX_OPERATION_DATASTORE_KEY_LENGTH, MAX_OPERATION_DATASTORE_VALUE_LENGTH, MAX_PARAMETERS_SIZE,
-    PERIODS_PER_CYCLE, T0, THREAD_COUNT, VERSION,
+    MIP_STORE_STATS_BLOCK_CONSIDERED, MIP_STORE_STATS_COUNTERS_MAX, PERIODS_PER_CYCLE, T0,
+    THREAD_COUNT, VERSION,
 };
 use massa_pool_exports::test_exports::MockPoolController;
 use massa_pool_exports::PoolChannels;
 use massa_pos_exports::test_exports::MockSelectorController;
 use massa_proto::massa::api::v1::massa_service_client::MassaServiceClient;
 use massa_protocol_exports::MockProtocolController;
+use massa_versioning_worker::versioning::{MipStatsConfig, MipStore};
 use std::{
     net::{IpAddr, Ipv4Addr, SocketAddr},
     path::PathBuf,
@@ -94,6 +96,13 @@ async fn test_start_grpc_server() {
         client_certificate_authority_root_path: PathBuf::default(),
     };
 
+    let mip_stats_config = MipStatsConfig {
+        block_count_considered: MIP_STORE_STATS_BLOCK_CONSIDERED,
+        counters_max: MIP_STORE_STATS_COUNTERS_MAX,
+    };
+
+    let mip_store = MipStore::try_from(([], mip_stats_config)).unwrap();
+
     let service = MassaGrpc {
         consensus_controller: Box::new(consensus_controller),
         consensus_channels,
@@ -112,6 +121,7 @@ async fn test_start_grpc_server() {
         storage: shared_storage,
         grpc_config: grpc_config.clone(),
         version: *VERSION,
+        mip_store,
     };
 
     let stop_handle = service.serve(&grpc_config).await.unwrap();

massa-node/src/main.rs

@@ -850,6 +850,7 @@ async fn launch(
             storage: shared_storage.clone(),
             grpc_config: grpc_config.clone(),
             version: *VERSION,
+            mip_store,
         };
 
         // HACK maybe should remove timeout later

massa-proto/Cargo.toml

@@ -14,5 +14,10 @@ prost = "0.11.8"
 prost-types = "0.11.8"
 tonic = "0.9.1"
 
+[build-dependencies]
+glob = "0.3.1"
+prost-build = "0.11.8"
+tonic-build = "0.9.1"
+
 [features]
 build-tonic = []

massa-proto/build.rs

@@ -39,7 +39,7 @@ mod tonic {
             .map_err(|e| format!("protobuf compilation error: {:?}", e))?;
 
         // Generate documentation for the protobuf API
-        generate_doc(&protos).map_err(|e| format!("protobuf documentation error: {:?}", e))?;
+        // generate_doc(&protos).map_err(|e| format!("protobuf documentation error: {:?}", e))?;
 
         // Return Ok if the build and documentation generation were successful
         Ok(())

massa-proto/proto/massa/api/v1/api.proto

@@ -12,6 +12,7 @@ import "google/api/annotations.proto";
 import "google/rpc/status.proto";
 import "operation.proto";
 import "slot.proto";
+import "versioning.proto";
 
 option csharp_namespace = "Com.Massa.Api.V1";
 option go_package = "github.com/massalabs/massa/api/v1;v1";
@@ -96,6 +97,11 @@ service MassaService {
     option (google.api.http) = {get: "/v1/version"};
   }
 
+  // Get
+  rpc GetMipStatus(GetMipStatusRequest) returns (GetMipStatusResponse) {
+    option (google.api.http) = {get: "/v1/mip_status"};
+  }
+
   // ███████╗████████╗██████╗ ███████╗ █████╗ ███╗   ███╗
   // ██╔════╝╚══██╔══╝██╔══██╗██╔════╝██╔══██╗████╗ ████║
   // ███████╗   ██║   ██████╔╝█████╗  ███████║██╔████╔██║
@@ -414,6 +420,19 @@ message SelectorDraws {
   repeated IndexedSlot next_endorsement_draws = 3;
 }
 
+message GetMipStatusRequest {
+  // Request id
+  string id = 1;
+}
+
+// GetMipStatusResponse holds response from GetMipStatus
+message GetMipStatusResponse {
+  // Request id
+  string id = 1;
+  // MipInfo - status id entry
+  repeated MipStatusEntry entry = 2;
+}
+
 // GetTransactionsThroughputRequest holds request for GetTransactionsThroughput
 message GetTransactionsThroughputRequest {
   // Request id

massa-proto/proto/massa/api/v1/versioning.proto

@@ -0,0 +1,48 @@
+// Copyright (c) 2023 MASSA LABS <info@massa.net>
+
+syntax = "proto3";
+
+package massa.api.v1;
+
+option csharp_namespace = "Com.Massa.Api.V1";
+option go_package = "github.com/massalabs/massa/api/v1;v1";
+option java_multiple_files = true;
+option java_package = "com.massa.api.v1";
+option objc_class_prefix = "GRPC";
+option php_namespace = "Com\\Massa\\Api\\V1";
+option ruby_package = "Com::Massa::Api::V1";
+option swift_prefix = "GRPC";
+
+// Entry for GetMipStatusResponse
+message MipStatusEntry {
+  // Mip info
+  MipInfo mip_info = 1;
+  // state id
+  ComponentStateId state_id = 2;
+}
+
+// Same as MipInfo struct in versioning package
+message MipInfo {
+  string name = 1;
+  fixed32 version = 2;
+  fixed64 start = 3;
+  fixed64 timeout = 4;
+  fixed64 activation_delay = 5;
+  repeated MipComponentEntry components = 6;
+}
+
+message MipComponentEntry {
+  fixed32 kind = 1;
+  fixed32 version = 2;
+}
+
+// Same as ComponentStateId enum in versioning package
+enum ComponentStateId {
+  COMPONENT_STATE_ID_UNSPECIFIED = 0;
+  COMPONENT_STATE_ID_ERROR = 1;
+  COMPONENT_STATE_ID_DEFINED = 2;
+  COMPONENT_STATE_ID_STARTED = 3;
+  COMPONENT_STATE_ID_LOCKEDIN = 4;
+  COMPONENT_STATE_ID_ACTIVE = 5;
+  COMPONENT_STATE_ID_FAILED = 6;
+}