feat(x/tx): support bytes field as signer

[yihuang]

should be harmless to support bytes field, and bytes fields are more efficient than string,

Description

Closes: #XXXX

---

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

• Improvements
  • Added support for a bytes field as a signer in the x/tx module.
• Field Updates
  • Changed signer field type in BadSigner from bytes to int32, affecting data representation and processing.
• Functionality Enhancements
  • Introduced new handling for protoreflect.BytesKind in the signing context, improving field processing capabilities.

[coderabbitai]

Walkthrough

Walkthrough

The pull request introduces several changes to the x/tx module, including updates to the changelog, modifications to the signers.proto file, and adjustments in the BadSigner structure within the associated Go files. Notably, the signer field type in BadSigner has been changed from bytes to int32, affecting related methods and serialization processes. Additionally, the makeGetSignersFunc method in the Context struct has been enhanced to handle byte fields.

Changes

File	Change Summary
x/tx/CHANGELOG.md	Updated to include support for bytes field as a signer in the x/tx module.
x/tx/internal/testpb/signers.proto	Changed signer field type from bytes to int32 in BadSigner message.
x/tx/internal/testpb/signers.pulsar.go	Updated BadSigner structure methods to reflect signer as int32, adjusted serialization logic.
x/tx/signing/context.go	Added handling for protoreflect.BytesKind in makeGetSignersFunc method.

Possibly related PRs

• chore: add releases to changelog #21831: The main PR updates the changelog for the x/tx module, while this retrieved PR also involves changes to the CHANGELOG.md, indicating a direct connection in terms of documentation updates.

Suggested reviewers

• aaronc
• kocubinski
• JulianToledano
• testinginprod
• sontrinh16
• tac0turtle

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4666e1d and 876756e.

Files selected for processing (4)

• x/tx/CHANGELOG.md (1 hunks)
• x/tx/internal/testpb/signers.proto (2 hunks)
• x/tx/internal/testpb/signers.pulsar.go (13 hunks)
• x/tx/signing/context.go (1 hunks)

Additional context used

Path-based instructions (3)

x/tx/CHANGELOG.md (1)

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

x/tx/internal/testpb/signers.pulsar.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

x/tx/signing/context.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (16)

x/tx/internal/testpb/signers.proto (1)

110-110: LGTM!

The addition of the empty line at the end of the file improves readability without affecting functionality. This is a good practice to follow.

x/tx/CHANGELOG.md (1)

36-39: LGTM!

The changelog entry follows the correct format, links to the relevant PR, and clearly describes the improvement. No issues found.

x/tx/signing/context.go (1)

304-308: LGTM!

The new case for handling protoreflect.BytesKind fields is implemented correctly. It retrieves the bytes from the specified field and appends them to the array of byte slices, following the existing pattern for other field types.

x/tx/internal/testpb/signers.pulsar.go (13)

Line range hint 7903-7908: ****

The change to the Signer field type from []byte to int32 in the BadSigner struct is intentional based on the PR summary. No issues with this change.

---

7925-7925: ****

The change to check if Signer is non-zero instead of checking the length of a byte slice is consistent with changing the Signer field type to int32.

---

7943-7943: ****

Setting Signer to the zero value for int32 is correct for clearing the field.

---

7962-7962: ****

Returning the int32 value of Signer is consistent with the field type change.

---

7984-7984: ****

Casting the value to int32 is correct for setting the int32 Signer field.

---

8021-8021: ****

Returning a zero int32 value is correct for initializing a new Signer field.

---

8091-8092: ****

Calculating the size contribution of the int32 Signer field is implemented correctly.

---

8123-8126: ****

Marshaling the int32 Signer field is implemented correctly using EncodeVarint.

---

8178-8181: ****

Checking the wire type and unmarshaling the int32 Signer field is implemented correctly.

---

8191-8191: ****

Decoding the int32 value into the Signer field is correct.

---

9394-9398: ****

The GetSigner method is updated to return the int32 Signer field with a default value of 0, which is correct.

---

9870-9870: ****

The Signer field is defined with the correct int32 type in the proto message.

---

9371-9371: Verify the field type change in the codebase.

Changing the Signer field type from []byte to int32 in the BadSigner message is a breaking change. Ensure that all code referencing this field has been updated to handle the new int32 type.

Run the following script to verify the field usage:

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[julienrbrt]

ACK

[julienrbrt]

cc @kocubinski, would be great to have your ACK on this.

[kocubinski]

should be harmless to support bytes field, and bytes fields are more efficient than string,

I'm OK with this change, but we should understand (and document) that a string field and bytes fields offer different support. string are expected to be encoded (e.g. bech32) and the signing context uses the passed in address decoder to do that.

This bytes implementation does no decoding.

[julienrbrt]

should be harmless to support bytes field, and bytes fields are more efficient than string,

I'm OK with this change, but we should understand (and document) that a string field and bytes fields offer different support. string are expected to be encoded (e.g. bech32) and the signing context uses the passed in address decoder to do that.

This bytes implementation does no decoding.

Do you think we should use the address codec on bytes too and do the usual BytesToString as validity check and check for no error (discarding the string obv)? That would bring the support closer and more consistent.

[aaronc]

Do you think we should use the address codec on bytes too and do the usual BytesToString as validity check and check for no error (discarding the string obv)? That would bring the support closer and more consistent.

What kind of error would we expect here?

Do we want any kind of special support in sign modes to render this as bech32?

[yihuang]

Do you think we should use the address codec on bytes too and do the usual BytesToString as validity check and check for no error (discarding the string obv)? That would bring the support closer and more consistent.

What kind of error would we expect here?

Do we want any kind of special support in sign modes to render this as bech32?

In our use case, we happen to store the sender using bytes field in an EVM tx wrapping message, and we choose bytes field to avoid the bech32 decoding step. the end user is not expected to construct the message directly, they'll use the eth compatible wallets to sign tx and send the signed tx through the RPC api.

[meetrick]

It seems like a necessary modification for performance improvement.

[julienrbrt]

What kind of error would we expect here?

Do we want any kind of special support in sign modes to render this as bech32?

It would depend on the address codec of the chain, doesn't have to be per se bech32.
We use the address codec for string -> bytes

• https://github.com/cosmos/cosmos-sdk/blob/de0708b/x/tx/signing/context.go#L204-L207 / https://github.com/cosmos/cosmos-sdk/blob/de0708b/x/tx/signing/context.go#L215-L218

So maybe we should ensure bytes -> string is valid too, even if we don't care about the string result.

[aaronc]

I created an open issue on this years ago: #15740. We should see what amino json output will look like and if there's anything we can do to make it user friendly.

[kocubinski]

devs can use the DefineFieldEncoding API for that, maybe we can close that issue @aaronc ?

[yihuang]

Can we backport this to x/tx/v0.13.x(aka. release/v0.50.x I think). @julienrbrt

[mergify]

backport release/v0.50.x

✅ Backports have been created

• #21944 feat(x/tx): support bytes field as signer (backport #21850) has been created for branch release/v0.50.x

[julienrbrt]

Can we backport this to x/tx/v0.13.x(aka. release/v0.50.x I think). @julienrbrt

Hey, discussed with the team, we've discussed not to backport to a compatible v0.50 x/tx version, as that change is consensus breaking and we are not a great way to convey that for 0ver extracted modules.
As it is a small feature, I would advise forking x/tx v0.13.x to include this in the meantime.