Skip to content

refactor: clean op signer #6249

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 8 commits into
base: develop
Choose a base branch
from

Conversation

fdefelici
Copy link
Contributor

Description

BurnchainOpSigner is consistently configured to be disposed of explicitly via the BurnchainOpSigner::dispose() method.
Therefore, the logic for automatically disposing of it during signing operations can be safely removed.

Also add test coverage for BurnchainOpSigner

Applicable issues

Additional info (benefits, drawbacks, caveats)

Checklist

  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo
  • New integration test(s) added to bitcoin-tests.yml

@fdefelici fdefelici self-assigned this Jul 3, 2025
@fdefelici fdefelici changed the base branch from master to develop July 3, 2025 14:11
@fdefelici fdefelici moved this to Status: 💻 In Progress in Stacks Core Eng Jul 4, 2025
@fdefelici fdefelici added this to the 3.1.0.0.14 milestone Jul 4, 2025
@fdefelici fdefelici marked this pull request as ready for review July 4, 2025 15:32
@fdefelici fdefelici requested review from a team as code owners July 4, 2025 15:32
Copy link

codecov bot commented Jul 4, 2025

Codecov Report

Attention: Patch coverage is 87.50000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 82.04%. Comparing base (381ee9b) to head (ea2c239).
Report is 16 commits behind head on develop.

Files with missing lines Patch % Lines
stacks-node/src/tests/epoch_21.rs 0.00% 4 Missing ⚠️
stacks-node/src/main.rs 0.00% 2 Missing ⚠️
stacks-node/src/keychain.rs 50.00% 1 Missing ⚠️
stacks-node/src/operations.rs 98.07% 1 Missing ⚠️
stacks-node/src/tests/signer/v0.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #6249      +/-   ##
===========================================
- Coverage    82.10%   82.04%   -0.06%     
===========================================
  Files          546      546              
  Lines       347235   347268      +33     
  Branches       323      323              
===========================================
- Hits        285088   284933     -155     
- Misses       62139    62327     +188     
  Partials         8        8              
Files with missing lines Coverage Δ
...-node/src/burnchains/bitcoin_regtest_controller.rs 76.88% <ø> (-0.16%) ⬇️
stacks-node/src/tests/nakamoto_integrations.rs 86.73% <100.00%> (-0.25%) ⬇️
stacks-node/src/tests/neon_integrations.rs 69.02% <100.00%> (+3.44%) ⬆️
stacks-node/src/keychain.rs 81.23% <50.00%> (ø)
stacks-node/src/operations.rs 93.18% <98.07%> (+20.45%) ⬆️
stacks-node/src/tests/signer/v0.rs 38.04% <0.00%> (-1.69%) ⬇️
stacks-node/src/main.rs 0.00% <0.00%> (ø)
stacks-node/src/tests/epoch_21.rs 0.00% <0.00%> (ø)

... and 40 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 381ee9b...ea2c239. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aldur aldur requested review from Jiloc and rdeioris July 7, 2025 15:17
Jiloc
Jiloc previously approved these changes Jul 9, 2025
Copy link
Contributor

@Jiloc Jiloc left a comment

Choose a reason for hiding this comment

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

lgtm!

rdeioris
rdeioris previously approved these changes Jul 10, 2025
@Jiloc Jiloc added this pull request to the merge queue Jul 10, 2025
@wileyj wileyj removed this pull request from the merge queue due to a manual request Jul 10, 2025
@fdefelici fdefelici dismissed stale reviews from rdeioris and Jiloc via bdff47b July 10, 2025 15:55
@fdefelici
Copy link
Contributor Author

I had to manage a merge conflict, so re-approval is needed @rdeioris @Jiloc

@fdefelici fdefelici requested review from rdeioris and Jiloc July 11, 2025 07:35
Jiloc
Jiloc previously approved these changes Jul 11, 2025
Copy link
Contributor

@Jiloc Jiloc left a comment

Choose a reason for hiding this comment

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

lgtm!

@fdefelici fdefelici force-pushed the refactor/clean-op-signer branch from bdff47b to ea2c239 Compare July 11, 2025 14:03
@fdefelici fdefelici moved this from Status: 💻 In Progress to Status: In Review in Stacks Core Eng Jul 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Status: In Review
Development

Successfully merging this pull request may close these issues.

refactor: BurnchainOpSigner cleanup
3 participants