fix(api): formatted bridge fee amount [SLT-227]

[bigboydiamonds]

Summary by CodeRabbit

• New Features

  • Updated calculation method for the bridge fee, enhancing the accuracy of fee representation in the response payload.

• Bug Fixes

  • Improved handling of decimal precision for bridge fees based on the latest token information.

[coderabbitai]

Walkthrough

The changes involve a modification in the calculation of the bridgeFeeFormatted value within the bridgeController. The source of the decimal precision for formatting the bridge fee has shifted from using the toTokenInfo.decimals to retrieving the decimals from originQueryTokenOutInfo. This adjustment introduces a dependency on the originQuery data, altering how the bridge fee is represented in the response payload while maintaining the overall structure of the payload mapping.

Changes

File	Change Summary
packages/rest-api/src/controllers/bridgeController.ts	Updated the calculation of bridgeFeeFormatted to use decimals from originQueryTokenOutInfo instead of toTokenInfo.decimals.

Poem

In the land of code where rabbits play,
A bridge fee change brightens the day.
From tokens to queries, the decimals dance,
Formatting fees now takes a new chance.
Hopping through logic, so clever and neat,
A leap for the future, oh what a treat! 🐰✨

---

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

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]

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4a0f2e7 and f2e3499.

Files selected for processing (1)

• packages/rest-api/src/controllers/bridgeController.ts (1 hunks)

Additional comments not posted (2)

packages/rest-api/src/controllers/bridgeController.ts (2)

36-43: Ensure consistent decimal usage for formatted amounts

In the payload:

• maxAmountOutStr is formatted using toTokenInfo.decimals.
• bridgeFeeFormatted is formatted using originQueryTokenOutInfo.decimals.

Verify that this difference is intentional. If both amounts represent values in the same token, consider using the same decimals for consistency.

---

41-43: Verify the correctness of using originQueryTokenOutInfo.decimals

Previously, bridgeFeeFormatted was calculated using toTokenInfo.decimals. Now it's using originQueryTokenOutInfo.decimals. Ensure that this change is intentional and that feeAmount should indeed be formatted with the decimals of originQueryTokenOutInfo.

Run the following script to confirm that feeAmount corresponds to the token obtained from originQuery.tokenOut:

Verification successful

---

Verified: Using originQueryTokenOutInfo.decimals for formatting feeAmount is correct

The change from toTokenInfo.decimals to originQueryTokenOutInfo.decimals for formatting feeAmount has been verified as correct and intentional. This modification ensures that the fee amount is formatted using the appropriate decimal precision of the bridge token, which is consistent with the implementation across the codebase.

Key points:

• feeAmount is calculated in bridge token decimals.
• originQuery and its associated information (including decimals) are closely tied to the bridge token.
• This change maintains consistency with other parts of the system that handle fee calculations and formatting.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that `feeAmount` is associated with the token represented by `originQuery.tokenOut`.

# Expected: Confirm that `feeAmount` should be formatted using `originQueryTokenOutInfo.decimals`.

# Search for code comments or documentation linking `feeAmount` and `originQuery.tokenOut`.
fd -e js -e ts | xargs rg -A 5 -B 5 'feeAmount'

Length of output: 25009

---

Script:

#!/bin/bash
# Search for the construction of originQuery and its relationship to bridgeToken
rg -A 10 -B 10 'originQuery\s*=|originQuery:'

Length of output: 86854

[coderabbitai]

Add error handling for originQueryTokenOutInfo being undefined

If tokenAddressToToken does not find a matching token, it may return undefined. Accessing originQueryTokenOutInfo.decimals without checking can lead to runtime errors. Consider adding a null check to handle this scenario gracefully.

Apply this change to ensure originQueryTokenOutInfo is defined:

const originQueryTokenOutInfo = tokenAddressToToken(
  fromChain.toString(),
  quote.originQuery.tokenOut
)

if (!originQueryTokenOutInfo) {
  throw new Error(`Token not found for address: ${quote.originQuery.tokenOut}`)
}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.95009%. Comparing base (4a0f2e7) to head (f2e3499).
Report is 16 commits behind head on master.

Additional details and impacted files

@@                 Coverage Diff                 @@
##              master       #3165         +/-   ##
===================================================
+ Coverage   36.85539%   37.95009%   +1.09470%     
===================================================
  Files            444         418         -26     
  Lines          25752       24245       -1507     
  Branches         146          82         -64     
===================================================
- Hits            9491        9201        -290     
+ Misses         15520       14306       -1214     
+ Partials         741         738          -3     

Flag	Coverage Δ
packages	90.96267% <ø> (ø)
promexporter	?
solidity	?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cloudflare-workers-and-pages]

Deploying sanguine-fe with    Cloudflare Pages

Latest commit:	f2e3499
Status:	✅  Deploy successful!
Preview URL:	https://fe7e4854.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-bridge-fee-format.sanguine-fe.pages.dev

View logs

[Defi-Moses]

Good catch, since the fee is taken in the intermediary token, that is the decimals that matter, not the final token.

Are there other places where this logic would be faulty?