Merge pull request #27 from Synaps3Protocol/registries/hook

Registries/hook

Author: geolffreym

.env.vault

@@ -54,7 +54,7 @@ force-compile:
 
 .PHONY: test ## run tests
 test:
-	@CI=true && forge test --show-progress --gas-report -vvv  --fail-fast 
+	@export CI=true && forge test --show-progress --gas-report -vvvv 
 
 .PHONY: coverage ## run tests coverage report
 coverage:

Makefile

@@ -31,9 +31,44 @@ contract AccessManager is Initializable, UUPSUpgradeable, AccessManagerUpgradeab
         //     return (true, getRoleAdmin(roleId), 0); // => (true, 0, 0)
         // }
 
+        // Strategic roles for governance classification within the protocol:
+        //
+        // Community Governance Role:
+        // - GOV_ROLE: Represents decentralized community governance.
+        // Decisions are made through collective voting mechanisms (e.g., token-weighted, quadratic).
+        //
+        // Group/Sub-DAO Based Roles:
+        // - ADMIN_ROLE: Managed by a smart account or sub-DAO.
+        // Handles protocol upgrades, pause mechanisms, and operational role assignments.
+        // - MOD_ROLE: Managed by a smart account or sub-DAO.
+        // Approves policy submissions and moderates hook operations.
+        // - REF_ROLE: Managed by a smart account or sub-DAO.
+        // Participates in governance referenda for content curation and distributor selection.
+        //
+        // Individual/Contract Based Roles:
+        // - OPS_ROLE: Internal operational role assigned to protocol-trusted contracts
+        // for direct module interactions. No human involvement.
+        // - VER_ROLE: Individual role assigned to trusted creators, enabling
+        // content uploads without conventional verification.
+
+        /*
+            GOV_ROLE (Community Governance)
+            │
+            ├── ADMIN_ROLE (Smart Account / Sub-DAO)
+            │   │
+            │   ├── MOD_ROLE (Smart Account / Sub-DAO)
+            │   │
+            │   └── OPS_ROLE (Internal Contract Role)
+            │
+            ├── REF_ROLE (Smart Account / Sub-DAO)
+            │
+            ├── VER_ROLE (Individual Trusted Creator)
+        */
+
+        _setRoleAdmin(C.VER_ROLE, C.GOV_ROLE);
+        _setRoleAdmin(C.REF_ROLE, C.GOV_ROLE);
         _setRoleAdmin(C.MOD_ROLE, C.ADMIN_ROLE);
         _setRoleAdmin(C.OPS_ROLE, C.ADMIN_ROLE);
-        _setRoleAdmin(C.VER_ROLE, C.GOV_ROLE);
     }
 
     // TODO pause protocol based on permission and roles

contracts/access/AccessManager.sol

@@ -0,0 +1,2 @@
+// pause protocol using:
+// pause manager + pausable

contracts/access/eg.PauseManager

@@ -38,12 +38,12 @@ contract AssetOwnership is
     /// @dev Emitted when a new asset is registered on the platform.
     /// @param owner The address of the creator or owner of the registered asset.
     /// @param assetId The unique identifier for the registered asset.
-    event RegisteredAsset(address indexed owner, uint256 assetId);
+    event RegisteredAsset(address indexed owner, uint256 indexed assetId);
 
     /// @dev Emitted when an asset is revoked and removed from the platform.
     /// @param owner The address of the owner of the revoked asset.
     /// @param assetId The unique identifier for the revoked asset.
-    event RevokedAsset(address indexed owner, uint256 assetId);
+    event RevokedAsset(address indexed owner, uint256 indexed assetId);
 
     /// @dev Emitted when an asset is transferred from one owner to another.
     /// @param from The address of the current owner of the asset.
@@ -112,6 +112,7 @@ contract AssetOwnership is
     }
 
     // TODO: build getURI => from custodian /erc721-metadata
+    // TODO: Update asset info control version restricted/approved by governance
     // TODO: Transfer Ownership Fee: Introducing a fee for transferring
     // ownership discourages frequent or unnecessary transfers,
     // adding an economic cost to any potential abuse of the system. Like bypassing content

contracts/assets/AssetOwnership.sol

@@ -3,14 +3,13 @@
 pragma solidity 0.8.26;
 
 import { UUPSUpgradeable } from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
