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

fix: avoid false positive on multiple events in same tx #3517

Merged
merged 5 commits into from
Feb 11, 2025

Conversation

ws4charlie
Copy link
Contributor

@ws4charlie ws4charlie commented Feb 11, 2025

Description

Same event is appended twice to the event array and it results in false positive in the log print. The error message appears in local E2E tests and goes away after fix.

How Has This Been Tested?

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Summary by CodeRabbit

  • New Features
    • Enhanced chain confirmation settings to support multiple confirmation counts.
  • Bug Fixes
    • Resolved issues with duplicate event reporting and test failures across multiple blockchain operations.
    • Adjusted key operation scheduling to reduce spam.
  • Refactor
    • Reorganized core components and improved logging for clearer event tracking.
  • Tests
    • Added simulation tests to validate withdrawal operations and ballot consistency.

Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The pull request updates the changelog and source files to document and implement several changes. A new ConfirmationParams field is added to chain parameters while deprecating the confirmation_count field. The zetaclient now uses structured logging in the EVM observer (with updated log messages and a new logging field constant, FieldBlock) to improve log clarity. The changes also address issues in event processing for Bitcoin, Solana, and TON test cases, along with code refactoring that splits the Bitcoin observer and signer components.

Changes

File(s) Summary
changelog.md Updated to document new features, refactors, fixes, and tests; introduces ConfirmationParams and deprecates confirmation_count.
zetaclient/chains/evm/observer/v2_inbound.go
zetaclient/logs/fields.go
Modified logging: replaced formatted strings with structured log entries in event processing and added a new constant FieldBlock for standardized log output.

Possibly related PRs

Suggested labels

no-changelog, CONSENSUS_TESTS, UPGRADE_LIGHT_TESTS, chain:bitcoin, chain:solana, SOLANA_TESTS

Suggested reviewers

  • skosito
  • lumtis
  • gartnera
  • swift1337
  • 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
🪧 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. (Beta)
  • @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.

@ws4charlie ws4charlie changed the title fix: fix false positive on multiple events in same tx fix: avoid false positive on multiple events in same tx Feb 11, 2025
@ws4charlie ws4charlie added zetaclient Issues related to ZetaClient bug Something isn't working labels Feb 11, 2025
@ws4charlie ws4charlie marked this pull request as ready for review February 11, 2025 18:03
@ws4charlie ws4charlie requested a review from a team as a code owner February 11, 2025 18:04
Copy link

codecov bot commented Feb 11, 2025

Codecov Report

Attention: Patch coverage is 0% with 54 lines in your changes missing coverage. Please review.

Project coverage is 65.53%. Comparing base (d5b8c55) to head (05912ec).
Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
zetaclient/chains/evm/observer/v2_inbound.go 0.00% 54 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #3517      +/-   ##
===========================================
- Coverage    65.54%   65.53%   -0.01%     
===========================================
  Files          445      445              
  Lines        30570    30573       +3     
===========================================
  Hits         20036    20036              
- Misses        9680     9683       +3     
  Partials       854      854              
Files with missing lines Coverage Δ
zetaclient/chains/evm/observer/v2_inbound.go 0.00% <0.00%> (ø)

Copy link
Contributor

@kingpinXD kingpinXD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments , LGTM

@ws4charlie ws4charlie enabled auto-merge February 11, 2025 19:32
@ws4charlie ws4charlie added this pull request to the merge queue Feb 11, 2025
Merged via the queue into develop with commit c92ea7e Feb 11, 2025
44 of 45 checks passed
@ws4charlie ws4charlie deleted the fix-false-positive-multiple-events-in-same-tx branch February 11, 2025 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working zetaclient Issues related to ZetaClient
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants