refactor: further simplify Network type processing

lklimek · lklimek · commit 1264c18d4cc4 · 2025-03-04T12:57:55.000+01:00
diff --git a/packages/rs-sdk/src/networks.rs b/packages/rs-sdk/src/networks.rs
@@ -35,48 +35,19 @@ pub const NETWORK_TESTNET: Network = Network::Testnet;
 
 /// Local development network, run in containers on a local machine for development purposess
 pub const NETWORK_LOCAL: Network = Network::Regtest;
+pub trait NetworkSettings {
+    fn core_network(&self) -> Network;
 
-/// Configuration of the Dash Platform network.
-///
-/// In most cases, you should use [NETWORK_MAINNET], [NETWORK_TESTNET], or [NETWORK_LOCAL] constants.
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
-pub enum NetworkSettings {
-    Default(Network),
-    Custom {
-        core_network: Network,
-        instant_lock_quorum_type: QuorumType,
-    },
-    /// Mock network for testing purposes
-    #[cfg(feature = "mocks")]
-    Mock,
+    fn chain_locks_quorum_type(&self) -> QuorumType;
 }
 
-impl NetworkSettings {
-    pub fn core_network(&self) -> Network {
-        match self {
-            Self::Default(network) => *network,
-            Self::Custom { core_network, .. } => *core_network,
-            #[cfg(feature = "mocks")]
-            Self::Mock => NETWORK_LOCAL,
-        }
+impl NetworkSettings for Network {
+    fn core_network(&self) -> Network {
+        *self
     }
 
-    pub fn chain_locks_type(&self) -> QuorumType {
-        let llmq_type = match self {
-            Self::Default(network) => network.chain_locks_type() as u32,
-            Self::Custom {
-                instant_lock_quorum_type,
-                ..
-            } => *instant_lock_quorum_type as u32,
-            #[cfg(feature = "mocks")]
-            Self::Mock => self.core_network().chain_locks_type() as u32,
-        };
-        QuorumType::from(llmq_type)
-    }
-}
-
-impl From<Network> for NetworkSettings {
-    fn from(network: Network) -> Self {
-        NetworkSettings::Default(network)
+    fn chain_locks_quorum_type(&self) -> QuorumType {
+        let llmq_type: u8 = self.chain_locks_type().into();
+        QuorumType::from(llmq_type as u32)
     }
 }
diff --git a/packages/rs-sdk/src/platform/transition/asset_lock.rs b/packages/rs-sdk/src/platform/transition/asset_lock.rs
@@ -1,5 +1,6 @@
 //! [AssetLockProof] utilities
 
+use crate::networks::NetworkSettings;
 use crate::{Error, Sdk};
 use dapi_grpc::platform::v0::get_epochs_info_request::{self, GetEpochsInfoRequestV0};
 use dapi_grpc::platform::v0::GetEpochsInfoRequest;
@@ -71,7 +72,7 @@ impl AssetLockProofVerifier for AssetLockProof {
                     .cyclehash
                     .to_raw_hash()
                     .to_byte_array();
-                let quorum_type = sdk.quorum_params().instant_lock_quorum_type;
+                let quorum_type: QuorumType = sdk.network_settings().chain_locks_quorum_type();
                 // Try to fetch the quorum public key; if it fails, we assume platform does not have this quorum yet
                 let quorum_pubkey = match context_provider.get_quorum_public_key(
                     quorum_type as u32,
@@ -183,7 +184,7 @@ fn verify_instant_lock_signature(
 mod tests {
 
     use dashcore_rpc::json::QuorumType;
-    use dpp::dashcore::{consensus::deserialize, InstantLock};
+    use dpp::dashcore::{consensus::deserialize, hashes::Hash, InstantLock};
 
     use crate::platform::transition::asset_lock::verify_instant_lock_signature;
 
diff --git a/packages/rs-sdk/src/sdk.rs b/packages/rs-sdk/src/sdk.rs
@@ -97,7 +97,7 @@ pub type LastQueryTimestamp = u64;
 pub struct Sdk {
     inner: SdkInstance,
     /// Type of network we use. Determines some parameters, like quorum types.
-    network_settings: NetworkSettings,
+    network: Network,
     /// Use proofs when retrieving data from the platform.
     ///
     /// This is set to `true` by default. `false` is not implemented yet.
@@ -149,7 +149,7 @@ impl Clone for Sdk {
             metadata_height_tolerance: self.metadata_height_tolerance,
             metadata_time_tolerance_ms: self.metadata_time_tolerance_ms,
             dapi_client_settings: self.dapi_client_settings,
-            network_settings: self.network_settings,
+            network: self.network,
             #[cfg(feature = "mocks")]
             dump_dir: self.dump_dir.clone(),
         }
@@ -278,7 +278,7 @@ impl Sdk {
 
     /// Get configured Dash Core network type.
     pub fn core_network(&self) -> Network {
-        self.network_settings.core_network()
+        self.network.core_network()
     }
 
     /// Retrieve object `O` from proof contained in `request` (of type `R`) and `response`.
@@ -305,7 +305,7 @@ impl Sdk {
             SdkInstance::Dapi { .. } => O::maybe_from_proof_with_metadata(
                 request,
                 response,
-                self.network_settings.core_network(),
+                self.network.core_network(),
                 self.version(),
                 &provider,
             ),
@@ -533,8 +533,8 @@ impl Sdk {
     }
 
     /// Return configuration of quorum, like type of quorum used for instant lock.
-    pub(crate) fn network_settings(&self) -> NetworkSettings {
-        self.network_settings
+    pub(crate) fn network_settings(&self) -> Network {
+        self.network
     }
 
     /// Return [Dash Platform version](PlatformVersion) information used by this SDK.
@@ -731,8 +731,10 @@ pub struct SdkBuilder {
     core_user: String,
     core_password: Zeroizing<String>,
 
-    /// Customized network settings of a Dash network used by the SDK.
-    network_settings: NetworkSettings,
+    /// Dash Core network type used by the SDK.
+    ///
+    /// Defaults to [NETWORK_MAINNET](crate::networks::NETWORK_MAINNET).
+    network: Network,
 
     /// If true, request and verify proofs of the responses.
     proofs: bool,
@@ -784,7 +786,7 @@ impl Default for SdkBuilder {
             core_port: 0,
             core_password: "".to_string().into(),
             core_user: "".to_string(),
-            network_settings: NETWORK_MAINNET.into(),
+            network: NETWORK_MAINNET,
             proofs: true,
             metadata_height_tolerance: Some(1),
             metadata_time_tolerance_ms: None,
@@ -825,7 +827,7 @@ impl SdkBuilder {
 
     /// Create a new SdkBuilder that will generate mock client.
     pub fn new_mock() -> Self {
-        Self::default().with_network_settings(NetworkSettings::Mock)
+        Self::default()
     }
 
     /// Create a new SdkBuilder instance preconfigured for testnet. NOT IMPLEMENTED YET.
@@ -867,8 +869,9 @@ impl SdkBuilder {
     /// Defaults to [NETWORK_MAINNET](crate::networks::NETWORK_MAINNET).
     ///
     /// For more control over the configuration, use [SdkBuilder::with_network_settings()].
-    pub fn with_network(self, network: Network) -> Self {
-        self.with_network_settings(network)
+    pub fn with_network(mut self, network: Network) -> Self {
+        self.network = network;
+        self
     }
 
     /// Configure CA certificate to use when verifying TLS connections.
@@ -953,15 +956,6 @@ impl SdkBuilder {
         self
     }
 
-    /// Customize custom Dash Platform network settings.
-    ///
-    /// This method is aimed for advanced use cases, where [SdkBuilder::with_network()] is not good enough.
-    /// It allows to configure network settings like quorum type, network type, etc. by creating [NetworkSettings] directly.
-    pub fn with_network_settings<T: Into<NetworkSettings>>(mut self, network_type: T) -> Self {
-        self.network_settings = network_type.into();
-        self
-    }
-
     /// Use Dash Core as a wallet and context provider.
     ///
     /// This is a convenience method that configures the SDK to use Dash Core as a wallet and context provider.
@@ -1063,7 +1057,7 @@ impl SdkBuilder {
                 let mut sdk= Sdk{
                     dapi_client_settings,
                     inner:SdkInstance::Dapi { dapi,  version:self.version },
-                    network_settings: self.network_settings,
+                    network: self.network,
                     proofs:self.proofs,
                     context_provider: ArcSwapOption::new( self.context_provider.map(Arc::new)),
                     cancel_token: self.cancel_token,
@@ -1131,7 +1125,7 @@ impl SdkBuilder {
                         address_list: AddressList::new(),
                         version: self.version,
                     },
-                    network_settings: self.network_settings,
+                    network: self.network,
                     dump_dir: self.dump_dir.clone(),
                     proofs:self.proofs,
                     internal_cache: Default::default(),
