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

keys: rename show to secret #1807

Merged
merged 3 commits into from
Dec 20, 2024
Merged

keys: rename show to secret #1807

merged 3 commits into from
Dec 20, 2024

Conversation

leighmcculloch
Copy link
Member

What

Rename keys show to keys secret.

Why

Close #1804

Rename `keys show` to `keys secret`.

### Why

Close #1804
@leighmcculloch leighmcculloch changed the title Rename keys show to keys secret. keys: rename show to secret Dec 19, 2024
@willemneal
Copy link
Member

Perhaps private? We are renaming address to public

Copy link
Contributor

@Ifropc Ifropc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think secret is better than private because we usually use "secret key" instead of "private key" across our docs/sdks/etc.

@leighmcculloch
Copy link
Member Author

Private is historically the more common term in asymmetric key management, but some libs, such as the libs in the Rust ecosystem, have used "Secret". "Secret" contrasts the key types in key pairs more clearly, and avoids problems where they are easily confusable, such as "pk" can mean private or public key.

Note that in SDKs like the js-stellar-sdk the secret terminology is used too.

@leighmcculloch leighmcculloch enabled auto-merge (squash) December 19, 2024 21:50
@leighmcculloch leighmcculloch merged commit 2790dc1 into main Dec 20, 2024
27 of 30 checks passed
@leighmcculloch leighmcculloch deleted the i1804 branch December 20, 2024 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

keys: rename show to secret
3 participants