docs: document the missing onlyBetweenPermitted modifier - #83
Open
Dusk1e wants to merge 1 commit into
Open
Conversation
Permissioned.sol has three modifiers but the Solidity API reference lists two. onlyBetweenPermitted is absent, and it is the one behind FHERC20.allowanceEncrypted, which uses it so that both the owner and the spender can read an allowance. It landed in fhenix-contracts 781b3d0 (2024-07-28), five months after this page was last touched (2024-02-26), and the reference was never updated. The name does not appear anywhere in this repo. Added in the page's existing format, wording taken from the contract's NatSpec. The Helium snapshot was cut 2024-11-04, after the modifier landed, and the two copies are byte-identical, so both are updated to keep them in sync.
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
1 participant
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.
Permissioned.solhas three modifiers but the API reference lists two.onlyBetweenPermittedis missing, and it's the one behindFHERC20.allowanceEncrypted, which uses it so both the owner and the spender can read an allowance.It landed in fhenix-contracts
781b3d0(2024-07-28), five months after this page was last touched (2024-02-26), and the reference was never updated. The name doesn't appear anywhere in this repo.Added in the page's existing format, wording taken from the contract's NatSpec. The Helium snapshot was cut 2024-11-04, after the modifier landed, and the two copies are byte-identical, so I updated both to keep them in sync. Happy to drop the versioned one if you'd rather leave snapshots frozen.