Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 2.66 KB

developer-notes.md

File metadata and controls

105 lines (71 loc) · 2.66 KB

Developer notes

Contributing / Local Warnet Development

Download the code repository

git clone https://github.com/bitcoin-dev-project/warnet
cd warnet

Recommended: use a virtual Python environment such as venv

python3 -m venv .venv # Use alternative venv manager if desired
source .venv/bin/activate
pip install --upgrade pip
pip install -e .

Formatting & linting

This project primarily uses the uv python packaging tool: https://docs.astral.sh/uv/ along with the sister formatter/linter ruff https://docs.astral.sh/ruff/

Refer to the uv documentation for installation methods: https://docs.astral.sh/uv/getting-started/installation/

With uv installed you can add/remove dependencies using uv add <dep> or uv remove <dep>. This will update the [uv.lock`](https://docs.astral.sh/uv/guides/projects/#uvlock) file automatically.

We use ruff version 0.11.0 in this project currently. This can be installed as a stand-alone binary (see documentation), or via uv using:

# install
$ uv tool install ruff@0.11.0

# lint
$ uvx ruff@0.11.0 check .

# format
$ uvx ruff@0.11.0 format .

Release process

Once a tag is pushed to GH this will start an image build using the tag

Prerequisites

  • Update version in pyproject.toml
  • Tag git with new version
  • Push tag to GitHub

Manual Builds

# Install build dependencies
pip install -e .[build]

# Remove previous release metadata
rm -i -Rf build/ dist/

# Build wheel
python3 -m build

Upload

# Upload to Pypi
python3 -m twine upload dist/*

Building docker images

The Bitcoin Core docker images used by warnet are specified in the docker-bake.hcl file. This uses the (experimental) bake build functionality of docker buildx. We use HCL language in the declaration file itself. See the bake documentation for more information on specifications, and how to e.g. override arguments.

In order to build (or "bake") a certain image, find the image's target (name) in the docker-bake.hcl file, and then run docker buildx bake <target>.

# build the  dummy image that will crash on 5k invs
docker buildx bake bitcoin-5k-inv

# build the same image, but set platform to only linux/amd64
docker buildx bake bitcoin-5k-inv --set bitcoin-5k-inv.platform=linux/amd64

To load the single-platform build result to docker images, run:

docker buildx bake --load bitcoin-5k-inv

Push the build result to a registry by running:

docker buildx bake --push bitcoin-5k-inv

It will automatically push the build result to registry.