DEX explorer for Penumbra

A DEX explorer for Penumbra.

Getting Started

TK. Although the docs at https://github.com/penumbra-zone/cuiloa may be useful.

Penumbra node setup

You need to have a full node setup with penumbra (including cometbft) as detailed here for testnets. Alternatively, you can configure a full node on a devnet as explained here. In either case, you need to modify the config.toml file that is created by pd after generating your configuration files.

config.toml should be found under $HOME/.penumbra/testnet_data/node0/cometbft/config/. In this file, there is a heading [tx_index] with the configuration variable of indexer = "kv". Using the URI of the database you created with PostgreSQL from the previous section, you need to update the section under [tx_index] to the following:

[tx_index]
indexer = "psql"
psql-conn = "$YOUR_DB_URI_HERE"

After you have updated this file, you should start the full node as instructed by the Penumbra guide. If everything was configured correctly, you should be able to open the database and inspect for Block and Transaction events. If there is no data, check the logs for cometbft for any errors with inserting data into the indexer.

Deployment

Merges to main will automatically build a container, hosted at ghcr.io/penumbra-zone/dex-explorer. In order to run the dex-explorer, you'll need to deploy a Penumbra fullnode, with ABCI event indexing enabled. The relevant env vars you'll want to set are:

• PENUMBRA_GRPC_ENDPOINT
• PENUMBRA_INDEXER_ENDPOINT
• NEXT_PUBLIC_CHAIN_ID
• NEXT_PUBLIC_CUILOA_URL

Name

It'd be nice to have a cool name for the DEX explorer. We don't have one yet.

Proto Generation

Using https://buf.build/penumbra-zone/penumbra/sdks/main