Skip to content

Commit d02da95

Browse files
committed
docs: Adding docs for monitor example
1 parent 5296d7d commit d02da95

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/modules/ROOT/pages/quickstart.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,27 @@ The monitor will now:
484484
2. Watch for large dex swaps.
485485
3. Send notifications via Slack when large swaps occur.
486486

487+
**Running monitor against a specific block**
488+
489+
You can run the monitor against a specific block number for testing or debugging purposes. This is useful when you want to verify how the monitor behaves.
490+
491+
[source,bash]
492+
----
493+
cargo run -- --monitorName "Large Transfer of USDC Token" --network=ethereum_mainnet --block=12345678
494+
----
495+
496+
This command will:
497+
1. Execute the monitor named "Large Transfer of USDC Token"
498+
2. Run it against the ethereum_mainnet network
499+
3. Process block number 12345678 specifically
500+
501+
As a result, you will get a JSON output with the monitor matches, if any.
502+
503+
[NOTE]
504+
====
505+
All three parameters (`--monitorName`, `--network`, and `--block`) are required when running against a specific block.
506+
====
507+
487508
==== 5. Next Steps:
488509

489510
* Adjust the swap threshold by modifying the `expression` value.

0 commit comments

Comments
 (0)