From 8126acb1318f3531359ff61fb8301fbf611537e8 Mon Sep 17 00:00:00 2001 From: aubrey <73075391+aubrika@users.noreply.github.com> Date: Tue, 16 Jul 2024 06:56:47 -0700 Subject: [PATCH] cometindex: clarify some environment context in the readme (#4710) ## Describe your changes ## Issue ticket number and link ## Checklist before requesting a review - [ ] If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: > just a readme update --------- Signed-off-by: finch Co-authored-by: finch --- crates/util/cometindex/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/crates/util/cometindex/README.md b/crates/util/cometindex/README.md index 466f13a600..23c88fd73f 100644 --- a/crates/util/cometindex/README.md +++ b/crates/util/cometindex/README.md @@ -1,4 +1,10 @@ +# pindexer +To run `pindexer`, you will need to create two postgres databases: one for the raw data and one for the compiled data. The raw data is the data from CometBFT, while the compiled data is translated into schemas determined by `pindexer`. + +`pindexer` will read from the raw data database and write to the compiled data database, but doing so also requires a local database of ABCI events to be present. The most straightforward way to create such a database is by following the devnet instructions in the [Penumbra Guide]. + +[Penumbra Guide]: https://guide.penumbra.zone/dev/devnet-quickstart.html # macos