Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: changelog onto master #946

Merged
merged 3 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 62 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,71 @@
# Changelog

## Unreleased
## v1.2.0 May 13, 2024

### Improvements

- [#909](https://github.com/cosmos/iavl/pull/909) Async pruning of legacy nodes.
- [#925](https://github.com/cosmos/iavl/pull/925) Add the `AsyncPruning` option to the `MutableTree` constructor to enable async pruning.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

The AsyncPruning option mentioned in the CHANGELOG.md does not appear to be implemented in the codebase, nor is it documented outside of the CHANGELOG entry itself. Here are the findings:

  • The term AsyncPruning is only found in the CHANGELOG.md.
  • Searches for related terms like pruning show multiple references, but none specifically mention AsyncPruning.

It is recommended to verify whether this feature is implemented under a different name or if the implementation is pending. Further investigation or clarification from the development team may be necessary.

Analysis chain

Added entry about the AsyncPruning option in the MutableTree constructor.

This is a significant improvement as it enhances the functionality of the tree structure. Ensure that the implementation details and potential impacts of this feature are well-documented in the developer documentation.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the `AsyncPruning` option is implemented and documented in the codebase.

# Test: Search for the `AsyncPruning` implementation in the codebase. Expect: Implementation details and references in the code.
rg --type go $'AsyncPruning'

Length of output: 27



Script:

#!/bin/bash
# Broaden the search to include possible indirect references or different naming conventions related to 'AsyncPruning'
# Search in all files, not just Go files, to capture documentation and other references.

# Search for 'AsyncPruning' in all files
rg 'AsyncPruning'

# Search for 'pruning' to find related context that might include 'AsyncPruning'
rg 'pruning'

Length of output: 2527


## v1.1.4 May 8, 2024

### Bug Fixes

- [#943](https://github.com/cosmos/iavl/pull/943) Fix the `WorkingHash` with the `InitialVersion` option.

## v1.1.2 April 8, 2024

### Bug Fixes

- [#928](https://github.com/cosmos/iavl/pull/928) Fix the reformatted root node issue.

## v1.1.1 March 16, 2024 (retracted)

### Bug Fixes

- [#910](https://github.com/cosmos/iavl/pull/910) Fix the reference root format from (prefix, version) to (prefix, version, nonce)

### Improvements

- [#910](https://github.com/cosmos/iavl/pull/910) Async pruning of legacy orphan nodes.

## v1.1.0 February 29, 2024 (retracted)

### API Breaking Changes

- [#874](https://github.com/cosmos/iavl/pull/874) Decouple `cosmos-db` and implement own `db` package.

## v1.0.4 May 7, 2024

### Bug Fixes

- [#943](https://github.com/cosmos/iavl/pull/943) Fix the `WorkingHash` with the `InitialVersion` option.

## v1.0.3 April 8, 2024

### Bug Fixes

- [#928](https://github.com/cosmos/iavl/pull/928) Fix the reformatted root node issue.

## v1.0.2 March 16, 2024 (retracted)

### Bug Fixes

- [#911](https://github.com/cosmos/iavl/pull/911) Fix the reference root format from (prefix, version) to (prefix, version, nonce)

### Improvements

- [#911](https://github.com/cosmos/iavl/pull/911) Async pruning of legacy orphan nodes.

## v1.0.1 February 16, 2024 (retracted)

### Improvements

- [#876](https://github.com/cosmos/iavl/pull/876) Make pruning of legacy orphan nodes asynchronous.

## v1.0.0 (October 30, 2023) (retracted)

### Improvements

- [#695](https://github.com/cosmos/iavl/pull/695) Add API `SaveChangeSet` to save the changeset as a new version.
- [#703](https://github.com/cosmos/iavl/pull/703) New APIs `NewCompressExporter`/`NewCompressImporter` to support more compact snapshot format.
- [#729](https://github.com/cosmos/iavl/pull/729) Speedup Genesis writes for IAVL, by writing in small batches.
Expand All @@ -18,7 +78,6 @@
- [#943](https://github.com/cosmos/iavl/pull/943) Fix the `WorkingHash` with the `InitialVersion` option.
- [#909](https://github.com/cosmos/iavl/pull/909) Fix the reference node formats and delete legacy nodes.
- [#773](https://github.com/cosmos/iavl/pull/773) Fix memory leak in `Import`.
- [#795](https://github.com/cosmos/iavl/pull/795) Fix plugin used for buf generate.
- [#801](https://github.com/cosmos/iavl/pull/801) Fix rootKey empty check by len equals 0.
- [#805](https://github.com/cosmos/iavl/pull/805) Use `sync.Map` instead of map to prevent concurrent writes at the fast node level

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ In Ethereum, the analog is [Patricia tries](http://en.wikipedia.org/wiki/Radix_t
## IAVL x Cosmos SDK

| IAVL | DB Interface | Cosmos SDK |
| -------------------------------------------------------------- | -------------------------------------------------------- | ---------------- |
|----------------------------------------------------------------|----------------------------------------------------------|------------------|
| [v0.19.x](https://github.com/cosmos/iavl/tree/release/v0.19.x) | [`tm-db`](https://github.com/tendermint/tm-db) | v0.45.x, v0.46.x |
| [v0.20.x](https://github.com/cosmos/iavl/tree/release/v0.20.x) | [`cometbft-db`](https://github.com/cometbft/cometbft-db) | v0.47.x |
| [v1.x.x](https://github.com/cosmos/iavl/tree/release/v1.x.x) | [`cosmos-db`](https://github.com/cosmos/cosmos-db) | - |
| [v1.0.3](https://github.com/cosmos/iavl/tree/release/v1.x.x) | [`cosmos-db`](https://github.com/cosmos/cosmos-db) | v0.50.0-5 |
| [v1.1.2,4](https://github.com/cosmos/iavl/tree/release/v1.x.x) | [`iavl-db`](https://github.com/cosmos/iavl) | v0.50.6 |
| [v1.2.x](https://github.com/cosmos/iavl/tree/release/v1.x.x) | [`iavl-db`](https://github.com/cosmos/iavl) | v0.50.7+ |

NOTE: In the past, a v0.21.x release was published, but never used in production. It was retracted to avoid confusion.