Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ For more information on how to run Commit-Boost, check out our [docs](https://co
For more information on how to develop a module on Commit-Boost, check out our [docs](https://commit-boost.github.io/commit-boost-client/category/developing).

### Example
> **_NOTE:_** The code is unaudited and NOT ready for production. All APIs are subject to change

A basic commit module with Commit-Boost.

Expand Down
7 changes: 1 addition & 6 deletions docs/docs/developing/commit-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ sidebar_position: 2

While a module can be written in any language, we currently provide some utilities for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust.

:::note
Commit-Boost is still in alpha development, all APIs are subject to change
:::


In Rust, we provide utilities to load and run modules. Simply add to your `Cargo.toml`:
```toml
commit-boost = { git = "https://github.com/Commit-Boost/commit-boost-client", rev = "..." }
Expand Down Expand Up @@ -125,4 +120,4 @@ All that is left is to use the metrics throughout your code:
```rust
SIG_RECEIVED_COUNTER.inc();
```
These will be automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running.
These will be automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running.
4 changes: 0 additions & 4 deletions docs/docs/get_started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description: Initial setup

# Overview

:::warning
Commit-Boost is currently in alpha development and **NOT** ready for production use. Please use caution
:::

Commit-Boost is primarily based on [Docker](https://www.docker.com/) to enable modularity, sandboxing and cross-platform compatibility. It is also possible to run Commit-Boost [natively](/get_started/running/binary) without Docker.

Each component roughly maps to a container: from a single `.toml` config file, the node operator can specify which modules they want to run, and Commit-Boost takes care of spinning up the services and creating links between them.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/get_started/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Common issues

# Troubleshooting

Commit-Boost is currently in alpha development so it's likely there are bugs, if you find any or have any question, please reach out on [X (Twitter)](https://x.com/Commit_Boost) or [Telegram](https://t.me/+Pcs9bykxK3BiMzk5).
Commit-Boost was recently audited and going through a phased approach for validators to move to production. If you find any or have any question, please reach out on [X (Twitter)](https://x.com/Commit_Boost) or [Telegram](https://t.me/+Pcs9bykxK3BiMzk5). If there are any security related items, please see [here](https://github.com/Commit-Boost/commit-boost-client/blob/main/SECURITY.md).


If you started the modules correctly you should see the following logs.
Expand Down Expand Up @@ -65,4 +65,4 @@ This will only happen if you received a header in the previous call, and if the
```bash
2024-09-16T14:38:01.409075Z INFO submit_blinded_block{req_id=6eb9a04d-6f79-4295-823f-c054582b3599 slot=2549590}: ua="Lighthouse/v5.2.1-9e12c21" slot_uuid=16186e06-0cd0-47bc-9758-daa1b66eff5c ms_into_slot=1409 block_hash=0xfa135ae6f2bfb32b0a47368f93d69e0a2b3f8b855d917ec61d78e78779edaae6
2024-09-16T14:38:02.910974Z INFO submit_blinded_block{req_id=6eb9a04d-6f79-4295-823f-c054582b3599 slot=2549590}: received unblinded block
```
```
Loading