Sprint 12: Implement clearing module (#340)

Signed-off-by: Mario Francia <mario@io.builders>
Signed-off-by: Roberto Delgado <roberto@io.builders>
Signed-off-by: Marcos Serradilla Diez <marcos@io.builders>
Signed-off-by: jaime-iobermudez <jaime.bermudez@io.builders>
Signed-off-by: Manu Fernández <manuel@io.builders>
Signed-off-by: Alberto Molina <alberto@io.builders>
Signed-off-by: Miguel_LZPF <miguel.carpena@io.builders>
Co-authored-by: Mario Francia <mario@io.builders>
Co-authored-by: Marcos Serradilla Diez <marcos@io.builders>
Co-authored-by: jaime-iobermudez <jaime.bermudez@io.builders>
Co-authored-by: Manu Fernández <manuel@io.builders>
Co-authored-by: Alberto Molina <alberto@io.builders>
Co-authored-by: Miguel_LZPF <miguel.carpena@io.builders>

Author: 7 people

.github/workflows/all.publish.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Setup NodeJS Environment
         uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
         with:
-          node-version: 18.x
+          node-version: 20.x
 
       - name: Create file .npmrc
         run: |
@@ -49,4 +49,4 @@ jobs:
       - name: Publish sdk package
         run: npm run publish:sdk --access=public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/all.test.yml

@@ -13,6 +13,7 @@ jobs:
       CLIENT_PRIVATE_KEY_ECDSA_1: ${{ secrets.CLIENT_PRIVATE_KEY_ECDSA_1 }}
       CLIENT_PUBLIC_KEY_ECDSA_1: ${{ secrets.CLIENT_PUBLIC_KEY_ECDSA_1 }}
       CLIENT_ACCOUNT_ID_ECDSA_1: "0.0.1328"
+      CLIENT_EVM_ADDRESS_ECDSA_1_CORRECT: "0x97C50bb12E1C6284cF2855cdba95c5D60AEE44CF"
       CLIENT_EVM_ADDRESS_ECDSA_1: "0x0000000000000000000000000000000000000530"
       CLIENT_PRIVATE_KEY_ECDSA_2: ${{ secrets.CLIENT_PRIVATE_KEY_ECDSA_2 }}
       CLIENT_PUBLIC_KEY_ECDSA_2: ${{ secrets.CLIENT_PUBLIC_KEY_ECDSA_2 }}
@@ -45,9 +46,9 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup NodeJS Environment
-        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a
+        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
         with:
-          node-version: 18.x
+          node-version: 20.x
 
       - name: Install dependencies Contracts
         working-directory: contracts

.gitignore

@@ -107,9 +107,6 @@ dist
 # Docusaurus cache and generated files
 .docusaurus
 
-# Serverless directories
-.serverless/
-
 # FuseBox cache
 .fusebox/
 
@@ -132,8 +129,6 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
-package-lock.json
-
 asset-tokenization-studio.iml
 
 # IntelliJ Idea

commitlint.config.ts

@@ -0,0 +1 @@
+export default { extends: ["@commitlint/config-conventional"] };

contracts/.solhint.json

@@ -38,6 +38,7 @@
         "reentrancy": "error",
         "state-visibility": "error",
         "quotes": ["error", "single"],
-        "not-rely-on-time": "off"
+        "not-rely-on-time": "off",
+        "ordering": "error"
     }
 }

contracts/Configuration.ts

@@ -226,10 +226,10 @@ export const CONTRACT_NAMES = [
     'ProxyAdmin',
     'Factory',
     'BusinessLogicResolver',
-    'AccessControl',
+    'AccessControlFacet',
     'Cap',
     'ControlList',
-    'Pause',
+    'PauseFacet',
     'ERC20',
     'ERC1410ScheduledTasks',
     'ERC1594',
@@ -242,13 +242,17 @@ export const CONTRACT_NAMES = [
     'ScheduledBalanceAdjustments',
     'ScheduledTasks',
     'Snapshots',
-    'CorporateActionsSecurity',
+    'CorporateActions',
     'TransferAndLock',
     'Lock',
-    'Hold',
     'AdjustBalances',
     'ProtectedPartitions',
+    'Hold',
     'TimeTravel',
+    'Kyc',
+    'SsiManagement',
+    'ClearingFacet',
+    'ClearingActionsFacet',
 ] as const
 export type ContractName = (typeof CONTRACT_NAMES)[number]
 export const CONTRACT_NAMES_WITH_PROXY = ['Factory', 'BusinessLogicResolver']

contracts/contracts/factory/Factory.sol

@@ -218,10 +218,11 @@ 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 {
     IBusinessLogicResolver
 } from '../interfaces/resolver/IBusinessLogicResolver.sol';
-import {LocalContext} from '../layer_1/context/LocalContext.sol';
+import {LocalContext} from '../layer_0/context/LocalContext.sol';
 import {
     FactoryRegulationData,
     buildRegulationData,
@@ -411,6 +412,10 @@ contract Factory is IFactory, LocalContext {
         IProtectedPartitions(securityAddress_).initialize_ProtectedPartitions(
             _securityData.arePartitionsProtected
         );
+
+        IClearing(securityAddress_).initialize_Clearing(
+            _securityData.clearingActive
+        );
     }
 
     function getAppliedRegulationData(

contracts/contracts/interfaces/factory/IFactory.sol

@@ -240,6 +240,7 @@ interface IFactory {
         bool isWhiteList;
         uint256 maxSupply;
         ERC20.ERC20MetadataInfo erc20MetadataInfo;
+        bool clearingActive;
     }
 
     struct EquityData {

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

@@ -251,6 +251,17 @@ interface IDiamondCutManager {
         uint256 version
     );
 
+    /// @notice emited when createBatchConfiguration is executed
+    event DiamondBatchConfigurationCreated(
+        bytes32 configurationId,
+        FacetConfiguration[] facetConfigurations,
+        bool _isLastBatch,
+        uint256 version
+    );
+
+    /// @notice emited when cancelBatchConfiguration is executed
+    event DiamondBatchConfigurationCanceled(bytes32 configurationId);
+
     /// @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.
@@ -260,6 +271,21 @@ interface IDiamondCutManager {
         FacetConfiguration[] calldata _facetConfigurations
     ) external;
 
+    /// @notice Create a new batch 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.
+    /// @param _facetConfigurations.version list of versions of each _facetIds.
+    /// @param _isLastBatch boolean to indicate if is the last batch iteration.
+    function createBatchConfiguration(
+        bytes32 _configurationId,
+        FacetConfiguration[] calldata _facetConfigurations,
+        bool _isLastBatch
+    ) external;
+
+    /// @notice Cancel a current batch configuration.
+    /// @param _configurationId unused identifier to the configuration.
+    function cancelBatchConfiguration(bytes32 _configurationId) 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.

contracts/contracts/layer_1/ERC1400/ERC1410/ERC1410BasicStorageWrapper.sol renamed to contracts/contracts/layer_0/ERC1400/ERC1410/ERC1410BasicStorageWrapper.sol

@@ -208,46 +208,57 @@ pragma solidity 0.8.18;
 
 import {
     IERC1410StorageWrapper
-} from '../../interfaces/ERC1400/IERC1410StorageWrapper.sol';
-import {Common} from '../../common/Common.sol';
+} from '../../../layer_1/interfaces/ERC1400/IERC1410StorageWrapper.sol';
+import {ERC20StorageWrapper1} from '../ERC20/ERC20StorageWrapper1.sol';
 import {
-    ERC1410BasicStorageWrapperRead
-} from './ERC1410BasicStorageWrapperRead.sol';
+    IERC1410Basic
+} from '../../../layer_1/interfaces/ERC1400/IERC1410Basic.sol';
 
 abstract contract ERC1410BasicStorageWrapper is
     IERC1410StorageWrapper,
-    ERC1410BasicStorageWrapperRead,
-    Common
+    ERC20StorageWrapper1
 {
     function _transferByPartition(
         address _from,
-        address _to,
-        uint256 _value,
+        IERC1410Basic.BasicTransferInfo memory _basicTransferInfo,
         bytes32 _partition,
         bytes memory _data,
         address _operator,
         bytes memory _operatorData
-    ) internal virtual {
-        _beforeTokenTransfer(_partition, _from, _to, _value);
-
-        _reduceBalanceByPartition(_from, _value, _partition);
+    ) internal {
+        _beforeTokenTransfer(
+            _partition,
+            _from,
+            _basicTransferInfo.to,
+            _basicTransferInfo.value
+        );
 
-        if (!_validPartitionForReceiver(_partition, _to)) {
-            _addPartitionTo(_value, _to, _partition);
-        } else {
-            _increaseBalanceByPartition(_to, _value, _partition);
-        }
+        _reduceBalanceByPartition(_from, _basicTransferInfo.value, _partition);
 
         // Emit transfer event.
         emit TransferByPartition(
             _partition,
             _operator,
             _from,
-            _to,
-            _value,
+            _basicTransferInfo.to,
+            _basicTransferInfo.value,
             _data,
             _operatorData
         );
+
+        if (!_validPartitionForReceiver(_partition, _basicTransferInfo.to)) {
+            return
+                _addPartitionTo(
+                    _basicTransferInfo.value,
+                    _basicTransferInfo.to,
+                    _partition
+                );
+        }
+        _increaseBalanceByPartition(
+            _basicTransferInfo.to,
+            _basicTransferInfo.value,
+            _partition
+        );
     }
 
     function _beforeTokenTransfer(
@@ -256,4 +267,10 @@ abstract contract ERC1410BasicStorageWrapper is
         address to,
         uint256 amount
     ) internal virtual;
+
+    function _addPartitionTo(
+        uint256 _value,
+        address _account,
+        bytes32 _partition
+    ) internal virtual;
 }