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

[Docs/Tooling] Default to os keyring backend #966

Open
6 tasks
okdas opened this issue Nov 25, 2024 · 2 comments
Open
6 tasks

[Docs/Tooling] Default to os keyring backend #966

okdas opened this issue Nov 25, 2024 · 2 comments
Assignees
Labels
community A ticket intended to potentially be picked up by a community member documentation Improvements or additions to documentation good first issue Good for newcomers tooling Tooling - CLI, scripts, helpers, off-chain, etc...

Comments

@okdas
Copy link
Member

okdas commented Nov 25, 2024

Objective

We've been using test as a keyring backend as this is the easiest backend for development purposes.
Now that we recommend users to utilize poktrolld binary in different ways, we should default to better security practices.

Origin Document

image

Goals

Deliverables

  • Update CLI arguments to default to os keyring backend
  • Update documentation/cheat-sheets where users interact with the poktrolld binary to remove the --keyring-backend argument (so it defaults to os)/

Non-goals / Non-deliverables

  • Do not remove --keyring-backend=test from the infrastructure. Infrastructure keyring considerations are different from user machines. Node operators should be familiar with their options for keyring backends.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @okdas
Co-Owners: TBD

@okdas okdas added documentation Improvements or additions to documentation good first issue Good for newcomers tooling Tooling - CLI, scripts, helpers, off-chain, etc... community A ticket intended to potentially be picked up by a community member labels Nov 25, 2024
@okdas okdas self-assigned this Nov 25, 2024
@okdas okdas added this to Shannon Nov 25, 2024
@okdas okdas moved this to 🔖 Ready in Shannon Nov 25, 2024
@okdas
Copy link
Member Author

okdas commented Nov 25, 2024

@Olshansk this seems like a good first / community issue

@Olshansk Olshansk added this to the Shannon Quality of Life milestone Nov 26, 2024
@Olshansk Olshansk moved this from 🔖 Ready to 📋 Backlog in Shannon Nov 26, 2024
@Olshansk
Copy link
Member

@okdas Thanks for creating this. Let's keep it on the backlog and prioritize it when/if we get lots of people complaining about the CLI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community A ticket intended to potentially be picked up by a community member documentation Improvements or additions to documentation good first issue Good for newcomers tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants