Linting. Project restructure.

Author: KyrylR

Cargo.toml

@@ -1,7 +1,6 @@
 [workspace]
 resolver = "3"
 members = [
-    "nostr_options_cli",
     "crates/*"
 ]
 
@@ -18,11 +17,10 @@ anyhow = { version = "1.0.100" }
 clap = { version = "4.5.49", features = ["derive"] }
 dirs = {version = "6.0.0"}
 futures-util = { version = "0.3.31" }
-global_utils = { path = "./crates/global_utils" }
+global-utils = { path = "crates/global-utils" }
 nostr = { version = "0.43.1", features = ["std"] }
 nostr-sdk = { version = "0.43.0" }
-nostr_relay_connector = { path = "./crates/nostr_relay_connector"}
-nostr_relay_processor = { path = "./crates/nostr_relay_processor"}
+dex-nostr-relay = { path = "./crates/dex-nostr-relay"}
 serde = { version = "1.0.228", features = ["derive"] }
 serde_json = { version = "1.0.145" }
 thiserror = { version = "2.0.17" }

README.md

@@ -22,16 +22,16 @@ The core of our DEX is the **PACT (PACT for Auditable Contract Transactions)** p
 
 A PACT offer is implemented as a standard NOSTR event with kind `30078` (non-standard, ephemeral event kind for DEX offers). The event structure maps to PACT requirements as follows:
 
-| NOSTR Field | PACT Field | Data Type | Required | Description |
-|-------------|------------|-----------|----------|-------------|
-| `id` | Event ID | string (64-char hex) | Yes | SHA-256 hash of canonical serialized event data (excluding `sig`). Serves as unique, content-addressed identifier |
-| `pubkey` | Maker Key | string (64-char hex) | Yes | 32-byte x-only Schnorr public key of market maker. Must be registered in on-chain Maker Identity Registry |
-| `created_at` | Timestamp | integer | Yes | Unix timestamp (seconds) when offer was created |
-| `description` | Description | string | No | Human-readable description of instrument and complex terms |
-| `kind` | Event Type | integer | Yes | Event type identifier. Value `1` reserved for standard offers. Enables future protocol extensions |
-| `tags` | Metadata | array of arrays | Yes | Structured machine-readable metadata for filtering and discovery |
-| `content` | Contract Code | string | Yes | Stringified JSON containing full Simplicity contract code |
-| `sig` | Signature | string (128-char hex) | Yes | 64-byte Schnorr signature proving authenticity and integrity |
+| NOSTR Field   | PACT Field    | Data Type             | Required | Description                                                                                                       |
+|---------------|---------------|-----------------------|----------|-------------------------------------------------------------------------------------------------------------------|
+| `id`          | Event ID      | string (64-char hex)  | Yes      | SHA-256 hash of canonical serialized event data (excluding `sig`). Serves as unique, content-addressed identifier |
+| `pubkey`      | Maker Key     | string (64-char hex)  | Yes      | 32-byte x-only Schnorr public key of market maker. Must be registered in on-chain Maker Identity Registry         |
+| `created_at`  | Timestamp     | integer               | Yes      | Unix timestamp (seconds) when offer was created                                                                   |
+| `description` | Description   | string                | No       | Human-readable description of instrument and complex terms                                                        |
+| `kind`        | Event Type    | integer               | Yes      | Event type identifier. Value `1` reserved for standard offers. Enables future protocol extensions                 |
+| `tags`        | Metadata      | array of arrays       | Yes      | Structured machine-readable metadata for filtering and discovery                                                  |
+| `content`     | Contract Code | string                | Yes      | Stringified JSON containing full Simplicity contract code                                                         |
+| `sig`         | Signature     | string (128-char hex) | Yes      | 64-byte Schnorr signature proving authenticity and integrity                                                      |
 
 ### Tag Examples
 

nostr_options_cli/Cargo.toml crates/dex-cli/Cargo.tomlnostr_options_cli/Cargo.toml renamed to crates/dex-cli/Cargo.toml

@@ -6,14 +6,13 @@ edition = "2024"
 [dependencies]
 anyhow = { workspace = true }
 nostr = { workspace = true }
-global_utils = { workspace = true }
+global-utils = { workspace = true }
 futures-util = { workspace = true }
 serde_json = { workspace = true }
 tokio = { workspace = true }
 clap = { workspace = true }
 dirs = { workspace = true }
 tracing = { workspace = true }
 thiserror = { workspace = true }
-nostr_relay_connector = { workspace = true }
-nostr_relay_processor = { workspace = true }
+dex-nostr-relay = { workspace = true }
 

