Skip to content

Commit

Permalink
cometindex: clarify some environment context in the readme (#4710)
Browse files Browse the repository at this point in the history
## 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 <[email protected]>
Co-authored-by: finch <[email protected]>
  • Loading branch information
aubrika and plaidfinch committed Jul 16, 2024
1 parent 5902460 commit 8126acb
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions crates/util/cometindex/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 8126acb

Please sign in to comment.