common/bitutil: deprecate XORBytes in favor of stdlib crypto/subtle #18218
Conversation
This file contains hidden or 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
Sahil-4555
requested review from
AskAlexSharov,
Giulio2002,
mh0lt and
yperbasis
as code owners
chfast
approved these changes
Dec 9, 2025
common/bitutil/bitutil.go
Outdated
| // XORBytes xors the bytes in a and b. The destination is assumed to have enough | ||
| // space. Returns the number of bytes xor'd. | ||
| // | ||
| // If dst does not have length at least n, |
Member
There was a problem hiding this comment.
It doesn't really explain what the n is.
Contributor
Author
There was a problem hiding this comment.
It refers to min(len(a), len(b))
| xorOff = (binary.LittleEndian.Uint32(cache[dstOff:]) % uint32(rows)) * hashBytes | ||
| ) | ||
| bitutil.XORBytes(temp, cache[srcOff:srcOff+hashBytes], cache[xorOff:xorOff+hashBytes]) | ||
| subtle.XORBytes(temp, cache[srcOff:srcOff+hashBytes], cache[xorOff:xorOff+hashBytes]) |
Member
There was a problem hiding this comment.
The usage is in the ethash implementation, so you can also consider removing ethash :)
Contributor
Author
There was a problem hiding this comment.
Means your suggestion is to remove this entire execution/protocol/rules/ethash directory?
chfast
approved these changes
Dec 9, 2025
Member
chfast
left a comment
chfast
left a comment
There was a problem hiding this comment.
Already approved. My intention was just to indicate that the single usage of this function is in the semi-dead code, i.e. risk is very low.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
With
Go 1.20, the standard library now providescrypto/subtle.XORBytes, which is more efficient than our existingbitutil.XORBytes. Because the custom implementation is referenced in only a single spot inerigon, deprecating it is straightforward.