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

docs: Update protobuf tx signing message format outer link #22510

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

middthe
Copy link
Contributor

@middthe middthe commented Nov 11, 2024

Description

The original link couldn't direct us to the right webpage, I think the new one should be ok


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity and structure of the transaction encoding strategy document.
    • Updated encoding methods for transactions using Protocol Buffers to improve compatibility.
    • Introduced new methods in the AccountRetriever and Generator interfaces for better transaction handling.
    • Clarified handling of public keys and expanded signing modes to enhance transaction signing processes.

@middthe middthe requested a review from a team as a code owner November 11, 2024 15:20
Copy link
Contributor

coderabbitai bot commented Nov 11, 2024

📝 Walkthrough

Walkthrough

The pull request updates the document adr-020-protobuf-transaction-encoding.md, detailing the encoding of transactions using Protocol Buffers in the Cosmos SDK. Key modifications include the introduction of new message structures, enhancements to the SignerInfo structure, and the addition of several methods in the AccountRetriever and Generator interfaces. The document clarifies the handling of public keys and expands signing modes, while also emphasizing the need to reject unknown fields in protobuf messages. Overall, the document's structure and clarity have been improved.

Changes

File Path Change Summary
docs/architecture/adr-020-protobuf-transaction-encoding.md - Updated transaction encoding details using Protocol Buffers.
- Introduced new message structures: Tx, TxRaw, TxBody, AuthInfo.
- Modified SignerInfo structure.
- Added methods to AccountRetriever: GetAccount, GetAccountWithHeight, EnsureExists, GetAccountNumberSequence.
- Added methods to Generator: NewTx, NewFee, NewSignature, MarshalTx.
- Updated method signature for GetTx() in TxBuilder.

Possibly related PRs

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • hieuvubk

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 78f08e8 and 36a0c21.

📒 Files selected for processing (1)
  • docs/architecture/adr-020-protobuf-transaction-encoding.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-020-protobuf-transaction-encoding.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (1)
docs/architecture/adr-020-protobuf-transaction-encoding.md (1)

252-252: LGTM: Link update is accurate and relevant.

The added link to the MessageFormat documentation is properly formatted and points to the correct resource, providing valuable reference for the human-readable encoding format discussion.


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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Thanks!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 11, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Nov 11, 2024
Merged via the queue into cosmos:main with commit d986269 Nov 11, 2024
71 of 73 checks passed
mergify bot pushed a commit that referenced this pull request Nov 11, 2024
julienrbrt pushed a commit that referenced this pull request Nov 12, 2024
@middthe middthe deleted the fix/msgformatlink branch November 12, 2024 13:09
alpe added a commit that referenced this pull request Nov 13, 2024
* main: (31 commits)
  docs: update links for https security protocol (#22514)
  build(deps): Bump github.com/bytedance/sonic from 1.12.3 to 1.12.4 in /log (#22513)
  feat(x/protocolpool)!: allow any coins in continuous funds (#21916)
  docs: Update protobuf  tx signing message format outer link (#22510)
  test(accounts): fix integration tests (#22418)
  chore(x): fix some typos in comment (#22508)
  build(deps): Bump cosmossdk.io/log from 1.4.1 to 1.5.0 (#22487)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.5 to 1.0.0-alpha.6 (#22502)
  build(deps): Bump golang.org/x/crypto from 0.28.0 to 0.29.0 (#22480)
  docs(adr75): server v2 (#21069)
  fix(server/v2): improve server stop (#22455)
  chore: prepare core changelog (#22495)
  refactor(store/v2): simplify genesis flow (#22435)
  build(deps): Bump google.golang.org/grpc from 1.67.1 to 1.68.0 (#22486)
  build(deps): Bump golang.org/x/sync from 0.8.0 to 0.9.0 (#22482)
  feat(x/circuit): Allow msg Reset with empty msgURL (#22459)
  build(deps): Bump actions/xxx-artifact from v3 to v4 (#22468)
  feat(stf/branch): simplify merged iterator (#22131)
  refactor(log): disable coloring in testing logger (#22466)
  chore(x/tx): update changelog to alpha.2 (#22465)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release Type: ADR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants