Skip to content

Commit 736d3cd

Browse files
committed
diff ..
1 parent 5ffb73e commit 736d3cd

File tree

3 files changed

+135
-0
lines changed

3 files changed

+135
-0
lines changed

.env.example

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
PORT=3000
2+
DB_URI=mongodb://localhost:27017/rechain_stats
3+
REDIS_URL=redis://localhost:6379
4+
JWT_SECRET=supersecretjwtkey

api-doc.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# REChain ® Stats — API Documentation
2+
3+
## GET /api/chain/metrics
4+
Returns general metrics about blockchain activity.
5+
6+
## GET /api/node/health
7+
Returns list of node statuses with uptime, latency, version.
8+
9+
## GET /api/dao/proposals
10+
Returns proposal history, vote counts, and outcomes.
11+
12+
## GET /api/resource/usage
13+
Returns CPU, RAM, and disk usage per monitored node.

wiki.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# 📊 REChain ® Stats — Wiki
2+
3+
Welcome to the **REChain ® Stats** Wiki — your go-to hub for understanding the statistics and analytics infrastructure across the REChain Network Solutions ecosystem.
4+
5+
---
6+
7+
## 📌 Overview
8+
9+
**REChain ® Stats** is a decentralized statistics and metrics service designed to track and report critical blockchain, node, and platform data across the REChain infrastructure. It provides visibility into:
10+
11+
- Node health
12+
- Chain activity
13+
- Resource usage
14+
- Governance and proposal metrics
15+
- DAO and dApp adoption
16+
17+
---
18+
19+
## 📂 Repository Structure
20+
21+
```
22+
Stats/
23+
├── backend/ # API or backend logic (Rust, Go, Node.js, etc.)
24+
├── frontend/ # UI for presenting metrics
25+
├── data/ # Raw or aggregated statistical data
26+
├── scripts/ # Automation & data sync tools
27+
└── README.md
28+
```
29+
30+
---
31+
32+
## ⚙️ Features
33+
34+
| Feature | Description |
35+
|------------------------------|-----------------------------------------------------------------------------|
36+
| 📈 Chain Metrics | Live data on block height, transactions per second, gas consumption, etc. |
37+
| 🧠 Node Analytics | Uptime, region, latency, versioning, peer stats |
38+
| 🧮 DAO + Proposal Stats | Voting activity, proposal counts, results, and quorum data |
39+
| 📉 Resource Usage | CPU/RAM/disk usage per node (if integrated with monitoring) |
40+
| 🛠 Custom Dashboards | Filter by time, region, or specific service (e.g. dApp, CEX, Wallet) |
41+
| 📊 Data Export | JSON, CSV, or API output for external processing |
42+
43+
---
44+
45+
## 📡 API Endpoints (Example)
46+
47+
```
48+
GET /api/chain/metrics
49+
GET /api/node/health
50+
GET /api/dao/proposals
51+
GET /api/resource/usage
52+
```
53+
54+
---
55+
56+
## 🧪 How to Run
57+
58+
### Prerequisites
59+
60+
- Node.js or Rust (depending on backend)
61+
- MongoDB / PostgreSQL / InfluxDB for time-series data
62+
- Redis (optional for caching)
63+
64+
### Local Setup
65+
66+
```bash
67+
git clone https://github.com/REChain-Network-Solutions/Stats.git
68+
cd Stats
69+
npm install # or cargo build
70+
npm start # or cargo run
71+
```
72+
73+
---
74+
75+
## 🔐 Authentication & Access
76+
77+
For private dashboards or internal stats:
78+
79+
- Enable JWT-based access
80+
- Use `.env` for secrets & keys
81+
- Integrate with REChain Wallet Connect for secure auth
82+
83+
---
84+
85+
## 📦 Integrations
86+
87+
| Service | Integration Purpose |
88+
|---------------------------|-------------------------------------------------|
89+
| REChain Node | Node monitoring & metadata reporting |
90+
| REChain DAO | Proposal + voting stats |
91+
| dApps & Wallets | Usage and telemetry |
92+
| REChain CEX (rechain.group)| Volume and trade metrics |
93+
94+
---
95+
96+
## 🧩 Related Projects
97+
98+
- [`REChain-/`](https://github.com/sorydima/REChain-/): Core blockchain node
99+
- [`dApp`](https://github.com/REChain-Network-Solutions/dApp.git): Decentralized apps dashboard
100+
- [`PoSPro`](https://github.com/REChain-Network-Solutions/PoSPro-.git): Decentralized point-of-sale system
101+
102+
---
103+
104+
## 📅 Roadmap
105+
106+
- [x] Basic metrics API
107+
- [ ] Grafana-compatible dashboards
108+
- [ ] Distributed P2P stat node sync
109+
- [ ] Anomaly detection & alerts
110+
- [ ] Public REST API with API key auth
111+
112+
---
113+
114+
## 👨‍💻 Contributors
115+
116+
Built with ❤️ by the **REChain Network Solutions** core team and community contributors.
117+
118+
Join us on [Telegram](https://t.me/REChainDAO) or contribute via [GitHub Issues](https://github.com/REChain-Network-Solutions/Stats/issues).

0 commit comments

Comments
 (0)