eth-parser

Table of Contents

• eth-parser
  • Table of Contents
  • About the project
  • API documentation
  • Live DEMO
  • Local development
    • Running from source
      • Prerequisites
    • Project Layout

About the project

The purpose of the project is to provides a RESTful API to interact with the transaction on the network by iterate through Ethereum blocks and transactions, store parsed transaction for subscribed addresses into the in-memory store.

API documentation

For full API document please checkout this section

Live DEMO

API server was deployed to GCP Cloud Run, you can try the following commands to interact with the service

• Subscribe to an address

curl --location 'https://eth-parser-ywc6sv7cza-uc.a.run.app/subscribe' \
--header 'Content-Type: application/json' \
--data '{
    "address": "0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5"
}'

• List collected transactions of an address

curl --location 'https://eth-parser-ywc6sv7cza-uc.a.run.app/transactions?address=0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5'

• Get current fetched block number

curl --location 'https://eth-parser-ywc6sv7cza-uc.a.run.app/block'

• List all addresses that have been subscribed

curl --location 'https://eth-parser-ywc6sv7cza-uc.a.run.app/subscriber'

Note The live demo is using concurrency limit of 10, batch size of 50 to avoid the service from being rate limited by the RPC provider. Try running locally with different configuration for better performance.

Local development

Running from source

Prerequisites

• Go 1.22.3

Override environment variables is optional, you can use the default values

# default values
export PORT=8080
export LOG_LEVEL=info
export ENDPOINT="https://mainnet.infura.io/v3/12bd8c6b2e5e400b8cf17b6664320653"
export START_BLOCK=20083813
export CONCURRENCY_LIMIT=10
export BATCH_SIZE=50
export RATE_LIMIT_INTERVAL=1
export NEW_BLOCK_INTERVAL=15

Run the server:

go run main.go

Project Layout

.
├── common
│   └── ...
├── config
│   └── ...
├── provider
│   └── ...
├── server
│   └── ...
└── txstore
    └── ...

common - Shared utilities, data structures, and helper functions.

config - Application settings, connections, keys.

provider - Interfaces and implementation for different blockchain provider.

server - HTTP server setup, handler, and API routes.

txstore - Transaction data storage and retrieval logic.