fix: safe eth requirement

[leoslr]

Description of the changes

When checking the eth balance, we should enforce a balance higher than the given amount only when needsGas if true.
This prevent user from paying (e.g. from Safe) when their balance is exactly the same as the amoutn they have to pay.

Summary by CodeRabbit

• Bug Fixes
  • Improved ETH payment solvency checks to correctly handle cases where gas is not required, allowing balances equal to the payment amount to be considered sufficient.
• Tests
  • Added test cases to verify ETH solvency logic with and without gas requirements.
  • Clarified test descriptions for ERC20 payment scenarios.

[coderabbitai]

Walkthrough

The changes update the isSolvent function in the payment processor to adjust how Ethereum (ETH) balances are checked against payment amounts, introducing a conditional based on the needsGas flag. Corresponding unit tests are added to verify this new logic, including scenarios for both values of needsGas.

Changes

File(s)	Change Summary
packages/payment-processor/src/payment/index.ts	Updated isSolvent logic: ETH balance check now allows equality when needsGas is false, otherwise requires a strictly greater balance.
packages/payment-processor/test/payment/index.test.ts	Added new ETH currency constant and two test cases for isSolvent behavior with needsGas true/false. Renamed an existing test for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant PaymentProcessor

    Caller->>PaymentProcessor: isSolvent(currency, amount, needsGas)
    alt currency is ETH
        alt needsGas is true
            PaymentProcessor->>PaymentProcessor: ethBalance.gt(amount)
        else needsGas is false
            PaymentProcessor->>PaymentProcessor: ethBalance.gte(amount)
        end
    else currency is not ETH
        PaymentProcessor->>PaymentProcessor: (other balance checks)
    end
    PaymentProcessor-->>Caller: return true/false

Loading

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ 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 d999342 and 34fa23f.

📒 Files selected for processing (2)

• packages/payment-processor/src/payment/index.ts (1 hunks)
• packages/payment-processor/test/payment/index.test.ts (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/payment-processor/test/payment/index.test.ts (2)

packages/types/src/request-logic-types.ts (1)

• ICurrency (278-285)

packages/payment-processor/src/payment/index.ts (1)

• isSolvent (251-284)

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

• GitHub Check: build-and-test

🔇 Additional comments (5)

packages/payment-processor/src/payment/index.ts (1)

278-279: LGTM: Improved ETH balance check logic to support Safe wallet payments.

The change adds a conditional check for the ETH balance requirement based on the needsGas flag. This properly addresses the issue where users with Safe wallets (or similar) were unable to make payments when their balance was exactly equal to the payment amount.

• When needsGas is true: ETH balance must be strictly greater than the required amount, ensuring room for gas
• When needsGas is false: ETH balance can be equal to the required amount, allowing exact-balance payments

This implementation correctly uses BigNumber's gt and gte methods for precise numerical comparisons.

packages/payment-processor/test/payment/index.test.ts (4)

37-41: Good addition of the ETH currency constant for test consistency.

Adding this ethCurrency constant makes the test code more maintainable and allows for consistent ETH currency representation throughout the test suite.

---

525-525: Appropriate test rename for clarity.

Renaming this test to explicitly mention "ERC20 payment" improves test readability by clearly distinguishing it from the new ETH-specific tests.

---

543-555: Good test case for ETH payments with exact balance (needsGas=false).

This test properly verifies that the isSolvent function correctly handles the case where:

1. The currency is ETH
2. The balance equals exactly the required amount (200)
3. The needsGas flag is false

The test confirms the function now returns true in this scenario, allowing payments from wallets with exact balances.

---

557-569: Good test case for ETH payments requiring excess balance (needsGas=true).

This test verifies that isSolvent still correctly enforces the stricter balance requirement when needsGas is true. It confirms the function returns false when:

1. The currency is ETH
2. The balance equals exactly the required amount (200)
3. The needsGas flag is true

This ensures the original behavior is maintained for cases where gas costs need to be considered.

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

[alexandre-abrioux]

In the PR description:

When checking the eth balance, we should enforce a baancer higher than the given amount when needsGas if false.

--> I think you meant true

LGTM 🙂 nice fix