-import { EIP712Upgradeable } from "@openzeppelin/contracts-upgradeable/utils/cryptography/EIP712Upgradeable.sol";
-import { NoncesUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/NoncesUpgradeable.sol";
 import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import { EnumerableSet } from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
 import { AccessControlledUpgradeable } from "@synaps3/core/primitives/upgradeable/AccessControlledUpgradeable.sol";
 import { QuorumUpgradeable } from "@synaps3/core/primitives/upgradeable/QuorumUpgradeable.sol";
 import { IAssetReferendum } from "@synaps3/core/interfaces/assets/IAssetReferendum.sol";
+import { T } from "@synaps3/core/primitives/Types.sol";
 import { C } from "@synaps3/core/primitives/Constants.sol";
 
 /// @title AssetReferendum
@@ -20,8 +19,6 @@ contract AssetReferendum is
     Initializable,
     UUPSUpgradeable,
     AccessControlledUpgradeable,
-    NoncesUpgradeable,
-    EIP712Upgradeable,
     QuorumUpgradeable,
     IAssetReferendum
 {
@@ -34,19 +31,19 @@ contract AssetReferendum is
     /// @dev Event emitted when a content is submitted for referendum.
     /// @param assetId The ID of the asset that has been submitted.
     /// @param initiator The address of the initiator who submitted the asset.
-    event Submitted(address indexed initiator, uint256 assetId);
+    event Submitted(address indexed initiator, uint256 indexed assetId);
 
     /// @dev Event emitted when a content is approved.
     /// @param assetId The ID of the asset that has been approved.
-    event Approved(uint256 assetId);
+    event Approved(uint256 indexed assetId);
 
     /// @dev Event emitted when a content is revoked.
     /// @param assetId The ID of the asset that has been revoked.
-    event Revoked(uint256 assetId);
+    event Revoked(uint256 indexed assetId);
 
     /// @dev Event emitted when a content is rejected.
     /// @param assetId The ID of the asset that has been rejected.
-    event Rejected(uint256 assetId);
+    event Rejected(uint256 indexed assetId);
 
     /// @dev Error thrown when asset submission fails.
     /// @param initiator The address of the user who attempted to submit the asset.
@@ -66,7 +63,6 @@ contract AssetReferendum is
     function initialize(address accessManager) public initializer {
         __Quorum_init();
         __UUPSUpgradeable_init();
-        __EIP712_init("Referendum", "1");
         __AccessControlled_init(accessManager);
     }
 
@@ -133,7 +129,7 @@ contract AssetReferendum is
     /// @notice Checks if the asset is active nor blocked.
     /// @param assetId The ID of the asset.
     function isActive(uint256 assetId) public view returns (bool) {
-        return _status(assetId) == Status.Active;
+        return _status(assetId) == T.Status.Active;
     }
 
     /// @notice Function that should revert when msg.sender is not authorized to upgrade the contract.

contracts/assets/AssetReferendum.sol

@@ -0,0 +1 @@
+// dispute rights via governance

contracts/assets/eg.AssetDisputes

@@ -4,8 +4,7 @@ pragma solidity 0.8.26;
 
 /// @title IAssetRegistrable Interface
 /// @notice Defines the essential functions for managing asset registration and governance through a referendum process.
-/// @dev Implement this interface in a referendum contract to allow
-///      asset proposals, approvals, rejections, and revocations.
+/// @dev This interface mirrors the FSM behavior from `IQuorum`, but scoped to asset governance.
 interface IAssetRegistrable {
     /// @notice Submits a new asset proposition for a referendum.
     /// @dev This function should allow entities to propose an asset for approval.

contracts/core/interfaces/assets/IAssetRegistrable.sol

@@ -2,14 +2,14 @@
 // NatSpec format convention - https://docs.soliditylang.org/en/v0.5.10/natspec-format.html
 pragma solidity 0.8.26;
 
-/// @title IBalanceOperator Interface
-/// @notice Combines functionalities for verifying, depositing, withdrawing, and transferring balances.
-/// @dev This interface aggregates multiple interfaces to standardize balance-related operations.
 import { IBalanceDepositor } from "@synaps3/core/interfaces/base/IBalanceDepositor.sol";
 import { IBalanceWithdrawable } from "@synaps3/core/interfaces/base/IBalanceWithdrawable.sol";
 import { IBalanceTransferable } from "@synaps3/core/interfaces/base/IBalanceTransferable.sol";
 import { IBalanceVerifiable } from "@synaps3/core/interfaces/base/IBalanceVerifiable.sol";
 
+/// @title IBalanceOperator Interface
+/// @notice Combines functionalities for verifying, depositing, withdrawing, and transferring balances.
+/// @dev This interface aggregates multiple interfaces to standardize balance-related operations.
 /// @dev The `IBalanceOperator` interface extends multiple interfaces to provide a comprehensive suite of
 /// balance-related operations, including deposit, withdrawal, transfer, reserve, and balance verification.
 interface IBalanceOperator is IBalanceDepositor, IBalanceWithdrawable, IBalanceTransferable, IBalanceVerifiable {}

contracts/core/interfaces/base/IBalanceOperator.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity 0.8.26;
+
+import { IQuorumRegistrable } from "@synaps3/core/interfaces/base/IQuorumRegistrable.sol";
+import { IQuorumRevokable } from "@synaps3/core/interfaces/base/IQuorumRevokable.sol";
+import { IQuorumInspectable } from "@synaps3/core/interfaces/base/IQuorumInspectable.sol";
+
+/// @title IQuorum
+/// @notice Aggregates the full lifecycle of an FSM-driven entity registration system.
+/// @dev Combines registration, approval, rejection, revocation, and status inspection.
+///      Intended for systems that use `QuorumUpgradeable` as FSM logic layer.
+interface IQuorum is IQuorumRegistrable, IQuorumRevokable, IQuorumInspectable {}