Calculate fees independently in sync

[neekolas]

Summary by CodeRabbit

• New Features

  • Integrated an enhanced fee calculation mechanism into synchronization processes, providing more accurate and consistent fee assessments during operations.

• Refactor

  • Updated internal workflows to seamlessly incorporate fee validation, ensuring improved reliability without altering existing functionality for end-users.

[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 23 minutes and 40 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 e0f7223 and 0bcc377.

📒 Files selected for processing (3)

• pkg/server/server.go (1 hunks)
• pkg/sync/server.go (2 hunks)
• pkg/sync/syncWorker.go (8 hunks)

Walkthrough

The changes integrate a fee calculation mechanism into the synchronization workflow. A new fee calculator parameter is added to the NewSyncServer functions in both the replication and sync servers, and it is passed through to the sync worker. The syncWorker struct now holds a fee calculator, and its methods have been updated to compute and validate fees during envelope processing. The new method calculateFees encapsulates the fee computation logic.

Changes

File Path	Change Summary
pkg/server/server.go	Updated the NewSyncServer call in NewReplicationServer to include a new fee calculator parameter (fees.NewFeeCalculator(getRatesFetcher())), and modified the function signature to accept feeCalculator fees.IFeeCalculator.
pkg/sync/server.go	Updated the NewSyncServer function signature to include feeCalculator fees.IFeeCalculator and modified the call to startSyncWorker to pass this new parameter.
pkg/sync/syncWorker.go	Added a new field feeCalculator fees.IFeeCalculator to syncWorker, modified startSyncWorker and insertEnvelope (adding a spendPicodollars parameter) to incorporate fee calculation, and introduced the method calculateFees to compute fees based on the envelope data.

Sequence Diagram(s)

sequenceDiagram
    participant ReplicationServer
    participant SyncServer
    participant SyncWorker
    participant FeeCalculator

    ReplicationServer->>SyncServer: NewSyncServer(ctx, log, nodeRegistry, registrant, writerDB, FeeCalculator)
    SyncServer->>SyncWorker: startSyncWorker(..., FeeCalculator)
    Note over SyncWorker: Envelope received for processing
    SyncWorker->>FeeCalculator: calculateFees(envelope)
    FeeCalculator-->>SyncWorker: Return calculated fee (spendPicodollars)
    SyncWorker->>SyncWorker: validateAndInsertEnvelope(envelope, spendPicodollars)

Loading

Possibly related PRs

• Add fee calculation helpers #537: The changes in the main PR are related to the modifications in the retrieved PR as both introduce a feeCalculator parameter to the NewSyncServer function, enhancing fee calculation functionality.

Suggested reviewers

• fbac

---

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]

• Calculate fees independently in sync #556 👈 (View in Graphite)
• Change payer envelope to bytes field #553
• Track unsettled usage #549
• Add fees to UnsignedOriginatorEnvelope #548
• 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: 1

🧹 Nitpick comments (4)

pkg/server/server.go (1)

157-157: Consider reusing a single feeCalculator instance.
Re-initializing the fee calculator on each “NewReplicationServer” might be fine for smaller workloads, but you could reuse or cache a single instance globally or per server if rates don’t change frequently. This may reduce overhead if the creation process becomes more expensive later.

pkg/sync/syncWorker.go (3)

61-61: Ensure feeCalculator is properly initialized.
When creating the worker, verify that feeCalculator fully implements all required methods and is not nil. You might handle potential initialization failures here, preventing runtime errors down the line.

Also applies to: 72-72

---

412-412: Offer help for the TODO regarding fetch from other nodes.
The comment indicates there’s a requirement to handle envelopes from other nodes. If you’d like, I can open a new issue or propose a high-level approach for multi-node fetching logic.

---

504-524: Refine fee calculation logic.
The new calculateFees method is well structured, but keep an eye on potential changes to the congestion model. The TODO indicates a future enhancement to calculate real congestion rates, which might affect performance or fairness.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 47365e0 and 23a6769.

📒 Files selected for processing (3)

• pkg/server/server.go (1 hunks)
• pkg/sync/server.go (2 hunks)
• pkg/sync/syncWorker.go (8 hunks)

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

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

🔇 Additional comments (5)

pkg/sync/server.go (2)

7-7: No concerns about new import.
Importing the fees package here is consistent with the new fee-calculation functionality.

---

27-29: Validate feeCalculator parameter.
Consider adding a safeguard to ensure feeCalculator is non-nil before passing it to the worker. A nil calculator might lead to runtime errors or undefined behavior later.

pkg/sync/syncWorker.go (3)

11-16: Imports align with fee calculation usage.
These newly added imports (constants, currency, fees) are relevant for the fee-calculation logic and don’t appear to introduce conflicts.

---

38-38: Confirm concurrency-safety of feeCalculator.
Since syncWorker is expected to handle concurrent envelope processing, ensure feeCalculator is threadsafe or used in a threadsafe manner.

---

457-460: Validate spendPicodollars parameter.
If negative or zero fees are passed, it might indicate abnormal inputs or logic. Consider adding checks to prevent incorrect usage data from persisting to the database.