diff --git a/docs/governance/README.md b/docs/governance/README.md index ffe4bae763d..9cb29e78287 100644 --- a/docs/governance/README.md +++ b/docs/governance/README.md @@ -33,7 +33,6 @@ Governance discussions happens in a number of places moderated by diverse community members, including: - [Forum](http://forum.cosmos.network/) -- [Discord](https://discord.gg/W8trcGV) - [Reddit](http://reddit.com/r/cosmosnetwork) - [Telegram (Governance Working Group)](https://t.me/hubgov) - anywhere else you might interact with members of the Cosmos community! diff --git a/docs/governance/best_practices.md b/docs/governance/best_practices.md index b5f21c65b26..9ef03b93a4d 100644 --- a/docs/governance/best_practices.md +++ b/docs/governance/best_practices.md @@ -1,10 +1,10 @@ # Best Practices for Drafting a Proposal There are currently three types of proposals supported by the Cosmos Hub: -- [Community Pool Spend](/community-pool-spend) - Proposal to spend funds from the community pool on +- [Community Pool Spend](./community-pool-spend) - Proposal to spend funds from the community pool on an important project. -- [Parameter Change](/params-change) - Proposal to change a core on-chain parameter. -- [Text](/text) - Proposal to agree to a certain strategy, plan, commitment, future +- [Parameter Change](./params-change) - Proposal to change a core on-chain parameter. +- [Text](./text) - Proposal to agree to a certain strategy, plan, commitment, future upgrade or other statement. Text proposals are exclusively a signalling mechanism and focal point for future coordination - they do not directly cause any changes. @@ -34,7 +34,7 @@ If you're already confident about your idea, [skip to Stage 2](#stage-2-your-dra ### Not yet confident about your idea? Great! Governance proposals potentially impact many stakeholders. Introduce your idea with known members of the community before investing resources into drafting a proposal. Don't let negative feedback dissuade you from exploring your idea if you think that it's still important. -If you know people who are very involved with the Cosmos Hub, send them a private message with a concise overview of what you think will result from your idea or proposed changes. Wait for them to ask questions before providing details. Do the same in semi-private channels where people tend to be respectful (and hopefully supportive). I recommend [this Cosmos Discord community][discord] and the private Cosmos Network VIP Telegram channel (ask for an invite [on the forum][forum] if you are or would like to be a Cosmos contributor). +If you know people who are very involved with the Cosmos Hub, send them a private message with a concise overview of what you think will result from your idea or proposed changes. Wait for them to ask questions before providing details. Do the same in semi-private channels where people tend to be respectful (and hopefully supportive). I recommend the private Cosmos Network VIP Telegram channel (ask for an invite [on the forum][forum] if you are or would like to be a Cosmos contributor). ### Confident with your idea? Great! However, remember that governance proposals potentially impact many stakeholders, which can happen in unexpected ways. Introduce your idea with members of the community before investing resources into drafting a proposal. At this point you should seek out and carefully consider critical feedback in order to protect yourself from [confirmation bias](https://en.wikipedia.org/wiki/Confirmation_bias). This is the ideal time to see a critical flaw, because submitting a flawed proposal will waste resources. @@ -68,16 +68,15 @@ on Github is the ultimate standard for distributed collaboration on text files. ### Engage the community with your draft proposal 1. Post a draft of your proposal as a topic in the 'governance' category of the [Cosmos forum][forum]. Ideally this should contain a link to this repository, either directly to your proposal if it has been merged, or else to a pull-request containing your proposal if it has not been merged yet. 2. Directly engage key members of the community for feedback. These could be large contributors, those likely to be most impacted by the proposal, and entities with high stake-backing (eg. high-ranked validators; large stakers). -3. Engage with the Cosmos Governance Working Group (GWG). These are people focused on Cosmos governance--they won't write your proposal, but will provide feedback and recommend resources to support your work. Members can be contacted on the [forum][forum] (they use the tag 'GWG' in posts), in [Telegram](https://t.me/hubgov), and on [Discord][discord]. -4. Target members of the community in a semi-public way before bringing the draft to a full public audience. The burden of public scrutiny in a semi-anonymized environment (eg. Twitter) can be stressful and overwhelming without establishing support. Solicit opinions in places with people who have established reputations first. For example, there is a private Telegram group called Cosmos Network VIP (ask for an invite [on the forum][forum] if you are or would like to be a Cosmos contributor). Let people in the [Discord community][discord] know about your draft proposal. +3. Engage with the Cosmos Governance Working Group (GWG). These are people focused on Cosmos governance--they won't write your proposal, but will provide feedback and recommend resources to support your work. Members can be contacted on the [forum][forum] (they use the tag 'GWG' in posts) and in [Telegram](https://t.me/hubgov). +4. Target members of the community in a semi-public way before bringing the draft to a full public audience. The burden of public scrutiny in a semi-anonymized environment (eg. Twitter) can be stressful and overwhelming without establishing support. Solicit opinions in places with people who have established reputations first. For example, there is a private Telegram group called Cosmos Network VIP (ask for an invite [on the forum][forum] if you are or would like to be a Cosmos contributor). 5. Alert the entire community to the draft proposal via - Twitter, tagging accounts such as the All in Bits [Cosmos account](https://twitter.com/cosmos), the [Cosmos GWG](https://twitter.com/CosmosGov), and Today in Cosmos [@adriana_kalpa](https://twitter.com/adriana_kalpa) - [Telegram](https://t.me/cosmosproject), [Adriana](https://t.me/adriana_KalpaTech) (All in Bits) - - [Discord][discord] ### Submit your proposal to the testnet -I intend to expand this [guide to include testnet instructions](/submitting.md#submitting-your-proposal-to-the-testnet). +I intend to expand this [guide to include testnet instructions](submitting.md#submitting-your-proposal-to-the-testnet). You may want to submit your proposal to the testnet chain before the mainnet for a number of reasons, such as wanting to see what the proposal description will look like, to share what the proposal will look like in advance with stakeholders, and to signal that your proposal is about to go live on the mainnet. @@ -89,10 +88,10 @@ Submitting your proposal to the testnet increases the likelihood of engagement a A majority of the voting community should probably be aware of the proposal and have considered it before the proposal goes live on-chain. If you're taking a conservative approach, you should have reasonable confidence that your proposal will pass before risking deposit contributions. Make revisions to your draft proposal after each stage of engagement. -See the [submitting guide](/submitting.md) for more on submitting proposals. +See the [submitting guide](./submitting.md) for more on submitting proposals. ### The Deposit Period -The deposit period currently lasts 14 days. If you submitted your transaction with the minimum deposit (512 ATOM), your proposal will immediately enter the voting period. If you didn't submit the minimum deposit amount (currently 512 ATOM), then this may be an opportunity for others to show their support by contributing (and risking) their ATOMs as a bond for your proposal. You can request contributions openly and also contact stakeholders directly (particularly stakeholders who are enthusiastic about your proposal). Remember that each contributor is risking their funds, and you can [read more about the conditions for burning deposits here](/overview.md#burned-deposits). +The deposit period currently lasts 14 days. If you submitted your transaction with the minimum deposit (512 ATOM), your proposal will immediately enter the voting period. If you didn't submit the minimum deposit amount (currently 512 ATOM), then this may be an opportunity for others to show their support by contributing (and risking) their ATOMs as a bond for your proposal. You can request contributions openly and also contact stakeholders directly (particularly stakeholders who are enthusiastic about your proposal). Remember that each contributor is risking their funds, and you can [read more about the conditions for burning deposits here](./overview.md#burned-deposits). This is a stage where proposals may begin to get broader attention. Most popular explorers currently display proposals that are in the deposit period, but due to proposal spamming, this may change. [Hubble](https://hubble.figment.network/cosmos/chains/cosmoshub-3/governance), for example, only displays proposals that have 10% or more of the minimum deposit, so 51.2 ATOM or more. @@ -106,5 +105,4 @@ At this point you'll want to track which validator has voted and which has not. Remember that any voter may change their vote at any time before the voting period ends. That historically doesn't happen often, but there may be an opportunity to convince a voter to change their vote. The biggest risk is that stakeholders won't vote at all (for a number of reasons). Validator operators tend to need multiple reminders to vote. How you choose to contact validator operators, how often, and what you say is up to you--remember that no validator is obligated to vote, and that operators are likely occupied by competing demands for their attention. Take care not to stress any potential relationship with validator operators. - [discord]: https://discord.gg/W8trcGV [forum]: https://forum.cosmos.network/c/governance diff --git a/docs/governance/community-pool-spend/README.md b/docs/governance/community-pool-spend/README.md index 335f38796d2..fdd900304cc 100644 --- a/docs/governance/community-pool-spend/README.md +++ b/docs/governance/community-pool-spend/README.md @@ -1,6 +1,6 @@ # Cosmos Hub 3 and the Community Pool -The Cosmos Hub 3 launched with community-spend capabilities on December 11, 2019, effectively unlocking the potential for token-holders to vote to approve spending from the Community Pool. **This documentation is in active development, so please seek feedback and take care when using this information.** [Discuss its development here](https://forum.cosmos.network/t/gwg-community-spend-best-practices/3240). +The Cosmos Hub 3 launched with community-spend capabilities on December 11, 2019, effectively unlocking the potential for token-holders to vote to approve spending from the Community Pool. 馃嚜馃嚫 Esta p谩gina tambi茅n est谩 [disponible en espa帽ol](https://github.com/raquetelio/CosmosCommunitySpend/blob/master/README%5BES_es%5D.md). @@ -22,9 +22,9 @@ Drafting and submitting a proposal is a process that takes time, attention, and If you are considering drafting a proposal, you should review the general background on drafting and submitting a proposal: -1. [How the voting process and governance mechanism works](/overview.md) -1. [How to draft your proposal and engage with the Cosmos community about it](/best_practices.md) -1. [How to submit your proposal](/submitting.md) +1. [How the voting process and governance mechanism works](../overview.md) +1. [How to draft your proposal and engage with the Cosmos community about it](../best_practices.md) +1. [How to submit your proposal](../submitting.md) You should also review details specific to Community Pool Spend proposals: diff --git a/docs/governance/community-pool-spend/README[ES_es].md b/docs/governance/community-pool-spend/README[ES_es].md index 7d92eebe0d3..6a3f0419e41 100644 --- a/docs/governance/community-pool-spend/README[ES_es].md +++ b/docs/governance/community-pool-spend/README[ES_es].md @@ -18,11 +18,12 @@ Crear y enviar una propuesta es un proceso que lleva tiempo, atenci贸n y conllev Si est谩s considerando realizar una propuesta, deber铆as conocer: 1. [Sobre la Community Pool](#sobre-la-community-pool) -2. [C贸mo funciona el mecanismo de voto y gobernanza](voting.md) -3. [D贸nde y c贸mo involucrar a la comunidad de Cosmos acerca de tu idea](bestpractices.md) -4. [Lo que la comunidad querr谩 saber sobre tu propuesta](bestpractices.md#elements-of-a-community-spend-proposal) -5. [C贸mo preparar tu borrador de propuesta final para ser enviada](submitting.md) -6. [C贸mo enviar tu propuesta al Cosmos Hub testnet & mainnet](submitting.md) +2. [C贸mo funciona el mecanismo de voto y gobernanza](../overview.md#_2-voting-period) +3. [D贸nde y c贸mo involucrar a la comunidad de Cosmos acerca de tu idea](../best_practices.md) +4. [Lo que la comunidad querr谩 saber sobre tu propuesta](./best_practices.md#elements-of-a-community-spend-proposal) +5. [C贸mo preparar tu borrador de propuesta final para ser enviada](../submitting.md) +6. [C贸mo enviar tu propuesta al Cosmos Hub testnet & mainnet](../submitting.md) + ## Sobre la Community Pool @@ -60,4 +61,4 @@ La suposici贸n principal es que los fondos deber铆an ser gastados de forma que a Esperamos que todo esto tome forma a medida que las propuestas sean debatidas, aceptadas, y rechazadas por parte de la comunidad Cosmos Hub. ### 驴C贸mo se desembolsan los fondos una vez que una prouesta de gastos de comunidad es aprobada? -Si una propuesta de gastos de comunidad es aprobada, el n煤mero de ATOM inluidos en la propuesta ser谩n transferidos desde la community pool a la direcci贸n especificada en la propuesta, y esto ocurrir谩 justo inmediatamente despu茅s de que el periodo de votaci贸n termine. \ No newline at end of file +Si una propuesta de gastos de comunidad es aprobada, el n煤mero de ATOM inluidos en la propuesta ser谩n transferidos desde la community pool a la direcci贸n especificada en la propuesta, y esto ocurrir谩 justo inmediatamente despu茅s de que el periodo de votaci贸n termine. diff --git a/docs/governance/params-change/Bank.md b/docs/governance/params-change/Bank.md index 8964809a831..a95149da112 100644 --- a/docs/governance/params-change/Bank.md +++ b/docs/governance/params-change/Bank.md @@ -32,4 +32,4 @@ Setting the `sendenabled` parameter to `false` will prevent ATOMs from being tra #### Notes -The cosmoshub-1 chain launched with `sendenabled` set to `false` and with [`withdrawaddrenabled`](params-change/Distribution.md#4-withdrawaddrenabled) set to `false`. Staking was enabled on cosmoshub-1, so setting `withdrawaddrenabled` to false was necessary to prevent a loophole that would enable ATOM transfer via diverting staking rewards to a designated address. \ No newline at end of file +The cosmoshub-1 chain launched with `sendenabled` set to `false` and with [`withdrawaddrenabled`](./Distribution.md#4-withdrawaddrenabled) set to `false`. Staking was enabled on cosmoshub-1, so setting `withdrawaddrenabled` to false was necessary to prevent a loophole that would enable ATOM transfer via diverting staking rewards to a designated address. diff --git a/docs/governance/params-change/Distribution.md b/docs/governance/params-change/Distribution.md index 4185569d2f9..d5c6c70a52a 100644 --- a/docs/governance/params-change/Distribution.md +++ b/docs/governance/params-change/Distribution.md @@ -37,7 +37,7 @@ Increasing the value of the `communitytax` parameter will increase the rate that ### `baseproposerreward` **The fixed base reward bonus for the validator proposing a block, as a proportion of transaction fees.** -All validators in the active set share the rewards for producing a block equally, except for the proposer of a valid block: that validator receives a bonus of `0.010000000000000000` (1%) more in transaction fees. The proposer must include a minimum of 2/3 of precommit signatures from the other validators in the active set in order for the block to be valid and to receive the `baseproposerreward` bonus. All in Bits has published more in-depth information [here](https://hub.cosmos.network/master/validators/validator-faq.html#how-are-fees-distributed). +All validators in the active set share the rewards for producing a block equally, except for the proposer of a valid block: that validator receives a bonus of `0.010000000000000000` (1%) more in transaction fees. The proposer must include a minimum of 2/3 of precommit signatures from the other validators in the active set in order for the block to be valid and to receive the `baseproposerreward` bonus. All in Bits has published more in-depth information [here](../../validators/validator-faq.html#how-are-fees-distributed). * on-chain value: `{{ $themeConfig.currentParameters.distribution.baseproposerreward }}` * `cosmoshub-4` default: `0.010000000000000000` @@ -55,7 +55,7 @@ The Cosmos Hub transaction fee volume is proportionally very low in value compar ### `bonusproposerreward` **The maximum additional reward bonus for the validator proposing a block, as a proportion of transaction fees.** -All validators in the active set share the rewards for producing a block equally, except for the proposer of a valid block. If that validator includes more than a minimum of 2/3 of precommit signatures from the other validators in the active set, they are eligible to receive the `bonusproposerreward` of up to 4% (`0.040000000000000000`), beyond the 1% `baseproposerreward`. The bonus proposer reward amount that a validator receives depends upon how many precommit signatures are included in the proposed block (additional to the requisite 2/3). All in Bits has published more in-depth information [here](https://hub.cosmos.network/master/validators/validator-faq.html#how-are-fees-distributed). +All validators in the active set share the rewards for producing a block equally, except for the proposer of a valid block. If that validator includes more than a minimum of 2/3 of precommit signatures from the other validators in the active set, they are eligible to receive the `bonusproposerreward` of up to 4% (`0.040000000000000000`), beyond the 1% `baseproposerreward`. The bonus proposer reward amount that a validator receives depends upon how many precommit signatures are included in the proposed block (additional to the requisite 2/3). All in Bits has published more in-depth information [here](../../validators/validator-faq.html#how-are-fees-distributed). * on-chain value: `{{ $themeConfig.currentParameters.distribution.bonusproposerreward }}` * `cosmoshub-4` default: `0.040000000000000000` @@ -71,7 +71,7 @@ Increasing the value of the `bonusproposerreward` parameter will increase the ad The Cosmos Hub transaction fee volume is proportionally very low in value compared to the inflationary block rewards, and until that changes, this parameter will likely have very little impact on validator behaviours. As fee volumes increase, the `bonusproposerreward` bonus may incentivize delegations to the validator(s) with the greatest stake-backing. There are some detailed discussions about the proposer bonus [here](https://github.com/cosmos/cosmos-sdk/issues/3529). #### Example -**Note** that "reserve pool" refers to the community pool. In this example from the [All in Bits website](https://hub.cosmos.network/master/validators/validator-faq.html#how-are-fees-distributed), there are 10 validators with equal stake. Each of them applies a 1% commission rate and has 20% of self-delegated Atoms. Now comes a successful block that collects a total of 1025.51020408 Atoms in fees. +**Note** that "reserve pool" refers to the community pool. In this example from the [All in Bits website](../../validators/validator-faq.html#how-are-fees-distributed), there are 10 validators with equal stake. Each of them applies a 1% commission rate and has 20% of self-delegated Atoms. Now comes a successful block that collects a total of 1025.51020408 Atoms in fees. First, a 2% tax is applied. The corresponding Atoms go to the reserve pool (aka community pool). Reserve pool's funds can be allocated through governance to fund bounties and upgrades. @@ -115,7 +115,7 @@ Delegators can designate a separate withdrawal address (account) that receives s Changing the `withdrawaddrenabled` to false will prevent delegators from changing or setting a separate withdrawal address (account) that receives the staking rewards. This may disrupt the functionality of applications and the expectations of staking participants. #### Notes -This parameter was set to `false` before transfers were enabled in order to prevent stakers from diverting their rewards to other addresses ie. to avoid a loophole that would enable ATOM transfer via diverting staking rewards to a designated address. This parameter likely is only useful if [`sendenabled`](params-change/Bank.md#1-sendenabled) is set to `false`. +This parameter was set to `false` before transfers were enabled in order to prevent stakers from diverting their rewards to other addresses ie. to avoid a loophole that would enable ATOM transfer via diverting staking rewards to a designated address. This parameter likely is only useful if [`sendenabled`](./Bank.md#1-sendenabled) is set to `false`. ## Known Bug There is a known bug associated with this module that has reportedly caused a chain to halt. In [this reported case](https://github.com/cosmos/cosmos-sdk/issues/5808), the chain's parameter values were changed to be: @@ -125,4 +125,4 @@ base_proposer_reward: "0.999000000000000000" bonus_proposer_reward: "0.040000000000000000" ``` -Though the system will not allow eg. `baseproposerreward` to be a value greater than 1.0, it will allow the [`communitytax`](#1-communitytax), [`baseproposerreward`](#2-baseproposerreward), and [`bonusproposerreward`](#3-bonusproposerreward) parameters values to total an amount greater than 1.00, which will apparently cause the chain to panic and halt. You can [read more about the reported issue here](https://github.com/cosmos/cosmos-sdk/issues/5808). \ No newline at end of file +Though the system will not allow eg. `baseproposerreward` to be a value greater than 1.0, it will allow the [`communitytax`](#1-communitytax), [`baseproposerreward`](#2-baseproposerreward), and [`bonusproposerreward`](#3-bonusproposerreward) parameters values to total an amount greater than 1.00, which will apparently cause the chain to panic and halt. You can [read more about the reported issue here](https://github.com/cosmos/cosmos-sdk/issues/5808). diff --git a/docs/governance/params-change/Governance[ES_es].md b/docs/governance/params-change/Governance[ES_es].md index f96b41b032a..240d0d4ce52 100644 --- a/docs/governance/params-change/Governance[ES_es].md +++ b/docs/governance/params-change/Governance[ES_es].md @@ -12,41 +12,41 @@ El m贸dulo `gov` es responsable de las propuestas de gobierno en cadena y la fun - [`threshold`](#threshold) - `0.500000000000000000` (proporci贸n del poder de voto) - [`veto`](#veto) - `0.334000000000000000` (proporci贸n del poder de voto) -Los valores de lanzamiento de cada subkey de los par谩metros est谩n indicados arriba, pero puede [verificarlos usted mismo](params-change/Governance.md#verify-parameter-values). +Los valores de lanzamiento de cada subkey de los par谩metros est谩n indicados arriba, pero puede [verificarlos usted mismo](./Governance.md#verify-parameter-values). -Se est谩n considerando [algunas funciones adicionales](params-change/Governance.md#future) para el desarrollo del m贸dulo de gobernanza. +Se est谩n considerando [algunas funciones adicionales](./Governance.md#future) para el desarrollo del m贸dulo de gobernanza. -Si est谩s t茅cnicamente preparado, [estas son las especificaciones t茅cnicas](params-change/Governance.md#technical-specifications). Si quieres crear una propuesta para cambiar uno o m谩s de estos par谩metros, [mira esta secci贸n para el formato](params-change/submitting.md#formatting-the-json-file-for-the-governance-proposal). +Si est谩s t茅cnicamente preparado, [estas son las especificaciones t茅cnicas](./Governance.md#technical-specifications). Si quieres crear una propuesta para cambiar uno o m谩s de estos par谩metros, [mira esta secci贸n para el formato](../submitting.md#formatting-the-json-file-for-the-governance-proposal). ## 1. `depositparams` ## `mindeposit` ### El dep贸sito m铆nimo requerido para que una propuesta entre en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod), en micro-ATOMs #### `cosmoshub-3` por defecto: `512000000` `uatom` -Antes de que una propuesta de gobierno entre en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod) (es decir, para que la propuesta sea votada), debe haber al menos un n煤mero m铆nimo de ATOMs depositados. Cualquiera puede contribuir a este dep贸sito. Los dep贸sitos de las propuestas aprobadas y fallidas se devuelven a los contribuyentes. Los dep贸sitos se queman cuando las propuestas 1) [expiran](params-change/Governance.md#maxdepositperiod), 2) no alcanzan el [qu贸rum](params-change/Governance.md#quorum), o 3) son [vetadas](params-change/Governance.md#veto). El valor de subkey de este par谩metro representa el dep贸sito m铆nimo requerido para que una propuesta entre en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod) en micro-ATOMs, donde `512000000uatom` equivalen a 512 ATOM. +Antes de que una propuesta de gobierno entre en el [per铆odo de votaci贸n](./Governance.md#votingperiod) (es decir, para que la propuesta sea votada), debe haber al menos un n煤mero m铆nimo de ATOMs depositados. Cualquiera puede contribuir a este dep贸sito. Los dep贸sitos de las propuestas aprobadas y fallidas se devuelven a los contribuyentes. Los dep贸sitos se queman cuando las propuestas 1) [expiran](./Governance.md#maxdepositperiod), 2) no alcanzan el [qu贸rum](./Governance.md#quorum), o 3) son [vetadas](./Governance.md#veto). El valor de subkey de este par谩metro representa el dep贸sito m铆nimo requerido para que una propuesta entre en el [per铆odo de votaci贸n](./Governance.md#votingperiod) en micro-ATOMs, donde `512000000uatom` equivalen a 512 ATOM. ### Posibles consecuencias #### Disminuci贸n del valor `mindeposit` -La disminuci贸n del valor de subkey `mindeposit` permitir谩 que las propuestas de gobernanza entren en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod) con menos ATOMs en juego. Es probable que esto aumente el volumen de nuevas propuestas de gobernanza. +La disminuci贸n del valor de subkey `mindeposit` permitir谩 que las propuestas de gobernanza entren en el [per铆odo de votaci贸n](./Governance.md#votingperiod) con menos ATOMs en juego. Es probable que esto aumente el volumen de nuevas propuestas de gobernanza. #### Aumentar el valor `mindeposit` -Para aumentar el valor de subkey `mindeposit` ser谩 necesario arriesgar un mayor n煤mero de ATOMs antes de que las propuestas de gobierno puedan entrar en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod). Es probable que esto disminuya el volumen de nuevas propuestas de gobierno. +Para aumentar el valor de subkey `mindeposit` ser谩 necesario arriesgar un mayor n煤mero de ATOMs antes de que las propuestas de gobierno puedan entrar en el [per铆odo de votaci贸n](./Governance.md#votingperiod). Es probable que esto disminuya el volumen de nuevas propuestas de gobierno. ## `maxdepositperiod` ### La cantidad m谩xima de tiempo que una propuesta puede aceptar contribuciones de dep贸sito antes de expirar, en nanosegundos. #### `cosmoshub-3` por defecto: `1209600000000000` -Antes de que una propuesta de gobierno entre en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod), debe haber al menos un n煤mero m铆nimo de ATOMs depositados. El valor de subkey de este par谩metro representa la cantidad m谩xima de tiempo que la propuesta tiene para alcanzar la cantidad m铆nima de dep贸sito antes de expirar. La cantidad m谩xima de tiempo que una propuesta puede aceptar contribuciones de dep贸sito antes de expirar es actualmente de 1209600000000000 nanosegundos o 14 d铆as. Si la propuesta expira, cualquier cantidad de dep贸sito ser谩 quemada. +Antes de que una propuesta de gobierno entre en el [per铆odo de votaci贸n](./Governance.md#votingperiod), debe haber al menos un n煤mero m铆nimo de ATOMs depositados. El valor de subkey de este par谩metro representa la cantidad m谩xima de tiempo que la propuesta tiene para alcanzar la cantidad m铆nima de dep贸sito antes de expirar. La cantidad m谩xima de tiempo que una propuesta puede aceptar contribuciones de dep贸sito antes de expirar es actualmente de 1209600000000000 nanosegundos o 14 d铆as. Si la propuesta expira, cualquier cantidad de dep贸sito ser谩 quemada. ### Posibles consecuencias #### Disminuci贸n del valor `maxdepositperiod` La disminuci贸n del valor de subkey `maxdepositperiod` reducir谩 el tiempo de dep贸sito de las contribuciones a las propuestas de gobernanza. Es probable que esto disminuya el tiempo que algunas propuestas permanecen visibles y que disminuya la probabilidad de que entren en el per铆odo de votaci贸n. Esto puede aumentar la probabilidad de que las propuestas caduquen y se quemen sus dep贸sitos. #### Aumentar el valor `maxdepositperiod` -El aumento del valor de subkey `maxdepositperiod` ampliar谩 el plazo para las contribuciones de dep贸sito a las propuestas de gobernanza. Es probable que esto aumente el tiempo en que algunas propuestas siguen siendo visibles y aumente potencialmente la probabilidad de que entren en el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod). Esto puede disminuir la probabilidad de que las propuestas caduquen y se quemen sus dep贸sitos. +El aumento del valor de subkey `maxdepositperiod` ampliar谩 el plazo para las contribuciones de dep贸sito a las propuestas de gobernanza. Es probable que esto aumente el tiempo en que algunas propuestas siguen siendo visibles y aumente potencialmente la probabilidad de que entren en el [per铆odo de votaci贸n](./Governance.md#votingperiod). Esto puede disminuir la probabilidad de que las propuestas caduquen y se quemen sus dep贸sitos. #### Observaciones -Actualmente, la mayor铆a de los exploradores de la red (por ejemplo, Hubble, Big Dipper, Mintscan) dan la misma visibilidad a las propuestas en el per铆odo de dep贸sito que a las del [per铆odo de votaci贸n](params-change/Governance.md#votingperiod). Esto significa que una propuesta con un peque帽o dep贸sito (por ejemplo, 0.001 ATOM) tendr谩 la misma visibilidad que aquellas con un dep贸sito completo de 512 ATOM en el per铆odo de votaci贸n. +Actualmente, la mayor铆a de los exploradores de la red (por ejemplo, Hubble, Big Dipper, Mintscan) dan la misma visibilidad a las propuestas en el per铆odo de dep贸sito que a las del [per铆odo de votaci贸n](./Governance.md#votingperiod). Esto significa que una propuesta con un peque帽o dep贸sito (por ejemplo, 0.001 ATOM) tendr谩 la misma visibilidad que aquellas con un dep贸sito completo de 512 ATOM en el per铆odo de votaci贸n. ## 2. `votingparams` ## `votingperiod` @@ -88,10 +88,10 @@ El aumento del valor de subkey `quorum` requerir谩 una mayor proporci贸n de la r #### `cosmoshub-3` por defecto: `0.500000000000000000` Se requiere una mayor铆a simple de votos a favor (es decir, el 50% del poder de voto participativo) para que se apruebe una propuesta de gobierno. Aunque es necesario, un voto de mayor铆a simple 'yes' puede no ser suficiente para aprobar una propuesta en dos escenarios: -1. No se alcanza un [qu贸rum](params-change/Governance.md#quorum) del 40% de la capacidad de la red o +1. No se alcanza un [qu贸rum](./Governance.md#quorum) del 40% de la capacidad de la red o 2. Un voto de 'no-with-veto' del 33,4% del poder de voto o mayor. -Si se aprueba una propuesta de gobernanza, las cantidades depositadas se devuelven a los contribuyentes. Si se aprueba una propuesta basada en texto, nada se promulga autom谩ticamente, pero existe una expectativa social de que los participantes se coordinen para promulgar los compromisos se帽alados en la propuesta. Si se aprueba una propuesta de cambio de par谩metros, el par谩metro de protocolo cambiar谩 inmediatamente despu茅s de que termine el [per铆odo de votaci贸n](params-change/Governance.md#votingperiod), y sin necesidad de ejecutar un nuevo software. Si se aprueba una propuesta de gasto comunitario, el saldo de la Reserva Comunitaria disminuir谩 en el n煤mero de ATOMs indicados en la propuesta y la direcci贸n del destinatario aumentar谩 en ese mismo n煤mero de ATOMs inmediatamente despu茅s de que termine el per铆odo de votaci贸n. +Si se aprueba una propuesta de gobernanza, las cantidades depositadas se devuelven a los contribuyentes. Si se aprueba una propuesta basada en texto, nada se promulga autom谩ticamente, pero existe una expectativa social de que los participantes se coordinen para promulgar los compromisos se帽alados en la propuesta. Si se aprueba una propuesta de cambio de par谩metros, el par谩metro de protocolo cambiar谩 inmediatamente despu茅s de que termine el [per铆odo de votaci贸n](./Governance.md#votingperiod), y sin necesidad de ejecutar un nuevo software. Si se aprueba una propuesta de gasto comunitario, el saldo de la Reserva Comunitaria disminuir谩 en el n煤mero de ATOMs indicados en la propuesta y la direcci贸n del destinatario aumentar谩 en ese mismo n煤mero de ATOMs inmediatamente despu茅s de que termine el per铆odo de votaci贸n. ### Posibles consecuencias #### Disminuci贸n del valor `threshold` @@ -123,7 +123,7 @@ Aumentar el valor de subkey `veto` aumentar谩 la proporci贸n del poder de voto r ## Par谩metros de G茅nesis (aka lanzamiento) Esto es 煤til si no tienes `gaiad` instalado y no tienes una raz贸n para creer que el par谩metro ha cambiado desde que se lanz贸 la cadena. -Cada par谩metro puede ser verificado en el archivo g茅nesis de la cadena, que encuentra [aqu铆](https://raw.githubusercontent.com/cosmos/launch/master/genesis.json). Estos son los par谩metros con los que la 煤ltima cadena del Hub de Cosmos se lanz贸, y seguir谩 haci茅ndolo, a menos que una propuesta de gobierno los cambie. He resumido esos valores originales en la secci贸n [Especificaciones T茅cnicas](params-change/Governance.md#technical-specifications). +Cada par谩metro puede ser verificado en el archivo g茅nesis de la cadena, que encuentra [aqu铆](https://raw.githubusercontent.com/cosmos/launch/master/genesis.json). Estos son los par谩metros con los que la 煤ltima cadena del Hub de Cosmos se lanz贸, y seguir谩 haci茅ndolo, a menos que una propuesta de gobierno los cambie. He resumido esos valores originales en la secci贸n [Especificaciones T茅cnicas](./Governance.md#technical-specifications). El archivo g茅nesis contiene texto y es grande. El esquema de nombres de los par谩metros de g茅nesis no es id茅ntico a los de la lista anterior, as铆 que cuando busco, pongo un gui贸n bajo entre los caracteres en may煤sculas y min煤sculas, y luego convierto todos los caracteres a min煤sculas. @@ -175,4 +175,4 @@ El m贸dulo `gov` contiene los siguientes par谩metros: | threshold | string (dec) | "0.500000000000000000" | | veto | string (dec) | "0.334000000000000000" | -__Observaci贸n__: El m贸dulo de gobierno contiene par谩metros que son objetos que no son como los dem谩s m贸dulos. Si s贸lo se desea modificar un subconjunto de par谩metros, s贸lo hay que incluirlos y no toda la estructura de objetos de par谩metros. \ No newline at end of file +__Observaci贸n__: El m贸dulo de gobierno contiene par谩metros que son objetos que no son como los dem谩s m贸dulos. Si s贸lo se desea modificar un subconjunto de par谩metros, s贸lo hay que incluirlos y no toda la estructura de objetos de par谩metros. diff --git a/docs/governance/params-change/README.md b/docs/governance/params-change/README.md index 43d76d22263..87267d0406d 100644 --- a/docs/governance/params-change/README.md +++ b/docs/governance/params-change/README.md @@ -1,5 +1,5 @@ # Cosmos Hub Parameter-Change Best Practices & Wiki -This Cosmos Hub educational documentation aims to outline the [Hub's parameters](#modules-wiki), describe their functions, and describe the potential implications of modifying each parameter. This documentation also aims to provide [guidelines for creating and assessing parameter-change proposals](#best-practices). +This Cosmos Hub educational documentation aims to outline the [Hub's parameters](#params-wiki), describe their functions, and describe the potential implications of modifying each parameter. This documentation also aims to provide [guidelines for creating and assessing parameter-change proposals](#drafting-a-parameter-change-proposal). **This documentation has not had adequate review from experts or testing from participants, so please be cautious when using it.** [Discuss its development here](https://forum.cosmos.network/t/gwg-cosmos-hub-parameters-wiki/3170) and please provide feedback either in the forum or by opening a Github issue. If you are technically inclined, this is the full [list of modules](https://github.com/cosmos/cosmos-sdk/tree/master/x) in the Cosmos SDK. @@ -8,15 +8,15 @@ Drafting and submitting a parameter-change governance proposal involves two kind If you are considering drafting a proposal, you should review the general background on drafting and submitting a proposal: -1. [How the voting process and governance mechanism works](/overview.md) -1. [How to draft your proposal and engage with the Cosmos community about it](/best_practices.md) -1. [How to submit your proposal](/submitting.md) +1. [How the voting process and governance mechanism works](../overview.md) +1. [How to draft your proposal and engage with the Cosmos community about it](../best_practices.md) +1. [How to submit your proposal](../submitting.md) You should also review details specific to Parameter Change proposals: 1. [Params Wiki](#params-wiki) -1. [Best practices for a Parameter Change Proposal](best_practices.md) -1. [How to format Parameter Change Proposals](formatting.md) +1. [Best practices for a Parameter Change Proposal](./best_practices.md) +1. [How to format Parameter Change Proposals](./formatting.md) ## Params Wiki @@ -25,20 +25,20 @@ Each module has its own set of parameters. Any of them can be updated with a Params Change Proposal. There are currently 8 modules active in the Cosmos Hub with parameters that may be altered via governance proposal: -1. [auth](/Auth.md) - Authentication of accounts and transactions -2. [bank](/Bank.md) - Token transfer functionalities -3. [gov](/Governance.md) - On-chain governance proposals and voting -4. [staking](/Staking.md) - Proof-of-stake layer -5. [slashing](/Slashing.md) - Validator punishment mechanisms -6. [distribution](/Distribution.md) - Fee distribution and staking token provision distribution -7. [crisis](/Crisis.md) - Halting the blockchain under certain circumstances (ie. if an invariant is broken) -8. [mint](/Mint.md) - Creation of new units of staking token +1. [auth](./Auth.md) - Authentication of accounts and transactions +2. [bank](./Bank.md) - Token transfer functionalities +3. [gov](./Governance.md) - On-chain governance proposals and voting +4. [staking](./Staking.md) - Proof-of-stake layer +5. [slashing](./Slashing.md) - Validator punishment mechanisms +6. [distribution](./Distribution.md) - Fee distribution and staking token provision distribution +7. [crisis](./Crisis.md) - Halting the blockchain under certain circumstances (ie. if an invariant is broken) +8. [mint](./Mint.md) - Creation of new units of staking token -There is an [index of these parameters here](/params-change/param_index.md). +There is an [index of these parameters here](./param_index.md). The value or setting for each parameter may be verified in the chain's genesis file, [found here](https://raw.githubusercontent.com/cosmos/launch/master/genesis.json). These are the parameter settings that the latest Cosmos Hub chain launched with, and will remain so unless a governance proposal or software upgrade changes them. -There are also ways to query the current settings for each module's parameter(s). Some can be queried with the command line program [`gaiad`](/gaiad), but I'm still exploring the ways that these settings can be queried. Want to help? I've opened this up as an issue [here](https://github.com/gavinly/CosmosParametersWiki/issues/1). You can begin by using the command `gaia q [module] -h` to get help about the subcommands for the module you want to query. For example, `gaiad q staking params --chain-id cosmoshub-3 --node http://51.79.82.228:26657` returns the settings of four parameters: +There are also ways to query the current settings for each module's parameter(s). Some can be queried with the command line program [`gaiad`](./gaiad), but I'm still exploring the ways that these settings can be queried. Want to help? I've opened this up as an issue [here](https://github.com/gavinly/CosmosParametersWiki/issues/1). You can begin by using the command `gaia q [module] -h` to get help about the subcommands for the module you want to query. For example, `gaiad q staking params --chain-id cosmoshub-3 --node http://51.79.82.228:26657` returns the settings of four parameters: ``` unbonding_time: 504h0m0s max_validators: 125 @@ -48,13 +48,13 @@ bond_denom: uatom ## The Voting Process & Governance Mechanism -The criteria for submitting a parameter-change proposal and the subsequent voting conditions are the same as those for signalling (text-based) proposals and community-spend proposals. Details about the deposit period can be found [here](/overview.md#1-deposit-period), and voting period [here](/overview.md#what-determines-whether-or-not-a-governance-proposal-passes). +The criteria for submitting a parameter-change proposal and the subsequent voting conditions are the same as those for signalling (text-based) proposals and community-spend proposals. Details about the deposit period can be found [here](../overview.md#_1-deposit-period), and voting period [here](../overview.md#what-determines-whether-or-not-a-governance-proposal-passes). If a paramater-change proposal is successful, the change takes effect immediately upon completion of the voting period. ## Note - You cannot currently query the `bank` module's parameter, which is `sendenabled`. You also cannot query the `crisis` module's parameters. -- You will need to compile [`gaiad`](/gaiad) from source into a binary file executable by your operating system eg. MacOS, Windows, Linux +- You will need to compile [`gaiad`](./gaiad) from source into a binary file executable by your operating system eg. MacOS, Windows, Linux - You will need to indicate which chain you are querying, and currently this is `--chain-id cosmoshub-3` - You will need to connect to a full node. If gaiad isn't already configured for this, you can use this tag in your command `--node [address]:26657`. @@ -67,8 +67,8 @@ This documentation was created by Gavin Birch ([Figment Networks](https://figmen **Special thanks** to the following for helping to provide credible information that contributed to this wiki's development: - Aleks (All in Bits; Fission Labs) for answering countless questions about these parameters -- Alessio (All in Bits) for explaining how [`SigVerifyCostED25519`](params-change/Auth.md#4-sigverifycosted25519) & [`SigVerifyCostSecp256k1`](params-change/Auth.md#5-sigverifycostsecp256k1) work, and detailed answers to my many questions -- Vidor for volunteering to explain [`ConstantFee`](params-change/Crisis.md#1-constantfee) and answering my many questions in detail -- Hyung (B-Harvest) for volunteering how [`InflationRateChange`](params-change/Mint.md#2-inflationratechange) works -- Joe (Chorus One) for explaining the security details involved with [using full nodes for transactions](#full-nodes) -- Sunny (All in Bits; Sikka) for volunteering an explanation of the purpose of [`withdrawaddrenabled`](params-change/Distribution.md#4-withdrawaddrenabled) \ No newline at end of file +- Alessio (All in Bits) for explaining how [`SigVerifyCostED25519`](./Auth.md#4-sigverifycosted25519) & [`SigVerifyCostSecp256k1`](./Auth.md#5-sigverifycostsecp256k1) work, and detailed answers to my many questions +- Vidor for volunteering to explain [`ConstantFee`](./Crisis.md#1-constantfee) and answering my many questions in detail +- Hyung (B-Harvest) for volunteering how [`InflationRateChange`](./Mint.md#2-inflationratechange) works +- Joe (Chorus One) for explaining the security details involved with using full nodes for transactions +- Sunny (All in Bits; Sikka) for volunteering an explanation of the purpose of [`withdrawaddrenabled`](./Distribution.md#4-withdrawaddrenabled) diff --git a/docs/governance/params-change/formatting.md b/docs/governance/params-change/formatting.md index 86accd3bdb0..27676de82ca 100644 --- a/docs/governance/params-change/formatting.md +++ b/docs/governance/params-change/formatting.md @@ -1,6 +1,6 @@ # Formatting a Params Change Proposal -**Note:** Changes to the [`gov` module](/Governance.md) are different from the other kinds of parameter changes because `gov` has subkeys, [as discussed here](https://github.com/cosmos/cosmos-sdk/issues/5800). Only the `key` part of the JSON file is different for `gov` parameter-change proposals. +**Note:** Changes to the [`gov` module](./Governance.md) are different from the other kinds of parameter changes because `gov` has subkeys, [as discussed here](https://github.com/cosmos/cosmos-sdk/issues/5800). Only the `key` part of the JSON file is different for `gov` parameter-change proposals. For parameter-change proposals, there are seven (7) components: 1. **Title** - the distinguishing name of the proposal, typically the way the that explorers list proposals @@ -39,7 +39,7 @@ You use can also use [Hubble](https://hubble.figment.network/cosmos/chains/gaia- The deposit `denom` is `uatom` and `amount` is `100000`. Since 1,000,000 micro-ATOM is equal to 1 ATOM, a deposit of 0.1 ATOM will be included with this proposal. The gaia-13007 testnet currently has a 0.1 ATOM minimum deposit, so this will put the proposal directly into the voting period. There is a minimum deposit required for a proposal to enter the voting period, and anyone may contribute to this deposit within a 14-day period. If the minimum deposit isn't reached before this time, the deposit amounts will be burned. Deposit amounts will also be burned if quorum isn't met in the vote or if the proposal is vetoed. ### Mainnet example: -To date, the Cosmos Hub's parameters have not been changed by a parameter-change governance proposal. This is a hypothetical example of the JSON file that would be used with a command line transaction to create a new proposal. This is an example of a proposal that changes two parameters, and both parameters are from the [`slashing` module](Slashing.md). A single parameter-change governance proposal can reportedly change any number of parameters. +To date, the Cosmos Hub's parameters have not been changed by a parameter-change governance proposal. This is a hypothetical example of the JSON file that would be used with a command line transaction to create a new proposal. This is an example of a proposal that changes two parameters, and both parameters are from the [`slashing` module](./Slashing.md). A single parameter-change governance proposal can reportedly change any number of parameters. ``` { @@ -62,5 +62,4 @@ To date, the Cosmos Hub's parameters have not been changed by a parameter-change ``` **Note:** in the JSON file, `\n` creates a new line. -It's worth noting that this example proposal doesn't provide reasoning/justification for these changes. Consider consulting the [parameter-change best practices documentation](submitting.md) for guidance on the contents of a parameter-change proposal. - +It's worth noting that this example proposal doesn't provide reasoning/justification for these changes. Consider consulting the [parameter-change best practices documentation](./best_practices.md) for guidance on the contents of a parameter-change proposal. diff --git a/docs/governance/params-change/param_index.md b/docs/governance/params-change/param_index.md index d349b28983c..1e9c8249735 100644 --- a/docs/governance/params-change/param_index.md +++ b/docs/governance/params-change/param_index.md @@ -24,6 +24,6 @@ For more information on specific modules, refer to the [Cosmos SDK documentation

- Read more about the governance implications of the {{subspace}} subspace here. + Read more about the governance implications of the {{subspace}} subspace here.

- \ No newline at end of file + diff --git a/docs/governance/submitting.md b/docs/governance/submitting.md index 3ff19f67ddb..30d7ddc96eb 100644 --- a/docs/governance/submitting.md +++ b/docs/governance/submitting.md @@ -36,14 +36,14 @@ The reason we use IPFS is that it is a decentralized means of storage, making it ## Formatting the JSON file for the governance proposal -Prior to sending the transaction that submits your proposal on-chain, you must create a JSON file. This file will contain the information that will be stored on-chain as the governance proposal. Begin by creating a new text (.txt) file to enter this information. Use [these best practices](bestpractices.md) as a guide for the contents of your proposal. When you're done, save the file as a .json file. See the examples that follow to help format your proposal. +Prior to sending the transaction that submits your proposal on-chain, you must create a JSON file. This file will contain the information that will be stored on-chain as the governance proposal. Begin by creating a new text (.txt) file to enter this information. Use [these best practices](./best_practices.md) as a guide for the contents of your proposal. When you're done, save the file as a .json file. See the examples that follow to help format your proposal. Each proposal type is unique in how the JSON should be formatted. See the relevant section for the type of proposal you are drafting: -- [Text Proposals](text/formatting.md) -- [Community Pool Spend Proposals](community-pool-spend/formatting.md) -- [Parameter Change Proposals](params-change/formatting.md) +- [Text Proposals](./text/) +- [Community Pool Spend Proposals](./community-pool-spend/formatting.md) +- [Parameter Change Proposals](./params-change/formatting.md) Once on-chain, most people will rely upon network explorers to interpret this information with a graphical user interface (GUI). @@ -51,7 +51,7 @@ Once on-chain, most people will rely upon network explorers to interpret this in ## Sending the transaction that submits your governance proposal -For information on how to use gaiad (the command line interface) to submit an on-chain proposal through the governance module, please refer to the [gaiad resource](https://hub.cosmos.network/main/resources/gaiad.html) for the Cosmos Hub documentation. +For information on how to use gaiad (the command line interface) to submit an on-chain proposal through the governance module, please refer to the [gaiad resource](../resources/gaiad.md) for the Cosmos Hub documentation. ### Walkthrough example @@ -96,7 +96,8 @@ This is the complete command that I could use to submit a **mainnet** parameter- After posting your transaction, your command line interface (gaiad) will provide you with the transaction's hash, which you can either query using gaiad or by searching the hash using [Hubble](https://hubble.figment.network/cosmos/chains/cosmoshub-3/transactions/B8E2662DE82413F03919712B18F7B23AF00B50DAEB499DAD8C436514640EFC79). The hash should look something like this: `B8E2662DE82413F03919712B18F7B23AF00B50DAEB499DAD8C436514640EFC79` You can see whether or not your transaction was successful with Hubble: -![Verify tx with Hubble](/community-pool-spend/verify%20tx.png?raw=true) + +![Verify tx with Hubble](../images/verify-tx.png) ### Troubleshooting a failed transaction There are a number of reasons why a transaction may fail. Here are two examples: diff --git a/docs/governance/community-pool-spend/verify tx.png b/docs/images/verify-tx.png similarity index 100% rename from docs/governance/community-pool-spend/verify tx.png rename to docs/images/verify-tx.png