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

document how to create a new key type and add it to the keyring #6500

Closed
4 tasks
fedekunze opened this issue Jun 24, 2020 · 6 comments · Fixed by #14573
Closed
4 tasks

document how to create a new key type and add it to the keyring #6500

fedekunze opened this issue Jun 24, 2020 · 6 comments · Fixed by #14573
Labels
C:Keys Keybase, KMS and HSMs good first issue T:Docs Changes and features related to documentation.

Comments

@fedekunze
Copy link
Collaborator

Summary

  • document how to create a new key type and add it to the keyring

Problem Definition

Currently, the process of adding a new key type (eg: The Eth's secp256k1 used on Ethermint) to the keyring in not fully documented/tested, and it would be extremely helpful to add a dev guide.

Proposal

cc: @alessio @jgimeno


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@fedekunze fedekunze added T:Docs Changes and features related to documentation. C:Keys Keybase, KMS and HSMs labels Jun 24, 2020
@fedekunze fedekunze added this to the v0.39 milestone Jun 24, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Jul 5, 2020
@alessio alessio reopened this Jul 12, 2020
@alessio alessio added the pinned label Jul 12, 2020
@tac0turtle tac0turtle removed the stale label Jul 14, 2020
@jgimeno
Copy link
Contributor

jgimeno commented Jul 22, 2020

docs/basics/accounts.md has to be updated too, I think the Keybase api changed a little since then.

@amaury1093
Copy link
Contributor

Reading this again, I'm actually not 100% sure what's in scope:

Add a document/guide to add and register a new key type to the keyring that's used for custom account types

@fedekunze Are you referring to:

  • generate a key of type secp256k1 or ed25519 (basically document the --algo flag)
  • or generate a new key type, which I believe isn't supported in the sdk now. "eg: The Eth's secp256k1 used on Ethermint" can't you use --algo secp256k1?

@fedekunze
Copy link
Collaborator Author

fedekunze commented Oct 28, 2020

the keyring.SignatureAlgo allows you to create a custom key type for the keyring. This is currently not documented. I've implemented it with the help of @alessio on Ethermint's crypto/ package.

@amaury1093 amaury1093 modified the milestones: v0.40 [Stargate], v0.40.1 Nov 18, 2020
@amaury1093 amaury1093 removed their assignment Jan 6, 2021
@amaury1093
Copy link
Contributor

@fedekunze Would you (or @alessio) be willing to write documentation on this piece? I think I am lacking context on how to achieve this.

@dsmello
Copy link

dsmello commented Apr 11, 2022

Hello folks,

What is the state of this issue? I want to help.

julienrbrt pushed a commit that referenced this issue Jan 11, 2023
mergify bot pushed a commit that referenced this issue Jan 11, 2023
Closes #6500

(cherry picked from commit f9cc31f)
0xmuralik pushed a commit to 0xmuralik/cosmos-sdk that referenced this issue Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Keys Keybase, KMS and HSMs good first issue T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants