From ee2173aa5382f814f11f1e4693267c694ff1570e Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Tue, 13 Aug 2024 11:27:21 +0100 Subject: [PATCH] docs: improve changelog for Inactive Provider Validators (#2131) * inactive vals changelog * Fix typo by adding *not*; and mention that things are parameters * Fix typo in features/2079-... --------- Co-authored-by: Philip Offtermatt --- .../provider/2079-inactive-validators.md | 15 +++++++++++++++ .../features/provider/2035-min-stake-max-rank.md | 5 +++-- .../features/provider/2066-allow-inactive-vals.md | 3 +++ .../features/provider/2066-inactive-vals.md | 1 - .../features/provider/2079-inactive-validators.md | 15 +++++++++++++++ .../provider/2035-min-stake-max-rank.md | 5 +++-- .../provider/2066-allow-inactive-vals.md | 3 +++ .../state-breaking/provider/2066-inactive-vals.md | 1 - .../provider/2079-inactive-validators.md | 3 +++ 9 files changed, 45 insertions(+), 6 deletions(-) create mode 100644 .changelog/unreleased/api-breaking/provider/2079-inactive-validators.md create mode 100644 .changelog/unreleased/features/provider/2066-allow-inactive-vals.md delete mode 100644 .changelog/unreleased/features/provider/2066-inactive-vals.md create mode 100644 .changelog/unreleased/features/provider/2079-inactive-validators.md create mode 100644 .changelog/unreleased/state-breaking/provider/2066-allow-inactive-vals.md delete mode 100644 .changelog/unreleased/state-breaking/provider/2066-inactive-vals.md create mode 100644 .changelog/unreleased/state-breaking/provider/2079-inactive-validators.md diff --git a/.changelog/unreleased/api-breaking/provider/2079-inactive-validators.md b/.changelog/unreleased/api-breaking/provider/2079-inactive-validators.md new file mode 100644 index 0000000000..815f730e58 --- /dev/null +++ b/.changelog/unreleased/api-breaking/provider/2079-inactive-validators.md @@ -0,0 +1,15 @@ +- Add the _Inactive Provider Validators_ feature (as per + [ADR-017](https://cosmos.github.io/interchain-security/adrs/adr-017-allowing-inactive-validators)), + which entails the following changes on the provider. + ([\#2079](https://github.com/cosmos/interchain-security/pull/2079)) + + - Add `max_provider_consensus_validators`, a provider module param that sets + the maximum number of validators that will be passed to the provider consensus engine. + - Add `no_valupdates_genutil` and `no_valupdates_staking`, "wrapper" modules around + the Cosmos SDK's native genutil and staking modules. Both modules provide the exact + same functionality as the native modules, except for *not* returning validator set updates + to the provider consensus engine. + - Return the first `max_provider_consensus_validators` validators (sorted by largest amount of stake first) + to the provider consensus engine. + - Use the `max_validators` validators as basis for the validator sets sent to the consumers + (`max_validators` is a staking module param). \ No newline at end of file diff --git a/.changelog/unreleased/features/provider/2035-min-stake-max-rank.md b/.changelog/unreleased/features/provider/2035-min-stake-max-rank.md index 36184e3d15..e48d7f299f 100644 --- a/.changelog/unreleased/features/provider/2035-min-stake-max-rank.md +++ b/.changelog/unreleased/features/provider/2035-min-stake-max-rank.md @@ -1,2 +1,3 @@ -- Add minimum stake requirement to let consumer chains - determine requirements for validators that validate their chain. ([\#2035](https://github.com/cosmos/interchain-security/pull/2035)) +- Add `min_stake`, a power shaping configuration parameter that enables consumers to set + the minimum amount of provider stake every validator needs to be eligible to opt-in. + ([\#2035](https://github.com/cosmos/interchain-security/pull/2035)) diff --git a/.changelog/unreleased/features/provider/2066-allow-inactive-vals.md b/.changelog/unreleased/features/provider/2066-allow-inactive-vals.md new file mode 100644 index 0000000000..d5f85f9508 --- /dev/null +++ b/.changelog/unreleased/features/provider/2066-allow-inactive-vals.md @@ -0,0 +1,3 @@ +- Add `allow_inactive_vals`, a power shaping configuration parameter that enables consumers + to specify whether validators outside the active provider validator set are eligible to opt-in. + ([\#2066](https://github.com/cosmos/interchain-security/pull/2066)) \ No newline at end of file diff --git a/.changelog/unreleased/features/provider/2066-inactive-vals.md b/.changelog/unreleased/features/provider/2066-inactive-vals.md deleted file mode 100644 index f54d88fc29..0000000000 --- a/.changelog/unreleased/features/provider/2066-inactive-vals.md +++ /dev/null @@ -1 +0,0 @@ -- Add the `allow_inactive_vals` parameter for consumer chains to choose whether inactive validators can validate their chain ([\#2066](https://github.com/cosmos/interchain-security/pull/2066)) \ No newline at end of file diff --git a/.changelog/unreleased/features/provider/2079-inactive-validators.md b/.changelog/unreleased/features/provider/2079-inactive-validators.md new file mode 100644 index 0000000000..815f730e58 --- /dev/null +++ b/.changelog/unreleased/features/provider/2079-inactive-validators.md @@ -0,0 +1,15 @@ +- Add the _Inactive Provider Validators_ feature (as per + [ADR-017](https://cosmos.github.io/interchain-security/adrs/adr-017-allowing-inactive-validators)), + which entails the following changes on the provider. + ([\#2079](https://github.com/cosmos/interchain-security/pull/2079)) + + - Add `max_provider_consensus_validators`, a provider module param that sets + the maximum number of validators that will be passed to the provider consensus engine. + - Add `no_valupdates_genutil` and `no_valupdates_staking`, "wrapper" modules around + the Cosmos SDK's native genutil and staking modules. Both modules provide the exact + same functionality as the native modules, except for *not* returning validator set updates + to the provider consensus engine. + - Return the first `max_provider_consensus_validators` validators (sorted by largest amount of stake first) + to the provider consensus engine. + - Use the `max_validators` validators as basis for the validator sets sent to the consumers + (`max_validators` is a staking module param). \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/provider/2035-min-stake-max-rank.md b/.changelog/unreleased/state-breaking/provider/2035-min-stake-max-rank.md index 36184e3d15..e48d7f299f 100644 --- a/.changelog/unreleased/state-breaking/provider/2035-min-stake-max-rank.md +++ b/.changelog/unreleased/state-breaking/provider/2035-min-stake-max-rank.md @@ -1,2 +1,3 @@ -- Add minimum stake requirement to let consumer chains - determine requirements for validators that validate their chain. ([\#2035](https://github.com/cosmos/interchain-security/pull/2035)) +- Add `min_stake`, a power shaping configuration parameter that enables consumers to set + the minimum amount of provider stake every validator needs to be eligible to opt-in. + ([\#2035](https://github.com/cosmos/interchain-security/pull/2035)) diff --git a/.changelog/unreleased/state-breaking/provider/2066-allow-inactive-vals.md b/.changelog/unreleased/state-breaking/provider/2066-allow-inactive-vals.md new file mode 100644 index 0000000000..d5f85f9508 --- /dev/null +++ b/.changelog/unreleased/state-breaking/provider/2066-allow-inactive-vals.md @@ -0,0 +1,3 @@ +- Add `allow_inactive_vals`, a power shaping configuration parameter that enables consumers + to specify whether validators outside the active provider validator set are eligible to opt-in. + ([\#2066](https://github.com/cosmos/interchain-security/pull/2066)) \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/provider/2066-inactive-vals.md b/.changelog/unreleased/state-breaking/provider/2066-inactive-vals.md deleted file mode 100644 index f54d88fc29..0000000000 --- a/.changelog/unreleased/state-breaking/provider/2066-inactive-vals.md +++ /dev/null @@ -1 +0,0 @@ -- Add the `allow_inactive_vals` parameter for consumer chains to choose whether inactive validators can validate their chain ([\#2066](https://github.com/cosmos/interchain-security/pull/2066)) \ No newline at end of file diff --git a/.changelog/unreleased/state-breaking/provider/2079-inactive-validators.md b/.changelog/unreleased/state-breaking/provider/2079-inactive-validators.md new file mode 100644 index 0000000000..6760b3071d --- /dev/null +++ b/.changelog/unreleased/state-breaking/provider/2079-inactive-validators.md @@ -0,0 +1,3 @@ +- Add the _Inactive Provider Validators_ feature (as per + [ADR-017](https://cosmos.github.io/interchain-security/adrs/adr-017-allowing-inactive-validators)). + ([\#2079](https://github.com/cosmos/interchain-security/pull/2079)) \ No newline at end of file