Update README.md

This commit is contained in:
Ivan Daniluk 2018-11-01 11:36:23 +01:00 committed by GitHub
parent 453521cdd2
commit b51858de47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,8 +1,21 @@
# Simulator # P2P messaging simulation toolkit
--- ---
This repository holds different simulators for exploring and researching p2p networks and messaging related to Status. This repository holds different simulators for exploring and researching p2p networks and messaging related to Status.
Original intent of these simulators to provide stats and resulting traces/logs for further WebGL visualization. Original intent of these simulators is to provide stats and resulting traces/logs for further analysis and visualization.
```
+------------------+ +----------------+ +-------------+ +------------------+
| Choose | | Run nodes in | | | | |
| network topology |---- simulated | | | | |
+------------------+ | environment | | Propagate | | Collect network |
| - in-memory |---- message(s) |---- events & |
+------------------+ | - exec | | | | generate stats |
| Choose |---- - docker | | | | |
| Simulator | | | | | | |
+------------------+ +----------------+ +-------------+ +------------------+
```
See READMEs for each package/program separately. See READMEs for each package/program separately.
@ -10,15 +23,14 @@ See READMEs for each package/program separately.
Propagation simulators send message over known network topology and record its propagation data/stats. Propagation simulators send message over known network topology and record its propagation data/stats.
Currently implemented: Currently implemented:
- Whisper V6 (based on geth code)
- Naive p2p messaging (goroutines and channel simulation with naive simplistic message propagation, used for initial testing)
## Discovery | Simulator | Description |
TBD |---|---|
| WhisperV6 | Master branch if go-ethereum Whisper implementation |
| Naive | Naive p2p propagation |
## Usage ## Usage
## License ## License
MIT MIT