Merge pull request #19 from dadadave80/chore/rename-and-refactor-libs

Chore/rename and refactor libs

Author: dadadave80

script/DeployDiamond.s.sol

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {FacetCut, FacetCutAction} from "@diamond-storage/DiamondStorage.sol";
 import {GetSelectors} from "@diamond-test/helpers/GetSelectors.sol";
 import {MockDiamond} from "@diamond-test/mocks/MockDiamond.sol";
 import {DiamondCutFacet} from "@diamond/facets/DiamondCutFacet.sol";
 import {DiamondLoupeFacet} from "@diamond/facets/DiamondLoupeFacet.sol";
 import {OwnableRolesFacet} from "@diamond/facets/OwnableRolesFacet.sol";
 import {DiamondInit} from "@diamond/initializers/DiamondInit.sol";
-import {LibContext} from "@diamond/libraries/LibContext.sol";
+import {ContextLib} from "@diamond/libraries/ContextLib.sol";
+import {FacetCut, FacetCutAction} from "@diamond/libraries/DiamondLib.sol";
 import {Script} from "forge-std/Script.sol";
 
 /// @title DeployDiamond
@@ -57,7 +57,7 @@ contract DeployDiamond is Script, GetSelectors {
 
         // Deploy the Diamond contract with the facets and initialization args
         MockDiamond diamond =
-            new MockDiamond(cut, diamondInit, abi.encodeWithSignature("initDiamond(address)", LibContext._msgSender()));
+            new MockDiamond(cut, diamondInit, abi.encodeWithSignature("initDiamond(address)", ContextLib.msgSender()));
         diamond_ = address(diamond);
         vm.stopBroadcast();
     }

src/Diamond.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {FacetCut, LibDiamond} from "@diamond/libraries/LibDiamond.sol";
+import {DiamondLib, FacetCut} from "@diamond/libraries/DiamondLib.sol";
 
 /*
 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀
@@ -64,14 +64,18 @@ abstract contract Diamond {
 
             // Revert or return based on the result
             switch result
-            case 0 { revert(0, returndatasize()) }
-            default { return(0, returndatasize()) }
+            case 0 {
+                revert(0, returndatasize())
+            }
+            default {
+                return(0, returndatasize())
+            }
         }
     }
 
     /// @notice Internal function to perform a diamond cut
     function _diamondCut(FacetCut[] memory _facetCuts, address _init, bytes memory _calldata) internal virtual {
-        LibDiamond._diamondCut(_facetCuts, _init, _calldata);
+        DiamondLib.diamondCut(_facetCuts, _init, _calldata);
     }
 
     /// @notice Internal hook function to run before a delegatecall to the facet
@@ -81,6 +85,6 @@ abstract contract Diamond {
     /// @notice Retrieves the implementation address for the current function call
     /// @dev A Facet is one of many implementations in a Diamond Proxy
     function _facet() internal view virtual returns (address) {
-        return LibDiamond._selectorToFacet(msg.sig);
+        return DiamondLib.selectorToFacet(msg.sig);
     }
 }

src/facets/DiamondCutFacet.sol

@@ -1,10 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {FacetCut} from "@diamond-storage/DiamondStorage.sol";
 import {IDiamondCut} from "@diamond/interfaces/IDiamondCut.sol";
-import {LibDiamond} from "@diamond/libraries/LibDiamond.sol";
-import {LibOwnableRoles} from "@diamond/libraries/LibOwnableRoles.sol";
+import {DiamondLib, FacetCut} from "@diamond/libraries/DiamondLib.sol";
+import {OwnableRolesLib} from "@diamond/libraries/OwnableRolesLib.sol";
 
 /// @title DiamondCutFacet
 /// @notice Simple single owner and multiroles authorization mixin.
@@ -23,8 +22,8 @@ contract DiamondCutFacet is IDiamondCut {
     ///                  _calldata is executed with delegatecall on _init
     function diamondCut(FacetCut[] calldata _diamondCut, address _init, bytes calldata _calldata) external payable {
         // Check that the caller is the owner
-        LibOwnableRoles._checkOwner();
+        OwnableRolesLib._checkOwner();
         // Call the diamond cut function from the library
-        LibDiamond._diamondCutCalldata(_diamondCut, _init, _calldata);
+        DiamondLib.diamondCutCalldata(_diamondCut, _init, _calldata);
     }
 }

src/facets/DiamondLoupeFacet.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {Facet} from "@diamond-storage/DiamondStorage.sol";
 import {IDiamondLoupe} from "@diamond/interfaces/IDiamondLoupe.sol";
-import {DiamondStorage, LibDiamond} from "@diamond/libraries/LibDiamond.sol";
+import {Facet} from "@diamond/libraries/DiamondLib.sol";
+import {DiamondLib, DiamondStorage} from "@diamond/libraries/DiamondLib.sol";
 
 /// @title DiamondLoupeFacet
 /// @notice Provides read-only functions to inspect the state of a Diamond proxy, including facets, function selectors, and supported interfaces
@@ -15,7 +15,7 @@ contract DiamondLoupeFacet is IDiamondLoupe {
     /// @notice Gets all facet addresses and their function selectors.
     /// @return facets_ Facet
     function facets() external view returns (Facet[] memory facets_) {
-        DiamondStorage storage ds = LibDiamond._diamondStorage();
+        DiamondStorage storage ds = DiamondLib.diamondStorage();
         uint256 facetCount = ds.facetAddresses.length;
         facets_ = new Facet[](facetCount);
         for (uint256 i; i < facetCount; ++i) {
@@ -34,21 +34,21 @@ contract DiamondLoupeFacet is IDiamondLoupe {
         override
         returns (bytes4[] memory facetFunctionSelectors_)
     {
-        facetFunctionSelectors_ = LibDiamond._diamondStorage().facetToSelectorsAndPosition[_facet].functionSelectors;
+        facetFunctionSelectors_ = DiamondLib.diamondStorage().facetToSelectorsAndPosition[_facet].functionSelectors;
     }
 
     /// @notice Get all the facet addresses used by a diamond.
     /// @return facetAddresses_
     function facetAddresses() external view override returns (address[] memory facetAddresses_) {
-        facetAddresses_ = LibDiamond._diamondStorage().facetAddresses;
+        facetAddresses_ = DiamondLib.diamondStorage().facetAddresses;
     }
 
     /// @notice Gets the facet that supports the given selector.
     /// @dev If facet is not found return address(0).
     /// @param _functionSelector The function selector.
     /// @return facetAddress_ The facet address.
     function facetAddress(bytes4 _functionSelector) external view override returns (address facetAddress_) {
-        facetAddress_ = LibDiamond._diamondStorage().selectorToFacetAndPosition[_functionSelector].facetAddress;
+        facetAddress_ = DiamondLib.diamondStorage().selectorToFacetAndPosition[_functionSelector].facetAddress;
     }
 
     /// @notice Query if a contract implements an interface
@@ -58,6 +58,6 @@ contract DiamondLoupeFacet is IDiamondLoupe {
     /// @return `true` if the contract implements `interfaceID` and
     ///  `interfaceID` is not 0xffffffff, `false` otherwise
     function supportsInterface(bytes4 _interfaceId) external view returns (bool) {
-        return LibDiamond._diamondStorage().supportedInterfaces[_interfaceId];
+        return DiamondLib.diamondStorage().supportedInterfaces[_interfaceId];
     }
 }

src/facets/OwnableRolesFacet.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {LibOwnableRoles} from "@diamond/libraries/LibOwnableRoles.sol";
+import {OwnableRolesLib} from "@diamond/libraries/OwnableRolesLib.sol";
 
 /// @title OwnableRolesFacet
 /// @notice Simple single owner and multiroles authorization mixin.
@@ -16,7 +16,7 @@ import {LibOwnableRoles} from "@diamond/libraries/LibOwnableRoles.sol";
 /// [EIP-173](https://eips.ethereum.org/EIPS/eip-173) for compatibility,
 /// the nomenclature for the 2-step ownership handover may be unique to this codebase.
 contract OwnableRolesFacet {
-    using LibOwnableRoles for *;
+    using OwnableRolesLib for *;
 
     /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
     /*                  PUBLIC UPDATE FUNCTIONS                   */
