Merge pull request #28 from Synaps3Protocol/registries/hook

Registries/hook

Author: geolffreym

broadcast/16_Upgrade_Rights_RightsPolicyAuthorizer.s.sol/80002/run-1747408115.json

@@ -4,9 +4,10 @@ pragma solidity 0.8.26;
 
 import { IAssetRegistrable } from "@synaps3/core/interfaces/assets/IAssetRegistrable.sol";
 import { IAssetVerifiable } from "@synaps3/core/interfaces/assets/IAssetVerifiable.sol";
+import { IAssetRevokable } from "@synaps3/core/interfaces/assets/IAssetRevokable.sol";
 
 /// @title IAssetReferendum
 /// @notice Unified interface for managing content registration and verifications within a referendum-based system.
 /// @dev This interface extends both IAssetRegistrable and IAssetVerifiable to provide a single entry point for
 ///      handling asset registration and verification processes.
-interface IAssetReferendum is IAssetRegistrable, IAssetVerifiable {}
+interface IAssetReferendum is IAssetRegistrable, IAssetVerifiable, IAssetRevokable {}

broadcast/16_Upgrade_Rights_RightsPolicyAuthorizer.s.sol/80002/run-1747408579.json

@@ -15,14 +15,4 @@ interface IAssetRegistrable {
     /// @dev Once approved, the asset is considered verified and usable within the system.
     /// @param assetId The unique identifier of the asset to be approved.
     function approve(uint256 assetId) external;
-
-    /// @notice Rejects an asset proposition in the referendum.
-    /// @dev If rejected, the asset cannot be used in the system unless resubmitted.
-    /// @param assetId The unique identifier of the asset to be rejected.
-    function reject(uint256 assetId) external;
-
-    /// @notice Revokes a previously approved asset.
-    /// @dev This function allows the system to remove approval from an asset, disabling its functionality.
-    /// @param assetId The unique identifier of the asset to be revoked.
-    function revoke(uint256 assetId) external;
 }

broadcast/16_Upgrade_Rights_RightsPolicyAuthorizer.s.sol/80002/run-latest.json

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: BUSL-1.1
+// NatSpec format convention - https://docs.soliditylang.org/en/v0.5.10/natspec-format.html
+pragma solidity 0.8.26;
+
+/// @title IAssetRevokable Interface
+/// @notice Defines the functions for invalidating or withdrawing assets from the system.
+/// @dev This interface focuses on asset rejection and revocation, used in the governance lifecycle.
+interface IAssetRevokable {
+    /// @notice Rejects an asset proposition in the referendum.
+    /// @dev If rejected, the asset cannot be used in the system unless resubmitted.
+    /// @param assetId The unique identifier of the asset to be rejected.
+    function reject(uint256 assetId) external;
+
+    /// @notice Revokes a previously approved asset.
+    /// @dev This function allows the system to remove approval from an asset, disabling its functionality.
+    /// @param assetId The unique identifier of the asset to be revoked.
+    function revoke(uint256 assetId) external;
+}

contracts/core/interfaces/assets/IAssetReferendum.sol

@@ -2,12 +2,9 @@
 // NatSpec format convention - https://docs.soliditylang.org/en/v0.5.10/natspec-format.html
 pragma solidity 0.8.26;
 
-import { IBalanceVerifiable } from "@synaps3/core/interfaces/base/IBalanceVerifiable.sol";
-import { IBalanceWithdrawable } from "@synaps3/core/interfaces/base/IBalanceWithdrawable.sol";
-
 /// @title ICustodian
 /// @notice Interface for custodian contracts responsible for managing content custody.
