Skip to content

Commit

Permalink
Updated readme with test block info.
Browse files Browse the repository at this point in the history
  • Loading branch information
gabehamilton committed Jun 26, 2023
1 parent d61bc9e commit 3eb0009
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 3eb0009

Please sign in to comment.