update readme and format code

Author: rya-sge

README.md

@@ -9,18 +9,18 @@ abstract contract AccessControlModuleStandalone is AccessControl {
     error AccessControlModuleStandalone_AddressZeroNotAllowed();
     /* ============ Constructor ============ */
     /**
-    * @notice Assigns the provided address as the default admin.
-    * @dev
-    *  - Reverts if `admin` is the zero address.  
-    *  - Grants `DEFAULT_ADMIN_ROLE` to `admin`.  
-    *    The return value of `_grantRole` is intentionally ignored, as it returns `false`
-    *    only when the role was already granted.
-    *
-    * @param admin The address that will receive the `DEFAULT_ADMIN_ROLE`.
-    */
-    constructor(address admin)
-    {
-        if(admin == address(0)){
+     * @notice Assigns the provided address as the default admin.
+     * @dev
+     *  - Reverts if `admin` is the zero address.
+     *  - Grants `DEFAULT_ADMIN_ROLE` to `admin`.
+     *    The return value of `_grantRole` is intentionally ignored, as it returns `false`
+     *    only when the role was already granted.
+     *
+     * @param admin The address that will receive the `DEFAULT_ADMIN_ROLE`.
+     */
+
+    constructor(address admin) {
+        if (admin == address(0)) {
             revert AccessControlModuleStandalone_AddressZeroNotAllowed();
         }
         // we don't check the return value
@@ -29,17 +29,13 @@ abstract contract AccessControlModuleStandalone is AccessControl {
         _grantRole(DEFAULT_ADMIN_ROLE, admin);
     }
 
-
     /*//////////////////////////////////////////////////////////////
                             PUBLIC/EXTERNAL FUNCTIONS
     //////////////////////////////////////////////////////////////*/
-    /** 
+    /**
      * @dev Returns `true` if `account` has been granted `role`.
      */
-    function hasRole(
-        bytes32 role,
-        address account
-    ) public view virtual override(AccessControl) returns (bool) {
+    function hasRole(bytes32 role, address account) public view virtual override(AccessControl) returns (bool) {
         // The Default Admin has all roles
         if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) {
             return true;

doc/codelist.md

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.0;
 
 import {IIdentityRegistryContains} from "./IIdentityRegistry.sol";
+
 interface IAddressList is IIdentityRegistryContains {
     /* ============ Events ============ */
     /// @notice Emitted when multiple addresses are added.
@@ -20,7 +21,6 @@ interface IAddressList is IIdentityRegistryContains {
     /// @param targetAddress The removed address.
     event RemoveAddress(address targetAddress);
 
-
     /* ============ Write ============ */
     /**
      * @notice Adds multiple addresses to the set.
@@ -50,7 +50,6 @@ interface IAddressList is IIdentityRegistryContains {
      */
     function removeAddress(address targetAddress) external;
 
-
     /* ============ Read ============ */
 
     /**
@@ -71,8 +70,5 @@ interface IAddressList is IIdentityRegistryContains {
      * @param targetAddresses Array of addresses to check.
      * @return results Boolean array aligned by index with listing results.
      */
-    function areAddressesListed(address[] memory targetAddresses)
-        external
-        view
-        returns (bool[] memory results);
-}
+    function areAddressesListed(address[] memory targetAddresses) external view returns (bool[] memory results);
+}

src/modules/AccessControlModuleStandalone.sol

@@ -11,15 +11,15 @@ pragma solidity ^0.8.20;
  *    whether a transfer is permitted according to rule-based restrictions.
  */
 interface IERC7943NonFungibleCompliance {
-   /**
+    /**
      * @notice Verifies whether a transfer is permitted according to the token’s compliance rules.
      * @dev
      *  This function must not modify state.
      *  It may enforce checks such as:
-     *   - Allowlist / blocklist membership  
-     *   - Freezing rules  
-     *   - Transfer limitations  
-     *   - Jurisdictional, regulatory, or policy-driven restrictions  
+     *   - Allowlist / blocklist membership
+     *   - Freezing rules
+     *   - Transfer limitations
+     *   - Jurisdictional, regulatory, or policy-driven restrictions
      *  If the transfer is not allowed, this function MUST return `false`.
      *
      * @param from The address currently holding the token.
@@ -28,25 +28,28 @@ interface IERC7943NonFungibleCompliance {
      * @param amount The amount being transferred (always `1` for ERC-721).
      * @return allowed `true` if the transfer is permitted, otherwise `false`.
      */
-    function canTransfer(address from, address to, uint256 tokenId, uint256 amount) external view returns (bool allowed);
+    function canTransfer(address from, address to, uint256 tokenId, uint256 amount)
+        external
+        view
+        returns (bool allowed);
 }
 
 /**
  * @title IERC7943NonFungibleComplianceExtend
  * @notice Extended compliance interface for ERC-721/1155–style non-fungible assets.
  * @dev
  *  Adds functionality for:
- *   - Returning standardized transfer-restriction codes  
- *   - Compliance checks involving a spender (e.g., approvals and operators)  
- *   - Writing compliance-related state upon successful transfers  
+ *   - Returning standardized transfer-restriction codes
+ *   - Compliance checks involving a spender (e.g., approvals and operators)
+ *   - Writing compliance-related state upon successful transfers
  *  For ERC-721, `amount/value` MUST be set to `1`.
  */
- interface IERC7943NonFungibleComplianceExtend is IERC7943NonFungibleCompliance {
+interface IERC7943NonFungibleComplianceExtend is IERC7943NonFungibleCompliance {
     /**
      * @notice Returns a transfer-restriction code describing why a transfer is blocked.
      * @dev
-     *  - MUST NOT modify state.  
-     *  - MUST return `0` when the transfer is allowed.  
+     *  - MUST NOT modify state.
+     *  - MUST return `0` when the transfer is allowed.
      *  - Non-zero codes SHOULD follow the ERC-1404 or RuleEngine restriction-code conventions.
      *
      * @param from The address currently holding the token.
@@ -55,8 +58,11 @@ interface IERC7943NonFungibleCompliance {
      * @param amount The amount being transferred (always `1` for ERC-721).
      * @return code A restriction code: `0` for success, otherwise an implementation-defined error code.
      */
-    function detectTransferRestriction(address from, address to, uint256 tokenId, uint256  amount ) external view returns(uint8 code);
-    
+    function detectTransferRestriction(address from, address to, uint256 tokenId, uint256 amount)
+        external
+        view
+        returns (uint8 code);
+
     /**
      * @notice Returns a transfer-restriction code for transfers triggered by a spender.
      * @dev
@@ -89,7 +95,9 @@ interface IERC7943NonFungibleCompliance {
      * @param value The transfer amount (always `1` for ERC-721).
      * @return allowed `true` if the transfer is permitted, otherwise `false`.
      */
-    function canTransferFrom(address spender, address from, address to, uint256 tokenId, uint256 value) external returns (bool allowed);
+    function canTransferFrom(address spender, address from, address to, uint256 tokenId, uint256 value)
+        external
+        returns (bool allowed);
 
     /**
      * @notice Notifies the rule engine or compliance module that a transfer has been executed.
@@ -106,4 +114,3 @@ interface IERC7943NonFungibleCompliance {
      */
     function transferred(address spender, address from, address to, uint256 tokenId, uint256 value) external;
 }
- 

src/rules/interfaces/IAddressList.sol

@@ -3,7 +3,8 @@
 pragma solidity ^0.8.20;
 
 /* ==== Abtract contracts === */
-import {RuleBlacklistInvariantStorage} from "./abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol";
+import {RuleBlacklistInvariantStorage} from
+    "./abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol";
 import {RuleAddressSet} from "./abstract/RuleAddressSet/RuleAddressSet.sol";
 import {RuleValidateTransfer} from "./abstract/RuleValidateTransfer.sol";
 /* ==== Interfaces === */
@@ -54,7 +55,7 @@ contract RuleBlacklist is RuleValidateTransfer, RuleAddressSet, RuleBlacklistInv
     /*
     * @inheritdoc IERC7943NonFungibleComplianceExtend
     */
-    function detectTransferRestriction(address from, address to, uint256 /* tokenId */, uint256 value )
+    function detectTransferRestriction(address from, address to, uint256, /* tokenId */ uint256 value)
         public
         view
         override(IERC7943NonFungibleComplianceExtend)
@@ -80,14 +81,15 @@ contract RuleBlacklist is RuleValidateTransfer, RuleAddressSet, RuleBlacklistInv
     }
 
     /**
-    * @inheritdoc IERC7943NonFungibleComplianceExtend
-    */
-    function detectTransferRestrictionFrom(address spender, address from, address to, uint256 /* tokenId */, uint256 value )
-        public
-        view
-        override(IERC7943NonFungibleComplianceExtend)
-        returns (uint8)
-    {
+     * @inheritdoc IERC7943NonFungibleComplianceExtend
+     */
+    function detectTransferRestrictionFrom(
+        address spender,
+        address from,
+        address to,
+        uint256, /* tokenId */
+        uint256 value
+    ) public view override(IERC7943NonFungibleComplianceExtend) returns (uint8) {
         return detectTransferRestrictionFrom(spender, from, to, value);
     }
 
@@ -97,7 +99,13 @@ contract RuleBlacklist is RuleValidateTransfer, RuleAddressSet, RuleBlacklistInv
      * @return true if the restriction code is known, false otherwise
      *
      */
-    function canReturnTransferRestrictionCode(uint8 _restrictionCode) public pure virtual override(IRule) returns (bool) {
+    function canReturnTransferRestrictionCode(uint8 _restrictionCode)
+        public
+        pure
+        virtual
+        override(IRule)
+        returns (bool)
+    {
         return _restrictionCode == CODE_ADDRESS_FROM_IS_BLACKLISTED
             || _restrictionCode == CODE_ADDRESS_TO_IS_BLACKLISTED || _restrictionCode == CODE_ADDRESS_SPENDER_IS_BLACKLISTED;
     }
@@ -108,7 +116,13 @@ contract RuleBlacklist is RuleValidateTransfer, RuleAddressSet, RuleBlacklistInv
      * @return true if the transfer is valid, false otherwise
      *
      */
-    function messageForTransferRestriction(uint8 _restrictionCode) public pure virtual override(IERC1404) returns (string memory) {
+    function messageForTransferRestriction(uint8 _restrictionCode)
+        public
+        pure
+        virtual
+        override(IERC1404)
+        returns (string memory)
+    {
         if (_restrictionCode == CODE_ADDRESS_FROM_IS_BLACKLISTED) {
             return TEXT_ADDRESS_FROM_IS_BLACKLISTED;
         } else if (_restrictionCode == CODE_ADDRESS_TO_IS_BLACKLISTED) {
@@ -122,17 +136,38 @@ contract RuleBlacklist is RuleValidateTransfer, RuleAddressSet, RuleBlacklistInv
 
     /* ============  State Functions ============ */
 
-    function transferred(address from, address to, uint256 value) public view virtual override(IERC3643IComplianceContract) {
+    function transferred(address from, address to, uint256 value)
+        public
+        view
+        virtual
+        override(IERC3643IComplianceContract)
+    {
         uint8 code = this.detectTransferRestriction(from, to, value);
-        require(code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), RuleBlacklist_InvalidTransfer(address(this), from, to, value, code));
+        require(
+            code == uint8(REJECTED_CODE_BASE.TRANSFER_OK),
+            RuleBlacklist_InvalidTransfer(address(this), from, to, value, code)
+        );
     }
 
-    function transferred(address spender, address from, address to, uint256 value) public view virtual override(IRuleEngine) {
+    function transferred(address spender, address from, address to, uint256 value)
+        public
+        view
+        virtual
+        override(IRuleEngine)
+    {
         uint8 code = this.detectTransferRestrictionFrom(spender, from, to, value);
-        require(code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), RuleBlacklist_InvalidTransfer(address(this), from, to, value, code));
+        require(
+            code == uint8(REJECTED_CODE_BASE.TRANSFER_OK),
+            RuleBlacklist_InvalidTransfer(address(this), from, to, value, code)
+        );
     }
 
-    function transferred(address spender, address from, address to, uint256 /* tokenId */, uint256 value) public view virtual override(IERC7943NonFungibleComplianceExtend) {
+    function transferred(address spender, address from, address to, uint256, /* tokenId */ uint256 value)
+        public
+        view
+        virtual
+        override(IERC7943NonFungibleComplianceExtend)
+    {
         transferred(spender, from, to, value);
     }
 }