chore: Adding Optimism network samples (#132)

* Adding Optimist network samples

* Carlo update

* Fixes to the examples

* Fixes to the examples

* Moved network examples

* Cargo update

* Cargo update

* chore: Move examples to isolated folder

* fix: Link to examples folder

* docs: Add examples to docs project structure

* Carmo update

* chore: Cargo update

* docs: Adds documentation on script

* chore: Cargo update

---------

Co-authored-by: shahnami <[email protected]>

Author: d-carmo

.gitignore

@@ -22,7 +22,7 @@ data/**/*.json
 
 # Ignore actual config files but not examples
 config/**/*.json
-!config/**/*.json.example
+!examples/config/**/*.json
 
 # Ignore .env files
 .env

Cargo.lock

@@ -142,6 +142,7 @@ openzeppelin-monitor/
 ├── docs/               # Documentation
 ├── scripts/            # Utility scripts
 ├── cmd/                # Metrics and monitoring
+├── examples/           # Example configuration files
 └── ... other root files (Cargo.toml, README.md, etc.)
 ```
 

README.md

@@ -135,6 +135,7 @@ openzeppelin-monitor/
 ├── docs/               # Documentation
 ├── scripts/            # Utility scripts
 ├── cmd/                # Metrics and monitoring
+├── examples/           # Example configuration files
 └── ... other root files (Cargo.toml, README.md, etc.)
 ```
 
@@ -357,25 +358,25 @@ This table lists the environment variables and their default values.
 | Port to use for metrics server.
 |===
 
-* Copy and configure example files:
+* Copy and configure some example files:
 
 [source,bash]
 ----
 # EVM Configuration
-cp config/monitors/evm_transfer_usdc.json.example config/monitors/evm_transfer_usdc.json
-cp config/networks/ethereum_mainnet.json.example config/networks/ethereum_mainnet.json
+cp examples/config/monitors/evm_transfer_usdc.json config/monitors/evm_transfer_usdc.json
+cp examples/config/networks/ethereum_mainnet.json config/networks/ethereum_mainnet.json
 
 # Stellar Configuration
-cp config/monitors/stellar_transfer_usdc.json.example config/monitors/stellar_transfer_usdc.json
-cp config/networks/stellar_mainnet.json.example config/networks/stellar_mainnet.json
+cp examples/config/monitors/stellar_swap_dex.json config/monitors/stellar_swap_dex.json
+cp examples/config/networks/stellar_mainnet.json config/networks/stellar_mainnet.json
 
 # Notification Configuration
-cp config/triggers/email_notifications.json.example config/triggers/email_notifications.json
-cp config/triggers/slack_notifications.json.example config/triggers/slack_notifications.json
-cp config/triggers/discord_notifications.json.example config/triggers/discord_notifications.json
-cp config/triggers/telegram_notifications.json.example config/triggers/telegram_notifications.json
-cp config/triggers/webhook_notifications.json.example config/triggers/webhook_notifications.json
-cp config/triggers/script_notifications.json.example config/triggers/script_notifications.json
+cp examples/config/triggers/slack_notifications.json config/triggers/slack_notifications.json
+cp examples/config/triggers/email_notifications.json config/triggers/email_notifications.json
+
+# Filter Configuration
+cp examples/config/filters/evm_filter_block_number.sh config/filters/evm_filter_block_number.sh
+cp examples/config/filters/stellar_filter_block_number.sh config/filters/stellar_filter_block_number.sh
 ----
 
 == Data Storage Configuration
@@ -1111,6 +1112,25 @@ For more information about custom scripts, see xref:scripts.adoc[Custom Scripts
 
 === Testing your configuration
 
+==== Network Configuration
+The `validate_network_config.sh` script helps ensure your network configuration is properly set up and operational. The script:
+
+* Tests the health of all configured RPC endpoints
+* Validates connectivity using network-specific methods
+* Provides clear visual feedback for each endpoint
+
+[source,bash]
+----
+# Test default networks directory (/config/networks/)
+./scripts/validate_network_config.sh
+
+# Test a specific configuration directory
+./scripts/validate_network_config.sh -f /path/to/configs
+----
+
+TIP: Run this script when setting up new networks, before deploying configuration changes, or when troubleshooting connectivity issues.
+
+==== Monitor Configuration
 The monitor can be tested in two modes:
 
 ==== 1. Latest Block Mode

config/filters/.keep

@@ -150,10 +150,10 @@ Create the Ethereum mainnet network configuration:
 
 [source,bash]
 ----
-cp config/networks/ethereum_mainnet.json.example config/networks/ethereum_mainnet.json
+cp examples/config/networks/ethereum_mainnet.json config/networks/ethereum_mainnet.json
 ----
 
-The link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/networks/ethereum_mainnet.json.example[default configuration^] should work, but you may want to update the RPC URL to your preferred provider.
+The link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/networks/ethereum_mainnet.json[default configuration^] should work, but you may want to update the RPC URL to your preferred provider.
 
 [source,json]
 ----
@@ -183,10 +183,11 @@ Create the USDC transfer monitor configuration:
 
 [source,bash]
 ----
-cp config/monitors/evm_transfer_usdc.json.example config/monitors/evm_transfer_usdc.json
+cp examples/config/monitors/evm_transfer_usdc.json config/monitors/evm_transfer_usdc.json
+cp examples/config/filters/evm_filter_block_number.sh config/filters/evm_filter_block_number.sh
 ----
 
-This link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/monitors/evm_transfer_usdc.json.example[configuration^] monitors USDC transfers over 10,000 USDC. You can customize the notification channels by modifying the `triggers` array.
+This link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/monitors/evm_transfer_usdc.json[configuration^] monitors USDC transfers over 10,000 USDC. You can customize the notification channels by modifying the `triggers` array.
 
 [source,json]
 ----
@@ -264,10 +265,10 @@ Remove the `trigger_conditions` array to disable additional filtering.
 
 [source,bash]
 ----
-cp config/triggers/slack_notifications.json.example config/triggers/slack_notifications.json
+cp examples/config/triggers/slack_notifications.json config/triggers/slack_notifications.json
 ----
 
-Update the webhook URL in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/triggers/slack_notifications.json.example[configuration^].
+Update the webhook URL in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/triggers/slack_notifications.json[configuration^].
 
 [source,json]
 ----
@@ -290,10 +291,10 @@ Update the webhook URL in the link:https://github.com/OpenZeppelin/openzeppelin-
 
 [source,bash]
 ----
-cp config/triggers/email_notifications.json.example config/triggers/email_notifications.json
+cp examples/config/triggers/email_notifications.json config/triggers/email_notifications.json
 ----
 
-Update the SMTP settings in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/triggers/email_notifications.json.example[configuration^].
+Update the SMTP settings in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/triggers/email_notifications.json[configuration^].
 
 [source,json]
 ----
@@ -347,7 +348,7 @@ The monitor will now:
 * Adjust the transfer threshold by modifying the `expression` value.
 * Monitor additional ERC20 tokens by creating new monitor configurations.
 * xref:index.adoc#testing_your_configuration[Test the Monitor] configuration against a block number
-* Explore other examples in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/tree/main/config/monitors[`config/monitors` directory].
+* Explore other examples in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/tree/main/examples/config/monitors[`examples/config/monitors` directory].
 
 === Monitoring Dex Swaps (Stellar):
 
@@ -357,10 +358,10 @@ Create the Stellar mainnet network configuration:
 
 [source,bash]
 ----
-cp config/networks/stellar_mainnet.json.example config/networks/stellar_mainnet.json
+cp examples/config/networks/examples/stellar_mainnet.json config/networks/stellar_mainnet.json
 ----
 
-The link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/networks/stellar_mainnet.json.example[default configuration^] should work, but you may want to update the RPC URL to your preferred provider.
+The link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/networks/stellar_mainnet.json[default configuration^] should work, but you may want to update the RPC URL to your preferred provider.
 
 [source,json]
 ----
@@ -390,10 +391,11 @@ Create the large swap monitor configuration:
 
 [source,bash]
 ----
-cp config/monitors/stellar_swap_dex.json.example config/monitors/stellar_swap_dex.json
+cp examples/config/monitors/stellar_swap_dex.json config/monitors/stellar_swap_dex.json
+cp examples/config/filters/stellar_filter_block_number.sh config/filters/stellar_filter_block_number.sh
 ----
 
-This link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/monitors/stellar_swap_dex.json.example[configuration^] monitors large swaps of over 1,000,000,000 tokens. You can customize the notification channels by modifying the `triggers` array.
+This link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/monitors/stellar_swap_dex.json[configuration^] monitors large swaps of over 1,000,000,000 tokens. You can customize the notification channels by modifying the `triggers` array.
 
 [source,json]
 ----
@@ -448,10 +450,10 @@ Remove the `trigger_conditions` array to disable additional filtering.
 
 [source,bash]
 ----
-cp config/triggers/slack_notifications.json.example config/triggers/slack_notifications.json
+cp examples/config/triggers/slack_notifications.json config/triggers/slack_notifications.json
 ----
 
-Update the webhook URL in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/config/triggers/slack_notifications.json.example[configuration^].
+Update the webhook URL in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/blob/main/examples/config/triggers/slack_notifications.json[configuration^].
 
 [source,json]
 ----
@@ -497,4 +499,4 @@ The monitor will now:
 * Adjust the swap threshold by modifying the `expression` value.
 * Monitor additional dex swaps by creating new monitor configurations.
 * xref:index.adoc#testing_your_configuration[Test the Monitor] configuration against a block number
-* Explore other examples in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/tree/main/config/monitors[`config/monitors` directory].
+* Explore other examples in the link:https://github.com/OpenZeppelin/openzeppelin-monitor/tree/main/examples/config/monitors[`examples/config/monitors` directory].