feat(code): Experimental node CLI

.github/codespell/codespell.ini

@@ -1,3 +1,3 @@
 [codespell]
-skip = ./code/target
+skip = ./code/target,./code/Cargo.lock
 ignore-words = .github/codespell/words.txt

.github/codespell/words.txt

@@ -1,5 +1,5 @@
 crate
-shs
-ser
-numer
 manuel
+numer
+ser
+shs

.github/workflows/coverage.yml

@@ -25,10 +25,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - run: npm install -g @informalsystems/quint
+      - name: Install Quint
+        run: npm install -g @informalsystems/quint
       - name: Setup Rust toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -39,7 +43,15 @@ jobs:
       - name: Install cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
       - name: Generate code coverage
-        run: cargo llvm-cov nextest --workspace --exclude malachite-itf --all-features --ignore-run-fail --lcov --output-path lcov.info
+        run: |
+          cargo llvm-cov nextest \
+            --workspace \
+            --exclude malachite-itf \
+            --ignore-filename-regex node/bin \
+            --all-features \
+            --ignore-run-fail \
+            --lcov \
+            --output-path lcov.info
       - name: Generate text report
         run: cargo llvm-cov report
       - name: Upload coverage to Codecov
@@ -61,10 +73,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - run: npm install -g @informalsystems/quint
+      - name: Install Quint
+        run: npm install -g @informalsystems/quint
       - name: Setup Rust toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:

.github/workflows/mbt.yml

@@ -27,10 +27,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - run: npm install -g @informalsystems/quint
+      - name: Install Quint
+        run: npm install -g @informalsystems/quint
       - name: Setup Rust toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
       - name: Install cargo-nextest

.github/workflows/rust.yml

@@ -31,25 +31,31 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - run: npm install -g @informalsystems/quint
+      - name: Install Quint
+        run: npm install -g @informalsystems/quint
       - name: Setup Rust toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
       - name: Install cargo-nextest
         uses: taiki-e/install-action@cargo-nextest
       - name: Build code
         run: cargo nextest run --workspace --all-features --no-run
       - name: Run tests
-        run: cargo nextest run --workspace --all-features
+        run: cargo nextest run --workspace --all-features --no-capture
 
   clippy:
     name: Clippy
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
       - name: Setup Rust toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:

code/Cargo.toml

@@ -3,8 +3,11 @@ resolver = "2"
 
 members = [
   "common",
-  "driver",
+  "driver", 
+  "gossip",
   "itf",
+  "node", 
+  "proto",
   "round",
   "test",
   "vote",
@@ -18,17 +21,37 @@ license      = "Apache-2.0"
 publish      = false
 
 [workspace.dependencies]
-derive-where      = "1.2.7"
-ed25519-consensus = "2.1.0"
-futures           = "0.3"
-glob              = "0.3.0"
-itf               = "0.2.2"
-num-bigint        = "0.4.4"
-num-traits        = "0.2.17"
-pretty_assertions = "1.4"
-rand              = { version = "0.8.5", features = ["std_rng"] }
-serde             = "1.0"
-serde_json        = "1.0"
-serde_with        = "3.4"
-sha2              = "0.10.8"
-signature         = "2.1.0"
+malachite-common = { version = "0.1.0", path = "common" }
+malachite-driver = { version = "0.1.0", path = "driver" }
+malachite-gossip = { version = "0.1.0", path = "gossip" }
+malachite-itf    = { version = "0.1.0", path = "itf" }
+malachite-node   = { version = "0.1.0", path = "node" }
+malachite-proto  = { version = "0.1.0", path = "proto" }
+malachite-round  = { version = "0.1.0", path = "round" }
+malachite-test   = { version = "0.1.0", path = "test" }
+malachite-vote   = { version = "0.1.0", path = "vote" }
+
+async-trait        = "0.1.77"
+derive-where       = "1.2.7"
+ed25519-consensus  = "2.1.0"
+futures            = "0.3"
+glob               = "0.3.0"
+itf                = "0.2.2"
+num-bigint         = "0.4.4"
+num-traits         = "0.2.17"
+pretty_assertions  = "1.4"
+prost              = "0.12.3"
+prost-types        = "0.12.3"
+prost-build        = "0.12.3"
+rand               = "0.8.5"
+serde              = "1.0"
+serde_json         = "1.0"
+serde_with         = "3.4"
+sha2               = "0.10.8"
+signature          = "2.1.0"
+thiserror          = "1.0"
+tokio              = "1.35.1"
+tokio-stream       = "0.1"
+toml               = "0.8.10"
+tracing            = "0.1.40"
+tracing-subscriber = "0.3.18"

code/common/Cargo.toml

@@ -9,5 +9,5 @@ license.workspace      = true
 publish.workspace      = true
 
 [dependencies]
-derive-where.workspace = true
-signature.workspace    = true
+derive-where.workspace    = true
+signature.workspace       = true

code/common/src/context.rs

@@ -1,13 +1,13 @@
 use crate::{
-    Address, Height, NilOrVal, Proposal, PublicKey, Round, SignedVote, SigningScheme, Validator,
-    ValidatorSet, Value, ValueId, Vote,
+    Address, Height, NilOrVal, Proposal, PublicKey, Round, SignedProposal, SignedVote,
+    SigningScheme, Validator, ValidatorSet, Value, ValueId, Vote,
 };
 
 /// This trait allows to abstract over the various datatypes
 /// that are used in the consensus engine.
 pub trait Context
 where
-    Self: Sized,
+    Self: Sized + Clone + Send + Sync + 'static,
 {
     /// The type of address of a validator.
     type Address: Address;
@@ -33,7 +33,7 @@ where
     /// The signing scheme used to sign votes.
     type SigningScheme: SigningScheme;
 
-    /// Sign the given vote our private key.
+    /// Sign the given vote with our private key.
     fn sign_vote(&self, vote: Self::Vote) -> SignedVote<Self>;
 
     /// Verify the given vote's signature using the given public key.
@@ -43,12 +43,23 @@ where
         public_key: &PublicKey<Self>,
     ) -> bool;
 
+    /// Sign the given proposal with our private key.
+    fn sign_proposal(&self, proposal: Self::Proposal) -> SignedProposal<Self>;
+
+    /// Verify the given proposal's signature using the given public key.
+    fn verify_signed_proposal(
+        &self,
+        signed_proposal: &SignedProposal<Self>,
+        public_key: &PublicKey<Self>,
+    ) -> bool;
+
     /// Build a new proposal for the given value at the given height, round and POL round.
     fn new_proposal(
         height: Self::Height,
         round: Round,
         value: Self::Value,
         pol_round: Round,
+        address: Self::Address,
     ) -> Self::Proposal;
 
     /// Build a new prevote vote by the validator with the given address,

code/common/src/height.rs

@@ -7,6 +7,8 @@ use core::fmt::Debug;
 /// A height of 0 represents a chain which has not yet produced a block.
 pub trait Height
 where
-    Self: Default + Copy + Clone + Debug + PartialEq + Eq + PartialOrd + Ord,
+    Self: Default + Copy + Clone + Debug + PartialEq + Eq + PartialOrd + Ord + Send + Sync,
 {
+    /// Increment the height by one.
+    fn increment(&self) -> Self;
 }

code/common/src/lib.rs

@@ -12,10 +12,13 @@
 #![cfg_attr(not(test), deny(clippy::unwrap_used, clippy::panic))]
 #![cfg_attr(coverage_nightly, feature(coverage_attribute))]
 
+extern crate alloc;
+
 mod context;
 mod height;
 mod proposal;
 mod round;
+mod signed_proposal;
 mod signed_vote;
 mod signing;
 mod timeout;
@@ -42,6 +45,7 @@ pub use context::Context;
 pub use height::Height;
 pub use proposal::Proposal;
 pub use round::Round;
+pub use signed_proposal::SignedProposal;
 pub use signed_vote::SignedVote;
 pub use signing::SigningScheme;
 pub use timeout::{Timeout, TimeoutStep};

code/common/src/proposal.rs

@@ -5,7 +5,7 @@ use crate::{Context, Round};
 /// Defines the requirements for a proposal type.
 pub trait Proposal<Ctx>
 where
-    Self: Clone + Debug + PartialEq + Eq,
+    Self: Clone + Debug + Eq + Send + Sync + 'static,
     Ctx: Context,
 {
     /// The height for which the proposal is for.
@@ -19,4 +19,7 @@ where
 
     /// The POL round for which the proposal is for.
     fn pol_round(&self) -> Round;
+
+    /// Address of the validator who issued this proposal
+    fn validator_address(&self) -> &Ctx::Address;
 }

code/common/src/round.rs

@@ -1,4 +1,4 @@
-use core::cmp;
+use core::{cmp, fmt};
 
 /// A round number.
 ///
@@ -72,6 +72,12 @@ impl Ord for Round {
     }
 }
 