nostr_options_cli/src/cli.rs crates/dex-cli/src/cli.rsnostr_options_cli/src/cli.rs renamed to crates/dex-cli/src/cli.rs

@@ -4,8 +4,9 @@ use crate::utils::{
 };
 use clap::{Parser, Subcommand};
 use nostr::{EventId, PublicKey};
-use nostr_relay_connector::relay_client::ClientConfig;
-use nostr_relay_processor::relay_processor::{OrderPlaceEventTags, OrderReplyEventTags, RelayProcessor};
+
+use dex_nostr_relay::relay_client::ClientConfig;
+use dex_nostr_relay::relay_processor::{OrderPlaceEventTags, OrderReplyEventTags, RelayProcessor};
 use std::path::PathBuf;
 use std::time::Duration;
 use tracing::instrument;

crates/dex-cli/src/error.rs

@@ -0,0 +1,14 @@
+use crate::utils::FileError;
+use dex_nostr_relay::error::NostrRelayError;
+
+pub type Result<T> = core::result::Result<T, CliError>;
+
+#[derive(thiserror::Error, Debug)]
+pub enum CliError {
+    #[error("Occurred error with io, err: {0}")]
+    Io(#[from] std::io::Error),
+    #[error(transparent)]
+    File(#[from] FileError),
+    #[error(transparent)]
+    NostrRelay(#[from] NostrRelayError),
+}

nostr_options_cli/src/lib.rs crates/dex-cli/src/lib.rsnostr_options_cli/src/lib.rs renamed to crates/dex-cli/src/lib.rs

@@ -1,6 +1,9 @@
 use clap::Parser;
+
 use global_utils::logger::init_logger;
+
 use simplicity_dex::cli::Cli;
+
 use tracing::instrument;
 
 #[tokio::main]

nostr_options_cli/src/main.rs crates/dex-cli/src/main.rsnostr_options_cli/src/main.rs renamed to crates/dex-cli/src/main.rs

@@ -16,13 +16,13 @@ pub fn write_into_stdout<T: AsRef<str> + std::fmt::Debug>(text: T) -> std::io::R
 
 pub fn default_key_path() -> PathBuf {
     dirs::home_dir()
-        .unwrap_or_else(|| PathBuf::from("."))
+        .unwrap_or_else(|| PathBuf::from("../../.."))
         .join(DEFAULT_KEY_PATH)
 }
 
 pub fn default_relays_path() -> PathBuf {
     dirs::home_dir()
-        .unwrap_or_else(|| PathBuf::from("."))
+        .unwrap_or_else(|| PathBuf::from("../../.."))
         .join(DEFAULT_RELAYS_FILEPATH)
 }
 #[derive(Debug, thiserror::Error)]

nostr_options_cli/src/utils.rs crates/dex-cli/src/utils.rsnostr_options_cli/src/utils.rs renamed to crates/dex-cli/src/utils.rs

@@ -1,5 +1,5 @@
 [package]
-name = "nostr_relay_processor"
+name = "dex-nostr-relay"
 version.workspace = true
 edition.workspace = true
 rust-version.workspace = true
@@ -9,9 +9,8 @@ readme.workspace = true
 [dependencies]
 anyhow = { workspace = true }
 tokio = { workspace = true }
-global_utils = { workspace = true }
+global-utils = { workspace = true }
 nostr-sdk = { workspace = true }
 nostr = { workspace = true }
-nostr_relay_connector = { workspace = true }
 tracing = { workspace = true }
 thiserror = { workspace = true }

crates/nostr_relay_processor/Cargo.toml crates/dex-nostr-relay/Cargo.tomlcrates/nostr_relay_processor/Cargo.toml renamed to crates/dex-nostr-relay/Cargo.toml

@@ -0,0 +1,18 @@
+use nostr::SignerError;
+use nostr::filter::SingleLetterTagError;
+
+#[derive(thiserror::Error, Debug)]
+pub enum NostrRelayError {
+    #[error("Signer error: {0}")]
+    Signer(#[from] SignerError),
+    #[error("Single letter error: {0}")]
+    SingleLetterTag(#[from] SingleLetterTagError),
+    #[error("Failed to convert custom url to RelayURL, err: {err_msg}")]
+    FailedToConvertRelayUrl { err_msg: String },
+    #[error("An error occurred in Nostr Client, err: {0}")]
+    NostrClientFailure(#[from] nostr_sdk::client::Error),
+    #[error("Relay Client requires for operation signature, add key to the Client")]
+    MissingSigner,
+}
+
+pub type Result<T> = std::result::Result<T, NostrRelayError>;