docs: clarify governance proposal fee is a burn, not collateral#566
Conversation
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
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
|
This is okay, but I not comprehensive. Proposal collateral is certainly mentioned more in the docs. |
|
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? |
|
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.
|
Done — pushed a second commit that updates all the proposal-related "collateral" references in
Left the masternode collateral references (1000 DASH) untouched — those are actual collateral. |
thephez
left a comment
There was a problem hiding this comment.
LGTM. Builds fine locally 👍
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
nCollateralHashfield description to clarify the fee is a coin burn viaOP_RETURNnCollateralHashvs. actual behaviorNo 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)
All 177 warnings are pre-existing and unrelated to this PR:
git.too_shallowwarnings (shallow clone, no git timestamps for source files)myst.xref_missingwarnings (DIP README cross-reference targets indocs/core/dips/)RemovedInSphinx90Warningdeprecation notices from hoverxref extensionNo new warnings or errors introduced by this change.
Environment: Python 3.14.3, Sphinx 8.1.3, macOS (arm64)