Convert module role hats to mutable #1
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
gershido
requested changes
May 12, 2024
There was a problem hiding this comment.
In addition to the comments, the rest of the functions documentation includes still the previous names - OWNER_HAT and ARBITRATOR_HAT. Regarding emitting events in the setup, it's easier with the events but we can also parse the initialization data in the subgraph handler if necessary, so both work.
src/AllowlistEligibility.sol
Outdated
|
|
||
| /** | ||
| * @notice Set a new arbitrator hat | ||
| * @dev Only callable by a wearer of the current arbitratorHat, and only if the target hat is mutable |
There was a problem hiding this comment.
Documentation fix: "ownerHat" instead of "arbitratorHat". Or is the intention here is to provide the permission to the arbitrator?
src/AllowlistEligibility.sol
Outdated
Comment on lines
363
to
382
| /** | ||
| * @dev Set a new owner hat | ||
| * @param _newOwnerHat The new owner hat | ||
| */ | ||
| function _setOwnerHat(uint256 _newOwnerHat) public { | ||
| ownerHat = _newOwnerHat; | ||
|
|
||
| emit OwnerHatSet(_newOwnerHat); | ||
| } | ||
|
|
||
| /** | ||
| * @dev Set a new arbitrator hat | ||
| * @param _newArbitratorHat The new arbitrator hat | ||
| */ | ||
| function _setArbitratorHat(uint256 _newArbitratorHat) public { | ||
| arbitratorHat = _newArbitratorHat; | ||
|
|
||
| emit ArbitratorHatSet(_newArbitratorHat); | ||
| } | ||
|
|
There was a problem hiding this comment.
The functions visibility is accidentally public
README.md
Outdated
| ### Humanistic Functionality | ||
|
|
||
| - Wearer(s) of the `ownerHat` can manually revoke an account's hat by calling `removeAccountAndBurnHat()`. | ||
| - Wearer(s) of the `arbitrator` can manually put an account in bad standing and burn their hat `setStandingForAccountAndBurnHat()`. |
README.md
Outdated
|
|
||
| - Wearer(s) of the `ownerHat` can simply add account(s) to the allowlist by calling `addAccount()` or `addAccounts()`. | ||
| - Wearer(s) of the `ownerHat` can simply remove account(s) from the allowlist by calling `removeAccount()` or `removeAccounts()`. | ||
| - Wearer(s) of the `arbitrator` can simply set the standing of account(s) by calling `setStandingForAccount()` or `setStandingForAccounts()`. |
README.md
Outdated
| @@ -4,20 +4,22 @@ A [Hats Protocol](https://github.com/hats-protocol/hats-protocol) eligibility mo | |||
|
|
|||
| ## Overview and Usage | |||
|
|
|||
| This module sets up a simple allowlist to determine eligibility for a hat. For a given account (i.e., potential hat wearer), the allowlist stores values for that account's eligibility and standing for the hat. The wearer(s) of the `OWNER_HAT` can add or remove accounts from the allowlist. The wearer(s) of the `ARBITRATOR_HAT` can set the standing of accounts. | |||
| This module sets up a simple allowlist to determine eligibility for a hat. For a given account (i.e., potential hat wearer), the allowlist stores values for that account's eligibility and standing for the hat. The wearer(s) of the `ownerHat` can add or remove accounts from the allowlist. The wearer(s) of the `arbitrator` can set the standing of accounts. | |||
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.
Converts ownerHat and arbitratorHat from immutable "constants" to mutable storage values.
The reason to do this is that this module is stateful, which adds friction to migrating to a new instance in order to update owner or arbitrator roles.
There are two primary benefits of immutable config on modules
We can get the benefits of (1) in a mutable scenario by constraining changes to when the hat is mutable.