Feature/directory server transition (#401)

* Initial changes to validator client API

* Updated models

* GatewayRegistrationInfo constructor

* Change validator topology to convert into NymTopology without failure

* Mixnode registering and unregistering presence

* Directory -> Validator renamings + adjustments

* Updated upgrade command for mixnode

* Extracted metrics part of directory client into separate library

* Removed no longer needed traits

* Integrated new metrics client into mixnode

* Introduced the same set of changes to the gateway

* Getting active topology in client core via validator client

* Updated clients to get correct topology

* Introduced mix mining endpoints to validator client

* Network monitor using validator client

* Removed directory client

* Updated wasm client

* Temporarily disabled the test

* Checking ok status for validator client response

* Updated upgrade command for clients

* Allowing using old presence directory as new validator endpoint for mixnodes and gateways

* Fixed tests in non-default crates

Author: jstuczyn

Cargo.lock

@@ -13,9 +13,8 @@ members = [
     "clients/socks5",
     "clients/webassembly",
     "clients/client-core",
-    "common/client-libs/directory-client",
-    "common/client-libs/directory-client/models",
     "common/client-libs/gateway-client",
+    "common/client-libs/metrics-client",
     "common/client-libs/mixnet-client",
     "common/client-libs/validator-client",
     "common/config",

Cargo.toml

@@ -19,13 +19,13 @@ tokio = { version = "0.2", features = ["full"] }
 # internal
 config = { path = "../../common/config" }
 crypto = { path = "../../common/crypto" }
-directory-client = { path = "../../common/client-libs/directory-client" }
 gateway-client = { path = "../../common/client-libs/gateway-client" }
 gateway-requests = { path = "../../gateway/gateway-requests" }
 nonexhaustive-delayqueue = { path = "../../common/nonexhaustive-delayqueue" }
 nymsphinx = { path = "../../common/nymsphinx" }
 pemstore = { path = "../../common/pemstore" }
 topology = { path = "../../common/topology" }
+validator-client = { path = "../../common/client-libs/validator-client" }
 
 [dev-dependencies]
 tempfile = "3.1.0"

clients/client-core/Cargo.toml

@@ -12,11 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use directory_client::DirectoryClient;
 use log::*;
 use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::params::DEFAULT_NUM_MIX_HOPS;
-use std::convert::TryInto;
 use std::ops::Deref;
 use std::sync::Arc;
 use std::time;
@@ -146,7 +144,7 @@ impl TopologyRefresherConfig {
 }
 
 pub struct TopologyRefresher {
-    directory_client: directory_client::Client,
+    validator_client: validator_client::Client,
     topology_accessor: TopologyAccessor,
     refresh_rate: Duration,
 }
@@ -156,24 +154,24 @@ impl TopologyRefresher {
         cfg: TopologyRefresherConfig,
         topology_accessor: TopologyAccessor,
     ) -> Self {
-        let directory_client_config = directory_client::Config::new(cfg.directory_server);
-        let directory_client = directory_client::Client::new(directory_client_config);
+        let validator_client_config = validator_client::Config::new(cfg.directory_server);
+        let validator_client = validator_client::Client::new(validator_client_config);
 
         TopologyRefresher {
-            directory_client,
+            validator_client,
             topology_accessor,
             refresh_rate: cfg.refresh_rate,
         }
     }
 
     async fn get_current_compatible_topology(&self) -> Option<NymTopology> {
-        match self.directory_client.get_topology().await {
+        match self.validator_client.get_active_topology().await {
             Err(err) => {
-                error!("failed to get network topology! - {:?}", err);
+                error!("failed to get active network topology! - {:?}", err);
                 None
             }
             Ok(topology) => {
-                let nym_topology: NymTopology = topology.try_into().ok()?;
+                let nym_topology: NymTopology = topology.into();
                 Some(nym_topology.filter_system_version(env!("CARGO_PKG_VERSION")))
             }
         }

clients/client-core/src/client/topology_control.rs

@@ -26,7 +26,8 @@ pub mod persistence;
 pub const MISSING_VALUE: &str = "MISSING VALUE";
 
 // 'CLIENT'
-const DEFAULT_DIRECTORY_SERVER: &str = "https://directory.nymtech.net";
+const DEFAULT_VALIDATOR_REST_ENDPOINT: &str = "https://directory.nymtech.net";
+
 // 'DEBUG'
 const DEFAULT_ACK_WAIT_MULTIPLIER: f64 = 1.5;
 
@@ -175,8 +176,8 @@ impl<T: NymConfig> Config<T> {
         self.client.gateway_listener = gateway_listener.into();
     }
 
-    pub fn with_custom_directory<S: Into<String>>(&mut self, directory_server: S) {
-        self.client.directory_server = directory_server.into();
+    pub fn with_custom_validator<S: Into<String>>(&mut self, validator: S) {
+        self.client.validator_rest_url = validator.into();
     }
 
     pub fn set_high_default_traffic_volume(&mut self) {
@@ -233,8 +234,8 @@ impl<T: NymConfig> Config<T> {
         self.client.ack_key_file.clone()
     }
 
-    pub fn get_directory_server(&self) -> String {
-        self.client.directory_server.clone()
+    pub fn get_validator_rest_endpoint(&self) -> String {
+        self.client.validator_rest_url.clone()
     }
 
     pub fn get_gateway_id(&self) -> String {
@@ -325,7 +326,6 @@ impl<T: NymConfig> Default for Config<T> {
 }
 
 #[derive(Debug, Deserialize, PartialEq, Serialize)]
-#[serde(deny_unknown_fields)]
 pub struct Client<T> {
     /// Version of the client for which this configuration was created.
     #[serde(default = "missing_string_value")]
@@ -334,8 +334,10 @@ pub struct Client<T> {
     /// ID specifies the human readable ID of this particular client.
     id: String,
 
-    /// URL to the directory server.
-    directory_server: String,
+    /// URL to the validator server for obtaining network topology.
+    // before 0.9.0 this was the directory server
+    #[serde(alias = "directory_server")]
+    validator_rest_url: String,
 
     /// Special mode of the system such that all messages are sent as soon as they are received
     /// and no cover traffic is generated. If set all message delays are set to 0 and overwriting
@@ -388,7 +390,7 @@ impl<T: NymConfig> Default for Client<T> {
         Client {
             version: env!("CARGO_PKG_VERSION").to_string(),
             id: "".to_string(),
-            directory_server: DEFAULT_DIRECTORY_SERVER.to_string(),
+            validator_rest_url: DEFAULT_VALIDATOR_REST_ENDPOINT.to_string(),
             vpn_mode: false,
             private_identity_key_file: Default::default(),
             public_identity_key_file: Default::default(),

clients/client-core/src/config/mod.rs

@@ -33,13 +33,13 @@ tokio-tungstenite = "0.11.0" # websocket
 client-core = { path = "../client-core" }
 config = { path = "../../common/config" }
 crypto = { path = "../../common/crypto" }
-directory-client = { path = "../../common/client-libs/directory-client" }
 gateway-client = { path = "../../common/client-libs/gateway-client" }
 gateway-requests = { path = "../../gateway/gateway-requests" }
 nymsphinx = { path = "../../common/nymsphinx" }
 pemstore = { path = "../../common/pemstore" }
 topology = { path = "../../common/topology" }
 websocket-requests = { path = "websocket-requests" }
+validator-client = { path = "../../common/client-libs/validator-client" }
 version-checker = { path = "../../common/version-checker" }
 
 [dev-dependencies]

clients/native/Cargo.toml

@@ -30,8 +30,8 @@ version = '{{ client.version }}'
 # Human readable ID of this particular client.
 id = '{{ client.id }}'
 
-# URL to the directory server.
-directory_server = '{{ client.directory_server }}'
+# URL to the validator server for obtaining network topology.
+validator_rest_url = '{{ client.validator_rest_url }}'
 
 # Special mode of the system such that all messages are sent as soon as they are received
 # and no cover traffic is generated. If set all message delays are set to 0 and overwriting

clients/native/src/client/config/template.rs

@@ -226,7 +226,7 @@ impl NymClient {
     // the current global view of topology
     fn start_topology_refresher(&mut self, topology_accessor: TopologyAccessor) {
         let topology_refresher_config = TopologyRefresherConfig::new(
-            self.config.get_base().get_directory_server(),
+            self.config.get_base().get_validator_rest_endpoint(),
             self.config.get_base().get_topology_refresh_rate(),
         );
         let mut topology_refresher =
@@ -235,7 +235,7 @@ impl NymClient {
         // components depending on topology would see a non-empty view
         info!(
             "Obtaining initial network topology from {}",
-            self.config.get_base().get_directory_server()
+            self.config.get_base().get_validator_rest_endpoint()
         );
         self.runtime.block_on(topology_refresher.refresh());