Change payer envelope to bytes field

[neekolas]

Summary by CodeRabbit

• New Features

  • Enabled direct envelope creation from raw data, expanding flexibility in processing envelope information.

• Refactor

  • Enhanced internal handling with improved error management for message and identity updates.
  • Streamlined envelope construction flows to boost consistency and overall system reliability.

• Chores

  • Updated protocol definition generation to reference a new source branch.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the way envelope data is generated, processed, and handled across several components. It changes the branch used for protobuf generation and refactors envelope construction by shifting from directly unmarshaling to working with byte representations. Several functions have updated signatures to return errors, and new helper functions (such as one to create a payer envelope from bytes) have been introduced. Test functions and utility code are also modified to reflect these changes, ensuring that error handling is improved and the envelope data flows consistently through the system.

Changes

File(s)	Change Summary
dev/gen-protos	Changed the branch for protobuf definition generation from main to nm/serialize-payer-envelope.
pkg/api/message/publish_test.go, pkg/registrant/registrant_test.go	Modified tests to introduce explicit unmarshalling of PayerEnvelopeBytes into a new envelope variable, replacing direct envelope access.
pkg/api/payer/service.go	Updated buildUnsignedOriginatorEnvelopeFromChain to return a tuple with an error and improved its error handling.
pkg/envelopes/payer.go, pkg/envelopes/unsignedOriginator.go	Added NewPayerEnvelopeFromBytes for constructing envelopes from byte slices and introduced the new method PayerEnvelopeBytes() for retrieving envelope bytes.
pkg/indexer/storer/groupMessage.go, pkg/indexer/storer/identityUpdate.go	Refactored envelope building logic in storage functions to isolate envelope construction and include error checks.
pkg/registrant/registrant.go	Removed the unmarshalling of the PayerEnvelope and now directly assigns PayerEnvelopeBytes to the unsigned envelope.
pkg/testutils/envelopes/envelopes.go	Modified CreateOriginatorEnvelope to marshal the payer envelope into bytes, updating the structure’s field accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Service/Indexer
    participant Builder as EnvelopeBuilder
    participant ProtoUtil as Proto Utility

    Caller->>Builder: Request envelope construction
    Builder->>ProtoUtil: Marshal payer envelope (using bytes)
    ProtoUtil-->>Builder: Return PayerEnvelope instance (or error)
    alt Error Occurs
        Builder-->>Caller: Return error
        Note right of Caller: Log error and halt further processing
    else Successful
        Builder-->>Caller: Return constructed envelope
        Caller->>Next: Proceed with signing or blockchain operations
    end

Loading

Possibly related PRs

• API Mock Improvements #394: Updates in envelope handling within publish_test.go that focus on adjustments related to PayerEnvelope processing.
• Add tests and fix bugs for payer API #248: Modifications in the construction and management of PayerEnvelope data in publish_test.go, indicating a close code-level connection.

Suggested reviewers

• mkysel
• richardhuaaa

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

Error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)
Failed executing command with error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24)

---

📜 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 8d666c7 and 57bdcd1.

⛔ Files ignored due to path filters (1)

• pkg/proto/xmtpv4/envelopes/envelopes.pb.go is excluded by !**/*.pb.go, !pkg/proto/**

📒 Files selected for processing (10)

• dev/gen-protos (1 hunks)
• pkg/api/message/publish_test.go (1 hunks)
• pkg/api/payer/service.go (3 hunks)
• pkg/envelopes/payer.go (1 hunks)
• pkg/envelopes/unsignedOriginator.go (1 hunks)
• pkg/indexer/storer/groupMessage.go (1 hunks)
• pkg/indexer/storer/identityUpdate.go (2 hunks)
• pkg/registrant/registrant.go (2 hunks)
• pkg/registrant/registrant_test.go (2 hunks)
• pkg/testutils/envelopes/envelopes.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

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.

[neekolas]

• Change payer envelope to bytes field #552 👈 (View in Graphite)
• Link payer to gateway envelopes #536 : 1 other dependent PR (#537 )
• Add payers table #535
• Fix foundry version check #534
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.