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

docs: bring v4.1.0 and v4.1.1 changelog to main #1793

Merged
merged 7 commits into from
Apr 23, 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
1 change: 1 addition & 0 deletions .changelog/v4.1.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*April 17, 2024*
1 change: 1 addition & 0 deletions .changelog/v4.1.1/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*April 22, 2024*
57 changes: 54 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,56 @@
# CHANGELOG

## v4.1.1

*April 22, 2024*

### BUG FIXES

- [Provider](x/ccv/provider)
- Fix the output format of QueryAllPairsValConAddrByConsumerChainID to be consumer addresses instead of bytes
([\#1722](https://github.com/cosmos/interchain-security/pull/1722))

## v4.1.0

*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

- [Provider](x/ccv/provider)
- Added query for current values of all provider parameters
([\#1605](https://github.com/cosmos/interchain-security/pull/1605))

### 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.
([\#1516](https://github.com/cosmos/interchain-security/pull/1516))

## v4.0.0

*January 22, 2024*
Expand Down Expand Up @@ -164,9 +215,9 @@
- [Consumer](x/ccv/consumer)
- Add the consumer-side changes for jail throttling with retries (cf. ADR 008).
([\#1024](https://github.com/cosmos/interchain-security/pull/1024))
- Introduce the gRPC query `/interchain_security/ccv/consumer/provider-
info` and CLI command `interchain-security-cd q ccvconsumer
provider-info` to retrieve provider info from the consumer chain.
- Introduce the gRPC query `/interchain_security/ccv/consumer/provider-info`
and CLI command `interchain-security-cd q ccvconsumer provider-info`
to retrieve provider info from the consumer chain.
([\#1164](https://github.com/cosmos/interchain-security/pull/1164))
- [Provider](x/ccv/provider)
- Add `InitTimeoutTimestamps` and `ExportedVscSendTimestamps` to exported
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/consumer-development/changeover-procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ The changeover procedure may be updated in the future to create a seamless way o

This onboarding checklist is slightly different from the one under [Onboarding](./onboarding.md)

Additionally, you can check the [testnet repo](https://github.com/cosmos/testnets/blob/master/replicated-security/CONSUMER_LAUNCH_GUIDE.md) for a comprehensive guide on preparing and launching consumer chains.
Additionally, you can check the [testnet repo](https://github.com/cosmos/testnets/blob/master/interchain-security/CONSUMER_LAUNCH_GUIDE.md) for a comprehensive guide on preparing and launching consumer chains.

## 1. Complete testing & integration

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/consumer-development/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Onboarding Checklist
---
# Consumer Onboarding Checklist

The following checklists will aid in onboarding a new consumer chain to replicated security.
The following checklists will aid in onboarding a new consumer chain to interchain security.

Additionally, you can check the [testnet repo](https://github.com/cosmos/testnets/blob/master/replicated-security/CONSUMER_LAUNCH_GUIDE.md) for a comprehensive guide on preparing and launching consumer chains.
Additionally, you can check the [testnet repo](https://github.com/cosmos/testnets/blob/master/interchain-security/CONSUMER_LAUNCH_GUIDE.md) for a comprehensive guide on preparing and launching consumer chains.

## 1. Complete testing & integration

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/proposals.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Minimal example:
"distribution_transmission_channel": "channel-123"
}
```
More examples can be found in the replicated security testnet repository [here](https://github.com/cosmos/testnets/blob/master/replicated-security/stopped/baryon-1/proposal-baryon-1.json) and [here](https://github.com/cosmos/testnets/blob/master/replicated-security/stopped/noble-1/start-proposal-noble-1.json).
More examples can be found in the interchain security testnet repository [here](https://github.com/cosmos/testnets/blob/master/interchain-security/stopped/baryon-1/proposal-baryon-1.json) and [here](https://github.com/cosmos/testnets/blob/master/interchain-security/stopped/noble-1/start-proposal-noble-1.json).

## `ConsumerRemovalProposal`
Proposal type used to suggest removing an existing consumer chain.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/validators/joining-neutron.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Neutron is the first consumer chain to implement ICS.
You can find instructions on joining the mainnet [here](https://docs.neutron.org/neutron/consumer-chain-launch).


To join Neutron chain on the replicated security testnet check [here](https://github.com/cosmos/testnets/tree/master/replicated-security/pion-1)
To join Neutron chain on the interchain security testnet check [here](https://github.com/cosmos/testnets/tree/master/interchain-security/pion-1)

## Resources
* [Neutron docs](https://docs.neutron.org)
12 changes: 6 additions & 6 deletions docs/docs/validators/joining-testnet.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
sidebar_position: 2
title: Joining Replicated Security testnet
title: Joining Interchain Security testnet
---

## Introduction

This short guide will teach you how to join the [Replicated Security testnet](https://github.com/cosmos/testnets/tree/master/replicated-security).
This short guide will teach you how to join the [Interchain Security testnet](https://github.com/cosmos/testnets/tree/master/interchain-security).

The experience gained in the testnet will prepare you for validating interchain secured chains.

Expand All @@ -21,7 +21,7 @@ For general information about running cosmos-sdk based chains check out the [val
At present, all validators of the provider chain must also validate all governance approved consumer chains. The consumer chains cannot have a validator set different than the provider, which means they cannot introduce validators that are not also validating the provider chain.
:::

A comprehensive guide is available [here](https://github.com/cosmos/testnets/tree/master/replicated-security/provider).
A comprehensive guide is available [here](https://github.com/cosmos/testnets/tree/master/interchain-security/provider).

## Initialization

Expand Down Expand Up @@ -119,22 +119,22 @@ $: ./statesync.sh # setup config.toml for statesync
Finally, copy the provider genesis and start your node:

```bash
$: GENESIS_URL=https://github.com/cosmos/testnets/raw/master/replicated-security/provider/provider-genesis.json
$: GENESIS_URL=https://github.com/cosmos/testnets/raw/master/interchain-security/provider/provider-genesis.json
$: wget $GENESIS_URL -O genesis.json
$: genesis.json $NODE_HOME/config/genesis.json
# start the service
$: gaiad start --x-crisis-skip-assert-invariants --home $NODE_HOME --p2p.seeds="08ec17e86dac67b9da70deb20177655495a55407@provider-seed-01.rs-testnet.polypore.xyz:26656,4ea6e56300a2f37b90e58de5ee27d1c9065cf871@provider-seed-02.rs-testnet.polypore.xyz:26656"
```

Additional scripts to setup your nodes are available [here](https://github.com/cosmos/testnets/blob/master/replicated-security/provider/join-rs-provider.sh) and [here](https://github.com/cosmos/testnets/blob/master/replicated-security/provider/join-rs-provider-cv.sh). The scripts will configure your node and create the required services - the scripts only work in linux environments.
Additional scripts to setup your nodes are available [here](https://github.com/cosmos/testnets/blob/master/interchain-security/provider/join-ics-provider.sh) and [here](https://github.com/cosmos/testnets/blob/master/interchain-security/provider/join-ics-provider-cv.sh). The scripts will configure your node and create the required services - the scripts only work in linux environments.

## Joining consumer chains

:::tip
Once you reach the active set on the provider chain, you will be required to validate all available consumer chains.

You can use the same consensus key on all consumer chains, or opt to use a different key on each consumer chain.
Check out this [guide](../features/key-assignment.md) to learn more about key assignment in replicated security.
Check out this [guide](../features/key-assignment.md) to learn more about key assignment in interchain security.
:::

To join consumer chains, simply replicate the steps above for each consumer using the correct consumer chain binaries.
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/validators/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Overview
:::tip
We advise that you join the [Replicated Security testnet](https://github.com/cosmos/testnets/tree/master/replicated-security) to gain hands-on experience with running consumer chains.
We advise that you join the [Replicated Security testnet](https://github.com/cosmos/testnets/tree/master/interchain-security) to gain hands-on experience with running consumer chains.
:::

At present, replicated security requires all validators of the provider chain (ie. Cosmos Hub) to run validator nodes for all governance-approved consumer chains.
Expand Down Expand Up @@ -63,11 +63,11 @@ The new `genesis.json` containing the initial validator set will be distributed
:::tip
Please pay attention to any onboarding repositories provided by the consumer chain teams.
Recommendations are available in [Consumer Onboarding Checklist](../consumer-development/onboarding.md).
Another comprehensive guide is available in the [Replicated Security testnet repo](https://github.com/cosmos/testnets/blob/master/replicated-security/CONSUMER_LAUNCH_GUIDE.md).
Another comprehensive guide is available in the [Interchain Security testnet repo](https://github.com/cosmos/testnets/blob/master/interchain-security/CONSUMER_LAUNCH_GUIDE.md).
:::

### 7. Creating IBC connections
Finally, to fully establish replicated security an IBC relayer is used to establish connections and create the required channels.
Finally, to fully establish interchain security an IBC relayer is used to establish connections and create the required channels.

:::warning
The relayer can establish the connection only after the consumer chain starts producing blocks.
Expand All @@ -91,7 +91,7 @@ More information is available in [Downtime Slashing documentation](../features/s
:::

## Double-signing Infractions
To learn more about equivocation handling in replicated security check out the [Slashing](../features/slashing.md) documentation section.
To learn more about equivocation handling in interchain security check out the [Slashing](../features/slashing.md) documentation section.

## Key assignment
Validators can use different consensus keys on the provider and each of the consumer chains. The consumer chain consensus key must be registered on the provider before use.
Expand All @@ -101,5 +101,5 @@ For more information check out the [Key assignment overview and guide](../featur
## References:
- [Cosmos Hub Validators FAQ](https://hub.cosmos.network/validators/validator-faq)
- [Cosmos Hub Running a validator](https://hub.cosmos.network/validators/validator-setup)
- [Startup Sequence](https://github.com/cosmos/testnets/blob/master/replicated-security/CONSUMER_LAUNCH_GUIDE.md#chain-launch)
- [Startup Sequence](https://github.com/cosmos/testnets/blob/master/interchain-security/CONSUMER_LAUNCH_GUIDE.md#chain-launch)
- [Submit Unjailing Transaction](https://hub.cosmos.network/validators/validator-setup#unjail-validator)
Loading