Add docs on clever errors #99
Open
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
damirka
reviewed
Oct 31, 2024
| conditions and still get useful error messages. | ||
|
|
||
| ```move | ||
| module 0x42::macro_exporter { |
There was a problem hiding this comment.
For coherence, I would split it into two codeblocks and use module labels.
damirka
reviewed
Oct 31, 2024
| > change due to any changes in the source file (e.g., due to auto-formatting, adding a new module | ||
| > member, or adding a newline). | ||
|
|
||
| ## Clever Abort Codes |
There was a problem hiding this comment.
Can you add a link to a matching page in the book/?
tnowacki
reviewed
Nov 1, 2024
| or an abort is raised. They are a source feature and compile to a `u64` abort code value that | ||
| contains the information needed to access the line number, constant name, and constant value given | ||
| the clever error code and the module that the clever error constant was declared in. Because of | ||
| this, post-processing is required to go from the `u64` abort code value to a human-readable error |
There was a problem hiding this comment.
Suggested change
| this, post-processing is required to go from the `u64` abort code value to a human-readable error | |
| this compilation, post-processing is required to go from the `u64` abort code value to a human-readable error |
There was a problem hiding this comment.
Trying to be less ambiguous.
| contains the information needed to access the line number, constant name, and constant value given | ||
| the clever error code and the module that the clever error constant was declared in. Because of | ||
| this, post-processing is required to go from the `u64` abort code value to a human-readable error | ||
| message. This post-processing is automatically performed by the Sui GraphQL server, as well as the |
There was a problem hiding this comment.
Suggested change
| message. This post-processing is automatically performed by the Sui GraphQL server, as well as the | |
| message. The post-processing is automatically performed by the Sui GraphQL server, as well as the |
There was a problem hiding this comment.
I think this just reads cleaner given the previous sentence.
|
|
||
| ## Assertions with no Abort Codes | ||
|
|
||
| Assertions, and `abort` statements without an abort code will automatically derive an abort code |
There was a problem hiding this comment.
Suggested change
| Assertions, and `abort` statements without an abort code will automatically derive an abort code | |
| Assertions and `abort` statements without an abort code will automatically derive an abort code |
| In hex, if `double_except_three(3)` is called, it will abort with a `u64` abort code as follows: | ||
|
|
||
| ``` | ||
| 0x8000_7000_1000_0000 |
There was a problem hiding this comment.
Suggested change
| 0x8000_7000_1000_0000 | |
| 0x8000_0007_0001_0000 |
Is this correct? I was surprised that the value was set into the higher bits there.
| In hex, if `assert_false(3)` is called, it will abort with a `u64` abort code as follows: | ||
|
|
||
| ``` | ||
| 0x8000_4000_ffff_ffff |
There was a problem hiding this comment.
Let's double check this with the one above
|
|
||
| // Print the constant name (if any) | ||
| if identifier_index != 0xffff { | ||
| let constant_name = get_identifier_at_table_index(module, identifier_index); |
There was a problem hiding this comment.
get_identifier_at_table_index
I appreciate this is pseudo code, but do we have a method for this?
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.
Adds docs on clever errors.