README.md

Blockscout ENS service

This project provides indexed data of domain name service for blockscout instances.

Here is brief overview of the project structure:

Service is multi-chain, meaning that only one instance of graph-node, postgres and bens-server is required.

Variable	Required	Description	Default value
`BENS__DATABASE__CONNECT__URL`	true	e.g. `postgresql://postgres:postgres@localhost:5432/postgres`
`BENS__DATABASE__CREATE_DATABASE`			`false`
`BENS__DATABASE__RUN_MIGRATIONS`			`false`
`BENS__SERVER__HTTP__ADDR`			`0.0.0.0:8050`
`BENS__SERVER__HTTP__ENABLED`			`true`
`BENS__SERVER__HTTP__MAX_BODY_SIZE`			`2097152`
`BENS__SUBGRAPHS_READER__REFRESH_CACHE_SCHEDULE`			`0 0 * * * *`
`BENS__TRACING__ENABLED`			`true`
`BENS__TRACING__FORMAT`			`default`

If you want to add your name service procol to blockscout you should:

Clone this blockscout-rs repo to add new protocol.
Write subraph code: read subgraph writer guide
[OPTIONAL] if your protocol is based on SpaceID, read SpaceID integration section.
Start graph-node: read graph-node guide
Deploy subgraph to graph-node: read how to deploy subgraphs guide
Update default config of BENS server for production and staging
Start bens-server connected to common database: read how to start bens guide
Check that bens-server responses with valid domains
Add your protocol to list of supported domains
Finally, create PR with:
- New directory inside blockscout-ens/graph-node/subgraphs with your subgraph code
- Updated BENS config
- Updated supported domains list
- Result of indexed data: proof that your indexed subgraph contains correct amount of domains, resolved_addresses and so on