Skip to content

Commit

Permalink
docs: refresh docs page (#3360)
Browse files Browse the repository at this point in the history
* docs: update configs

* docs: update configs

* docs: add lsm section

* docs: mv modules section

* docs: small ics refactor
  • Loading branch information
MSalopek committed Sep 23, 2024
1 parent 3ce3c5b commit c5e9b0a
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 357 deletions.
34 changes: 1 addition & 33 deletions docs/docs/getting-started/what-is-gaia.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,38 +20,6 @@ Interchain security features deployed on the Cosmos Hub blockchain allow anyone
:::


The `gaia` blockchain uses the following cosmos-sdk, ibc-go and interchain-security modules, alongside some others:

## cosmos-sdk
* [x/auth](https://docs.cosmos.network/v0.47/build/modules/auth)
* [x/authz](https://docs.cosmos.network/v0.47/build/modules/authz)
* [x/bank](https://docs.cosmos.network/v0.47/build/modules/bank)
* [x/capability](https://docs.cosmos.network/v0.47/build/modules/capability)
* [x/consensus](https://docs.cosmos.network/v0.47/build/modules/consensus)
* [x/crisis](https://docs.cosmos.network/v0.47/build/modules/crisis)
* [x/distribution](https://docs.cosmos.network/v0.47/build/modules/distribution)
* [x/evidence](https://docs.cosmos.network/v0.47/build/modules/evidence)
* [x/feegrant](https://docs.cosmos.network/v0.47/build/modules/feegrant)
* [x/gov](https://docs.cosmos.network/v0.47/build/modules/gov)
* [x/mint](https://docs.cosmos.network/v0.47/build/modules/mint)
* [x/params](https://docs.cosmos.network/v0.47/build/modules/params)
* [x/slashing](https://docs.cosmos.network/v0.47/build/modules/slashing)
* [x/staking (with LSM changes)](https://docs.cosmos.network/v0.47/build/modules/staking)
* [x/upgrade](https://docs.cosmos.network/v0.47/build/modules/upgrade)

## ibc-go
* [transfer](https://ibc.cosmos.network/main/apps/transfer/overview)
* [interchain accounts - host](https://ibc.cosmos.network/v8/apps/interchain-accounts/client#host)
* [interchain accounts - controller](https://ibc.cosmos.network/v8/apps/interchain-accounts/client#controller)
* [interchain-security/provider](https://github.com/cosmos/interchain-security/tree/main/x/ccv/provider)
* [packetforward](https://github.com/cosmos/ibc-apps/tree/main/middleware/packet-forward-middleware)
* [ibcfee](https://ibc.cosmos.network/v7/middleware/ics29-fee/overview)
* [ibc-rate-limiting](https://github.com/Stride-Labs/ibc-rate-limiting)

## gaia specific modules
* [x/metaprotocols](https://github.com/cosmos/gaia/tree/main/x/metaprotocols)

## other modules
* [fee market](https://github.com/skip-mev/feemarket)
For a full list of modules used on the Cosmos Hub follow this [link](../modules/README.md).

Next, learn how to [install Gaia](./installation.md).
7 changes: 0 additions & 7 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@ order: 1
sidebar_position: 1
---

:::tip
### **Gaia v19 Upgrade**
Cosmos Hub upgraded to [v19.1.0](https://github.com/cosmos/gaia/releases/tag/v19.1.0) at block height: [21,835,200](https://www.mintscan.io/cosmos/block/21835200).

To upgrade from v18.1.0 check the [upgrade guide](https://github.com/cosmos/gaia/blob/v19.1.0/UPGRADING.md).
:::

![Welcome to the Cosmos Hub](images/cosmos-hub-image.jpg)

# Introduction
Expand Down
22 changes: 15 additions & 7 deletions docs/docs/interchain-security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,31 @@ title: Interchain Security
order: 3
---

The [Interchain Security](https://cosmos.github.io/interchain-security/) feature brings to the Cosmos Hub a shared security model, where the Cosmos Hub validators, also validate on consumer chains. This is valuable for consumer chains, as consumer chains can focus on product-market fit, rather than business and operational agreements in bringing together a validator set. As part of this agreement, consumer chains pay for the security by distributing a portion of the consumer chain revenue to Hub token holders.
The [Interchain Security](https://cosmos.github.io/interchain-security/) feature brings to the Cosmos Hub a shared security model, where the Cosmos Hub validators, also validate consumer chains. This is valuable for consumer chains, as consumer chains can focus on product-market fit, rather than business and operational agreements in bringing together a validator set. As part of this agreement, consumer chains pay for the security by distributing a portion of the consumer chain revenue to Hub token holders.

All potential chains are onboarded as consumer chains, via Hub Governance, with the feedback from the Hub community.

## New ICS features
## ICS features

Novel Interchain Security features such as [Partial Set Security](https://cosmos.github.io/interchain-security/features/partial-set-security) and [Power Shaping](https://cosmos.github.io/interchain-security/features/power-shaping) bring benefits for both the consumer chains and validators:
[Partial Set Security](https://cosmos.github.io/interchain-security/features/partial-set-security) and [Power Shaping](https://cosmos.github.io/interchain-security/features/power-shaping) bring benefits for both the consumer chains and validators:

### Top-N consumer chains

Validators inside the top-N percent of voting power are required to validate the consumer chain.

e.g. `top-95` means that the 95% of the validators (by voting power) are required to run the consumer chain binary

### Opt-in consumer chains

Only validators that opt to running a consumer chains are required to run the chain binary and become eligible for consumer chain rewards distribution.

### New consumer chain parameters
### Parameter customization

Consumer chains gain the ability to customize the validator set to their needs:
* define allow/denylists
* set maximum number of validators
* set validator power cap

- define allow/denylists
- set maximum number of validators
- set validator power cap

## Notable consumer chains

Expand All @@ -40,3 +42,9 @@ Neutron was onboarded as a consumer chain in May 2023, see Hub [proposal 792](ht

[Stride](https://www.stride.zone/), is a liquid staking provider, which aims to unlock liquidity for Cosmos Hub token holders.
Stride was onboarded as a consumer chain in July 2023, see Hub [proposal 799](https://www.mintscan.io/cosmos/proposals/799) for more details.

## Resources

For more information visit:

- [Interchain Security docs](https://cosmos.github.io/interchain-security)
37 changes: 36 additions & 1 deletion docs/docs/modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,41 @@ order: 1
Here you can find an overview of the modules included on the Cosmos Hub (Gaia) blockchain with relevant info and
links for each one.

## Module List
# Module List

## cosmos-sdk

- [x/auth](https://docs.cosmos.network/v0.50/build/modules/auth)
- [x/authz](https://docs.cosmos.network/v0.50/build/modules/authz)
- [x/bank](https://docs.cosmos.network/v0.50/build/modules/bank)
- [x/capability](https://docs.cosmos.network/v0.50/build/modules/capability)
- [x/consensus](https://docs.cosmos.network/v0.50/build/modules/consensus)
- [x/crisis](https://docs.cosmos.network/v0.50/build/modules/crisis)
- [x/distribution](https://docs.cosmos.network/v0.50/build/modules/distribution)
- [x/evidence](https://docs.cosmos.network/v0.50/build/modules/evidence)
- [x/feegrant](https://docs.cosmos.network/v0.50/build/modules/feegrant)
- [x/gov](https://docs.cosmos.network/v0.50/build/modules/gov)
- [x/mint](https://docs.cosmos.network/v0.50/build/modules/mint)
- [x/params](https://docs.cosmos.network/v0.50/build/modules/params)
- [x/slashing](https://docs.cosmos.network/v0.50/build/modules/slashing)
- [x/staking (with LSM changes)](https://docs.cosmos.network/v0.50/build/modules/staking)
- [x/upgrade](https://docs.cosmos.network/v0.50/build/modules/upgrade)

## ibc-go

- [transfer](https://ibc.cosmos.network/main/apps/transfer/overview)
- [interchain accounts - host](https://ibc.cosmos.network/v8/apps/interchain-accounts/client#host)
- [interchain accounts - controller](https://ibc.cosmos.network/v8/apps/interchain-accounts/client#controller)
- [interchain-security/provider](https://github.com/cosmos/interchain-security/tree/main/x/ccv/provider)
- [packetforward](https://github.com/cosmos/ibc-apps/tree/main/middleware/packet-forward-middleware)
- [ibcfee](https://ibc.cosmos.network/v8/middleware/ics29-fee/overview)
- [ibc-rate-limiting](https://github.com/Stride-Labs/ibc-rate-limiting)

## gaia specific modules

- [Metaprotocols](./metaprotocols.md)
- [LSM staking](./lsm-staking.md)

## other modules

- [fee market](https://github.com/skip-mev/feemarket)
5 changes: 4 additions & 1 deletion docs/docs/modules/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{
"label": "Gaia Modules",
"position": 11,
"link": { "type": "doc", "id": "modules/README" }
"link": {
"type": "doc",
"id": "modules/README"
}
}
Loading

0 comments on commit c5e9b0a

Please sign in to comment.