Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(explorer): fix the amount in withdraw parity test #3370

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

ChiTimesChi
Copy link
Collaborator

@ChiTimesChi ChiTimesChi commented Nov 5, 2024

Description
A clear and concise description of the features you're adding in this pull request.

Additional context
Add any other context about the problem you're solving.

Metadata

  • Fixes #[Link to Issue]

Summary by CodeRabbit

  • New Features

    • Enhanced calculation of transaction amounts during withdrawal and minting, now accounting for fees.
    • Inclusion of the fee field in the transaction records for better transparency.
  • Bug Fixes

    • Updated method signatures to improve error handling during transaction processing.

@ChiTimesChi ChiTimesChi requested a review from trajan0x as a code owner November 5, 2024 13:01
Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The changes in this pull request primarily modify the withdrawParity and mintParity methods within the BackfillSuite struct in the chain_test.go file. The adjustments focus on how the Amount field for the BridgeEvent model is calculated, now reflecting the difference between parsedLog.Amount and parsedLog.Fee. This change is applied to both V1 and non-V1 parsing logic. Additionally, the Fee field has been explicitly included in the model for both methods, along with minor formatting and comment updates.

Changes

File Path Change Summary
services/explorer/backfill/chain_test.go Updated withdrawParity and mintParity methods to calculate Amount as parsedLog.Amount - parsedLog.Fee. Included Fee in BridgeEvent model. Adjusted method signatures to return error. Minor comments and formatting changes.

Possibly related PRs

  • fix withdrawal api [SLT-365] #3306: The changes in the Withdraw method involve handling amounts related to transactions, which is conceptually similar to the adjustments made in the withdrawParity method regarding the calculation of amounts and fees in the main PR.

Suggested labels

Typescript

Suggested reviewers

  • aureliusbtc
  • dwasse

Poem

In the land of code where rabbits play,
Amounts and fees dance in a new way.
With every log and parsed delight,
We calculate right, oh what a sight!
Hopping through changes, we cheer and sing,
For a brighter future, our code will bring! 🐇✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7c5c4f1 and 5651c23.

📒 Files selected for processing (1)
  • services/explorer/backfill/chain_test.go (4 hunks)
🔇 Additional comments (1)
services/explorer/backfill/chain_test.go (1)

Line range hint 872-882: LGTM: Correct implementation of fee subtraction in withdraw parity test.

The change properly calculates the net amount by subtracting the fee from the total amount, which is the expected behavior for withdraw operations. This fix ensures that the test accurately verifies the actual amount received after fees.

Also applies to: 906-916


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

@github-actions github-actions bot added go Pull requests that update Go code size/xs labels Nov 5, 2024
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@7c5c4f1). Learn more about missing BASE report.
Report is 4 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##             master      #3370   +/-   ##
===========================================
  Coverage          ?   9.59066%           
===========================================
  Files             ?        188           
  Lines             ?      19519           
  Branches          ?         82           
===========================================
  Hits              ?       1872           
  Misses            ?      17447           
  Partials          ?        200           
Flag Coverage Δ
explorer 4.97617% <ø> (?)
promexporter 6.81642% <ø> (?)

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.

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5651c23
Status: ✅  Deploy successful!
Preview URL: https://160bc4f4.sanguine-fe.pages.dev
Branch Preview URL: https://test-fix-explorer-withdraw-a.sanguine-fe.pages.dev

View logs

@ChiTimesChi ChiTimesChi merged commit f09281b into master Nov 5, 2024
31 checks passed
@ChiTimesChi ChiTimesChi deleted the test/fix-explorer-withdraw-amount branch November 5, 2024 13:37
ChiTimesChi added a commit that referenced this pull request Nov 5, 2024
ChiTimesChi added a commit that referenced this pull request Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go Pull requests that update Go code size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant