Skip to content

Commit 0192205

Browse files
MSalopekmpokestana-miricdusan-maksimovic
authored
docs: add v15 specific docs, changelogs and instructions (#3009)
* docs: add changelogs section; add migration doc * docs: change homepage banner * docs: add proposals and instructions * Update docs/docs/changelogs/v15.1.0.md Co-authored-by: Marius Poke <[email protected]> * Update docs/docs/changelogs/v15.1.0.md Co-authored-by: Stana Miric <[email protected]> * Update docs/docs/changelogs/v15.1.0.md Co-authored-by: Stana Miric <[email protected]> * Update docs/docs/changelogs/v15.1.0.md Co-authored-by: Dusan Maksimovic <[email protected]> * Update docs/docs/governance/proposal-types/software-upgrade.md Co-authored-by: Dusan Maksimovic <[email protected]> * Update docs/docs/changelogs/v15.1.0.md Co-authored-by: Dusan Maksimovic <[email protected]> * Update docs/docs/changelogs/v15.1.0.md Co-authored-by: Dusan Maksimovic <[email protected]> * Update docs/docs/migration/cosmoshub-4-v15-upgrade.md Co-authored-by: Dusan Maksimovic <[email protected]> * docs: add review comment changes * docs: add review comment changes --------- Co-authored-by: Marius Poke <[email protected]> Co-authored-by: Stana Miric <[email protected]> Co-authored-by: Dusan Maksimovic <[email protected]>
1 parent 08acfa8 commit 0192205

File tree

11 files changed

+494
-15
lines changed

11 files changed

+494
-15
lines changed

‎docs/docs/changelogs/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Changelogs
3+
order: 1
4+
---
5+
6+
This folder documents and clarifies important API and other changes introduced to the Cosmos Hub blockchain as a result of a software upgrade. Most changes are a result of updating cosmos-sdk, ibc-go and cometbft versions.

‎docs/docs/changelogs/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Changelogs",
3+
"position": 16,
4+
"link": { "type": "doc", "id": "changelogs/README" }
5+
}

‎docs/docs/changelogs/v15.1.0.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
title: v15.1.0
3+
order: 1
4+
---
5+
6+
This document outlines API breaking changes that were introduced in `gaia v15.1.0`.
7+
8+
This release is based on cosmos-sdk `v0.47.x` and ibc-go `v7.x`.
9+
10+
You can find the comprehensive API docs at:
11+
* https://docs.cosmos.network/api
12+
13+
Module reference manuals (with CLI instructions) can be found at:
14+
* https://docs.cosmos.network/v0.47/build/modules
15+
16+
Comprehensive list of changes:
17+
* https://github.com/cosmos/gaia/blob/release/v15.1.x/CHANGELOG.md#api-breaking
18+
19+
## Supported modules:
20+
cosmos-sdk `v0.47.10-ics-lsm`
21+
* x/auth
22+
* x/authz
23+
* x/bank
24+
* x/capability
25+
* x/consensus
26+
* x/crisis
27+
* x/distribution
28+
* x/evidence
29+
* x/feegrant
30+
* x/gov
31+
* x/mint
32+
* x/params
33+
* x/slashing
34+
* x/staking (with LSM changes)
35+
* x/upgrade
36+
37+
ibc-go `v7.x`
38+
* transfer
39+
* ica (host)
40+
41+
interchain-security/provider `v3.3.x`
42+
43+
packetforward `v7.x`
44+
45+
gaia
46+
* x/globalfee `v15.x`
47+
* x/metaprotocols `v15.x`
48+
49+
50+
# Important changes
51+
Changes are outlined compared to `gaiad <= v14.x`
52+
53+
## Behaviour changes
54+
55+
Starting `v15.1.0` all users must have at least `1 ATOM` staked in order to cast a vote on a governance proposal.
56+
57+
Votes from accounts whose staked amounts are `< 1 ATOM` will be rejected.
58+
59+
## REST/RPC Changes
60+
61+
### DenomOwners
62+
63+
The `DenomOwners` query is not supported on the Cosmos Hub chain.
64+
* querying `<RPC_ADDR>.cosmos/bank/v1beta1/denom_owners/{denom}` always returns an empty result.
65+
66+
67+
### Querying latest block
68+
69+
`curl <RPC>/blocks/latest` no longer works and returns `{"code":12,"message":"Not Implemented","details":[]}`
70+
71+
The endpoint was moved to: `<RPC>/cosmos/base/tendermint/v1beta1/blocks/latest`
72+
73+
74+
# CLI Changes
75+
76+
## Genesis commands
77+
78+
`gaiad` no longer uses a custom genesis commands and instead relies on the commands defined in the [x/genutil module](https://docs.cosmos.network/v0.47/build/modules/genutil).
79+
80+
These queries no longer work:
81+
```shell
82+
gaiad gentx
83+
gaiad collect-gentx
84+
gaiad validate-genesis
85+
gaiad add-genesis-account
86+
```
87+
88+
Use the `genesis` subcommands instead:
89+
```shell
90+
gaiad genesis gentx
91+
gaiad genesis collect-gentx
92+
gaiad genesis validate-genesis
93+
gaiad genesis add-genesis-account
94+
gaiad genesis migrate
95+
```
96+
97+
## Governance commands
98+
99+
Governance commands are aligned with cosmos-sdk v0.47.x [x/gov module](https://docs.cosmos.network/v0.47/build/modules/gov).
100+
101+
### submit-legacy-proposal
102+
103+
Some proposal types can be submitted using the `gaiad tx gov submit-legacy-proposal` command:
104+
```sh
105+
gaiad tx gov submit-legacy-proposal
106+
107+
Available Commands:
108+
cancel-software-upgrade Cancel the current software upgrade proposal
109+
change-reward-denoms Submit a change reward denoms proposal
110+
consumer-addition Submit a consumer addition proposal
111+
consumer-removal Submit a consumer chain removal proposal
112+
ibc-upgrade Submit an IBC upgrade proposal
113+
param-change Submit a parameter change proposal
114+
software-upgrade Submit a software upgrade proposal
115+
update-client Submit an update IBC client proposal
116+
```
117+
118+
Most cosmos-sdk modules no longer allow their parameters to be upgraded using a `param-change` proposal. Use the corresponding `MsgUpgradeParams` message instead and create a JSON file proposal using `draft-proposal` (listed below).
119+
120+
List of proposals available for submission via `submit-legacy-proposal` will be further decreased in subsequent releases.
121+
122+
More information is available in cosmos-sdk [x/gov docs](https://docs.cosmos.network/v0.47/build/modules/gov#submit-legacy-proposal).
123+
124+
### draft-proposal
125+
126+
`gaiad tx gov draft-proposal` command is available. You can use this command to create a draft proposal in JSON format.
127+
* more information is available in the cosmos-sdk [x/gov docs](https://docs.cosmos.network/v0.47/build/modules/gov#draft-proposal)
128+
129+
### submit-proposal
130+
131+
`gaiad tx gov submit-proposal` command is available. Use `draft-proposal` (listed above) to create a proposal JSON and submit it as a transaction.
132+
133+
More information is available in cosmos-sdk [x/gov docs](https://docs.cosmos.network/v0.47/build/modules/gov#submit-proposal)

‎docs/docs/governance/proposal-types/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ parent:
99
- [**Text**](../proposal-types/text-prop.md)
1010
- [**Community Pool Spend**](../proposal-types/community-pool-spend.md)
1111
- [**Parameter Change**](../proposal-types/param-change.md)
12-
- **Software Upgrade**
12+
- [**Software Upgrade**](../proposal-types/software-upgrade.md)
1313
- **IBC Client Update**
1414

1515
## Drafting a Proposal

‎docs/docs/governance/proposal-types/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Parameter Changes",
2+
"label": "Common proposals",
33
"position": 1,
44
"link": { "type": "doc", "id": "governance/proposal-types/README" }
55
}

‎docs/docs/governance/proposal-types/software-upgrade.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
order: 2
3+
parent:
4+
order: 2
5+
---
6+
7+
# Software Upgrade
8+
9+
Software upgrade proposals are submitted to signal that a Cosmos Hub release with new features, bugfixes and various other improvements is available and ready for production deployment.
10+
11+
Software upgrade proposals should be submitted by the development teams tasked with stewarding the Cosmos Hub development.
12+
13+
## Procedure
14+
15+
Use `draft-proposal` command to create a draft proposal and populate it with required information.
16+
17+
```sh
18+
✗ gaiad tx gov draft-proposal
19+
Use the arrow keys to navigate: ↓ ↑ → ←
20+
? Select proposal type:
21+
text
22+
community-pool-spend
23+
▸ software-upgrade # choose this
24+
cancel-software-upgrade
25+
other
26+
27+
# populate all steps (displaying all for demonstration purposes)
28+
Enter proposal title: Upgrade v15
29+
Enter proposal authors: Stewards
30+
Enter proposal summary: Upgrade to v15
31+
Enter proposal details: <v15 upgrade changelog details>
32+
Enter proposal proposal forum url: /
33+
Enter proposal vote option context: Vote YES to support running this binary on the Cosmos Hub mainnet.
34+
Enter proposal deposit: 100001uatom
35+
Enter msg authority: cosmos10d07y265gmmuvt4z0w9aw880jnsr700j6zn9kn
36+
```
37+
38+
In your `draft_proposal.json` populate the `height` with your desired upgrade height and populate the `info` field with additional information (must be a valid JSON string):
39+
```json
40+
{
41+
"binaries": {
42+
"darwin/amd64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-darwin-amd64?checksum=sha256:7157f03fbad4f53a4c73cde4e75454f4a40a9b09619d3295232341fec99ad138",
43+
"darwin/arm64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-darwin-arm64?checksum=sha256:09e2420151dd22920304dafea47af4aa5ff4ab0ddbe056bb91797e33ff6df274",
44+
"linux/amd64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-linux-amd64?checksum=sha256:236b5b83a7674e0e63ba286739c4670d15d7d6b3dcd810031ff83bdec2c0c2af",
45+
"linux/arm64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-linux-arm64?checksum=sha256:b055fb7011e99d16a3ccae06443b0dcfd745b36480af6b3e569e88c94f3134d3",
46+
"windows/armd64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-windows-amd64.exe?checksum=sha256:f0224ba914cad46dc27d6a9facd8179aec8a70727f0b1e509f0c6171c97ccf76",
47+
"windows/arm64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-windows-arm64.exe?checksum=sha256:cbbce5933d501b4d54dcced9b097c052bffdef3fa8e1dfd75f29b34c3ee7de86"
48+
}
49+
}
50+
```
51+
52+
Upload your `draft_metadata.json` to a distribution platform of your choice. `draft_proposal.json` is used to submit a governance proposal using `submit-proposal`.
53+
54+
```sh
55+
gaiad tx gov submit-proposal <path_to_proposal.json>
56+
--from <submitter address> \
57+
--chain-id cosmoshub-4 \
58+
--gas <max gas allocated> \
59+
--fees <fees allocated> \
60+
--node <node address> \
61+
```
62+
63+
## Using x/upgrading
64+
65+
Software upgrade proposals can be submitted using the [x/upgrade module](https://docs.cosmos.network/v0.47/build/modules/upgrade#transactions). The end effect will be the same since the `x/gov` module routes the message to `x/upgrade` module.
66+
67+
## Additional information
68+
69+
Additional instructions with debugging information is available on the [submitting](../submitting.md) page.
70+

‎docs/docs/governance/proposal-types/text-prop.md

+50-8
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,53 @@ Technically, nothing happens on-chain. No code executes, and this 'unenforceable
3535
* The community might be more informed about a topic than they previously were.
3636
* The community might feel confident that we are aligned on a particular definition or social norm.
3737

38-
39-
40-
41-
42-
43-
44-
45-
38+
## Submitting a text proposal
39+
40+
Follow the instructions below to create a text proposal and submit it to the blockchain.
41+
42+
```sh
43+
➜ gaiad tx gov draft-proposal
44+
45+
Use the arrow keys to navigate: ↓ ↑ → ←
46+
? Select proposal type:
47+
▸ text # choose this
48+
community-pool-spend
49+
software-upgrade
50+
cancel-software-upgrade
51+
other
52+
```
53+
54+
Choose `text` from the `draft-proposal` menu and populate all the available fields.
55+
```sh
56+
✔ text
57+
Enter proposal title: Title
58+
Enter proposal authors: Author
59+
Enter proposal summary: Proposal summary
60+
Enter proposal details: Details, all the details
61+
Enter proposal proposal forum url: /
62+
Enter proposal vote option context: Vote yes if <...>
63+
Enter proposal deposit: 100001uatom
64+
```
65+
66+
Check `draft_proposal.json`, your result should be similar to this:
67+
```json
68+
{
69+
"metadata": "ipfs://CID",
70+
"deposit": "100001uatom",
71+
"title": "Title",
72+
"summary": "Proposal summary"
73+
}
74+
```
75+
76+
Upload your `draft_metadata.json` to a distribution platform of your choice. `draft_proposal.json` is used to submit a governance proposal using `submit-proposal`.
77+
78+
```sh
79+
gaiad tx gov submit-proposal <path_to_proposal.json>
80+
--from <submitter address> \
81+
--chain-id cosmoshub-4 \
82+
--gas <max gas allocated> \
83+
--fees <fees allocated> \
84+
--node <node address> \
85+
```
86+
87+
Additional instructions with debugging information is available on the [submitting](../submitting.md) page.

‎docs/docs/governance/proposals/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Proposals",
3-
"position": 1
3+
"position": 6
44
}

‎docs/docs/governance/submitting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -256,4 +256,4 @@ You may want to submit your proposal to the testnet chain before the mainnet for
256256
1. To see what the proposal description will look like.
257257
2. To signal that your proposal is about to go live on the mainnet.
258258
3. To share what the proposal will look like in advance with stakeholders.
259-
4. To test the functionality of the governance features.
259+
4. To test the functionality of the governance features.

‎docs/docs/index.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ import { currentParams } from '@site/docs/governance/current-parameters.js';
77
import { PlainVar } from '@site/src/js/Var';
88

99
:::tip
10-
### **v14 Upgrade**
11-
Cosmos Hub will be upgraded to [v14.1](https://github.com/cosmos/gaia/releases/tag/v14.1.0) at block height: **[18,262,000](https://www.mintscan.io/cosmos/blocks/18262000)**
10+
### **v15.1 Upgrade**
11+
Cosmos Hub will be upgraded to [v15.1](https://github.com/cosmos/gaia/releases/tag/v15.1.0) at block height: **[19,639,600](https://www.mintscan.io/cosmos/blocks/19639600)**
1212

13-
To upgrade from v13 check the [**upgrade guide**](/migration/cosmoshub-4-v14-upgrade.md)
13+
To upgrade from v14 check the [**upgrade guide**](/migration/cosmoshub-4-v15-upgrade.md)
1414
:::
1515

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

0 commit comments

Comments
 (0)