Skip to content

Commit 4da7af6

Browse files
authored
Update README.md
1 parent b33d42a commit 4da7af6

File tree

1 file changed

+86
-2
lines changed

1 file changed

+86
-2
lines changed

README.md

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,86 @@
1-
# Celo-Wallet-Simulator
2-
Developer tool for simulating wallet activity on the Celo blockchain. Includes persona modeling, RPC failover, dynamic delays, and daily transaction logging for research & infra testing.
1+
# ⚡ Celo Wallet Simulator
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
4+
[![Node.js](https://img.shields.io/badge/node-%3E%3D18-green)](https://nodejs.org/)
5+
[![GitHub stars](https://img.shields.io/github/stars/CryptoExplor/Celo-Wallet-Simulator?style=social)](https://github.com/CryptoExplor/Celo-Wallet-Simulator/stargazers)
6+
7+
A lightweight **wallet activity simulator** for the **Celo blockchain**, designed for:
8+
9+
* 🔹 **Infrastructure testing** (RPCs, nodes, endpoints)
10+
* 🔹 **Monitoring transaction throughput**
11+
* 🔹 **Researching organic wallet behavior**
12+
* 🔹 **Developer tooling & analytics**
13+
14+
---
15+
16+
## 📦 Features
17+
18+
✅ Persona-driven wallet behavior (`personas.json`)
19+
✅ Configurable wait logic (adaptive random spacing)
20+
✅ Multi-RPC rotation for Celo endpoints
21+
✅ Structured CSV logging for analysis
22+
✅ JSON-based configuration (no hardcoding)
23+
24+
---
25+
26+
## 🚀 Quick Start
27+
28+
1. **Clone the repo**
29+
30+
```bash
31+
git clone https://github.com/CryptoExplor/Celo-Wallet-Simulator.git
32+
cd Celo-Wallet-Simulator
33+
npm install
34+
```
35+
36+
2. **Add wallets**
37+
38+
* Create a `key.txt` file in the root directory.
39+
* Put **one private key per line**.
40+
41+
3. **Run the simulator**
42+
43+
```bash
44+
node index.js
45+
```
46+
47+
4. **View logs**
48+
49+
* Generated in `tx_log_YYYY-MM-DD.csv` (daily rotation).
50+
51+
---
52+
53+
## 📘 Documentation
54+
55+
📄 [Usage Guide](./USAGE.md) – setup, personas, logging, workflow
56+
📄 [Architecture](./ARCHITECTURE.md) – system design & internals
57+
58+
---
59+
60+
## 📂 Project Structure
61+
62+
```
63+
Celo-Wallet-Simulator/
64+
│── index.js # Main loop engine
65+
│── personas.json # Wallet persona configs
66+
│── key.txt # Wallet private keys (user-supplied)
67+
│── tx_log_*.csv # Daily transaction logs
68+
│── USAGE.md # Usage documentation
69+
│── ARCHITECTURE.md # Architecture documentation
70+
│── package.json
71+
```
72+
73+
---
74+
75+
## ⚠️ Disclaimer
76+
77+
This project is provided for **educational and development purposes only**.
78+
It is intended to support Celo developers and infrastructure teams in:
79+
80+
* Testing RPC endpoints
81+
* Simulating transaction activity
82+
* Analyzing network performance
83+
84+
It should **not** be used for spam, Sybil attacks, or any form of abuse.
85+
86+
---

0 commit comments

Comments
 (0)