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

Fix: typo in public_key_cryptography.md #4083

Closed
wants to merge 1 commit into from

Conversation

youyyytrok
Copy link

This PR fixes a typo in the public_key_cryptography.md file. Specifically, the incorrect value "257-bits" has been corrected to "256-bits" for Secp256k1 public key compression size.

@youyyytrok youyyytrok requested review from liamsi and a team as code owners December 5, 2024 13:55
@youyyytrok youyyytrok requested review from staheri14 and rach-id and removed request for a team December 5, 2024 13:55
@celestia-bot celestia-bot requested a review from a team December 5, 2024 13:56
Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the documentation regarding Secp256k1 public keys in the public_key_cryptography.md file. It corrects the previously stated size of compressed public keys from 257-bits to 256-bits, ensuring accuracy in the description. No other content, structure, or formatting changes were made to the document.

Changes

File Change Summary
specs/src/public_key_cryptography.md Updated description of Secp256k1 public keys from "257-bits" to "256-bits" for accuracy.

Possibly related PRs

  • docs: fix typo in specs/src/cat_pool.md #4061: This PR corrects a typographical error in the specs/src/cat_pool.md file, similar to the main PR's focus on correcting a specific detail in a documentation file related to public-key cryptography.
  • fix: typographical errors in multiple files  #4078: This PR addresses multiple typographical errors across various files, including specs/src/cat_pool.md, which aligns with the main PR's objective of correcting a specific statement in the documentation on public-key cryptography.

Suggested labels

external

Suggested reviewers

  • liamsi
  • evan-forbes
  • ninabarbakadze
  • rootulp

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
specs/src/public_key_cryptography.md (1)

17-17: LGTM! The correction to 256-bits is accurate.

The change improves technical accuracy as Secp256k1 public keys use a 256-bit field. When compressed, they are stored in 33 bytes total: 1 byte prefix for the y-coordinate parity and 32 bytes (256 bits) for the x-coordinate.

Consider adding a brief note about the compression format:

-Secp256k1 public keys can be compressed to 256-bits (or 33 bytes) per the format described [here](https://github.com/cosmos/cosmos-sdk/blob/v0.46.15/docs/basics/accounts.md#public-keys).
+Secp256k1 public keys can be compressed to 256-bits (or 33 bytes, consisting of a 1-byte prefix and 32-byte x-coordinate) per the format described [here](https://github.com/cosmos/cosmos-sdk/blob/v0.46.15/docs/basics/accounts.md#public-keys).
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6447542 and e65a122.

📒 Files selected for processing (1)
  • specs/src/public_key_cryptography.md (1 hunks)

@@ -14,7 +14,7 @@ A highly-optimized library is available in C (<https://github.com/bitcoin-core/s

### Public-keys

Secp256k1 public keys can be compressed to 257-bits (or 33 bytes) per the format described [here](https://github.com/cosmos/cosmos-sdk/blob/v0.46.15/docs/basics/accounts.md#public-keys).
Secp256k1 public keys can be compressed to 256-bits (or 33 bytes) per the format described [here](https://github.com/cosmos/cosmos-sdk/blob/v0.46.15/docs/basics/accounts.md#public-keys).
Copy link
Collaborator

Choose a reason for hiding this comment

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

A compressed Secp256k1 public key is 256 bits for the x coordinate and 1 bit to determine if the y coordinate is even or odd. 256 + 1 = 257 which is 33 bytes.

Copy link
Author

Choose a reason for hiding this comment

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

Sorry

Copy link
Collaborator

Choose a reason for hiding this comment

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

no worries

@rootulp rootulp closed this Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants