Fix docs_from_attrs truncating mid-UTF-8 codepoint#1769
Merged
leighmcculloch merged 8 commits intomainfrom Mar 24, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a UTF-8 correctness bug in soroban-sdk-macros where doc-comment truncation could split multi-byte characters, potentially encoding invalid UTF-8 into the contract spec XDR.
Changes:
- Truncate doc strings using
floor_char_boundaryso truncation always occurs at a valid UTF-8 boundary. - Add a unit test covering the case where a multi-byte character straddles the truncation boundary.
leighmcculloch
commented
Mar 23, 2026
mootz12
approved these changes
Mar 23, 2026
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
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.
What
Use
floor_char_boundaryto truncate doc comments at a valid UTF-8 character boundary indocs_from_attrs. Add a test that confirms a doc string where a multi-byte character straddles the truncation boundary produces valid UTF-8.Why
The current implementation truncates doc bytes with
Vec::truncateat an arbitrary byte offset, which could split multi-byte UTF-8 codepoints and store invalid UTF-8 in the contract's spec XDR.Close #1768