move node types and handlings to separate packages #729
Conversation
This file contains 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
…reth into move-atomic-network-handlers
…reth into move-atomic-network-handlers
ceyonur
commented
Jan 6, 2025
| return nil | ||
| } | ||
|
|
||
| func (vm *VM) RegisterLeafRequestHandler(nodeType message.NodeType, metricName string, trieDB *triedb.Database, trieKeyLen int, useSnapshot bool) error { |
There was a problem hiding this comment.
Hmm I wonder if we should register an interface rather than nodeType directly. I feel like there is definitely room to improve this PR in general, but did not want to break it anything further.
qdm12
approved these changes
Jan 7, 2025
| @@ -1218,15 +1226,41 @@ func (vm *VM) setAppRequestHandlers() { | |||
| }, | |||
| }, | |||
| ) | |||
| if err := vm.RegisterLeafRequestHandler(message.StateTrieNode, "sync_state_trie_leaves", evmTrieDB, message.StateTrieKeyLength, true); err != nil { | |||
| return err | |||
There was a problem hiding this comment.
nit
Suggested change
| return err | |
| return fmt.Errorf("failed registering state trie database: %s", err) |
maybe %w is needed though
| } | ||
| // Register atomic trieDB for serving atomic leafs requests. | ||
| if err := vm.RegisterLeafRequestHandler(atomic.AtomicTrieNode, "sync_atomic_trie_leaves", vm.atomicTrie.TrieDB(), atomic.AtomicTrieKeyLength, false); err != nil { | ||
| return err |
There was a problem hiding this comment.
nit
Suggested change
| return err | |
| return fmt.Errorf("failed registering atomic trie database: %s", err) |
maybe %w is needed though
| @@ -34,7 +34,7 @@ State sync code is structured as follows: | |||
| - `plugin/evm/`: The engine expects the VM to implement `StateSyncableVM` interface, | |||
| - `StateSyncServer`: Contains methods executed on nodes _serving_ state sync requests. | |||
| - `StateSyncClient`: Contains methods executed on nodes joining the network via state sync, and orchestrates the top level steps of the sync. | |||
| - `peer`: Contains abstractions used by `sync/statesync` to send requests to peers (`AppRequest`) and receive responses from peers (`AppResponse`). | |||
| - `peer`: Contains abstractions used by `sync/statesync` to send requests to peers (`AppRequest`) and receive responses from peers (`AppResponse`). | |||
There was a problem hiding this comment.
nit revert this, the trailing space is a bit out of scope 😄 Although we probably want to setup CI markdown checks at some point to have consistent markdown.
Comment on lines
+87
to
+88
| if len(leafsRequest.Start) != 0 && len(leafsRequest.Start) != lrh.trieKeyLength || | ||
| len(leafsRequest.End) != 0 && len(leafsRequest.End) != lrh.trieKeyLength { |
There was a problem hiding this comment.
shouldnt' we use parentheses in those conditions?? 🤔
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why this should be merged
Moves declaration of message.NodeType to separate pkgs
How this works
This pull request includes several changes to the
plugin/evmpackage, primarily focusing on the atomic trie synchronization and request handling.Atomic Trie Synchronization:
plugin/evm/atomic/atomic_syncer.go: IntroducedAtomicTrieNodeconstant and replacedatomicKeyLengthwithAtomicTrieKeyLengththroughout the file. [1] [2] [3] [4]Request Handling:
plugin/evm/message/handler.go: Simplified theRequestHandlerinterface by mergingHandleStateTrieLeafsRequestandHandleAtomicTrieLeafsRequestinto a singleHandleLeafsRequestmethod. [1] [2]plugin/evm/message/leafs_request.go: UpdatedLeafsRequestto use a singleNodeTypefield and removed the distinction between state and atomic trie nodes. [1] [2]plugin/evm/vm.go: IntroducedRegisterLeafRequestHandlerthat can register differentmessage.NodeTypes and passes configs tonetworkHandlerto handle registered NodeTypes accordingly by creating leaf request handlers for each type.Test Updates:
plugin/evm/atomic/atomic_syncer_test.go: Updated tests to useAtomicTrieKeyLengthinstead ofatomicKeyLength. [1] [2] [3] [4]plugin/evm/message/leafs_request_test.go: Removed tests that validated the old node type-specific request handling.Additional Changes:
plugin/evm/atomic/atomic_trie.go: ReplacedatomicKeyLengthwithAtomicTrieKeyLength. [1] [2]plugin/evm/atomic/atomic_trie_iterator.go: Removed theatomicTrieKeyLenconstant and replaced its usage withAtomicTrieKeyLength. [1] [2]These changes collectively simplify the codebase and improve the maintainability of the atomic trie synchronization and request handling logic.
How this was tested
Existing UTs
Need to be documented?
No
Need to update RELEASES.md?
No