Merge pull request #4736 from nymtech/jon/nym-vpn-api-env

Add NYM_VPN_API to network config

Author: tommyv1987

common/network-defaults/src/lib.rs

@@ -42,6 +42,7 @@ pub struct NymNetworkDetails {
     pub endpoints: Vec<ValidatorDetails>,
     pub contracts: NymContracts,
     pub explorer_api: Option<String>,
+    pub nym_vpn_api_url: Option<String>,
 }
 
 // by default we assume the same defaults as mainnet, i.e. same prefixes and denoms
@@ -71,6 +72,7 @@ impl NymNetworkDetails {
             endpoints: Default::default(),
             contracts: Default::default(),
             explorer_api: Default::default(),
+            nym_vpn_api_url: Default::default(),
         }
     }
 
@@ -126,6 +128,7 @@ impl NymNetworkDetails {
             .with_multisig_contract(get_optional_env(var_names::MULTISIG_CONTRACT_ADDRESS))
             .with_coconut_dkg_contract(get_optional_env(var_names::COCONUT_DKG_CONTRACT_ADDRESS))
             .with_explorer_api(get_optional_env(var_names::EXPLORER_API))
+            .with_nym_vpn_api_url(get_optional_env(var_names::NYM_VPN_API))
     }
 
     pub fn new_mainnet() -> Self {
@@ -155,6 +158,7 @@ impl NymNetworkDetails {
                 ),
             },
             explorer_api: parse_optional_str(mainnet::EXPLORER_API),
+            nym_vpn_api_url: parse_optional_str(mainnet::NYM_VPN_API),
         }
     }
 
@@ -263,6 +267,19 @@ impl NymNetworkDetails {
         self.explorer_api = endpoint.map(Into::into);
         self
     }
+
+    #[must_use]
+    pub fn with_nym_vpn_api_url<S: Into<String>>(mut self, endpoint: Option<S>) -> Self {
+        self.nym_vpn_api_url = endpoint.map(Into::into);
+        self
+    }
+
+    pub fn nym_vpn_api_url(&self) -> Option<Url> {
+        self.nym_vpn_api_url.as_ref().map(|url| {
+            url.parse()
+                .expect("the provided nym-vpn api url is invalid!")
+        })
+    }
 }
 
 #[derive(Debug, Copy, Serialize, Deserialize, Clone, PartialEq, Eq)]

common/network-defaults/src/mainnet.rs

@@ -31,6 +31,7 @@ pub const NYXD_URL: &str = "https://rpc.nymtech.net";
 pub const NYM_API: &str = "https://validator.nymtech.net/api/";
 pub const NYXD_WS: &str = "wss://rpc.nymtech.net/websocket";
 pub const EXPLORER_API: &str = "https://explorer.nymtech.net/api/";
+pub const NYM_VPN_API: &str = "https://nymvpn.net/api/";
 
 // I'm making clippy mad on purpose, because that url HAS TO be updated and deployed before merging
 pub const EXIT_POLICY_URL: &str =
@@ -114,6 +115,7 @@ pub fn export_to_env() {
     set_var_to_default(var_names::NYXD_WEBSOCKET, NYXD_WS);
     set_var_to_default(var_names::EXPLORER_API, EXPLORER_API);
     set_var_to_default(var_names::EXIT_POLICY_URL, EXIT_POLICY_URL);
+    set_var_to_default(var_names::NYM_VPN_API, NYM_VPN_API);
 }
 
 pub fn export_to_env_if_not_set() {
@@ -155,4 +157,5 @@ pub fn export_to_env_if_not_set() {
     set_var_conditionally_to_default(var_names::NYXD_WEBSOCKET, NYXD_WS);
     set_var_conditionally_to_default(var_names::EXPLORER_API, EXPLORER_API);
     set_var_conditionally_to_default(var_names::EXIT_POLICY_URL, EXIT_POLICY_URL);
+    set_var_conditionally_to_default(var_names::NYM_VPN_API, NYM_VPN_API);
 }

common/network-defaults/src/var_names.rs

@@ -24,6 +24,7 @@ pub const NYM_API: &str = "NYM_API";
 pub const NYXD_WEBSOCKET: &str = "NYXD_WS";
 pub const EXPLORER_API: &str = "EXPLORER_API";
 pub const EXIT_POLICY_URL: &str = "EXIT_POLICY";
+pub const NYM_VPN_API: &str = "NYM_VPN_API";
 
 pub const DKG_TIME_CONFIGURATION: &str = "DKG_TIME_CONFIGURATION";
 

envs/canary.env

@@ -20,3 +20,4 @@ COCONUT_DKG_CONTRACT_ADDRESS=n1aakfpghcanxtc45gpqlx8j3rq0zcpyf49qmhm9mdjrfx036h4
 EXPLORER_API=https://canary-explorer.performance.nymte.ch/api
 NYXD="https://canary-validator.performance.nymte.ch"
 NYM_API="https://canary-api.performance.nymte.ch/api"
+NYM_VPN_API="https://foo/api"

envs/mainnet.env

@@ -24,3 +24,4 @@ NYXD="https://rpc.nymtech.net"
 NYM_API="https://validator.nymtech.net/api/"
 NYXD_WS="wss://rpc.nymtech.net/websocket"
 EXPLORER_API="https://explorer.nymtech.net/api/"
+NYM_VPN_API="https://nymvpn.com/api"

nym-wallet/Cargo.lock

@@ -56,5 +56,6 @@ pub(crate) fn network_details() -> nym_network_defaults::NymNetworkDetails {
             coconut_dkg_contract_address: parse_optional_str(COCONUT_DKG_CONTRACT_ADDRESS),
         },
         explorer_api: parse_optional_str(EXPLORER_API),
+        nym_vpn_api_url: None,
     }
 }

nym-wallet/nym-wallet-types/src/network/qa.rs

@@ -56,5 +56,6 @@ pub(crate) fn network_details() -> nym_network_defaults::NymNetworkDetails {
             coconut_dkg_contract_address: parse_optional_str(COCONUT_DKG_CONTRACT_ADDRESS),
         },
         explorer_api: parse_optional_str(EXPLORER_API),
+        nym_vpn_api_url: None,
     }
 }