Overhaul of ENR implementation - part I #707
Merged
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
Contributor
kdeme
commented
Jun 21, 2024
kdeme
commented
- Rework adding and updating of fields by having an insert call that gets used everywhere. Avoiding also duplicate keys. One side-effect of this is that ENR sequence number will always get updated on an update call, even if nothing changes.
- Deprecate initRecord as it is only used in tests and is flawed
- Assert when predefined keys go into the extra custom pairs. Any of the predefined keys are only to be passed now via specific parameters to make sure that the correct types are stored in ENR.
- Clearify the Opt.none behaviour for Record.update
- When setting ipv6, allow for tcp/udp port fields to be used default
- General clean-up
- Rework/clean-up completely the ENR tests.
- Rework adding and updating of fields by having an insert call that gets used everywhere. Avoiding also duplicate keys. One side-effect of this is that ENR sequence number will always get updated on an update call, even if nothing changes. - Deprecate initRecord as it is only used in tests and is flawed - Assert when predefined keys go into the extra custom pairs. Any of the predefined keys are only to be passed now via specific parameters to make sure that the correct types are stored in ENR. - Clearify the Opt.none behaviour for Record.update - When setting ipv6, allow for tcp/udp port fields to be used default - General clean-up - Rework/clean-up completely the ENR tests.
kdeme
commented
Jun 21, 2024
Comment on lines
+323
to
+324
| ## If none of the k:v pairs are changed, the sequence number of the `Record` | ||
| ## will still be incremented and a new signature will be applied. |
There was a problem hiding this comment.
I've checked and allthe usages through discv5 updateRecord call in nimbus-eth2 will only call this if the provided extraField actually changes, avoiding a seqNum update on same update with same data. Nevertheless, perhaps this is still something to re-add...
kdeme
commented
Jun 21, 2024
Comment on lines
+117
to
+141
| func find(pairs: openArray[FieldPair], key: string): Opt[int] = | ||
| ## Search for key in key:value pairs. | ||
| ## | ||
| ## Returns some(index of key) if key is found. Else returns none. | ||
| for i, (k, v) in pairs: | ||
| if k == key: | ||
| return Opt.some(i) | ||
| Opt.none(int) | ||
|
|
||
| func insert(pairs: var seq[FieldPair], item: FieldPair) = | ||
| ## Insert item in key:value pairs. | ||
| ## | ||
| ## If a FieldPair with key is already present, the value is updated, otherwise | ||
| ## the pair is inserted in the correct position to keep the pairs sorted. | ||
| let index = find(pairs, item[0]) | ||
| if index.isSome(): | ||
| pairs[index.get()] = item | ||
| else: | ||
| pairs.insert(item, pairs.lowerBound(item, cmp)) | ||
|
|
||
| func insert(pairs: var seq[FieldPair], b: openArray[FieldPair]) = | ||
| ## Insert all items in key:value pairs. | ||
| for item in b: | ||
| pairs.insert(item) | ||
|
|
There was a problem hiding this comment.
Could use some other structure than a sequence (e.g. btree , table, etc.) but that seemed (?) kind of overkill considering an ENR will hold typically hold 8 k:v pairs in beacon, or perhaps 11 when we add ipv6, and can be max. 300 bytes.
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.