xmtpd icon indicating copy to clipboard operation
xmtpd copied to clipboard

Add Payer Report protos

Open neekolas opened this issue 8 months ago • 3 comments

tl;dr

  • Updates protos to include new Payer Report types

neekolas avatar Apr 04 '25 23:04 neekolas

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

:no_entry: Files ignored due to path filters (4)
  • pkg/proto/openapi/xmtpv4/envelopes/payer_report.swagger.json is excluded by !pkg/proto/**
  • pkg/proto/openapi/xmtpv4/payer_api/payer_api.swagger.json is excluded by !pkg/proto/**
  • pkg/proto/xmtpv4/envelopes/envelopes.pb.go is excluded by !**/*.pb.go, !pkg/proto/**
  • pkg/proto/xmtpv4/envelopes/payer_report.pb.go is excluded by !**/*.pb.go, !pkg/proto/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

coderabbitai[bot] avatar Apr 04 '25 23:04 coderabbitai[bot]


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.

neekolas avatar Apr 04 '25 23:04 neekolas

Add payer report protocol buffer definitions to enable payer reporting functionality in the XMTP v4 protocol

Introduces new protocol buffer definitions for payer reporting in the XMTP v4 protocol:

  • Adds new PayerReport message type in payer_report.pb.go containing originator node ID, sequence range, merkle root, and active nodes
  • Adds new PayerReportAttestation message type for report verification with report ID and signature fields
  • Extends ClientEnvelope message in envelopes.pb.go to support payer report payloads
  • Adds corresponding OpenAPI/Swagger specifications in payer_report.swagger.json and payer_api.swagger.json

📍Where to Start

Start with the core payer report message definitions in payer_report.pb.go which defines the fundamental data structures.


Macroscope summarized a4918db.

macroscopeapp[bot] avatar Apr 04 '25 23:04 macroscopeapp[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.

graphite-app[bot] avatar May 08 '25 15:05 graphite-app[bot]