From 3eb0009b208c162c011754212b8a15d0e487262a Mon Sep 17 00:00:00 2001 From: Gabe Hamilton Date: Mon, 26 Jun 2023 11:47:17 -0600 Subject: [PATCH] Updated readme with test block info. --- indexer/README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/indexer/README.md b/indexer/README.md index 6904077be..502f4e815 100644 --- a/indexer/README.md +++ b/indexer/README.md @@ -17,13 +17,18 @@ This project is using `workspace` feature of Cargo. ### Crates -- [`alert-rules`](./alert-rules) crate provides the `AlertRule` type for usage in other crates -- [`shared`](./shared) crate holds the common `clap` structs for every indexer in the workspace. Also, it includes shared types and utils. -- [`storage`](./storage) crate provides the functions to work with Redis that are common for all indexers in the workspace +- [`indexer_rule_type`](./indexer_rule_type) provides the IndexerRule type to this app and the registry contract. +- [`indexer_rules_engine`](./indexer_rules_engine) contains logic for matching IndexerRules against StreamerMessages +- [`storage`](./storage) crate provides the functions to work with Redis ### Indexers -- [`queryapi_coordinator`](./queryapi_coordinator) an indexer to watch for `AlertRules` and index changes to the QueryApi registry contract. +- [`queryapi_coordinator`](./queryapi_coordinator) an indexer to index changes to the QueryApi registry contract and + to watch for `IndexerRules` associated with the IndexerFunctions in the registry. + +### Tests +Some tests require blocks with matching data. To download the test block, run +`./download_test_blocks.sh 93085141`. Some other useful blocks are 80854399 92476362 93085141 93659695. ## Design concept