TREX-161 : Add erc 165 (#219)

- import ERC-165
- Implement ERC-165 on T-REX
- Full Test coverage of ERC-165
- CHANGELOG

.solcover.js

@@ -4,5 +4,6 @@ module.exports = {
         "_testContracts",
         "roles/permissioning/owner/",
         "roles/permissioning/agent/",
+        "utils",
     ],
 };

CHANGELOG.md

@@ -12,13 +12,29 @@ All notable changes to this project will be documented in this file.
     - Events: `DefaultAllowance`, `DefaultAllowanceDisabled`, `DefaultAllowanceEnabled`.
   - Enhanced the `allowance` function to return `type(uint256).max` for addresses with default allowance enabled, unless the user has opted out.
 
+- **ERC-165 Interface Implementation**:
+  - Implemented ERC-165 support across all major contracts in the suite, allowing them to explicitly declare the interfaces they support. This enhancement improves interoperability and makes it easier for external contracts and tools to interact with T-REX contracts.
+  - ERC-165 support was added to the following contracts:
+    - `Token`
+    - `IdentityRegistry`
+    - `IdentityRegistryStorage`
+    - `TrustedIssuersRegistry`
+    - `ClaimTopicsRegistry`
+    - `TREXGateway`
+    - `DVATransferManager`
+    - `ModularCompliance`
+    - Compliance Modules (e.g., `CountryAllowModule`, `TransferRestrictModule`)
+    - `TREXImplementationAuthority`
+    - `IAFactory`
+  - Each contract now implements the `supportsInterface` function to identify the supported interfaces, ensuring compliance with ERC-165 standards.
+
 ## [4.1.5]
 
 ### Update
 - DvA Transfer Manager contract proxified
 - The DvA manager contract freezes the tokens to be transferred instead of being a vault (so it must be a token agent)
 - Only the token owner (rather than agents) can call setApprovalCriteria, as it is part of the main token settings.
-- 
+
 ## [4.1.4]
 
 ### Added

contracts/DVA/DVATransferManager.sol

@@ -74,8 +74,10 @@ import "./IDVATransferManager.sol";
 import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../roles/IERC173.sol";
 
-contract DVATransferManager is IDVATransferManager, Initializable, OwnableUpgradeable, UUPSUpgradeable {
+contract DVATransferManager is IDVATransferManager, Initializable, OwnableUpgradeable, UUPSUpgradeable, IERC165 {
 
     // Mapping for token approval criteria
     mapping(address => ApprovalCriteria) private _approvalCriteria;
@@ -301,6 +303,16 @@ contract DVATransferManager is IDVATransferManager, Initializable, OwnableUpgrad
         return "DVATransferManager";
     }
 
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IDVATransferManager).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
+
     /**
      *  @dev See {IDVATransferManager-calculateTransferID}
      */

contracts/compliance/modular/ModularCompliance.sol

@@ -69,6 +69,8 @@ import "./MCStorage.sol";
 import "./modules/IModule.sol";
 import "../../errors/ComplianceErrors.sol";
 import "../../errors/InvalidArgumentErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../roles/IERC173.sol";
 
 /// errors
 
@@ -89,7 +91,7 @@ error OnlyOwnerOrTokenCanCall();
 error TokenNotBound();
 
 
-contract ModularCompliance is IModularCompliance, OwnableUpgradeable, MCStorage {
+contract ModularCompliance is IModularCompliance, OwnableUpgradeable, MCStorage, IERC165 {
 
     /// modifiers
 
@@ -272,6 +274,16 @@ contract ModularCompliance is IModularCompliance, OwnableUpgradeable, MCStorage
         return true;
     }
 
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IModularCompliance).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
+
     /// @dev Extracts the Solidity ABI selector for the specified interaction.
     /// @param callData Interaction data.
     /// @return result The 4 byte function selector of the call encoded in

contracts/compliance/modular/modules/AbstractModule.sol

@@ -65,8 +65,9 @@ pragma solidity 0.8.26;
 import "./IModule.sol";
 import "../../../errors/InvalidArgumentErrors.sol";
 import "../../../errors/ComplianceErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-abstract contract AbstractModule is IModule {
+abstract contract AbstractModule is IModule, IERC165 {
 
     /// compliance contract binding status
     mapping(address => bool) private _complianceBound;
@@ -115,4 +116,13 @@ abstract contract AbstractModule is IModule {
         return _complianceBound[_compliance];
     }
 
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IModule).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
+
 }

