etherhound-core 0.1.0b1

EtherHound Core - Blockchain Event Scanner Server

EtherHound (Core)

The core of EtherHound — fast, flexible Ethereum blockchain event tracker.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

EtherHound Core is the foundational service of the EtherHound suite — a modular, event-driven blockchain scanner designed to monitor Ethereum networks with high precision.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• python >= 3.10
• web3 >= 7.12.0
• fastapi[standard]
• pydantic
• typer (CLI)

Installation

Github installation (recommended):

1. clone the repo

git clone https://github.com/EtherHounds/Core.git

2. cd into the repo

cd Core

3. build

pip install . -U

4. done!

PyPi:

pip install etherhound-core

(back to top)

Usage

CLI (hound)

deploy

used to deploy the Hound Server

Args:

• host (str): the uvicorn server host, default=localhost
• port (int): the uvicorn server port, default=8080
• rpc (str): the RPC url from your provider
• mode (str): the scanner mode, default="fast"
• detach (bool): de-attach from the server, default=False
• load_env (bool): get the rpc,mode from the .env file, default=False

(back to top)

Roadmap

• Examples
• Better Documentation
• Docker image (docker hub)
• BlockScanner Implementation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)

Contact

SpicyPenguin - @kerolis55463

Project Link: https://github.com/EtherHounds/Core

(back to top)