+impl fmt::Display for Round {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        self.as_i64().fmt(f)
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

code/common/src/signed_proposal.rs

@@ -0,0 +1,29 @@
+use derive_where::derive_where;
+
+use crate::{Context, Signature};
+
+/// A signed proposal, ie. a proposal emitted by a validator and signed by its private key.
+#[derive_where(Clone, Debug, PartialEq, Eq)]
+pub struct SignedProposal<Ctx>
+where
+    Ctx: Context,
+{
+    /// The proposal.
+    pub proposal: Ctx::Proposal,
+
+    /// The signature of the proposal.
+    pub signature: Signature<Ctx>,
+}
+
+impl<Ctx> SignedProposal<Ctx>
+where
+    Ctx: Context,
+{
+    /// Create a new signed proposal from the given proposal and signature.
+    pub fn new(proposal: Ctx::Proposal, signature: Signature<Ctx>) -> Self {
+        Self {
+            proposal,
+            signature,
+        }
+    }
+}

code/common/src/signing.rs

@@ -1,4 +1,5 @@
-use core::fmt::Debug;
+use alloc::vec::Vec;
+use core::fmt::{Debug, Display};
 
 use signature::{Keypair, Signer, Verifier};
 
@@ -14,12 +15,25 @@ pub trait SigningScheme
 where
     Self: Clone + Debug + Eq,
 {
+    /// Errors that can occur when decoding a signature from a byte array.
+    type DecodingError: Display;
+
     /// The type of signatures produced by this signing scheme.
-    type Signature: Clone + Debug + Eq;
+    type Signature: Clone + Debug + Eq + Send + Sync;
 
     /// The type of public keys produced by this signing scheme.
-    type PublicKey: Clone + Debug + Eq + Verifier<Self::Signature>;
+    type PublicKey: Clone + Debug + Eq + Send + Sync + Verifier<Self::Signature>;
 
     /// The type of private keys produced by this signing scheme.
-    type PrivateKey: Clone + Signer<Self::Signature> + Keypair<VerifyingKey = Self::PublicKey>;
+    type PrivateKey: Clone
+        + Send
+        + Sync
+        + Signer<Self::Signature>
+        + Keypair<VerifyingKey = Self::PublicKey>;
+
+    /// Decode a signature from a byte array.
+    fn decode_signature(bytes: &[u8]) -> Result<Self::Signature, Self::DecodingError>;
+
+    /// Encode a signature to a byte array.
+    fn encode_signature(signature: &Self::Signature) -> Vec<u8>;
 }