refactor: UpdatableValidatorSigner (#12857)

near · Feb 3, 2025 · 6c774bc · 6c774bc
1 parent 4f20d61
commit 6c774bc
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 14 deletions.
diff --git a/chain/client/src/config_updater.rs b/chain/client/src/config_updater.rs
@@ -1,5 +1,5 @@
 use near_chain_configs::UpdatableClientConfig;
-use near_dyn_configs::{UpdatableConfigLoaderError, UpdatableConfigs};
+use near_dyn_configs::{UpdatableConfigLoaderError, UpdatableConfigs, UpdatableValidatorSigner};
 use near_primitives::validator_signer::ValidatorSigner;
 use std::sync::Arc;
 use tokio::sync::broadcast::Receiver;
@@ -44,7 +44,9 @@ impl ConfigUpdater {
                             update_client_config_fn(client_config);
                         tracing::info!(target: "config", "Updated ClientConfig");
                     }
-                    if let Some(validator_signer) = updatable_configs.validator_signer {
+                    if let UpdatableValidatorSigner::MaybeKey(validator_signer) =
+                        updatable_configs.validator_signer
+                    {
                         update_result.validator_signer_updated |=
                             update_validator_signer_fn(validator_signer);
                         tracing::info!(target: "config", "Updated validator key");

diff --git a/core/chain-configs/src/lib.rs b/core/chain-configs/src/lib.rs
@@ -34,9 +34,7 @@ pub use genesis_config::{
 };
 use near_primitives::types::{Balance, BlockHeightDelta, Gas, NumBlocks, NumSeats};
 use num_rational::Rational32;
-pub use updatable_config::{
-    MutableConfigValue, MutableValidatorSigner, UpdatableClientConfig, UpdatableValidatorSigner,
-};
+pub use updatable_config::{MutableConfigValue, MutableValidatorSigner, UpdatableClientConfig};
 
 pub const GENESIS_CONFIG_FILENAME: &str = "genesis.json";
 

diff --git a/core/chain-configs/src/updatable_config.rs b/core/chain-configs/src/updatable_config.rs
@@ -110,5 +110,4 @@ pub struct UpdatableClientConfig {
     pub produce_chunk_add_transactions_time_limit: Option<Duration>,
 }
 
-pub type UpdatableValidatorSigner = Option<Arc<ValidatorSigner>>;
 pub type MutableValidatorSigner = MutableConfigValue<Option<Arc<ValidatorSigner>>>;
diff --git a/core/dyn-configs/src/lib.rs b/core/dyn-configs/src/lib.rs
@@ -1,14 +1,24 @@
 #![doc = include_str!("../README.md")]
 
-use near_chain_configs::{UpdatableClientConfig, UpdatableValidatorSigner};
+use near_chain_configs::UpdatableClientConfig;
 use near_o11y::log_config::LogConfig;
+use near_primitives::validator_signer::ValidatorSigner;
 use near_time::Clock;
 use std::path::PathBuf;
 use std::sync::Arc;
 use tokio::sync::broadcast::Sender;
 
 mod metrics;
 
+#[derive(Clone, Default)]
+pub enum UpdatableValidatorSigner {
+    /// Validator key existence could not be determined.
+    #[default]
+    KeyExistenceNotDetermined,
+    /// The new state of the validator key.
+    MaybeKey(Option<Arc<ValidatorSigner>>),
+}
+
 #[derive(Clone, Default)]
 /// Contains the latest state of configs which can be updated at runtime.
 pub struct UpdatableConfigs {
@@ -17,9 +27,7 @@ pub struct UpdatableConfigs {
     /// Contents of the `config.json` corresponding to the mutable fields of `ClientConfig`.
     pub client_config: Option<UpdatableClientConfig>,
     /// Validator key hot loaded from file.
-    /// `None` means that the validator key existence could not be determined.
-    /// `Some(None)` means that it was determined that the validator key does not exist.
-    pub validator_signer: Option<UpdatableValidatorSigner>,
+    pub validator_signer: UpdatableValidatorSigner,
 }
 
 /// Pushes the updates to listeners.

diff --git a/nearcore/src/dyn_config.rs b/nearcore/src/dyn_config.rs
@@ -1,6 +1,6 @@
 use crate::config::Config;
 use near_chain_configs::UpdatableClientConfig;
-use near_dyn_configs::{UpdatableConfigLoaderError, UpdatableConfigs};
+use near_dyn_configs::{UpdatableConfigLoaderError, UpdatableConfigs, UpdatableValidatorSigner};
 use near_o11y::log_config::LogConfig;
 use near_primitives::validator_signer::ValidatorSigner;
 use serde::Deserialize;
@@ -35,14 +35,14 @@ pub fn read_updatable_configs(
 
     let validator_signer = if let Some(config) = config {
         match read_validator_key(home_dir, &config) {
-            Ok(validator_key) => Some(validator_key),
+            Ok(validator_key) => UpdatableValidatorSigner::MaybeKey(validator_key),
             Err(err) => {
                 errs.push(err);
-                None
+                UpdatableValidatorSigner::KeyExistenceNotDetermined
             }
         }
     } else {
-        None
+        UpdatableValidatorSigner::KeyExistenceNotDetermined
     };
 
     if errs.is_empty() {