-
Notifications
You must be signed in to change notification settings - Fork 62
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
Governance: set overview page as index #545
Open
fadeev
wants to merge
3
commits into
main
Choose a base branch
from
governance-index
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 |
---|---|---|
@@ -1,10 +1,9 @@ | ||
{ | ||
"index": "Governance", | ||
"overview": "Governance", | ||
"text": "Text Proposal", | ||
"parameter": "Parameter Change Proposal", | ||
"upgrade": "Software Upgrade Proposal", | ||
"submit": "Submit a Proposal", | ||
"deposit": "Making a Deposit", | ||
"voting": "Voting on a 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,10 +1,62 @@ | ||
--- | ||
title: Governance | ||
pageType: sub-category | ||
--- | ||
|
||
import { CurrentPageNavigationSections } from "~/components/shared"; | ||
import { GovParams } from "~/components/Docs"; | ||
|
||
<div className="flex flex-col gap-20 sm:gap-[120px]"> | ||
<CurrentPageNavigationSections /> | ||
</div> | ||
import { Alert } from "~/components/shared"; | ||
|
||
## Overview | ||
|
||
ZetaChain uses the standard Cosmos SDK [`gov` governance | ||
module](https://docs.cosmos.network/v0.50/modules/gov/) to manage the network. | ||
This module allows for the creation of proposals, which can be voted on by | ||
stakers of the network. This guide will walk you through the process of creating | ||
proposals using the ZetaChain's `zetacored` CLI. | ||
|
||
## Governance Parameters | ||
|
||
<GovParams /> | ||
|
||
## Making a Proposal | ||
|
||
To make a proposal you will need to: | ||
|
||
- Create a `proposal.json` file. The contents of the proposal file depends on | ||
the type of a proposal: [text proposal](/users/cli/governance/text), | ||
[parameter change proposal](/users/cli/governance/parameter), [software | ||
upgrade proposal](/users/cli/governance/upgrade), etc. | ||
- Create and publish a `metadata.json` file to IPFS or the web and submit the | ||
proposal using `zetacored tx gov submit-proposal` command. Learn about this | ||
step on the [Submit a Proposal](/users/cli/governance/submit) page | ||
|
||
<Alert variant="tip"> | ||
{" "} | ||
Check out the [text proposal](/users/cli/governance/text) doc to learn more about the basics of how proposals are structured.{" "} | ||
</Alert> | ||
|
||
## Proposal Stages | ||
|
||
The lifecycle of a proposal consists of the following stages: | ||
|
||
1. **Deposit Period**: During this period, any user can deposit tokens to a | ||
proposal. If the proposal reaches the required deposit amount, it will move | ||
to the **voting period**. If the proposal does not reach the required deposit | ||
amount, it will be marked as "Rejected". As a creator of a proposal, you can | ||
supply your proposal with the deposit (equal or higher than the min deposit | ||
param) to immediately move to the voting period. | ||
2. **Voting Period**: During this period, stakers can vote on the proposal. If | ||
the proposal does not reach the required quorum or does not pass until the | ||
voting period ends, it will be marked as "Rejected". If the proposal reaches | ||
the required quorum and passes, it will be executed. If the proposal executed | ||
successfully, it will be marked as "Passed". If the proposal executed | ||
unsuccessfully, it will be marked as "Failed". | ||
|
||
The deposit amounts will be returned to the depositors, unless the proposal was | ||
vetoed, or never entered voting period (minimum deposit not reached within | ||
deposit period). | ||
|
||
## Governance Module Docs | ||
|
||
To learn more about the governance module, refer to the [`gov` module | ||
documentation](https://docs.cosmos.network/v0.50/modules/gov/). |
This file was deleted.
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.
🛠️ Refactor suggestion
Fix grammatical error in proposal file description.
The subject-verb agreement needs correction.
Apply this diff:
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[grammar] ~25-~25: Possible subject-verb agreement error.
Context: ...file. The contents of the proposal file depends on the type of a proposal: [text prop...
(NNS_OF_SINGULAR_AGREEMENT)
[grammar] ~26-~26: If ‘type’ is a classification term, ‘a’ is not necessary. Use “type of”. (The phrases ‘kind of’ and ‘sort of’ are informal if they mean ‘to some extent’.)
Context: ...s of the proposal file depends on the type of a proposal: [text proposal](/users/cli/go...
(KIND_OF_A)