add minimal listener

Author: patrick-ogrady

.github/workflows/publish.yml

@@ -32,3 +32,8 @@ jobs:
       continue-on-error: true
       env:
         CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+    - name: Publish inspector
+      run: cargo publish --manifest-path inspector/Cargo.toml
+      continue-on-error: true
+      env:
+        CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

Cargo.lock

@@ -2,6 +2,7 @@
 members = [
     "chain",
     "client",
+    "inspector",
     "types",
 ]
 resolver = "2"
@@ -30,6 +31,7 @@ tracing = "0.1.41"
 tracing-subscriber = "0.3.19"
 governor = "0.6.3"
 prometheus-client = "0.22.3"
+clap = "4.5.18"
 
 [profile.bench]
 # Because we enable overflow checks in "release," we should benchmark with them.

Cargo.toml

@@ -8,6 +8,7 @@
 
 * [chain](./chain/README.md): A minimal blockchain built with the [Commonware Library](https://github.com/commonwarexyz/monorepo).
 * [client](./client/README.md): Client for interacting with `alto`.
+* [inspector](./inspector/README.md): Monitor `alto` activity.
 * [types](./types/README.md): Common types used throughout `alto`.
 
 ## Licensing

README.md

@@ -31,8 +31,8 @@ tracing = { workspace = true }
 tracing-subscriber = { workspace = true, features = ["fmt", "json"] }
 governor = { workspace = true }
 prometheus-client = { workspace = true }
+clap = { workspace = true }
 sysinfo = "0.33.1"
-clap = "4.5.18"
 axum = "0.8.1"
 uuid = "1.15.1"
 serde = { version = "1.0.218", features = ["derive"] }

chain/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "alto-inspector"
+version = "0.0.2"
+publish = true
+edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Monitor alto activity."
+readme = "README.md"
+homepage = "https://alto.commonware.xyz"
+repository = "https://github.com/commonwarexyz/alto/tree/main/inspector"
+documentation = "https://docs.rs/alto-inspector"
+
+[dependencies]
+commonware-cryptography = { workspace = true }
+commonware-utils = { workspace = true }
+alto-types = { workspace = true }
+alto-client = { workspace = true }
+bytes =  { workspace = true }
+rand = { workspace = true }
+thiserror = { workspace = true }
+clap = { workspace = true }
+tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
+tokio = { version = "1.40.0", features = ["full"] }
+futures = { workspace = true }

inspector/Cargo.toml

@@ -0,0 +1,10 @@
+# alto-inspector
+
+[![Crates.io](https://img.shields.io/crates/v/alto-inspector.svg)](https://crates.io/crates/alto-inspector)
+[![Docs.rs](https://docs.rs/alto-inspector/badge.svg)](https://docs.rs/alto-inspector)
+
+Monitor `alto` activity.
+
+## Status
+
+`alto-inspector` is **ALPHA** software and is not yet recommended for production use. Developers should expect breaking changes and occasional instability.

inspector/README.md

@@ -0,0 +1,69 @@
+use alto_client::{consensus::Message, Client};
+use clap::{value_parser, Arg, Command};
+use commonware_cryptography::bls12381::PublicKey;
+use commonware_utils::from_hex_formatted;
+use futures::StreamExt;
+use tracing::info;
+
+#[tokio::main]
+async fn main() {
+    // Parse arguments
+    let matches = Command::new("inspector")
+        .about("Monitor alto activity.")
+        .arg(
+            Arg::new("indexer")
+                .long("indexer")
+                .required(false)
+                .value_parser(value_parser!(String)),
+        )
+        .arg(
+            Arg::new("identity")
+                .long("identity")
+                .required(false)
+                .value_parser(value_parser!(String)),
+        )
+        .get_matches();
+
+    // Create logger
+    tracing_subscriber::fmt().init();
+
+    // Parse the identity
+    let identity = matches.get_one::<String>("identity").unwrap();
+    let identity = from_hex_formatted(identity).unwrap();
+    let identity = PublicKey::try_from(identity).expect("Invalid identity");
+
+    // Connect to the indexer
+    let indexer = matches.get_one::<String>("indexer").unwrap();
+    let client = Client::new(indexer, identity);
+
+    // Stream the chain
+    let mut stream = client
+        .register()
+        .await
+        .expect("Failed to connect to indexer");
+    while let Some(message) = stream.next().await {
+        let message = message.expect("Failed to receive message");
+        match message {
+            Message::Seed(seed) => {
+                info!(view = seed.view, "seed");
+            }
+            Message::Notarization(notarized) => {
+                info!(
+                    view = notarized.proof.view,
+                    height = notarized.block.height,
+                    timestamp = notarized.block.timestamp,
+                    digest = ?notarized.block.digest(),
+                    "notarized");
+            }
+            Message::Finalization(finalized) => {
+                info!(
+                    view = finalized.proof.view,
+                    height = finalized.block.height,
+                    timestamp = finalized.block.timestamp,
+                    digest = ?finalized.block.digest(),
+                    "finalized"
+                );
+            }
+        }
+    }
+}