Docs/periodic review reference docs 4300#76
Merged
oskarszoon merged 15 commits intoOct 30, 2025
Merged
Conversation
- Add missing ResetBlockAssemblyFully method to service definition - Fix StateMessage field definitions to match actual protobuf implementation - Remove unused NewChaintipAndHeightRequest message from documentation - Verify all message definitions against actual protobuf implementation - Ensure complete accuracy with current Block Assembly API Documentation now perfectly reflects the actual implementation with: - All service methods that are actually implemented - Correct StateMessage fields without deprecated resetWaitCount/resetWaitTime - Only messages that are used by service methods - Complete coverage of Block Assembly functionality for mining operations
- Add missing RPC methods: GetNextBlockID, GetBlockHeadersFromCommonAncestor, GetBlocksByHeight, FindBlocksContainingSubtree, ReportPeerFailure - Add missing message types: GetNextBlockIDResponse, InvalidateBlockResponse, ReportPeerFailureRequest, etc. - Update existing messages with missing fields (AddBlockRequest, GetBlockResponse, GetBlockHeaderResponse) - Fix GetNextWorkRequiredRequest field names and add missing currentBlockTime field - Update InvalidateBlock service method to return correct response type - Update NotificationMetadata to use map instead of repeated MetadataEntry - Reorganize table of contents to include all message types Fixes #4300 - Periodic review of service and store reference documentation
- Add missing base_url and peer_id fields to ProcessBlockRequest - Add missing is_revalidation field to ValidateBlockRequest - Sync documentation with actual protobuf implementation Fixes #4300
- Add missing swagger annotation for BatchTransactionItem message - Ensure consistency with other message definitions in protobuf - Sync documentation with actual protobuf implementation Related to #4300
- Add missing ReportPeerFailure method to subscription functions - Sync documentation with actual blockchain service implementation - Method handles peer failure reports and broadcasts to subscribers Related to #4300
- Fix ProcessSubtree method signature to include missing utxoDiff parameter - Add parameter description for UTXO set difference tracker - Sync documentation with actual blockpersister implementation Related to #4300
- Fix Server struct definition with missing fields (blockPriorityQueue, blockClassifier, forkManager, catchupAlternatives) - Correct field name from processSubtreeNotify to processBlockNotify - Add missing blocksCurrentlyValidating field to BlockValidation struct - Fix New function signature to include blockAssemblyClient parameter - Remove non-existent methods (SubtreeFound, Get, Exists, SetTxMeta, DelTxMeta, SetMinedMulti) - Add actual ValidateBlock method that exists in implementation - Sync documentation with actual blockvalidation service implementation Related to #4300
- Fix Server struct definition with correct field types and names - Change P2PNode p2p.NodeI to P2PClient p2pMessageBus.P2PClient - Correct bitcoinProtocolID to bitcoinProtocolVersion - Add missing fields: peerRegistry, peerSelector, peerHealthChecker, syncCoordinator - Remove non-existent fields: miningOnTopicName, handshakeTopicName - Fix NewServer function signature with missing parameters (blockAssemblyClient, invalidBlocksKafkaConsumerClient, invalidSubtreeKafkaConsumerClient) - Update interface references from go-p2p to go-p2p-message-bus package - Correct dependencies section with proper interface names - Sync documentation with actual P2P service implementation Related to #4300
- Add missing blockValidationClient field to RPCServer struct - Fix NewServer function signature with blockValidationClient parameter - Update parameter descriptions to include block validation service - Fix markdown formatting for admonition boxes and numbered lists - Improve MkDocs Material compatibility for proper list numbering - Sync documentation with actual RPC service implementation Related to #4300
- Add missing fields to UTXOWrapper struct definition - Include UTXOTotalValue and UTXOCount performance optimization fields - Add reusable buffer fields (b8, b16, reusableScript) for efficient serialization - Sync documentation with actual utxopersister implementation - All other struct definitions and method signatures verified as accurate Related to #4300
- Add missing blockchainClient field to Validator struct definition - Update New function signature to include blockchainClient parameter - Sync documentation with actual validator implementation - All other struct definitions and method signatures verified as accurate Related to #4300
- Add missing OnLongestChain field to MinedBlockInfo struct definition - Add missing Skip, UnminedSince, and BlockIDs fields to UnminedTransaction struct - Fix GetUnminedTxIterator method signature to include fullScan parameter - Add missing MarkTransactionsOnLongestChain method to Store interface - Update Key Functions section with new method description - Sync documentation with actual utxo store implementation Related to #4300
- Add missing peer_id field to KafkaSubtreeTopicMessage definition - Add missing peer_id field to KafkaRejectedTxTopicMessage definition - Update field specifications with peer_id descriptions - Update JSON examples to include peer_id fields - Update code examples for sending and receiving messages with peer_id - Enhance rejected transaction handling to differentiate internal vs external rejections - Sync documentation with actual protobuf definitions Related to #4300
- Remove non-existent root level files (settings_local.conf, docker-compose.yml) - Add missing cmd/ directories: checkblock, resetblockassembly, utxovalidator - Fix docs/ directory structure to match actual organization - Add howto, misc, settings, topics, tutorials directories - Remove non-existent architecture and images directories - Sync documentation with actual project structure Related to #4300
Contributor
|
🤖 Claude Code Review Status: Complete This PR updates reference documentation to reflect recent API changes. The documentation changes are consistent and follow proper documentation patterns. Observations: The PR adds documentation for several new API features:
All documentation updates appear to be synchronization changes to match code modifications. No issues found. |
|
oskarszoon
approved these changes
Oct 30, 2025
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
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.