docs: update masternode setup and maintenance for ext addr #533
Conversation
WalkthroughDocumentation updates: replaced legacy ipAndPort with coreP2PAddrs (added Evonode address fields), revised BLS legacy guidance to recommend generating a new basic-scheme BLS key, clarified ProReg/ProUp/ProRev argument text and examples, adjusted islock → isdlock terminology and cycleHash semantics, and added a help-parsing script update feature. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant CLI as stdout / pipe
participant Script as core-help-parsing.sh
participant File as Target markdown file
CLI->>Script: send help text (stdin)
alt no --update
Script->>CLI: format via process_help_output()
Script->>CLI: print formatted markdown
else --update FILE
Script->>Script: process_help_output() -> formatted block
Script->>File: read existing FILE
Script->>File: validate target & locate "### Options" section
Script->>File: replace Options block with formatted block
Script->>File: write temp -> atomically replace FILE
Script->>CLI: print success message
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (7)
💤 Files with no reviewable changes (2)
✅ Files skipped from review due to trivial changes (1)
🧰 Additional context used🧠 Learnings (4)📓 Common learnings📚 Learning: 2025-11-10T18:51:37.016ZApplied to files:
📚 Learning: 2025-11-10T19:11:33.355ZApplied to files:
📚 Learning: 2025-11-10T17:22:58.160ZApplied to files:
🔇 Additional comments (6)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/user/masternodes/maintenance.rst (1)
165-176: Inconsistent formatting for backwards-compatibility note.The note at lines 165-167 is formatted as inline text, while the similar note for regular masternodes (lines 122-126) uses proper RST note-box formatting. For consistency and clarity, both should use the same formatting style.
Apply this diff to add proper RST note formatting:
Where: - As of Dash Core v23.0, ``coreP2PAddrs``, ``platformP2PAddrs``, and - ``platformHTTPSAddrs`` fields accept backwards-compatible input. +.. note:: + + As of Dash Core v23.0, ``coreP2PAddrs``, ``platformP2PAddrs``, and + ``platformHTTPSAddrs`` fields accept backwards-compatible input. +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/user/masternodes/maintenance.rst(6 hunks)docs/user/masternodes/setup-testnet.rst(1 hunks)docs/user/masternodes/setup.rst(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
📚 Learning: 2025-11-10T18:51:37.016Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Applied to files:
docs/user/masternodes/setup.rstdocs/user/masternodes/setup-testnet.rstdocs/user/masternodes/maintenance.rst
📚 Learning: 2025-11-10T17:22:58.160Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Applied to files:
docs/user/masternodes/setup.rst
📚 Learning: 2025-11-10T19:11:33.355Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1702-1704
Timestamp: 2025-11-10T19:11:33.355Z
Learning: Repo: dashpay/docs — For ListDescriptors RPC, document Parameter #1 `private` (bool, default false) and note that `mnemonic` and `mnemonicpassphrase` appear only when `private=true` and the wallet was created with a mnemonic. Both fields are strings per Dash Core v23.0 help (scripts/core-rpc-tools/dash-cli-help-23.0.0.jsonl).
Applied to files:
docs/user/masternodes/setup.rst
📚 Learning: 2025-11-10T17:45:04.767Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
Applied to files:
docs/user/masternodes/setup-testnet.rstdocs/user/masternodes/maintenance.rst
🔇 Additional comments (5)
docs/user/masternodes/setup.rst (1)
562-586: ✓ Deprecation guidance and argument descriptions align well with backwards-compatibility messaging.The reworded warning (lines 562-566) appropriately redirects users to generate a new basic scheme BLS key instead of using the deprecated legacy path. The added note (lines 571-574) clarifies that
coreP2PAddrsaccepts backwards-compatible input, and the reformatted argument descriptions (lines 575-586) now use consistent inline code formatting for parameter names and clearer wrapping. This aligns with the v23.0 backwards-compatibility model documented in the learnings.docs/user/masternodes/setup-testnet.rst (1)
494-513: ✓ Consistent messaging and formatting aligned with setup.rst.The warning and argument descriptions have been updated in parallel with the setup.rst file, maintaining consistent guidance across both mainnet and testnet documentation. The backwards-compatibility note for
coreP2PAddrsand inline code formatting match the pattern established in the setup guide.docs/user/masternodes/maintenance.rst (3)
174-175:⚠️ Example syntax for platformP2PAddrs and platformHTTPSAddrs may not match description.The argument descriptions at lines 174-175 state that
platformP2PAddrsandplatformHTTPSAddrsshould be "Array of addresses in the form 'ADDR:PORT'". However, the example at line 186 shows:... 972a33056d57359de8acfa4fb8b29dc1c14f76b8 26656 443 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhuThis appears to pass raw port numbers (
26656and443) rather than array-formatted addresses like'["127.0.0.1:26656"]'and'["127.0.0.1:443"]'. This is inconsistent with the documented format requirement.Please verify whether the example syntax at line 186 is correct per Dash Core v23.0 behavior, or if it should be updated to match the array format described at lines 174-175. Based on the backwards-compatibility learning note, these fields may accept multiple formats (number/string/array), which could explain the discrepancy—if so, please add clarification to the description.
Also applies to: 186-186
210-225: ✓ Deprecation guidance and argument descriptions updated consistently.The warning at lines 210-215 now directs users to generate a new basic scheme BLS key instead of using
protx update_registrar_legacy, consistent with the messaging in setup.rst and setup-testnet.rst. The updated argument descriptions (lines 220-225) now clearly indicate that empty string""can be used to retain the last on-chain value for operatorKeyAddr, votingKeyAddr, and payoutAddress, improving clarity for operators.
253-253: ✓ feeSourceAddress description clarified for ProUpRevTx.The updated description now explicitly states that if
feeSourceAddressis not specified,operatorPayoutAddresswill be used. This is a helpful clarification for operators performing revocation transactions.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/user/masternodes/maintenance.rst(6 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
📚 Learning: 2025-11-10T17:45:04.767Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
Applied to files:
docs/user/masternodes/maintenance.rst
📚 Learning: 2025-11-10T18:51:37.016Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Applied to files:
docs/user/masternodes/maintenance.rst
🔇 Additional comments (2)
docs/user/masternodes/maintenance.rst (2)
175-177: Clarify example format for platform address fields.The description specifies platformP2PAddrs and platformHTTPSAddrs should be "Array of addresses in the form 'ADDR:PORT'" (lines 175-176), but the example at line 187 shows only port numbers (
26656and443). While backwards compatibility may accept port-only format, the example should match the documented format to avoid user confusion.Consider updating the example to show the full ADDR:PORT format:
- protx update_service_evo d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a '["140.82.59.51:10002"]' 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 972a33056d57359de8acfa4fb8b29dc1c14f76b8 26656 443 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu + protx update_service_evo d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a '["140.82.59.51:10002"]' 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 972a33056d57359de8acfa4fb8b29dc1c14f76b8 '["140.82.59.51:26656"]' '["140.82.59.51:443"]' yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhuBased on retrieved learnings about backwards compatibility constraints in v23.0.0.
Also applies to: 187-187
122-138: Clear and well-organized parameter documentation for regular masternodes.The backwards-compatibility note is properly positioned, and parameter descriptions clearly indicate which fields are optional and what defaults apply. The deprecation guidance in the ProUpRegTx section is also well-structured.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/core/reference/p2p-network-instantsend-messages.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
🔇 Additional comments (2)
docs/core/reference/p2p-network-instantsend-messages.md (2)
57-57: Terminology and protocol versioning updates are clear.Lines 57, 61, and 62 update field descriptions with improved terminological precision:
- Line 57 correctly shifts from "islock" to "isdlock" in version field description
- Line 61 adds explicit protocol version context (70237) and clarifies the semantic shift in cycleHash meaning, with backward compatibility note
- Line 62 specifies "basic BLS scheme" for signature serialization
These updates enhance clarity for protocol consumers. The unchanged hex dump example remains consistent with these descriptions.
Also applies to: 61-61, 62-62
47-62: No issues found—documentation is consistent.All references to isdlock terminology, protocol versions (70237, 70220, 70231), and the request ID calculation are consistent across related documentation files. The islock references are properly scoped to the deprecated messages file, and cross-references between current and deprecated docs are correct.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/user/masternodes/maintenance.rst(6 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
📚 Learning: 2025-11-10T17:45:04.767Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-evo.md:1493-1494
Timestamp: 2025-11-10T17:45:04.767Z
Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.
Applied to files:
docs/user/masternodes/maintenance.rst
📚 Learning: 2025-11-10T18:51:37.016Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Applied to files:
docs/user/masternodes/maintenance.rst
📚 Learning: 2025-11-10T17:22:58.160Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Applied to files:
docs/user/masternodes/maintenance.rst
📚 Learning: 2025-11-10T19:11:33.355Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1702-1704
Timestamp: 2025-11-10T19:11:33.355Z
Learning: Repo: dashpay/docs — For ListDescriptors RPC, document Parameter #1 `private` (bool, default false) and note that `mnemonic` and `mnemonicpassphrase` appear only when `private=true` and the wallet was created with a mnemonic. Both fields are strings per Dash Core v23.0 help (scripts/core-rpc-tools/dash-cli-help-23.0.0.jsonl).
Applied to files:
docs/user/masternodes/maintenance.rst
🔇 Additional comments (3)
docs/user/masternodes/maintenance.rst (3)
118-148: ProUpServTx syntax and documentation for Regular masternodes looks good.The command syntax, backwards-compatibility note, and example are consistent and clearly documented.
211-226: Updated BLS deprecation guidance is clear and actionable.The new warning (lines 213–216) appropriately directs users to generate a basic scheme BLS key and references the BLS generation instructions, replacing the older approach. Parameter descriptions are well-clarified with last-on-chain value semantics.
187-187: Fix the example to match documented parameter format for platformP2PAddrs and platformHTTPSAddrs.Lines 175–176 document that
platformP2PAddrsandplatformHTTPSAddrsshould be "Array of addresses in the form 'ADDR:PORT'", but the example on line 187 shows only port numbers (26656 443). This mismatches the documented format and creates inconsistency withcoreP2PAddrs, which correctly uses the array format in the same example.Update the example to:
- protx update_service_evo d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a '["140.82.59.51:10002"]' 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 972a33056d57359de8acfa4fb8b29dc1c14f76b8 26656 443 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu + protx update_service_evo d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a '["140.82.59.51:10002"]' 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 972a33056d57359de8acfa4fb8b29dc1c14f76b8 '["140.82.59.51:26656"]' '["140.82.59.51:443"]' yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu⛔ Skipped due to learnings
Learnt from: thephez Repo: dashpay/docs PR: 525 File: docs/core/api/remote-procedure-calls-evo.md:1493-1494 Timestamp: 2025-11-10T17:45:04.767Z Learning: In docs/core/api/remote-procedure-calls-evo.md, the platformHTTPSAddrs parameter in ProTx commands (like protx register_fund_evo) has type `number/string/array` because Dash Core v23.0.0 maintains backwards compatibility by still accepting just a port number (the old platformHTTPPort format), in addition to accepting the new string or array of strings in `ADDR:PORT` format.Learnt from: thephez Repo: dashpay/docs PR: 525 File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738 Timestamp: 2025-11-10T18:51:37.016Z Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.Learnt from: thephez Repo: dashpay/docs PR: 525 File: docs/core/api/remote-procedure-call-quick-reference.md:34-34 Timestamp: 2025-11-10T17:22:58.160Z Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Script now can take help output and directly update the markdown file
1 participant
Preview build: https://dash-docs--533.org.readthedocs.build/en/533/
Summary by CodeRabbit