BitVMX is a cutting-edge platform designed to optimistically execute arbitrary programs on Bitcoin, leveraging the N-party disputable computation paradigm introduced by BitVM. This repository lists all open-source components that make up the BitVMX ecosystem, from the core protocol and client libraries to tools and examples.
⚠️ Disclaimer:
All projects are currently under active development. They are not production-ready, not audited, and may introduce breaking changes without backward compatibility in future updates.
| Project | Description |
|---|---|
| BitVMX Client | Core client for interacting with the BitVMX protocol and the Bitcoin blockchain. |
| BitVMX-CPU | The execution engine for BitVMX programs. Refer to the BitVMX website and whitepaper for details. |
| BitVMX Protocol Builder | Constructs Directed Acyclic Graphs (DAGs) of pre-signed Bitcoin transactions representing protocol execution paths. |
| BitVMX ZK-Proof | Provides Zero-Knowledge proof generation for integration with BitVMX protocols. |
| BitVMX Storage Backend | Unified storage management layer for BitVMX components. |
| Project | Description |
|---|---|
| BitVMX Key Manager | Comprehensive Rust library for managing cryptographic keys and aggregated signatures used in BitVMX transactions. |
| BitVMX Wallet | Bitcoin wallet implementation tailored for the BitVMX ecosystem. |
| Project | Description |
|---|---|
| Bitcoin Coordinator | Manages and monitors transaction activity within the Bitcoin network. |
| Bitcoin Indexer | Extracts and stores Bitcoin block and transaction IDs for fast access and analysis. |
| BitVMX Transaction Monitor | Monitors and manages multiple types of transaction watchers across the Bitcoin network. |
| BitVMX Bitcoin RPC | Lightweight Rust interface for interacting with a Bitcoin Core node. |
| Project | Description |
|---|---|
| Rust BitVMX Broker | Message broker implementing synchronous and bidirectional communication channels between BitVMX clients. |
| BitVMX Operator Comms | Operator communication layer built on top of the BitVMX Broker. |
| BitVMX Settings | Configuration management library supporting environment variables and file-based settings. |
| Project | Description |
|---|---|
| bitcoin-scriptexec | Bitcoin Script execution utility for testing and debugging. |
| Rust Bitcoin Docker | Rust library for running and managing Bitcoin Core in Docker containers. |
| Docker RISCV32 Build Environment | Provides the RISC-V 32-bit toolchain for building programs runnable on the BitVMX-CPU. |
| Project | Description |
|---|---|
| BitVMX – Add Numbers Game | A demonstration game where two players compete to solve an addition challenge using BitVMX verification logic. |
The bitvmx_protocol PoC has been deprecated and is no longer maintained or improved. If what you're looking for is the BitVMX platform, please go to BitVMX Client
We welcome contributions from the community to help expand and improve the BitVMX ecosystem.
Before contributing, please take a moment to read the following guidelines.
If you discover a bug, security issue, or unexpected behavior:
- Open an issue in the corresponding repository.
- Describe the problem clearly, including steps to reproduce, expected behavior, and relevant logs or screenshots.
- Tag the issue appropriately (e.g.,
bug,enhancement,documentation).
We’re continuously improving the protocols, libraries, and tooling.
Feature proposals or design suggestions are encouraged, open a GitHub issue or discussion outlining:
- The motivation behind your idea.
- How it fits within the BitVMX architecture.
- Possible implementation approaches.
To submit a code contribution:
- Fork the target repository.
- Create a feature branch (
git checkout -b feature/my-improvement). - Implement and document your changes.
- Run the tests and ensure all checks pass.
- Submit a pull request with a clear summary and link to any related issues.
🧩 Note: All contributions should follow the existing Rust formatting and linting conventions (
cargo fmt,cargo clippy).
Contributors are expected to maintain a respectful, collaborative, and inclusive environment.
Disagreements are natural; disrespect is not. Please keep all interactions constructive and professional.
All BitVMX projects are distributed under the MIT License.
By contributing, you agree that your code will be released under the same license.
Visit bitvmx.org for documentation, articles, and technical overviews of BitVMX and ongoing research