feat: missing interfaces updated & updated previous ones (#36)

Author: Szooot

abis/Validator.json

@@ -365,7 +365,7 @@
       {
         "name": "result",
         "type": "tuple",
-        "internalType": "struct IValidator.ValidationResult",
+        "internalType": "struct IFilecoinPayValidator.ValidationResult",
         "components": [
           {
             "name": "modifiedAmount",

script/utils/DeployUtils.sol

@@ -51,6 +51,7 @@ contract DeployUtils is Script {
     }
 
     function readLatestDeploymentArtifact() internal view returns (string memory json) {
+        // forge-lint: disable-next-line(unsafe-cheatcode)
         json = vm.readFile(string.concat("./deployments/", network(), "/latest.json"));
     }
 

src/Client.sol

@@ -13,23 +13,24 @@ import {VerifRegAPI} from "filecoin-solidity/v0.8/VerifRegAPI.sol";
 import {UtilsHandlers} from "filecoin-solidity/v0.8/utils/UtilsHandlers.sol";
 import {FilAddresses} from "filecoin-solidity/v0.8/utils/FilAddresses.sol";
 import {AllocationResponseCbor} from "./lib/AllocationResponseCbor.sol";
-import {PoRepMarket} from "./PoRepMarket.sol";
+import {IPoRepMarket} from "./interfaces/IPoRepMarket.sol";
+import {IClient} from "./interfaces/IClient.sol";
 import {PoRepTypes} from "./types/PoRepTypes.sol";
 import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
 import {IMetaAllocator} from "./interfaces/IMetaAllocator.sol";
 
 /**
  * @title Client
- * @notice Upgradeable contract for managing client allowances with role-based access control
+ * @notice Contract for clients to interact with storage providers, manage deals, and handle DataCap transfers
  */
-contract Client is Initializable, AccessControlUpgradeable, UUPSUpgradeable, ReentrancyGuard {
+contract Client is IClient, Initializable, AccessControlUpgradeable, UUPSUpgradeable, ReentrancyGuard {
     using AllocationResponseCbor for DataCapTypes.TransferReturn;
 
     // @custom:storage-location erc7201:porepmarket.storage.ClientStorage
     struct ClientStorage {
         mapping(uint256 dealId => Deal deal) _deals;
         mapping(uint64 claim => bool isTerminated) _terminatedClaims;
-        PoRepMarket _poRepMarketContract;
+        IPoRepMarket _poRepMarketContract;
         IMetaAllocator _metaAllocatorContract;
     }
 
@@ -205,7 +206,7 @@ contract Client is Initializable, AccessControlUpgradeable, UUPSUpgradeable, Ree
         _grantRole(TERMINATION_ORACLE, terminationOracle);
 
         ClientStorage storage $ = s();
-        $._poRepMarketContract = PoRepMarket(_poRepMarketContract);
+        $._poRepMarketContract = IPoRepMarket(_poRepMarketContract);
         $._metaAllocatorContract = IMetaAllocator(_metaAllocatorContract);
     }
 

src/PoRepMarket.sol

@@ -7,7 +7,8 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
 import {CommonTypes} from "filecoin-solidity/v0.8/types/CommonTypes.sol";
 import {AccessControlUpgradeable} from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
 import {ISPRegistry} from "./interfaces/ISPRegistry.sol";
-import {ValidatorFactory} from "./ValidatorFactory.sol";
+import {IValidatorFactory} from "./interfaces/IValidatorFactory.sol";
+import {IPoRepMarket} from "./interfaces/IPoRepMarket.sol";
 import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 import {SLITypes} from "./types/SLITypes.sol";
 import {PoRepTypes} from "./types/PoRepTypes.sol";
@@ -18,7 +19,7 @@ import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet
  * @dev PoRepMarket contract is a contract that allows users to create and manage deal proposals for PoRep deals
  * @notice PoRepMarket contract
  */
-contract PoRepMarket is Initializable, AccessControlUpgradeable, UUPSUpgradeable {
+contract PoRepMarket is IPoRepMarket, Initializable, AccessControlUpgradeable, UUPSUpgradeable {
     using EnumerableSet for EnumerableSet.UintSet;
     /**
      * @notice role to manage contract upgrades
@@ -39,7 +40,7 @@ contract PoRepMarket is Initializable, AccessControlUpgradeable, UUPSUpgradeable
         mapping(uint256 dealId => PoRepTypes.DealProposal) _dealProposals;
         EnumerableSet.UintSet _dealIdsReadyForPayment;
         ISPRegistry _SPRegistryContract;
-        ValidatorFactory _validatorFactoryContract;
+        IValidatorFactory _validatorFactoryContract;
         address _clientSmartContract;
         uint256 _dealIdCounter;
     }
@@ -187,7 +188,7 @@ contract PoRepMarket is Initializable, AccessControlUpgradeable, UUPSUpgradeable
         _grantRole(UPGRADER_ROLE, _admin);
 
         DealProposalsStorage storage $ = s();
-        $._validatorFactoryContract = ValidatorFactory(_validatorFactory);
+        $._validatorFactoryContract = IValidatorFactory(_validatorFactory);
         $._SPRegistryContract = ISPRegistry(_spRegistry);
     }
 
@@ -248,7 +249,7 @@ contract PoRepMarket is Initializable, AccessControlUpgradeable, UUPSUpgradeable
     }
 
     /**
-     * @notice Updates the validator and rail id for a deal proposal
+     * @notice Updates the validator for a deal proposal
      * @param dealId The id of the deal proposal
      */
     function updateValidator(uint256 dealId) external {

src/SLIOracle.sol

@@ -11,7 +11,7 @@ import {SLITypes} from "./types/SLITypes.sol";
 
 /**
  * @title SLI Oracle
- * @notice
+ * @notice Contract for managing and retrieving SLI values for storage providers
  */
 contract SLIOracle is ISLIOracle, Initializable, AccessControlUpgradeable, UUPSUpgradeable, MulticallUpgradeable {
     /**

src/Validator.sol

@@ -10,20 +10,21 @@ import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {CommonTypes} from "filecoin-solidity/v0.8/types/CommonTypes.sol";
 
 import {IFilecoinPayV1} from "./interfaces/IFilecoinPayV1.sol";
-import {IValidator} from "./interfaces/IValidator.sol";
+import {IFilecoinPayValidator} from "./interfaces/IFilecoinPayValidator.sol";
 import {ISLIScorer} from "./interfaces/ISLIScorer.sol";
 import {IPoRepMarket} from "./interfaces/IPoRepMarket.sol";
 import {ISPRegistry} from "./interfaces/ISPRegistry.sol";
+import {IClient} from "./interfaces/IClient.sol";
+import {IValidator} from "./interfaces/IValidator.sol";
 import {Operator} from "./abstracts/Operator.sol";
 import {PoRepTypes} from "./types/PoRepTypes.sol";
-import {Client} from "./Client.sol";
 
 /**
  * @title Validator
  * @dev Implements validator and operator logic for managing Filecoin Pay rails
  * @notice Validator contract for Filecoin Pay
  */
-contract Validator is Initializable, AccessControlUpgradeable, IValidator, Operator {
+contract Validator is Initializable, AccessControlUpgradeable, IFilecoinPayValidator, IValidator, Operator {
     /**
      * @notice Error indicating that the caller is not the FilecoinPay contract
      */
@@ -311,7 +312,8 @@ contract Validator is Initializable, AccessControlUpgradeable, IValidator, Opera
      */
     function validatePayment(uint256 railId, uint256 proposedAmount, uint256 fromEpoch, uint256 toEpoch, uint256 rate)
         external
-        returns (IValidator.ValidationResult memory result)
+        override
+        returns (ValidationResult memory result)
     {
         ValidatorStorage storage $ = _getValidatorStorage();
         if (msg.sender != $.filecoinPay) {
@@ -341,7 +343,7 @@ contract Validator is Initializable, AccessControlUpgradeable, IValidator, Opera
         uint256 score = ISLIScorer($.SLIScorer).calculateScore($.providerId, dealProposal.requirements);
 
         bool scoreMatches = score == 100;
-        bool dataSizeMatches = Client($.clientSC).isDataSizeMatching($.dealId);
+        bool dataSizeMatches = IClient($.clientSC).isDataSizeMatching($.dealId);
 
         if (!scoreMatches || !dataSizeMatches) {
             result.settleUpto = toEpoch;
@@ -571,7 +573,7 @@ contract Validator is Initializable, AccessControlUpgradeable, IValidator, Opera
         ValidatorStorage storage $ = _getValidatorStorage();
 
         PoRepTypes.DealProposal memory dealProposal = IPoRepMarket($.poRepMarket).getDealProposal($.dealId);
-        CommonTypes.FilActorId[] memory allocationIds = Client($.clientSC).getClientAllocationIdsPerDeal($.dealId);
+        CommonTypes.FilActorId[] memory allocationIds = IClient($.clientSC).getClientAllocationIdsPerDeal($.dealId);
 
         uint256 sectorCount = allocationIds.length;
         uint256 pricePerSectorPerMonth = dealProposal.terms.pricePerSectorPerMonth;

src/ValidatorFactory.sol

@@ -9,14 +9,15 @@ import {BeaconProxy} from "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol"
 import {Validator} from "./Validator.sol";
 import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
 import {UUPSUpgradeable} from "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
-import {PoRepMarket} from "./PoRepMarket.sol";
+import {IPoRepMarket} from "./interfaces/IPoRepMarket.sol";
+import {IValidatorFactory} from "./interfaces/IValidatorFactory.sol";
 import {PoRepTypes} from "./types/PoRepTypes.sol";
 
 /**
  * @title ValidatorFactory
  * @notice Beacon factory contract for creating Validator instances
  */
-contract ValidatorFactory is UUPSUpgradeable, AccessControlUpgradeable {
+contract ValidatorFactory is IValidatorFactory, UUPSUpgradeable, AccessControlUpgradeable {
     /**
      * @notice Upgradable role which allows for contract upgrades
      */
@@ -159,7 +160,7 @@ contract ValidatorFactory is UUPSUpgradeable, AccessControlUpgradeable {
         ValidatorFactoryStorage storage $ = s();
         if ($._instances[dealId] != address(0)) revert InstanceAlreadyExists();
 
-        PoRepTypes.DealProposal memory dp = PoRepMarket($._poRepMarket).getDealProposal(dealId);
+        PoRepTypes.DealProposal memory dp = IPoRepMarket($._poRepMarket).getDealProposal(dealId);
         if (msg.sender != dp.client) revert InvalidClientAddress();
 
         bytes memory initCode = abi.encodePacked(

src/abstracts/Operator.sol

@@ -3,38 +3,14 @@ pragma solidity =0.8.30;
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {IFilecoinPayV1} from "../interfaces/IFilecoinPayV1.sol";
+import {IOperator} from "../interfaces/IOperator.sol";
 
 /**
  * @title Operator abstract contract
  * @notice Abstract contract defining operator functions for creating and managing payment rails in the FilecoinPayV1 system.
  * This contract provides internal helper functions for interacting with the FilecoinPayV1 interface, while leaving the implementation of the external functions to derived contracts.
  */
-abstract contract Operator {
-    /**
-     * @notice Creates a payment rail
-     * @param token The ERC20 token to use for the payment rail
-     */
-    function createRail(IERC20 token) external virtual;
-
-    /**
-     * @notice Updates the lockup period of a payment rail
-     * @param railId ID of the payment rail
-     * @param newLockupPeriod New lockup period to set
-     */
-    function updateLockupPeriod(uint256 railId, uint256 newLockupPeriod) external virtual;
-
-    /**
-     * @notice Modifies the payment rate and optionally makes a one-time payment.
-     * @param railId The ID of the rail to modify.
-     */
-    function modifyRailPayment(uint256 railId) external virtual;
-
-    /**
-     * @notice Terminates a payment rail, preventing further payments after the rail's lockup period. After calling this method, the lockup period cannot be changed, and the rail's rate and fixed lockup may only be reduced.
-     * @param railId The ID of the rail to terminate.
-     */
-    function terminateRail(uint256 railId) external virtual;
-
+abstract contract Operator is IOperator {
     /**
      * @notice Internal function to create a payment rail
      * @param filecoinPay The FilecoinPayV1 interface

src/interfaces/IClient.sol

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: MIT
+// solhint-disable func-name-mixedcase
+
+pragma solidity =0.8.30;
+
+import {CommonTypes} from "filecoin-solidity/v0.8/types/CommonTypes.sol";
+import {DataCapTypes} from "filecoin-solidity/v0.8/types/DataCapTypes.sol";
+
+/**
+ * @title IClient
+ * @notice Interface for client interactions with storage providers
+ */
+interface IClient {
+    /**
+     * @notice This function transfers DataCap tokens from the client to the storage provider
+     * @dev This function can only be called by the client
+     * @param params The parameters for the transfer
+     * @param dealId The id of the deal
+     * @param dealCompleted Whether the deal is completed
+     */
+    function transfer(DataCapTypes.TransferParams calldata params, uint256 dealId, bool dealCompleted) external;
+
+    /**
+     * @notice The handle_filecoin_method function is a universal entry point for calls
+     * coming from built-in Filecoin actors. Datacap is an FRC-46 Token. Receiving FRC46
+     * tokens requires implementing a Receiver Hook:
+     * https://github.com/filecoin-project/FIPs/blob/master/FRCs/frc-0046.md#receiver-hook.
+     * We use handle_filecoin_method to handle the receiver hook and make sure that the token
+     * sent to our contract is freshly minted Datacap and reject all other calls and transfers.
+     * @param method Method number
+     * @param inputCodec Codec of the payload
+     * @param params Params of the call
+     * @return exitCode The exit code of the operation
+     * @return codec The codec used for the response
+     * @return data The response data
+     * @dev Reverts if trying to send a unsupported token type
+     * @dev Reverts if trying to receive invalid token
+     */
+    function handle_filecoin_method(uint64 method, uint64 inputCodec, bytes calldata params)
+        external
+        view
+        returns (uint32 exitCode, uint64 codec, bytes memory data);
+
+    /**
+     * @notice custom getter to retrieve allocation ids per client and provider
+     * @param dealId the id of the deal
+     * @return allocationIds the allocation ids for the client and provider
+     */
+    function getClientAllocationIdsPerDeal(uint256 dealId) external view returns (CommonTypes.FilActorId[] memory);
+
+    /**
+     * @notice custom getter to check if claim is terminated
+     * @param claimId the id of the claim
+     * @return isTerminated whether the claim is terminated
+     */
+    function terminatedClaims(uint64 claimId) external view returns (bool);
+
+    /**
+     * @notice Checks if the total active data size for the client with the specified provider matches the expected size
+     * @dev This function can only be called by the validator of the deal
+     * @param dealId The id of the deal
+     * @return totalSizePerSp The total active data size for the client with the specified provider
+     */
+    function isDataSizeMatching(uint256 dealId) external returns (bool);
+
+    /**
+     * @notice Marks the given claims as terminated early.
+     * @dev Only callable by TERMINATION_ORACLE role.
+     * @param claims An array of claim IDs to mark as terminated.
+     */
+    function claimsTerminatedEarly(uint64[] calldata claims) external;
+}

src/interfaces/IFilecoinPayValidator.sol

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: MIT
+pragma solidity =0.8.30;
+
+/**
+ * @title Interface for Filecoin Pay Validator
+ * @notice Defines the interface for payment validation in Filecoin Pay rails
+ */
+interface IFilecoinPayValidator {
+    /**
+     * @notice Result structure for validation during rail settlement
+     * @param modifiedAmount The actual payment amount determined by the validator after validation of a rail during settlement
+     * @param settleUpto The epoch up to and including which settlement should occur
+     * @param note A placeholder note for any additional information the validator wants to send to the caller of `settleRail`
+     */
+    struct ValidationResult {
+        // The actual payment amount determined by the validator after validation of a rail during settlement
+        uint256 modifiedAmount;
+        // The epoch up to and including which settlement should occur.
+        uint256 settleUpto;
+        // A placeholder note for any additional information the validator wants to send to the caller of `settleRail`
+        string note;
+    }
+
+    /**
+     * @notice Validates a proposed payment amount for a payment rail
+     * @param railId ID of the payment rail
+     * @param proposedAmount Proposed payment amount to validate
+     * @param fromEpoch The epoch up to and including which the rail has already been settled
+     * @param toEpoch The epoch up to and including which validation is requested; payment will be validated for (toEpoch - fromEpoch) epochs
+     * @param rate Rate used for payment calculation
+     * @return result ValidationResult struct containing validation outcome
+     */
+    function validatePayment(
+        uint256 railId,
+        uint256 proposedAmount,
+        // the epoch up to and including which the rail has already been settled
+        uint256 fromEpoch,
+        // the epoch up to and including which validation is requested; payment will be validated for (toEpoch - fromEpoch) epochs
+        uint256 toEpoch,
+        uint256 rate
+    ) external returns (ValidationResult memory result);
+
+    /**
+     * @notice Invoked when a payment rail is terminated
+     * @param railId The ID of the terminated rail
+     * @param terminator Address that initiated the termination
+     * @param endEpoch Filecoin epoch at which the rail was terminated
+     */
+    function railTerminated(uint256 railId, address terminator, uint256 endEpoch) external;
+}