Validator on-boarding docs (#656)

* Add first draft of validator onboarding * Update docs * Add documentation link to main README * Continue docs development * Update book readme * Update docs * Allow vc to run without testnet subcommand * Small change to onboarding docs * Tidy CLI help messages * Update docs * Add check to val client see if beacon node is synced * Add notifier service to validator client * Re-order onboarding steps * Update deposit contract address * Update testnet dir * Add note about public eth1 node * Set default eth1 endpoint to sigp * Fix broken test * Try fix eth1 cache locking * Be more specific about eth1 endpoint * Increase gas limit for deposit * Fix default deposit amount
2026-03-22 14:24:44 +00:00 · 2019-12-09 22:42:36 +11:00
parent f1edca30ff
commit 3c6c06a505
19 changed files with 548 additions and 57 deletions
--- a/validator_client/src/notifier.rs
+++ b/validator_client/src/notifier.rs
@@ -0,0 +1,91 @@
+use crate::ProductionValidatorClient;
+use exit_future::Signal;
+use futures::{Future, Stream};
+use slog::{error, info};
+use slot_clock::SlotClock;
+use std::time::{Duration, Instant};
+use tokio::timer::Interval;
+use types::EthSpec;
+
+/// Spawns a notifier service which periodically logs information about the node.
+pub fn spawn_notifier<T: EthSpec>(client: &ProductionValidatorClient<T>) -> Result<Signal, String> {
+    let context = client.context.service_context("notifier".into());
+
+    let slot_duration = Duration::from_millis(context.eth2_config.spec.milliseconds_per_slot);
+    let duration_to_next_slot = client
+        .duties_service
+        .slot_clock
+        .duration_to_next_slot()
+        .ok_or_else(|| "slot_notifier unable to determine time to next slot")?;
+
+    // Run this half way through each slot.
+    let start_instant = Instant::now() + duration_to_next_slot + (slot_duration / 2);
+
+    // Run this each slot.
+    let interval_duration = slot_duration;
+
+    let duties_service = client.duties_service.clone();
+    let log_1 = context.log.clone();
+    let log_2 = context.log.clone();
+
+    let interval_future = Interval::new(start_instant, interval_duration)
+        .map_err(
+            move |e| error!(log_1, "Slot notifier timer failed"; "error" => format!("{:?}", e)),
+        )
+        .for_each(move |_| {
+            let log = log_2.clone();
+
+            if let Some(slot) = duties_service.slot_clock.now() {
+                let epoch = slot.epoch(T::slots_per_epoch());
+
+                let total_validators = duties_service.total_validator_count();
+                let proposing_validators = duties_service.proposer_count(epoch);
+                let attesting_validators = duties_service.attester_count(epoch);
+
+                if total_validators == 0 {
+                    error!(log, "No validators present")
+                } else if total_validators == attesting_validators {
+                    info!(
+                        log_2,
+                        "All validators active";
+                        "proposers" => proposing_validators,
+                        "active_validators" => attesting_validators,
+                        "total_validators" => total_validators,
+                        "epoch" => format!("{}", epoch),
+                        "slot" => format!("{}", slot),
+                    );
+                } else if attesting_validators > 0 {
+                    info!(
+                        log_2,
+                        "Some validators active";
+                        "proposers" => proposing_validators,
+                        "active_validators" => attesting_validators,
+                        "total_validators" => total_validators,
+                        "epoch" => format!("{}", epoch),
+                        "slot" => format!("{}", slot),
+                    );
+                } else {
+                    info!(
+                        log_2,
+                        "Awaiting activation";
+                        "validators" => total_validators,
+                        "epoch" => format!("{}", epoch),
+                        "slot" => format!("{}", slot),
+                    );
+                }
+            } else {
+                error!(log, "Unable to read slot clock");
+            }
+
+            Ok(())
+        });
+
+    let (exit_signal, exit) = exit_future::signal();
+    let log = context.log.clone();
+    client.context.executor.spawn(
+        exit.until(interval_future)
+            .map(move |_| info!(log, "Shutdown complete")),
+    );
+
+    Ok(exit_signal)
+}