https://github.com/bitcoin-dev-project/warnet
Monitor and analyze the emergent behaviors of Bitcoin networks
https://github.com/bitcoin-dev-project/warnet
Last synced: 2 months ago
JSON representation
Monitor and analyze the emergent behaviors of Bitcoin networks
- Host: GitHub
- URL: https://github.com/bitcoin-dev-project/warnet
- Owner: bitcoin-dev-project
- License: mit
- Created: 2023-08-15T17:32:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T12:03:59.000Z (about 2 years ago)
- Last Synced: 2024-05-02T05:19:39.569Z (about 2 years ago)
- Language: Python
- Homepage: https://warnet.dev
- Size: 2.11 MB
- Stars: 56
- Watchers: 6
- Forks: 27
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warnet
Monitor and analyze the emergent behaviors of Bitcoin networks.
## Major Features
* Launch a bitcoin network with a specified number of nodes connected to each other according to a network topology.
* Run scenarios of network behavior across the network which can be programmed using the Bitcoin Core functional [test_framework language](https://github.com/bitcoin/bitcoin/tree/master/test/functional).
* Collect and search data from nodes including log files and p2p messages.
* Monitor and visualize performance data from Bitcoin nodes.
* Connect to a large network running in a remote cluster, or a smaller network running locally.
* Add a Lightning Network with its own channel topology and payment activity.
## Documentation
- [Design](/DESIGN.md)
- [Installation](/docs/install.md)
- [CLI Commands](/docs/warnet.md)
- [Network configuration with yaml files](/docs/config.md)
- [Plugins](/docs/plugins.md)
- [Scenarios](/docs/scenarios.md)
- [Monitoring](/docs/logging_monitoring.md)
- [Snapshots](/docs/snapshots.md)
- [Connecting to local nodes outside the cluster](/docs/connecting-local-nodes.md)
- [Scaling](/docs/scaling.md)
- [Contributing](/docs/developer-notes.md)
## Quick Start
### 1. Create a python virtual environment
```sh
python3 -m venv .venv
source .venv/bin/activate
```
### 2. Install Warnet
```sh
pip install warnet
```
### 3. Set up dependencies
Warnet will ask which back end you want to use, check that it is working,
and install additional client tools into the virtual environment.
```sh
warnet setup
```
### 4. Create a project and network
Warnet will create a new folder structure containing standard scenario and plugin
files, and prompt for details about a network topology to create. Topology details
include number of Bitcoin nodes, which release versions or custom images to deploy
and how many random graph connections to start each node with.
```sh
warnet new /my/work/stuff/projectname
```
### 5. Deploy the network
```sh
warnet deploy /my/work/stuff/projectname/networks/networkname
```
### 6. Run experiments
For example, you can start mining blocks...
```sh
warnet run /my/work/stuff/projectname/scenarios/miner_std.py
```
... and then observe network connectivity and statistics in your browser:
```sh
warnet dashboard
```
### 7. Shut down the network
```sh
warnet down
```
### 8. Customize
Read the docs and learn how to write your own [scenarios](docs/scenarios.md)
or add [plugins](docs/plugins.md) to your network. [Configure](docs/config.md) individual nodes
in the network by editing the `network.yaml` file or configure
defaults for all nodes in the network by editing `node-defaults.yaml`. Once
your network is running use Warnet [CLI](docs/warnet.md) commands to interact with it.
