Remove mentions of nostr-mls (marmot-protocol#177)

Author: erskingardner

crates/mdk-core/src/constant.rs

@@ -1,4 +1,4 @@
-//! Nostr MLS constants
+//! MDK constants
 
 use openmls::extensions::ExtensionType;
 use openmls_traits::types::Ciphersuite;

crates/mdk-core/src/error.rs

@@ -23,7 +23,7 @@ use openmls::key_packages::errors::{KeyPackageNewError, KeyPackageVerifyError};
 use openmls::prelude::{MlsGroupStateError, ValidationError};
 use openmls_traits::types::CryptoError;
 
-/// Nostr MLS error
+/// MDK error
 #[derive(Debug, PartialEq, thiserror::Error)]
 pub enum Error {
     /// Hex error

crates/mdk-core/src/groups.rs

@@ -1,4 +1,4 @@
-//! Nostr MLS Group Management
+//! MDK groups
 //!
 //! This module provides functionality for managing MLS groups in Nostr:
 //! - Group creation and configuration
@@ -7,7 +7,7 @@
 //! - Group metadata handling
 //! - Group secret management
 //!
-//! Groups in Nostr MLS have both an MLS group ID and a Nostr group ID. The MLS group ID
+//! Groups in MDK have both an MLS group ID and a Nostr group ID. The MLS group ID
 //! is used internally by the MLS protocol, while the Nostr group ID is used for
 //! relay-based message routing and group discovery.
 
@@ -380,7 +380,7 @@ where
         }
     }
 
-    /// Retrieves a Nostr MLS group by its MLS group ID
+    /// Retrieves a MDK group by its MLS group ID
     ///
     /// # Arguments
     ///
@@ -397,7 +397,7 @@ where
             .map_err(|e| Error::Group(e.to_string()))
     }
 
-    /// Retrieves all Nostr MLS groups from storage
+    /// Retrieves all MDK groups from storage
     ///
     /// # Returns
     ///

crates/mdk-core/src/key_packages.rs

@@ -1,4 +1,4 @@
-//! Nostr MLS Key Packages
+//! MDK Key Packages
 
 use mdk_storage_traits::MdkStorageProvider;
 use mdk_storage_traits::mls_codec::JsonCodec;

crates/mdk-core/src/lib.rs

@@ -259,9 +259,9 @@ where
     }
 }
 
-/// The main struct for the Nostr MLS implementation.
+/// The main struct for the MDK implementation.
 ///
-/// This struct provides the core functionality for MLS operations in Nostr:
+/// This struct provides the core functionality for MLS operations in the Marmot protocol:
 /// - Group management (creation, updates, member management)
 /// - Message handling (encryption, decryption, processing)
 /// - Key management (key packages, welcome messages)
@@ -380,7 +380,7 @@ where
         .with_grease(&self.provider.crypto)
     }
 
-    /// Get nostr mls group's required capabilities extension
+    /// Get the group's required capabilities extension
     #[inline]
     pub(crate) fn required_capabilities_extension(&self) -> Extension {
         Extension::RequiredCapabilities(RequiredCapabilitiesExtension::new(
@@ -406,7 +406,7 @@ where
     }
 }
 
-/// Tests module for nostr-mls
+/// Tests module for mdk-core
 #[cfg(test)]
 pub mod tests {
     use mdk_memory_storage::MdkMemoryStorage;

crates/mdk-core/src/messages/mod.rs

@@ -1,4 +1,4 @@
-//! Nostr MLS Messages
+//! MDK messages
 //!
 //! This module provides functionality for creating, processing, and managing encrypted
 //! messages in MLS groups. It handles:
@@ -7,7 +7,7 @@
 //! - Message state tracking
 //! - Integration with Nostr events
 //!
-//! Messages in Nostr MLS are wrapped in Nostr events (kind:445) for relay transmission.
+//! Messages in MDK are wrapped in Nostr events (kind:445) for relay transmission.
 //! The message content is encrypted using both MLS group keys and NIP-44 encryption.
 //! Message state is tracked to handle processing status and failure scenarios.
 

crates/mdk-core/src/prelude.rs

@@ -17,7 +17,7 @@
 // === Core MDK Types ===
 /// MDK error type
 pub use crate::Error;
-/// The main MDK struct for Nostr MLS operations
+/// The main MDK struct for Marmot protocol operations
 pub use crate::MDK;
 /// MDK provider for OpenMLS integration
 pub use crate::MdkProvider;

crates/mdk-core/src/test_util.rs

@@ -1,4 +1,4 @@
-//! Test utilities for the nostr-mls crate
+//! Test utilities for the mdk-core crate
 //!
 //! This module provides shared test utilities used across multiple test modules
 //! to avoid code duplication and ensure consistency in test setup.

crates/mdk-core/src/welcomes.rs

@@ -1,4 +1,4 @@
-//! Nostr MLS Welcomes
+//! MDK welcomes
 
 use nostr::{EventId, Kind, Tag, TagKind, Timestamp, UnsignedEvent};
 use openmls::prelude::*;

crates/mdk-memory-storage/Cargo.toml

@@ -2,7 +2,7 @@
 name = "mdk-memory-storage"
 version = "0.5.1"
 edition = "2024"
-description = "In-memory database for nostr-mls that implements the MdkStorageProvider Trait"
+description = "In-memory database for MDK that implements the MdkStorageProvider trait"
 authors = ["Jeff Gardner <j@jeffg.me>", "Yuki Kishimoto <yukikishimoto@protonmail.com>", "MDK Developers"]
 homepage.workspace = true
 repository.workspace = true