warnet 0.9.9__tar.gz

warnet-0.9.9/.dockerignore

@@ -0,0 +1,16 @@
+.git
+
+**/__pycache__
+.trunk
+.venv
+build
+dist
+**/*.egg-info
+**/*.egg/
+**/*.pyc
+**/*.swp
+
+frontend
+.ruff_cache
+.idea
+.ignored_extras

warnet-0.9.9/.github/workflows/deploy.yml

@@ -0,0 +1,60 @@
+name: deploy
+
+on:
+  workflow_run:
+    workflows: ["test"]
+    types:
+      - completed
+
+jobs:
+  deploy-to-dockerhub:
+    runs-on: ubuntu-latest
+    if: >
+      github.event.workflow_run.conclusion == 'success'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_RPC_REPO }}
+          tags: |
+            type=ref,event=tag
+            type=ref,event=pr
+            type=raw,value=latest,enable={{is_default_branch}}
+          labels: |
+            maintainer=bitcoindevproject
+            org.opencontainers.image.title=warnet-rpc
+            org.opencontainers.image.description=Warnet RPC server
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push production RPC image
+        uses: docker/build-push-action@v5
+        with:
+          file: src/templates/rpc/Dockerfile_rpc
+          platforms: linux/amd64,linux/arm64
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Build and push dev RPC image
+        if: github.ref == 'refs/heads/main'
+        uses: docker/build-push-action@v5
+        with:
+          file: src/templates/rpc/Dockerfile_rpc_dev
+          platforms: linux/amd64,linux/arm64
+          context: .
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_RPC_REPO }}:dev
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

warnet-0.9.9/.github/workflows/publish-dist.yml

@@ -0,0 +1,94 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/warnet
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+

warnet-0.9.9/.github/workflows/test.yml

@@ -0,0 +1,110 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+  ruff-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # - uses: chartboost/ruff-action@v1
+      # Until this gets updated we need to use this commit hash (or later)
+      - uses: chartboost/ruff-action@491342200cdd1cf4d5132a30ddc546b3b5bc531b
+        with:
+          args: 'format --check'
+          changed-files: 'true'
+  build-image:
+    needs: [ruff, ruff-format]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and export
+        uses: docker/build-push-action@v5
+        with:
+          file: src/warnet/templates/rpc/Dockerfile_rpc
+          context: .
+          tags: warnet/dev
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          outputs: type=docker,dest=/tmp/warnet.tar
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: warnet
+          path: /tmp/warnet.tar
+  test:
+    needs: [build-image]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        test: [scenarios_test.py, rpc_test.py, graph_test.py, ln_test.py, dag_connection_test.py]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: hynek/setup-cached-uv@v1
+      - uses: medyagh/setup-minikube@master
+        with:
+          mount-path: ${{ github.workspace }}:/mnt/src
+      - uses: actions/download-artifact@v4
+        with:
+          name: warnet
+          path: /tmp
+      - run: |
+          echo loading the image directly into minikube docker
+          eval $(minikube -p minikube docker-env)
+          docker load --input /tmp/warnet.tar
+          docker image ls -a
+
+          echo Installing warnet python package for cli
+          uv venv
+          uv pip install -e .
+
+          echo "Contents of warnet-rpc-statefulset-dev.yaml being used:"
+          cat src/warnet/templates/rpc/warnet-rpc-statefulset-dev.yaml
+
+          echo Setting up k8s
+          kubectl apply -f src/warnet/templates/rpc/namespace.yaml
+          kubectl apply -f src/warnet/templates/rpc/rbac-config.yaml
+          kubectl apply -f src/warnet/templates/rpc/warnet-rpc-service.yaml
+          kubectl apply -f src/warnet/templates/rpc/warnet-rpc-statefulset-dev.yaml
+          kubectl config set-context --current --namespace=warnet
+
+          echo sleeping for 30s to give k8s time to boot
+          sleep 30
+          kubectl describe pod rpc-0
+          kubectl logs rpc-0
+
+          echo Waiting for rpc-0 to come online
+          until kubectl get pod rpc-0 --namespace=warnet; do
+             echo "Waiting for server to find pod rpc-0..."
+             sleep 4
+          done
+          kubectl wait --for=condition=Ready --timeout=2m pod rpc-0
+        shell: bash
+      - run: |
+          kubectl port-forward svc/rpc 9276:9276 &
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          ./test/${{matrix.test}}
+  # build-test:
+  #   needs: [build-image]
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: ./.github/actions/compose
+  #     - run: ./test/build_branch_test.py compose

