key management contract implmentation (#440)

* update readme with additional pre-requisites for those new to the project

* wip timeboost contracts, alloy contract binding

* quick test of contract deployment in rust, added contract related builds and tests in the ci workflow

* Fix forge-std submodule

* rust lint fix

* reorg contracts

* use build.rs instead of forge bind

* update deployer

* fmt after gen bindings, update justfile

* update CI

* add foundry toolchain in CI tasks and run forge build in build.rs

* wip removed unused vars and added additional functions based on design feedback

* added nextCommittee(), refactored events and errors

* remove gen bindings command reference in readme

* add storage gap for upgradeability in the event the base contract is changed

* improve contract extensibility by adding the vi
rtual keyword to key functions so that child contracts can upgrade them if necessary

* changed storage from arrays to mappings to make deletions more straight-forward, changed currentCommittee logic and add delete by id function

* changed field names in the committeemember, replace removeCOmmittee() with pruneUNtil() for bulk deletion and removed linked list complexity

* refactor: remove unused or duplicate errors, optimize gas usage a bit

* rename contract events and updated tests

* always regen bindings, forge fmt

* ci: install foundry toolchain for timeboost ci

* fix cargo::error instruction, add nightly rustfmt

---------

Co-authored-by: Alex Xiong <[email protected]>

Author: alysiahuggins

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

@@ -31,6 +31,10 @@ jobs:
         wget https://github.com/casey/just/releases/download/1.14.0/just-1.14.0-x86_64-unknown-linux-musl.tar.gz
         tar -vxf just-1.14.0-x86_64-unknown-linux-musl.tar.gz just
         sudo cp just /usr/bin/just
+    - name: Install rustfmt for nightly
+      run: rustup component add --toolchain nightly rustfmt
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
     - name: Install protobuf compiler
       run: |
         sudo apt-get update
@@ -60,6 +64,10 @@ jobs:
         wget https://github.com/casey/just/releases/download/1.14.0/just-1.14.0-x86_64-unknown-linux-musl.tar.gz
         tar -vxf just-1.14.0-x86_64-unknown-linux-musl.tar.gz just
         sudo cp just /usr/bin/just
+    - name: Install rustfmt for nightly
+      run: rustup component add --toolchain nightly rustfmt
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
     - name: Run tests
       run: just test_ci
 
@@ -81,10 +89,13 @@ jobs:
         sudo cp just /usr/bin/just
     - name: Install rustfmt for nightly
       run: rustup component add --toolchain nightly rustfmt
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
     - name: Check packages individually
       run: just check-individually
     - name: Run lint
       run: just lint
+
   build-docker:
     runs-on: ubuntu-latest
     steps:
@@ -100,6 +111,7 @@ jobs:
         sudo cp just /usr/bin/just
     - name: Build Docker
       run: just build_docker
+
   integration:
     runs-on: ubuntu-latest
     timeout-minutes: 25
@@ -117,12 +129,36 @@ jobs:
         wget https://github.com/casey/just/releases/download/1.14.0/just-1.14.0-x86_64-unknown-linux-musl.tar.gz
         tar -vxf just-1.14.0-x86_64-unknown-linux-musl.tar.gz just
         sudo cp just /usr/bin/just
+    - name: Install rustfmt for nightly
+      run: rustup component add --toolchain nightly rustfmt
+    - 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
     - name: Run tests with late-start node
       run: just run_demo -l -s /tmp/stamp --ignore-stamp --yapper -k test-configs/local-5.json
     - name: Run sailfish demo
       run: just run_sailfish_demo
+
+  contracts:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0
+    - name: Install Just
+      run: |
+        wget https://github.com/casey/just/releases/download/1.14.0/just-1.14.0-x86_64-unknown-linux-musl.tar.gz
+        tar -vxf just-1.14.0-x86_64-unknown-linux-musl.tar.gz just
+        sudo cp just /usr/bin/just
+    - name: Install rustfmt for nightly
+      run: rustup component add --toolchain nightly rustfmt
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
+    - name: Run contract tests
+      run: forge test -vvv
+
   nitro-timeboost-integration:
     runs-on: ubuntu-latest
     timeout-minutes: 60
@@ -140,6 +176,10 @@ jobs:
         wget https://github.com/casey/just/releases/download/1.14.0/just-1.14.0-x86_64-unknown-linux-musl.tar.gz
         tar -vxf just-1.14.0-x86_64-unknown-linux-musl.tar.gz just
         sudo cp just /usr/bin/just
+    - name: Install rustfmt for nightly
+      run: rustup component add --toolchain nightly rustfmt
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
     - name: Clone Espresso Testnode Repository
       run: |
         git clone --recursive https://github.com/EspressoSystems/decentralized-timeboost-nitro-testnode.git

.gitignore

@@ -31,4 +31,7 @@ timeboost-proto/src/*.rs
 bacon.toml
 
 __pycache__/
+*.DS_Store
 
+# Rust bindings for smart contracts
+timeboost-contract/src/bindings

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "timeboost-proto/protos"]
 	path = timeboost-proto/protos
 	url = https://github.com/EspressoSystems/timeboost-proto.git
+[submodule "contracts/lib/openzeppelin-contracts-upgradeable"]
+	path = contracts/lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

Cargo.lock

@@ -11,6 +11,7 @@ members = [
     "tests",
     "timeboost",
     "timeboost-builder",
+    "timeboost-contract",
     "timeboost-crypto",
     "timeboost-proto",
     "timeboost-sequencer",
@@ -28,7 +29,8 @@ rust-version = "1.85.0"
 
 [workspace.dependencies]
 aes-gcm = { version = "0.10.3" }
-alloy = { version = "1.0", features = ["default", "arbitrary", "k256", "serde", "rlp"] }
+alloy = { version = "1.0", features = ["default", "arbitrary", "k256", "serde", "rlp", "node-bindings", "getrandom"] }
+alloy-chains = "0.2"
 # derive feature is not exposed via `alloy`, thus has to explicitly declare here
 alloy-rlp = { version = "0.3.12", features = ["derive"] }
 anyhow = "1.0.89"

Cargo.toml

@@ -30,8 +30,29 @@ of the protocol in Rust, as well as exhaustive testing. The layout of the reposi
 - `timeboost-proto`: Contains protobuf schema and protobuf generated code for inlusion list
 - `yapper`: Transaction submission test tool.
 
-## MSRV (minimum supported Rust version)
-The MSRV of this repository is 1.85.
+## Pre-requisites
+- **Rust toolchain** (Minimum supported rust version (MSRV): 1.88): [Install via rustup](https://rustup.rs/)
+- **just** (for command aliases):
+  ```sh
+  cargo install just
+  ```
+- **cargo-nextest** (for running tests):
+  ```sh
+  cargo install cargo-nextest
+  ```
+
+- **Foundry** (for Solidity development and testing): [Install Foundry](https://book.getfoundry.sh/getting-started/installation)
+  ```sh
+  curl -L https://foundry.paradigm.xyz | bash
+  foundryup
+  ```
+
+- **Docker** (for integration tests, if needed): [Install Docker](https://docs.docker.com/get-docker/)
+
+- **Initialize Submodules:**
+   ```sh
+   git submodule update --init --recursive
+   ```
 
 ## Build
 
@@ -45,6 +66,11 @@ Release build
 just build_release
 ```
 
+## Contracts Build
+```sh
+just build-contracts
+```
+
 ## Run
 
 Run in docker
@@ -87,6 +113,11 @@ ln -s ../../scripts/pre-commit .git/hooks/pre-commit
 just test
 ```
 
+Contracts test
+```shell
+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

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env