Skip to content

[ADD] Fee amount usd#21

Open
LikoIlya wants to merge 9 commits intomainfrom
fee-amount-usd
Open

[ADD] Fee amount usd#21
LikoIlya wants to merge 9 commits intomainfrom
fee-amount-usd

Conversation

@LikoIlya
Copy link
Copy Markdown
Collaborator

@LikoIlya LikoIlya commented Jun 30, 2025

Summary by CodeRabbit

  • New Features

    • Added support for returning the bridge fee amount in USD in relevant API responses.
    • Introduced utilities for converting token amounts between raw and decimal representations.
  • Bug Fixes

    • None.
  • Chores

    • Updated workflows to trigger on an additional branch ("fee-amount-usd") for Docker image publishing.
    • Minor formatting improvements in receipt controller.
  • Refactor

    • Simplified and updated fee calculation logic to compute bridge fees in USD before converting to native token units.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 30, 2025

Walkthrough

The changes update GitHub Actions workflows to trigger on an additional branch, introduce and propagate bridge fee calculations in USD across the backend, and add utility functions for token decimal conversions. The API schema and controller logic are updated to include and return the USD fee amount, while some code formatting and minor refactoring are also applied.

Changes

File(s) Change Summary
.github/workflows/publish-back-core.yaml
.github/workflows/publish-indexer-evm.yaml
.github/workflows/publish-indexer-svm.yaml
Workflows now trigger on both main and fee-amount-usd branches.
backend/back-core/src/controllers/receipt.controller.ts Minor formatting: whitespace adjustment and blank line added; no logic changes.
backend/back-core/src/controllers/send-signature.controller.ts Removed address index option from mnemonic derivation; getSendSignature now includes and returns feeAmountUsd.
backend/back-core/src/fee/bridgeFee.ts Renamed and refactored function to compute bridge fee in USD only; simplified signature and logic.
backend/back-core/src/fee/fee.ts Fee calculation now in USD first, then converted to native coin; returns feeAmountUsd in result.
backend/back-core/src/fee/token-prices.ts Added convertFromDecimals and convertToDecimals utility functions for token amount conversions.
backend/back-core/src/routes/utils.ts Added feeAmountUsd property to sendPayloadResponseSchema with OpenAPI metadata.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SendSignatureController
    participant FeeModule (getFees)
    participant BridgeFee
    participant TokenPrices

    Client->>SendSignatureController: Request send signature
    SendSignatureController->>FeeModule (getFees): Calculate fees (networkFrom, networkTo, tokenAddr, amount, isMaxAmount)
    FeeModule (getFees)->>BridgeFee: getBridgeFeeUSD(tokenUsdPrice, amount, minBridgeFeeUSD)
    BridgeFee-->>FeeModule (getFees): feeAmountUsd
    FeeModule (getFees)->>TokenPrices: usd2Coin(feeAmountUsd, price)
    TokenPrices-->>FeeModule (getFees): feeAmount (native)
    FeeModule (getFees)-->>SendSignatureController: { feeAmountUsd, feeAmount, amountToSend }
    SendSignatureController-->>Client: Respond with signature and feeAmountUsd
Loading

Poem

The fee now speaks in dollars too,
A hop, a skip—conversion’s new!
From tokens raw to decimals bright,
We count the coins and get it right.
Workflows leap on branches wide,
As rabbits code with cheerful pride! 🐇💸


📜 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 5689dfa and 52396b3.

📒 Files selected for processing (2)
  • backend/back-core/src/controllers/receipt.controller.ts (2 hunks)
  • backend/back-core/src/fee/fee.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • backend/back-core/src/controllers/receipt.controller.ts
  • backend/back-core/src/fee/fee.ts
✨ 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
🪧 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants