Skip to content

Commit

Permalink
docs: update chagelog and release notes (#1552)
Browse files Browse the repository at this point in the history
update chagelog and release notes
  • Loading branch information
mpoke authored Jan 8, 2024
1 parent b4daea5 commit 087a9fe
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .changelog/v3.3.0/summary.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
*December 5, 2023*
*January 5, 2024*
31 changes: 17 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## v3.3.0

*December 5, 2023*
*January 5, 2024*

### API BREAKING

Expand Down Expand Up @@ -32,25 +32,28 @@

### IMPROVEMENTS

- Split out consumer genesis state to reduce shared data between provider and
consumer. ([\#1324](https://github.com/cosmos/interchain-security/pull/1324))
- Note: This breaks json format used by augmenting Genesis files of consumer
chains with consumer genesis content exported from provider chain. Consumer
Genesis content exported from a provider chain using major version 1, 2 or 3
of the provider module needs to be transformed with the transformation command
introduced by this PR:
- General
- Split out consumer genesis state to reduce shared data between provider and
consumer. ([\#1324](https://github.com/cosmos/interchain-security/pull/1324))
- Note: This breaks json format used by augmenting Genesis files of consumer
chains with consumer genesis content exported from provider chain. Consumer
Genesis content exported from a provider chain using major version 1, 2 or 3
of the provider module needs to be transformed with the transformation command
introduced by this PR:
```
Transform the consumer genesis file from a provider version v1, v2 or v3 to a version supported by this consumer. Result is printed to STDOUT.
Example:
$ <appd> transform /path/to/ccv_consumer_genesis.json
Usage:
interchain-security-cd genesis transform [genesis-file] [flags]
interchain-security-cd genesis transform [genesis-file] [flags]
```
- Refactor shared events, codecs and errors assign to
consumer and provider dedicated types where possible.
([\#1350](https://github.com/cosmos/interchain-security/pull/1350))
- Refactor shared events, codecs and errors assign to
consumer and provider dedicated types where possible.
([\#1350](https://github.com/cosmos/interchain-security/pull/1350))
- [Provider](x/ccv/provider)
- Add `QueryAllPairsValConAddrByConsumerChainID` method to get list of all pairs `valConsensus` address by `Consummer chainID`. ([\#1503](https://github.com/cosmos/interchain-security/pull/1503))

### STATE BREAKING

Expand Down
31 changes: 14 additions & 17 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
<!--
A release notes template that should be adapted for every release
- release: <v*.*.*>
- release branch: <v*.x>
- the last release: <v-last>
- the last release branch: <v-last.x>
-->
# Replicated Security v3.3.0 Release Notes

# Replicated Security <v*.*.*> Release Notes

<!--
Please indicate whether this release is relevant to consumers or providers.
-->
***Note this release is ONLY relevant to <consumers/providers>***
***Note this release is ONLY relevant to providers***

## 📝 Changelog

Check out the [changelog](https://github.com/cosmos/interchain-security/blob/<v*.*.*>/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/release/<v-last>...<v*.*.*>) from last release.

<!-- Add the following line for major releases -->
Refer to the [upgrading guide](https://github.com/cosmos/interchain-security/blob/release/<v*.x>/UPGRADING.md) when migrating from `<v-last.x>` to `<v*.x>`.
Check out the [changelog](https://github.com/cosmos/interchain-security/blob/v3.3.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/v3.2.0...v3.3.0) from last release.

## 🚀 Highlights

<!-- Add any highlights of this release -->

This release introduces the following noteworthy changes:

- The cryptographic verification of equivocation feature is ported to SDK 0.47.
The feature is already running on the Cosmos Hub as part of the [v2.4.0-lsm](https://github.com/cosmos/interchain-security/releases/tag/v2.4.0-lsm) release.

- It splits out consumer genesis state to reduce shared data between provider and consumer.
As a result, the consumer CCV genesis state obtained from the provider chain needs to be transformed to be compatible with different versions of consumer chains. For more details, see the [documentation](https://cosmos.github.io/interchain-security/consumer-development/consumer-genesis-transformation).

- A query (`QueryAllPairsValConAddrByConsumerChainID`) is added to get a list of all assigned consumer keys for a given consumer `chainId`. For more details, see the [documentation](https://cosmos.github.io/interchain-security/features/key-assignment).

## ❤️ Contributors

* Decentrio ([@decentriolabs](https://twitter.com/decentriolabs))
* Informal Systems ([@informalinc](https://twitter.com/informalinc))

This list is non-exhaustive and ordered alphabetically.
Expand Down

0 comments on commit 087a9fe

Please sign in to comment.