Integrate client into chain and add inspector (#4)

* add client import

* add indexer URL to readme

* push through indexer

* push into syncer (need blocks)

* spike on indexer

* add logs

* reuse reqwest client

* perform seed upload

* remove nullification

* add minimal listener

* inspector tweaks

* make indexer

* remove reserialization

* use finalizer to avoid confusion

* fix end condition

* [chain] Add `Indexer` trait (#5)

* pipe indexer into engine

* basic indexer test

* check indexer is working

* [inspector] Add remaining functionality (#7)

* cleanup inspector

* finish inspector

* refactor code

* update README

* add much faster

* add connection prep

* add debug

* add range

* fetch range

* update README

* update versions to 0.0.3

* make bump_versions executable

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,13 +2,14 @@
 members = [
     "chain",
     "client",
+    "inspector",
     "types",
 ]
 resolver = "2"
 
 [workspace.dependencies]
-alto-client = { version = "0.0.2", path = "client" }
-alto-types = { version = "0.0.2", path = "types" }
+alto-client = { version = "0.0.3", path = "client" }
+alto-types = { version = "0.0.3", path = "types" }
 commonware-consensus = { version = "0.0.40" }
 commonware-cryptography = { version = "0.0.40" }
 commonware-deployer = { version = "0.0.40" }
@@ -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

@@ -1,6 +1,6 @@
 [package]
 name = "alto-chain"
-version = "0.0.2"
+version = "0.0.3"
 publish = true
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -12,6 +12,7 @@ documentation = "https://docs.rs/alto-chain"
 
 [dependencies]
 alto-types = { workspace = true }
+alto-client = { workspace = true }
 commonware-consensus = { workspace = true }
 commonware-cryptography = { workspace = true }
 commonware-deployer = { workspace = true }
@@ -30,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

@@ -22,9 +22,17 @@ cargo install commonware-deployer
 ### Create Deployer Artifacts
 
 ```bash
-cargo run --bin setup -- --peers 10 --bootstrappers 2 --regions us-west-1,us-east-1,eu-west-1,ap-northeast-1,eu-north-1,ap-south-1,sa-east-1,eu-central-1,ap-northeast-2,ap-southeast-2 --instance-type c7g.xlarge --storage-size 10 --storage-class gp3 --worker-threads 4 --message-backlog 16384 --mailbox-size 16384 --dashboard dashboard.json --output assets
+cargo run --bin setup -- generate --peers 10 --bootstrappers 2 --regions us-west-1,us-east-1,eu-west-1,ap-northeast-1,eu-north-1,ap-south-1,sa-east-1,eu-central-1,ap-northeast-2,ap-southeast-2 --instance-type c7g.xlarge --storage-size 10 --storage-class gp3 --worker-threads 4 --message-backlog 16384 --mailbox-size 16384 --dashboard dashboard.json --output assets
 ```
 
+### [Optional] Configure Indexer Upload
+
+```bash
+cargo run --bin setup -- indexer --dir assets --url <indexer URL>
+```
+
+_The indexer URL is configured separately because it is typically only known after the threshold key is generated (derived in `setup generate`)._
+
 ### Build Validator Binary
 
 #### Build Cross-Platform Compiler

chain/README.md

@@ -312,7 +312,7 @@
                     },
                     "disableTextWrap": false,
                     "editorMode": "builder",
-                    "expr": "engine_syncer_latest_height{job=~\"$Validator\", region=~\"$Region\"}",
+                    "expr": "engine_syncer_finalized_height{job=~\"$Validator\", region=~\"$Region\"}",
                     "fullMetaSearch": false,
                     "includeNullMetadata": true,
                     "legendFormat": "{{job}} ({{instance}})",

chain/dashboard.json

@@ -4,7 +4,7 @@ use super::{
     Config,
 };
 use crate::actors::syncer;
-use alto_types::{Block, Finalization, Notarization};
+use alto_types::{Block, Finalization, Notarization, Seed};
 use commonware_consensus::threshold_simplex::Prover;
 use commonware_cryptography::{sha256::Digest, Hasher, Sha256};
 use commonware_macros::select;
@@ -215,21 +215,23 @@ impl<R: Rng + Spawner + Metrics + Clock> Actor<R> {
                 }
                 Message::Prepared { proof, payload } => {
                     // Parse the proof
-                    let (view, parent, _, signature, _) =
+                    let (view, parent, _, signature, seed) =
                         self.prover.deserialize_notarization(proof).unwrap();
                     let notarization = Notarization::new(view, parent, payload, signature.into());
+                    let seed = Seed::new(view, seed.into());
 
                     // Send the notarization to the syncer
-                    syncer.notarized(notarization).await;
+                    syncer.notarized(notarization, seed).await;
                 }
                 Message::Finalized { proof, payload } => {
                     // Parse the proof
-                    let (view, parent, _, signature, _) =
+                    let (view, parent, _, signature, seed) =
                         self.prover.deserialize_finalization(proof.clone()).unwrap();
                     let finalization = Finalization::new(view, parent, payload, signature.into());
+                    let seed = Seed::new(view, seed.into());
 
                     // Send the finalization to the syncer
-                    syncer.finalized(finalization).await;
+                    syncer.finalized(finalization, seed).await;
                 }
             }
         }