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

[Documentation]: Clarify what is meant for mykey for Staking unjail #22809

Open
gluax opened this issue Dec 9, 2024 · 3 comments
Open

[Documentation]: Clarify what is meant for mykey for Staking unjail #22809

gluax opened this issue Dec 9, 2024 · 3 comments
Assignees
Labels
T:Docs Changes and features related to documentation.

Comments

@gluax
Copy link
Contributor

gluax commented Dec 9, 2024

Summary

For the tx slashing unjail --from mykey what is mykey the docs are unclear, and the description of --from is inconsistent from command to command.

I tried doing the address, the validator_address and the name of it from keys list.

Regardless I get an error of:

Error: failed to convert address field to address: from.info: key not found [cosmos/[email protected]/crypto/keyring/keyring.go:538]
12:55PM ERR failure when running app err="failed to convert address field to address: from.info: key not found [cosmos/[email protected]/crypto/keyring/keyring.go:538]"

That error could also be improved as it's not clear what is wrong. If that is invalid it should say and give an example of what a valid value would be.

@gluax gluax added the T:Docs Changes and features related to documentation. label Dec 9, 2024
@gluax gluax changed the title [Documentation]: Clarify what is meant for mykey for Staking unbound [Documentation]: Clarify what is meant for mykey for Staking unjail Dec 9, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Cosmos-SDK Dec 9, 2024
@tac0turtle
Copy link
Member

hey sorry for the delay in our response. the key here is the key you are using to unjail. testing locally it works as expected. what version of the software are you using

@tac0turtle tac0turtle self-assigned this Dec 10, 2024
@tac0turtle tac0turtle moved this from 📋 Backlog to 👀 Waiting / In review in Cosmos-SDK Dec 10, 2024
@tac0turtle tac0turtle moved this from 👀 Waiting / In review to 🤸‍♂️ In Progress in Cosmos-SDK Dec 10, 2024
@gluax
Copy link
Contributor Author

gluax commented Dec 11, 2024

hey sorry for the delay in our response. the key here is the key you are using to unjail. testing locally it works as expected. what version of the software are you using

Hi, I realized it was something in a custom module which requires me to pass --keyring-dir as well.

I do stand by that the documentation is extremely inconsistent and unclear what should be passed to --from, especially on this command.

It should state that the argument to from is the name of a key saved within in a keyring, rather than mykey which could mean one of several things(a key file, the validator address, the nickname of the key in the keyring, etc) upon being read, especially in combination with the error message which made me think it desired a address instead.

And I'm not sure how to word this constructively, but I will do my best. Even in your response you state the key here is the key which is similarly unclear. The question is what is the key, so we can't say it is a key. That doesn't clarify anything.

Trying to help the documentation here, since more often than not, my(and my teams) biggest frustration in the cosmos ecosystem is often the documentation.

@tac0turtle
Copy link
Member

in the cmd it says

 --from string              Name or address of private key with which to sign

this does imply that you can not put random info here, the address you put or name of the key should have the private key somewhere.

If youd like to make a pr to better this, we welcome it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
Status: 🤸‍♂️ In Progress
Development

No branches or pull requests

2 participants