Skip to content

docs: clarify governance proposal fee is a burn, not collateral#566

Merged
thephez merged 2 commits intodashpay:masterfrom
thepastaclaw:fix-governance-collateral-terminology
Feb 16, 2026
Merged

docs: clarify governance proposal fee is a burn, not collateral#566
thephez merged 2 commits intodashpay:masterfrom
thepastaclaw:fix-governance-collateral-terminology

Conversation

@thepastaclaw
Copy link
Contributor

@thepastaclaw thepastaclaw commented Feb 16, 2026

Summary

The governance proposal fee transaction uses OP_RETURN, making the fee an unrecoverable coin burn. The documentation previously described this as "collateral," which incorrectly implies the funds are staked or recoverable.

Changes

  • Updated the nCollateralHash field description to clarify the fee is a coin burn via OP_RETURN
  • Added a note explaining the historical naming of nCollateralHash vs. actual behavior
  • Changed "requires a collateral transaction - 1 Dash" to "requires a fee of 1 Dash, burned via OP_RETURN"
  • Updated annotated hexdump descriptions to say "Fee Tx Hash" instead of "Collateral Hash"

No protocol field names were changed — only descriptions and comments were updated.

Fixes #551

Preview build: https://dash-docs--566.org.readthedocs.build/en/566/

Build output (Sphinx)
$ make html
build succeeded, 177 warnings.
The HTML pages are in _build/html.

All 177 warnings are pre-existing and unrelated to this PR:

  • git.too_shallow warnings (shallow clone, no git timestamps for source files)
  • myst.xref_missing warnings (DIP README cross-reference targets in docs/core/dips/)
  • RemovedInSphinx90Warning deprecation notices from hoverxref extension

No new warnings or errors introduced by this change.

Environment: Python 3.14.3, Sphinx 8.1.3, macOS (arm64)

The governance proposal fee transaction uses OP_RETURN, making the fee
an unrecoverable coin burn. Update descriptions to reflect this while
preserving the historical protocol field name 'nCollateralHash'.

Fixes dashpay#551
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@thephez
Copy link
Collaborator

thephez commented Feb 16, 2026

This is okay, but I not comprehensive. Proposal collateral is certainly mentioned more in the docs.

@thepastaclaw
Copy link
Contributor Author

Good point — I'll do a more thorough pass to catch the other mentions of "proposal collateral" throughout the docs. Want me to update this PR with a broader sweep, or open a separate one?

@thephez
Copy link
Collaborator

thephez commented Feb 16, 2026

Keep it all in this PR

…r proposals

Replace misleading 'collateral' terminology with 'fee' or 'burn' in the
governance usage guide. Proposal fees are permanent coin burns via
OP_RETURN, not recoverable collateral. Masternode collateral references
(1000 DASH) are left unchanged as those are actual collateral.
@thepastaclaw
Copy link
Contributor Author

Done — pushed a second commit that updates all the proposal-related "collateral" references in docs/user/governance/using.rst:

  • "Preparing the collateral" → "Preparing the proposal fee"
  • "collateral fee" → "proposal fee"
  • "collateral transaction" → "fee transaction"
  • "spending 1 DASH as collateral" → "burning 1 DASH as the proposal fee"
  • etc.

Left the masternode collateral references (1000 DASH) untouched — those are actual collateral.

Copy link
Collaborator

@thephez thephez left a comment

Choose a reason for hiding this comment

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

LGTM. Builds fine locally 👍

@thephez thephez merged commit 251f09c into dashpay:master Feb 16, 2026
1 check 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.

2 participants