-interface ICustodian is IBalanceVerifiable, IBalanceWithdrawable {
+interface ICustodian {
     /// @notice Set the endpoint of the custodian.
     /// @dev This function can only be called by the owner of the contract.
     /// @param _endpoint The new custodian's endpoint.

contracts/core/interfaces/assets/IAssetRegistrable.sol

@@ -2,11 +2,9 @@
 // NatSpec format convention - https://docs.soliditylang.org/en/v0.5.10/natspec-format.html
 pragma solidity 0.8.26;
 
-import { IBalanceOperator } from "@synaps3/core/interfaces/base/IBalanceOperator.sol";
-
 /// @title ITreasury Interface
 /// @notice Defines the standard functions for a Treasury contract.
-interface ITreasury is IBalanceOperator {
+interface ITreasury {
     /// @notice Collects accrued fees for a specified currency from an authorized fee collector.
     /// @param collector The address of an authorized fee collector.
     /// @param currency The address of the currency for which fees are being collected.

contracts/core/interfaces/assets/IAssetRevokable.sol

@@ -6,13 +6,17 @@ pragma solidity 0.8.26;
 /// @notice Interface for registering and managing custodial rights over assets.
 /// @dev This interface provides functions for granting and revoking custodial rights.
 interface IRightsAssetCustodianRegistrable {
-    /// @notice Grants custodial rights over the asset held by a holder to a custodian.
-    /// @dev Assigns the specified custodian as a custodian, allowing them to manage the holder's asset.
-    /// @param custodian The address of the custodian who will receive custodial rights.
+    /// @notice Assigns custodial rights over the caller's content to a specified custodian.
+    /// @param custodian The address of the custodian to assign.
     function grantCustody(address custodian) external;
 
     /// @notice Revokes custodial rights of a custodian for the caller's assets.
-    /// @dev Removes the specified custodian from the custody registry of the caller.
     /// @param custodian The address of the custodian to revoke custody from.
     function revokeCustody(address custodian) external;
+
+    /// @notice Sets a custom priority value for a specific custodian assigned to the caller.
+    /// @dev Influences the weighting in the balancing algorithm used to select custodians.
+    /// @param custodian The custodian whose priority is being set.
+    /// @param priority The priority value to assign. Must be >= 1.
+    function setPriority(address custodian, uint256 priority) external;
 }

contracts/core/interfaces/custody/ICustodian.sol

@@ -3,25 +3,34 @@
 pragma solidity 0.8.26;
 
 /// @title IRightsAssetCustodianVerifiable
-/// @notice Interface for verifying and retrieving custody-related data.
-/// @dev This interface provides read-access functions to check custodianship status and custody records.
+/// @notice Interface for verifying custodian assignments and querying custody-related data.
+/// @dev Includes read-access functions used in balancing and audit operations.
 interface IRightsAssetCustodianVerifiable {
-    /// @notice Checks if a given custodian is a custodian for the specified content holder.
-    /// @dev Returns true if the custodian has custodial rights over the holder's assets.
+    /// @notice Checks whether a custodian is currently assigned to a holder.
+    /// @dev Returns true only if the custodian is active and listed for the specified holder.
     /// @param holder The address of the asset rights holder.
-    /// @param custodian The address of the custodian to check.
-    /// @return True if the custodian is a custodian, false otherwise.
+    /// @param custodian The address of the custodian to verify.
+    /// @return True if `custodian` is valid and assigned to `holder`, false otherwise.
     function isCustodian(address holder, address custodian) external view returns (bool);
 
-    /// @notice Retrieves the addresses of all custodians assigned to a given content holder.
-    /// @dev Returns an array of addresses representing custodians for the specified asset holder.
-    /// @param holder The address of the asset rights holder whose custodians are being retrieved.
-    /// @return An array of addresses of assigned custodians.
-    function getCustodians(address holder) external view returns (address[] memory);
+    /// @notice Returns a custodian selected by a probabilistic balancing algorithm.
+    /// @dev The selection is based on priority, demand and economic weight (balance).
+    /// @param holder The address of the asset holder requesting a custodian.
+    /// @param currency The currency used to evaluate the custodian's balance.
+    /// @return The selected custodian address.
+    function getBalancedCustodian(address holder, address currency) external view returns (address);
 
-    /// @notice Retrieves the total number of asset items in custody for a given custodian.
-    /// @dev Returns the number of assets managed by the specified custodian.
-    /// @param custodian The address of the custodian whose custodial content count is being requested.
-    /// @return The total number of assets held in custody by the custodian.
+    /// @notice Retrieves the total number of holders assigned to a custodian.
+    /// @dev Represents the current load (demand) of a custodian in terms of assignments.
+    /// @param custodian The custodian address to query.
+    /// @return The number of holders currently assigned to the custodian.
     function getCustodyCount(address custodian) external view returns (uint256);
+
+    /// @notice Calculates the weighted score of a custodian for a specific holder and currency.
+    /// @dev Used to externally query the score that influences custodian selection.
+    /// @param holder The address of the rights holder.
+    /// @param custodian The address of the custodian.
+    /// @param currency The token used to evaluate economic backing.
+    /// @return The computed weight used in the balancing algorithm.
+    function calcWeight(address holder, address custodian, address currency) external view returns (uint256);
 }