Skip to content

Conversation

@UdjinM6
Copy link

@UdjinM6 UdjinM6 commented Jun 12, 2025

Issue being fixed or feature implemented

The issue with zmq test was discovered by @coderabbitai while reviewing #6718, see #6718 (comment)

What was done?

Use correct quorum type and hash, re-enable test_recovered_signature_publishers()

How Has This Been Tested?

Run interface_zmq_dash.py

Breaking Changes

n/a

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

@UdjinM6 UdjinM6 added this to the 23 milestone Jun 12, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jun 12, 2025

Walkthrough

The test function test_recovered_signature_publishers in test/functional/interface_zmq_dash.py was re-enabled by uncommenting its invocation. Within this test, the quorum type parameter used in relevant RPC calls was changed from 103 to 100. The process for selecting the quorum for signing was updated: instead of using a fixed quorum hash, the code now dynamically selects a quorum hash by invoking the quorum("selectquorum", 100, sign_id) RPC call and then uses this hash to determine the quorum masternodes. The quorum type parameter in signing calls was also set to 100. No changes were made to public entity declarations or signatures.

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
test/functional/interface_zmq_dash.py (1)

150-154: 🛠️ Refactor suggestion

Replace arbitrary sleep(1) with an explicit readiness / polling check

Hard-coding a 1-second delay is fragile – network or CI variance can easily make the test flaky.
Instead of sleeping, poll for the first recovered-sig CL message (or any other deterministic condition) before calling test_recovered_signature_publishers().

-        # Wait a moment to avoid subscribing to recovered sig in the test before the one from the chainlock
-        # has been sent which leads to test failure.
-        time.sleep(1)
+        # Wait until the CL recovered-sig has actually been published to ZMQ so that we
+        # do not miss it when subscribing in the next test.
+        self.wait_for_recovered_sig(
+            self.nodes[0].getbestchainlock()["requestId"],
+            self.nodes[0].getbestblockhash(),
+        )

This removes the race while keeping the intent intact.

🧹 Nitpick comments (2)
test/functional/interface_zmq_dash.py (2)

194-196: Avoid the magic number 100 – introduce a named constant for the quorum type

100 is repeated and its meaning is opaque. Define it once (LLMQ_TEST_V17, LLMQ_100_67, etc.) and reuse the symbol – this improves readability and guards against typos.

-            rpc_recovered_sig = self.mninfo[0].get_node(self).quorum('getrecsig', 100, request_id, msg_hash)
+            QUORUM_TYPE_REC_SIG = 100  # LLMQ_100_67
+            rpc_recovered_sig = self.mninfo[0].get_node(self).quorum(
+                'getrecsig', QUORUM_TYPE_REC_SIG, request_id, msg_hash
+            )

The same constant can then be reused further down (see lines 224-226).


224-226: Deduplicate quorum-type literals and keep logic self-contained

100 appears three times in the new signing block. After introducing QUORUM_TYPE_REC_SIG (previous comment), factor it in here and avoid accidental divergence.

-        quorumHash = self.nodes[0].quorum("selectquorum", 100, sign_id)["quorumHash"]
-        for mn in self.get_quorum_masternodes(quorumHash): # type: MasternodeInfo
-            mn.get_node(self).quorum("sign", 100, sign_id, sign_msg_hash)
+        quorumHash = self.nodes[0].quorum(
+            "selectquorum", QUORUM_TYPE_REC_SIG, sign_id
+        )["quorumHash"]
+
+        for mn in self.get_quorum_masternodes(quorumHash):  # type: MasternodeInfo
+            mn.get_node(self).quorum("sign", QUORUM_TYPE_REC_SIG, sign_id, sign_msg_hash)

This keeps the quorum-type consistent and self-documenting.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ee34525 and 492d678.

📒 Files selected for processing (1)
  • test/functional/interface_zmq_dash.py (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: linux64_sqlite-build / Build source
  • GitHub Check: linux64_fuzz-build / Build source
  • GitHub Check: linux64_ubsan-build / Build source
  • GitHub Check: linux64-build / Build source
  • GitHub Check: linux64_tsan-build / Build source
  • GitHub Check: linux64_multiprocess-build / Build source
  • GitHub Check: arm-linux-build / Build source
  • GitHub Check: win64-build / Build source
  • GitHub Check: linux64_nowallet-build / Build source
  • GitHub Check: x86_64-apple-darwin / Build depends

Copy link
Collaborator

@knst knst left a comment

Choose a reason for hiding this comment

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

LGTM 492d678

Copy link
Member

@PastaPastaPasta PastaPastaPasta left a comment

Choose a reason for hiding this comment

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

utACK 492d678

@PastaPastaPasta PastaPastaPasta merged commit ce682f2 into dashpay:develop Jun 20, 2025
55 of 57 checks passed
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.

3 participants