Add support for new protocol checksum & chatIndex #1386
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
extremeheat
reviewed
Mar 26, 2025
Comment on lines
+222
to
+231
| // Override and extend logSentMessageFromPeer to increment index | ||
| const originalLogSent = client.logSentMessageFromPeer | ||
| client.logSentMessageFromPeer = function (chatPacket) { | ||
| // Include chat index in outgoing player_chat packets | ||
| if (client.supportFeature('chatIndex')) { | ||
| chatPacket.index = client._chatMessageIndex++ | ||
| } | ||
|
|
||
| return originalLogSent ? originalLogSent.call(this, chatPacket) : true | ||
| } |
Comment on lines
+122
to
+126
| const calculatedChecksum = calculateChecksum(packet.previousMessages) | ||
| if (packet.checksum !== 0 && packet.checksum !== calculatedChecksum) { | ||
| debug('Chat checksum mismatch', packet.checksum, calculatedChecksum) | ||
| raise('multiplayer.disconnect.chat_validation_failed') | ||
| return |
There was a problem hiding this comment.
I'm not sure we should be enforcing all these checks at the library level as opposed to the user level. We did add some abstractions to chat for the purpose of not having to reimplement complex logic on the user's side. Perhaps it would make sense to have these kind of kick checks behind a flag.
Comment on lines
+231
to
+233
| client.emit('error', new Error(`Chat index mismatch. Expected: ${client._expectedChatIndex}, got: ${packet.index}`)) | ||
| client.end('Chat message received out of order') | ||
| return |
Comment on lines
+426
to
+428
| // Add checksum for 1.21.5+ | ||
| if (mcData.supportFeature('chatChecksum')) { | ||
| params.checksum = options.checksum !== undefined ? options.checksum : calculateChecksum(client._lastSeenMessages) |
There was a problem hiding this comment.
nit: if both the if branches rely on same code you can avoid the duplicate code here by putting it up top
| // Calculate checksum for the lastSeen message signatures (1.21.5+) | ||
| const calculateChecksum = (lastSeen) => { | ||
| if (!mcData.supportFeature('chatChecksum') || !lastSeen || lastSeen.length === 0) { | ||
| return 0 // Default value for backward compatibility |
There was a problem hiding this comment.
Can you elaborate here what you mean by "backward compatibility"?
|
I still have an issue on the client side. I'm investigating, it seems related to the login packet but I checked the protocol (directly by decompiling the client and comparing with 1.21.4) and nothing as changed (at least from my POV). |
|
part of 1.21.5 support; tracked at PrismarineJS/mineflayer#3641 |
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.
resolve #1385
Waiting for PrismarineJS/minecraft-data#995 to be merge for minecraft-data to be up to date