Fix HexString JSON schema for empty byte strings#3029
Open
weifanglab wants to merge 1 commit into
Open
Conversation
Signed-off-by: weifanglab <weifanglab@outlook.com>
Contributor
|
All contributors have signed the CLA ✍️ ✅ |
Author
|
I have read the CLA Document and I hereby sign the CLA |
Author
|
@theodorebugnet Hi, Could you please review this PR at your convenience? Thank you very much. |
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.
Description
Summary of the changes...
Fix the variable-length
HexStringJSON Schema pattern so it accepts empty byte strings.HexString<Vec<u8>>can already serialize an empty byte vector as"0x"and parse"0x"back into an empty vector. However, its JSON Schema pattern required at least one byte, which made the schema reject a value that the type itself accepts.This changes the variable-length pattern from
+to*and updates the description to explicitly mention zero bytes.CHANGELOG.mdwith a new entry if my PR makes any breaking changes or fixes a bug. If my PR removes a feature or changes its behavior, I provide help for users on how to migrate to the new behavior.Cargo.tomlchanges before opening the PRs. (Are all new dependencies necessary? Is any module dependency leaked into the full-node (hint: it shouldn't)?)Linked Issues
Testing
SKIP_GUEST_BUILD=1 cargo test -p sov-rollup-interface variable_length_hex_string_json_schema_allows_empty_stringSKIP_GUEST_BUILD=1 cargo test -p sov-rollup-interfacecargo fmt --checkDocs
Describe where this code is documented. If it changes a documented interface, have the docs been updated?
Rendered docs are available at
https://sovlabs-ci-rustdoc-artifacts.us-east-1.amazonaws.com/<BRANCH_NAME>/index.html