test: add repository property-based tests (#10)

* tests: add pbt for monitor repo and configs

* chore: move integration tests into own folder

* fix: config validation via load_all

* tests: run with multiple inputs

* tests: reduce input size

* feat: recommend past blocks configuration

* fix: integration test rpc url

* fix: multiple network service inits

* tests: add repository tests and fix typo

* tests: add invalid name tests and add linter

* fix: shutdown signal

* chore: update readme for githooks

* chore: formatting

* test: add cron validation

* fix: valid cron schedule for network strategy

Author: shahnami

.githooks/commit-msg

@@ -29,3 +29,6 @@ config/**/*.json
 
 # Ignore DS_Store files
 .DS_Store
+
+# Ignore proptest regressions
+tests/**/*.proptest-regressions

.githooks/pre-push

@@ -7,6 +7,7 @@ edition = "2021"
 async-trait = "0.1"
 base64 = "0.22"
 chrono = "0.4"
+cron = "0.15.0"
 dotenvy = "0.15.7"
 email_address = "0.2.9"
 env_logger = "0.11.5"
@@ -28,5 +29,6 @@ tokio-cron-scheduler = "0.13.0"
 web3 = "0.19.0"
 
 [dev-dependencies]
-tempfile = "3.2"
 mockall = "0.13.1"
+proptest = "1.6.0"
+tempfile = "3.2"

.gitignore

@@ -210,9 +210,18 @@ cargo run
 ### Run Tests
 
 ```bash
-cargo test -- --nocapture
+cargo test
+cargo test properties
+cargo test integration
 ```
 
+### Developer setup
+
+1. Run `chmod +x .githooks/*` to make the git hooks executable.
+2. Run `git config core.hooksPath .githooks` to setup git hooks for linting and formatting.
+3. Run `rustup toolchain install nightly` to install the nightly toolchain.
+4. Run `rustup component add rustfmt --toolchain nightly` to install rustfmt for the nightly toolchain.
+
 ## Project Structure
 
 - `src/`: Source code
@@ -227,8 +236,14 @@ cargo test -- --nocapture
 ## Caveats
 
 - This software is in alpha. Use in production environments at your own risk.
+- EVM monitors require an ABI to decode and trigger on contract events and functions.
 - Monitor performance depends on network congestion and RPC endpoint reliability.
-- Past block processing is limited by `max_past_blocks` in network configuration (default: 10).
+- The `max_past_blocks` configuration is critical to prevent missing blocks:
+  - Should be approximately calculated as: `(cron_interval_ms/block_time_ms) + confirmation_blocks + 1` (defaults to this value if not set)
+  - Example: For 1-minute cron on Ethereum (~12s blocks, 12 confirmation blocks):
+    - `(60000/12000) + 12 + 1 = 18 blocks`
+  - Setting this too low may result in missed blocks, especially on fast networks
+  - Consider network congestion and block time variability when configuring
 - For email notifications, the `port` field is optional and defaults to 465.
 - Template variable availability depends on the trigger source:
   - If triggered by an event, only event variables will be populated.

Cargo.lock

@@ -13,6 +13,6 @@
   "block_time_ms": 12000,
   "confirmation_blocks": 12,
   "cron_schedule": "0 */1 * * * *",
-  "max_past_blocks": 3,
+  "max_past_blocks": 18,
   "store_blocks": false
 }

Cargo.toml

@@ -13,6 +13,6 @@
   "block_time_ms": 5000,
   "confirmation_blocks": 2,
   "cron_schedule": "0 */1 * * * *",
-  "max_past_blocks": 3,
+  "max_past_blocks": 20,
   "store_blocks": true
 }

README.md

@@ -13,6 +13,6 @@
   "block_time_ms": 5000,
   "confirmation_blocks": 2,
   "cron_schedule": "0 */1 * * * *",
-  "max_past_blocks": 50,
+  "max_past_blocks": 20,
   "store_blocks": true
 }

config/networks/ethereum_mainnet.json.example

@@ -10,7 +10,7 @@
             "subject": "large_transfer_usdc_email triggered",
             "body": "Large transfer of ${event_0_value} USDC from ${event_0_from} to ${event_0_to} | https://etherscan.io/tx/${transaction_hash}#eventlog",
             "sender": "[email protected]",
-            "receipients": [
+            "recipients": [
                 "[email protected]",
                 "[email protected]"
             ]
@@ -27,7 +27,7 @@
             "subject": "large_transfer_usdc_email triggered",
             "body": "${monitor_name} triggered because of a large transfer of ${function_0_2} USDC to ${function_0_1} | https://stellar.expert/explorer/testnet/tx/${transaction_hash}",
             "sender": "[email protected]",
-            "receipients": [
+            "recipients": [
                 "[email protected]",
                 "[email protected]"
             ]