https://github.com/protolambda/e2db
DB models and feeds for Eth2 state and Eth1-deposits
https://github.com/protolambda/e2db
Last synced: about 2 months ago
JSON representation
DB models and feeds for Eth2 state and Eth1-deposits
- Host: GitHub
- URL: https://github.com/protolambda/e2db
- Owner: protolambda
- License: mit
- Created: 2020-05-25T13:08:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-08T12:43:19.000Z (almost 5 years ago)
- Last Synced: 2025-02-08T16:32:33.755Z (3 months ago)
- Language: Python
- Size: 149 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# E2DB
Database models and feeds to track the Eth2 Beacon Chain and Eth1 deposit process.
The goal is to enable anyone to index their own DB of enhanced chain information,
to track their validators, build dashboards, and back other tooling with.
The DB can use a local sqlite file, or attach to a remote mysql/postgres DB.
## Powered by
- SQL-Alchemy for a nice SQL DB ORM
- Trio for safe async python, and memory send/receive channels
- `eth2`, a new experimental API package for Eth2
- `eth2spec`, the canonical spec for datatypes and state processing functions
- Web3.py, for Eth1 monitoring
- Docker deployment
Example docker usage:
```shell script
docker build -t protolambda/e2db .
docker run -d --name e2db protolambda/e2db python -u run_eth2_feeds.py --watch --backfill \
--eth2-addr=http://mylighthouse.apiaddress \
--db-addr=longconnectionstring
```
For testing you can leave out the `--db-addr`, and it will write to a local SQLite DB called `testing.db`
## Features
- Extensive indexing of Eth2 state for testnet analytics (including watching hot-chain/forked-data)
- Indexing of Eth1 deposits (including pending deposits, live watching, etc.)
## Work in progress
- An analytics-focused explorer utilizing the data, build on Dash and Plotly
- Insight into Eth1 deposits progress to inform new testnet users of their status
- Gamification of testnets using this data.
## Planned features
- Filtering to only track a subset of the validators or state. Keeps the DB small, and useful for staking operations.
- Switch from lighthouse API to standardized Eth2 API
- Maybe DB support for some network-level analytics, depending on integration with Rumor and Prrkl networking tools.
## License
MIT, see [`LICENSE`](./LICENSE) file.