Clarify constraint descriptor for v_old and root == anchor to indicate inclusive OR #458
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.
In src/circuit.rs#L241, the constraint is currently described as:
"Either v_old = 0, or root = anchor"
However, this phrasing can be read as an exclusive-or (XOR), suggesting that not both conditions can be true at once.
To prevent confusion, the PR rephrased the comment/descriptor to
"v_old = 0, or root = anchor"
so it clearly indicates an inclusive-or rather than an exclusive-or. This will help auditors avoid misreading the condition as prohibiting both v_old == 0 and root == anchor from being true simultaneously.