Add support for new envelope types

[neekolas]

TL;DR

Added support for payer reports and payer report attestations in the envelope system.

What changed?

• Added two new topic kinds: TOPIC_KIND_PAYER_REPORTS_V1 and TOPIC_KIND_PAYER_REPORT_ATTESTATIONS_V1 to the topic package
• Extended the TopicMatchesPayload() function to handle the new payload types: PayerReport and PayerReportAttestation
• Added a test case for payer report envelopes with mismatched topics

How to test?

1. Run the existing test suite to verify that the new topic kinds and payload types are properly handled:

   go test ./pkg/envelopes/...
   go test ./pkg/topic/...
   

2. Create client envelopes with payer report payloads and verify they match with the correct topic kinds.

Why make this change?

This change extends the envelope system to support payer reports and their attestations, which are needed for payment verification and reporting functionality. The envelope system needs to properly match these new payload types with their corresponding topics to ensure messages are routed correctly.

Summary by CodeRabbit

• New Features

  • Expanded message processing to support additional report and attestation types, enhancing how diverse data is managed.
  • Improved topic categorization to align with these new data types.

• Tests

  • Added a scenario to verify that the system correctly handles cases where the data type does not match the expected topic.

[coderabbitai[bot]]

"""

Walkthrough

The pull request extends the envelope handling functionality by modifying the TopicMatchesPayload method in the client envelope to support two new payload types: PayerReport and PayerReportAttestation. Corresponding topic constants and string representations are added in the topic package. A new test case is introduced to verify that a mismatch between an envelope payload and an incorrect topic is properly identified without error.

Changes

File(s)	Summary
pkg/envelopes/client.go pkg/envelopes/envelopes_test.go	Extended TopicMatchesPayload to support PayerReport and PayerReportAttestation payload types and added a test case for handling a topic mismatch with a PayerReport payload.
pkg/topic/topic.go	Added two new topic constants (TOPIC_KIND_PAYER_REPORTS_V1 and TOPIC_KIND_PAYER_REPORT_ATTESTATIONS_V1) and updated the String() method to include their string representations.

Sequence Diagram(s)

sequenceDiagram
    participant CE as ClientEnvelope
    participant P as Payload
    participant T as TopicKind

    CE->>+CE: Invoke TopicMatchesPayload(P, targetTopic)
    alt P is PayerReport
        CE->>CE: Check targetTopic == TOPIC_KIND_PAYER_REPORTS_V1
    else P is PayerReportAttestation
        CE->>CE: Check targetTopic == TOPIC_KIND_PAYER_REPORT_ATTESTATIONS_V1
    else
        CE->>CE: Handle other payload types
    end
    CE-->>-CE: Return match result (true/false)

Possibly related PRs

• xmtp/xmtpd#248: Contains enhancements to the PublishClientEnvelopes method and introduces tests for the PayerApiService, sharing functionality related to handling PayerReport payloads and topic associations.

Suggested reviewers

• richardhuaaa
• mkysel """

[!TIP]

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 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 3d4363ca3f10507be9749009a5cce8aee72a17b7 and d60a6c62042b72d52219a00b08a6fbea0b6ce863.

📒 Files selected for processing (3)

• pkg/envelopes/client.go (1 hunks)
• pkg/envelopes/envelopes_test.go (1 hunks)
• pkg/topic/topic.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• pkg/topic/topic.go
• pkg/envelopes/client.go
• pkg/envelopes/envelopes_test.go

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

• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Code Review

✨ 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:

• 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

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]

[!WARNING] This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite. Learn more

• #760 : 2 dependent PRs (#761 , #764 )
• #703
• #702 👈 (View in Graphite)
• #701
• #700
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• Queue - adds this PR to the back of the merge queue
• Hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

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

[macroscopeapp[bot]]

Add PayerReport and PayerReportAttestation envelope types to the TopicMatchesPayload validation in ClientEnvelope

• Adds support for PayerReport and PayerReportAttestation payload types in client.go by extending the TopicMatchesPayload function
• Introduces new TOPIC_KIND_PAYER_REPORTS_V1 and TOPIC_KIND_PAYER_REPORT_ATTESTATIONS_V1 constants in topic.go
• Adds test coverage in envelopes_test.go for payload type validation with mismatched topics

📍Where to Start

Start with the TopicMatchesPayload function in client.go which contains the core logic for validating the new envelope types against their corresponding topics.

---

Macroscope summarized d60a6c6.

[graphite-app[bot]]

Merge activity

• May 8, 8:02 AM PDT: neekolas added this pull request to the Graphite merge queue.
• May 8, 8:03 AM PDT: CI is running for this pull request on a draft pull request (#770) due to your merge queue CI optimization settings.
• May 8, 8:04 AM PDT: Merged by the Graphite merge queue via draft PR: #770.