chore(iota-names): some cleanup and improvements (#6530)

Co-authored-by: Thoralf-M <[email protected]>

Author: thibault-martinez

crates/iota-graphql-rpc/src/types/query.rs

@@ -541,7 +541,8 @@ impl Query {
             .extend()
     }
 
-    /// Resolves an IOTA-Names `domain` name to an address, if it has been bound.
+    /// Resolves an IOTA-Names `domain` name to an address, if it has been
+    /// bound.
     async fn resolve_iota_names_address(
         &self,
         ctx: &Context<'_>,

crates/iota-indexer/src/lib.rs

@@ -174,9 +174,9 @@ pub struct IotaNamesOptions {
     #[arg(default_value_t = IotaNamesConfig::default().object_id)]
     #[arg(long = "iota-names-object-id")]
     pub object_id: ObjectID,
-    #[arg(default_value_t = IotaNamesConfig::default().payment_package_address)]
-    #[arg(long = "iota-names-payment-package-address")]
-    pub payment_package_address: IotaAddress,
+    #[arg(default_value_t = IotaNamesConfig::default().payments_package_address)]
+    #[arg(long = "iota-names-payments-package-address")]
+    pub payments_package_address: IotaAddress,
     #[arg(default_value_t = IotaNamesConfig::default().registry_id)]
     #[arg(long = "iota-names-registry-id")]
     pub registry_id: ObjectID,
@@ -193,15 +193,15 @@ impl From<IotaNamesOptions> for IotaNamesConfig {
         let IotaNamesOptions {
             package_address,
             object_id,
-            payment_package_address,
+            payments_package_address,
             registry_id,
             reverse_registry_id,
             subdomain_proxy_package_id,
         } = options;
         Self {
             package_address,
             object_id,
-            payment_package_address,
+            payments_package_address,
             registry_id,
             reverse_registry_id,
             subdomain_proxy_package_id,
@@ -214,15 +214,15 @@ impl From<IotaNamesConfig> for IotaNamesOptions {
         let IotaNamesConfig {
             package_address,
             object_id,
-            payment_package_address,
+            payments_package_address,
             registry_id,
             reverse_registry_id,
             subdomain_proxy_package_id,
         } = config;
         Self {
             package_address,
             object_id,
-            payment_package_address,
+            payments_package_address,
             registry_id,
             reverse_registry_id,
             subdomain_proxy_package_id,

crates/iota-names/src/config.rs

@@ -15,22 +15,29 @@ use crate::Domain;
 pub const LEAF_EXPIRATION_TIMESTAMP: u64 = 0;
 pub const DEFAULT_TLD: &str = "iota";
 pub const ACCEPTED_SEPARATORS: [char; 2] = ['.', '*'];
-pub const IOTA_NEW_FORMAT_SEPARATOR: char = '@';
+pub const IOTA_AT_FORMAT_SEPARATOR: char = '@';
 
 #[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
 #[serde(rename_all = "kebab-case")]
 pub struct IotaNamesConfig {
+    /// Address of the `iota_names` package.
     pub package_address: IotaAddress,
+    /// ID of the `IotaNames` object.
     pub object_id: ObjectID,
-    pub payment_package_address: IotaAddress,
+    /// Address of the `payments` package.
+    pub payments_package_address: IotaAddress,
+    /// ID of the registry table.
     pub registry_id: ObjectID,
+    /// ID of the reverse registry table.
     pub reverse_registry_id: ObjectID,
+    /// Address of the `subdomain_proxy` package.
     pub subdomain_proxy_package_id: ObjectID,
 }
 
 impl Default for IotaNamesConfig {
     fn default() -> Self {
-        // TODO change to mainnet
+        // TODO change to mainnet https://github.com/iotaledger/iota/issues/6532
+        // TODO change to testnet https://github.com/iotaledger/iota/issues/6531
         Self::devnet()
     }
 }
@@ -39,15 +46,15 @@ impl IotaNamesConfig {
     pub fn new(
         package_address: IotaAddress,
         object_id: ObjectID,
-        payment_package_address: IotaAddress,
+        payments_package_address: IotaAddress,
         registry_id: ObjectID,
         reverse_registry_id: ObjectID,
         subdomain_proxy_package_id: ObjectID,
     ) -> Self {
         Self {
             package_address,
             object_id,
-            payment_package_address,
+            payments_package_address,
             registry_id,
             reverse_registry_id,
             subdomain_proxy_package_id,
@@ -56,10 +63,9 @@ impl IotaNamesConfig {
 
     pub fn from_chain(chain: &Chain) -> Self {
         match chain {
-            // Chain::Mainnet => IotaNamesConfig::mainnet(),
-            // Chain::Testnet => IotaNamesConfig::testnet(),
+            Chain::Mainnet => todo!("https://github.com/iotaledger/iota/issues/6532"),
+            Chain::Testnet => todo!("https://github.com/iotaledger/iota/issues/6531"),
             Chain::Unknown => IotaNamesConfig::devnet(),
-            _ => todo!("uncomment Mainnet and Testnet when IOTA-Names is published there"),
         }
     }
 
@@ -84,15 +90,17 @@ impl IotaNamesConfig {
         .unwrap()
     }
 
-    // TODO add mainnet() and testnet()
+    // TODO add mainnet https://github.com/iotaledger/iota/issues/6532
 
-    // Create a config based on the package and object ids published on devnet
+    // TODO add testnet https://github.com/iotaledger/iota/issues/6531
+
+    // Create a config based on the package and object ids published on devnet.
     pub fn devnet() -> Self {
         const PACKAGE_ADDRESS: &str =
             "0xe27899d691184f66821f8fed5e7c26f3c65b26921947956435a655c8d7efc573";
         const OBJECT_ID: &str =
             "0xdad5289ef0d64f8f3b4d72522907f3f67109fa00bfbcba2dd03c68084f1dfc89";
-        const PAYMENT_PACKAGE_ADDRESS: &str =
+        const PAYMENTS_PACKAGE_ADDRESS: &str =
             "0x8e1d3fafb70764eccc2e6b61812daf0a4db40db3c5cea515bf4d390f11016030";
         const REGISTRY_ID: &str =
             "0xff608b2b0d500b4d0cb25ff165bc3e01fce9bf3ef7fb002840b814d304a08b2a";
@@ -103,15 +111,15 @@ impl IotaNamesConfig {
 
         let package_address = IotaAddress::from_str(PACKAGE_ADDRESS).unwrap();
         let object_id = ObjectID::from_str(OBJECT_ID).unwrap();
-        let payment_package_address = IotaAddress::from_str(PAYMENT_PACKAGE_ADDRESS).unwrap();
+        let payments_package_address = IotaAddress::from_str(PAYMENTS_PACKAGE_ADDRESS).unwrap();
         let registry_id = ObjectID::from_str(REGISTRY_ID).unwrap();
         let reverse_registry_id = ObjectID::from_str(REVERSE_REGISTRY_ID).unwrap();
         let subdomain_proxy_package_id = ObjectID::from_str(SUBDOMAIN_PROXY_PACKAGE_ID).unwrap();
 
         Self::new(
             package_address,
             object_id,
-            payment_package_address,
+            payments_package_address,
             registry_id,
             reverse_registry_id,
             subdomain_proxy_package_id,

crates/iota-names/src/domain.rs

@@ -8,7 +8,7 @@ use move_core_types::{ident_str, identifier::IdentStr, language_storage::StructT
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    config::{ACCEPTED_SEPARATORS, DEFAULT_TLD, IOTA_NEW_FORMAT_SEPARATOR},
+    config::{ACCEPTED_SEPARATORS, DEFAULT_TLD, IOTA_AT_FORMAT_SEPARATOR},
     error::IotaNamesError,
 };
 
@@ -18,13 +18,6 @@ pub struct Domain {
     labels: Vec<String>,
 }
 
-// impl std::fmt::Display for Domain {
-//     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-//         let labels = self.labels.iter().rev().cloned().collect::<Vec<_>>();
-//         write!(f, "{}", labels.join("."))
-//     }
-// }
-
 // impl FromStr for Domain {
 //     type Err = anyhow::Error;
 
@@ -54,7 +47,7 @@ impl FromStr for Domain {
         }
         let separator = separator(s)?;
 
-        let formatted_string = convert_from_new_format(s, &separator)?;
+        let formatted_string = convert_from_at_format(s, &separator)?;
 
         let labels = formatted_string
             .split(separator)
@@ -140,6 +133,9 @@ impl Domain {
     /// Returns the number of labels including TLD.
     ///
     /// ```
+    /// use std::str::FromStr;
+    ///
+    /// use iota_names::domain::Domain;
     /// assert_eq!(
     ///     Domain::from_str("test.example.iota").unwrap().num_labels(),
     ///     3
@@ -176,7 +172,7 @@ impl Domain {
         let _tld = labels.pop();
         let sld = labels.pop().unwrap();
 
-        format!("{}{}{}", labels.join(sep), IOTA_NEW_FORMAT_SEPARATOR, sld)
+        format!("{}{IOTA_AT_FORMAT_SEPARATOR}{sld}", labels.join(sep))
     }
 }
 
@@ -212,8 +208,8 @@ fn separator(s: &str) -> Result<char, IotaNamesError> {
 /// Converts @label ending to label{separator}iota ending.
 ///
 /// E.g. `@example` -> `example.iota` | `test@example` -> `test.example.iota`
-fn convert_from_new_format(s: &str, separator: &char) -> Result<String, IotaNamesError> {
-    let mut splits = s.split(IOTA_NEW_FORMAT_SEPARATOR);
+fn convert_from_at_format(s: &str, separator: &char) -> Result<String, IotaNamesError> {
+    let mut splits = s.split(IOTA_AT_FORMAT_SEPARATOR);
 
     let Some(before) = splits.next() else {
         return Err(IotaNamesError::InvalidSeparator);
@@ -239,9 +235,14 @@ fn convert_from_new_format(s: &str, separator: &char) -> Result<String, IotaName
     Ok(parts.join(&separator.to_string()))
 }
 
+/// Checks the validity of a label according to these rules:
+/// - length must be in [MIN_LABEL_LENGTH..MAX_LABEL_LENGTH]
+/// - must contain only '0'..'9', 'a'..'z' and '-'
+/// - must not start or end with '-'
 pub fn validate_label(label: &str) -> Result<&str, IotaNamesError> {
     const MIN_LABEL_LENGTH: usize = 1;
     const MAX_LABEL_LENGTH: usize = 63;
+
     let bytes = label.as_bytes();
     let len = bytes.len();
 
@@ -254,39 +255,16 @@ pub fn validate_label(label: &str) -> Result<&str, IotaNamesError> {
     }
 
     for (i, character) in bytes.iter().enumerate() {
-        let is_valid_character = match character {
-            b'a'..=b'z' => true,
-            b'0'..=b'9' => true,
-            b'-' if i != 0 && i != len - 1 => true,
-            _ => false,
-        };
-
-        if !is_valid_character {
-            match character {
-                b'-' => return Err(IotaNamesError::InvalidHyphens),
-                _ => return Err(IotaNamesError::InvalidUnderscore),
-            }
+        match character {
+            b'a'..=b'z' | b'0'..=b'9' => continue,
+            b'-' if i == 0 || i == len - 1 => return Err(IotaNamesError::HyphensAsFirstOrLastChar),
+            _ => return Err(IotaNamesError::InvalidLabelChar),
         };
     }
+
     Ok(label)
 }
 
-// fn parse_domain_label(label: &str) -> anyhow::Result<String> {
-//     anyhow::ensure!(
-//         label.len() >= MIN_LABEL_LEN && label.len() <= MAX_LABEL_LEN,
-//         "label length outside allowed range
-// [{MIN_LABEL_LEN}..{MAX_LABEL_LEN}]: {}",         label.len()
-//     );
-//     let regex =
-// regex::Regex::new("^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$").unwrap();
-
-//     anyhow::ensure!(
-//         regex.is_match(label),
-//         "invalid characters in domain: {label}"
-//     );
-//     Ok(label.to_owned())
-// }
-
 #[cfg(test)]
 mod tests {
     use super::*;

crates/iota-names/src/error.rs

@@ -6,20 +6,20 @@ use serde::{Deserialize, Serialize};
 
 #[derive(thiserror::Error, Debug, Serialize, Deserialize, Clone, Eq, PartialEq)]
 pub enum IotaNamesError {
-    #[error("Name Service: String length: {0} exceeds maximum allowed length: {1}")]
+    #[error("String length: {0} exceeds maximum allowed length: {1}")]
     ExceedsMaxLength(usize, usize),
-    #[error("Name Service: String length: {0} outside of valid range: [{1}, {2}]")]
+    #[error("String length: {0} outside of valid range: [{1}, {2}]")]
     InvalidLength(usize, usize, usize),
-    #[error("Name Service: Hyphens are not allowed as the first or last character")]
-    InvalidHyphens,
-    #[error("Name Service: Only lowercase letters, numbers, and hyphens are allowed")]
-    InvalidUnderscore,
-    #[error("Name Service: Domain must contain at least one label")]
+    #[error("Hyphens are not allowed as the first or last character")]
+    HyphensAsFirstOrLastChar,
+    #[error("Only lowercase letters, numbers, and hyphens are allowed as label characters")]
+    InvalidLabelChar,
+    #[error("Domain must contain at least one label")]
     LabelsEmpty,
-    #[error("Name Service: Domain must include only one separator")]
+    #[error("Domain must include only one separator")]
     InvalidSeparator,
-    #[error("Name Service: Name has expired")]
+    #[error("Name has expired")]
     NameExpired,
-    #[error("Name Service: Malformed object for {0}")]
+    #[error("Malformed object for {0}")]
     MalformedObject(ObjectID),
 }

crates/iota-names/src/lib.rs

@@ -17,10 +17,7 @@ use serde::{Deserialize, Serialize};
 
 use self::domain::Domain;
 
-pub const MIN_LABEL_LEN: usize = 3;
-pub const MAX_LABEL_LEN: usize = 63;
-
-/// An object to manage a second-level domain (SLD)
+/// An object to manage a second-level domain (SLD).
 #[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
 pub struct IotaNamesRegistration {
     id: ObjectID,
@@ -63,7 +60,9 @@ pub trait IotaNamesNft {
 
     fn expiration_timestamp_ms(&self) -> u64;
 
-    fn expiration_time(&self) -> SystemTime;
+    fn expiration_time(&self) -> SystemTime {
+        UNIX_EPOCH + Duration::from_millis(self.expiration_timestamp_ms())
+    }
 
     fn has_expired(&self) -> bool {
         self.expiration_time() <= SystemTime::now()
@@ -90,10 +89,6 @@ impl IotaNamesNft for IotaNamesRegistration {
         self.expiration_timestamp_ms
     }
 
-    fn expiration_time(&self) -> SystemTime {
-        UNIX_EPOCH + Duration::from_millis(self.expiration_timestamp_ms())
-    }
-
     fn image_url(&self) -> &str {
         &self.image_url
     }
@@ -119,10 +114,6 @@ impl IotaNamesNft for SubdomainRegistration {
         self.nft.expiration_timestamp_ms()
     }
 
-    fn expiration_time(&self) -> SystemTime {
-        self.nft.expiration_time()
-    }
-
     fn image_url(&self) -> &str {
         self.nft.image_url()
     }