Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): added boltup installer + usage #448

Merged
merged 2 commits into from
Nov 27, 2024
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
32 changes: 24 additions & 8 deletions testnets/holesky/QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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
Expand Down
33 changes: 33 additions & 0 deletions testnets/holesky/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down