A work-in-progress Bitcoin Script execution utility.
DISCLAIMER: DO NOT EVER, EVER, TRY TO USE THIS CRATE FOR CONSENSUS PURPOSES !!
This project is a work-in-progress mostly attempting to facilitate BitVM development. It does not yet fully implement all opcodes, but as a library already gives you pretty good insight into the internals of the execution in a step-wise manner.
You can simply use cargo run or build/intall the binary as follows:
# to build in debug mode
$ cargo build --locked
# to build in release (optimized) mode
$ cargo build --locked --release
# to install in ~/.cargo/bin
$ cargo install --locked --path .
The CLI currently takes only a single argument: the path to the ASM script file:
# using the binary
$ btcexec <script.bs>
# using cargo run
$ cargo run -- <script.bs>
There are wasm bindings provided. For API documentation, see the src/wasm.rsa file.
To build the WASM bindings, install wasm-pack and then run the following script:
./build-wasm.sh
This project is licensed under the MIT License - see LICENSE file for details.
This repository is a component of the BitVMX Ecosystem, an open platform for disputable computation secured by Bitcoin.
You can find the index of all BitVMX open-source components at FairgateLabs/BitVMX.