Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jovijovi/ether-crawler

A transaction crawler for the Ethereum ecosystem.
https://github.com/jovijovi/ether-crawler

blockchain crawler ether ethereum transaction

Last synced: about 10 hours ago
JSON representation

A transaction crawler for the Ethereum ecosystem.

Awesome Lists containing this project

README

        

# Ether Crawler

[![GitHub Actions](https://github.com/jovijovi/ether-crawler/workflows/Test/badge.svg)](https://github.com/jovijovi/ether-crawler)

Transactions crawler for the Ethereum ecosystem.

## Features

- Dump `transfer coin` transaction to database
- Support [PostgreSQL](https://www.postgresql.org), [MySQL](https://www.mysql.com) and [SQLite](https://www.sqlite.org)
- Custom crawler concurrency options

## Supported Chains

- [Ethereum](https://ethereum.org/)
- [Polygon](https://polygon.technology/)

## Development Environment

- typescript `4.8.4`
- node `v16.18.0`
- ts-node `v10.9.1`
- yarn `v1.22.19`

## Quick Guide

- Install dependency

```shell
yarn
```

- Build code

Install all dependencies and compile code.

```shell
make build
```

- DEV environment dependency

- Setup

```shell
cd ./devenv
./dev.sh up
cd ..
```

- Shutdown

```shell
./dev.sh down
```

- Build docker image

```shell
make docker
```

- Run

- Params

- `--config` Config filepath. Example:

```shell
ts-node ./src/main/index.ts --config ./conf/app.config.yaml
```

- Run code directly by `ts-node`

```shell
yarn dev-run --config ./conf/app.config.yaml
```

- Run compiled code by `node`

```shell
yarn dist-run --config ./conf/app.config.yaml
```

- Clean

```shell
make clean
```

## Roadmap

- Support more transaction type
- Improve performance
- UT
- Resume job from interruption

## License

[MIT](LICENSE)