Unified contributor management

Two methods to manage the contributor role have been merged into a single one. The change was propagated to relevant tests. (cherry picked from commit 8633a0c)
daibi · Jan 17, 2023 · 6aef40d · 6aef40d
1 parent d56ebe0
commit 6aef40d
Show file tree

Hide file tree

Showing 29 changed files with 431 additions and 794 deletions.
diff --git a/contracts/RMRK/access/Ownable.sol b/contracts/RMRK/access/Ownable.sol
@@ -97,24 +97,21 @@ contract Ownable is Context {
     }
 
     /**
-     * @notice Adds a contributor to the smart contract.
+     * @notice Adds or removes a contributor to the smart contract.
      * @dev Can only be called by the owner.
      * @param contributor Address of the contributor's account
+     * @param grantRole A boolean value signifying whether the contributor role is being granted (`true`) or revoked
+     *  (`false`)
      */
-    function addContributor(address contributor) external onlyOwner {
+    function manageContributor(
+        address contributor,
+        bool grantRole
+    ) external onlyOwner {
         if (contributor == address(0)) revert RMRKNewContributorIsZeroAddress();
-        _contributors[contributor] = 1;
-        emit ContributorUpdate(contributor, true);
-    }
-
-    /**
-     * @notice Removes a contributor from the smart contract.
-     * @dev Can only be called by the owner.
-     * @param contributor Address of the contributor's account
-     */
-    function revokeContributor(address contributor) external onlyOwner {
-        delete _contributors[contributor];
-        emit ContributorUpdate(contributor, false);
+        grantRole
+            ? _contributors[contributor] = 1
+            : _contributors[contributor] = 0;
+        emit ContributorUpdate(contributor, grantRole);
     }
 
     /**

diff --git a/docs/RMRK/access/Ownable.md b/docs/RMRK/access/Ownable.md
@@ -10,22 +10,6 @@ A minimal ownable smart contractf or owner and contributors.
 
 ## Methods
 
-### addContributor
-
-```solidity
-function addContributor(address contributor) external nonpayable
-```
-
-Adds a contributor to the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### isContributor
 
 ```solidity
@@ -48,6 +32,23 @@ Used to check if the address is one of the contributors.
 |---|---|---|
 | _0 | bool | Boolean value indicating whether the address is a contributor or not |
 
+### manageContributor
+
+```solidity
+function manageContributor(address contributor, bool grantRole) external nonpayable
+```
+
+Adds or removes a contributor to the smart contract.
+
+*Can only be called by the owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| contributor | address | Address of the contributor&#39;s account |
+| grantRole | bool | A boolean value signifying whether the contributor role is being granted (`true`) or revoked  (`false`) |
+
 ### owner
 
 ```solidity
@@ -76,22 +77,6 @@ Leaves the contract without owner. Functions using the `onlyOwner` modifier will
 *Can only be called by the current owner.Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is  only available to the owner.*
 
 
-### revokeContributor
-
-```solidity
-function revokeContributor(address contributor) external nonpayable
-```
-
-Removes a contributor from the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### transferOwnership
 
 ```solidity

diff --git a/docs/RMRK/access/OwnableLock.md b/docs/RMRK/access/OwnableLock.md
@@ -10,22 +10,6 @@ A minimal ownable lock smart contract.
 
 ## Methods
 
-### addContributor
-
-```solidity
-function addContributor(address contributor) external nonpayable
-```
-
-Adds a contributor to the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### getLock
 
 ```solidity
@@ -65,6 +49,23 @@ Used to check if the address is one of the contributors.
 |---|---|---|
 | _0 | bool | Boolean value indicating whether the address is a contributor or not |
 
+### manageContributor
+
+```solidity
+function manageContributor(address contributor, bool grantRole) external nonpayable
+```
+
+Adds or removes a contributor to the smart contract.
+
+*Can only be called by the owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| contributor | address | Address of the contributor&#39;s account |
+| grantRole | bool | A boolean value signifying whether the contributor role is being granted (`true`) or revoked  (`false`) |
+
 ### owner
 
 ```solidity
@@ -93,22 +94,6 @@ Leaves the contract without owner. Functions using the `onlyOwner` modifier will
 *Can only be called by the current owner.Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is  only available to the owner.*
 
 
-### revokeContributor
-
-```solidity
-function revokeContributor(address contributor) external nonpayable
-```
-
-Removes a contributor from the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### setLock
 
 ```solidity

diff --git a/docs/RMRK/utils/RMRKMintingUtils.md b/docs/RMRK/utils/RMRKMintingUtils.md
@@ -10,22 +10,6 @@ Smart contract of the RMRK minting utils module.
 
 ## Methods
 
-### addContributor
-
-```solidity
-function addContributor(address contributor) external nonpayable
-```
-
-Adds a contributor to the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### getLock
 
 ```solidity
@@ -65,6 +49,23 @@ Used to check if the address is one of the contributors.
 |---|---|---|
 | _0 | bool | Boolean value indicating whether the address is a contributor or not |
 
+### manageContributor
+
+```solidity
+function manageContributor(address contributor, bool grantRole) external nonpayable
+```
+
+Adds or removes a contributor to the smart contract.
+
+*Can only be called by the owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| contributor | address | Address of the contributor&#39;s account |
+| grantRole | bool | A boolean value signifying whether the contributor role is being granted (`true`) or revoked  (`false`) |
+
 ### maxSupply
 
 ```solidity
@@ -127,22 +128,6 @@ Leaves the contract without owner. Functions using the `onlyOwner` modifier will
 *Can only be called by the current owner.Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is  only available to the owner.*
 
 
-### revokeContributor
-
-```solidity
-function revokeContributor(address contributor) external nonpayable
-```
-
-Removes a contributor from the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### setLock
 
 ```solidity

diff --git a/docs/implementations/RMRKCatalogImpl.md b/docs/implementations/RMRKCatalogImpl.md
@@ -10,22 +10,6 @@ Implementation of RMRK catalog.
 
 ## Methods
 
-### addContributor
-
-```solidity
-function addContributor(address contributor) external nonpayable
-```
-
-Adds a contributor to the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### addEquippableAddresses
 
 ```solidity
@@ -237,6 +221,23 @@ Used to check if the address is one of the contributors.
 |---|---|---|
 | _0 | bool | Boolean value indicating whether the address is a contributor or not |
 
+### manageContributor
+
+```solidity
+function manageContributor(address contributor, bool grantRole) external nonpayable
+```
+
+Adds or removes a contributor to the smart contract.
+
+*Can only be called by the owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| contributor | address | Address of the contributor&#39;s account |
+| grantRole | bool | A boolean value signifying whether the contributor role is being granted (`true`) or revoked  (`false`) |
+
 ### owner
 
 ```solidity
@@ -281,22 +282,6 @@ Used to remove all of the `equippableAddresses` for a `Part` associated with the
 |---|---|---|
 | partId | uint64 | ID of the part that we are clearing the `equippableAddresses` from |
 
-### revokeContributor
-
-```solidity
-function revokeContributor(address contributor) external nonpayable
-```
-
-Removes a contributor from the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### setEquippableAddresses
 
 ```solidity

diff --git a/docs/implementations/abstracts/RMRKAbstractEquippableImpl.md b/docs/implementations/abstracts/RMRKAbstractEquippableImpl.md
@@ -122,22 +122,6 @@ Used to add a child token to a given parent token.
 | childId | uint256 | ID of the new proposed child token |
 | data | bytes | Additional data with no specified format |
 
-### addContributor
-
-```solidity
-function addContributor(address contributor) external nonpayable
-```
-
-Adds a contributor to the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### addEquippableAssetEntry
 
 ```solidity
@@ -757,6 +741,23 @@ Used to check if the address is one of the contributors.
 |---|---|---|
 | _0 | bool | Boolean value indicating whether the address is a contributor or not |
 
+### manageContributor
+
+```solidity
+function manageContributor(address contributor, bool grantRole) external nonpayable
+```
+
+Adds or removes a contributor to the smart contract.
+
+*Can only be called by the owner.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| contributor | address | Address of the contributor&#39;s account |
+| grantRole | bool | A boolean value signifying whether the contributor role is being granted (`true`) or revoked  (`false`) |
+
 ### maxSupply
 
 ```solidity
@@ -975,22 +976,6 @@ Leaves the contract without owner. Functions using the `onlyOwner` modifier will
 *Can only be called by the current owner.Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is  only available to the owner.*
 
 
-### revokeContributor
-
-```solidity
-function revokeContributor(address contributor) external nonpayable
-```
-
-Removes a contributor from the smart contract.
-
-*Can only be called by the owner.*
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| contributor | address | Address of the contributor&#39;s account |
-
 ### royaltyInfo
 
 ```solidity