Merge #4494

4494: Implement `get_addresses_bytecode` in JsonRPC r=aoudiamoncef a=aoudiamoncef

* [x] document all added functions
* [ ] try in sandbox /simulation/labnet
  * [ ] if part of node-launch, checked using the `resync_check` flag
* [x] unit tests on the added/changed features
  * [x] make tests compile
  * [x] make tests pass 
* [x] add logs allowing easy debugging in case the changes caused problems
* [x] if the API has changed, update the API specification

closes #4474

Co-authored-by: Moncef AOUDIA <[email protected]>

massa-api-exports/src/address.rs

@@ -155,3 +155,25 @@ impl std::fmt::Display for CompactAddressInfo {
         Ok(())
     }
 }
+
+/// filter used when retrieving address informations
+#[derive(Debug, Deserialize, Clone, Serialize)]
+pub struct AddressFilter {
+    /// Address
+    pub address: Address,
+
+    /// true means final
+    /// false means candidate
+    pub is_final: bool,
+}
+
+impl std::fmt::Display for AddressFilter {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "Address: {:?}", self.address)?;
+        if self.is_final {
+            write!(f, " (Final)")
+        } else {
+            write!(f, " (Candidate)")
+        }
+    }
+}

massa-api/Cargo.toml

@@ -4,37 +4,39 @@ version = "0.26.1"
 edition = "2021"
 
 [features]
-testing = []
+testing = ["dep:massa_channel", "dep:massa_grpc", "massa_grpc/testing"]
 
 [dependencies]
-jsonrpsee = { workspace = true, "features" = ["server", "macros"] }
-futures = { workspace = true }
-async-trait = { workspace = true }
-serde = { workspace = true, "features" = ["derive"] }
-serde_json = { workspace = true }
-tower-http = { workspace = true, "features" = ["cors"] }
-tower = { workspace = true, "features" = ["full"] }
-hyper = { workspace = true }
-tokio = { workspace = true, "features" = ["full"] }
-tokio-stream = { workspace = true, "features" = ["sync"] }
-tracing = { workspace = true }
-itertools = { workspace = true }
-parking_lot = { workspace = true, "features" = ["deadlock_detection"] }
-massa_consensus_exports = { workspace = true }
 massa_api_exports = { workspace = true }
+massa_channel = { workspace = true, optional = true}
+massa_consensus_exports = { workspace = true }
+massa_execution_exports = { workspace = true }
+massa_grpc = { workspace = true, "features" = ["testing"], optional = true}
+massa_hash = { workspace = true }
 massa_models = { workspace = true }
 massa_pool_exports = { workspace = true }
-massa_protocol_exports = { workspace = true }
-massa_execution_exports = { workspace = true }
 massa_pos_exports = { workspace = true }
-massa_storage = { workspace = true }
+massa_protocol_exports = { workspace = true }
 massa_serialization = { workspace = true }
 massa_signature = { workspace = true }
+massa_storage = { workspace = true }
 massa_time = { workspace = true }
 massa_versioning = { workspace = true }
-massa_hash = { workspace = true }
 massa_wallet = { workspace = true }
 
+async-trait = { workspace = true }
+futures = { workspace = true }
+hyper = { workspace = true }
+itertools = { workspace = true }
+jsonrpsee = { workspace = true, "features" = ["server", "macros"] }
+parking_lot = { workspace = true, "features" = ["deadlock_detection"] }
+serde = { workspace = true, "features" = ["derive"] }
+serde_json = { workspace = true }
+tokio = { workspace = true, "features" = ["full"] }
+tokio-stream = { workspace = true, "features" = ["sync"] }
+tower = { workspace = true, "features" = ["full"] }
+tower-http = { workspace = true, "features" = ["cors"] }
+tracing = { workspace = true }
 
 [dev-dependencies]
 massa_consensus_exports = { workspace = true, "features" = ["testing"] }

massa-api/src/lib.rs

@@ -12,7 +12,7 @@ use jsonrpsee::server::middleware::HostFilterLayer;
 use jsonrpsee::server::{BatchRequestConfig, ServerBuilder, ServerHandle};
 use jsonrpsee::RpcModule;
 use massa_api_exports::{
-    address::AddressInfo,
+    address::{AddressFilter, AddressInfo},
     block::{BlockInfo, BlockSummary},
     config::APIConfig,
     datastore::{DatastoreEntryInput, DatastoreEntryOutput},
@@ -54,6 +54,11 @@ mod api_trait;
 mod private;
 mod public;
 
+#[cfg(feature = "testing")]
+use massa_channel as _;
+#[cfg(feature = "testing")]
+use massa_grpc as _;
+
 #[cfg(test)]
 mod tests;
 
@@ -369,6 +374,10 @@ pub trait MassaRpc {
     #[method(name = "get_addresses")]
     async fn get_addresses(&self, arg: Vec<Address>) -> RpcResult<Vec<AddressInfo>>;
 
+    /// Get addresses bytecode.
+    #[method(name = "get_addresses_bytecode")]
+    async fn get_addresses_bytecode(&self, args: Vec<AddressFilter>) -> RpcResult<Vec<Vec<u8>>>;
+
     /// Adds operations to pool. Returns operations that were ok and sent to pool.
     #[method(name = "send_operations")]
     async fn send_operations(&self, arg: Vec<OperationInput>) -> RpcResult<Vec<OperationId>>;

massa-api/src/private.rs

@@ -5,7 +5,7 @@ use crate::{MassaRpcServer, Private, RpcServer, StopHandle, Value, API};
 use async_trait::async_trait;
 use jsonrpsee::core::{Error as JsonRpseeError, RpcResult};
 use massa_api_exports::{
-    address::AddressInfo,
+    address::{AddressFilter, AddressInfo},
     block::{BlockInfo, BlockSummary},
     config::APIConfig,
     datastore::{DatastoreEntryInput, DatastoreEntryOutput},
@@ -238,6 +238,10 @@ impl MassaRpcServer for API<Private> {
         crate::wrong_api::<Vec<AddressInfo>>()
     }
 
+    async fn get_addresses_bytecode(&self, _: Vec<AddressFilter>) -> RpcResult<Vec<Vec<u8>>> {
+        crate::wrong_api::<Vec<Vec<u8>>>()
+    }
+
     async fn send_operations(&self, _: Vec<OperationInput>) -> RpcResult<Vec<OperationId>> {
         crate::wrong_api::<Vec<OperationId>>()
     }