Add nostr-mls crate

Pull-Request: #843
Reviewed-by: Yuki Kishimoto <[email protected]>
Signed-off-by: Yuki Kishimoto <[email protected]>

Author: erskingardner

CHANGELOG.md

@@ -33,6 +33,7 @@
 * mls-storage: add new crate with traits and types for mls storage implementations ([JeffG] at https://github.com/rust-nostr/nostr/pull/836)
 * mls-memory-storage: add an in-memory implementation for MLS ([JeffG] at https://github.com/rust-nostr/nostr/pull/839)
 * mls-sqlite-storage: a sqlite implementation for MLS ([JeffG] at https://github.com/rust-nostr/nostr/pull/842)
+* mls: add new crate for implementing MLS messaging ([JeffG] at https://github.com/rust-nostr/nostr/pull/843)
 
 ## v0.41.0 - 2025/04/15
 

Cargo.lock

@@ -28,6 +28,7 @@ nostr-lmdb = { version = "0.41", path = "./crates/nostr-lmdb", default-features
 nostr-mls-memory-storage = { version = "0.41", path = "./crates/nostr-mls-memory-storage", default-features = false }
 nostr-mls-sqlite-storage = { version = "0.41", path = "./crates/nostr-mls-sqlite-storage", default-features = false }
 nostr-mls-storage = { version = "0.41", path = "./crates/nostr-mls-storage", default-features = false }
+nostr-mls = { version = "0.41", path = "./crates/nostr-mls", default-features = false }
 nostr-ndb = { version = "0.41", path = "./crates/nostr-ndb", default-features = false }
 nostr-relay-builder = { version = "0.41", path = "./crates/nostr-relay-builder", default-features = false }
 nostr-relay-pool = { version = "0.41", path = "./crates/nostr-relay-pool", default-features = false }

Cargo.toml

@@ -12,6 +12,7 @@ The project is split up into several crates in the `crates/` directory:
         * [**nostr-lmdb**](./crates/nostr-lmdb): LMDB storage backend
         * [**nostr-ndb**](./crates/nostr-ndb): [nostrdb](https://github.com/damus-io/nostrdb) storage backend
         * [**nostr-indexeddb**](./crates/nostr-indexeddb): IndexedDB storage backend
+    * [**nostr-mls**](./crates/nostr-mls): A library for implmenting NIP-EE MLS messaging
     * [**nostr-mls-storage**](./crates/nostr-mls-storage): Storage traits for using MLS messaging
         * [**nostr-mls-memory-storage**](./crates/nostr-mls-memory-storage): In-memory storage for nostr-mls
         * [**nostr-mls-sqlite-storage**](./crates/nostr-mls-sqlite-storage): Sqlite storage for nostr-mls

README.md

@@ -44,6 +44,7 @@ buildargs=(
     "-p nostr-mls-storage"
     "-p nostr-mls-memory-storage"
     "-p nostr-mls-sqlite-storage"
+    "-p nostr-mls"
     "-p nostr-indexeddb --target wasm32-unknown-unknown"
     "-p nostr-ndb"
     "-p nostr-keyring"
@@ -64,6 +65,7 @@ skip_msrv=(
     "-p nostr-mls-storage"                # MSRV: 1.74.0
     "-p nostr-mls-memory-storage"         # MSRV: 1.74.0
     "-p nostr-mls-sqlite-storage"         # MSRV: 1.74.0
+    "-p nostr-mls"                        # MSRV: 1.74.0
     "-p nostr-keyring"                    # MSRV: 1.75.0
     "-p nostr-keyring --features async"   # MSRV: 1.75.0
     "-p nostr-sdk --features tor"         # MSRV: 1.77.0

contrib/scripts/check-crates.sh

@@ -9,6 +9,7 @@ args=(
     "-p nostr-mls-storage"
     "-p nostr-mls-memory-storage"
     "-p nostr-mls-sqlite-storage"
+    "-p nostr-mls"
     "-p nostr-ndb"
     "-p nostr-indexeddb"
     "-p nostr-keyring"

contrib/scripts/release.sh

@@ -0,0 +1,41 @@
+[package]
+name = "nostr-mls"
+version = "0.41.0"
+edition = "2021"
+description = "A simplified interface to build secure messaging apps on nostr with MLS."
+authors = ["Jeff Gardner <[email protected]>", "Yuki Kishimoto <[email protected]>", "Rust Nostr Developers"]
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
+readme = "README.md"
+rust-version = "1.74.0"
+keywords = ["nostr", "mls", "openmls"]
+
+[features]
+default = []
+test-utils = []
+
+[dependencies]
+nostr = { workspace = true, features = ["std", "nip44"] }
+nostr-mls-storage.workspace = true
+openmls = { git = "https://github.com/openmls/openmls", rev = "4cc0f594b11262083ad9827b3b2033052c6ef99f", default-features = false }
+openmls_basic_credential = { git = "https://github.com/openmls/openmls", rev = "4cc0f594b11262083ad9827b3b2033052c6ef99f", default-features = false }
+openmls_rust_crypto = { git = "https://github.com/openmls/openmls", rev = "4cc0f594b11262083ad9827b3b2033052c6ef99f", default-features = false }
+openmls_traits = { git = "https://github.com/openmls/openmls", rev = "4cc0f594b11262083ad9827b3b2033052c6ef99f", default-features = false }
+tls_codec = "0.4"
+tracing = { workspace = true, features = ["std"] }
+
+[dev-dependencies]
+nostr-mls-memory-storage.workspace = true
+nostr-mls-sqlite-storage.workspace = true
+tempfile = "3.8"
+tokio = { workspace = true, features = ["macros", "rt", "rt-multi-thread"] }
+tracing-subscriber = { workspace = true, features = ["env-filter"] }
+
+[[example]]
+name = "mls_memory"
+path = "examples/mls_memory.rs"
+
+[[example]]
+name = "mls_sqlite"
+path = "examples/mls_sqlite.rs"

crates/nostr-mls/Cargo.toml

@@ -0,0 +1,18 @@
+# Nostr Messaging Layer Security (MLS)
+
+## Description
+
+A simplified interface to build secure messaging apps on nostr with MLS ([RFC 9420](https://datatracker.ietf.org/doc/html/rfc9420)),
+according to [NIP-EE](https://github.com/nostr-protocol/nips/pull/1427).
+
+## State
+
+**This library is in an ALPHA state**, things that are implemented generally work but the API will change in breaking ways.
+
+## Donations
+
+`rust-nostr` is free and open-source. This means we do not earn any revenue by selling it. Instead, we rely on your financial support. If you actively use any of the `rust-nostr` libs/software/services, then please [donate](https://rust-nostr.org/donate).
+
+## License
+
+This project is distributed under the MIT software license - see the [LICENSE](../../LICENSE) file for details