feat(levm): improve precompiles code clarity #1579
Merged
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
maximopalopoli
changed the title
JereSalo
approved these changes
Dec 30, 2024
crates/vm/levm/src/precompiles.rs
Outdated
Comment on lines
343
to
344
| /// This function returns the slice defined by the limits converted to a vec. If the size to expand the | ||
| /// slice are not covered by the calldata size, then the missing space needed is filled with zeros. |
There was a problem hiding this comment.
Suggested change
| /// This function returns the slice defined by the limits converted to a vec. If the size to expand the | |
| /// slice are not covered by the calldata size, then the missing space needed is filled with zeros. | |
| /// This function returns the slice between the lower and upper limit of the calldata (as a vector), padding with zeros at the end if necessary. |
There was a problem hiding this comment.
Done in Improve comments
crates/vm/levm/src/precompiles.rs
Outdated
| @@ -366,6 +374,7 @@ fn mod_exp(base: BigUint, exponent: BigUint, modulus: BigUint) -> BigUint { | |||
| } | |||
| } | |||
|
|
|||
| /// If the result size is lower than the needed, then pads the result to right filling with zeros at left. | |||
There was a problem hiding this comment.
Suggested change
| /// If the result size is lower than the needed, then pads the result to right filling with zeros at left. | |
| /// If the result size is less than needed, pads left with zeros. |
There was a problem hiding this comment.
Done in Improve comments
crates/vm/levm/src/precompiles.rs
Outdated
| @@ -805,7 +862,7 @@ fn blake2f_compress_f( | |||
| Ok(output) | |||
| } | |||
|
|
|||
| // Reads a part of the calldata and returns what is read as u64 or an error | |||
| /// Reads a part of the calldata and returns what is read as u64 or an error | |||
There was a problem hiding this comment.
Suggested change
| /// Reads a part of the calldata and returns what is read as u64 or an error | |
| /// Reads part of the calldata and returns what is read as u64 or an error |
Maybe it would be good if we clarify in which scenario it returns an error. "or an error if out of bounds" for example
There was a problem hiding this comment.
Done in Improve comments
ilitteri
approved these changes
Jan 6, 2025
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.
Motivation
The motivation is to improve the clarity of the code.
Description
Added some comments, made a constant and some separate functions to make the code more understandable.