chore: Add link to documentation when config fails (#119)

* chore: Add link to documentation when config fails

* docs: Improve instructions

* chore: Update link to docs

* chore: Cargo update

* docs: Fix links

* chore: Cargo update

Author: shahnami

CONTRIBUTING.md

@@ -388,7 +388,7 @@ Testing is the responsibility of all contributors as such all contributions must
 
 ## Documentation
 
-- See [User Documentation](https://docs.openzeppelin.com/monitor/0.1.0/).
+- See [User Documentation](https://docs.openzeppelin.com/monitor).
 
 ## Issue and Pull Request Labeling Guidelines
 

Cargo.lock

@@ -6,7 +6,7 @@
 
 In the rapidly evolving world of blockchain technology, effective monitoring is crucial for ensuring security and performance. OpenZeppelin Monitor is a blockchain monitoring service that watches for specific on-chain activities and triggers notifications based on configurable conditions. The service offers multi-chain support with configurable monitoring schedules, flexible trigger conditions, and an extensible architecture for adding new chains.
 
-[Install](https://docs.openzeppelin.com/monitor/0.1.0/#getting_started) | [User Docs](https://docs.openzeppelin.com/monitor/0.1.0/) | [Quickstart](https://docs.openzeppelin.com/monitor/0.1.0/quickstart) | [Crate Docs](https://docs.openzeppelin.com/monitor/0.1.0/rust_docs/doc/openzeppelin_monitor/)
+[Install](https://docs.openzeppelin.com/monitor#getting_started) | [User Docs](https://docs.openzeppelin.com/monitor) | [Quickstart](https://docs.openzeppelin.com/monitor/quickstart) | [Crate Docs](https://docs.openzeppelin.com/monitor/rust_docs/doc/openzeppelin_monitor/)
 
 ## Features
 
@@ -33,11 +33,11 @@ In the rapidly evolving world of blockchain technology, effective monitoring is
 
 ### Installation
 
-View the [Installation](https://docs.openzeppelin.com/monitor/0.1.0/#getting_started) documentation for detailed information. For a quicker introduction, check out the [Quickstart](https://docs.openzeppelin.com/monitor/0.1.0/quickstart) guide.
+View the [Installation](https://docs.openzeppelin.com/monitor#getting_started) documentation for detailed information. For a quicker introduction, check out the [Quickstart](https://docs.openzeppelin.com/monitor/quickstart) guide.
 
 ### Usage
 
-View the [Usage](https://docs.openzeppelin.com/monitor/0.1.0/#running_the_monitor) documentation for more information.
+View the [Usage](https://docs.openzeppelin.com/monitor#running_the_monitor) documentation for more information.
 
 ## For Developers
 
@@ -237,7 +237,7 @@ For security concerns, please refer to our [Security Policy](SECURITY.md).
 
 ## Get Help
 
-If you have any questions, first see if the answer to your question can be found in the [User Documentation](https://docs.openzeppelin.com/monitor/0.1.0/).
+If you have any questions, first see if the answer to your question can be found in the [User Documentation](https://docs.openzeppelin.com/monitor).
 
 If the answer is not there:
 

README.md

@@ -149,7 +149,7 @@ For detailed information about each directory and its contents, see xref:structu
 
 == Installation
 
-=== Option 1: Install Locally
+=== Run Locally
 . Clone the repository:
 +
 [source,bash]
@@ -162,21 +162,30 @@ cd openzeppelin-monitor
 +
 [source,bash]
 ----
-cargo build
+cargo build --release
+----
+
+. Move the binary to the project root (so that it can access the `./config` folder)
++
+[source,bash]
+----
+mv ./target/release/openzeppelin-monitor .
 ----
 
-==== Run the CLI:
 . View available options:
 +
 [source,bash]
 ----
 ./openzeppelin-monitor --help
+
+# Enable logging to file
+./openzeppelin-monitor --log-file
+
+# Enable metrics server
+./openzeppelin-monitor --metrics
 ----
-+
-. Use `--log-file` to enable file-based logging.
-. Use `--metrics` to enable the metrics server.
 
-=== Option 2: Run with Docker
+=== Run with Docker
 
 ==== Basic Setup
 

docs/modules/ROOT/pages/index.adoc

@@ -38,7 +38,7 @@ For details on the supported values see xref:index.adoc#basic_configuration[User
 
 == Installation
 
-=== Local Installation
+=== Run Locally
 
 . Clone the repository:
 +
@@ -52,22 +52,30 @@ cd openzeppelin-monitor
 +
 [source,bash]
 ----
-cargo build
+cargo build --release
 ----
 
-=== Standalone CLI Usage
+. Move the binary to the project root (so that it can access the `./config` folder)
++
+[source,bash]
+----
+mv ./target/release/openzeppelin-monitor .
+----
 
 . View available options:
 +
 [source,bash]
 ----
 ./openzeppelin-monitor --help
-----
 
-. Enable logging to file with `--log-file`
-. Enable metrics server with `--metrics`
+# Enable logging to file
+./openzeppelin-monitor --log-file
+
+# Enable metrics server
+./openzeppelin-monitor --metrics
+----
 
-=== Docker Installation
+=== Run with Docker
 
 ==== Basic Setup
 

docs/modules/ROOT/pages/quickstart.adoc

@@ -104,23 +104,23 @@ The retry policy can be customized using the `ExponentialBackoff` builder in the
 
 [source,rust]
 ----
-		let retry_policy = ExponentialBackoff::builder()
-			.base(2)
-			.retry_bounds(Duration::from_millis(100), Duration::from_secs(4))
-			.jitter(Jitter::None)
-			.build_with_max_retries(2);
+let retry_policy = ExponentialBackoff::builder()
+  .base(2)
+  .retry_bounds(Duration::from_millis(100), Duration::from_secs(4))
+  .jitter(Jitter::None)
+  .build_with_max_retries(2);
 ----
 
 The retry policy can be customized with the following options:
 
 [source,rust]
 ----
 pub struct ExponentialBackoff {
-    pub max_n_retries: Option<u32>,     // Maximum number of allowed retries attempts.
-    pub min_retry_interval: Duration,   // Minimum waiting time between two retry attempts (it can end up being lower when using full jitter).
-    pub max_retry_interval: Duration,   // Maximum waiting time between two retry attempts.
-    pub jitter: Jitter,                 // How we apply jitter to the calculated backoff intervals.
-    pub base: u32,                      // Base of the exponential.
+  pub max_n_retries: Option<u32>,     // Maximum number of allowed retries attempts.
+  pub min_retry_interval: Duration,   // Minimum waiting time between two retry attempts (it can end up being lower when using full jitter).
+  pub max_retry_interval: Duration,   // Maximum waiting time between two retry attempts.
+  pub jitter: Jitter,                 // How we apply jitter to the calculated backoff intervals.
+  pub base: u32,                      // Base of the exponential.
 }
 ----
 
@@ -148,8 +148,8 @@ pub struct StellarTransportClient {
 [source,rust]
 ----
 let client = ClientBuilder::new(reqwest::Client::new())
-    .with(RetryTransientMiddleware::new_with_policy(retry_policy))
-    .build();
+  .with(RetryTransientMiddleware::new_with_policy(retry_policy))
+  .build();
 ----
 
 === Implementation Details

docs/modules/ROOT/pages/rpc.adoc

@@ -15,15 +15,15 @@ Custom filter scripts allow you to apply additional conditions to matches detect
 === Implementation Guide
 
 1. Create a script in one of the supported languages:
-   * Bash
-   * Python
-   * JavaScript
+  * Bash
+  * Python
+  * JavaScript
 
 2. Your script will receive a JSON object with the following structure:
-
+  * EVM
++
 [source,json]
 ----
-// Example for EVM MATCH
 {
   "args": ["--verbose"],
   "monitor_match": {
@@ -140,8 +140,12 @@ Custom filter scripts allow you to apply additional conditions to matches detect
     }
   }
 }
+----
 
-// Example for STELLAR MATCH
+  * Stellar
++
+[source,json]
+----
 {
   "args": ["--verbose"],
   "monitor_match": {

docs/modules/ROOT/pages/scripts.adoc

@@ -29,19 +29,21 @@ use crate::{
 		create_block_handler, create_trigger_handler, has_active_monitors, initialize_services,
 		Result,
 	},
-	models::Network,
+	models::{BlockChainType, Network},
 	repositories::{MonitorRepository, NetworkRepository, TriggerRepository},
 	services::{
 		blockchain::{ClientPool, ClientPoolTrait},
 		blockwatcher::{BlockTracker, BlockTrackerTrait, BlockWatcherService, FileBlockStorage},
+		trigger::TriggerExecutionServiceTrait,
+	},
+	utils::{
+		constants::DOCUMENTATION_URL, logging::setup_logging,
+		metrics::server::create_metrics_server,
 	},
-	utils::{logging::setup_logging, metrics::server::create_metrics_server},
 };
 
 use clap::{Arg, Command};
 use dotenvy::dotenv;
-use models::BlockChainType;
-use services::trigger::TriggerExecutionServiceTrait;
 use std::env::{set_var, var};
 use std::sync::Arc;
 use tokio::sync::watch;
@@ -142,7 +144,8 @@ async fn main() -> Result<()> {
 		MonitorRepository<NetworkRepository, TriggerRepository>,
 		NetworkRepository,
 		TriggerRepository,
-	>(None, None, None)?;
+	>(None, None, None)
+	.map_err(|e| anyhow::anyhow!("Failed to initialize services: {}. Please refer to the documentation quickstart ({}) on how to configure the service.", e, DOCUMENTATION_URL))?;
 
 	// Check if metrics should be enabled from either CLI flag or env var
 	let metrics_enabled =

src/main.rs

@@ -0,0 +1 @@
+pub const DOCUMENTATION_URL: &str = "https://docs.openzeppelin.com/monitor";

src/utils/constants.rs

@@ -3,20 +3,22 @@
 //! This module provides various utility functions and types that are used across
 //! the application. Currently includes:
 //!
+//! - constants: Constants for the application
 //! - cron_utils: Utilities for working with cron schedules and time intervals
-//! - error: Custom error type for more structured error handling
 //! - expression: Utilities for working with cron expressions
 //! - logging: Logging utilities
+//! - metrics: Metrics utilities
 //! - script: Utilities for working with scripts
 
 mod cron_utils;
 mod expression;
+mod script;
+
+pub mod constants;
 pub mod logging;
 pub mod metrics;
-mod script;
 
+pub use constants::*;
 pub use cron_utils::*;
 pub use expression::*;
-pub use logging::*;
-pub use metrics::*;
 pub use script::*;