MCPcopy Index your code
hub / github.com/Commit-Boost/commit-boost-client

github.com/Commit-Boost/commit-boost-client @v0.9.8

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.9.8 ↗ · + Follow
631 symbols 1,524 edges 104 files 108 documented · 17%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Commit-Boost

Ci Docs Release Chat X

A new Ethereum validator sidecar focused on standardizing the last mile of communication between validators and third-party protocols.

Overview

Commit-Boost is a modular sidecar that allows Ethereum validators to opt-in to different commitment protocols

For node operators

  • Run a single sidecar with support for MEV-Boost and other proposer commitments protocols, such as preconfirmations and inclusion lists
  • Out-of-the-box support for metrics reporting and dashboards to have clear insight into what is happening in your validator
  • Plug-in system to add custom modules, e.g. receive a notification on Telegram if a relay fails to deliver a block

For developers

  • A modular platform to develop and distribute proposer commitments protocols
  • A single API to interact with validators
  • Support for hard-forks and new protocol requirements

Get started

Audit

Commit-Boost received an audit from Sigma Prime. Find the report here.

Verifying release artifacts

All release binaries are signed using Sigstore cosign. You can verify that a binary was built by the official Commit-Boost CI pipeline from the tagged commit of any release.

Prerequisites

Install cosign: cosign installation guide

Verify a binary

# Set the release version and your target architecture
# Architecture options: darwin_arm64, linux_arm64, linux_x86-64
export REPO=Commit-Boost/commit-boost-client
export VERSION=vX.Y.Z
export ARCH=linux_x86-64
export BIN=commit-boost-pbs

# Download the binary tarball and its signature bundle
curl -L \
    -o "$BIN-$VERSION-$ARCH.tar.gz" \
    "https://github.com/$REPO/releases/download/$VERSION/$BIN-$VERSION-$ARCH.tar.gz"

curl -L \
  -o "$BIN-$VERSION-$ARCH.tar.gz.sigstore.json" \
  "https://github.com/$REPO/releases/download/$VERSION/$BIN-$VERSION-$ARCH.tar.gz.sigstore.json"

# Verify the binary was signed by the official CI pipeline
cosign verify-blob \
  "$BIN-$VERSION-$ARCH.tar.gz" \
  --bundle "$BIN-$VERSION-$ARCH.tar.gz.sigstore.json" \
  --certificate-oidc-issuer="https://token.actions.githubusercontent.com" \
  --certificate-identity="https://github.com/Commit-Boost/commit-boost-client/.github/workflows/release.yml@refs/heads/main"

A successful verification prints Verified OK. If the binary was modified after being built by CI, verification will fail.

The .sigstore.json bundle for each binary is attached to the release alongside the tarball itself.

Acknowledgements

License

MIT + Apache-2.0

Extension points exported contracts — how you extend this code

BuilderApiState (Interface)
(no doc) [2 implementers]
crates/pbs/src/state.rs
ProxyId (Interface)
(no doc) [2 implementers]
crates/common/src/commit/request.rs
BuilderApi (Interface)
(no doc) [2 implementers]
crates/pbs/src/api.rs
TestRandomSeed (Interface)
(no doc) [1 implementers]
crates/common/src/utils.rs
GetHeaderInfo (Interface)
(no doc) [1 implementers]
crates/common/src/pbs/types/mod.rs
GetPayloadInfo (Interface)
(no doc) [1 implementers]
crates/common/src/pbs/types/mod.rs

Core symbols most depended-on inside this repo

get
called by 48
examples/status_api/src/main.rs
get_env_val
called by 27
crates/cli/src/docker_init.rs
deserialize
called by 27
crates/common/src/utils.rs
public_key
called by 25
crates/signer/src/manager/dirk.rs
inc
called by 24
examples/status_api/src/main.rs
random_secret
called by 16
crates/common/src/signer/schemes/bls.rs
load_env_var
called by 16
crates/common/src/config/utils.rs
validate
called by 16
crates/common/src/config/mod.rs

Shape

Function 264
Method 207
Class 120
Enum 34
Interface 6

Languages

Rust100%
TypeScript1%

Modules by API surface

crates/signer/src/proto/v1.rs45 symbols
crates/common/src/utils.rs38 symbols
crates/common/src/types.rs33 symbols
crates/signer/src/manager/dirk.rs28 symbols
crates/signer/src/manager/local.rs24 symbols
crates/common/src/commit/request.rs23 symbols
crates/common/src/signer/loader.rs21 symbols
tests/src/mock_relay.rs20 symbols
crates/common/src/config/mux.rs16 symbols
crates/signer/src/service.rs15 symbols
crates/common/src/signer/schemes/ecdsa.rs15 symbols
crates/common/src/pbs/relay.rs15 symbols

For agents

$ claude mcp add commit-boost-client \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact