-
Notifications
You must be signed in to change notification settings - Fork 738
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: add v15 specific docs, changelogs and instructions #3009
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
3aea9aa
docs: add changelogs section; add migration doc
MSalopek 901092a
docs: change homepage banner
MSalopek 5a90781
docs: add proposals and instructions
MSalopek 1aa9ba4
Update docs/docs/changelogs/v15.1.0.md
MSalopek bf43862
Update docs/docs/changelogs/v15.1.0.md
MSalopek 8a699a9
Update docs/docs/changelogs/v15.1.0.md
MSalopek 4cb9855
Update docs/docs/changelogs/v15.1.0.md
MSalopek 5fd5b03
Update docs/docs/governance/proposal-types/software-upgrade.md
MSalopek 43cf80d
Update docs/docs/changelogs/v15.1.0.md
MSalopek 8910c19
Update docs/docs/changelogs/v15.1.0.md
MSalopek bc6e62a
Update docs/docs/migration/cosmoshub-4-v15-upgrade.md
MSalopek 2dd4371
docs: add review comment changes
MSalopek 1d29dc8
docs: add review comment changes
MSalopek 324d526
Merge branch 'main' into masa/more-v47-docs
MSalopek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Changelogs | ||
order: 1 | ||
--- | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"label": "Changelogs", | ||
"position": 16, | ||
"link": { "type": "doc", "id": "changelogs/README" } | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
--- | ||
title: v15.1.0 | ||
order: 1 | ||
--- | ||
|
||
This document outlines API breaking changes that were introduced in `gaia v15.1.0`. | ||
|
||
This release is based on cosmos-sdk `v0.47.x` and ibc-go `v7.x`. | ||
|
||
You can find the comprehensive API docs at: | ||
* https://docs.cosmos.network/api | ||
|
||
Module reference manuals (with CLI instructions) can be found at: | ||
* https://docs.cosmos.network/v0.47/build/modules | ||
|
||
Comprehensive list of changes: | ||
* https://github.com/cosmos/gaia/blob/release/v15.1.x/CHANGELOG.md#api-breaking | ||
|
||
## Supported modules: | ||
cosmos-sdk `v0.47.10-ics-lsm` | ||
* x/auth | ||
* x/authz | ||
* x/bank | ||
* x/capability | ||
* x/consensus | ||
* x/crisis | ||
* x/distribution | ||
* x/evidence | ||
* x/feegrant | ||
* x/gov | ||
* x/mint | ||
* x/params | ||
* x/slashing | ||
* x/staking (with LSM changes) | ||
* x/upgrade | ||
|
||
ibc-go `v7.x` | ||
* transfer | ||
* ica (host) | ||
|
||
interchain-security/provider `v3.3.x` | ||
|
||
packetforward `v7.x` | ||
|
||
gaia | ||
* x/globalfee `v15.x` | ||
* x/metaprotocols `v15.x` | ||
|
||
|
||
# Important changes | ||
Changes are outlined compared to `gaiad <= v14.x` | ||
|
||
## Behaviour changes | ||
|
||
Starting `v15.1.0` all users must have at least `1 ATOM` staked in order to cast a vote on a governance proposal. | ||
|
||
Votes from accounts whose staked amounts are `< 1 ATOM` will be rejected. | ||
|
||
## REST/RPC Changes | ||
|
||
### DenomOwners | ||
|
||
The `DenomOwners` query is not supported on the Cosmos Hub chain. | ||
* querying `<RPC_ADDR>.cosmos/bank/v1beta1/denom_owners/{denom}` always returns an empty result. | ||
|
||
|
||
### Querying latest block | ||
|
||
`curl <RPC>/blocks/latest` no longer works and returns `{"code":12,"message":"Not Implemented","details":[]}` | ||
|
||
The endpoint was moved to: `<RPC>/cosmos/base/tendermint/v1beta1/blocks/latest` | ||
|
||
|
||
# CLI Changes | ||
|
||
## Genesis commands | ||
|
||
`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). | ||
|
||
These queries no longer work: | ||
```shell | ||
gaiad gentx | ||
gaiad collect-gentx | ||
gaiad validate-genesis | ||
gaiad add-genesis-account | ||
``` | ||
|
||
Use the `genesis` subcommands instead: | ||
```shell | ||
gaiad genesis gentx | ||
gaiad genesis collect-gentx | ||
gaiad genesis validate-genesis | ||
gaiad genesis add-genesis-account | ||
gaiad genesis migrate | ||
``` | ||
|
||
## Governance commands | ||
|
||
Governance commands are aligned with cosmos-sdk v0.47.x [x/gov module](https://docs.cosmos.network/v0.47/build/modules/gov). | ||
|
||
### submit-legacy-proposal | ||
|
||
Some proposal types can be submitted using the `gaiad tx gov submit-legacy-proposal` command: | ||
```sh | ||
gaiad tx gov submit-legacy-proposal | ||
|
||
Available Commands: | ||
cancel-software-upgrade Cancel the current software upgrade proposal | ||
change-reward-denoms Submit a change reward denoms proposal | ||
consumer-addition Submit a consumer addition proposal | ||
consumer-removal Submit a consumer chain removal proposal | ||
ibc-upgrade Submit an IBC upgrade proposal | ||
param-change Submit a parameter change proposal | ||
software-upgrade Submit a software upgrade proposal | ||
update-client Submit an update IBC client proposal | ||
``` | ||
|
||
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). | ||
|
||
List of proposals available for submission via `submit-legacy-proposal` will be further decreased in subsequent releases. | ||
|
||
More information is available in cosmos-sdk [x/gov docs](https://docs.cosmos.network/v0.47/build/modules/gov#submit-legacy-proposal). | ||
|
||
### draft-proposal | ||
|
||
`gaiad tx gov draft-proposal` command is available. You can use this command to create a draft proposal in JSON format. | ||
* more information is available in the cosmos-sdk [x/gov docs](https://docs.cosmos.network/v0.47/build/modules/gov#draft-proposal) | ||
|
||
### submit-proposal | ||
|
||
`gaiad tx gov submit-proposal` command is available. Use `draft-proposal` (listed above) to create a proposal JSON and submit it as a transaction. | ||
|
||
More information is available in cosmos-sdk [x/gov docs](https://docs.cosmos.network/v0.47/build/modules/gov#submit-proposal) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Parameter Changes", | ||
"label": "Common proposals", | ||
"position": 1, | ||
"link": { "type": "doc", "id": "governance/proposal-types/README" } | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
order: 2 | ||
parent: | ||
order: 2 | ||
--- | ||
|
||
# Software Upgrade | ||
|
||
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. | ||
|
||
Software upgrade proposals should be submitted by the development teams tasked with stewarding the Cosmos Hub development. | ||
|
||
## Procedure | ||
|
||
Use `draft-proposal` command to create a draft proposal and populate it with required information. | ||
|
||
```sh | ||
✗ gaiad tx gov draft-proposal | ||
Use the arrow keys to navigate: ↓ ↑ → ← | ||
? Select proposal type: | ||
text | ||
community-pool-spend | ||
▸ software-upgrade # choose this | ||
cancel-software-upgrade | ||
other | ||
|
||
# populate all steps (displaying all for demonstration purposes) | ||
Enter proposal title: Upgrade v15 | ||
Enter proposal authors: Stewards | ||
Enter proposal summary: Upgrade to v15 | ||
Enter proposal details: <v15 upgrade changelog details> | ||
Enter proposal proposal forum url: / | ||
Enter proposal vote option context: Vote YES to support running this binary on the Cosmos Hub mainnet. | ||
Enter proposal deposit: 100001uatom | ||
Enter msg authority: cosmos10d07y265gmmuvt4z0w9aw880jnsr700j6zn9kn | ||
``` | ||
|
||
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): | ||
```json | ||
{ | ||
"binaries": { | ||
"darwin/amd64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-darwin-amd64?checksum=sha256:7157f03fbad4f53a4c73cde4e75454f4a40a9b09619d3295232341fec99ad138", | ||
"darwin/arm64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-darwin-arm64?checksum=sha256:09e2420151dd22920304dafea47af4aa5ff4ab0ddbe056bb91797e33ff6df274", | ||
"linux/amd64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-linux-amd64?checksum=sha256:236b5b83a7674e0e63ba286739c4670d15d7d6b3dcd810031ff83bdec2c0c2af", | ||
"linux/arm64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-linux-arm64?checksum=sha256:b055fb7011e99d16a3ccae06443b0dcfd745b36480af6b3e569e88c94f3134d3", | ||
"windows/armd64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-windows-amd64.exe?checksum=sha256:f0224ba914cad46dc27d6a9facd8179aec8a70727f0b1e509f0c6171c97ccf76", | ||
"windows/arm64": "https://github.com/cosmos/gaia/releases/download/v15.0.0/gaiad-v15.0.0-windows-arm64.exe?checksum=sha256:cbbce5933d501b4d54dcced9b097c052bffdef3fa8e1dfd75f29b34c3ee7de86" | ||
} | ||
} | ||
``` | ||
|
||
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`. | ||
|
||
```sh | ||
gaiad tx gov submit-proposal <path_to_proposal.json> | ||
--from <submitter address> \ | ||
--chain-id cosmoshub-4 \ | ||
--gas <max gas allocated> \ | ||
--fees <fees allocated> \ | ||
--node <node address> \ | ||
``` | ||
|
||
## Using x/upgrading | ||
|
||
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. | ||
|
||
## Additional information | ||
|
||
Additional instructions with debugging information is available on the [submitting](../submitting.md) page. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Proposals", | ||
"position": 1 | ||
"position": 6 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link to https://github.com/cosmos/gaia/blob/v15.1.0/UPGRADING.md instead
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have to copy the file into the docs folder. The root dir of gaia repo is not available in the docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But this link is available, right? https://github.com/cosmos/gaia/blob/release/v15.1.x/UPGRADING.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's do that for future releases after the docs refactor