Docs/service documentation corrections #117
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Corrects component diagrams and documentation based on reviews across multiple merged PRs. All changes verified against actual codebase implementation. Changes: - Consolidated logical components into actual physical implementations - Removed non-existent components from PlantUML diagrams - Added clarifying notes about simplified component views - Fixed CLI command documentation (utxovalidator → validate-utxo-set) - Fixed distributed pause diagram (removed non-existent flag checks) - Fixed markdown formatting (list numbering, link text, blank lines) - Updated .markdownlint.yml to allow duplicate headings in different sections - Regenerated all SVG files from corrected PlantUML sources Files modified: - validator.md: Added Remote vs Local deployment context - utxoPersister.md: Consolidated Server component documentation - rpc.md: Consolidated RPC handler documentation - utxo.md: Simplified UTXO Store component view - subtreeValidation.md: Fixed link text, removed non-existent components - minersHowToTeranodeCLI.md: Corrected validate-utxo-set command - subtree_validation_distributed_pause.puml: Fixed Pod B flag check - Multiple PlantUML and SVG files updated All markdownlint checks pass. Python validator warnings are pre-existing false positives (numbered lists detected as config parameters).
Clarify that reassigned UTXOs cannot be spent until 1,000 blocks after reassignment (ReAssignedUtxoSpendableAfterBlocks constant). This waiting period ensures network consensus and prevents disputes over confiscated and reassigned transaction outputs. Addresses October 2024 implementation change from commit 4b4f4e8.
Add documentation for the utxostore_useExternalTxCache setting that controls short-lived caching of externally stored transactions. The cache (10-second expiration) optimizes concurrent reads of large transactions with many outputs, reducing redundant external storage fetches during high-throughput validation. Addresses October 2024 implementation from commit 92aa20e.
Explain the FSM-aware INV message queueing mechanism that prevents message loss during blockchain state transitions. INV messages are queued in Kafka when the FSM is not in RUNNING state, ensuring reliable message delivery during node startup, synchronization, block reorganizations, and other state transitions. Addresses September 2024 implementation from commit dc2971d.
Contributor
|
🤖 Claude Code Review Status: Complete Review SummaryThis PR contains documentation corrections addressing feedback from multiple previous PRs. The changes focus on:
FindingsNo issues found. The documentation changes are accurate, well-structured, and improve clarity. All changes have been properly verified against the codebase. Key Improvements
All PlantUML diagrams and SVG files were correctly regenerated from updated sources. |
sugh01
approved these changes
Nov 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.