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.
- 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
- Installation
- CLI Commands
- Network configuration with yaml files
- Plugins
- Scenarios
- Monitoring
- Snapshots
- Connecting to local nodes outside the cluster
- Scaling
- Contributing
Quick Start
1. Create a python virtual environment
python3 -m venv .venv
source .venv/bin/activate
2. Install Warnet
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.
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.
warnet new /my/work/stuff/projectname
5. Deploy the network
warnet deploy /my/work/stuff/projectname/networks/networkname
6. Run experiments
For example, you can start mining blocks...
warnet run /my/work/stuff/projectname/scenarios/miner_std.py
... and then observe network connectivity and statistics in your browser:
warnet dashboard
7. Shut down the network
warnet down
8. Customize
Read the docs and learn how to write your own scenarios
or add plugins to your network. Configure 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 commands to interact with it.
2 maintainers
Metadata
2 maintainers
Release files for warnet 1.1.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| warnet-1.1.20.tar.gz | 600.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| warnet-1.1.20-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / warnet-1.1.20.tar.gz
| Download URL | warnet-1.1.20.tar.gz |
|---|---|
| Size | 600.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b629dcb3111d29a5b9fe04e573a7dde6a20d76f53adfe7cba7e506c33de965f6
|
|
BLAKE2b-256 checksum How to use checksums |
7c0be3fa9481ed7b96c2ff7d5100dbceaef0e850f0453db55d1e805d88b72e7f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 28, 2026.
Transparency logRelease files / warnet-1.1.20-py3-none-any.whl
| Download URL | warnet-1.1.20-py3-none-any.whl |
|---|---|
| Size | 462.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
206385ed53f6eb4f881a1cfc2d3ccebf1f8000771fb6e2126a90f09feed0dd1d
|
|
BLAKE2b-256 checksum How to use checksums |
78e8b8c45015b84fb61a52c05752466c1f19fcf7e259f4d9aa2124ddbafdaf4d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 28, 2026.
Transparency log
