Add explorer to hersir (#4108)

* Refactor hersir: pull out all keys generation and allow to define external wallets or committess and voteplans, this will allow external clients to create their own keys which will be used for tally operations.

* update tests with hersir changes

* Refactor explorer module. Extract configuration struct for explorer. Added extension to multiaddr struct for better address formatting and finally make ExplorerProcess constructor return error

* added simple explorer client which is capable to send simple sanity request to explorer server

* update usages for ExplorerProcess new constructor impl

* added possibility to start explorer by hersir

Author: dkijania

Cargo.lock

@@ -33,7 +33,9 @@ pub fn explorer_test_context(
 
     let params = ExplorerParams::new(test_config.query_complexity_limit, None, None);
 
-    (jormungandr.explorer(params), jormungandr)
+    let explorer_process = jormungandr.explorer(params).unwrap();
+    println!("{:?}", explorer_process.client().current_time());
+    (explorer_process, jormungandr)
 }
 
 pub fn get_invalid_block(explorer: &Explorer) {

explorer/src/tests.rs

@@ -10,6 +10,11 @@ nodes:
         leadership_mode: leader
         persistence_mode: inmemory
 
+explorer:
+    connect_to: passive
+    persistence_mode: inmemory
+
+
 blockchain:
     discrimination: test
     consensus: bft

testing/hersir/res/example.yaml

@@ -0,0 +1,30 @@
+use crate::{builder::NodeSetting, config::ExplorerTemplate};
+use jormungandr_automation::{
+    jormungandr::{explorer::configuration::ExplorerConfiguration, get_available_port, NodeAlias},
+    utils::MultiaddrExtension,
+};
+use std::{collections::HashMap, path::Path};
+
+pub fn generate_explorer(
+    nodes: &HashMap<NodeAlias, NodeSetting>,
+    explorer_template: &ExplorerTemplate,
+) -> Result<ExplorerConfiguration, Error> {
+    let settings = nodes
+        .get(&explorer_template.connect_to)
+        .ok_or_else(|| Error::CannotFindAlias(explorer_template.connect_to.clone()))?;
+
+    Ok(ExplorerConfiguration {
+        explorer_port: get_available_port(),
+        explorer_listen_address: "127.0.0.1".to_string(),
+        node_address: settings.config.p2p.public_address.clone().to_http_addr(),
+        logs_dir: Some(Path::new("C:\\work\\iohk\\logs.txt").to_path_buf()),
+        storage_dir: None,
+        params: explorer_template.to_explorer_params(),
+    })
+}
+
+#[derive(thiserror::Error, Debug)]
+pub enum Error {
+    #[error("cannot find alias '{0}' for any defined node")]
+    CannotFindAlias(NodeAlias),
+}

testing/hersir/src/builder/explorer.rs

@@ -1,4 +1,5 @@
 mod committee;
+mod explorer;
 pub mod rng;
 pub mod settings;
 mod stake_pool;
@@ -9,7 +10,8 @@ pub mod wallet;
 pub use crate::controller::Error as ControllerError;
 use crate::{
     config::{
-        Blockchain, CommitteeTemplate, Config, SessionSettings, VotePlanTemplate, WalletTemplate,
+        Blockchain, CommitteeTemplate, Config, ExplorerTemplate, SessionSettings, VotePlanTemplate,
+        WalletTemplate,
     },
     controller::{Controller, Error},
     utils::Dotifier,
@@ -35,6 +37,7 @@ pub struct NetworkBuilder {
     topology: Topology,
     blockchain: Blockchain,
     session_settings: SessionSettings,
+    explorer_template: Option<ExplorerTemplate>,
     wallet_templates: Vec<WalletTemplate>,
     committee_templates: Vec<CommitteeTemplate>,
     vote_plan_templates: Vec<VotePlanTemplate>,
@@ -72,6 +75,7 @@ impl NetworkBuilder {
             .wallet_templates(config.wallets)
             .vote_plan_templates(config.vote_plans)
             .committees(config.committees)
+            .explorer(config.explorer)
     }
 
     pub fn topology(mut self, topology: Topology) -> Self {
@@ -142,6 +146,7 @@ impl NetworkBuilder {
             &self.blockchain,
             &self.wallet_templates,
             &self.committee_templates,
+            &self.explorer_template,
             &self.vote_plan_templates,
             &mut random,
         )?;
@@ -155,6 +160,11 @@ impl NetworkBuilder {
         self.finish_all();
         Controller::new(settings, self.session_settings.root)
     }
+
+    pub fn explorer(mut self, explorer: Option<ExplorerTemplate>) -> Self {
+        self.explorer_template = explorer;
+        self
+    }
 }
 
 fn document(path: &Path, settings: &Settings) -> Result<(), Error> {

testing/hersir/src/builder/mod.rs

@@ -5,15 +5,18 @@ pub(crate) mod wallet;
 pub use crate::{builder::settings::node::NodeSetting, config::Blockchain};
 use crate::{
     builder::{
-        committee::generate_committee_data, stake_pool, vote::generate_vote_plans,
-        wallet::generate, Node as NodeTemplate, Random, VotePlanKey, VotePlanSettings, Wallet,
+        committee::generate_committee_data, explorer::generate_explorer, stake_pool,
+        vote::generate_vote_plans, wallet::generate, Node as NodeTemplate, Random, VotePlanKey,
+        VotePlanSettings, Wallet,
     },
-    config::{CommitteeTemplate, VotePlanTemplate, WalletTemplate},
+    config::{CommitteeTemplate, ExplorerTemplate, VotePlanTemplate, WalletTemplate},
 };
 use assert_fs::fixture::{ChildPath, PathChild};
 use chain_crypto::Ed25519;
 use chain_impl_mockchain::{chaintypes::ConsensusVersion, fee::LinearFee};
-use jormungandr_automation::jormungandr::NodeAlias;
+use jormungandr_automation::jormungandr::{
+    explorer::configuration::ExplorerConfiguration, NodeAlias,
+};
 use jormungandr_lib::{
     crypto::key::SigningKey,
     interfaces::{
@@ -31,6 +34,7 @@ pub struct Settings {
     pub wallets: Vec<Wallet>,
     pub committees: Vec<CommitteeIdDef>,
     pub block0: Block0Configuration,
+    pub explorer: Option<ExplorerConfiguration>,
     pub stake_pools: HashMap<NodeAlias, StakePool>,
     pub vote_plans: HashMap<VotePlanKey, VotePlanSettings>,
 }
@@ -41,6 +45,7 @@ impl Settings {
         blockchain: &Blockchain,
         wallets: &[WalletTemplate],
         committees: &[CommitteeTemplate],
+        explorer: &Option<ExplorerTemplate>,
         vote_plans: &[VotePlanTemplate],
         rng: &mut Random<RNG>,
     ) -> Result<Self, Error>
@@ -59,6 +64,7 @@ impl Settings {
                 ),
                 initial: Vec::new(),
             },
+            explorer: None,
             stake_pools: HashMap::new(),
             vote_plans: HashMap::new(),
         };
@@ -71,6 +77,11 @@ impl Settings {
 
         settings.vote_plans = vote_plans;
         let discrimination = settings.block0.blockchain_configuration.discrimination;
+
+        if let Some(explorer) = explorer {
+            settings.explorer = Some(generate_explorer(&settings.nodes, explorer)?);
+        }
+
         settings.block0.initial.extend(
             fragments
                 .iter()
@@ -198,4 +209,6 @@ pub enum Error {
     Settings(#[from] wallet::Error),
     #[error(transparent)]
     Committee(#[from] crate::builder::committee::Error),
+    #[error(transparent)]
+    Explorer(#[from] crate::builder::explorer::Error),
 }

testing/hersir/src/builder/settings/mod.rs

@@ -14,7 +14,9 @@ use crate::{
     builder::{Node, NodeAlias, Topology},
     error::Error,
 };
-use jormungandr_automation::jormungandr::{LogLevel, TestingDirectory};
+use jormungandr_automation::jormungandr::{
+    explorer::configuration::ExplorerParams, LogLevel, PersistenceMode, TestingDirectory,
+};
 use serde::Deserialize;
 use std::{collections::HashSet, path::PathBuf, str::FromStr};
 pub use vote_plan::VotePlanTemplate;
@@ -23,6 +25,7 @@ pub use vote_plan::VotePlanTemplate;
 pub struct Config {
     pub blockchain: Blockchain,
     pub nodes: Vec<NodeConfig>,
+    pub explorer: Option<ExplorerTemplate>,
     #[serde(default)]
     pub session: SessionSettings,
     pub wallets: Vec<WalletTemplate>,
@@ -108,6 +111,30 @@ fn default_title() -> String {
     "unnamed_scenario".to_owned()
 }
 
+#[derive(Debug, Deserialize, Clone)]
+pub struct ExplorerTemplate {
+    pub connect_to: NodeAlias,
+    #[serde(default = "default_persistence_mode")]
+    pub persistence_mode: PersistenceMode,
+    pub address_bech32_prefix: Option<String>,
+    pub query_depth_limit: Option<u64>,
+    pub query_complexity_limit: Option<u64>,
+}
+
+fn default_persistence_mode() -> PersistenceMode {
+    PersistenceMode::InMemory
+}
+
+impl ExplorerTemplate {
+    pub fn to_explorer_params(&self) -> ExplorerParams {
+        ExplorerParams {
+            address_bech32_prefix: self.address_bech32_prefix.clone(),
+            query_complexity_limit: self.query_complexity_limit,
+            query_depth_limit: self.query_depth_limit,
+        }
+    }
+}
+
 impl Default for SessionSettings {
     fn default() -> Self {
         Self {

testing/hersir/src/config/mod.rs

@@ -64,4 +64,6 @@ pub enum Error {
     SettingsWallet(#[from] crate::builder::settings::wallet::Error),
     #[error(transparent)]
     Settings(#[from] crate::builder::settings::Error),
+    #[error("no explorer configuration defined")]
+    NoExplorerConfigurationDefined,
 }

testing/hersir/src/controller/error.rs

@@ -34,7 +34,7 @@ impl ExplorerTip {
             })?;
         println!(
             "{:#?}",
-            node.explorer(ExplorerParams::default())
+            node.explorer(ExplorerParams::default())?
                 .client()
                 .last_block()?
         );

testing/hersir/src/controller/interactive/args/explorer.rs

@@ -19,7 +19,7 @@ pub use interactive::{
     UserInteractionController,
 };
 use jormungandr_automation::jormungandr::{
-    ConfiguredStarter, JormungandrParams, JormungandrProcess, LegacyNodeConfig,
+    ConfiguredStarter, ExplorerProcess, JormungandrParams, JormungandrProcess, LegacyNodeConfig,
     LegacyNodeConfigConverter, LogLevel, NodeAlias, PersistenceMode, Starter, TestingDirectory,
     Version,
 };
@@ -197,6 +197,16 @@ impl Controller {
         builder.build()
     }
 
+    pub fn spawn_explorer(&mut self) -> Result<ExplorerProcess, Error> {
+        ExplorerProcess::new(
+            self.settings
+                .explorer
+                .clone()
+                .ok_or(Error::NoExplorerConfigurationDefined)?,
+        )
+        .map_err(Into::into)
+    }
+
     pub fn spawn_node_async(&mut self, alias: &str) -> Result<JormungandrProcess, Error> {
         let mut starter = self.make_starter_for(
             SpawnParams::new(alias).persistence_mode(PersistenceMode::InMemory),