gobitfly / eth2-beaconchain-explorer

Open source golang based explorer for the eth2 beacon chain
GNU General Public License v3.0
774 stars 411 forks source link

Readme section `Developing locally with docker` is outdated #2899

Open TheJoeSchr opened 1 month ago

TheJoeSchr commented 1 month ago

Describe the bug The section Developing locally with docker is outdated. It references services which don't exist anymore in docker-compose.yml like e.g. eth1, prysm, postgres

There seems to be a new helper script under local-deployment/run.sh but when running it with start I get an error like this (see attached screenshot):

INFO[2024-06-20T18:50:54+02:00] Uploading and executing package 'github.com/gobitfly/eth2-beaconchain-explorer/local-testnet'
There was an error interpreting Starlark code
Evaluation error: An error occurred while loading the module 'github.com/kurtosis-tech/ethereum-package/src/package_io/input_parser.star'
        Caused by: Error occurred while validating /kurtosis-data/repositories/kurtosis-tech/ethereum-package/kurtosis.yml
        Caused by: The package name in kurtosis.yml must match the location it is in. Package name is 'github.com/ethpandaops/ethereum-package' and kurtosis.yml is found here: 'github.com/kurtosis-tech/ethereum-package'
        at [github.com/gobitfly/eth2-beaconchain-explorer/local-testnet/main.star:1:29]: <toplevel>

Error encountered running Starlark code.

So the refined section should probably get into this as well as referencing the seemingly more up-to-date README.md at local-deployment/README.md

To Reproduce Steps to reproduce the behavior:

  1. cd local-deployment
  2. docker-compose up eth1 prysm postgres
  3. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots image

Desktop (please complete the following information):