@evvm/testnet-contracts 2.2.3 → 3.0.0

package/contracts/nameService/lib/IdentityValidation.sol

@@ -2,12 +2,27 @@
 // Full license terms available at: https://www.evvm.info/docs/EVVMNoncommercialLicense
 
 pragma solidity ^0.8.0;
-
+/**
+ * @title EVVM Identity Validation
+ * @author Mate labs
+ * @notice Byte-level validation for usernames, phone numbers, and emails.
+ * @dev Optimized for gas efficiency. Rules: Usernames (4+ chars, start with letter), 
+ *      Phones (digit checks), Emails (structural structure).
+ */
 library IdentityValidation{
     /**
-     * @notice Validates username format according to system rules
-     * @dev Username must be at least 4 characters, start with a letter, and contain only letters/digits
+     * @notice Validates username format per system rules
+     * @dev Username must be 4+ chars, start with letter,
+     *      contain only letters/digits
+     *
+     * Validation Rules:
+     * - Minimum length: 4 characters
+     * - Must start with a letter (A-Z or a-z)
+     * - Can only contain letters and digits
+     * - No special characters or spaces allowed
+     *
      * @param username The username string to validate
+     * @return True if valid username format, false otherwise
      */
     function isValidUsername(string memory username) internal pure returns (bool) {
         bytes memory usernameBytes = bytes(username);