Renamed testnet mode to disabled credentials mode

Vladrofl · May 3, 2022 · 21d19d2 · 21d19d2
1 parent 5f116f8
commit 21d19d2
Show file tree

Hide file tree

Showing 27 changed files with 120 additions and 113 deletions.
diff --git a/clients/client-core/src/config/mod.rs b/clients/client-core/src/config/mod.rs
@@ -110,8 +110,8 @@ impl<T: NymConfig> Config<T> {
         self.client.id = id;
     }
 
-    pub fn with_testnet_mode(&mut self, testnet_mode: bool) {
-        self.client.testnet_mode = testnet_mode;
+    pub fn with_disabled_credentials(&mut self, disabled_credentials_mode: bool) {
+        self.client.disabled_credentials_mode = disabled_credentials_mode;
     }
 
     pub fn with_gateway_endpoint<S: Into<String>>(&mut self, id: S, owner: S, listener: S) {
@@ -154,8 +154,8 @@ impl<T: NymConfig> Config<T> {
         self.client.id.clone()
     }
 
-    pub fn get_testnet_mode(&self) -> bool {
-        self.client.testnet_mode
+    pub fn get_disabled_credentials_mode(&self) -> bool {
+        self.client.disabled_credentials_mode
     }
 
     pub fn get_nym_root_directory(&self) -> PathBuf {
@@ -294,10 +294,10 @@ pub struct Client<T> {
     /// ID specifies the human readable ID of this particular client.
     id: String,
 
-    /// Indicates whether this client is running in a testnet mode, thus attempting
+    /// Indicates whether this client is running in a disabled credentials mode, thus attempting
     /// to claim bandwidth without presenting bandwidth credentials.
     #[serde(default)]
-    testnet_mode: bool,
+    disabled_credentials_mode: bool,
 
     /// Addresses to APIs running on validator from which the client gets the view of the network.
     validator_api_urls: Vec<Url>,
@@ -354,7 +354,7 @@ impl<T: NymConfig> Default for Client<T> {
         Client {
             version: env!("CARGO_PKG_VERSION").to_string(),
             id: "".to_string(),
-            testnet_mode: false,
+            disabled_credentials_mode: false,
             validator_api_urls: default_api_endpoints(),
             private_identity_key_file: Default::default(),
             public_identity_key_file: Default::default(),

diff --git a/clients/native/src/client/config/template.rs b/clients/native/src/client/config/template.rs
@@ -19,9 +19,9 @@ version = '{{ client.version }}'
 # Human readable ID of this particular client.
 id = '{{ client.id }}'
 
-# Indicates whether this client is running in a testnet mode, thus attempting
+# Indicates whether this client is running in a disabled credentials mode, thus attempting
 # to claim bandwidth without presenting bandwidth credentials.
-testnet_mode = {{ client.testnet_mode }}
+disabled_credentials_mode = {{ client.disabled_credentials_mode }}
 
 # Addresses to APIs running on validator from which the client gets the view of the network.
 validator_api_urls = [

diff --git a/clients/native/src/client/mod.rs b/clients/native/src/client/mod.rs
@@ -199,8 +199,8 @@ impl NymClient {
             Some(bandwidth_controller),
         );
 
-        if self.config.get_base().get_testnet_mode() {
-            gateway_client.set_testnet_mode(true)
+        if self.config.get_base().get_disabled_credentials_mode() {
+            gateway_client.set_disabled_credentials_mode(true)
         }
         gateway_client
             .authenticate_and_start()

diff --git a/clients/native/src/commands/init.rs b/clients/native/src/commands/init.rs
@@ -24,8 +24,8 @@ use crate::commands::override_config;
 #[cfg(feature = "eth")]
 #[cfg(not(feature = "coconut"))]
 use crate::commands::{
-    DEFAULT_ETH_ENDPOINT, DEFAULT_ETH_PRIVATE_KEY, ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME,
-    TESTNET_MODE_ARG_NAME,
+    DEFAULT_ETH_ENDPOINT, DEFAULT_ETH_PRIVATE_KEY, DISABLED_CREDENTIALS_MODE_ARG_NAME,
+    ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME,
 };
 
 pub fn command_args<'a, 'b>() -> clap::App<'a, 'b> {
@@ -66,22 +66,22 @@ pub fn command_args<'a, 'b>() -> clap::App<'a, 'b> {
     #[cfg(not(feature = "coconut"))]
         let app = app
         .arg(
-            Arg::with_name(TESTNET_MODE_ARG_NAME)
-                .long(TESTNET_MODE_ARG_NAME)
-                .help("Set this client to work in a testnet mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
+            Arg::with_name(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .long(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .help("Set this client to work in a disabled credentials mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
                 .conflicts_with_all(&[ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME])
         )
         .arg(Arg::with_name(ETH_ENDPOINT_ARG_NAME)
             .long(ETH_ENDPOINT_ARG_NAME)
             .help("URL of an Ethereum full node that we want to use for getting bandwidth tokens from ERC20 tokens. If you don't want to set this value, use --testnet-mode instead")
             .takes_value(true)
-            .default_value_if(TESTNET_MODE_ARG_NAME, None, DEFAULT_ETH_ENDPOINT)
+            .default_value_if(DISABLED_CREDENTIALS_MODE_ARG_NAME, None, DEFAULT_ETH_ENDPOINT)
             .required(true))
         .arg(Arg::with_name(ETH_PRIVATE_KEY_ARG_NAME)
             .long(ETH_PRIVATE_KEY_ARG_NAME)
             .help("Ethereum private key used for obtaining bandwidth tokens from ERC20 tokens. If you don't want to set this value, use --testnet-mode instead")
             .takes_value(true)
-            .default_value_if(TESTNET_MODE_ARG_NAME, None, DEFAULT_ETH_PRIVATE_KEY)
+            .default_value_if(DISABLED_CREDENTIALS_MODE_ARG_NAME, None, DEFAULT_ETH_PRIVATE_KEY)
             .required(true)
         );
 

diff --git a/clients/native/src/commands/mod.rs b/clients/native/src/commands/mod.rs
@@ -5,7 +5,7 @@ use crate::client::config::{Config, SocketType};
 use clap::ArgMatches;
 use url::Url;
 
-pub(crate) const TESTNET_MODE_ARG_NAME: &str = "testnet-mode";
+pub(crate) const DISABLED_CREDENTIALS_MODE_ARG_NAME: &str = "testnet-mode";
 #[cfg(not(feature = "coconut"))]
 pub(crate) const ETH_ENDPOINT_ARG_NAME: &str = "eth_endpoint";
 #[cfg(not(feature = "coconut"))]
@@ -72,8 +72,8 @@ pub(crate) fn override_config(mut config: Config, matches: &ArgMatches<'_>) -> C
             .with_eth_private_key(DEFAULT_ETH_PRIVATE_KEY);
     }
 
-    if !cfg!(feature = "eth") || matches.is_present(TESTNET_MODE_ARG_NAME) {
-        config.get_base_mut().with_testnet_mode(true)
+    if !cfg!(feature = "eth") || matches.is_present(DISABLED_CREDENTIALS_MODE_ARG_NAME) {
+        config.get_base_mut().with_disabled_credentials(true)
     }
 
     config

diff --git a/clients/native/src/commands/run.rs b/clients/native/src/commands/run.rs
@@ -6,7 +6,9 @@ use crate::client::NymClient;
 use crate::commands::override_config;
 #[cfg(feature = "eth")]
 #[cfg(not(feature = "coconut"))]
-use crate::commands::{ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME, TESTNET_MODE_ARG_NAME};
+use crate::commands::{
+    DISABLED_CREDENTIALS_MODE_ARG_NAME, ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME,
+};
 use clap::{App, Arg, ArgMatches};
 use config::NymConfig;
 use log::*;
@@ -46,9 +48,9 @@ pub fn command_args<'a, 'b>() -> clap::App<'a, 'b> {
     #[cfg(not(feature = "coconut"))]
         let app = app
         .arg(
-            Arg::with_name(TESTNET_MODE_ARG_NAME)
-                .long(TESTNET_MODE_ARG_NAME)
-                .help("Set this client to work in a testnet mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
+            Arg::with_name(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .long(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .help("Set this client to work in a disabled credentials mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
                 .conflicts_with_all(&[ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME])
         )
         .arg(Arg::with_name(ETH_ENDPOINT_ARG_NAME)

diff --git a/clients/socks5/src/client/config/template.rs b/clients/socks5/src/client/config/template.rs
@@ -19,9 +19,9 @@ version = '{{ client.version }}'
 # Human readable ID of this particular client.
 id = '{{ client.id }}'
 
-# Indicates whether this client is running in a testnet mode, thus attempting
+# Indicates whether this client is running in a disabled credentials mode, thus attempting
 # to claim bandwidth without presenting bandwidth credentials.
-testnet_mode = {{ client.testnet_mode }}
+disabled_credentials_mode = {{ client.disabled_credentials_mode }}
 
 # Addresses to APIs running on validator from which the client gets the view of the network.
 validator_api_urls = [

diff --git a/clients/socks5/src/client/mod.rs b/clients/socks5/src/client/mod.rs
@@ -187,8 +187,8 @@ impl NymClient {
             Some(bandwidth_controller),
         );
 
-        if self.config.get_base().get_testnet_mode() {
-            gateway_client.set_testnet_mode(true)
+        if self.config.get_base().get_disabled_credentials_mode() {
+            gateway_client.set_disabled_credentials_mode(true)
         }
         gateway_client
             .authenticate_and_start()

diff --git a/clients/socks5/src/commands/init.rs b/clients/socks5/src/commands/init.rs
@@ -22,8 +22,8 @@ use crate::commands::override_config;
 #[cfg(feature = "eth")]
 #[cfg(not(feature = "coconut"))]
 use crate::commands::{
-    DEFAULT_ETH_ENDPOINT, DEFAULT_ETH_PRIVATE_KEY, ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME,
-    TESTNET_MODE_ARG_NAME,
+    DEFAULT_ETH_ENDPOINT, DEFAULT_ETH_PRIVATE_KEY, DISABLED_CREDENTIALS_MODE_ARG_NAME,
+    ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME,
 };
 
 pub fn command_args<'a, 'b>() -> clap::App<'a, 'b> {
@@ -66,22 +66,22 @@ pub fn command_args<'a, 'b>() -> clap::App<'a, 'b> {
     #[cfg(not(feature = "coconut"))]
         let app = app
         .arg(
-            Arg::with_name(TESTNET_MODE_ARG_NAME)
-                .long(TESTNET_MODE_ARG_NAME)
-                .help("Set this client to work in a testnet mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
+            Arg::with_name(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .long(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .help("Set this client to work in a disabled credentials mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
                 .conflicts_with_all(&[ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME])
         )
         .arg(Arg::with_name(ETH_ENDPOINT_ARG_NAME)
             .long(ETH_ENDPOINT_ARG_NAME)
             .help("URL of an Ethereum full node that we want to use for getting bandwidth tokens from ERC20 tokens. If you don't want to set this value, use --testnet-mode instead")
             .takes_value(true)
-            .default_value_if(TESTNET_MODE_ARG_NAME, None, DEFAULT_ETH_ENDPOINT)
+            .default_value_if(DISABLED_CREDENTIALS_MODE_ARG_NAME, None, DEFAULT_ETH_ENDPOINT)
             .required(true))
         .arg(Arg::with_name(ETH_PRIVATE_KEY_ARG_NAME)
             .long(ETH_PRIVATE_KEY_ARG_NAME)
             .help("Ethereum private key used for obtaining bandwidth tokens from ERC20 tokens. If you don't want to set this value, use --testnet-mode instead")
             .takes_value(true)
-            .default_value_if(TESTNET_MODE_ARG_NAME, None, DEFAULT_ETH_PRIVATE_KEY)
+            .default_value_if(DISABLED_CREDENTIALS_MODE_ARG_NAME, None, DEFAULT_ETH_PRIVATE_KEY)
             .required(true)
         );
 

diff --git a/clients/socks5/src/commands/mod.rs b/clients/socks5/src/commands/mod.rs
@@ -9,7 +9,7 @@ pub(crate) mod init;
 pub(crate) mod run;
 pub(crate) mod upgrade;
 
-pub(crate) const TESTNET_MODE_ARG_NAME: &str = "testnet-mode";
+pub(crate) const DISABLED_CREDENTIALS_MODE_ARG_NAME: &str = "testnet-mode";
 #[cfg(not(feature = "coconut"))]
 pub(crate) const ETH_ENDPOINT_ARG_NAME: &str = "eth_endpoint";
 #[cfg(not(feature = "coconut"))]
@@ -68,8 +68,8 @@ pub(crate) fn override_config(mut config: Config, matches: &ArgMatches<'_>) -> C
             .with_eth_private_key(DEFAULT_ETH_PRIVATE_KEY);
     }
 
-    if !cfg!(feature = "eth") || matches.is_present(TESTNET_MODE_ARG_NAME) {
-        config.get_base_mut().with_testnet_mode(true)
+    if !cfg!(feature = "eth") || matches.is_present(DISABLED_CREDENTIALS_MODE_ARG_NAME) {
+        config.get_base_mut().with_disabled_credentials(true)
     }
 
     config

diff --git a/clients/socks5/src/commands/run.rs b/clients/socks5/src/commands/run.rs
@@ -6,7 +6,9 @@ use crate::client::NymClient;
 use crate::commands::override_config;
 #[cfg(feature = "eth")]
 #[cfg(not(feature = "coconut"))]
-use crate::commands::{ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME, TESTNET_MODE_ARG_NAME};
+use crate::commands::{
+    DISABLED_CREDENTIALS_MODE_ARG_NAME, ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME,
+};
 use clap::{App, Arg, ArgMatches};
 use config::NymConfig;
 use log::*;
@@ -52,9 +54,9 @@ pub fn command_args<'a, 'b>() -> clap::App<'a, 'b> {
     #[cfg(not(feature = "coconut"))]
     let app = app
         .arg(
-            Arg::with_name(TESTNET_MODE_ARG_NAME)
-                .long(TESTNET_MODE_ARG_NAME)
-                .help("Set this client to work in a testnet mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
+            Arg::with_name(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .long(DISABLED_CREDENTIALS_MODE_ARG_NAME)
+                .help("Set this client to work in a disabled credentials mode that would attempt to use gateway without bandwidth credential requirement. If this value is set, --eth_endpoint and --eth_private_key don't need to be set.")
                 .conflicts_with_all(&[ETH_ENDPOINT_ARG_NAME, ETH_PRIVATE_KEY_ARG_NAME])
         )
         .arg(Arg::with_name(ETH_ENDPOINT_ARG_NAME)

diff --git a/clients/webassembly/src/client/mod.rs b/clients/webassembly/src/client/mod.rs
@@ -26,7 +26,7 @@ const DEFAULT_GATEWAY_RESPONSE_TIMEOUT: Duration = Duration::from_millis(1_500);
 #[wasm_bindgen]
 pub struct NymClient {
     validator_server: Url,
-    testnet_mode: bool,
+    disabled_credentials_mode: bool,
 
     // TODO: technically this doesn't need to be an Arc since wasm is run on a single thread
     // however, once we eventually combine this code with the native-client's, it will make things
@@ -72,7 +72,7 @@ impl NymClient {
 
             on_message: None,
             on_gateway_connect: None,
-            testnet_mode: true,
+            disabled_credentials_mode: true,
         }
     }
 
@@ -85,9 +85,12 @@ impl NymClient {
         self.on_gateway_connect = Some(on_connect)
     }
 
-    pub fn set_testnet_mode(&mut self, testnet_mode: bool) {
-        console_log!("Setting testnet mode to {}", testnet_mode);
-        self.testnet_mode = testnet_mode;
+    pub fn set_disabled_credentials_mode(&mut self, disabled_credentials_mode: bool) {
+        console_log!(
+            "Setting disabled credentials mode to {}",
+            disabled_credentials_mode
+        );
+        self.disabled_credentials_mode = disabled_credentials_mode;
     }
 
     fn self_recipient(&self) -> Recipient {
@@ -107,7 +110,7 @@ impl NymClient {
 
     // Right now it's impossible to have async exported functions to take `&self` rather than self
     pub async fn initial_setup(self) -> Self {
-        let testnet_mode = self.testnet_mode;
+        let disabled_credentials_mode = self.disabled_credentials_mode;
 
         let bandwidth_controller = None;
 
@@ -129,8 +132,8 @@ impl NymClient {
             bandwidth_controller,
         );
 
-        if testnet_mode {
-            gateway_client.set_testnet_mode(true)
+        if disabled_credentials_mode {
+            gateway_client.set_disabled_credentials_mode(true)
         }
 
         gateway_client

diff --git a/common/client-libs/gateway-client/src/client.rs b/common/client-libs/gateway-client/src/client.rs
@@ -45,7 +45,7 @@ const DEFAULT_RECONNECTION_BACKOFF: Duration = Duration::from_secs(5);
 
 pub struct GatewayClient {
     authenticated: bool,
-    testnet_mode: bool,
+    disabled_credentials_mode: bool,
     bandwidth_remaining: i64,
     gateway_address: String,
     gateway_identity: identity::PublicKey,
@@ -83,7 +83,7 @@ impl GatewayClient {
     ) -> Self {
         GatewayClient {
             authenticated: false,
-            testnet_mode: false,
+            disabled_credentials_mode: false,
             bandwidth_remaining: 0,
             gateway_address,
             gateway_identity,
@@ -100,8 +100,8 @@ impl GatewayClient {
         }
     }
 
-    pub fn set_testnet_mode(&mut self, testnet_mode: bool) {
-        self.testnet_mode = testnet_mode
+    pub fn set_disabled_credentials_mode(&mut self, disabled_credentials_mode: bool) {
+        self.disabled_credentials_mode = disabled_credentials_mode
     }
 
     // TODO: later convert into proper builder methods
@@ -134,7 +134,7 @@ impl GatewayClient {
 
         GatewayClient {
             authenticated: false,
-            testnet_mode: false,
+            disabled_credentials_mode: false,
             bandwidth_remaining: 0,
             gateway_address,
             gateway_identity,
@@ -548,13 +548,13 @@ impl GatewayClient {
         if self.shared_key.is_none() {
             return Err(GatewayClientError::NoSharedKeyAvailable);
         }
-        if self.bandwidth_controller.is_none() && !self.testnet_mode {
+        if self.bandwidth_controller.is_none() && !self.disabled_credentials_mode {
             return Err(GatewayClientError::NoBandwidthControllerAvailable);
         }
 
         warn!("Not enough bandwidth. Trying to get more bandwidth, this might take a while");
-        if self.testnet_mode {
-            info!("The client is running in testnet mode - attempting to claim bandwidth without a credential");
+        if self.disabled_credentials_mode {
+            info!("The client is running in disabled credentials mode - attempting to claim bandwidth without a credential");
             return self.try_claim_testnet_bandwidth().await;
         }
 

diff --git a/gateway/src/commands/init.rs b/gateway/src/commands/init.rs
@@ -47,10 +47,10 @@ pub struct Init {
     #[clap(long)]
     mnemonic: String,
 
-    /// Set this gateway to work in a testnet mode that would allow clients to bypass bandwidth credential requirement
+    /// Set this gateway to work in a disabled credentials mode that would allow clients to bypass bandwidth credential requirement
     #[cfg(all(feature = "eth", not(feature = "coconut")))]
     #[clap(long)]
-    testnet_mode: bool,
+    disabled_credentials_mode: bool,
 
     /// URL of an Ethereum full node that we want to use for getting bandwidth tokens from ERC20 tokens
     #[cfg(all(feature = "eth", not(feature = "coconut")))]
@@ -76,7 +76,7 @@ impl From<Init> for OverrideConfig {
             mnemonic: Some(init_config.mnemonic),
 
             #[cfg(all(feature = "eth", not(feature = "coconut")))]
-            testnet_mode: init_config.testnet_mode,
+            disabled_credentials_mode: init_config.disabled_credentials_mode,
 
             #[cfg(all(feature = "eth", not(feature = "coconut")))]
             eth_endpoint: Some(init_config.eth_endpoint),