Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BitVM/rust-bitcoin-scriptexec
Bitcoin Script interpreter implemented in Rust
https://github.com/BitVM/rust-bitcoin-scriptexec
Last synced: 3 months ago
JSON representation
Bitcoin Script interpreter implemented in Rust
- Host: GitHub
- URL: https://github.com/BitVM/rust-bitcoin-scriptexec
- Owner: BitVM
- License: cc0-1.0
- Created: 2023-10-31T18:01:11.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-02T12:41:58.000Z (11 months ago)
- Last Synced: 2024-04-03T09:28:34.510Z (11 months ago)
- Language: Rust
- Homepage:
- Size: 173 KB
- Stars: 34
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bitvm - Bitcoin Script interpreter implemented in Rust
README
bitcoin-scriptexec
==================
A work-in-progress Bitcoin Script execution utility.
**DISCLAIMER: DO NOT EVER, EVER, TRY TO USE THIS CRATE FOR CONSENSUS PURPOSES !!**
# Status
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.
# Usage
## CLI
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 .
```
### Usage
The CLI currently takes only a single argument: the path to the ASM script file:
```
# using the binary
$ btcexec
# using cargo run
$ cargo run --
```
## WASM
There are wasm bindings provided. For API documentation, see the `src/wasm.rs`a file.
To build the WASM bindings, [install wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
and then run the following script:
```
./build-wasm.sh
```