README.md

Blockscout ENS service

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

Here is brief overview of the project stucture:

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

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