- The code is unaudited and NOT ready for production
- Docker
Commit Boost currently has a "container-centric" approach, i.e. services are mapped to containers which are spawned using docker compose.
There are currently two modules that are provided by commit boost:
- the pbs module (implements the BuilderAPI for MEV Boost)
- the signer module (implements the Signer API)
While in development you have to build them manually as Commit Boost will search for the images to run, eventually we'll provide images to pull from the Docker registry. You can do so by running this script.
Commit Boost also supports "Commit Modules", which are modules that leverage the Signer API to request signatures from the proposer. You can find an example here. Commit Modules also need to be built as docker images and specified in the config file. You can build the local example by running this script.
Note: because Commit Boost currently uses Docker underneath, if you require sudo to interact with Docker, you will need sudo to launch some Commit Boost commands.
The main config file is a .toml which specifies how modules should be built, and their configs. Full specifations are WIP. You can find an example here
Use this command to setup the Docker Compose file that will be used to run the services. For example:
./target/debug/commit-boost init --config config.example.tomlThis will create three files:
cb.docker-compose.yml, used to start services.cb.env, with local env variables to be loaded at runtimetargets.json, used by prometheus to dynamically discover metrics servers
Once the init is done, you can start Commit Boost with start. For example:
./target/debug/commit-boost start --docker cb.docker-compose.yml --env .cb.env./target/debug/commit-boost stop --docker cb.docker-compose.yml --env .cb.envTo listen to logs:
./target/debug/commit-boost stop --docker cb.docker-compose.yml --env .cb.envTODO:
- how services are started with configs
- describe metrics
MIT + Apache-2.0