Skip to content

docs: comprehensive miner and signer configuration reference#6936

Merged
simone-stacks merged 12 commits intostacks-network:developfrom
simone-stacks:docs/miner-signer-settings
Mar 14, 2026
Merged

docs: comprehensive miner and signer configuration reference#6936
simone-stacks merged 12 commits intostacks-network:developfrom
simone-stacks:docs/miner-signer-settings

Conversation

@simone-stacks
Copy link
Copy Markdown
Contributor

Description

  • Add comprehensive reference TOML configs with all settings documented (defaults, units, interaction warnings)
  • Add doc annotations (@default, @Units, @notes) to signer RawConfigFile struct
  • Add docs/signing.md signer setup guide and update docs/mining.md with signer references

Applicable issues

Checklist

  • Test coverage for new or modified code paths
  • For new Clarity features or consensus changes, add property tests (see docs/property-testing.md)
  • Changelog is updated
  • Required documentation changes (e.g., rpc/openapi.yaml for RPC endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo

@simone-stacks simone-stacks changed the base branch from master to develop February 26, 2026 14:50
Comment thread docs/signing.md Outdated
Comment thread sample/conf/mainnet-miner-conf.toml Outdated
Comment thread sample/conf/mainnet-miner-conf.toml Outdated
Comment thread sample/conf/signer/mainnet-signer-conf.toml
Comment thread sample/conf/mainnet-signer-conf.toml Outdated
Comment thread sample/conf/mainnet-signer-conf.toml Outdated
Comment thread sample/conf/mainnet-signer-conf.toml Outdated
Comment thread sample/conf/signer/mainnet-signer-conf.toml
Comment thread sample/conf/signer/mainnet-signer-conf.toml
Comment thread sample/conf/mainnet-signer-conf.toml Outdated
Comment thread sample/conf/mainnet-signer-conf.toml Outdated
jacinta-stacks
jacinta-stacks previously approved these changes Feb 27, 2026
Copy link
Copy Markdown
Contributor

@francesco-stacks francesco-stacks left a comment

Choose a reason for hiding this comment

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

lgtm!

@simone-stacks simone-stacks marked this pull request as ready for review March 5, 2026 15:33
@simone-stacks simone-stacks enabled auto-merge March 5, 2026 18:59
Copy link
Copy Markdown
Contributor

@francesco-stacks francesco-stacks left a comment

Choose a reason for hiding this comment

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

lgtm!

@simone-stacks
Copy link
Copy Markdown
Contributor Author

I had to commit new changes since CI was complaining about the config files. Basically stackslib/conf is a symlink to sample/conf, and test_example_confs parses all .toml there as node ConfigFile. mainnet-signer-conf.toml is a stacks-signer binary config with fields like stacks_private_key that don't exist in the node ConfigFile, causing the test to fail.

Moving to a signer/ subdirectory fixes this since the test uses non-recursive read_dir.

@simone-stacks
Copy link
Copy Markdown
Contributor Author

@jacinta-stacks @francesco-stacks do you think we should also have a test for the signer conf?

@simone-stacks simone-stacks added this pull request to the merge queue Mar 13, 2026
Merged via the queue into stacks-network:develop with commit 3595c00 Mar 14, 2026
1 check passed
@simone-stacks simone-stacks deleted the docs/miner-signer-settings branch March 14, 2026 00:40
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 14, 2026

Codecov Report

❌ Patch coverage is 87.50000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.93%. Comparing base (d929c52) to head (0d0b61c).
⚠️ Report is 35 commits behind head on develop.

Files with missing lines Patch % Lines
stacks-signer/src/config.rs 87.50% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #6936      +/-   ##
===========================================
+ Coverage    78.05%   84.93%   +6.87%     
===========================================
  Files          412      412              
  Lines       219938   219954      +16     
  Branches       338      338              
===========================================
+ Hits        171680   186814   +15134     
+ Misses       48258    33140   -15118     
Files with missing lines Coverage Δ
stacks-signer/src/config.rs 91.28% <87.50%> (+6.09%) ⬆️

... and 206 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 d929c52...0d0b61c. 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.

@github-actions
Copy link
Copy Markdown

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Mar 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants