msgIdToStrFn: support Uint8Array #5240
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
Performance Report✔️ no performance regression detected Full benchmark results
|
nflaig
reviewed
Mar 7, 2023
| @@ -27,8 +27,7 @@ export function fastMsgIdFn(rpcMsg: RPC.IMessage): string { | |||
| } | |||
|
|
|||
| export function msgIdToStrFn(msgId: Uint8Array): string { | |||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call | |||
| return Buffer.prototype.toString.call(msgId, "base64"); | |||
| return toHex(msgId); | |||
There was a problem hiding this comment.
are there any potential side-effects or considerations changing the return value from base64 to hex?
There was a problem hiding this comment.
previously we choosed base64 probably because of the memory efficiency, but it's an issue with Uint8Array anyway. Switching to hex helps us:
- fix the issue with Uint8Array by using
toHexfunction - have same message id format to other clients which make it easier to debug, for example Nimbus
I think the memory difference is no much
There was a problem hiding this comment.
sounds good to me, thanks for explaining 👍
There was a problem hiding this comment.
toHex util uses Buffer toString which is memory efficient too. Prefixing with "'0x" adds non-trivial unnecessary memory, but it's not that bad, and all hex strings are assumed to be prefixed so
nflaig
approved these changes
Mar 7, 2023
wemeetagain
approved these changes
Mar 7, 2023
|
🎉 This PR is included in v1.7.0 🎉 |
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.
Motivation
IWANTmessages, however Lodestar missed some of themDescription
toHex()utility which support both Buffer and Uint8Arraypart of #5074
part of ChainSafe/js-libp2p-gossipsub#411