Skip to content

Commit

Permalink
chore: Update root docs (cometbft#1740)
Browse files Browse the repository at this point in the history
* Import v1.0.0-alpha.1 changelog entries

Signed-off-by: Thane Thomson <connect@thanethomson.com>

* Import root doc changes from v1.x branch

Signed-off-by: Thane Thomson <connect@thanethomson.com>

* Import changelog config from v1.x branch

Signed-off-by: Thane Thomson <connect@thanethomson.com>

* unclog build

Signed-off-by: Thane Thomson <connect@thanethomson.com>

* Fix changelog entry and put it in v1.0.0-alpha.1

Signed-off-by: Thane Thomson <connect@thanethomson.com>

* unclog build

Signed-off-by: Thane Thomson <connect@thanethomson.com>

---------

Signed-off-by: Thane Thomson <connect@thanethomson.com>
  • Loading branch information
thanethomson authored Dec 5, 2023
1 parent 037a4a1 commit 999692e
Show file tree
Hide file tree
Showing 96 changed files with 1,510 additions and 655 deletions.
18 changes: 17 additions & 1 deletion .changelog/config.toml
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
project_url = 'https://github.com/cometbft/cometbft'
project_url = 'https://github.com/cometbft/cometbft'

sort_releases_by = [
"date",
"version"
]
release_date_formats = [
# "*December 1, 2023*
"*%B %d, %Y*",
# "*Dec 1, 2023*
"*%b %d, %Y*",
# "2023-12-01" (ISO format)
"%F",
]

[change_set_sections]
sort_entries_by = "entry-text"
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
`[mempool]` Change the signature of `CheckTx` in the `Mempool` interface to
`CheckTx(tx types.Tx) (*abcicli.ReqRes, error)`. Also, add new method
`SetTxRemovedCallback`.
([\#1010](https://github.com/cometbft/cometbft/issues/1010))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[state]` The `state.Store` interface has been expanded
to accommodate the data pull companion API of ADR 101
([\#1096](https://github.com/cometbft/cometbft/issues/1096))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[proxy]` Expand `ClientCreator` interface to allow
for per-"connection" control of client creation
([\#1141](https://github.com/cometbft/cometbft/pull/1141))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[mempool]` Remove `mempoolIDs` for internally storing peer ids as `p2p.ID`
instead of `uint16`.
([\#1146](https://github.com/cometbft/cometbft/pull/1146))
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- `[cmd]` Remove `replay` and `replay-console` subcommands
and corresponding consensus file replay code, such as
`consensus.RunReplayFile`, and `consensus.State.ReplayFile`
([\#1170](https://github.com/cometbft/cometbft/pull/1170))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state/indexer/block]` BlockIndexer now has additional method `Prune`, `GetRetainHeight`, `SetRetainHeight` ([\#1176](https://github.com/cometbft/cometbft/pull/1176))
- `[state/txindex]` TxIndexer now has additional methods: `Prune`, `GetRetainHeight`, `SetRetainHeight` ([\#1176](https://github.com/cometbft/cometbft/pull/1176))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[node]` Change the signature of `GenesisDocProvider` to
return the checksum of JSON content alongside the parsed genesis data
([\#1287](https://github.com/cometbft/cometbft/issues/1287)).
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[node]` Go-API breaking: Change the signature of `LoadStateFromDBOrGenesisDocProvider`
to accept an optional operator provided hash of the genesis file
([\#1324](https://github.com/cometbft/cometbft/pull/1324)).
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[version]` Bumped the P2P version from 8 to 9, as this release contains new P2P messages.
([\#1411](https://github.com/cometbft/cometbft/pull/1411))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[rpc/client]` Hard-code the `/websocket` endpoint path such that it is
no longer configurable, removing the related client constructor parameter
([\#1412](https://github.com/cometbft/cometbft/pull/1412))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[blocksync]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[consensus]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[evidence]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[inspect]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/autofile]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/bits]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/clist]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/cmap]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/events]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/fail]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/flowrate]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/net]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/os]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/progressbar]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/protoio]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/pubsub]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/rand]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/service]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/strings]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/sync]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/tempfile]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/timer]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[libs/async]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[statesync]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[store]` Move to `internal`
([\#1485](https://github.com/cometbft/cometbft/pull/1485))
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- `[abci]` Renamed the alias types for gRPC requests, responses, and service
instances to follow the naming changes in the proto-derived
`api/cometbft/abci/v1` package
([\#1533](https://github.com/cometbft/cometbft/pull/1533)):
* The prefixed naming pattern `RequestFoo`, `ReponseFoo` changed to
suffixed `FooRequest`, `FooResponse`.
* Each method gets its own unique request and response type to allow for
independent evolution with backward compatibility.
* `ABCIClient` renamed to `ABCIServiceClient`.
* `ABCIServer` renamed to `ABCIServiceServer`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[store]` Make the `LoadBlock` method also return block metadata
([\#1556](https://github.com/cometbft/cometbft/issues/1556))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Made `/api` a standalone Go module with its own `go.mod`
([\#1561](https://github.com/cometbft/cometbft/issues/1561))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[comet]` Version variables, in `version/version.go`, have been renamed to reflect the CometBFT rebranding.
([cometbft/cometbft\#1621](https://github.com/cometbft/cometbft/pull/1621))
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- `[proto]` Renamed the packages from `tendermint.*` to `cometbft.*`
and introduced versioned packages to distinguish between proto definitions
released in 0.34.x, 0.37.x, 0.38.x, and 1.0.x versions.
Prior to the 1.0 release, the versioned packages are suffixed with
`.v1beta1`, `.v1beta2`, and so on; all definitions describing the protocols
as per the 1.0.0 release are in packages suffixed with `.v1`.
Relocated generated Go code into a new `api` folder and changed the import
paths accordingly.
([\#495](https://github.com/cometbft/cometbft/pull/495)
[\#1504](https://github.com/cometbft/cometbft/issues/1504))
2 changes: 2 additions & 0 deletions .changelog/v1.0.0-alpha.1/breaking-changes/558-tm10011-B.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[crypto/merkle]` The public `Proof.ComputeRootHash` function has been deleted.
([\#558](https://github.com/cometbft/cometbft/issues/558))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[rpc/grpc]` Remove the deprecated gRPC broadcast API
([\#650](https://github.com/cometbft/cometbft/issues/650))
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- `[abci]` Changed the proto-derived enum type and constant aliases to the
buf-recommended naming conventions adopted in the `abci/v1` proto package.
For example, `ResponseProcessProposal_ACCEPT` is renamed to `PROCESS_PROPOSAL_STATUS_ACCEPT`
([\#736](https://github.com/cometbft/cometbft/issues/736)).
- `[abci]` The `Type` enum field is now required to be set to a value other
than the default `CHECK_TX_TYPE_UNKNOWN` for a valid `CheckTxRequest`
([\#736](https://github.com/cometbft/cometbft/issues/736)).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- `[rpc]` The endpoints `broadcast_tx_*` now return an error when the node is
performing block sync or state sync.
([\#785](https://github.com/cometbft/cometbft/issues/785))
- `[mempool]` When the node is performing block sync or state sync, the mempool
reactor now discards incoming transactions from peers, and does not propagate
transactions to peers.
([\#785](https://github.com/cometbft/cometbft/issues/785))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[consensus]` `Handshaker.Handshake` now requires `context.Context` ([cometbft/cometbft\#857](https://github.com/cometbft/cometbft/pull/857))
- `[node]` `NewNode` now requires `context.Context` as the first parameter ([cometbft/cometbft\#857](https://github.com/cometbft/cometbft/pull/857))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[consensus]` Consensus now prevotes `nil` when the proposed value does not
match the value the local validator has locked on
([\#1203](https://github.com/cometbft/cometbft/pull/1203))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[consensus]` Remove logic to unlock block on +2/3 prevote for nil
([\#1175](https://github.com/cometbft/cometbft/pull/1175): @BrendanChou)
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state/indexer]` Respect both height params while querying for events
([\#1529](https://github.com/cometbft/cometbft/pull/1529))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state/pruning]` When no blocks are pruned, do not attempt to prune statestore
([\#1616](https://github.com/cometbft/cometbft/pull/1616))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[config]` Add `[grpc.block_service]` section to configure gRPC `BlockService`
([\#1094](https://github.com/cometbft/cometbft/issues/1094))
3 changes: 3 additions & 0 deletions .changelog/v1.0.0-alpha.1/features/1094-grpc-block-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[grpc]` Add `BlockService` with client to facilitate fetching of blocks and
streaming of the latest committed block height
([\#1094](https://github.com/cometbft/cometbft/issues/1094))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[config]` Add `[grpc.block_results_service]` gRPC configuration `BlockResultsService`
([\#1095](https://github.com/cometbft/cometbft/issues/1095))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[grpc]` Add `BlockResultsService` with client to fetch BlockResults
for a given height, or latest.
([\#1095](https://github.com/cometbft/cometbft/issues/1095))
23 changes: 23 additions & 0 deletions .changelog/v1.0.0-alpha.1/features/1097-pruning-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
- `[proto]` Add definitions and generated code for
[ADR-101](./docs/architecture/adr-101-data-companion-pull-api.md)
`PruningService` in the `cometbft.services.pruning.v1` proto package
([\#1097](https://github.com/cometbft/cometbft/issues/1097)).
- `[rpc/grpc]` Add privileged gRPC server and client facilities, in
`server/privileged` and `client/privileged` packages respectively, to
enable a separate API server within the node which serves trusted clients
without authentication and should never be exposed to public internet
([\#1097](https://github.com/cometbft/cometbft/issues/1097)).
- `[rpc/grpc]` Add a pruning service adding on the privileged gRPC server API to
give an [ADR-101](./docs/architecture/adr-101-data-companion-pull-api.md) data
companion control over block data retained by the node. The
`WithPruningService` option method in `server/privileged` is provided to
configure the pruning service
([\#1097](https://github.com/cometbft/cometbft/issues/1097)).
- `[rpc/grpc]` Add `PruningServiceClient` interface
for the gRPC client in `client/privileged` along with a configuration option
to enable it
([\#1097](https://github.com/cometbft/cometbft/issues/1097)).
- `[config]` Add `[grpc.privileged]` section to configure the privileged
gRPC server for the node, and `[grpc.privileged.pruning_service]` section
to control the pruning service
([\#1097](https://github.com/cometbft/cometbft/issues/1097)).
2 changes: 2 additions & 0 deletions .changelog/v1.0.0-alpha.1/features/1234-pruning-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[metrics]` Add metrics to monitor pruning and current available data in stores: `PruningServiceBlockRetainHeight`, `PruningServiceBlockResultsRetainHeight`, `ApplicationBlockRetainHeight`, `BlockStoreBaseHeight`, `ABCIResultsBaseHeight`.
([\#1234](https://github.com/cometbft/cometbft/pull/1234))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
`[rpc/grpc]` Add gRPC endpoint for pruning the block and transaction indexes
([\#1327](https://github.com/cometbft/cometbft/pull/1327))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state]` Add TxIndexer and BlockIndexer pruning metrics
([\#1334](https://github.com/cometbft/cometbft/issues/1334))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[metrics]` Add metric for mempool size in bytes `SizeBytes`.
([\#1512](https://github.com/cometbft/cometbft/pull/1512))
17 changes: 17 additions & 0 deletions .changelog/v1.0.0-alpha.1/features/1643-nop-mempool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
- `[mempool]` Add `nop` mempool ([\#1643](https://github.com/cometbft/cometbft/pull/1643))

If you want to use it, change mempool's `type` to `nop`:

```toml
[mempool]

# The type of mempool for this node to use.
#
# Possible types:
# - "flood" : concurrent linked list mempool with flooding gossip protocol
# (default)
# - "nop" : nop-mempool (short for no operation; the ABCI app is responsible
# for storing, disseminating and proposing txs). "create_empty_blocks=false"
# is not supported.
type = "nop"
```
2 changes: 2 additions & 0 deletions .changelog/v1.0.0-alpha.1/features/816-grpc-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[rpc/grpc]` Add gRPC client with support for version service
([\#816](https://github.com/cometbft/cometbft/issues/816))
3 changes: 3 additions & 0 deletions .changelog/v1.0.0-alpha.1/features/816-grpc-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[rpc/grpc]` Add gRPC server to the node, configurable
via a new `[grpc]` section in the configuration file
([\#816](https://github.com/cometbft/cometbft/issues/816))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[rpc/grpc]` Add gRPC version service to allow clients to
establish the software and protocol versions of the node
([\#816](https://github.com/cometbft/cometbft/issues/816))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[node]` Remove genesis persistence in state db, replaced by a hash
([cometbft/cometbft\#1017](https://github.com/cometbft/cometbft/pull/1017),
[cometbft/cometbft\#1295](https://github.com/cometbft/cometbft/pull/1295))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[consensus]` Log vote validation failures at info level
([\#1022](https://github.com/cometbft/cometbft/pull/1022))
3 changes: 3 additions & 0 deletions .changelog/v1.0.0-alpha.1/improvements/1096-config-pruner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[config]` Added `[storage.pruning]` and `[storage.pruning.data_companion]`
sections to facilitate background pruning and data companion (ADR 101)
operations ([\#1096](https://github.com/cometbft/cometbft/issues/1096))
3 changes: 3 additions & 0 deletions .changelog/v1.0.0-alpha.1/improvements/1096-node-pruner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[node]` The `node.Node` struct now manages a
`state.Pruner` service to facilitate background pruning
([\#1096](https://github.com/cometbft/cometbft/issues/1096))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state]` ABCI response pruning has been added for use by the data companion
([\#1096](https://github.com/cometbft/cometbft/issues/1096))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[state]` Block pruning has been moved from the block executor into a
background process ([\#1096](https://github.com/cometbft/cometbft/issues/1096))
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- `[abci/client]` Add consensus-synchronized local client creator,
which only imposes a mutex on the consensus "connection", leaving
the concurrency of all other "connections" up to the application
([\#1141](https://github.com/cometbft/cometbft/pull/1141))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[abci/client]` Add fully unsynchronized local client creator, which
imposes no mutexes on the application, leaving all handling of concurrency up
to the application ([\#1141](https://github.com/cometbft/cometbft/pull/1141))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[consensus]` When prevoting, avoid calling PropocessProposal when we know the
proposal was already validated by correct nodes.
([\#1230](https://github.com/cometbft/cometbft/pull/1230))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[node]` On upgrade, after [\#1296](https://github.com/cometbft/cometbft/pull/1296), delete the genesis file existing in the DB.
([cometbft/cometbft\#1297](https://github.com/cometbft/cometbft/pull/1297)
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[cli/node]` The genesis hash provided with the `--genesis-hash` is now
forwarded to the node, instead of reading the file.
([\#1324](https://github.com/cometbft/cometbft/pull/1324)).
3 changes: 3 additions & 0 deletions .changelog/v1.0.0-alpha.1/improvements/1412-rpc-versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[rpc]` The RPC API is now versioned, with all existing endpoints accessible
via `/v1/*` as well as `/*`
([\#1412](https://github.com/cometbft/cometbft/pull/1412))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[consensus]` Reduce the default MaxBytes to 4MB and increase MaxGas to 10 million
([\#1518](https://github.com/cometbft/cometbft/pull/1518))
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
- `[mempool]` Add experimental feature to limit the number of persistent peers and non-persistent
peers to which the node gossip transactions.
([\#1558](https://github.com/cometbft/cometbft/pull/1558))
([\#1584](https://github.com/cometbft/cometbft/pull/1584))
- `[config]` Add mempool parameters `experimental_max_gossip_connections_to_persistent_peers` and
`experimental_max_gossip_connections_to_non_persistent_peers` for limiting the number of peers to
which the node gossip transactions.
([\#1558](https://github.com/cometbft/cometbft/pull/1558))
([\#1584](https://github.com/cometbft/cometbft/pull/1584))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[e2e]` Allow latency emulation between nodes.
([\#1560](https://github.com/cometbft/cometbft/pull/1560))
Loading

0 comments on commit 999692e

Please sign in to comment.