Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gobitfly/eth2-beaconchain-explorer

Open source golang based explorer for the eth2 beacon chain
https://github.com/gobitfly/eth2-beaconchain-explorer

block-explorer eth2 eth2-beacon-chain golang

Last synced: about 1 month ago
JSON representation

Open source golang based explorer for the eth2 beacon chain

Awesome Lists containing this project

README 

        
# Ethereum Beacon Chain Explorer



The explorer provides a comprehensive and easy to use interface for the upcoming Ethereum beacon chain. It makes it easy to view proposed blocks, follow attestations and monitor your staking activity.



[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://dsc.gg/beaconchain)

[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/beaconcha_in)



[![Badge](https://github.com/gobitfly/eth2-beaconchain-explorer/workflows/Build/badge.svg)](https://github.com/gobitfly/eth2-beaconchain-explorer/actions?query=workflow%3A%22Build+%26+Publish+Docker+images%22)

[![Go Report Card](https://goreportcard.com/badge/github.com/gobitfly/eth2-beaconchain-explorer)](https://goreportcard.com/report/github.com/gobitfly/eth2-beaconchain-explorer)

[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/gobitfly/eth2-beaconchain-explorer/badge)](https://www.gitpoap.io/gh/gobitfly/eth2-beaconchain-explorer)



## About



The explorer is built using golang and utilizes a PostgreSQL database for storing and indexing data. In order to avoid the situation we currently have with the Ethereum chain where closed source block explorers dominate the market we decided to make our explorer open source and available for everybody.



### Ethereum Testnet Explorers



[Goerli](https://goerli.beaconcha.in)


[Sepolia](https://sepolia.beaconcha.in)


[Holesky](https://holesky.beaconcha.in)



**Warning:** The explorer is still under heavy active development. More or less everything might change without prior notice and we cannot guarantee any backwards compatibility for now. Once the Ethereum ecosystem matures we will be able to provide stronger guarantees about the updatability of the explorer.



![Site](https://user-images.githubusercontent.com/26490734/120495328-e351f800-c3bc-11eb-92a8-e93fbde24539.png 'Beacon Chain Web Interface Screenshot')



## Features



- General

  - Open Source (GNU General Public License v3.0)

  - Supports Execution Layer and Consensus Layer

  - Supports multiple networks

  - Written in Golang



- Website

  - [Validator Dashboard](https://beaconcha.in/dashboard) with status, income, balance, attestations, proposals and charts

  - Overviews about [blocks](https://beaconcha.in/blocks), [slots](https://beaconcha.in/slots), [epochs](https://beaconcha.in/epochs), [transactions](https://beaconcha.in/transactions), [validators](https://beaconcha.in/validators), [slashings](https://beaconcha.in/validators/slashings) and the [mempool](https://beaconcha.in/mempool)

  - Stats and info about [Rocket Pool](https://beaconcha.in/pools/rocketpool), [staking services](https://beaconcha.in/stakingServices), [MEV relays](https://beaconcha.in/relays) and [Ethereum clients](https://beaconcha.in/user/ethClients)

  - Leaderboards about [validators](https://beaconcha.in/validators/leaderboard) and [deposits](https://beaconcha.in/validators/deposit-leaderboard)

  - [Charts](https://beaconcha.in/charts) about various stats



- Monitoring

  - The monitoring feature analyzes blockchain data and (optionally) data provided by a user's staking setup

  - Highly configurable [notifications and notification channels](https://beaconcha.in/user/notifications) (mobile push, email, webhooks)



- Tools

  - [APIs](https://beaconcha.in/api/v1/docs/index.html) for Execution Layer and Consensus Layer

  - [Ethereum Staking Pool benchmark and overview](https://beaconcha.in/pools)

  - [Income History](https://beaconcha.in/user/rewards)

  - [Profit Calculator](https://beaconcha.in/calculator)

  - Block Visualizer [[1](https://beaconcha.in/vis)] [[2](https://beaconcha.in/charts/slotviz)]

  - [Unit Converter](https://beaconcha.in/tools/unitConverter)

  - [Graffiti Wall](https://beaconcha.in/graffitiwall)



- [Beaconcha.in Mobile App](https://beaconcha.in/mobile)

  - Open Source (GNU General Public License v3.0)

  - Dashboard with similar info as the website

  - Notifications about client updates

  - Advanced Rocket Pool features

  - Machine stats with charts

  - Widgets

  - Themes



## ToDo



- Add chain statistic charts

- Improve design, move away from stock bootstrap 4

- Use a proper open source charting library

- Come up with a smarter exporter logic (the current logic is stupid as it simply dumps the contents of the RPC calls into the database without doing any pre-aggregation or cleanups)



## Getting started



We currently do not provide any pre-built binaries of the explorer. Docker images are available at https://hub.docker.com/repository/docker/gobitfly/eth2-beaconchain-explorer.



- Download the latest version of the Prysm beacon chain client and start it with the `--archive` flag set

- Wait till the client finishes the initial sync

- Setup a PostgreSQL DB and import the `tables.sql` file from the root of this repository

- Install go version 1.13 or higher

- Clone the repository and run `make all` to build the indexer and front-end binaries

- Copy the config-example.yml file and adapt it to your environment

- Start the explorer binary and pass the path to the config file as argument

- To build bootstrap run `npm run --prefix ./bootstrap dist-css` in project folder.



## Developing locally with docker

- Clone the repository

- Run `docker-compose up` to start instances of the following containers `eth1`, `prysm`, `postgres` and `golang`.

- Open a new terminal in project directory and run `docker run -it --rm --net=host -v $(pwd):/src  postgres psql -f /src/tables.sql -d db -h 0.0.0.0 -U postgres` to create new tables in the database  

- Wait for the client to finish initial sync, you can check this by looking at logs of `prysm` instance.

- Copy the `config-example.yml` file and adapt it to your environment.\

 In your `.yml` file specify `eth1Endpoint` as `'./private/eth1_node/.ethereum/goerli/geth.ipc'`. 

 For database information check `postgres` section in `docker-compose.yml` file.

- Connect to `golang` instance by running `docker exec -ti golang bash` and run `make all`

- Start the explorer binary and pass the path to the config file as argument 



      ./bin/explorer --config your_config.yml   



## Development



Install golint. (see https://github.com/golang/lint)



## Commercial usage



The explorer uses Highsoft charts which are not free for commercial and governmental use. If you plan to use the explorer for commercial purposes you currently need to purchase an appropriate HighSoft license.

We are planning to switch out the Highsoft chart library with a less restrictive charting library (suggestions are welcome).