Skip to content

Commit

Permalink
docs: remove components from changelog (#2257)
Browse files Browse the repository at this point in the history
* update v6 changelog

* add old changelog entries to epilogue.md

* remove componenets from unclog config
  • Loading branch information
mpoke committed Sep 11, 2024
1 parent 07ea628 commit b68c0f5
Show file tree
Hide file tree
Showing 134 changed files with 593 additions and 379 deletions.
18 changes: 2 additions & 16 deletions .changelog/config.toml
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
project_url = "https://github.com/cosmos/interchain-security"

# Settings related to components/sub-modules. Only relevant if you make use of
# components/sub-modules.
[components]

# The title to use for the section of entries not relating to a specific
# component.
general_entries_title = "General"

# The number of spaces to inject before each component-related entry.
entry_indent = 2

# The components themselves. Each component has a name (used when rendered
# to Markdown) and a path relative to the project folder (i.e. relative to
# the parent of the `.changelog` folder).
[components.all]
provider = { name = "Provider", path = "x/ccv/provider" }
consumer = { name = "Consumer", path = "x/ccv/consumer" }
tests = { name = "Tests", path = "tests" }
docs = { name = "Documentation", path = "docs/docs" }
[change_set_sections]
sort_entries_by = "entry-text"
408 changes: 407 additions & 1 deletion .changelog/epilogue.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Add the _Inactive Provider Validators_ feature (as per
- `[x/provider]` 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))
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- The removal of `VSCMaturedPackets` entail several API breaking changes.
- `[x/provider]` The removal of `VSCMaturedPackets` entail several API breaking changes.
([\#2098](https://github.com/cosmos/interchain-security/pull/2098))

- Remove the `oldest_unconfirmed_vsc` query -- used to get
Expand Down
60 changes: 60 additions & 0 deletions .changelog/unreleased/api-breaking/2171-permissionless-ics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
- `[x/provider]` Add the Permissionless ICS feature on the provider (as per
[ADR-019](https://cosmos.github.io/interchain-security/adrs/adr-019-permissionless-ics)),
which entails the following api-breaking changes on the provider.
([\#2171](https://github.com/cosmos/interchain-security/pull/2171))

- Deprecate the `chain-id` parameter in favour of `consumer-id` for all transactions and queries targeting a unique consumer chain. Below is a list highlighting the changes in the CLI commands. All commands assume the prefix `interchain-security-pd tx|q provider`.
- **Transactions:**
- `assign-consensus-key [consumer-id] [consumer-pubkey]`
-- submit a [MsgAssignConsensusKey](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L46)
- `opt-in [consumer-id] [consumer-pubkey]`
-- submit a [MsgOptIn](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L256)
- `opt-out [consumer-id]`
-- submit a [MsgOptOut](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L277)
- `set-consumer-commission-rate [consumer-id] [commission-rate]`
-- submit a [MsgSetConsumerCommissionRate](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L295)

- **Queries:**
- `consumer-genesis [consumer-id]` -- query for consumer chain genesis state by consumer id.
- REST:`/interchain_security/ccv/provider/consumer_genesis/{consumer_id}`

- `validator-consumer-key [consumer-id] [provider-validator-address]` -- query assigned validator consensus public key for a consumer chain.
- REST: `/interchain_security/ccv/provider/validator_consumer_addr/{consumer_id}/{provider_address}`

- `validator-provider-key [consumer-id] [consumer-validator-address]` -- query assigned validator consensus public key for the provider chain.
- REST: `/interchain_security/ccv/provider/validator_provider_addr/{consumer_id}/{consumer_address}`

- `consumer-opted-in-validators [consumer-id]` -- query opted-in validators for a given consumer chain.
- REST: `/interchain_security/ccv/provider/opted_in_validators/{consumer_id}`

- `consumer-validators [consumer-id]` -- query the last set consumer-validator set for a given consumer chain.
- REST: `/interchain_security/ccv/provider/consumer_validators/{consumer_id}`

- `validator-consumer-commission-rate [consumer-id]` -- query the consumer commission rate a validator charges on a consumer chain.
- REST: `/interchain_security/ccv/provider/consumer_commission_rate/{consumer_id}/{provider_address}`

- `all-pairs-valconsensus-address [consumer-id]` -- query all pairs of valconsensus address by consumer id.
- REST: `/interchain_security/ccv/provider/address_pairs/{consumer_id}`

- Deprecate the following queries, proposals and all legacy governance proposals:

- **Queries:**
- `list-start-proposals` -- query consumer chains start proposals on provider chain.
- REST: `/interchain_security/ccv/provider/consumer_chain_start_proposals`

- `list-stop-proposals` -- consumer chains stop proposals on provider chain.
- REST: `/interchain_security/ccv/provider/consumer_chain_stop_proposals`

- `list-proposed-consumer-chains` -- query chain ids in consumer addition proposal before voting finishes.
- REST: `/interchain_security/ccv/provider/proposed_consumer_chains`

- **Proposals:**
- [MsgConsumerAddition](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L121) -- deprecated in favor of [MsgCreateConsumer](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L360)
- [MsgConsumerRemoval](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L206) -- deprecated in favor of [MsgRemoveConsumer](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L225)
- [MsgConsumerModification](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L321) -- deprecated in favor of [MsgUpdateConsumer](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L383)

- **Legacy Proposals:**
- [ConsumerAdditionProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L31)
- [ConsumerModificationProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L140)
- [ConsumerRemovalProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L122)
- [ChangeRewardDenomsProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L192)

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Add `min_stake`, a power shaping configuration parameter that enables consumers to set
- `[x/provider]` 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))
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Add `allow_inactive_vals`, a power shaping configuration parameter that enables consumers
- `[x/provider]` 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))
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Add the _Inactive Provider Validators_ feature (as per
- `[x/provider]` 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))
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Remove `VSCMaturedPackets` from the provider module, which entails the following
- `[x/provider]` Remove `VSCMaturedPackets` from the provider module, which entails the following
changes to the provider.
([\#2098](https://github.com/cosmos/interchain-security/pull/2098))

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[x/provider]` Add a query to get the blocks until the next epoch begins
([\#2106](https://github.com/cosmos/interchain-security/pull/2106))
33 changes: 33 additions & 0 deletions .changelog/unreleased/features/2171-permissionless-ics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
- `[x/provider]` Add the _Permissionless ICS_ feature (as per
[ADR-019](https://cosmos.github.io/interchain-security/adrs/adr-019-permissionless-ics)),
which entails the following CLI and API enhancements on the provider.
([\#2171](https://github.com/cosmos/interchain-security/pull/2171))

- Introduce new CLI commands and gRPC endpoints to manage consumer chains. All commands listed below assume the prefix `interchain-security-pd tx|q provider`.

- **Transactions:**
- `create-consumer [consumer-parameters]`
-- submit a [MsgCreateConsumer](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L360)
-- replace [ConsumerAdditionProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L31)

- `update-consumer [consumer-parameters]`
-- submit a [MsgUpdateConsumer](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L383)
-- replace [ConsumerModificationProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L140)

- `remove-consumer [consumer-id]`
-- submit a [MsgRemoveConsumer](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/tx.proto#L225)
-- replace [ConsumerRemovalProposal](https://github.com/cosmos/interchain-security/blob/a17a3851b5eb3cec515b711dceae0afe9c14c3f0/proto/interchain_security/ccv/provider/v1/provider.proto#L122)

> These new TX commands should be used instead of their corresponding deprecated proposals. To update consumer chains owned by the governance module, a proposal containing a `MsgUpdateConsumer` message must be submitted.
- **Queries:**
- `consumer-chain [consumer-id]`-- query details of a consumer chain associated with the consumer id.
- REST: `interchain-security/ccv/provider/consumer_chain/{consumer_id}`
- `consumer-id-from-client-id [client-id]` -- get the consumer id of a chain from a client id.
- REST: `interchain-security/ccv/provider/consumer_id/{client_id}`
- `blocks-until-next-epoch` -- query number of blocks remaining until the next epoch begins.
- REST: `interchain-security/ccv/provider/blocks_until_next_epoch`

- Improve the `list-consumer-chains` query to accept optional parameters `[phase]` and `[limit]`:
- `[phase]`: Filters returned consumer chains by their phase.
- `[limit]`: Limits the number of consumer chains returned.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Remove provider migrations to consensus versions lower than 7.
- `[x/provider]` Remove provider migrations to consensus versions lower than 7.
To migrate the provider module from consensus version 3, 4, or 5 to consensus version 7 or higher,
users should use v4.3.x in production to migrate to consensus version 6.
([\#2211](https://github.com/cosmos/interchain-security/pull/2211))

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Add `min_stake`, a power shaping configuration parameter that enables consumers to set
- `[x/provider]` 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))
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Add `allow_inactive_vals`, a power shaping configuration parameter that enables consumers
- `[x/provider]` 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))
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- Add the _Inactive Provider Validators_ feature (as per
- `[x/provider]` 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))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[x/provider]` Remove `VSCMaturedPackets` from the provider module (as per
[ADR-018](https://cosmos.github.io/interchain-security/adrs/adr-018-remove-vscmatured)).
([\#2098](https://github.com/cosmos/interchain-security/pull/2098))
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[x/provider]` Add the _Permissionless ICS_ feature (as per
[ADR-019](https://cosmos.github.io/interchain-security/adrs/adr-019-permissionless-ics)).
([\#2171](https://github.com/cosmos/interchain-security/pull/2171))

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/v3.2.0/bug-fixes/consumer/1146-pending-packets.md

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/v3.2.0/bug-fixes/consumer/1262-fee-pool-addr.md

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/v3.2.0/bug-fixes/consumer/1295-migration.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/dependencies/1196-bump-ibc.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/dependencies/1258-bump-ibc.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/dependencies/1258-bump-sdk.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/dependencies/1259-bump-sdk.md

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/v3.2.0/features/provider/1076-export-timestamps.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/features/provider/1280-reward-denoms.md

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/v3.2.0/improvements/1244-consumer-unbonding.md

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/state-breaking/1196-bump-ibc.md

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/v3.2.0/state-breaking/1244-consumer-unbonding.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/state-breaking/1258-bump-ibc.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/state-breaking/1258-bump-sdk.md

This file was deleted.

3 changes: 0 additions & 3 deletions .changelog/v3.2.0/state-breaking/1259-bump-sdk.md

This file was deleted.

This file was deleted.

Loading

0 comments on commit b68c0f5

Please sign in to comment.