From 5f553bb3ee3a342f1da91f3ab2a4a9079eb2e094 Mon Sep 17 00:00:00 2001 From: Sam Kleinman Date: Fri, 18 Jun 2021 09:57:32 -0400 Subject: [PATCH] changelog: update and regularize changelog entries (#6594) --- CHANGELOG_PENDING.md | 15 ++++++++------- UPGRADING.md | 27 +++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 7 deletions(-) diff --git a/CHANGELOG_PENDING.md b/CHANGELOG_PENDING.md index e54e94b0c..316436001 100644 --- a/CHANGELOG_PENDING.md +++ b/CHANGELOG_PENDING.md @@ -17,9 +17,8 @@ Friendly reminder: We have a [bug bounty program](https://hackerone.com/tendermi - [rpc] \#6168 Change default sorting to desc for `/tx_search` results (@melekes) - [cli] \#6282 User must specify the node mode when using `tendermint init` (@cmwaters) - [state/indexer] \#6382 reconstruct indexer, move txindex into the indexer package (@JayT106) - - [cli] \#6372 Introduce `BootstrapPeers` as part of the new p2p stack. Peers to be connected on - startup (@cmwaters) - - [config] \#6462 Move `PrivValidator` configuration out of `BaseConfig` into its own section. + - [cli] \#6372 Introduce `BootstrapPeers` as part of the new p2p stack. Peers to be connected on startup (@cmwaters) + - [config] \#6462 Move `PrivValidator` configuration out of `BaseConfig` into its own section. (@tychoish) - Apps - [ABCI] \#6408 Change the `key` and `value` fields from `[]byte` to `string` in the `EventAttribute` type. (@alexanderbez) @@ -32,13 +31,15 @@ Friendly reminder: We have a [bug bounty program](https://hackerone.com/tendermi - P2P Protocol - Go API + - [node] \#6540 Reduce surface area of the `node` package by making most of the implementation details private. (@tychoish) + - [p2p] \#6547 Move the entire `p2p` package and all reactor implementations into `internal`. (@tychoish) + - [libs/log] \#6534 Remove the existing custom Tendermint logger backed by go-kit. The logging interface, `Logger`, remains. Tendermint still provides a default logger backed by the performant zerolog logger. (@alexanderbez) - [libs/time] \#6495 Move types/time to libs/time to improve consistency. (@tychoish) - - [libs/log] \#6534 Removed the existing custom Tendermint logger backed by go-kit. The logging interface, `Logger`, remains. Tendermint still provides a default logger backed by the performant zerolog logger. (@alexanderbez) - [mempool] \#6529 The `Context` field has been removed from the `TxInfo` type. `CheckTx` now requires a `Context` argument. (@alexanderbez) - [abci/client, proxy] \#5673 `Async` funcs return an error, `Sync` and `Async` funcs accept `context.Context` (@melekes) - - [p2p] Removed unused function `MakePoWTarget`. (@erikgrinaker) + - [p2p] Remove unused function `MakePoWTarget`. (@erikgrinaker) - [libs/bits] \#5720 Validate `BitArray` in `FromProto`, which now returns an error (@melekes) - - [proto/p2p] Renamed `DefaultNodeInfo` and `DefaultNodeInfoOther` to `NodeInfo` and `NodeInfoOther` (@erikgrinaker) + - [proto/p2p] Rename `DefaultNodeInfo` and `DefaultNodeInfoOther` to `NodeInfo` and `NodeInfoOther` (@erikgrinaker) - [proto/p2p] Rename `NodeInfo.default_node_id` to `node_id` (@erikgrinaker) - [libs/os] Kill() and {Must,}{Read,Write}File() functions have been removed. (@alessio) - [store] \#5848 Remove block store state in favor of using the db iterators directly (@cmwaters) @@ -54,7 +55,7 @@ Friendly reminder: We have a [bug bounty program](https://hackerone.com/tendermi - [rpc/client/http] \#6176 Unexpose `WSEvents` (@melekes) - [rpc/jsonrpc/client/ws_client] \#6176 `NewWS` no longer accepts options (use `NewWSWithOptions` and `OnReconnect` funcs to configure the client) (@melekes) - [internal/libs] \#6366 Move `autofile`, `clist`,`fail`,`flowrate`, `protoio`, `sync`, `tempfile`, `test` and `timer` lib packages to an internal folder - - [libs/rand] \#6364 Removed most of libs/rand in favour of standard lib's `math/rand` (@liamsi) + - [libs/rand] \#6364 Remove most of libs/rand in favour of standard lib's `math/rand` (@liamsi) - [mempool] \#6466 The original mempool reactor has been versioned as `v0` and moved to a sub-package under the root `mempool` package. Some core types have been kept in the `mempool` package such as `TxCache` and it's implementations, the `Mempool` interface itself and `TxInfo`. (@alexanderbez) diff --git a/UPGRADING.md b/UPGRADING.md index 3c1d38658..667228328 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -47,6 +47,33 @@ This guide provides instructions for upgrading to specific versions of Tendermin * CLI commands and flags are all now hyphen-case instead of snake_case. Make sure to adjust any scripts that calls a cli command with snake_casing + +### API Changes + +The p2p layer was reimplemented as part of the 0.35 release cycle, and +all reactors were refactored. As part of that work these +implementations moved into the `internal` package and are no longer +considered part of the public Go API of tendermint. These packages +are: + +- `p2p` +- `mempool` +- `consensus` +- `statesync` +- `blockchain` +- `evidence` + +Accordingly, the space `node` package was changed to reduce access to +tendermint internals: applications that use tendermint as a library +will need to change to accommodate these changes. Most notably: + +- The `Node` type has become internal, and all constructors return a + `service.Service` implementation. + +- The `node.DefaultNewNode` and `node.NewNode` constructors are no + longer exported and have been replaced with `node.New` and + `node.NewDefault` which provide more functional interfaces. + ## v0.34.0 **Upgrading to Tendermint 0.34 requires a blockchain restart.**