evm+solana: Add comments to clarify the order of struct parsing #246
+8
−0
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
johnsaigle
force-pushed
the
comments-for-parsing
branch
from
6b3a70a to
5a86faf
Compare
johnsaigle
force-pushed
the
comments-for-parsing
branch
3 times, most recently
from
11ba8ad to
2cd182d
Compare
johnsaigle
force-pushed
the
comments-for-parsing
branch
from
2cd182d to
7ce5400
Compare
|
#248 will get rid of the structs, but the same idea applies that the encoding is swapped around in the wire format |
johnsaigle
force-pushed
the
comments-for-parsing
branch
from
7ce5400 to
4d5f464
Compare
|
Rebase done, should be up-to-date with |
djb15
approved these changes
Mar 5, 2024
The 'wire format' of the Transceiver messages encodes/decodes the fields of the struct in reverse order to how they are declared in the Solidity and Rust structs. This is done safely, and we have unit tests to verify that the encoding/decoding process is consistent on both sides. However, it's not clear that this is intentional when reading through the code. This comment should help with readability and hopefully will stop reviewers from falling down rabbit holes.
johnsaigle
force-pushed
the
comments-for-parsing
branch
from
4d5f464 to
e0aa2fc
Compare
mdulin2
approved these changes
Mar 11, 2024
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.
The 'wire format' of the Transceiver messages encodes/decodes the fields of the struct in reverse order to how they are declared in the Solidity and Rust structs.
This is done safely, and we have unit tests to verify that the encoding/decoding process is consistent on both sides. However, it's not clear that this is intentional when reading through the code. This comment should help with readability and hopefully will stop reviewers from falling down rabbit holes.