Skip to content

itest: RegisterSpendNtfn detects reorgs #10083

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

starius
Copy link
Collaborator

@starius starius commented Jul 16, 2025

Change Description

Added itest "reorg_notifications" which tests that RegisterSpendNtfn behaves as expected during a reorg. A reorg notification is produced after a reorg affects the block which has produced a spending notification for this registration.

Steps to Test

make itest icase='reorg_notifications'
make itest icase='reorg_notifications' backend=btcd
make itest icase='reorg_notifications' backend=neutrino

Pull Request Checklist

Testing

  • Your PR passes all CI checks.
  • Tests covering the positive and negative (error paths) are included.
  • Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @starius, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a crucial integration test to validate the robustness of the RegisterSpendNtfn RPC in handling blockchain reorgs. The new test case meticulously simulates a reorg event to ensure that clients watching for spending notifications are correctly informed when a confirmed transaction is invalidated and potentially replaced by an alternative transaction on the new chain. This enhances the reliability of chain monitoring within the system.

Highlights

  • New Integration Test: I've added a new integration test, testReorgNotifications, to verify the behavior of the RegisterSpendNtfn RPC during blockchain reorgs. This test ensures that the system correctly issues reorg notifications when a previously confirmed spending transaction is unconfirmed due to a chain reorganization.
  • Reorg Notification Verification: The test specifically simulates a scenario where an output is spent by one transaction (tx2b), which is then confirmed. After receiving the spending notification, a reorg is triggered that unconfirms tx2b. The test then asserts that a reorg notification is received by the RegisterSpendNtfn client.
  • Alternative Spending Confirmation: Following the reorg and the reorg notification, the test confirms an alternative transaction (tx2a) that also spends the same output. It then verifies that a new spending notification is correctly issued for this newly confirmed transaction.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

Added itest "reorg_notifications" which tests that RegisterSpendNtfn behaves as
expected during a reorg. A reorg notification is produced after a reorg affects
the block which has produced a spending notification for this registration.
@starius starius force-pushed the reorg-notif-itest3 branch from 7c14269 to 2e214d6 Compare July 16, 2025 03:36
@starius starius marked this pull request as ready for review July 16, 2025 04:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant