Skip to content
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

Documenting parameters #68

Closed
4 tasks
nylira opened this issue Jul 9, 2019 · 1 comment · Fixed by #1051
Closed
4 tasks

Documenting parameters #68

nylira opened this issue Jul 9, 2019 · 1 comment · Fixed by #1051
Labels
scope: docs Improvements or additions to documentation

Comments

@nylira
Copy link
Contributor

nylira commented Jul 9, 2019

Summary

Could we add a page to the documentation that shows all of the current parameters of the Cosmos Hub?

Problem Definition

It's unclear to the community how long the unbonding period is, the exact percent slashed for validator double-signing, the amount slashed over time for validators that go offline, things like that. Can we document this? If it's in the docs it'll show up on https://hub.cosmos.network.

Proposal

Document the relevant parameters of the Cosmos Hub that would otherwise require querying endpoints.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@alexanderbez
Copy link
Contributor

alexanderbez commented Jul 18, 2019

The params themselves are already documented in the SDK (e.g. here).

Now the actual specific parameters of the Hub are another story. I don't see the benefit of having these actual values documented as they're dynamic -- they can change live on-chain. This would require us to constantly keep an eye on this doc and keep it up to date (we already have trouble doing this).

All the parameters are queryable by a module's /params REST endpoint. IMHO, params should ideally be exposed on most, if not all, block explorers.

@tac0turtle tac0turtle added the scope: docs Improvements or additions to documentation label Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants