Skip to content

Latest commit

 

History

History
 
 

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:

bens-structure

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

Contribute

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

  1. Clone this blockscout-rs repo to add new protocol.
  2. Write subraph code: read subgraph writer guide
  3. [OPTIONAL] if your protocol is based on SpaceID, read SpaceID integration section.
  4. Start graph-node: read graph-node guide
  5. Deploy subgraph to graph-node: read how to deploy subgraphs guide
  6. Update default config of BENS server for production and staging
  7. Start bens-server connected to common database: read how to start bens guide
  8. Check that bens-server responses with valid domains
  9. Add your protocol to list of supported domains
  10. 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