feat: 🎸 Handling of the addCanceled function in the Storages

✅ Closes: #218

src/v0.8/core/carstore/Carstore.sol

@@ -155,13 +155,7 @@ contract Carstore is Initializable, UUPSUpgradeable, CarstoreBase {
         uint64 _id,
         uint64 _matchingId,
         bool _matchingState
-    )
-        external
-        onlyRole(roles, RolesType.DATASWAP_CONTRACT)
-        onlyCarExist(this, _id)
-        onlyNotZero(_matchingId)
-        onlyCarReplicaExist(this, _id, _matchingId)
-    {
+    ) external onlyRole(roles, RolesType.DATASWAP_CONTRACT) {
         if (_matchingState) {
             _emitRepicaEvent(
                 _id,
@@ -186,6 +180,24 @@ contract Carstore is Initializable, UUPSUpgradeable, CarstoreBase {
             );
         }
     }
+    /// @dev Reports a failure in car replica storage.
+    /// @param _id The ID associated with the car replica.
+    /// @param _matchingId The ID of the matching process related to the storage failure.
+    function __reportCarReplicaStorageFailed(
+        uint64 _id,
+        uint64 _matchingId
+    )
+        external
+        onlyRole(roles, RolesType.DATASWAP_CONTRACT)
+        onlyCarReplicaState(
+            this,
+            _id,
+            _matchingId,
+            CarReplicaType.State.Matched
+        )
+    {
+        _emitRepicaEvent(_id, _matchingId, CarReplicaType.Event.StorageFailed);
+    }
 
     function _checkCarReplicaDealState(
         uint64 _id,
@@ -211,9 +223,6 @@ contract Carstore is Initializable, UUPSUpgradeable, CarstoreBase {
     )
         external
         onlyRole(roles, RolesType.DATASWAP_CONTRACT)
-        onlyCarExist(this, _id)
-        onlyNotZero(_matchingId)
-        onlyCarReplicaExist(this, _id, _matchingId)
         onlyCarReplicaState(this, _id, _matchingId, CarReplicaType.State.Stored)
     {
         _checkCarReplicaDealState(
@@ -240,9 +249,6 @@ contract Carstore is Initializable, UUPSUpgradeable, CarstoreBase {
     )
         external
         onlyRole(roles, RolesType.DATASWAP_CONTRACT)
-        onlyCarExist(this, _id)
-        onlyNotZero(_matchingId)
-        onlyCarReplicaExist(this, _id, _matchingId)
         onlyCarReplicaState(this, _id, _matchingId, CarReplicaType.State.Stored)
     {
         _checkCarReplicaDealState(

src/v0.8/core/filplus/Filplus.sol

@@ -38,7 +38,7 @@ import {FinanceType} from "src/v0.8/types/FinanceType.sol";
 contract Filplus is Initializable, UUPSUpgradeable, IFilplus, RolesModifiers {
     using ArrayUint16LIB for uint16[];
     using ArrayUint32LIB for uint32[];
-    IRoles private roles;
+    IRoles public roles;
     // solhint-disable-next-line
     address public GOVERNANCE_ADDRESS; //The address of the governance contract.
 

src/v0.8/core/finance/escrow/EscrowDataTradingFee.sol

@@ -174,7 +174,12 @@ contract EscrowDataTradingFee is EscrowBase {
             _datasetId
         );
 
-        uint256 amount = __getRequirement(_datasetId,_destMatchingId,payer, _token);
+        uint256 amount = __getRequirement(
+            _datasetId,
+            _destMatchingId,
+            payer,
+            _token
+        );
 
         FinanceType.PayeeInfo[] memory payees = new FinanceType.PayeeInfo[](1);
         payees[0] = FinanceType.PayeeInfo(payer, amount);
@@ -194,8 +199,14 @@ contract EscrowDataTradingFee is EscrowBase {
         uint64 _matchingId,
         address _payer,
         address _token
-    ) public view override onlyRole(roles, RolesType.DATASWAP_CONTRACT) returns (uint256 amount) {
-        (, , uint256 current, uint256 total ) = roles.finance().getAccountEscrow(
+    )
+        public
+        view
+        override
+        onlyRole(roles, RolesType.DATASWAP_CONTRACT)
+        returns (uint256 amount)
+    {
+        (, , uint256 current, uint256 total) = roles.finance().getAccountEscrow(
             _datasetId,
             _matchingId,
             _payer,
@@ -208,9 +219,16 @@ contract EscrowDataTradingFee is EscrowBase {
                 _matchingId,
                 _payer
             );
-        } else if (_payer == roles.datasets().getDatasetMetadataSubmitter(_datasetId)) {
+        } else if (
+            _payer == roles.datasets().getDatasetMetadataSubmitter(_datasetId)
+        ) {
             if (total <= 0) {
-                amount = _getSubsidyAmount(_datasetId, _matchingId, _payer, _token);
+                amount = _getSubsidyAmount(
+                    _datasetId,
+                    _matchingId,
+                    _payer,
+                    _token
+                );
             } else {
                 amount = total;
             }
@@ -361,7 +379,7 @@ contract EscrowDataTradingFee is EscrowBase {
     function _isEscrowRefund(uint64 _matchingId) internal view returns (bool) {
         return
             _matchingId != 0 &&
-            roles.storages().isStorageExpiration(_matchingId);
+            roles.storages().isStorageCompleted(_matchingId);
     }
 
     /// @dev Internal function to check if a parent account refund is applicable.

src/v0.8/core/finance/escrow/EscrowDatacapChunkLandCollateral.sol

@@ -40,7 +40,13 @@ contract EscrowDatacapChunkLandCollateral is EscrowBase {
         uint64 _matchingId,
         address _payer,
         address _token
-    ) public view override onlyRole(roles, RolesType.DATASWAP_CONTRACT) returns (uint256 amount) {
+    )
+        public
+        view
+        override
+        onlyRole(roles, RolesType.DATASWAP_CONTRACT)
+        returns (uint256 amount)
+    {
         (, , uint256 current, ) = roles.finance().getAccountEscrow(
             _datasetId,
             _matchingId,
@@ -141,7 +147,7 @@ contract EscrowDatacapChunkLandCollateral is EscrowBase {
         uint64 _matchingId
     ) internal view override returns (bool refund) {
         return ((_matchingId != 0 &&
-            roles.storages().isStorageExpiration(_matchingId)) ||
+            roles.storages().isStorageCompleted(_matchingId)) ||
             roles.datasets().getDatasetState(_datasetId) ==
             DatasetType.State.Rejected);
     }
@@ -154,6 +160,6 @@ contract EscrowDatacapChunkLandCollateral is EscrowBase {
         uint64 _matchingId
     ) internal view override returns (bool burn) {
         return (_matchingId != 0 &&
-            roles.storages().isStorageExpiration(_matchingId));
+            roles.storages().isStorageCompleted(_matchingId));
     }
 }

src/v0.8/interfaces/core/ICarstore.sol

@@ -213,6 +213,14 @@ interface ICarstore is ICarstoreReadOnly {
         bool _matchingState
     ) external;
 
+    /// @dev Reports a failure in car replica storage.
+    /// @param _id The ID associated with the car replica.
+    /// @param _matchingId The ID of the matching process related to the storage failure.
+    function __reportCarReplicaStorageFailed(
+        uint64 _id,
+        uint64 _matchingId
+    ) external;
+
     /// @notice Report that storage deal for a replica has expired.
     /// @dev This function allows reporting that the storage deal for a replica has expired.
     /// @param _id Car ID associated with the replica.
@@ -265,4 +273,7 @@ interface ICarstore is ICarstoreReadOnly {
         uint64 _datasetId,
         uint16 _replicaCount
     ) external;
+    /// @notice Get the Roles contract.
+    /// @return Roles contract address.
+    function roles() external view returns (IRoles);
 }

src/v0.8/interfaces/core/IEscrow.sol

@@ -18,6 +18,7 @@
 pragma solidity ^0.8.21;
 
 import {FinanceType} from "src/v0.8/types/FinanceType.sol";
+import {IRoles} from "src/v0.8/interfaces/core/IRoles.sol";
 
 /// @title IEscrow
 /// @dev This IEscrow provides Escrow-related interface.
@@ -56,4 +57,8 @@ interface IEscrow {
         address _owner,
         address _token
     ) external view returns (uint256 amount);
+
+    /// @notice Get the Roles contract.
+    /// @return Roles contract address.
+    function roles() external view returns (IRoles);
 }

src/v0.8/interfaces/core/IFilplus.sol

@@ -19,7 +19,7 @@
 pragma solidity ^0.8.21;
 
 import {FinanceType} from "src/v0.8/types/FinanceType.sol";
-
+import {IRoles} from "src/v0.8/interfaces/core/IRoles.sol";
 /// @title IFilplus
 interface IFilplus {
     // Public getter function to access datasetRuleMaxReplicasInCountries
@@ -275,4 +275,8 @@ interface IFilplus {
     function isCompliantRuleMaxReplicasPerSP(
         uint16 _value
     ) external view returns (bool);
+
+    /// @notice Get the Roles contract.
+    /// @return Roles contract address.
+    function roles() external view returns (IRoles);
 }

src/v0.8/interfaces/core/IFinance.sol

@@ -23,7 +23,7 @@ pragma solidity ^0.8.21;
 
 import {FinanceType} from "src/v0.8/types/FinanceType.sol";
 import {IBusinessFinanceStatistics} from "src/v0.8/interfaces/core/statistics/IBusinessFinanceStatistics.sol";
-
+import {IRoles} from "src/v0.8/interfaces/core/IRoles.sol";
 /// @title IPayment Interface
 /// @notice This interface defines the payment-related functions within the system.
 /// @notice instance example,type: mapping(uint256 => mapping(uint256 => mapping(address => mapping(address=>Account))));
@@ -196,4 +196,8 @@ interface IFinance is IBusinessFinanceStatistics {
         address _token,
         FinanceType.Type _type
     ) external view returns (bool);
+
+    /// @notice Get the Roles contract.
+    /// @return Roles contract address.
+    function roles() external view returns (IRoles);
 }

src/v0.8/interfaces/module/IStorages.sol

@@ -18,7 +18,6 @@
 
 pragma solidity ^0.8.21;
 
-import {IRoles} from "src/v0.8/interfaces/core/IRoles.sol";
 import {IStorageStatistics} from "src/v0.8/interfaces/core/statistics/IStorageStatistics.sol";
 
 /// @title Interface for Matchedstores contract
@@ -35,6 +34,11 @@ interface IStorages is IStorageStatistics {
         uint64[] memory _claimIds
     ) external;
 
+    /// @dev Completes the storage process for a given matching ID.
+    /// @param _matchingId The ID of the matching.
+    /// @param _ids An array of content identifiers of the matched data.
+    function completeStorage(uint64 _matchingId, uint64[] memory _ids) external;
+
     /// @dev Gets the list of done cars in the matchedstore.
     /// @param _matchingId The ID of the matching.
     /// @return An array of content identifiers of the done cars.
@@ -59,6 +63,13 @@ interface IStorages is IStorageStatistics {
         uint64 _matchingId
     ) external view returns (bool);
 
+    /// @dev Checks if the storage process is completed for a given matching ID.
+    /// @param _matchingId The ID of the matching.
+    /// @return A boolean indicating whether the storage process is completed or not.
+    function isStorageCompleted(
+        uint64 _matchingId
+    ) external view returns (bool);
+
     /// @dev Requests the allocation of matched datacap for a matching process.
     /// @param _matchingId The ID of the matching process.
     function requestAllocateDatacap(

src/v0.8/module/storage/Storages.sol

@@ -161,6 +161,62 @@ contract Storages is
         );
     }
 
+    /// @dev Completes the storage process for a given matching ID.
+    /// @param _matchingId The ID of the matching.
+    function completeStorage(uint64 _matchingId, uint64[] memory _ids) public {
+        StorageType.Storage storage storage_ = storages[_matchingId];
+        (
+            uint64 datasetId,
+            uint64[] memory cars,
+            ,
+            ,
+            ,
+            uint16 replicaIndex
+        ) = roles.matchingsTarget().getMatchingTarget(_matchingId);
+
+        if (storage_.doneCars.length < cars.length) {
+            require(isStorageExpiration(_matchingId), "Storage is in progress");
+            require(
+                storage_.doneCars.length + _ids.length == cars.length,
+                "invalid cars number"
+            );
+
+            for (uint256 i = 0; i < _ids.length; i++) {
+                require(
+                    CarReplicaType.State.Matched ==
+                        roles.carstore().getCarReplicaState(
+                            _ids[i],
+                            _matchingId
+                        ),
+                    "Invalid Replica State"
+                );
+                roles.carstore().__reportCarReplicaStorageFailed(
+                    _ids[i],
+                    _matchingId
+                );
+                uint64 carSize = roles.carstore().getCarSize(_ids[i]);
+                _addCanceled(datasetId, replicaIndex, _matchingId, carSize);
+            }
+        }
+
+        storage_.completed = true;
+
+        // Payment data trading fee
+        roles.finance().claimEscrow(
+            datasetId,
+            _matchingId,
+            FinanceType.FIL,
+            FinanceType.Type.EscrowDatacapChunkLandCollateral
+        );
+
+        roles.finance().claimEscrow(
+            datasetId,
+            _matchingId,
+            FinanceType.FIL,
+            FinanceType.Type.EscrowDataTradingFee
+        );
+    }
+
     /// @dev Gets the list of done cars in the matchedstore.
     function getStoredCars(
         uint64 _matchingId
@@ -213,6 +269,14 @@ contract Storages is
         }
     }
 
+    /// @dev Checks if the storage process is completed for a given matching ID.
+    /// @param _matchingId The ID of the matching.
+    /// @return A boolean indicating whether the storage process is completed or not.
+    function isStorageCompleted(uint64 _matchingId) public view returns (bool) {
+        StorageType.Storage storage storage_ = storages[_matchingId];
+        return storage_.completed;
+    }
+
     /// @dev Internal function to allocate matched datacap.
     // solhint-disable-next-line
     function _allocateDatacap(

src/v0.8/types/StorageType.sol

@@ -23,5 +23,6 @@ library StorageType {
     /// @notice Struct representing a storage deal.
     struct Storage {
         uint64[] doneCars;
+        bool completed;
     }
 }

test/v0.8/testcases/module/storage/RegistDataswapDatacapTestSuite.sol

@@ -0,0 +1,32 @@
+/*******************************************************************************
+ *   (c) 2023 Dataswap
+ *
+ *  Licensed under the GNU General Public License, Version 3.0 or later (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ ********************************************************************************/
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity ^0.8.21;
+
+import {TestCaseBase} from "test/v0.8/testcases/module/abstract/TestCaseBase.sol";
+import {IStoragesAssertion} from "test/v0.8/interfaces/assertions/module/IStoragesAssertion.sol";
+
+///@notice regist dataswap datacap test case with success
+contract RegistDataswapDatacapWithSuccess is TestCaseBase {
+    IStoragesAssertion storagesAssertion;
+    constructor(IStoragesAssertion _storagesAssertion) TestCaseBase() {
+        storagesAssertion = _storagesAssertion;
+    }
+
+    function action(uint64 /*_matchingId*/) internal virtual override {
+        storagesAssertion.registDataswapDatacapAssertion(address(0), 1024);
+    }
+}

test/v0.8/uinttests/helpers/BaseTestSetup.sol

@@ -262,6 +262,7 @@ contract BaseTestSetup {
             RolesType.ContractType.EscrowDatacapChunkLandCollateral,
             address(base.escrowDatacapChunkLandCollateral)
         );
+        base.role.grantRole(RolesType.DEFAULT_ADMIN_ROLE, address(0));
     }
 
     /// @dev Get the governanceContractAddresss contract.