refactor: use NodeId instead of String for discv5 json types #1488
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
njgheorghita
approved these changes
Sep 25, 2024
| @@ -24,15 +23,15 @@ pub struct KBucketsTable { | |||
| #[serde(rename_all = "camelCase")] | |||
| pub struct NodeInfo { | |||
| pub enr: Enr, | |||
| pub node_id: String, | |||
| pub node_id: NodeId, | |||
There was a problem hiding this comment.
Might be worth adding a comment here that NodeId gets properly serialized as a 0x-prefixed hexstring
There was a problem hiding this comment.
I don't think that's necessary. Since Serialize/Deserialize is derived, one should assume that serialization is done correctly.
But if you feel strong about it, I can add it.
There was a problem hiding this comment.
nope, just a nitpick
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.
What was wrong?
We are using String to represent NodeId in json types.
I believe this isn't necessary as NodeId serialization is the same as what we are using (hex string prefixed with "0x").
This is not a big deal, but something I encounter while refactoring kbuckets.
How was it fixed?
Changed String to NodeId as type.
To-Do