ethereum-block-scanner

Ethereum Block Scanner

Overview

This project offers a Go SDK and REST API for Ethereum block scanning.

Getting Started

Step 1. Run HTTP server:

make run-server

or run with docker-compose:

docker-compose up -d

Step 2.: Click on http://0.0.0.0:8080/swagger/index.html to open Swagger UI.

Step 3.: Run following example query or just explore the API via Swagger UI:

curl -X 'GET' \
  'http://0.0.0.0:8080/api/v1/block/current' \
  -H 'accept: application/json'

Development Setup

Step 0. Install pre-commit:

pip install pre-commit

# For macOS users.
brew install pre-commit

Then run pre-commit install to setup git hook scripts. Used hooks can be found here.

NOTE

pre-commit aids in running checks (end of file fixing, markdown linting, go linting, runs go tests, json validation, etc.) before you perform your git commits.

Step 1. Install external tooling (golangci-lint, etc.):

make install

Step 2. Setup project for local testing (code lint, runs tests, builds all needed binaries):

make all

NOTE

All binaries can be found in <project_root>/bin directory. Use make clean to delete old binaries.

Step 3. Run server:

make run-server

and open http://0.0.0.0:8080/swagger/index.html to open Swagger UI.

NOTE

Check Makefile for other useful commands.

NOTE

After modification of the API remember to run make docs is order to re-generate the API documentation so that Swagger UI visualizes the up-to-date changes.

License

MIT