From fec18d4d6d038d1a17d226812253ad70e0106d85 Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Wed, 27 Nov 2024 13:13:48 +0100 Subject: [PATCH 1/2] feat(docs): added boltup installer + usage --- testnets/holesky/QUICK_START.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/testnets/holesky/QUICK_START.md b/testnets/holesky/QUICK_START.md index fe5a600d..aace77b6 100644 --- a/testnets/holesky/QUICK_START.md +++ b/testnets/holesky/QUICK_START.md @@ -12,8 +12,6 @@ You will need the following dependencies on your machine: -- [Install Rust](https://www.rust-lang.org/tools/install) -- [Install Protoc](https://grpc.io/docs/protoc-installation/) - [Install Docker](https://docs.docker.com/get-docker/) Additionally, you will need: @@ -30,7 +28,30 @@ git clone https://github.com/chainbound/bolt && cd bolt ## 2. Install the bolt CLI -You can install the CLI directly from source: +To install the bolt CLI, you can either use our pre-built binaries or build it from source. + +### Using pre-built binaries + +```bash +# download the bolt-cli installer +curl -L https://raw.githubusercontent.com/chainbound/bolt/unstable/boltup/install.sh | bash + +# start a new shell to use the boltup installer +exec $SHELL + +# install the bolt-cli binary for holesky +boltup --tag v0.3.0-alpha + +# check for successful installation +bolt --help +``` + +### Building from source + +You will need the following dependencies to build the bolt CLI yourself: + +- [Install Rust](https://www.rust-lang.org/tools/install) +- [Install Protoc](https://grpc.io/docs/protoc-installation/) ```bash cd bolt-cli @@ -40,11 +61,6 @@ cargo install --force --path . bolt --help ``` -Alternatively, you can download one of the pre-built binaries from the -[releases page](https://github.com/chainbound/bolt/releases/tag/v0.3.0-alpha) (under "Assets"). -Make sure to download the correct binary for your system (e.g. `bolt-cli-aarch64-apple-darwin` -on MacBook with Apple Silicon chips). - ## 3. Obtain a list of your validator public keys This CLI command will list all the public keys of your validator(s) and save them From 62acf0cf46ca9f0e2c676b02f762bcdbc223fb71 Mon Sep 17 00:00:00 2001 From: nicolas <48695862+merklefruit@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:02:45 +0100 Subject: [PATCH 2/2] feat(docs): added boltup installer + usage to README --- testnets/holesky/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/testnets/holesky/README.md b/testnets/holesky/README.md index de85a0d8..c32c87c3 100644 --- a/testnets/holesky/README.md +++ b/testnets/holesky/README.md @@ -882,6 +882,39 @@ and outputs a JSON file with the delegation/revocation messages to the provided #### Installation and usage +To install the bolt CLI, you can either use our pre-built binaries or build it from source. + +**Using pre-built binaries** + +```bash +# download the bolt-cli installer +curl -L https://raw.githubusercontent.com/chainbound/bolt/unstable/boltup/install.sh | bash + +# start a new shell to use the boltup installer +exec $SHELL + +# install the bolt-cli binary for holesky +boltup --tag v0.3.0-alpha + +# check for successful installation +bolt --help +``` + +**Building from source** + +You will need the following dependencies to build the bolt CLI yourself: + +- [Install Rust](https://www.rust-lang.org/tools/install) +- [Install Protoc](https://grpc.io/docs/protoc-installation/) + +```bash +cd bolt-cli +cargo install --force --path . + +# check for successful installation +bolt --help +``` + Prerequisites: - [Rust toolchain](https://www.rust-lang.org/tools/install)