From cdae340de5bd2401c3eac3ad2608114d32911dc7 Mon Sep 17 00:00:00 2001 From: DrewVanderWerff <150300937+DrewVanderWerff@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:00:04 -0600 Subject: [PATCH 1/5] Update troubleshooting.md --- docs/docs/get_started/troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/get_started/troubleshooting.md b/docs/docs/get_started/troubleshooting.md index 964167bd..b576126c 100644 --- a/docs/docs/get_started/troubleshooting.md +++ b/docs/docs/get_started/troubleshooting.md @@ -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 ... (need to get link to MD). If you started the modules correctly you should see the following logs. @@ -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 -``` \ No newline at end of file +``` From 874752a18516f11f6d9ea13683f41765dff9bb16 Mon Sep 17 00:00:00 2001 From: DrewVanderWerff <150300937+DrewVanderWerff@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:00:34 -0600 Subject: [PATCH 2/5] Update overview.md --- docs/docs/get_started/overview.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/docs/get_started/overview.md b/docs/docs/get_started/overview.md index 49c6784b..cbf07772 100644 --- a/docs/docs/get_started/overview.md +++ b/docs/docs/get_started/overview.md @@ -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. From 3e0a427a832eb73a97122c71f9e45a2c11a6af66 Mon Sep 17 00:00:00 2001 From: DrewVanderWerff <150300937+DrewVanderWerff@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:11:21 -0600 Subject: [PATCH 3/5] Update commit-module.md --- docs/docs/developing/commit-module.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/docs/developing/commit-module.md b/docs/docs/developing/commit-module.md index af47384e..e84a3143 100644 --- a/docs/docs/developing/commit-module.md +++ b/docs/docs/developing/commit-module.md @@ -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 = "..." } @@ -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. \ No newline at end of file +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. From 07d416b38eafe4cee2293b3cc52c48a3c6b82d1e Mon Sep 17 00:00:00 2001 From: DrewVanderWerff <150300937+DrewVanderWerff@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:12:47 -0600 Subject: [PATCH 4/5] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 71057e98..11e9f930 100644 --- a/README.md +++ b/README.md @@ -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. From 5539019f31d73d4851cd80d5851c605beb656b71 Mon Sep 17 00:00:00 2001 From: DrewVanderWerff <150300937+DrewVanderWerff@users.noreply.github.com> Date: Mon, 9 Dec 2024 11:34:43 -0600 Subject: [PATCH 5/5] Update troubleshooting.md --- docs/docs/get_started/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/get_started/troubleshooting.md b/docs/docs/get_started/troubleshooting.md index b576126c..7dc9f648 100644 --- a/docs/docs/get_started/troubleshooting.md +++ b/docs/docs/get_started/troubleshooting.md @@ -4,7 +4,7 @@ description: Common issues # Troubleshooting -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 ... (need to get link to MD). +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.