Skip to content

Conversation

@thephez
Copy link
Collaborator

@thephez thephez commented Nov 17, 2025

Summary by CodeRabbit

  • Documentation
    • Expanded special transactions docs with explicit Version 1/2/3 distinctions for provider transactions
    • Added NetInfo Structure and described netInfo as the addressing format for Version 3+ (replacing prior ip/port/platform fields)
    • Clarified serialization and signature behavior for Version 2+ (basic BLS) and updated payload examples and versioned notes across ProRegTx, ProUpServTx, ProUpRegTx, and ProUpRevTx
    • Updated several doc links and references to point to the 22.0.0 docs and adjusted a maintenance note for platformP2PAddrs wording

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

@coderabbitai
Copy link

coderabbitai bot commented Nov 17, 2025

Walkthrough

Provider transaction docs updated to document Versions 1–3, introduce a Version 3+ netInfo structure (replacing ipAddress/port and platform-specific fields), and adjust serialization and BLS/version notes across ProRegTx, ProUpServTx, ProUpRegTx, ProUpRevTx, and related sections. Minor doc link updates and a maintenance note change were also applied.

Changes

Cohort / File(s) Summary
Provider transaction documentation
docs/core/reference/transactions-special-transactions.md
Added multi-version coverage (Version 1 legacy BLS, Version 2 basic BLS after v19, Version 3 extended addresses after v24). Marked ipAddress/port as version < 3 only; introduced netInfo for version 3+. Replaced platform-specific fields (platformNodeID, platformP2PPort, platformHTTPPort) with netInfo in v3. Added "NetInfo Structure" subsection and updated serialization/BLS notes and examples across ProRegTx, ProUpServTx, ProUpRegTx, ProUpRevTx and payload descriptions.
Documentation version/link updates
docs/core/api/remote-procedure-calls-removed.md, docs/core/api/remote-procedure-calls-wallet-deprecated.md, docs/core/index.md, docs/core/reference/p2p-network-control-messages.md, docs/core/reference/p2p-network-deprecated-messages.md
Updated prior-version links and anchors to point to 22.0.0 (replacing older 20.1.0/21.0.0 references) and adjusted wording in a removed-sporks section; no structural changes.
Masternode maintenance
docs/user/masternodes/maintenance.rst
Removed the statement that platformP2PAddrs must include port 26656 for mainnet; otherwise unchanged.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Focus areas:
    • Verify version constraints and phrasing across ProRegTx, ProUpServTx, ProUpRegTx, ProUpRevTx sections
    • Confirm netInfo structure fields and purposeMap entries are correct and consistent
    • Ensure all examples and serialization notes consistently reference "Version 2+", "Version 3", and "version < 3"
    • Check updated links/anchors to 22.0.0 are correct

Poem

🐰 I hopped through docs with careful cheer,

netInfo landed in version three this year,
BLS notes shifted, fields rearranged,
ProTx tales updated and neatly exchanged,
Hop—documentation now sprightly and clear!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: update special txs with extended address info' accurately reflects the main change—updating documentation for special transactions with extended addressing information (netInfo structure for Version 3).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6d54cdb and 8e9d6a7.

