docs: Add Rust-Solidity size validation alignment documentation#13
Merged
Conversation
…ment - Add detailed comments to KernelOutputParser.sol explaining that MAX_SINGLE_ACTION_BYTES bounds action_len (ActionV1 bytes), NOT the full wire encoding including the 4-byte length prefix - Create contracts/docs/binary-format.md with complete wire format spec - Simplify contracts/README.md and link to detailed docs This ensures the Solidity size validation is clearly documented as byte-for-byte aligned with the Rust implementation in kernel-core.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
KernelOutputParser.solclarifying thatMAX_SINGLE_ACTION_BYTESboundsaction_len(the ActionV1 bytes), NOT the full wire encoding including the 4-byte length prefixcontracts/docs/binary-format.mdwith complete wire format specificationcontracts/README.mdand link to detailed docsContext
Investigation confirmed that the Rust and Solidity implementations are already byte-for-byte aligned. Both check
action_len(the value read from the 4-byte prefix) againstMAX_SINGLE_ACTION_BYTES = 16424.This PR adds documentation to make this alignment explicit and prevent future confusion.
Test plan
kernel-core/src/types.rsandcodec.rs