Skip to content

Commit

Permalink
chore: move pending-release to release-notes (#3988)
Browse files Browse the repository at this point in the history
Also adds a line for node operators to modify their mempool
ttl-num-blocks config

(cherry picked from commit a2f10ed)
  • Loading branch information
rootulp authored and rach-id committed Nov 25, 2024
1 parent 3ef301a commit fa2cc55
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
12 changes: 4 additions & 8 deletions docs/release-notes/pending-release.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# Pending Nelease
# Pending Release

## v3.0.0 [Unreleased]
## v4.0.0

### Node Operators
### Node Operators (v4.0.0)

- Consensus node operators should enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3774](https://github.com/celestiaorg/celestia-app/pull/3774).

### Library Consumers

- Namespace and share constants in the `appconsts` package were moved to [celestiaorg/go-square](https://github.com/celestiaorg/go-square). See [#3765](https://github.com/celestiaorg/celestia-app/pull/3765).
### Library Consumers (v4.0.0)
19 changes: 17 additions & 2 deletions docs/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,32 @@

This guide provides notes for major version releases. These notes may be helpful for users when upgrading from previous major versions.

## v3.0.0

### Node Operators (v3.0.0)

- Consensus node operators must enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3774](https://github.com/celestiaorg/celestia-app/pull/3774).
- Consensus node operators should manually configure their node's mempool `ttl-num-blocks = 12` in config.toml. An example command to do this:

```bash
sed -i 's/ttl-num-blocks = 5/ttl-num-blocks = 12/' ~/.celestia-app/config/config.toml
```

### Library Consumers (v3.0.0)

- Namespace and share constants in the `appconsts` package were moved to [celestiaorg/go-square](https://github.com/celestiaorg/go-square). See [#3765](https://github.com/celestiaorg/celestia-app/pull/3765).

## [v2.0.0](https://github.com/celestiaorg/celestia-app/releases/tag/v2.0.0)

### Node Operators
### Node Operators (v2.0.0)

If you are a consensus node operator, please follow the communication channels listed under [network upgrades](https://docs.celestia.org/nodes/participate#network-upgrades) to learn when this release is recommended for each network (e.g. Mocha, Mainnet Beta).

Consensus node operators are expected to upgrade to this release _prior_ to the Lemongrass hardfork if they intend to continue participating in the network. The command used to start the [consensus node](https://docs.celestia.org/nodes/consensus-node#start-the-consensus-node) or [validator node](https://docs.celestia.org/nodes/validator-node#run-the-validator-node) will accept an additional `--v2-upgrade-height` flag. See [this table](https://docs.celestia.org/nodes/network-upgrade-process#lemongrass-network-upgrade) for upgrade heights for each network.

Consensus node operators should enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3812](https://github.com/celestiaorg/celestia-app/pull/3812).

### Library Consumers
### Library Consumers (v2.0.0)

If you are a library consumer, a number of the Go APIs have changed since celestia-app v1.x.x. Some of the notable changes are:

Expand Down

0 comments on commit fa2cc55

Please sign in to comment.