sprint 13: feat clearing module and improvements (#378)

Signed-off-by: Roberto Delgado <roberto@io.builders>
Signed-off-by: Miguel_LZPF <miguel.carpena@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Signed-off-by: Mario Francia <mario@io.builders>
Co-authored-by: Miguel_LZPF <miguel.carpena@io.builders>
Co-authored-by: jaime-iobermudez <jaime.bermudez@io.builders>
Co-authored-by: Mario Francia <mario@io.builders>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 5 people

.github/pull_request_template.md

@@ -0,0 +1,39 @@
+## Description
+
+Summarize the change and the issue fixed. Include motivation and context. List dependencies. 📝
+
+Fixes # (issue) 🛠️
+
+## Type of change
+
+- [ ] Bug fix 🐞
+- [ ] New feature ✨
+- [ ] Breaking change 💥
+- [ ] Documentation update 📖
+
+## Testing
+
+Describe tests and instructions to reproduce. 🧪
+
+- [ ] Local Tests (npm run test)
+- [ ] Manual (CLI or web interface)
+- [ ] Local GitHub Actions (act pull_request)
+
+**Node version**:
+
+- [ ] 18
+- [ ] 20
+- [x] 22
+- [ ] 23
+
+### Test Results (if any)
+
+## Checklist
+
+- [ ] Style Guidelines followed ✅
+- [ ] Self-Reviewed 👀
+- [ ] Documentation Updated 📚
+- [ ] **Linters** - No New Warnings ⚠️
+- [ ] Effective Tests Added ✔️
+- [ ] Local Tests Pass ✅
+- [ ] No reduction of **Coverage**

.husky/pre-commit

@@ -1 +1,2 @@
-npm run pre-commit:sdk
+npm run pre-commit:contracts
+npm run pre-commit:sdk

contracts/.eslintignore

@@ -5,8 +5,9 @@ cache/
 coverage/
 node_modules/
 package.json
+package-lock.json
 typechain-types/
 .gitlab-ci.yml
 build
-package.json
-*.md
+**/*.md
+slither.db.json

contracts/.eslintrc.json

@@ -251,7 +251,10 @@ export const CONTRACT_NAMES = [
     'TimeTravel',
     'Kyc',
     'SsiManagement',
-    'ClearingFacet',
+    'ClearingHoldCreationFacet',
+    'ClearingRedeemFacet',
+    'ClearingTransferFacet',
+    'ClearingReadFacet',
     'ClearingActionsFacet',
 ] as const
 export type ContractName = (typeof CONTRACT_NAMES)[number]
@@ -286,34 +289,40 @@ export default class Configuration {
     // private _contracts: Record<ContractName, ContractConfig>;
 
     public static get privateKeys(): Record<Network, string[]> {
-        return NETWORKS.reduce((result, network) => {
-            result[network] = Configuration._getEnvironmentVariableList({
-                name: `${network.toUpperCase()}_PRIVATE_KEY_#`,
-            })
-            return result
-        }, {} as Record<Network, string[]>)
+        return NETWORKS.reduce(
+            (result, network) => {
+                result[network] = Configuration._getEnvironmentVariableList({
+                    name: `${network.toUpperCase()}_PRIVATE_KEY_#`,
+                })
+                return result
+            },
+            {} as Record<Network, string[]>
+        )
     }
 
     public static get endpoints(): Record<Network, Endpoints> {
-        return NETWORKS.reduce((result, network) => {
-            result[network] = {
-                jsonRpc: Configuration._getEnvironmentVariable({
-                    name: `${network.toUpperCase()}_JSON_RPC_ENDPOINT`,
-                    defaultValue:
-                        network === 'local'
-                            ? 'http://localhost:7546'
-                            : `https://${network}.hash.io/api`,
-                }),
-                mirror: Configuration._getEnvironmentVariable({
-                    name: `${network.toUpperCase()}_MIRROR_NODE_ENDPOINT`,
-                    defaultValue:
-                        network === 'local'
-                            ? 'http://localhost:5551'
-                            : `https://${network}.mirrornode.hedera.com`,
-                }),
-            }
-            return result
-        }, {} as Record<Network, Endpoints>)
+        return NETWORKS.reduce(
+            (result, network) => {
+                result[network] = {
+                    jsonRpc: Configuration._getEnvironmentVariable({
+                        name: `${network.toUpperCase()}_JSON_RPC_ENDPOINT`,
+                        defaultValue:
+                            network === 'local'
+                                ? 'http://localhost:7546'
+                                : `https://${network}.hash.io/api`,
+                    }),
+                    mirror: Configuration._getEnvironmentVariable({
+                        name: `${network.toUpperCase()}_MIRROR_NODE_ENDPOINT`,
+                        defaultValue:
+                            network === 'local'
+                                ? 'http://localhost:5551'
+                                : `https://${network}.mirrornode.hedera.com`,
+                    }),
+                }
+                return result
+            },
+            {} as Record<Network, Endpoints>
+        )
     }
 
     public static get contracts(): Record<ContractName, ContractConfig> {
@@ -395,7 +404,7 @@ export default class Configuration {
         name: string
         indexChar?: string
     }): string[] {
-        let resultList: string[] = []
+        const resultList: string[] = []
         let index = 0
         do {
             const env = Configuration._getEnvironmentVariable({

contracts/.prettierignore

@@ -218,7 +218,9 @@ import {IERC1644} from '../layer_1/interfaces/ERC1400/IERC1644.sol';
 import {IERC1410Basic} from '../layer_1/interfaces/ERC1400/IERC1410Basic.sol';
 import {ICap} from '../layer_1/interfaces/cap/ICap.sol';
 import {IERC1594} from '../layer_1/interfaces/ERC1400/IERC1594.sol';
-import {IClearing} from '../layer_1/interfaces/clearing/IClearing.sol';
+import {
+    IClearingActions
+} from '../layer_1/interfaces/clearing/IClearingActions.sol';
 import {
     IBusinessLogicResolver
 } from '../interfaces/resolver/IBusinessLogicResolver.sol';
@@ -364,6 +366,16 @@ contract Factory is IFactory, LocalContext {
         );
     }
 
+    function getAppliedRegulationData(
+        RegulationType _regulationType,
+        RegulationSubType _regulationSubType
+    ) external pure override returns (RegulationData memory regulationData_) {
+        regulationData_ = buildRegulationData(
+            _regulationType,
+            _regulationSubType
+        );
+    }
+
     function _deploySecurity(
         SecurityData calldata _securityData,
         SecurityType _securityType
@@ -413,18 +425,8 @@ contract Factory is IFactory, LocalContext {
             _securityData.arePartitionsProtected
         );
 
-        IClearing(securityAddress_).initialize_Clearing(
+        IClearingActions(securityAddress_).initializeClearing(
             _securityData.clearingActive
         );
     }
-
-    function getAppliedRegulationData(
-        RegulationType _regulationType,
-        RegulationSubType _regulationSubType
-    ) external pure override returns (RegulationData memory regulationData_) {
-        regulationData_ = buildRegulationData(
-            _regulationType,
-            _regulationSubType
-        );
-    }
 }

contracts/Configuration.ts

@@ -229,21 +229,6 @@ interface IDiamondCutManager {
         uint256 version;
     }
 
-    // @notice Not able to use bytes32(0) with configurationId
-    error DefaultValueForConfigurationIdNotPermitted();
-
-    /// @notice Not able to use a facetId unregistered
-    error FacetIdNotRegistered(bytes32 configurationId, bytes32 facetId);
-
-    /// @notice Not able to duplicate facetId in list
-    error DuplicatedFacetInConfiguration(bytes32 facetId);
-
-    /// @notice error that occurs when try to create a configuration and the configuration key doesn't exists
-    error ResolverProxyConfigurationNoRegistered(
-        bytes32 resolverProxyConfigurationId,
-        uint256 version
-    );
-
     /// @notice emited when createConfiguration is executed
     event DiamondConfigurationCreated(
         bytes32 configurationId,
@@ -262,6 +247,21 @@ interface IDiamondCutManager {
     /// @notice emited when cancelBatchConfiguration is executed
     event DiamondBatchConfigurationCanceled(bytes32 configurationId);
 
+    // @notice Not able to use bytes32(0) with configurationId
+    error DefaultValueForConfigurationIdNotPermitted();
+
+    /// @notice Not able to use a facetId unregistered
+    error FacetIdNotRegistered(bytes32 configurationId, bytes32 facetId);
+
+    /// @notice Not able to duplicate facetId in list
+    error DuplicatedFacetInConfiguration(bytes32 facetId);
+
+    /// @notice error that occurs when try to create a configuration and the configuration key doesn't exists
+    error ResolverProxyConfigurationNoRegistered(
+        bytes32 resolverProxyConfigurationId,
+        uint256 version
+    );
+
     /// @notice Create a new configuration to the latest version of all facets.
     /// @param _configurationId unused identifier to the configuration.
     /// @param _facetConfigurations.id list of business logics to be registered.
@@ -286,6 +286,14 @@ interface IDiamondCutManager {
     /// @param _configurationId unused identifier to the configuration.
     function cancelBatchConfiguration(bytes32 _configurationId) external;
 
+    /// @notice check if a resolverProxy is registered. If not revert.
+    /// @param _configurationId the configuration key to be checked.
+    /// @param _version configured version in the resolverProxy.
+    function checkResolverProxyConfigurationRegistered(
+        bytes32 _configurationId,
+        uint256 _version
+    ) external;
+
     /// @notice Resolve the facet address knowing configuration, version and selector.
     /// @param _configurationId configured key in the resolverProxy.
     /// @param _version configured version in the resolverProxy. if is 0, ask for latest version.
@@ -317,14 +325,6 @@ interface IDiamondCutManager {
         uint256 _version
     ) external view returns (bool);
 
-    /// @notice check if a resolverProxy is registered. If not revert.
-    /// @param _configurationId the configuration key to be checked.
-    /// @param _version configured version in the resolverProxy.
-    function checkResolverProxyConfigurationRegistered(
-        bytes32 _configurationId,
-        uint256 _version
-    ) external;
-
     /// @notice Returns the length of configuration keys
     /// @return configurationsLength_
     function getConfigurationsLength()

contracts/contracts/factory/Factory.sol

@@ -217,12 +217,12 @@ interface IERC173 {
         address indexed newOwner
     );
 
-    /// @notice Get the address of the owner
-    /// @return owner_ The address of the owner.
-    function owner() external view returns (address owner_);
-
     /// @notice Set the address of the new owner of the contract
     /// @dev Set _newOwner to address(0) to renounce any ownership.
     /// @param _newOwner The address of the new owner of the contract
     function transferOwnership(address _newOwner) external;
+
+    /// @notice Get the address of the owner
+    /// @return owner_ The address of the owner.
+    function owner() external view returns (address owner_);
 }

contracts/contracts/interfaces/resolver/diamondCutManager/IDiamondCutManager.sol

@@ -208,11 +208,11 @@ pragma solidity 0.8.18;
 // SPDX-License-Identifier: BSD-3-Clause-Attribution
 
 interface IResolverProxy {
-    // When no function exists for function called
-    error FunctionNotFound(bytes4 _functionSelector);
-
     struct Rbac {
         bytes32 role;
         address[] members;
     }
+
+    // When no function exists for function called
+    error FunctionNotFound(bytes4 _functionSelector);
 }