warnet-0.9.9/.gitignore

@@ -0,0 +1,8 @@
+.vscode
+__pycache__
+.venv
+warnet.egg-info
+.python-version
+.env
+dist/
+build/

warnet-0.9.9/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 The Warnet Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

warnet-0.9.9/MANIFEST.in

@@ -0,0 +1,11 @@
+include src/warnet/schema/*.json
+include src/warnet/templates/bitcoin.conf
+include src/warnet/templates/fork_observer_config.toml
+include src/warnet/templates/addrman_observer_config.toml
+include src/warnet/templates/addrman.patch
+include src/warnet/templates/isroutable.patch
+include src/warnet/scripts/quick_start.sh
+graft src/warnet/templates/k8s
+graft src/warnet/templates/rpc
+graft src/warnet/templates/grafana-provisioning
+graft src/warnet/logging_config

warnet-0.9.9/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: warnet
+Version: 0.9.9
+Summary: Monitor and analyze the emergent behaviours of bitcoin networks
+License: MIT
+Project-URL: Homepage, https://warnet.dev
+Project-URL: GitHub, https://github.com/bitcoindevproject/warnet
+Keywords: bitcoin,warnet
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs==23.2.0
+Requires-Dist: blinker==1.7.0
+Requires-Dist: cachetools==5.3.2
+Requires-Dist: certifi==2023.11.17
+Requires-Dist: charset-normalizer==3.3.2
+Requires-Dist: click==8.1.7
+Requires-Dist: docker==7.0.0
+Requires-Dist: flask==3.0.0
+Requires-Dist: flask-jsonrpc==1.1.0
+Requires-Dist: google-auth==2.25.2
+Requires-Dist: idna==3.6
+Requires-Dist: itsdangerous==2.1.2
+Requires-Dist: jinja2==3.1.2
+Requires-Dist: jsonrpcclient==4.0.3
+Requires-Dist: jsonrpcserver==5.0.9
+Requires-Dist: jsonschema==4.20.0
+Requires-Dist: jsonschema-specifications==2023.12.1
+Requires-Dist: kubernetes==28.1.0
+Requires-Dist: markdown-it-py==3.0.0
+Requires-Dist: markupsafe==2.1.3
+Requires-Dist: mdurl==0.1.2
+Requires-Dist: networkx==3.2.1
+Requires-Dist: numpy==1.26.2
+Requires-Dist: oauthlib==3.2.2
+Requires-Dist: oslash==0.6.3
+Requires-Dist: packaging==23.2
+Requires-Dist: pyasn1==0.5.1
+Requires-Dist: pyasn1-modules==0.3.0
+Requires-Dist: pygments==2.17.2
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: referencing==0.32.0
+Requires-Dist: requests==2.29.0
+Requires-Dist: requests-oauthlib==1.3.1
+Requires-Dist: rich==13.7.0
+Requires-Dist: rpds-py==0.16.2
+Requires-Dist: rsa==4.9
+Requires-Dist: six==1.16.0
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: typeguard==2.13.3
+Requires-Dist: typing-extensions==4.9.0
+Requires-Dist: urllib3==1.26.18
+Requires-Dist: websocket-client==1.7.0
+Requires-Dist: werkzeug==3.0.1
+Provides-Extra: build
+Requires-Dist: twine; extra == "build"
+Requires-Dist: build; extra == "build"
+
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/pyproject.toml)
+# 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 from a graphml file.
+* Scenarios can be run across the network which can be programmed using the Bitcoin Core functional [test_framework language](https://github.com/bitcoin/bitcoin/tree/master/test/functional).
+* Nodes can have traffic shaping parameters assigned to them via the graph using [tc-netem](https://manpages.ubuntu.com/manpages/trusty/man8/tc-netem.8.html) tool.
+* Data from nodes can be collected and searched including log files and p2p messages.
+* Performance data from containers can be monitored and visualized.
+* Lightning Network nodes can be deployed and operated.
+* Networks can be deployed using Kubernetes, e.g. via MiniKube (small network graphs) or a managed cluster for larger network graphs.
+
+## Documentation
+
+- [Installation](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/install.md)
+- [Quick Run](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/quickrun.md)
+- [Running Warnet](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/running.md)
+- [Network Topology](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/graph.md)
+- [CLI Commands](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/warcli.md)
+- [Scenarios](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/scenarios.md)
+- [Data Collection](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/data.md)
+- [Monitoring](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/monitoring.md)
+- [Lightning Network](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/lightning.md)
+
+![warnet-art](https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/docs/machines.webp)

warnet-0.9.9/README.md

@@ -0,0 +1,28 @@
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/pyproject.toml)
+# 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 from a graphml file.
+* Scenarios can be run across the network which can be programmed using the Bitcoin Core functional [test_framework language](https://github.com/bitcoin/bitcoin/tree/master/test/functional).
+* Nodes can have traffic shaping parameters assigned to them via the graph using [tc-netem](https://manpages.ubuntu.com/manpages/trusty/man8/tc-netem.8.html) tool.
+* Data from nodes can be collected and searched including log files and p2p messages.
+* Performance data from containers can be monitored and visualized.
+* Lightning Network nodes can be deployed and operated.
+* Networks can be deployed using Kubernetes, e.g. via MiniKube (small network graphs) or a managed cluster for larger network graphs.
+
+## Documentation
+
+- [Installation](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/install.md)
+- [Quick Run](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/quickrun.md)
+- [Running Warnet](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/running.md)
+- [Network Topology](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/graph.md)
+- [CLI Commands](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/warcli.md)
+- [Scenarios](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/scenarios.md)
+- [Data Collection](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/data.md)
+- [Monitoring](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/monitoring.md)
+- [Lightning Network](https://github.com/bitcoin-dev-project/warnet/blob/main/docs/lightning.md)
+
+![warnet-art](https://raw.githubusercontent.com/bitcoin-dev-project/warnet/main/docs/machines.webp)

warnet-0.9.9/docs/data.md

@@ -0,0 +1,42 @@
+# Data Collection
+
+## Bitcoin Core logs
+
+Complete log output from a Bitcoin Core node can be retrieved by RPC `debug-log` using
+its network name and graph node index.
+
+Example:
+
+```
+$ warcli debug-log 0 --network=v25_test
+
+
+2023-10-11T17:54:39.616974Z Bitcoin Core version v25.0.0 (release build)
+2023-10-11T17:54:39.617209Z Using the 'arm_shani(1way,2way)' SHA256 implementation
+2023-10-11T17:54:39.628852Z Default data directory /home/bitcoin/.bitcoin
+... (etc)
+```
+
+## Aggregated logs from all nodes
+
+Aggregated logs can be searched using RPC `grep-logs` with regex patterns.
+
+Example:
+
+```
+$ warcli grep-logs 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d
+
+warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.716582Z [miner] AddToWallet 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d  newupdate
+warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.717787Z [miner] Submitting wtx 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d to mempool for relay
+warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.717929Z [validation] Enqueuing TransactionAddedToMempool: txid=94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d wtxid=0cc875e73bb0bd8f892b70b8d1e5154aab64daace8d571efac94c62b8c1da3cf
+warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.718040Z [validation] TransactionAddedToMempool: txid=94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d wtxid=0cc875e73bb0bd8f892b70b8d1e5154aab64daace8d571efac94c62b8c1da3cf
+warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.723017Z [miner] AddToWallet 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d
+warnet_test_uhynisdj_tank_000007: 2023-10-11T17:44:52.173199Z [validation] Enqueuing TransactionAddedToMempool: txid=94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d wtxid=0cc875e73bb0bd8f892b70b8d1e5154aab64daace8d571efac94c62b8c1da3cf
+warnet_test_uhynisdj_tank_000007: 2023-10-11T17:44:52.173237Z [mempool] AcceptToMemoryPool: peer=0: accepted 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d (poolsz 1 txn, 1 kB)
+warnet_test_uhynisdj_tank_000007: 2023-10-11T17:44:52.173303Z [validation] TransactionAddedToMempool: txid=94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d wtxid=0cc875e73bb0bd8f892b70b8d1e5154aab64daace8d571efac94c62b8c1da3cf
+warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:52.172963Z [mempool] Removed 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d from set of unbroadcast txns
+warnet_test_uhynisdj_tank_000002: 2023-10-11T17:44:52.325655Z [validation] Enqueuing TransactionAddedToMempool: txid=94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d wtxid=0cc875e73bb0bd8f892b70b8d1e5154aab64daace8d571efac94c62b8c1da3cf
+warnet_test_uhynisdj_tank_000002: 2023-10-11T17:44:52.325691Z [mempool] AcceptToMemoryPool: peer=1: accepted 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d (poolsz 1 txn, 1 kB)
+warnet_test_uhynisdj_tank_000002: 2023-10-11T17:44:52.325838Z [validation] TransactionAddedToMempool: txid=94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d wtxid=0cc875e73bb0bd8f892b70b8d1e5154aab64daace8d571efac94c62b8c1da3cf
+... (etc)
+```

warnet-0.9.9/docs/developer-notes.md

@@ -0,0 +1,21 @@
+# Developer notes
+
+## Kubernetes
+
+Kubernetes is running the RPC server as a `statefulSet` which is pulled from a
+container image on a registry. This means that (local) changes to the RPC
+server are **not** reflected on the RPC server when running in Kubernetes,
+unless you **also** push an updated image to a registry and update the
+Kubernetes config files.
+
+To help with this a helper script is provided: [build-k8s-rpc.sh](../scripts/build-k8s-rpc.sh).
+
+This script can be run in the following way:
+
+```bash
+DOCKER_REGISTRY=bitcoindevproject/warnet-rpc TAG=0.1 ./scripts/build-k8s-rpc.sh Dockerfile_rpc
+```
+
+You can optionally specify `LATEST=1` to also include the `latest` tag on docker hub.
+
+Once a new image has been pushed, it should be referenced in [warnet-rpc-statefulset.yaml](../src/warnet/templates/warnet-rpc-statefulset.yaml) in the `image` field.

warnet-0.9.9/docs/graph.md

@@ -0,0 +1,85 @@
+# Warnet Network Topology
+
+Warnet creates a Bitcoin network using a network topology from a [graphml](https://graphml.graphdrawing.org/specification.html) file.
+
+Before any scenarios or RPC commands can be executed, a Warnet network must be started from a graph.
+See [warcli.md](warcli.md) for more details on these commands.
+
+To start a network called `"warnet"` from the [default graph file](../src/graphs/default.graphml):
+```
+warcli network start
+```
+
+To start a network with custom configurations:
+```
+warcli network start <path/to/file.graphml> --network="network_name"
+```
+
+## Creating graphs automatically
+
+Graphs can be created via the graph menu:
+
+```bash
+# show graph commands
+warcli graph --help
+
+# Create a cycle graph of 12 nodes using default Bitcoin Core version (v26.0)
+warcli graph create 12 --outfile=./12_x_v26.0.graphml
+
+# Start network with default name "warnet"
+warcli network start ./12_x_v26.0.graphml
+```
+
+## Warnet graph nodes and edges
+
+Nodes in a Warnet graph MUST have either a `"version"` key or an `"image"` key.
+These dictate what version of Bitcoin Core to deploy in a fiven tank.
+
+Edges without additional properties are interpreted as Bitcoin p2p connections.
+If an edge has additional key-value properties, it will be interpreted as a
+lightning network channel (see [lightning.md](lightning.md)).
+
+## GraphML file specification
+
+### GraphML file format and headers
+```xml
+<?xml version="1.0" encoding="UTF-8"?><graphml xmlns="http://graphml.graphdrawing.org/xmlns">
+  <key id="services"        attr.name="services"         attr.type="string"   for="graph" />
+  <key id="version"         attr.name="version"          attr.type="string"   for="node" />
+  <key id="image"           attr.name="image"            attr.type="string"   for="node" />
+  <key id="bitcoin_config"  attr.name="bitcoin_config"   attr.type="string"   for="node" />
+  <key id="tc_netem"        attr.name="tc_netem"         attr.type="string"   for="node" />
+  <key id="exporter"        attr.name="exporter"         attr.type="boolean"  for="node" />
+  <key id="collect_logs"    attr.name="collect_logs"     attr.type="boolean"  for="node" />
+  <key id="build_args"      attr.name="build_args"       attr.type="string"   for="node" />
+  <key id="ln"              attr.name="ln"               attr.type="string"   for="node" />
+  <key id="ln_image"        attr.name="ln_image"         attr.type="string"   for="node" />
+  <key id="ln_cb_image"     attr.name="ln_cb_image"      attr.type="string"   for="node" />
+  <key id="ln_config"       attr.name="ln_config"        attr.type="string"   for="node" />
+  <key id="channel_open"    attr.name="channel_open"     attr.type="string"   for="edge" />
+  <key id="source_policy"   attr.name="source_policy"    attr.type="string"   for="edge" />
+  <key id="target_policy"   attr.name="target_policy"    attr.type="string"   for="edge" />
+  <graph edgedefault="directed">
+    <!-- <nodes> -->
+    <!-- <edges> -->
+  </graph>
+</graphml>
+```
+
+| key            | for   | type    | default   | explanation                                                                                                                                                         |
+|----------------|-------|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| services       | graph | string  |           | A space-separated list of extra service containers to deploy in the network. See [docs/services.md](services.md) for complete list of available services            |
+| version        | node  | string  |           | Bitcoin Core version with an available Warnet tank image on Dockerhub. May also be a GitHub repository with format user/repository:branch to build from source code |
+| image          | node  | string  |           | Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag                                                                                    |
+| bitcoin_config | node  | string  |           | A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly'                                                                              |
+| tc_netem       | node  | string  |           | A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem'                                                                                    |
+| exporter       | node  | boolean | False     | Whether to attach a Prometheus data exporter to the tank                                                                                                            |
+| collect_logs   | node  | boolean | False     | Whether to collect Bitcoin Core debug logs with Promtail                                                                                                            |
+| build_args     | node  | string  |           | A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests'                                                |
+| ln             | node  | string  |           | Attach a lightning network node of this implementation (currently only supports 'lnd')                                                                              |
+| ln_image       | node  | string  |           | Specify a lightning network node image from Dockerhub with the format repository/image:tag                                                                          |
+| ln_cb_image    | node  | string  |           | Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag                                                                             |
+| ln_config      | node  | string  |           | A string of arguments for the lightning network node in command-line format, e.g. '--protocol.wumbo-channels --bitcoin.timelockdelta=80'                            |
+| channel_open   | edge  | string  |           | Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel                                                                       |
+| source_policy  | edge  | string  |           | Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy                                                                      |
+| target_policy  | edge  | string  |           | Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy                                                                         |