refactor: reestructure and decouple right manager

Author: geolffreym

README.md

@@ -4,9 +4,18 @@
 
 MMC: 0x21173483074a46c302c4252e04c76fA90e6DdA6C
 
+
+Cnv:
+    guidelines for emitting events
+    - Any function that can change a storage variable should emit an event.
+    - The event should contain enough information for someone auditing the logs can determine what value the storage variable took at that time.
+    - Any address parameters in the event should be indexed so that it is easy to drill down on the activity of a particular wallet.
+    - View and pure functions should not contain events because they do not change the state.
+
 refs:
 
-https://github.com/crytic/building-secure-contracts/blob/master/development-guidelines/code_maturity.md#blockchain-maturity-evaluation
+https://github.com/crytic/building-secure-contracts/blob/master/development-guidelines/code_maturity.md
+
 https://docs.soliditylang.org/en/latest/style-guide.html
 
 

contracts/RightsManager.sol

@@ -10,23 +10,23 @@ import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/ac
 import { ERC721EnumerableUpgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721EnumerableUpgradeable.sol";
 
 import { GovernableUpgradeable } from "contracts/base/upgradeable/GovernableUpgradeable.sol";
-import { IReferendumVerifiable } from "contracts/interfaces/IReferendumVerifiable.sol";
-import { IOwnership } from "contracts/interfaces/IOwnership.sol";
+import { IContentVerifiable } from "contracts/interfaces/assets/IContentVerifiable.sol";
+import { IContentOwnership } from "contracts/interfaces/assets/IContentOwnership.sol";
 
 // TODO imp ERC404
 
 /// @title Ownership ERC721 Upgradeable
 /// @notice This abstract contract manages the ownership.
-contract Ownership is
+contract ContentOwnership is
     Initializable,
     UUPSUpgradeable,
-    GovernableUpgradeable,
     ERC721Upgradeable,
+    GovernableUpgradeable,
     ERC721EnumerableUpgradeable,
-    IOwnership
+    IContentOwnership
 {
-    IReferendumVerifiable public referendum;
-    event RegisteredContent(uint256 contentId);
+    IContentVerifiable public contentReferendum;
+    event RegisteredContent(address indexed owner, uint256 contentId);
     error InvalidNotApprovedContent();
     /// @notice Modifier to ensure content is approved before distribution.
     /// @param to The address attempting to distribute the content.
@@ -36,7 +36,7 @@ contract Ownership is
     /// It also ensures that the recipient is the one who initially submitted the content for approval.
     modifier onlyApprovedContent(address to, uint256 contentId) {
         // Revert if the content is not approved or if the recipient is not the original submitter
-        if (!referendum.isApproved(to, contentId)) revert InvalidNotApprovedContent();
+        if (!contentReferendum.isApproved(to, contentId)) revert InvalidNotApprovedContent();
         _;
     }
 
@@ -58,15 +58,16 @@ contract Ownership is
     }
 
     /// @notice Initializes the contract with the given dependencies, including the Referendum contract for governance-related verifications.
-    /// @param referendum_ The address of the Referendum contract, which is responsible for verifying governance decisions related to content.
+    /// @param contentReferendum_ The address of the Content Referendum contract, which is responsible for verifying governance decisions related to content.
     /// @dev This function can only be called once during the contract's deployment. It sets up UUPS upgradeability,
     /// ERC721 token functionality, and governance mechanisms. The Referendum contract is linked to handle governance verifications.
-    function initialize(address referendum_) public initializer {
+    function initialize(address contentReferendum_) public initializer {
         __UUPSUpgradeable_init();
         __ERC721Enumerable_init();
         __ERC721_init("Ownership", "OWN");
         __Governable_init(msg.sender);
-        referendum = IReferendumVerifiable(referendum_);
+        // we need to verify the status of each content before allow register it.
+        contentReferendum = IContentVerifiable(contentReferendum_);
     }
 
     /// @notice Checks if the contract supports a specific interface.
@@ -90,7 +91,7 @@ contract Ownership is
     /// @param contentId The content id of the NFT. This should be a unique identifier for the NFT.
     function registerContent(address to, uint256 contentId) external onlyApprovedContent(to, contentId) {
         _mint(to, contentId);
-        emit RegisteredContent(contentId);
+        emit RegisteredContent(to, contentId);
     }
 
     /// @dev Internal function to update the ownership of a token.

contracts/Ownership.sol contracts/assets/ContentOwnership.solcontracts/Ownership.sol renamed to contracts/assets/ContentOwnership.sol

@@ -11,35 +11,30 @@ import { Address } from "@openzeppelin/contracts/utils/Address.sol";
 
 import { GovernableUpgradeable } from "contracts/base/upgradeable/GovernableUpgradeable.sol";
 import { QuorumUpgradeable } from "contracts/base/upgradeable/QuorumUpgradeable.sol";
-import { IReferendum } from "contracts/interfaces/IReferendum.sol";
-import { IReferendumRoleManager } from "contracts/interfaces/IReferendumRoleManager.sol";
-import { IReferendumVerifiable } from "contracts/interfaces/IReferendumVerifiable.sol";
+import { IContentRegistrable } from "contracts/interfaces/assets/IContentRegistrable.sol";
+import { IContentRoleManager } from "contracts/interfaces/assets/IContentRoleManager.sol";
+import { IContentVerifiable } from "contracts/interfaces/assets/IContentVerifiable.sol";
 
 import { C } from "contracts/libraries/Constants.sol";
 import { T } from "contracts/libraries/Types.sol";
 
 /// @title Content curation contract.
 /// @notice This contract allows for the submission, voting, and approval/rejection of content.
-contract Referendum is
+contract ContentReferendum is
     Initializable,
     UUPSUpgradeable,
     GovernableUpgradeable,
     NoncesUpgradeable,
     EIP712Upgradeable,
     QuorumUpgradeable,
-    IReferendum,
-    IReferendumVerifiable,
-    IReferendumRoleManager
+    IContentRegistrable,
+    IContentVerifiable,
+    IContentRoleManager
 {
     using EnumerableSet for EnumerableSet.UintSet;
     mapping(address => EnumerableSet.UintSet) private submissions;
     // This role is granted to any representant trusted account. eg: Verified Accounts, etc.
     bytes32 private constant VERIFIED_ROLE = keccak256("VERIFIED_ROLE");
-
-    // Error to be thrown when the submission initiator is invalid.
-    error InvalidSubmissionSignature();
-    error InvalidSubmissionInitiator();
-
     /// @dev Event emitted when a content is submitted for referendum.
     /// @param contentId The ID of the content submitted.
     /// @param initiator The address of the initiator who submitted the content.
@@ -51,6 +46,16 @@ contract Referendum is
     /// @dev Event emitted when a content is revoked.
     /// @param contentId The ID of the content revoked.
     event ContentRevoked(uint256 indexed contentId);
+    /// @notice Emitted when the verified role is granted to an account.
+    /// @param account The address of the account that has been granted the verified role.
+    event VerifiedRoleGranted(address indexed account);
+
+    /// @notice Emitted when the verified role is revoked from an account.
+    /// @param account The address of the account from which the verified role has been revoked.
+    event VerifiedRoleRevoked(address indexed account);
+    // Error to be thrown when the submission initiator is invalid.
+    error InvalidSubmissionSignature();
+    error InvalidSubmissionInitiator();
 
     /// @dev Constructor that disables initializers to prevent the implementation contract from being initialized.
     /// @notice This constructor prevents the implementation contract from being initialized.
@@ -63,7 +68,6 @@ contract Referendum is
 
     /// @notice Initializes the contract.
     function initialize() public initializer {
-        __Quorum_init();
         __UUPSUpgradeable_init();
         __EIP712_init("Referendum", "1");
         __Governable_init(msg.sender);
@@ -74,15 +78,15 @@ contract Referendum is
     /// @dev Only governance is allowed to grant the role.
     function grantVerifiedRole(address account) external onlyGov {
         _grantRole(VERIFIED_ROLE, account);
-        // TODO emit event
+        emit VerifiedRoleGranted(account);
     }
 
     /// @notice Revoke the verified role to a specific account.
     /// @param account The address of the account to revoke.
     /// @dev Only governance is allowed to revoke the role.
     function revokeVerifiedRole(address account) external onlyGov {
         _revokeRole(VERIFIED_ROLE, account);
-        // TODO emit event
+        emit VerifiedRoleRevoked(account);
     }
 
     /// @notice Submits a content proposition for referendum.

contracts/Referendum.sol contracts/assets/ContentReferendum.solcontracts/Referendum.sol renamed to contracts/assets/ContentReferendum.sol

@@ -5,8 +5,8 @@ import { UUPSUpgradeable } from "@openzeppelin/contracts-upgradeable/proxy/utils
 import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 
 import { GovernableUpgradeable } from "contracts/base/upgradeable/GovernableUpgradeable.sol";
-import { IOwnership } from "contracts/interfaces/IOwnership.sol";
-import { IContentVault } from "contracts/interfaces/IContentVault.sol";
+import { IContentOwnership } from "contracts/interfaces/assets/IContentOwnership.sol";
+import { IContentVault } from "contracts/interfaces/assets/IContentVault.sol";
 
 /// @title ContentVault
 /// @notice This contract stores encrypted content and ensures only the rightful content holder
@@ -16,7 +16,7 @@ import { IContentVault } from "contracts/interfaces/IContentVault.sol";
 /// and inherits Governable for governance control.
 contract ContentVault is Initializable, UUPSUpgradeable, GovernableUpgradeable, IContentVault {
     /// @notice The Ownership contract that tracks content holders.
-    IOwnership public ownership;
+    IContentOwnership public ownership;
     /// @dev Mapping to store encrypted content, identified by content ID.
     mapping(uint256 => bytes) private secured;
     /// @notice Error thrown when a non-owner tries to modify or access the content.
@@ -46,7 +46,7 @@ contract ContentVault is Initializable, UUPSUpgradeable, GovernableUpgradeable,
     function initialize(address ownership_) public initializer {
         __UUPSUpgradeable_init();
         __Governable_init(msg.sender);
-        ownership = IOwnership(ownership_);
+        ownership = IContentOwnership(ownership_);
     }
 
     /// @notice Retrieves the encrypted content for a given content ID.