Add fees to UnsignedOriginatorEnvelope

[neekolas]

TL;DR

Added fee-related fields to message envelopes. Populates them using a FixedRateFetcher which uses hard-coded rates. This will have to do until we can get rates from a smart contract.

What changed?

• Added base_fee_picodollars and congestion_fee_picodollars fields to UnsignedOriginatorEnvelope
• Added target_originator field to PayerEnvelope
• Added corresponding getter methods for fee fields in Go code
• Updated protobuf generation to use nm/add-fees branch instead of main

How to test?

1. Run ./dev/gen-protos to verify protobuf generation works with new branch
2. Verify new fee fields are accessible through the Go API
3. Verify target_originator field is properly serialized/deserialized

Why make this change?

To support fee calculation and payment functionality in the messaging system, allowing for base fees and congestion-based pricing while maintaining proper message routing through originators.

Summary by CodeRabbit

• Chores

  • Updated the protocol definition generation process to source the latest specifications.

• New Features

  • Introduced new fee display capabilities, providing clear details on base and congestion fee amounts.

[coderabbitai]

Warning

Rate limit exceeded

@neekolas has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 242069b and 0078ca4.

⛔ 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 (12)

• pkg/api/message/publishWorker.go (6 hunks)
• pkg/api/message/publish_test.go (2 hunks)
• pkg/api/message/service.go (5 hunks)
• pkg/constants/constants.go (1 hunks)
• pkg/db/queries.sql (1 hunks)
• pkg/db/queries/queries.sql.go (3 hunks)
• pkg/envelopes/unsignedOriginator.go (2 hunks)
• pkg/registrant/registrant.go (2 hunks)
• pkg/registrant/registrant_test.go (3 hunks)
• pkg/server/server.go (3 hunks)
• pkg/testutils/api/api.go (3 hunks)
• pkg/testutils/fees/rates.go (1 hunks)

Walkthrough

The pull request updates the protobuf generation script and enhances the envelope structure. The script in dev/gen-protos now generates protobuf definitions from the nm/add-fees branch instead of main. Additionally, two new methods—BaseFee() and CongestionFee()—are added to the UnsignedOriginatorEnvelope struct in pkg/envelopes/unsignedOriginator.go to retrieve fee values from its proto field using the currency.PicoDollar type.

Changes

File(s)	Change Summary
dev/gen-protos	Modified the script to generate protobuf definitions from the nm/add-fees branch instead of the main branch at the remote repository.
pkg/envelopes/unsignedOriginator.go	Added methods BaseFee() and CongestionFee() to access fee values from the proto field as currency.PicoDollar; added import for currency.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Envelope as UnsignedOriginatorEnvelope

    Client->>+Envelope: BaseFee()
    Note right of Envelope: Access proto.BaseFeePicodollars
    Envelope-->>-Client: currency.PicoDollar (base fee)

    Client->>+Envelope: CongestionFee()
    Note right of Envelope: Access proto.CongestionFeePicodollars
    Envelope-->>-Client: currency.PicoDollar (congestion fee)

Loading

---

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

• Change payer envelope to bytes field #553
• Track unsettled usage #549
• Add fees to UnsignedOriginatorEnvelope #548 👈 (View in Graphite)
• Add fee calculation helpers #537
• Link payer to gateway envelopes #536 : 1 other dependent PR (#552 )
• Add payers table #535
• Fix foundry version check #534
• main

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

pkg/envelopes/unsignedOriginator.go (1)

54-57: LGTM! Consider adding tests.

The CongestionFee() method is well-implemented, following the same pattern as BaseFee(). Consider adding unit tests to verify both fee methods work correctly with various fee values.

Would you like me to help generate unit tests for both fee methods?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 13eca3f and 242069b.

⛔ Files ignored due to path filters (3)

• pkg/proto/openapi/xmtpv4/message_api/message_api.swagger.json is excluded by !pkg/proto/**
• pkg/proto/openapi/xmtpv4/message_api/misbehavior_api.swagger.json is excluded by !pkg/proto/**
• pkg/proto/xmtpv4/envelopes/envelopes.pb.go is excluded by !**/*.pb.go, !pkg/proto/**

📒 Files selected for processing (2)

• dev/gen-protos (1 hunks)
• pkg/envelopes/unsignedOriginator.go (2 hunks)

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

• GitHub Check: Build pre-baked anvil-xmtpd
• GitHub Check: Test (Node)

🔇 Additional comments (3)

dev/gen-protos (1)

4-4: Verify the branch usage for protobuf generation.

The script now generates protobuf definitions from the nm/add-fees branch instead of main. Please ensure that:

1. The branch contains stable protobuf definitions.
2. There is a plan to merge these changes back to main to avoid depending on a feature branch.

pkg/envelopes/unsignedOriginator.go (2)

6-6: LGTM!

The added import for the currency package is necessary for the new fee methods.

---

49-52: LGTM!

The BaseFee() method is well-implemented:

• Returns the correct type (currency.PicoDollar).
• Safely accesses the proto field (nil check in constructor).
• Clear and focused implementation.