Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

Commit

Permalink
docs: updates for docs 1261 (#606)
Browse files Browse the repository at this point in the history
* chore: linting for import to docs

* chore: suggestions from code review

* chore: rearrange section

* docs: add link to orch docs

* fix: than -> from
  • Loading branch information
jcstein authored Nov 20, 2023
1 parent 220eced commit 3158bf6
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 22 deletions.
28 changes: 8 additions & 20 deletions docs/bootstrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,33 +42,21 @@ one:
blobstream bootstrapper p2p --help
```

### Open the P2P port

In order for the bootstrapper node to work, you will need to expose the P2P
port, which is by default `30000`.

### Start the bootstrapper

Now that we have the store initialized, we can start the bootstrapper:

```shell
blobstream bootstrapper

Blobstream P2P network bootstrapper command

Usage:
blobstream bootstrapper [command]

Aliases:
bootstrapper, bs

Flags:
-h, --help help for bootstrapper

Use "blobstream bootstrapper [command] --help" for more information about a command.
blobstream bootstrapper start
```

### Open the P2P port

In order for the bootstrapper node to work, you will need to expose the P2P
port, which is by default `30000`.

#### Systemd service

An example of a systemd service that can be used for bootstrappers can be
found in the orchestrator documentation.
found in the
[orchestrator documentation](https://docs.celestia.org/nodes/blobstream-orchestrator).
2 changes: 1 addition & 1 deletion docs/orchestrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The orchestrator does the following:
4. Then, the orchestrator pushes its signature to the P2P network it is connected to, via adding it as a DHT value.
5. Listen for new attestations and go back to step 2.

The orchestrator connects to a separate P2P network than the consensus or the data availability networks.
The orchestrator connects to a separate P2P network from the consensus or the data availability networks.

The bootstrapper node for the Mocha testnet is:

Expand Down
2 changes: 1 addition & 1 deletion docs/relayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The relayer works as follows:
5. Once the relayer finds more than 2/3s signatures, it submits them to the target Blobstream smart contract where they get validated.
6. Listen for new attestations and go back to step 2.

The relayer connects to a separate P2P network than the consensus or the data availability one. So, we will provide bootstrappers for that one.
The relayer connects to a separate P2P network from the consensus or the data availability one. So, we will provide bootstrappers for that one.

This means that even if the consensus node is already connected to the consensus network, if the relayer doesn't start with a list of bootstrapper to its specific network, then, it will not work and will output the following logs:

Expand Down

0 comments on commit 3158bf6

Please sign in to comment.