pyproject.toml

# The MIT License (MIT)

# Copyright (c) 2021-2026 Krux contributors

# 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.

[project]
name = "krux"
version = "26.08.0"
description = "Open-source signing device firmware for Bitcoin"
authors = [{ name = "Jeff S", email = "jeffreesun@protonmail.com" }]
readme = "README.md"
license = { text = "MIT" }
requires-python = ">=3.11.5, <3.13"
dependencies = [
    "embit",
    "uUR",
]

[project.optional-dependencies]
docs = [
    "mkdocs>=1.6.1,<2",
    "mkdocs-material>=9.7.5,<10",
    "mkdocs-static-i18n>=1.3.1,<2",
    "pymdown-extensions>=10.21,<11",
    "mkdocs-macros-plugin>=1.5.0,<2",
]
simulator = [
    "numpy>=2.4.3,<3",
    "opencv-python>=4.13.0.92,<5",
    "Pillow>=12.2.0,<13",
    "pygame>=2.6.1,<3",
    "pyzbar>=0.1.9,<1",
]
flash = [
    "pyserial>=3.5,<4",
]
sign = [
    "qrcode>=8.2,<9",
]

[dependency-groups]
dev = [
    "black>=26.3.1,<27",
    "pylint>=4.0.5,<5",
    "pytest>=9.0.2,<10",
    "pytest-cov>=7.0.0,<8",
    "pytest-mock>=3.15.1,<4",
    "PyQRCode>=1.2.1,<2",
    "pycryptodome>=3.23.0,<4",
    "poethepoet>=0.42.1,<1",
    "vulture>=2.15,<3",
    "urllib3>=2.6.3",
]

# krux is firmware, not a distributable Python package
[tool.uv]
package = false

[tool.uv.sources]
embit = { path = "vendor/embit", editable = true }
# Native BC-UR module, the same cUR sources the devices run. Not editable: it is
# a C extension, so it has to be rebuilt (uv sync --reinstall-package uUR) after
# changing the submodule anyway.
uUR = { path = "firmware/MaixPy/components/micropython/port/src/bc-ur" }

[tool.pytest.ini_options]
pythonpath = ["src"]

[tool.poe.env]
PYTHONPATH = "${POE_ROOT}/src${PYTHONPATH:+:${PYTHONPATH}}"

[tool.poe.tasks]
# format tasks
format-src = "black src"
format-tests = "black tests"
format-scripts = "black firmware/font firmware/scripts i18n/*.py"
format = ["format-src", "format-tests", "format-scripts"]
# aliases
black.ref = "format"
format-test.ref = "format-tests"

# pylint tasks
lint-src = "pylint src"
lint-scripts = "pylint firmware/font/*.py firmware/scripts/*.py i18n/*.py"
lint = ["lint-src", "lint-scripts"]
# aliases
pylint.ref = "lint"

# vulture tasks
vulture-src = "vulture src"
vulture.ref = "vulture-src vulture_whitelist.py"
vulture-make = { shell = "vulture src --make-whitelist > vulture_whitelist.py" }
vulture-whitelist.ref = "vulture-make"

# secp256k1 tasks
# Builds the libsecp256k1-zkp pinned by the embit submodule and drops it where
# embit's ctypes backend looks for it. Without it embit falls back to its pure
# Python EC implementation, which is slower and does not always behave like the
# C library the firmware runs.
secp256k1-build = { shell = """
make -C vendor/embit/secp256k1
mkdir -p vendor/embit/src/embit/util/prebuilt
cp vendor/embit/secp256k1/build/libsecp256k1_* vendor/embit/src/embit/util/prebuilt/
""" }
secp256k1-check = { shell = '''python -c "
import sys
from embit.util import secp256k1

using_c = hasattr(secp256k1, '_secp')
print('embit secp256k1 backend:', 'C library' if using_c else 'pure Python')
sys.exit(0 if using_c else 1)
"''' }

# test tasks
test-clean = """python -c 'import shutil, os; os.path.exists("htmlcov") and shutil.rmtree("htmlcov")'"""
test-cov = "pytest --cache-clear --cov src/krux --cov-report html ./tests --cov-context=test --cov-report term-missing"
test-verbose = "pytest --cache-clear --cov src/krux --cov-report html --show-capture all --capture tee-sys -r A ./tests"
test-simple = "pytest --cache-clear ./tests"
# aliases
tests = ["test-clean", "test-cov"]
test.ref = "tests"
pytest.ref = "tests"

# pre commit task (do formatting, linting and tests)
pre-commit = ["format", "lint", "i18n validate", "vulture", "test-simple"]
pre-release = ["format", "lint", "i18n validate", "i18n-build", "update-glyphs", "vulture", "test-simple"]

# run docs locally
docs = "mkdocs serve --livereload"

# translations tasks
i18n = "python i18n/i18n.py"
i18n-bake = "python i18n/i18n.py clean prettify bake"
format-translations = "black src/krux/translations/*.py"
i18n-build = ["i18n-bake", "format-translations", "i18n validate"]
# aliases
translations.ref = "i18n-build"

# simulator tasks
# tasks below accept additional arguments
simulator-amigo = "python simulator/simulator.py --device maixpy_amigo"
simulator-m5stickv = "python simulator/simulator.py --device maixpy_m5stickv"
simulator-dock = "python simulator/simulator.py --device maixpy_dock"
simulator-yahboom = "python simulator/simulator.py --device maixpy_yahboom"
simulator-cube = "python simulator/simulator.py --device maixpy_cube"
simulator-wonder-mv = "python simulator/simulator.py --device maixpy_wonder_mv"
simulator-tzt = "python simulator/simulator.py --device maixpy_tzt"
simulator-wonder-k = "python simulator/simulator.py --device maixpy_wonder_k"
simulator-embed-fire = "python simulator/simulator.py --device maixpy_embed_fire"
# aliases
simulator.ref = "simulator-amigo"
simulator-m5.ref = "simulator-m5stickv"
simulator-mv.ref = "simulator-wonder-mv"
simulator-wonder.ref = "simulator-wonder-mv"
simulator-wondermv.ref = "simulator-wonder-mv"
simulator-wonderk.ref = "simulator-wonder-k"
simulator-k.ref = "simulator-wonder-k"
simulator-embed.ref = "simulator-embed-fire"
simulator-embedfire.ref = "simulator-embed-fire"

# git tasks
git-update = "git submodule update --init --recursive"
git-pull = "git pull git@github.com:selfcustody/krux.git"
git-pull-https = "git pull https://github.com/selfcustody/krux.git"

# ktool tasks
ktool-cmd = "python firmware/Kboot/build/ktool.py -b 2000000"
flash-cmd.ref = "ktool-cmd build/kboot.kfpkg"
flash.ref = "flash-cmd -B goE"
flash-dock.ref = "flash-cmd -B dan"
boot-cmd.ref = "ktool-cmd -s build/firmware.bin"
boot.ref = "boot-cmd -B goE"
boot-dock.ref = "boot-cmd -B dan"
terminal.ref = "ktool-cmd -T" # for yahboom add param: --reset
erase.ref = "ktool-cmd -B goE -E"
erase-dock.ref = "ktool-cmd -B dan -E"

# task for bdftokff font glyphs update
update-glyphs = "python ./firmware/font/bdftokff.py True"
glyphs.ref = "update-glyphs"
fonts.ref = "update-glyphs"

# task for sign_release?
# python sign_release.py

# task for missing glyphs
missing-glyphs = "python ./firmware/font/missing_glyphs.py"
fonts-missing.ref = "missing-glyphs"
missing.ref = "missing-glyphs"