/bitvm

Python wrapper around BitVM's Rust implementation

Primary LanguageRustMIT LicenseMIT

BitVM

Bitcoin-only Package vesion Format Python version License Code size Top Languages Repository size Last commit

BitVM banner

Vulpes Macrotis, henceforth VM, is better known as Kit Fox or Kitsune. BitVM is the brainchild of the amazing people at ZeroSync and this is only an attempted Python library using Rust bidings available via PyO3 package.

Contributions

To contribute to the project, fork the repository and clone to your local device and development dependencies including four extra libraries not included in final builds as such:

  • maturin Build and publish crates with pyo3, rust-cpython and cffi bindings as well as rust binaries as python packages GitHub PyPI Docs
  • mypy Optional static typing for Python GitHub PyPI Docs
  • pytest The pytest framework makes it easy to write small tests, yet scales to support complex functional testing GitHub PyPI Docs
  • ruff An extremely fast Python linter and code formatter, written in Rust. GitHub PyPI Docs

Use the following commands to setup your local environment with development dependencies:

pip install --user poetry
poetry install --with dev

Acknowledgements

License

This project is licensed under the terms of the MIT license.