fix(x/tx): add feePayer as signer (#22311) BACKPORT

[aljo242]

Summary by CodeRabbit

• New Features
  • Introduced support for unordered transactions.
• Bug Fixes
  • Improved transaction processing to ensure fee payer information is correctly recognized and included.
  • Updated documentation entries to reflect the latest transaction handling improvements.

[ironbird-prod]

Ironbird - launch a network

To use Ironbird, you can use the following commands:

• /ironbird chains - List of chain images that ironbird can use to spin-up testnet
• /ironbird loadtests - List of load test modes that ironbird can run against testnet
• /ironbird start - Launch a testnet with the specified chain and load test configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the x/tx module to enhance transaction handling. The changelog is modified to include new entries for unordered transaction support and a fee payer fix, while removing an obsolete JSON sort order entry. The decoding logic now checks for a fee payer in the transaction’s AuthInfo, converts the fee payer's address, and appends it to the signers list if applicable. Corresponding tests have been updated with new scenarios for valid and invalid fee payer values.

Changes

File(s)	Change Summary
x/tx/CHANGELOG.md	Updated changelog with a new unreleased entry for unordered transaction support (#23708), added a fee payer fix under version v0.14.0 (#24408), and removed an outdated entry from v0.13.6 regarding JSON attribute sort order (#21782).
x/tx/decode/decode.go x/tx/decode/decode_test.go	Modified Decode to check for a fee payer in the transaction and convert its address using the AddressCodec. Test cases were expanded to include a new feePayer field with scenarios for valid, invalid, and duplicate fee payer entries.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Transaction Source
    participant Decoder as Tx Decoder
    participant AC as AddressCodec

    Client->>Decoder: Call Decode(transaction)
    Decoder->>Decoder: Check if AuthInfo.feePayer exists
    alt Fee payer specified
        Decoder->>AC: Convert feePayer (string → bytes)
        alt Conversion fails
            AC-->>Decoder: Return conversion error
            Decoder->>Client: Return wrapped decoding error
        else Conversion succeeds
            Decoder->>Decoder: Verify feePayer not in seen signers
            Decoder->>Decoder: Append feePayer to signers list
        end
    else No fee payer specified
        Decoder->>Decoder: Proceed with normal decoding
    end
    Decoder->>Client: Return decoded transaction with signers

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0afb905 and 16c47b0.

📒 Files selected for processing (3)

• x/tx/CHANGELOG.md (1 hunks)
• x/tx/decode/decode.go (1 hunks)
• x/tx/decode/decode_test.go (3 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

x/tx/decode/decode.go (2)

types/tx_msg.go (1)

• Fee (34-37)

errors/errors.go (1)

• Wrap (180-196)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: test-system-legacy
• GitHub Check: test-system
• GitHub Check: Analyze
• GitHub Check: Gosec
• GitHub Check: Summary

🔇 Additional comments (6)

x/tx/decode/decode.go (1)

121-131: Implementation looks good with proper error handling.

The new code correctly checks for the fee payer in the transaction's AuthInfo and adds it to the signers list if it's not already present. The error handling follows the existing pattern in the codebase, using appropriate error wrapping.

A minor improvement would be to add a comment explaining why the fee payer needs to be a signer (e.g., for fee delegation scenarios), which would provide context for future maintainers.

x/tx/CHANGELOG.md (1)

40-40: LGTM! Clear changelog entry.

The changelog entry correctly describes the fix to add the fee payer as a signer and references the PR number.

x/tx/decode/decode_test.go (4)

53-57: Appropriate test struct extensions.

The addition of feePayer and expectedSigners fields to the test struct provides clear parameters for testing the new functionality.

---

69-88: Good test coverage with various scenarios.

The new test cases provide excellent coverage for the fee payer functionality:

1. Invalid fee payer address (expecting an error)
2. Valid fee payer as a separate signer
3. Fee payer that's already a message signer (deduplication)

This ensures the feature works correctly in different scenarios.

---

109-109: Good update to use test case parameter.

Using the test case's feePayer value allows for flexible testing of different scenarios.

---

124-124: Good assertion for signer count.

The assertion properly verifies that the number of signers in the decoded transaction matches the expected count, which is essential for validating the fee payer functionality.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.