Merge pull request #1620 from o1-labs/dw/multiaddress-fix

Replayer node - add documentation

Author: dannywillems

cli/src/commands/node/mod.rs

@@ -1,24 +1,18 @@
-use std::{fs::File, path::PathBuf, sync::Arc};
-
 use anyhow::Context;
 use ledger::proofs::provers::BlockProver;
-use node::{
-    account::AccountSecretKey,
-    snark::{BlockVerifier, TransactionVerifier},
-    transition_frontier::genesis::GenesisConfig,
-};
-
 use mina_node_account::AccountPublicKey;
-use reqwest::Url;
-
+use mina_node_native::{archive::config::ArchiveStorageOptions, tracing, NodeBuilder};
 use node::{
+    account::AccountSecretKey,
     core::log::inner::Level,
     p2p::{connection::outgoing::P2pConnectionOutgoingInitOpts, identity::SecretKey},
     service::Recorder,
+    snark::{BlockVerifier, TransactionVerifier},
+    transition_frontier::genesis::GenesisConfig,
     SnarkerStrategy,
 };
-
-use mina_node_native::{archive::config::ArchiveStorageOptions, tracing, NodeBuilder};
+use reqwest::Url;
+use std::{fs::File, path::PathBuf, sync::Arc};
 
 /// Mina node configuration and runtime options
 ///
@@ -216,6 +210,28 @@ pub struct Node {
     #[arg(long, requires = "producer")]
     pub coinbase_receiver: Option<AccountPublicKey>,
 
+    /// Enable recording of node state and actions for debugging and replay
+    ///
+    /// Recording captures the node's state transitions and input actions,
+    /// enabling deterministic replay for debugging and testing purposes.
+    ///
+    /// Available modes:
+    /// - `none`: No recording (default)
+    /// - `state-with-input-actions`: Records initial state and all input
+    ///   actions to the `recorder/` directory within the working directory
+    ///
+    /// Recorded data can be replayed using the `mina replay` command to
+    /// reproduce the exact sequence of state transitions for debugging.
+    ///
+    /// # Example
+    ///
+    /// ```bash
+    /// # Record node execution
+    /// mina node --network devnet --record state-with-input-actions
+    ///
+    /// # Replay recorded execution
+    /// mina replay state-with-input-actions ~/.mina/recorder
+    /// ```
     #[arg(long, default_value = "none", env)]
     pub record: String,
 

node/common/src/lib.rs

@@ -1,7 +1,5 @@
-pub mod tracing;
-
 mod service;
+pub mod tracing;
 pub use service::*;
-
 mod node;
 pub use node::*;

node/common/src/service/service.rs

@@ -1,5 +1,14 @@
-use std::sync::Arc;
-
+use super::{
+    archive::ArchiveService,
+    block_producer::BlockProducerService,
+    p2p::webrtc_with_libp2p::P2pServiceCtx,
+    replay::ReplayerState,
+    rpc::{RpcSender, RpcService},
+    snark_worker::SnarkWorker,
+    snarks::SnarkBlockVerifyArgs,
+    EventReceiver, EventSender,
+};
+use crate::rpc::RpcReceiver;
 use node::{
     core::{channels::mpsc, invariants::InvariantsState},
     event_source::Event,
@@ -14,43 +23,51 @@ use sha3::{
     digest::{core_api::XofReaderCoreWrapper, ExtendableOutput, Update},
     Shake256, Shake256ReaderCore,
 };
-
-use crate::rpc::RpcReceiver;
-
-use super::{
-    archive::ArchiveService,
-    block_producer::BlockProducerService,
-    p2p::webrtc_with_libp2p::P2pServiceCtx,
-    replay::ReplayerState,
-    rpc::{RpcSender, RpcService},
-    snark_worker::SnarkWorker,
-    snarks::SnarkBlockVerifyArgs,
-    EventReceiver, EventSender,
-};
+use std::sync::Arc;
 
 pub struct NodeService {
+    /// Master seed for deterministic random number generation.
     pub rng_seed: [u8; 32],
+    /// XOF-based RNG for ephemeral keys (derived from seed + "ephemeral").
     pub rng_ephemeral: XofReaderCoreWrapper<Shake256ReaderCore>,
+    /// XOF-based RNG for static operations (derived from seed + "static").
     pub rng_static: XofReaderCoreWrapper<Shake256ReaderCore>,
+    /// Standard RNG for general-purpose randomness.
     pub rng: StdRng,
 
     /// Events sent on this channel are retrieved and processed in the
     /// `event_source` state machine defined in the `mina-node` crate.
     pub event_sender: EventSender,
+    /// Channel for consuming events in the event source state machine.
     pub event_receiver: EventReceiver,
 
+    /// Channel for asynchronous block proof verification requests.
     pub snark_block_proof_verify: mpsc::TrackedUnboundedSender<SnarkBlockVerifyArgs>,
 
+    /// Manages ledger operations, database access, and staged ledger state.
     pub ledger_manager: LedgerManager,
+    /// SNARK proof worker for generating transaction proofs (enabled when node
+    /// acts as SNARK worker).
     pub snark_worker: Option<SnarkWorker>,
+    /// Block production service including VRF evaluation and block proving
+    /// (enabled when node acts as block producer).
     pub block_producer: Option<BlockProducerService>,
+    /// Archive service for storing full blockchain history (enabled when node
+    /// acts as archive node).
     pub archive: Option<ArchiveService>,
+    /// P2P networking context (WebRTC and optionally libp2p transports).
     pub p2p: P2pServiceCtx,
 
+    /// Runtime statistics and metrics collection.
     pub stats: Option<Stats>,
+    /// RPC service for external API queries.
     pub rpc: RpcService,
+    /// Records node state and actions for debugging and replay.
     pub recorder: Recorder,
+    /// Replayer state for deterministic action replay (only set in replay
+    /// mode).
     pub replayer: Option<ReplayerState>,
+    /// State for runtime invariant checking and validation.
     pub invariants_state: InvariantsState,
 }
 

node/native/src/replay.rs

@@ -1,13 +1,11 @@
-use std::cell::RefCell;
-
+use crate::NodeService;
 use node::{
     core::thread,
     recorder::StateWithInputActionsReader,
     snark::{BlockVerifier, TransactionVerifier},
     ActionWithMeta, BuildEnv, Store,
 };
-
-use crate::NodeService;
+use std::cell::RefCell;
 
 pub fn replay_state_with_input_actions(
     dir: &str,

node/testing/src/hosts.rs

@@ -1,14 +1,10 @@
+use crate::scenario::ListenerNode;
+use node::p2p::connection::outgoing::P2pConnectionOutgoingInitOpts;
 /// This should be the only place where environment variables are converted to addresses.
 ///
 use std::{env, str::FromStr};
 
-use node::p2p::connection::outgoing::P2pConnectionOutgoingInitOpts;
-
-use crate::scenario::ListenerNode;
-
 pub fn replayer() -> P2pConnectionOutgoingInitOpts {
-    // "/dns4/1.k8.openmina.com/tcp/31968/p2p/12D3KooWPayQEdprqY2m3biReUUybA5LoULpJE7YWu6wetEKKELv",
-
     let multiaddr = env::var("REPLAYER_MULTIADDR")
         .expect("must set variable `REPLAYER_MULTIADDR`")
         .parse::<libp2p::Multiaddr>()

node/testing/src/scenarios/solo_node/bootstrap.rs

@@ -1,15 +1,13 @@
-use std::time::Duration;
-
-use mina_core::constants::constraint_constants;
-use node::transition_frontier::sync::TransitionFrontierSyncState;
-use redux::Instant;
-
 use crate::{
     hosts,
     node::RustNodeTestingConfig,
     scenario::{ListenerNode, ScenarioStep},
     scenarios::ClusterRunner,
 };
+use mina_core::constants::constraint_constants;
+use node::transition_frontier::sync::TransitionFrontierSyncState;
+use redux::Instant;
+use std::time::Duration;
 
 /// Set up single Rust node and bootstrap snarked ledger, bootstrap ledger and blocks.
 ///

website/docs/developers/scripts/replayer/record-node-docker.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Record node execution using Docker
+
+# Create directory for recording
+mkdir -p mina-replay-test
+
+# Run node with recording enabled using Docker
+docker run --rm \
+  -v "$(pwd)/mina-replay-test:/root/.mina" \
+  o1labs/mina-rust:latest \
+  node \
+  --network devnet \
+  --record state-with-input-actions \
+  --work-dir /root/.mina

website/docs/developers/scripts/replayer/record-node.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+# Record node execution for debugging and replay
+
+# Run node with recording enabled
+mina node \
+  --network devnet \
+  --record state-with-input-actions \
+  --work-dir ~/.mina-replay-test

website/docs/developers/scripts/replayer/record-with-custom-dir-docker.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Record with custom directory using Docker
+
+# Create custom directory for recording
+mkdir -p my-custom-replay-dir
+
+# Run node with custom recording directory
+docker run --rm \
+  -v "$(pwd)/my-custom-replay-dir:/root/.mina" \
+  o1labs/mina-rust:latest \
+  node \
+  --network devnet \
+  --record state-with-input-actions \
+  --work-dir /root/.mina

website/docs/developers/scripts/replayer/record-with-custom-dir.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Record node execution with custom working directory
+
+WORK_DIR="$1"
+if [ -z "$WORK_DIR" ]; then
+  echo "Usage: $0 <work-directory>"
+  exit 1
+fi
+
+# Run node with recording enabled using custom directory
+mina node \
+  --network devnet \
+  --record state-with-input-actions \
+  --work-dir "$WORK_DIR"