From 6c16c17dc70fb6cadd92256911737becd45893c7 Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Mon, 9 Dec 2024 22:08:11 +1100 Subject: [PATCH] Update README.md --- indexer/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/indexer/README.md b/indexer/README.md index 916f5c9dfd43..834b4c9d1936 100644 --- a/indexer/README.md +++ b/indexer/README.md @@ -5,15 +5,15 @@ ### Configuration The `indexer.toml` contains configuration for the indexer. The file is templated for the local devnet, however presets are available for [known networks](https://github.com/ethereum-optimism/optimism/blob/develop/indexer/config/presets.go). The file also templates keys needed for custom networks such as the rollup contract addresses and the `l1-starting-height` for the deployment height. -Required configuration is network specific `(l1|l2)-rpc` urls that point to archival nodes as well as the `(l1|l2)-polling-interval` & `(l1|l2)-header-buffer-size` keys which controls the of rate data retrieval from these notes. +Required configuration is network specific `(l1|l2)-rpc` urls that point to archival nodes as well as the `(l1|l2)-polling-interval` & `(l1|l2)-header-buffer-size` keys which controls the rate of data retrieval from these nodes. ### Testing -All tests can be ran by running `make test` from the `/indexer` directory. This will run all unit and e2e tests. +All tests can be run by running `make test` from the `/indexer` directory. This will run all unit and e2e tests. -> **NOTE:** Successfully running the E2E tests requires spinning up a local devnet via [op-e2e](https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e) and pre-populating it with necessary bedrock genesis state. This genesis state is generated by invoking the`make devnet-allocs` target from the root of the optimism monorepo before running the indexer tests. More information on this can be found in the [op-e2e README](../op-e2e/README.md). A postgres database through pwd-less user $DB_USER env variable on port 5432 must be available as well. +> **NOTE:** Successfully running the E2E tests requires spinning up a local devnet via [op-e2e](https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e) and pre-populating it with necessary bedrock genesis state. This genesis state is generated by invoking the `make devnet-allocs` target from the root of the optimism monorepo before running the indexer tests. More information on this can be found in the [op-e2e README](../op-e2e/README.md). A postgres database through pwd-less user $DB_USER env variable on port 5432 must be available as well. ### Run the Indexer (docker-compose) -The local [docker-compose.go](https://github.com/ethereum-optimism/optimism/blob/develop/indexer/docker-compose.yml) file spins up **index, api, postgres, prometheus and grafana** services. The `indexer.toml` file is setup for the local devnet. To run against a live network, update the `indexer.toml` with the desired configuration. +The local [docker-compose.go](https://github.com/ethereum-optimism/optimism/blob/develop/ops-bedrock/docker-compose.yml) file spins up **index, api, postgres, prometheus and grafana** services. The `indexer.toml` file is set up for the local devnet. To run against a live network, update the `indexer.toml` with the desired configuration. > The API, Postgres, and Grafana services are the only ones with ports mapped externally. Postgres database is mapped to port 5433 to deconflict any instances already running on the default port @@ -40,7 +40,7 @@ The indexer application supports two separate services for collective operation: **Indexer Service** - A polling based service that constantly reads and persists OP Stack chain data (i.e, block meta, system contract events, synchronized bridge events) from a L1 and L2 chain. ### Indexer API -See `api/api.go` & `api/routes/` for available API endpoints to for paginated retrieval of bridge data. **TDB** docs. +See `api/api.go` & `api/routes/` for available API endpoints for paginated retrieval of bridge data. **TBD** docs. ### Indexer Service ![Service Component Diagram](./ops/assets/indexer-service.png) @@ -60,10 +60,10 @@ L1 blocks are only indexed if they contain L1 contract events. This is done to r The indexer service currently supports a Postgres database for storing L1/L2 OP Stack chain data. The most up-to-date database schemas can be found in the `./migrations` directory. **Run the idempotent migrations prior to starting the indexer** #### HTTP -The indexer service runs a lightweight health server adjacently to the main service. The health server exposes a single endpoint `/healthz` that can be used to check the health of the indexer service. The health assessment doesn't check dependency health (ie. database) but rather checks the health of the indexer service itself. +The indexer service runs a lightweight health server adjacent to the main service. The health server exposes a single endpoint `/healthz` that can be used to check the health of the indexer service. The health assessment doesn't check dependency health (ie. database) but rather checks the health of the indexer service itself. #### Metrics -The indexer services exposes a set of Prometheus metrics that can be used to monitor the health of the service. The metrics are exposed via the `/metrics` endpoint on the health server. +The indexer services expose a set of Prometheus metrics that can be used to monitor the health of the service. The metrics are exposed via the `/metrics` endpoint on the health server. ## Security