Fix binary protocol serialisation examples to align with reality #46
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
The witness is prepended wit more information than currently stated / it's unclear.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
wraitii
commented
May 15, 2024
Comment on lines
+78
to
86
| // Full witness -> [uint32(nbPublicElements) | uint32(nbPrivateElements) | uint32(nbElements) | publicVariables | secretVariables] | ||
| // Public witness -> [uint32(nbElements) | publicVariables ] | ||
| ``` | ||
|
|
||
| Where: | ||
|
|
||
| - `nbPublicElements == len(publicVariables)`. | ||
| - `nbPrivateElements == len(secretVariables)`. | ||
| - `nbElements == len(publicVariables) + len(secretVariables)`. |
There was a problem hiding this comment.
Could probably just use len(...) directly above TBH
|
Nice catch, thanks for the contribution. |
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.
The witness is prepended with more information than currently stated / it's unclear.
NB: I am not certain if this is a documentation mistake and working as intended or if it's actually not working as intended.
As far as I can tell from the code, the docs are wrong and the "full nb of element" is only serialised by happenstance because Golang does it by default for vectors.