Skip to content

Commit

Permalink
docs: fix cometbft renaming in guide
Browse files Browse the repository at this point in the history
Refs #2263. Follow-up to #3064.
  • Loading branch information
conorsch committed Sep 25, 2023
1 parent a3bfa32 commit 1154b35
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions docs/guide/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ is to download and build `pcli`, as described in
[Installation](./pcli/install.md).

The Penumbra node software is the Penumbra daemon, `pd`. This is an ABCI
application, which must be driven by Tendermint, so a Penumbra full node
consists of both a `pd` instance and a `tendermint` instance.
application, which must be driven by CometBFT, so a Penumbra full node
consists of both a `pd` instance and a `cometbft` instance.

The basic architecture of Penumbra is as follows:

Expand Down Expand Up @@ -57,7 +57,7 @@ capability│ │logic │────────┐
chain│ │ │ │ │
data│ │ │ ▼ │
│ │ ┌──┐ app ┌──────────┐ │
│ │ │pd│◀─────▶│tendermint│ │
│ │ │pd│◀─────▶│ cometbft │ │
│ │ └──┘ sync └──────────┘ │
│ │ ▲ │
╰ └───────────────┼─────────┘
Expand Down
16 changes: 8 additions & 8 deletions docs/guide/src/dev/devnet-quickstart.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Devnet Quickstart

This page describes a quickstart method for running `pd`+`tendermint` to test
This page describes a quickstart method for running `pd`+`cometbft` to test
changes during development.

To start, you'll need to [install Tendermint `v0.34`](../pd/build.md#installing-tendermint).
To start, you'll need to [install CometBFT `v0.34`](../pd/build.md#installing-cometbft).

## Generating configs

Expand All @@ -30,14 +30,14 @@ To run `pd`, run
cargo run --release --bin pd -- start --home ~/.penumbra/testnet_data/node0/pd
```

This will start but won't do anything yet, because Tendermint isn't running.
This will start but won't do anything yet, because CometBFT isn't running.

## Running `tendermint`
## Running `cometbft`

To run Tendermint, run
To run CometBFT, run

```shell
tendermint --home ~/.penumbra/testnet_data/node0/tendermint/ start
cometbft --home ~/.penumbra/testnet_data/node0/cometbft/ start
```

in another terminal window.
Expand Down Expand Up @@ -77,8 +77,8 @@ cargo run --release --bin pcli -- view reset
```

At this point you're ready to generate new configs, and restart both `pd` and
`tendermint`. The order they're started in doesn't particularly matter for
correctness, because `tendermint` will retry connecting to the ABCI server until
`cometbft`. The order they're started in doesn't particularly matter for
correctness, because `cometbft` will retry connecting to the ABCI server until
it succeeds.

## Optional: running smoke-tests
Expand Down
26 changes: 13 additions & 13 deletions docs/guide/src/pd/join-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
We provide instructions for running both fullnode deployments and validator deployments. A
fullnode will sync with the network but will not have any voting power, and will
not be eligible for staking or funding stream rewards. For more information on
what a fullnode is, see the [Tendermint
documentation](https://docs.tendermint.com/v0.34/tendermint-core/using-tendermint.html#adding-a-non-validator).
what a fullnode is, see the [CometBFT
documentation](https://docs.cometbft.com/v0.34/core/using-cometbft#adding-a-non-validator).

A regular validator will participate in voting and rewards, if it becomes part
of the consensus set. Of course, these rewards, like all other testnet tokens,
Expand All @@ -14,7 +14,7 @@ have no value.

To join a testnet as a fullnode, check out the tag for the current testnet, run
`pd testnet join` to generate configs, then use those configs to run `pd` and
`tendermint`. In more detail:
`cometbft`. In more detail:

### Resetting state

Expand Down Expand Up @@ -47,7 +47,7 @@ configs to a testnet data directory (by default, `~/.penumbra/testnet_data`).
If any data exists in the testnet data directory, this command will fail. See
the section above on resetting node state.

### Running `pd` and `tendermint`
### Running `pd` and `cometbft`

Next, run `pd` with the `--home` parameter pointed at the correct part of the
testnet data directory.
Expand All @@ -56,13 +56,13 @@ testnet data directory.
cargo run --bin pd --release -- start --home ~/.penumbra/testnet_data/node0/pd
```

Then (perhaps in another terminal), run Tendermint, also specifying `--home`:
Then (perhaps in another terminal), run CometBFT, also specifying `--home`:

```shell
tendermint start --home ~/.penumbra/testnet_data/node0/tendermint
cometbft start --home ~/.penumbra/testnet_data/node0/cometbft
```

Alternatively, `pd` and `tendermint` can be orchestrated with `docker-compose`:
Alternatively, `pd` and `cometbft` can be orchestrated with `docker-compose`:

```shell
cd deployments/compose/
Expand All @@ -77,7 +77,7 @@ cd deployments/systemd/
sudo cp *.service /etc/systemd/system/
# edit service files to customize for your system
sudo systemctl daemon-reload
sudo systemctl restart penumbra tendermint
sudo systemctl restart penumbra cometbft
```

## Joining as a validator
Expand All @@ -103,7 +103,7 @@ To create a template configuration, use `pcli validator definition template`:

```shell
$ cargo run --release --bin pcli -- validator definition template \
--tendermint-validator-keyfile ~/.penumbra/testnet_data/node0/tendermint/config/priv_validator_key.json \
--tendermint-validator-keyfile ~/.penumbra/testnet_data/node0/cometbft/config/priv_validator_key.json \
--file validator.toml
$ cat validator.toml
# This is a template for a validator definition.
Expand Down Expand Up @@ -148,7 +148,7 @@ rewards.

This is useful if, for example, you know your validator will not be online for a period of time,
and you want to avoid an uptime violation penalty. If you are uploading your validator for the
first time, you will likely want to start with it disabled until your Tendermint & `pd`
first time, you will likely want to start with it disabled until your CometBFT & `pd`
instances have caught up to the consensus block height.

Note that by default the `enabled` field is set to false and will need to be
Expand All @@ -161,14 +161,14 @@ removed if you wish.
#### Setting the consensus key

In the command above, the `--tendermint-validator-keyfile` flag was used to instruct
`pcli` to import the consensus key for the Tendermint identity. This works well
`pcli` to import the consensus key for the CometBFT identity. This works well
if `pcli` and `pd` are used on the same machine. If you are running them in separate
environments, you can omit the flag, and `pd` will generate a random key in the template.
You must then **manually update the `consensus_key`**. You can get the correct value
for `consensus_key` from your `tendermint` configs:
for `consensus_key` from your `cometbft` configs:

```shell
$ grep -A3 pub_key ~/.penumbra/testnet_data/node0/tendermint/config/priv_validator_key.json
$ grep -A3 pub_key ~/.penumbra/testnet_data/node0/cometbft/config/priv_validator_key.json
"pub_key": {
"type": "tendermint/PubKeyEd25519",
"value": "Fodjg0m1kF/6uzcAZpRcLJswGf3EeNShLP2A+UCz8lw="
Expand Down

0 comments on commit 1154b35

Please sign in to comment.