jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(eth-wire): remove TODO about capability Ord (#263)

Browse Source 
* chore(eth-wire): remove TODO about capability Ord

 * orderings should be consistent with geth, see updated comment

* move down string doc link
This commit is contained in:
Dan Cline
2022-11-26 01:17:57 -05:00
committed by GitHub
parent 6232505b94
commit 6da140ce1b
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
crates/net/eth-wire/src/p2pstream.rs
View File

@ -418,12 +418,18 @@ pub fn set_capability_offsets(
// map of capability name to version
let mut shared_capabilities = HashMap::new();
// sorted list of capability names
// TODO: the Ord implementation for strings says the following:
// > Strings are ordered lexicographically by their byte values. This orders Unicode code
// points based on their positions in the code charts. This is not necessarily the same as
// “alphabetical” order.
// We need to implement a case-sensitive alphabetical sort
// The `Ord` implementation for capability names should be equivalent to geth (and every other
// client), since geth uses golang's default string comparison, which orders strings
// lexicographically.
// https://golang.org/pkg/strings/#Compare
//
// This is important because the capability name is used to determine the message id offset, so
// if the sorting is not identical, offsets for connected peers could be inconsistent.
// This would cause the peers to send messages with the wrong message id, which is usually a
// protocol violation.
//
// The `Ord` implementation for `SmolStr` (used here) currently delegates to rust's `Ord`
// implementation for `str`, which also orders strings lexicographically.
let mut shared_capability_names = BTreeSet::new();
// find highest shared version of each shared capability