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.

Sign up for GitHub

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

docs: update docs for cutting release #1790

Merged
merged 3 commits into from
Apr 17, 2024
Merged

docs: update docs for cutting release #1790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52728c8
update changelog
bermuell Apr 17, 2024
deb09df
update release notes
bermuell Apr 17, 2024
39ff596
updated upgrading instructions
bermuell Apr 17, 2024
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
0 ...ovider/1740-oldest-unconfirm-vsc-query.md → ...ovider/1740-oldest-unconfirm-vsc-query.md
View file
Open in desktop
File renamed without changes.
0 .changelog/v4.1.0/features/1764-bump-ibc.md → ...og/v4.1.0/state-breaking/1764-bump-ibc.md
View file
Open in desktop
File renamed without changes.
4 changes: 1 addition & 3 deletions .changelog/v4.1.0/summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
<!--
*March 27, 2024*
-->
*April 17, 2024*
15 changes: 12 additions & 3 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,27 @@

## v4.1.0

<!--
*March 27, 2024*
-->
*April 17, 2024*

### DEPENDENCIES

- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to
[v0.47.10](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.10).
([\#1663](https://github.com/cosmos/interchain-security/pull/1663))
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.4.0](https://github.com/cosmos/ibc-go/releases/tag/v7.4.0).
([\#1764](https://github.com/cosmos/interchain-security/pull/1764))

### FEATURES

- [Provider](x/ccv/provider)
- Introduce epochs (i.e., send a VSCPacket every X blocks instead of in every
block) so that we reduce the cost of relaying IBC packets needed for ICS.
([\#1516](https://github.com/cosmos/interchain-security/pull/1516))
- Introduce the gRPC query `/interchain_security/ccv/provider/oldest_unconfirmed_vsc/{chain_id}`
and CLI command `interchain-security-pd q provider oldest_unconfirmed_vsc`
to retrieve the send timestamp of the oldest unconfirmed VSCPacket by chain id.
([\#1740](https://github.com/cosmos/interchain-security/pull/1740))

### IMPROVEMENTS

Expand All @@ -27,6 +32,10 @@

### STATE BREAKING

- General
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
[v7.4.0](https://github.com/cosmos/ibc-go/releases/tag/v7.4.0).
([\#1764](https://github.com/cosmos/interchain-security/pull/1764))
- [Provider](x/ccv/provider)
- Introduce epochs (i.e., send a VSCPacket every X blocks instead of in every
block) so that we reduce the cost of relaying IBC packets needed for ICS.
Expand Down
34 changes: 7 additions & 27 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,17 @@
<!--
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 <v*.*.*> Release Notes
# Replicated Security v4.1.0 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
** REMOVE THE LINE BELOW TO ENABLE THE MARKDOWN LINK CHECKER FOR RELEASE **
<!-- markdown-link-check-disable -->

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.
Check out the [changelog](https://github.com/cosmos/interchain-security/blob/v4.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/v4.0.0...v4.1.0) 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>`.
Refer to the [upgrading guide](https://github.com/cosmos/interchain-security/blob/release/v4.1.x/UPGRADING.md) when migrating from `v4.0.x` to `v4.1.x`.

** REMOVE THE LINE BELOW TO ENABLE THE MARKDOWN LINK CHECKER FOR RELEASE **
<!-- markdown-link-check-enable -->
## 🚀 Highlights

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

## ❤️ Contributors
<!-- markdown-link-check-disable -->
* Informal Systems ([@informalinc](https://twitter.com/informalinc))
<!-- markdown-link-check-enable -->

This list is non-exhaustive and ordered alphabetically.
Thank you to everyone who contributed to this release!
This release introduces epochs that reduce the costs of relaying IBC packets for ICS.
In addition it introduces queries to retrieve the send timestamp of the oldest unconfirmed VSCPacket by chain id and
for current values of all provider parameters.
28 changes: 14 additions & 14 deletions UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide provides instructions for upgrading to specific versions of Replicated Security.

## [v4.1.x](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-rc2) and [v4.1.x-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-lsm-rc2)
## [v4.1.x](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0) and [v4.1.x-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-lsm)

### Provider

Expand All @@ -15,17 +15,17 @@ as well as the corresponding migrators [here](https://github.com/cosmos/intercha

## [v4.0.x](https://github.com/cosmos/interchain-security/tree/release/v4.0.x)

`v4.0.x` sets the minimum required version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3.
`v4.0.x` sets the minimum required version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3.

### Provider
### Provider

Upgrading a provider from `v3.3.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/provider/migrations/migrator.go#L31.
Upgrading a provider from `v3.3.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/provider/migrations/migrator.go#L31.

### Consumer
### Consumer

***Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`.***
***Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`.***

Upgrading a consumer from `v3.2.0` to `v4.0.0` will not require state migration, however, upgrading directly from `v3.1.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/consumer/keeper/migrations.go#L22.
Upgrading a consumer from `v3.2.0` to `v4.0.0` will not require state migration, however, upgrading directly from `v3.1.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/consumer/keeper/migrations.go#L22.

In addition, the following migration needs to be added to the upgrade handler of the consumer chain:
```golang
Expand All @@ -49,15 +49,15 @@ func migrateICSOutstandingDowntime(ctx sdk.Context, keepers *upgrades.UpgradeKee

## [v3.3.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x)

### Provider
### Provider

Upgrading the provider from `v2.x.y` to `v3.3.0` will not require state migration.
Upgrading the provider from `v2.x.y` to `v3.3.0` will not require state migration.

## [v3.2.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x)

`v3.2.0` bumps IBC to `v7.3`. As a result, `legacy_ibc_testing` is not longer required and was removed, see https://github.com/cosmos/interchain-security/pull/1185. This means that when upgrading to `v3.2.0`, any customized tests relying on `legacy_ibc_testing` need to be updated.

### Consumer
### Consumer

Upgrading the consumer from either `v3.0.0` or `v3.1.0` to `v3.2.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v3.2.x/x/ccv/consumer/keeper/migration.go#L25.

Expand All @@ -67,13 +67,13 @@ Upgrading the consumer from either `v3.0.0` or `v3.1.0` to `v3.2.0` will require

The following should be considered as complementary to [Cosmos SDK v0.47 UPGRADING.md](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc2/UPGRADING.md).

#### Protobuf
#### Protobuf

Protobuf code generation, linting and formatting have been updated to leverage the `ghcr.io/cosmos/proto-builder:0.11.5` docker container. Replicated Security protobuf definitions are now packaged and published to [buf.build/cosmos/interchain-security](https://buf.build/cosmos/interchain-security) via CI workflows. The `third_party/proto` directory has been removed in favour of dependency management using [buf.build](https://docs.buf.build/introduction).

#### App modules

Legacy APIs of the `AppModule` interface have been removed from ccv modules. For example, for
Legacy APIs of the `AppModule` interface have been removed from ccv modules. For example, for

```diff
- // Route implements the AppModule interface
Expand Down Expand Up @@ -123,10 +123,10 @@ import (

## [v2.0.x](https://github.com/cosmos/interchain-security/releases/tag/v2.0.0)

### Provider
### Provider

Upgrading a provider from `v1.1.0-multiden` to `v2.0.0` will require state migrations. See [migration.go](https://github.com/cosmos/interchain-security/blob/v2.0.0/x/ccv/provider/keeper/migration.go).

### Consumer

Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations.
Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations.
Loading