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

soroban-cli: rename config identity to config key #1053

Closed
leighmcculloch opened this issue Oct 26, 2023 · 6 comments · Fixed by #1086
Closed

soroban-cli: rename config identity to config key #1053

leighmcculloch opened this issue Oct 26, 2023 · 6 comments · Fixed by #1086
Assignees
Labels
cli Related to Soroban CLI

Comments

@leighmcculloch
Copy link
Member

I think we should consider renaming config identity to config key.

Keys are buried in the soroban-cli under the config identity command. It's easy to miss it and think the soroban command doesn't do key generation or key management.

While identity is a nice name for a number of reasons of why we picked it, it reduces the discoverability.

@willemneal
Copy link
Member

We could also do top level

  • keys
  • id

This would let you have named public addresses including contracts.

@leighmcculloch
Copy link
Member Author

leighmcculloch commented Nov 15, 2023

I think there's value in keeping a local address book separate to keys. To make it really clear offer no ambiguity about what are keys a user owns vs other addresses.

i.e.:

  • soroban key
  • soroban addressbook

@willemneal
Copy link
Member

What is confusing though is a key also has an address. So anywhere we use an Address in the CLI should use either when converting the alias to address. So we prioritize one namespace over the other? Or ensure that aliases are unique across them.

Alternatively we could also have prefixes on the addresses. E.g.C: G:, and S:?

@leighmcculloch
Copy link
Member Author

Could you share some examples of what you mean?

@willemneal
Copy link
Member

For starters, if you have foo as both a key and in the address book then when using the alias which would be picked.

K:foo would refer to the address of the secret key foo, while A:foo would be the address book. Or we could avoid that all together and say they both share the same namespace.

@leighmcculloch
Copy link
Member Author

Rather than prefixes I'd make it a unified space where the addressbook is a superset of the keys, and registering an address in the addressbook under a name that has a key or vice versa would be an error.

@mollykarcher mollykarcher moved this from Backlog to In Progress in Platform Scrum Dec 14, 2023
@mollykarcher mollykarcher added the cli Related to Soroban CLI label Dec 14, 2023
@mollykarcher mollykarcher moved this from In Progress to Blocked in Platform Scrum Dec 14, 2023
@mollykarcher mollykarcher moved this from Blocked to In Progress in Platform Scrum Jan 4, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Platform Scrum Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to Soroban CLI
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants