Merge pull request #16 from fidlabs/feature/utests

unit tests

Author: CodeWarriorr

.env.example

@@ -14,8 +14,14 @@ PROXY_ADDRESS_CALIBNET=
 PROXY_ADDRESS_MAINNET=
 
 # For Mainnet deployment
+# Collateral deposit per CID in wei (1 FIL = 10^18 wei)
 COLLATERAL_PER_CID=100000000000000000 # 0.1 FIL
+# Minimum required storage providers and maximum replicas
+# Note: This is a critical configuration that should be set according to your contract requirements.
+# It defines the number of storage providers picked for each allocation package
 MIN_REQUIRED_STORAGE_PROVIDERS=2
+# Maximum replicas to available for users for each CID in an allocation package
+# Minimum is 1, maximum has to be less than or equal to the number of storage providers
 MAX_REPLICAS=3
 
 # For Devnet bash deploy scripts

README.md

@@ -229,8 +229,14 @@ PROXY_ADDRESS_CALIBNET=
 PROXY_ADDRESS_MAINNET=
 
 # For Mainnet deployment
+# Collateral deposit per CID in wei (1 FIL = 10^18 wei)
 COLLATERAL_PER_CID=100000000000000000 # 0.1 FIL
-MIN_REQUIRED_STORAGE_PROVIDERS=2
+# Minimum required storage providers and maximum replicas
+# Note: This is a critical configuration that should be set according to your contract requirements.
+# It defines the number of storage providers picked for each allocation package
+MIN_REQUIRED_STORAGE_PROVIDERS=2 
+# Maximum replicas to available for users for each CID in an allocation package
+# Minimum is 1, maximum has to be less than or equal to the number of storage providers
 MAX_REPLICAS=3
 
 # For Devnet bash deploy scripts

src/diamond/DiamondCutFacet.sol

@@ -15,7 +15,7 @@ import {LibDiamond} from "../libraries/LibDiamond.sol";
 
 contract DiamondCutFacet is IFacet, IDiamondCut {
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure returns (bytes4[] memory) {
+    function selectors() external pure virtual returns (bytes4[] memory) {
         bytes4[] memory _selectors = new bytes4[](1);
         _selectors[0] = this.diamondCut.selector;
         return _selectors;

src/diamond/DiamondLoupeFacet.sol

@@ -15,7 +15,7 @@ import {IERC165} from "../interfaces/IERC165.sol";
 
 contract DiamondLoupeFacet is IFacet, IDiamondLoupe, IERC165 {
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure returns (bytes4[] memory) {
+    function selectors() external pure virtual returns (bytes4[] memory) {
         bytes4[] memory _selectors = new bytes4[](4);
         _selectors[0] = this.facets.selector;
         _selectors[1] = this.facetFunctionSelectors.selector;

src/facets/AllocateFacet.sol

@@ -23,7 +23,7 @@ contract AllocateFacet is IFacet, Modifiers, PausableUpgradeable {
     using AllocationResponseCbor for DataCapTypes.TransferReturn;
 
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure returns (bytes4[] memory selectors_) {
+    function selectors() external pure virtual returns (bytes4[] memory selectors_) {
         selectors_ = new bytes4[](1);
         selectors_[0] = this.allocate.selector;
     }

src/facets/AllocatorManagerFacet.sol

@@ -12,7 +12,7 @@ import {IFacet} from "../interfaces/IFacet.sol";
  */
 contract AllocatorManagerFacet is IFacet, Modifiers {
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure returns (bytes4[] memory selectors_) {
+    function selectors() external pure virtual returns (bytes4[] memory selectors_) {
         selectors_ = new bytes4[](3);
         selectors_[0] = this.addAllocator.selector;
         selectors_[1] = this.removeAllocator.selector;

src/facets/DevnetFacet.sol

@@ -6,11 +6,17 @@ import {IFacet} from "../interfaces/IFacet.sol";
 import {Modifiers} from "../Modifiers.sol";
 
 contract DevnetFacet is IFacet, Modifiers {
-    error NotOnDevnet();
+    error NotOnDevnet(uint256 chainId);
 
+    /**
+     * @notice Build-in protection against deploying this facet on mainnet or testnet.
+     * 314159 - calibnet
+     * 31415926 - localnet / devenet
+     * 31337 - hardhat localnet
+     */
     constructor() {
-        if (block.chainid != 31415926 && block.chainid != 314159) {
-            revert NotOnDevnet();
+        if (block.chainid != 31415926 && block.chainid != 314159 && block.chainid != 31337) {
+            revert NotOnDevnet(block.chainid);
         }
     }
 

src/facets/FilecoinFacet.sol

@@ -14,7 +14,7 @@ contract FilecoinFacet is IFacet {
     address private constant _DATACAP_ADDRESS = address(0xfF00000000000000000000000000000000000007);
 
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure returns (bytes4[] memory selectors_) {
+    function selectors() external pure virtual returns (bytes4[] memory selectors_) {
         selectors_ = new bytes4[](1);
         selectors_[0] = this.handle_filecoin_method.selector;
     }

src/facets/OwnerFacet.sol

@@ -15,7 +15,7 @@ import {IFacet} from "../interfaces/IFacet.sol";
  */
 contract OwnerFacet is IFacet, Modifiers, PausableUpgradeable {
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure returns (bytes4[] memory selectors_) {
+    function selectors() external pure virtual returns (bytes4[] memory selectors_) {
         selectors_ = new bytes4[](7);
         selectors_[0] = this.setCollateralPerCID.selector;
         selectors_[1] = this.setMinRequiredStorageProviders.selector;
@@ -61,7 +61,7 @@ contract OwnerFacet is IFacet, Modifiers, PausableUpgradeable {
 
     function setDataCapTermMaxDays(int64 dataCapTermMaxDays) external onlyOwner {
         if (
-            dataCapTermMaxDays <= FilecoinEpochCalculator.TERM_MIN
+            dataCapTermMaxDays <= FilecoinEpochCalculator.TERM_MIN_IN_DAYS
                 || dataCapTermMaxDays > FilecoinEpochCalculator.FIVE_YEARS_IN_DAYS
         ) {
             revert ErrorLib.InvalidDataCapTermMaxDays();

src/facets/OwnershipFacet.sol

@@ -8,7 +8,7 @@ import {ErrorLib} from "../libraries/Errors.sol";
 
 contract OwnershipFacet is IFacet, IERC173 {
     // get the function selectors for this facet for deployment and update scripts
-    function selectors() external pure override returns (bytes4[] memory selectors_) {
+    function selectors() external pure virtual override returns (bytes4[] memory selectors_) {
         selectors_ = new bytes4[](4);
         selectors_[0] = this.transferOwnership.selector;
         selectors_[1] = this.owner.selector;