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

doc secp256r1 #8899

Merged
merged 13 commits into from
Mar 19, 2021
Merged

doc secp256r1 #8899

merged 13 commits into from
Mar 19, 2021

Conversation

robert-zaremba
Copy link
Collaborator

Description

closes: #8800


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@robert-zaremba robert-zaremba added the T:Docs Changes and features related to documentation. label Mar 16, 2021
@robert-zaremba robert-zaremba changed the title Robert/doc secp256r1 doc secp256r1 Mar 16, 2021

A few notes on the `Keyring` methods:
- `secp256k1`, as implemented in the [SDK's `crypto/keys/secp256k1` package](https://github.com/cosmos/cosmos-sdk/blob/v0.42.1/crypto/keys/secp256k1/secp256k1.go).
- `secp256r1`, as implemented in the [SDK's `crypto/keys/secp256r1` package](https://github.com/cosmos/cosmos-sdk/blob/master/crypto/keys/secp256r1/pubkey.go),
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I use a link to master, to allow an easy find when we will tag a new release.

docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

@robert-zaremba First, congratulations on this excellent well-written knowledge. In my fourth week learning about blockchain, I feel like I hit the jackpot reviewing this content. (Today I received my first Ledger wallet... I am in the early stages of learning). Second, I provided grammatical suggestions with the best intentions for technical accuracy and working to establish technical content standards.
Third, I hope to elevate more use of style and content standards. See Technical content style guidance where we are documenting our standards (work in progress). I hope that you find the details and supporting links helpful. Since this is my first PR review with your content, I'm interested in how well it is received. Let me know how I can do better!

docs/architecture/adr-020-protobuf-transaction-encoding.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
robert-zaremba and others added 4 commits March 17, 2021 10:20
Awesome grammar fixes and style improvements

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Awesome grammar and style improvements.

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
@robert-zaremba
Copy link
Collaborator Author

@barriebyron - thanks for an awesome suggestions and your English grammar guidance. The Cosmos documentation will improve a lot thanks to this.

Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

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

lgtm overall. One typo

docs/basics/accounts.md Outdated Show resolved Hide resolved
Alessio Treglia and others added 2 commits March 17, 2021 12:10
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
@orijbot
Copy link

orijbot commented Mar 17, 2021

@orijbot
Copy link

orijbot commented Mar 17, 2021

Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

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

pre-approving. The linked snippets are not linking to correct portions of the code, I suggest fixing that before merging.

docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
@orijbot
Copy link

orijbot commented Mar 19, 2021

@alessio alessio dismissed barriebyron’s stale review March 19, 2021 13:35

All suggestions were accepted. Thanks!

@clevinson clevinson added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 19, 2021
@mergify mergify bot merged commit cc1db18 into master Mar 19, 2021
@mergify mergify bot deleted the robert/doc-secp256r1 branch March 19, 2021 14:23
@barriebyron
Copy link
Contributor

@robert-zaremba I was out of office, sorry to miss your approval request. Good doc work, thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write docs for Secp256r1 Keys
7 participants