Skip to content

README.md

Latest commit

 

History

History
39 lines (30 loc) · 1.03 KB

README.md

File metadata and controls

39 lines (30 loc) · 1.03 KB

PerpStats

PerpStats is a decentralized analytics engine for tracking REChain Network’s perpetual trading markets. It ingests on-chain events, computes key metrics, and exposes them via API.

Table of Contents

Features

  • Real-time volume, open interest, funding rate calculations
  • Historical export (JSON, CSV)
  • REST & WebSocket API for live feeds

Quick Start

git clone https://github.com/REChain-Network-Solutions/PerpStats.git
cd PerpStats
cp .env.example .env
# set NODE_URL and DATABASE_URL
npm install
npm run dev

Usage

See USAGE.md for CLI and config details.

Architecture

High-level design overview: ingestion → processing → storage → API. More in ARCHITECTURE.md.

Contributing

See CONTRIBUTING.md. All contributions welcome!

License

Licensed under MIT. See LICENSE.