contracts/compliance/modular/modules/AbstractModuleUpgradeable.sol

@@ -68,9 +68,11 @@ import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 import "./IModule.sol";
 import "../../../errors/InvalidArgumentErrors.sol";
 import "../../../errors/ComplianceErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../../roles/IERC173.sol";
 
 
-abstract contract AbstractModuleUpgradeable is IModule, Initializable, OwnableUpgradeable, UUPSUpgradeable {
+abstract contract AbstractModuleUpgradeable is IModule, Initializable, OwnableUpgradeable, UUPSUpgradeable, IERC165 {
     struct AbstractModuleStorage {
         /// compliance contract binding status
         mapping(address => bool) complianceBound;
@@ -129,6 +131,16 @@ abstract contract AbstractModuleUpgradeable is IModule, Initializable, OwnableUp
         return s.complianceBound[_compliance];
     }
 
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IModule).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
+
     // solhint-disable-next-line func-name-mixedcase
     function __AbstractModule_init() internal onlyInitializing {
         __Ownable_init();

contracts/factory/TREXGateway.sol

@@ -67,6 +67,8 @@ import "@openzeppelin/contracts/utils/Strings.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "../errors/InvalidArgumentErrors.sol";
 import "../errors/RoleErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../roles/IERC173.sol";
 
 /// Errors
 
@@ -101,7 +103,7 @@ error DiscountOutOfRange();
 error BatchMaxLengthExceeded(uint16 lengthLimit);
 
 
-contract TREXGateway is ITREXGateway, AgentRole {
+contract TREXGateway is ITREXGateway, AgentRole, IERC165 {
 
     /// address of the TREX Factory that is managed by the Gateway
     address private _factory;
@@ -345,4 +347,14 @@ contract TREXGateway is ITREXGateway, AgentRole {
     function calculateFee(address deployer) public override view returns(uint256) {
         return _deploymentFee.fee - ((_feeDiscount[deployer] * _deploymentFee.fee) / 10000);
     }
+
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(ITREXGateway).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
 }

contracts/proxy/authority/IAFactory.sol

@@ -64,7 +64,7 @@ pragma solidity 0.8.26;
 
 import "./TREXImplementationAuthority.sol";
 
-contract IAFactory is IIAFactory {
+contract IAFactory is IIAFactory, IERC165 {
 
     /// variables
 
@@ -106,4 +106,13 @@ contract IAFactory is IIAFactory {
     function deployedByFactory(address _ia) external view override returns (bool) {
         return _deployedByFactory[_ia];
     }
+
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IIAFactory).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
 }

contracts/proxy/authority/TREXImplementationAuthority.sol

@@ -70,6 +70,8 @@ import "../../factory/ITREXFactory.sol";
 import "./IIAFactory.sol";
 import "../../errors/CommonErrors.sol";
 import "../../errors/InvalidArgumentErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../roles/IERC173.sol";
 
 /// Errors
 
@@ -101,7 +103,7 @@ error VersionAlreadyInUse();
 error VersionOfNewIAMustBeTheSameAsCurrentIA();
 
 
-contract TREXImplementationAuthority is ITREXImplementationAuthority, Ownable {
+contract TREXImplementationAuthority is ITREXImplementationAuthority, Ownable, IERC165 {
 
     /// variables
 
@@ -347,6 +349,16 @@ contract TREXImplementationAuthority is ITREXImplementationAuthority, Ownable {
         return ITREXFactory(_trexFactory).getImplementationAuthority();
     }
 
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(ITREXImplementationAuthority).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
+
     /**
      *  @dev casting function Version => bytes to allow compare values easier
      */

contracts/registry/implementation/ClaimTopicsRegistry.sol

@@ -65,6 +65,8 @@ pragma solidity 0.8.26;
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 import "../storage/CTRStorage.sol";
 import "../interface/IClaimTopicsRegistry.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../roles/IERC173.sol";
 
 /// Errors
 
@@ -76,7 +78,7 @@ error MaxTopicsReached(uint256 _max);
 error ClaimTopicAlreadyExists();
 
 
-contract ClaimTopicsRegistry is IClaimTopicsRegistry, OwnableUpgradeable, CTRStorage {  
+contract ClaimTopicsRegistry is IClaimTopicsRegistry, OwnableUpgradeable, CTRStorage, IERC165 {
 
     function init() external initializer {
         __Ownable_init();
@@ -116,4 +118,14 @@ contract ClaimTopicsRegistry is IClaimTopicsRegistry, OwnableUpgradeable, CTRSto
     function getClaimTopics() external view override returns (uint256[] memory) {
         return _claimTopics;
     }
+
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IClaimTopicsRegistry).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
 }

contracts/registry/implementation/IdentityRegistry.sol

@@ -72,9 +72,11 @@ import "../../roles/AgentRoleUpgradeable.sol";
 import "../interface/IIdentityRegistryStorage.sol";
 import "../storage/IRStorage.sol";
 import "../../errors/InvalidArgumentErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../roles/IERC173.sol";
 
 
-contract IdentityRegistry is IIdentityRegistry, AgentRoleUpgradeable, IRStorage {
+contract IdentityRegistry is IIdentityRegistry, AgentRoleUpgradeable, IRStorage, IERC165 {
 
     /**
      *  @dev the constructor initiates the Identity Registry smart contract
@@ -279,4 +281,14 @@ contract IdentityRegistry is IIdentityRegistry, AgentRoleUpgradeable, IRStorage
     function identity(address _userAddress) public view override returns (IIdentity) {
         return _tokenIdentityStorage.storedIdentity(_userAddress);
     }
+
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IIdentityRegistry).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
 }

contracts/registry/implementation/IdentityRegistryStorage.sol

@@ -68,6 +68,8 @@ import "../../roles/AgentRoleUpgradeable.sol";
 import "../interface/IIdentityRegistryStorage.sol";
 import "../storage/IRSStorage.sol";
 import "../../errors/InvalidArgumentErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../roles/IERC173.sol";
 
 /// Errors
 
@@ -85,7 +87,7 @@ error IdentityRegistryNotStored();
 error MaxIRByIRSReached(uint256 _max);
 
 
-contract IdentityRegistryStorage is IIdentityRegistryStorage, AgentRoleUpgradeable, IRSStorage {
+contract IdentityRegistryStorage is IIdentityRegistryStorage, AgentRoleUpgradeable, IRSStorage, IERC165 {
 
     function init() external initializer {
         __Ownable_init();
@@ -193,4 +195,14 @@ contract IdentityRegistryStorage is IIdentityRegistryStorage, AgentRoleUpgradeab
     function storedInvestorCountry(address _userAddress) external view override returns (uint16) {
         return _identities[_userAddress].investorCountry;
     }
+
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(IIdentityRegistryStorage).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
 }

contracts/registry/implementation/TrustedIssuersRegistry.sol

@@ -68,6 +68,8 @@ import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 import "../interface/ITrustedIssuersRegistry.sol";
 import "../storage/TIRStorage.sol";
 import "../../errors/InvalidArgumentErrors.sol";
+import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import "../../roles/IERC173.sol";
 
 /// Errors
 
@@ -95,7 +97,7 @@ error TrustedIssuerAlreadyExists();
 error TrustedIssuerDoesNotExist();
 
 
-contract TrustedIssuersRegistry is ITrustedIssuersRegistry, OwnableUpgradeable, TIRStorage {
+contract TrustedIssuersRegistry is ITrustedIssuersRegistry, OwnableUpgradeable, TIRStorage, IERC165 {
 
     /// Functions
 
@@ -226,4 +228,14 @@ contract TrustedIssuersRegistry is ITrustedIssuersRegistry, OwnableUpgradeable,
         }
         return false;
     }
+
+    /**
+     *  @dev See {IERC165-supportsInterface}.
+     */
+    function supportsInterface(bytes4 interfaceId) public pure virtual override returns (bool) {
+        return
+            interfaceId == type(ITrustedIssuersRegistry).interfaceId ||
+            interfaceId == type(IERC173).interfaceId ||
+            interfaceId == type(IERC165).interfaceId;
+    }
 }

contracts/roles/AgentRole.sol

@@ -72,11 +72,11 @@ import "../errors/RoleErrors.sol";
 
 /// Events
 
-/// @dev This event is emmited when an agent is added.
+/// @dev This event is emitted when an agent is added.
 /// @param _agent Address of agent contract
 event AgentAdded(address indexed _agent);
 
-/// @dev This event is emmited when an agent is removed.
+/// @dev This event is emitted when an agent is removed.
 /// @param _agent Address of agent contract
 event AgentRemoved(address indexed _agent);