@@ -29,18 +29,18 @@ contract OwnableRolesFacet {
 
     /// @dev Allows the owner to renounce their ownership.
     function renounceOwnership() public onlyOwner {
-        LibOwnableRoles._renounceOwnership();
+        OwnableRolesLib._renounceOwnership();
     }
 
     /// @dev Request a two-step ownership handover to the caller.
     /// The request will automatically expire in 48 hours (172800 seconds) by default.
     function requestOwnershipHandover() public {
-        LibOwnableRoles._requestOwnershipHandover();
+        OwnableRolesLib._requestOwnershipHandover();
     }
 
     /// @dev Cancels the two-step ownership handover to the caller, if any.
     function cancelOwnershipHandover() public {
-        LibOwnableRoles._cancelOwnershipHandover();
+        OwnableRolesLib._cancelOwnershipHandover();
     }
 
     /// @dev Allows the owner to complete the two-step ownership handover to `pendingOwner`.
@@ -73,7 +73,7 @@ contract OwnableRolesFacet {
 
     /// @dev Returns the owner of the contract.
     function owner() public view returns (address) {
-        return LibOwnableRoles._owner();
+        return OwnableRolesLib._owner();
     }
 
     /// @dev Returns the expiry timestamp for the two-step ownership handover to `pendingOwner`.
@@ -116,27 +116,27 @@ contract OwnableRolesFacet {
 
     /// @dev Marks a function as only callable by the owner.
     modifier onlyOwner() {
-        LibOwnableRoles._checkOwner();
+        OwnableRolesLib._checkOwner();
         _;
     }
 
     /// @dev Marks a function as only callable by an account with `roles`.
     modifier onlyRoles(uint256 _roles) {
-        LibOwnableRoles._checkRoles(_roles);
+        OwnableRolesLib._checkRoles(_roles);
         _;
     }
 
     /// @dev Marks a function as only callable by the owner or by an account
     ///      with `roles`. Checks for ownership first, then lazily checks for roles.
     modifier onlyOwnerOrRoles(uint256 _roles) {
-        LibOwnableRoles._checkOwnerOrRoles(_roles);
+        OwnableRolesLib._checkOwnerOrRoles(_roles);
         _;
     }
 
     /// @dev Marks a function as only callable by an account with `roles` or the owner.
     /// Checks for roles first, then lazily checks for ownership.
     modifier onlyRolesOrOwner(uint256 _roles) {
-        LibOwnableRoles._checkRolesOrOwner(_roles);
+        OwnableRolesLib._checkRolesOrOwner(_roles);
         _;
     }
 }

src/initializers/DiamondInit.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {DiamondStorage, LibDiamond} from "@diamond/libraries/LibDiamond.sol";
-import {LibOwnableRoles} from "@diamond/libraries/LibOwnableRoles.sol";
+import {DiamondLib, DiamondStorage} from "@diamond/libraries/DiamondLib.sol";
+import {OwnableRolesLib} from "@diamond/libraries/OwnableRolesLib.sol";
 
 /// @title DiamondInit
 /// @notice Provides an initializer to register standard interface support (ERC-165, ERC-173, IDiamondCut, IDiamondLoupe)
@@ -16,9 +16,9 @@ contract DiamondInit {
     ///      the initial state of the contract.
     function initDiamond(address _owner) public {
         // Initialize the owner
-        LibOwnableRoles._initializeOwner(_owner);
+        OwnableRolesLib._initializeOwner(_owner);
 
-        DiamondStorage storage ds = LibDiamond._diamondStorage();
+        DiamondStorage storage ds = DiamondLib.diamondStorage();
         /// @dev type(ERC165).interfaceId
         ds.supportedInterfaces[0x01ffc9a7] = true;
         /// @dev type(IERC173).interfaceId

src/initializers/MultiInit.sol

@@ -1,16 +1,21 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {LibDiamond} from "@diamond/libraries/LibDiamond.sol";
-import {AddressAndCalldataLengthMismatch} from "@diamond/libraries/errors/DiamondErrors.sol";
+import {DiamondLib} from "@diamond/libraries/DiamondLib.sol";
+
+/// @notice Thrown when the length of the address array does not match the length of the calldata array.
+/// @dev Used in initializer logic to ensure one-to-one mapping between addresses and initialization calldata.
+error AddressAndCalldataLengthMismatch();
 
 contract MultiInit {
-    function multiInit(address[] memory _initAddresses, bytes[] memory _initData) public {
+    function multiInit(address[] calldata _initAddresses, bytes[] calldata _initData) public {
         uint256 initAddressesLength = _initAddresses.length;
-        if (initAddressesLength != _initData.length) revert AddressAndCalldataLengthMismatch();
+        if (initAddressesLength != _initData.length) {
+            revert AddressAndCalldataLengthMismatch();
+        }
 
         for (uint256 i; i < initAddressesLength; ++i) {
-            LibDiamond._initializeDiamondCut(_initAddresses[i], _initData[i]);
+            DiamondLib.initializeDiamondCut(_initAddresses[i], _initData[i]);
         }
     }
 }

src/interfaces/IDiamondCut.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {FacetCut} from "@diamond-storage/DiamondStorage.sol";
+import {FacetCut} from "@diamond/libraries/DiamondLib.sol";
 
 /// @title IDiamondCut
 /// @notice Interface for diamond cut (facet add/replace/remove) functionality

src/interfaces/IDiamondLoupe.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {Facet} from "@diamond-storage/DiamondStorage.sol";
+import {Facet} from "@diamond/libraries/DiamondLib.sol";
 
 /// @title IDiamondLoupe
 /// @notice Interface for diamond loupe (facet information) functionality

src/libraries/LibContext.sol src/libraries/ContextLib.solsrc/libraries/LibContext.sol renamed to src/libraries/ContextLib.sol

@@ -12,16 +12,16 @@ pragma solidity ^0.8.20;
  *
  * This contract is only required for intermediate, library-like contracts.
  */
-library LibContext {
-    function _msgSender() internal view returns (address) {
+library ContextLib {
+    function msgSender() internal view returns (address) {
         return msg.sender;
     }
 
-    function _msgData() internal pure returns (bytes calldata) {
+    function msgData() internal pure returns (bytes calldata) {
         return msg.data;
     }
 
-    function _contextSuffixLength() internal pure returns (uint256) {
+    function contextSuffixLength() internal pure returns (uint256) {
         return 0;
     }
 }