From c5f7a5426bd68698a36c851558bad25810b7572e Mon Sep 17 00:00:00 2001 From: thedevbirb Date: Wed, 16 Oct 2024 10:26:23 +0200 Subject: [PATCH] docs(holesky): README launch wip --- testnets/holesky/README2.md | 96 +++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 testnets/holesky/README2.md diff --git a/testnets/holesky/README2.md b/testnets/holesky/README2.md new file mode 100644 index 00000000..31e44ef5 --- /dev/null +++ b/testnets/holesky/README2.md @@ -0,0 +1,96 @@ +# Holesky Launch Instructions + +## Prerequisites + +In order to run Bolt you need some components already installed and running in +your system. + +**A synced Geth client:** + +At the moment Bolt is only compatible with the Geth execution client. Running +another execution client could lead to commitment faults because fallback block +building is not supported yet. You can download Geth here [the official +website](https://geth.ethereum.org/downloads). + +**A synced beacon node:** + +Bolt is compatible with every beacon client. Please refer to the various beacon +client implementations to download and run them. + +**Active validators:** + +The Bolt sidecar requires signing keys from active Ethereum validators, or authorized delegates acting on their behalf, to issue and sign preconfirmations. + +## Setup + +There are various way to run the Bolt Sidecar: + +- as a standalone binary; +- as a Docker container; +- as a [Commit-Boost](https://commit-boost.github.io/commit-boost-client) + module. + +In this section we're going to explore each of these options and its +requirements. + +### Standalone Binary + +For running the Bolt Sidecar as a standalone binary you need to have the +following dependencies installed: + +- [git](https://git-scm.com/downloads); +- [Rust](https://www.rust-lang.org/tools/install). + +Depending on your platform you may need to install additional dependencies. + +#### Linux + +**Debian-based distributions:** + +```bash +sudo apt update && sudo apt install -y git build-essential libssl-dev build-essential ca-certificates +``` + +**Fedora/Red Hat/CentOS distributions:** + +```bash +sudo dnf groupinstall "Development Tools" && sudo dnf install -y git openssl-devel ca-certificates pkgconfig +``` + +**Arch/Manjaro-based distributions:** + +```bash +sudo pacman -Syu --needed base-devel git openssl ca-certificates pkgconf +``` + +**Alpine Linux** + +```bash +sudo apk add git build-base openssl-dev ca-certificates pkgconf +``` + +#### MacOS + +On MacOS after installing XCode Command Line tools (equivlanet to `build-essential` on Linux) you can install the other dependencies with [Homebew](https://brew.sh/): + +```zsh +xcode-select --install +brew install pkg-config openssl +``` + +--- + +After having installed the dependencies you can clone the Bolt repository by +running: + +```bash +git clone --branch v0.3.0 https://github.com/chainbound/bolt.git && cd bolt +``` + +Then you can build the Bolt sidecar by running: + +```bash +cargo build --release && mv target/release/bolt-sidecar . +``` + +### Docker