update node config and sourcing public keys from contract (#469)

* propose a new node config design

* refactor!: new NodeConfig, remove KeysetConfig

* update 5 node config

* ci_local tests passing

* remove test-configs/*.json

* introduce register binary for manager

* update demo scripts and CI

* add separate docker configss, update dockerfile

* fix ci

* update test-configs' readme

* newer os to get newer glibc

* try fix ci

* fix sailfish demo

* fix docker

* fix yapper

* use cargo fmt instead of just in build.rs

* remove unused run-local-integration

* robust keymanager contract address from non-default manager wallet

* clean up crypto's SerdeAs, remove unused to_bytes, try_from_str etc

* rename config_path to config

* reorg config

* update all test-config files

* minor fix

* fix ci

Co-authored-by: Luke Iannucci <[email protected]>

* rename net.sailfish to net.public

Co-authored-by: Toralf Wittner <[email protected]>

* add rationale to Blackbox

* fix typos

* improve mkconfig usage, avoid shell hack

* fix missing port adjustment for nitro

* correct inbox contract addr in configs

* replace Blackbox with Bs58Bincode<T>, structurize parent_chain, centralize offset const, builder for ChainConfig

Co-authored-by: Toralf Wittner <[email protected]>

* update test-configs

* fix all test errs

* remove Bs58Bincode altogether, use serde(transparent)

Co-authored-by: Toralf Wittner <[email protected]>

* remove unnecessary NodeEncodedKeypairConfig

* fix test err

* update port magic

* maybe fix ci

---------

Co-authored-by: Luke Iannucci <[email protected]>
Co-authored-by: Toralf Wittner <[email protected]>

Author: 3 people

.github/workflows/build-and-test.yml

@@ -134,9 +134,9 @@ jobs:
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@v1
     - name: Run tests
-      run: just run_demo -s /tmp/stamp --ignore-stamp --yapper -k test-configs/local-5.json
+      run: just run_demo -s /tmp/stamp --ignore-stamp --yapper -c test-configs/c0
     - name: Run tests with late-start node
-      run: just run_demo -l -s /tmp/stamp --ignore-stamp --yapper -k test-configs/local-5.json
+      run: just run_demo -l -s /tmp/stamp --ignore-stamp --yapper -c test-configs/c0
     - name: Run sailfish demo
       run: just run_sailfish_demo
 
@@ -195,7 +195,7 @@ jobs:
           --init &
         cd ..
     - name: Run test timeboost with nitro sequencer
-      run: just run_demo -s /tmp/stamp --ignore-stamp -k test-configs/local-2.json --rounds 10000 --yapper --nitro
+      run: just run_demo -s /tmp/stamp --ignore-stamp -c test-configs/nitro-ci-committee --rounds 10000 --yapper --nitro
     - name: Verify sequencer blocks
       run: |
         RUST_LOG=info just verify_blocks

Cargo.lock

@@ -78,11 +78,6 @@ Run in docker
 just run_integration
 ```
 
-Run locally
-```shell
-just run_integration_local
-```
-
 ### Accessing Metrics
 
 Metrics are exposed on port 8000 + `i` for each node. Once the nodes are up and running, you
@@ -120,4 +115,4 @@ just test-contracts
 
 [noise]: https://noiseprotocol.org/
 [sailfish]: https://eprint.iacr.org/2024/472.pdf
-[timeboost]: https://github.com/OffchainLabs/decentralized-timeboost-spec
+[timeboost]: https://github.com/OffchainLabs/decentralized-timeboost-spec

README.md

@@ -39,6 +39,14 @@ impl Address {
         self
     }
 
+    pub fn with_offset(mut self, o: u16) -> Self {
+        match self {
+            Self::Inet(ip, p) => self = Self::Inet(ip, p + o),
+            Self::Name(hn, p) => self = Self::Name(hn, p + o),
+        }
+        self
+    }
+
     pub fn is_ip(&self) -> bool {
         matches!(self, Self::Inet(..))
     }

cliquenet/src/addr.rs

@@ -4,9 +4,9 @@ services:
     command:
       [
         "/app/timeboost",
-        "--id", "0",
+        "--committee-id", "0",
         "--http-port", "8800",
-        "--keyset-file", "docker.json",
+        "--config", "docker/node_0.toml",
         "--stamp", "/tmp/timeboost.stamp",
         "--namespace", "10101",
       ]
@@ -31,9 +31,9 @@ services:
     command:
       [
         "/app/timeboost",
-        "--id", "1",
+        "--committee-id", "0",
         "--http-port", "8800",
-        "--keyset-file", "docker.json",
+        "--config", "docker/node_1.toml",
         "--stamp", "/tmp/timeboost.stamp",
         "--namespace", "10101",
       ]
@@ -58,9 +58,9 @@ services:
     command:
       [
         "/app/timeboost",
-        "--id", "2",
+        "--committee-id", "0",
         "--http-port", "8800",
-        "--keyset-file", "docker.json",
+        "--config", "docker/node_2.toml",
         "--stamp", "/tmp/timeboost.stamp",
         "--namespace", "10101",
       ]
@@ -85,9 +85,9 @@ services:
     command:
       [
         "/app/timeboost",
-        "--id", "3",
+        "--committee-id", "0",
         "--http-port", "8800",
-        "--keyset-file", "docker.json",
+        "--config", "docker/node_3.toml",
         "--stamp", "/tmp/timeboost.stamp",
         "--namespace", "10101",
       ]
@@ -112,9 +112,10 @@ services:
     command:
       [
         "/app/timeboost",
-        "--id", "4",
+        "--committee-id", "0",
         "--http-port", "8800",
         "--keyset-file", "docker.json",
+        "--config", "docker/node_4.toml",
         "--stamp", "/tmp/timeboost.stamp",
         "--namespace", "10101",
       ]
@@ -150,7 +151,7 @@ services:
         "--tps",
         "1",
         "--keyset-file",
-        "docker.json",
+        "committee.json",
       ]
     networks:
       timeboost:

docker-compose.yml

@@ -1,10 +1,16 @@
 # Builder stage
-FROM rust:bullseye AS builder
+FROM rust:bookworm AS builder
+SHELL ["/bin/bash", "-c"]
 
 WORKDIR /app
 
 COPY . .
 RUN apt update && apt-get install -y protobuf-compiler libssl-dev
+RUN curl -L https://foundry.paradigm.xyz | bash && /root/.foundry/bin/foundryup
+ENV PATH="/root/.foundry/bin:${PATH}"
+RUN forge --version
+RUN rustup component add rustfmt --toolchain nightly
+
 RUN cargo build --release --bin timeboost
 
 # Non-root app container stage
@@ -19,7 +25,7 @@ RUN groupadd -r appgroup && useradd -r -g appgroup timeboostuser
 
 # Copy binary
 COPY --from=builder /app/target/release/timeboost .
-COPY --from=builder /app/test-configs .
+COPY --from=builder /app/test-configs/docker .
 
 # Set ownership of application files and make binary executable
 RUN chown -R timeboostuser:appgroup /app && chmod +x /app/timeboost

docker/timeboost.Dockerfile

@@ -1,10 +1,14 @@
 # Builder stage
-FROM rust:bullseye AS builder
+FROM rust:bookworm AS builder
 
 WORKDIR /app
 
 COPY . .
 RUN apt update && apt-get install -y protobuf-compiler
+RUN curl -L https://foundry.paradigm.xyz | bash && /root/.foundry/bin/foundryup
+ENV PATH="/root/.foundry/bin:${PATH}"
+RUN forge --version
+RUN rustup component add rustfmt --toolchain nightly
 RUN cargo build --release --bin yapper
 
 # Non-root app container stage
@@ -19,7 +23,7 @@ RUN groupadd -r appgroup && useradd -r -g appgroup yapperuser
 
 # Copy binary and just
 COPY --from=builder /app/target/release/yapper .
-COPY --from=builder /app/test-configs .
+COPY --from=builder /app/test-configs/docker .
 
 # Set ownership of application files and make binary executable
 RUN chown -R yapperuser:appgroup /app && chmod +x /app/yapper
@@ -34,4 +38,4 @@ USER yapperuser
 ENV RUST_LOG=info
 
 # Run the timeboost binary
-CMD ["/app/yapper"]
+CMD ["/app/yapper"]

docker/yapper.Dockerfile

@@ -48,7 +48,9 @@ fix:
   cargo fix --allow-dirty --allow-staged
 
 ci_local:
-  just build && just lint && just test_ci --release && just run_demo && just run_sailfish_demo && just build_docker
+  just build && just lint && just test_ci --release && \
+  just run_demo -s /tmp/stamp --ignore-stamp --yapper -c test-configs/c0 && \
+  just run_sailfish_demo && just build_docker
 
 bacon: clippy check fmt
 
@@ -69,9 +71,6 @@ run_monitoring:
 stop_monitoring:
   docker compose -f docker-compose.metrics.yml down
 
-run_integration_local *ARGS:
-  ./scripts/run-local-integration {{ARGS}}
-
 run_demo *ARGS:
   ./scripts/run-timeboost-demo {{ARGS}}
 
@@ -84,33 +83,37 @@ run *ARGS:
 bench *ARGS:
   cargo bench --benches {{ARGS}} -- --nocapture
 
-mkconfig_local NUM_NODES *ARGS:
-  just mkconfig_local_full {{NUM_NODES}} "https://theserversroom.com/ethereum/54cmzzhcj1o/" 1 "0x4dbd4fc535ac27206064b68ffcf827b0a60bab3f" {{ARGS}}
-
-mkconfig_local_full NUM_NODES RPC_URL PARENT_CHAIN_ID PARENT_INBOX_ADDRESS *ARGS:
-  cargo run --bin mkconfig -- -n {{NUM_NODES}} \
-    --sailfish-base-addr "127.0.0.1:8000" \
-    --decrypt-base-addr "127.0.0.1:10000" \
-    --certifier-base-addr "127.0.0.1:11000" \
-    --internal-base-addr "127.0.0.1:5000" \
-    --parent-rpc-url {{RPC_URL}} \
-    --parent-chain-id {{PARENT_CHAIN_ID}} \
-    --parent-ibox-contr-addr {{PARENT_INBOX_ADDRESS}} \
-    --mode "increment-port" {{ARGS}} | jq
-
-mkconfig_docker NUM_NODES *ARGS:
-  just mkconfig_docker_full {{NUM_NODES}} "https://theserversroom.com/ethereum/54cmzzhcj1o/" 1 "0x4dbd4fc535ac27206064b68ffcf827b0a60bab3f" {{ARGS}}
-
-mkconfig_docker_full NUM_NODES RPC_URL PARENT_CHAIN_ID PARENT_INBOX_ADDRESS *ARGS:
+mkconfig NUM_NODES *ARGS:
   cargo run --bin mkconfig -- -n {{NUM_NODES}} \
-    --sailfish-base-addr "172.20.0.2:8000" \
-    --decrypt-base-addr "172.20.0.2:8001" \
-    --certifier-base-addr "172.20.0.2:8002" \
-    --internal-base-addr "172.20.0.2:5000" \
-    --parent-rpc-url {{RPC_URL}} \
-    --parent-chain-id {{PARENT_CHAIN_ID}} \
-    --parent-ibox-contr-addr {{PARENT_INBOX_ADDRESS}} \
-    --mode "increment-address" {{ARGS}} | jq
+    --public-addr "127.0.0.1:8000" \
+    --internal-addr "127.0.0.1:8003" \
+    --parent-rpc-url "http://127.0.0.1:8545" \
+    --parent-chain-id 31337 \
+    --parent-ibox-contract "0xa0f3a1a4e2b2bcb7b48c8527c28098f207572ec1" \
+    --key-manager-contract "0x2bbf15bc655c4cc157b769cfcb1ea9924b9e1a35" \
+    --output "test-configs/c0" {{ARGS}}
+
+mkconfig_docker *ARGS:
+  cargo run --bin mkconfig -- -n 5 \
+    --public-addr "172.20.0.2:8000" \
+    --internal-addr "172.20.0.2:8003" \
+    --mode "increment-address" \
+    --parent-rpc-url "http://127.0.0.1:8545" \
+    --parent-chain-id 31337 \
+    --parent-ibox-contract "0xa0f3a1a4e2b2bcb7b48c8527c28098f207572ec1" \
+    --key-manager-contract "0x2bbf15bc655c4cc157b769cfcb1ea9924b9e1a35" \
+    --output "test-configs/docker" {{ARGS}}
+
+mkconfig_nitro *ARGS:
+  cargo run --bin mkconfig -- -n 2 \
+    --public-addr "127.0.0.1:8000" \
+    --internal-addr "127.0.0.1:8003" \
+    --nitro-addr "localhost:55000" \
+    --parent-rpc-url "http://127.0.0.1:8545" \
+    --parent-chain-id 1337 \
+    --parent-ibox-contract "0xa0f3a1a4e2b2bcb7b48c8527c28098f207572ec1" \
+    --key-manager-contract "0x2bbf15bc655c4cc157b769cfcb1ea9924b9e1a35" \
+    --output "test-configs/nitro-ci-committee" {{ARGS}}
 
 verify_blocks *ARGS:
   cargo run --release --bin block-verifier --features bin {{ARGS}}
@@ -135,5 +138,5 @@ test-individually:
     cargo nextest run --no-tests=pass -p $pkg || exit 1; \
   done
 
-test-contract-deploy:
-  ./scripts/test-contract-deploy
+test-contract-deploy *ARGS:
+  ./scripts/test-contract-deploy {{ARGS}}

justfile

@@ -1,5 +1,5 @@
-use std::fmt;
-use std::num::NonZeroUsize;
+use std::num::{NonZeroUsize, ParseIntError};
+use std::{fmt, str::FromStr};
 
 use std::sync::Arc;
 
@@ -135,6 +135,15 @@ impl fmt::Display for CommitteeId {
     }
 }
 
+impl FromStr for CommitteeId {
+    type Err = ParseIntError;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let v = s.parse::<u64>()?;
+        Ok(Self(v))
+    }
+}
+
 impl Committable for CommitteeId {
     fn commit(&self) -> Commitment<Self> {
         RawCommitmentBuilder::new("CommitteeId")

multisig/src/committee.rs

@@ -1,11 +1,3 @@
 # Scripts
 
 These scripts are used to run the integration tests locally and do other tasks which require lots of steps.
-
-## run-local-integration
-
-This script runs a local integration test with 5 nodes. It can be run in either debug or release mode. To run in release mode, pass the `release` argument to the script, pass nothing to run in debug mode.
-
-```bash
-./scripts/run-local-integration [release]
-```