📒 Files selected for processing (6)
  • docs/core/api/remote-procedure-calls-removed.md (1 hunks)
  • docs/core/api/remote-procedure-calls-wallet-deprecated.md (1 hunks)
  • docs/core/index.md (1 hunks)
  • docs/core/reference/p2p-network-control-messages.md (1 hunks)
  • docs/core/reference/p2p-network-deprecated-messages.md (1 hunks)
  • docs/user/masternodes/maintenance.rst (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • docs/user/masternodes/maintenance.rst
  • docs/core/reference/p2p-network-deprecated-messages.md
  • docs/core/reference/p2p-network-control-messages.md
🧰 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-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/core/index.md
  • docs/core/api/remote-procedure-calls-wallet-deprecated.md
  • docs/core/api/remote-procedure-calls-removed.md
📚 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/core/index.md
  • docs/core/api/remote-procedure-calls-wallet-deprecated.md
  • docs/core/api/remote-procedure-calls-removed.md
📚 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/core/index.md
  • docs/core/api/remote-procedure-calls-wallet-deprecated.md
📚 Learning: 2025-11-12T18:09:41.377Z
Learnt from: thephez
Repo: dashpay/docs PR: 534
File: locale/en/LC_MESSAGES/docs/user/masternodes/maintenance.po:175-176
Timestamp: 2025-11-12T18:09:41.377Z
Learning: In the dashpay/docs repository, .po files under locale/ directories are automated outputs generated by running the transifex/pushtx.sh script. These files should not be manually edited as changes will be overwritten on the next Transifex sync. Any corrections should be made at the source level in the original documentation files or within Transifex.

Applied to files:

  • docs/core/index.md
🔇 Additional comments (3)
docs/core/index.md (1)

158-158: ✓ Previous version reference updated correctly.

The link to the previous documentation version has been updated from 21.0.0 to 22.0.0, maintaining consistency across the documentation set.

docs/core/api/remote-procedure-calls-removed.md (1)

9-9: ✓ Previous documentation version reference updated.

The link to the previous version of removed RPCs documentation has been updated to 22.0.0, consistent with other related documentation updates in this PR.

docs/core/api/remote-procedure-calls-wallet-deprecated.md (1)

13-13: ✓ Previous documentation version reference updated.

The link to the previous version of deprecated wallet RPCs documentation has been updated to 22.0.0, consistent with the broader documentation maintenance updates across this PR.


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (3)
docs/core/reference/transactions-special-transactions.md (3)

56-57: Apply hyphenation to compound adjectives.

Lines 56 and 57 use "owner related" and "operational related" as compound adjectives modifying "signing". These should be hyphenated per standard English grammar.

-| 20 | KeyIdOwner | CKeyID | The public key hash used for owner related signing (ProTx updates, governance voting)
+| 20 | KeyIdOwner | CKeyID | The public key hash used for owner-related signing (ProTx updates, governance voting)
-| 48 | PubKeyOperator | CBLSPublicKey | The BLS public key used for operational related signing (network messages, ProTx updates).<br>**Note**: serialization varies based on `version`:<br> - Version 1 - legacy BLS scheme<br> - Version 2+ - basic BLS scheme
+| 48 | PubKeyOperator | CBLSPublicKey | The BLS public key used for operational-related signing (network messages, ProTx updates).<br>**Note**: serialization varies based on `version`:<br> - Version 1 - legacy BLS scheme<br> - Version 2+ - basic BLS scheme

65-65: Remove redundant phrasing in "HTTP/API interface" descriptions.

Both lines 65 and 305 say "TCP port of Platform HTTP/API interface". Since "I" in "interface" creates redundancy, simplify to "TCP port of Platform HTTP/API" or similar.

-| 0 or 2 | platformHTTPPort | uint_16 | ***Version 2 only***<br>TCP port of Platform HTTP/API interface (network byte order). Only present for masternode type 1.<br>**Replaced by netInfo in version 3**
+| 0 or 2 | platformHTTPPort | uint_16 | ***Version 2 only***<br>TCP port of Platform HTTP/API (network byte order). Only present for masternode type 1.<br>**Replaced by netInfo in version 3**

Also applies to: 305-305


440-440: Apply hyphenation to compound adjective in ProUpRegTx section.

Line 440 uses "operational related" as a compound adjective. Hyphenate for consistency and correct grammar.

-| 48 | PubKeyOperator | CBLSPublicKey | The BLS public key used for operational related signing (network messages, ProTx updates).<br>**Note**: serialization varies based on `version`:<br> - Version 1 - legacy BLS scheme<br> - Version 2+ - basic BLS scheme
+| 48 | PubKeyOperator | CBLSPublicKey | The BLS public key used for operational-related signing (network messages, ProTx updates).<br>**Note**: serialization varies based on `version`:<br> - Version 1 - legacy BLS scheme<br> - Version 2+ - basic BLS scheme
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a10895 and 9f9d637.

📒 Files selected for processing (1)
  • docs/core/reference/transactions-special-transactions.md (4 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-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/core/reference/transactions-special-transactions.md
📚 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/core/reference/transactions-special-transactions.md
🪛 LanguageTool
docs/core/reference/transactions-special-transactions.md

[grammar] ~56-~56: Use a hyphen to join words.
Context: ...yID | The public key hash used for owner related signing (ProTx updates, governan...

(QB_NEW_EN_HYPHEN)


[grammar] ~57-~57: Use a hyphen to join words.
Context: ... The BLS public key used for operational related signing (network messages, ProTx...

(QB_NEW_EN_HYPHEN)


[style] ~65-~65: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ... 2 only***
TCP port of Platform HTTP/API interface (network byte order). Only present for ...

(ACRONYM_TAUTOLOGY)


[style] ~305-~305: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ... 2 only***
TCP port of Platform HTTP/API interface (network byte order). Only present for ...

(ACRONYM_TAUTOLOGY)


[grammar] ~440-~440: Use a hyphen to join words.
Context: ... The BLS public key used for operational related signing (network messages, ProTx...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)
docs/core/reference/transactions-special-transactions.md

49-49: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


50-50: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


51-51: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


52-52: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


53-53: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


54-54: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


55-55: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


56-56: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


57-57: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


58-58: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


59-59: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


60-60: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


61-61: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


62-62: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


63-63: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


64-64: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


65-65: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


66-66: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


67-67: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


75-75: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


76-76: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


294-294: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


295-295: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


296-296: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


297-297: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


298-298: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


299-299: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


300-300: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


301-301: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


302-302: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


303-303: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


304-304: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


305-305: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


306-306: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


307-307: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


437-437: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


438-438: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


439-439: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


440-440: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


582-582: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


583-583: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


584-584: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


585-585: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


586-586: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


587-587: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

🔇 Additional comments (5)
docs/core/reference/transactions-special-transactions.md (5)

69-78: NetInfo Structure section is well-documented with clear versioning.

The new NetInfo Structure section provides comprehensive documentation of the extensible address format, clearly explaining purpose IDs (0-2) and address types. The note at line 78 appropriately clarifies the relationship between version 3 transactions and the new structure.


49-67: ProRegTx versioning documentation is clear and comprehensive.

The version field updates (line 49) and version-specific field documentation for ipAddress/port (lines 53–54) and the new netInfo field (line 55) are well-structured. Platform-specific fields (lines 63–65) are correctly marked as version 2 only with netInfo replacement in version 3. The payload signature note (line 67) appropriately distinguishes BLS scheme variants by version.


294-309: ProUpServTx versioning mirrors ProRegTx updates appropriately.

Version descriptions (line 294), version-conditional field annotations (lines 297–305), and the note differentiating version 1 from version 3 transactions (line 309) follow the same clear pattern as ProRegTx documentation. The type field annotation (line 295) correctly specifies "Version 2 and later".


437-446: ProUpRegTx versioning documentation is consistent with overall versioning scheme.

Version descriptions (line 437) and signature serialization notes (line 440 — pending hyphenation fix noted above) appropriately document version-specific behavior. The ProUpRegTx structure correctly reflects version variants without the network address fields present in ProRegTx/ProUpServTx.


582-587: ProUpRevTx versioning and signature documentation is accurate.

Version descriptions (line 582) and the note about automatic version selection by the protx revoke RPC add helpful context. Signature serialization variants (line 587) clearly distinguish legacy vs. basic BLS schemes. Documentation correctly omits network address fields.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/core/reference/transactions-special-transactions.md (2)

49-67: Optional: Consider adding trailing pipes to markdown tables for strict compliance.

Markdown linter flags missing trailing pipes in table rows throughout the file (MD055). While most renderers handle this gracefully, adding trailing pipes would improve consistency:

-| 2 | version | uint_16 | Provider transaction version number.<br>...
+| 2 | version | uint_16 | Provider transaction version number.<br>... |

This applies to all table rows in the ProRegTx, NetInfo, ProUpServTx, ProUpRegTx, and ProUpRevTx tables.

Also applies to: 73-76, 294-307, 437-446, 580-587


56-57: Optional: Apply minor grammar/style improvements for formality.

Consider these stylistic refinements:

  • Lines 56–57, 440: Use hyphens for compound modifiers: "owner-related" and "operational-related" (not "owner related")
  • Lines 65, 305: Remove redundant "interface" in "HTTP/API interface" → "HTTP/API" (since API already implies interface)

These changes would improve documentation consistency and formality, but are not critical.

Also applies to: 65-65, 305-305, 440-440

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f9d637 and 6d54cdb.

📒 Files selected for processing (1)
  • docs/core/reference/transactions-special-transactions.md (4 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-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/core/reference/transactions-special-transactions.md
📚 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/core/reference/transactions-special-transactions.md
🪛 LanguageTool
docs/core/reference/transactions-special-transactions.md

[grammar] ~56-~56: Use a hyphen to join words.
Context: ...yID | The public key hash used for owner related signing (ProTx updates, governan...

(QB_NEW_EN_HYPHEN)


[grammar] ~57-~57: Use a hyphen to join words.
Context: ... The BLS public key used for operational related signing (network messages, ProTx...

(QB_NEW_EN_HYPHEN)


[style] ~65-~65: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ... 2 only***
TCP port of Platform HTTP/API interface (network byte order). Only present for ...

(ACRONYM_TAUTOLOGY)


[style] ~305-~305: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ... 2 only***
TCP port of Platform HTTP/API interface (network byte order). Only present for ...

(ACRONYM_TAUTOLOGY)


[grammar] ~440-~440: Use a hyphen to join words.
Context: ... The BLS public key used for operational related signing (network messages, ProTx...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)
docs/core/reference/transactions-special-transactions.md

49-49: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


50-50: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


51-51: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


52-52: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


53-53: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


54-54: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


55-55: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


56-56: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


57-57: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


58-58: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


59-59: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


60-60: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


61-61: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


62-62: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


63-63: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


64-64: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


65-65: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


66-66: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


67-67: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


75-75: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


76-76: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


294-294: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


295-295: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


296-296: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


297-297: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


298-298: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


299-299: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


300-300: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


301-301: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


302-302: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


303-303: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


304-304: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


305-305: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


306-306: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


307-307: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


437-437: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


438-438: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


439-439: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


440-440: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


582-582: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


583-583: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


584-584: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


585-585: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


586-586: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)


587-587: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

🔇 Additional comments (3)
docs/core/reference/transactions-special-transactions.md (3)

49-49: NetInfo Structure documentation and version descriptions are well-structured.

The addition of Version 3 support with the NetInfo Structure is clearly documented. Version constraints (< 3 for ipAddress/port, 3+ for netInfo) are properly marked, and the cross-reference from line 55 correctly anchors to #netinfo-structure. The subsection explanation at lines 69–78 provides necessary context about the purpose map and how v3 differs from earlier versions.

Also applies to: 53-78


290-309: ProUpServTx documentation is consistent with ProRegTx versioning.

Version constraints, netInfo replacement notes, and BLS serialization updates are aligned across both transaction types. The corrected anchor reference at line 299 now properly links to #netinfo-structure. The explanatory note at line 309 parallels the ProRegTx structure, maintaining consistency.


437-587: ProUpRegTx and ProUpRevTx sections maintain consistent versioning patterns.

Both sections properly document Versions 1–3 with appropriate serialization notes. ProUpRevTx notably adds helpful context about automatic version selection by the protx revoke RPC (line 582), and the BLS serialization notes are correctly updated across both transaction types. The documentation maintains consistency with earlier sections.

@thephez thephez merged commit 79ef5d7 into dashpay:23.0.0 Nov 17, 2025
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.

1 participant