File tree 1 file changed +39
-3
lines changed
1 file changed +39
-3
lines changed Original file line number Diff line number Diff line change 2
2
bitcoin-scriptexec
3
3
==================
4
4
5
- A Bitcoin Script execution utility.
5
+ A work-in-progress Bitcoin Script execution utility.
6
6
7
+ ** DISCLAIMER: DO NOT EVER, EVER, TRY TO USE THIS CRATE FOR CONSENSUS PURPOSES !!**
8
+
9
+
10
+ # Status
11
+
12
+ This project is a work-in-progress mostly attempting to facilitate BitVM development.
13
+ It does not yet fully implement all opcodes, but as a library already gives you pretty
14
+ good insight into the internals of the execution in a step-wise manner.
7
15
8
16
9
17
# Usage
10
18
11
- Currently, just install ` cargo ` and run following command:
19
+ ## CLI
20
+
21
+ You can simply use ` cargo run ` or build/intall the binary as follows:
22
+
23
+ ```
24
+ # to build in debug mode
25
+ $ cargo build --locked
26
+ # to build in release (optimized) mode
27
+ $ cargo build --locked --release
28
+ # to install in ~/.cargo/bin
29
+ $ cargo install --locked --path .
30
+ ```
31
+
32
+ ### Usage
33
+
34
+ The CLI currently takes only a single argument: the path to the ASM script file:
35
+
12
36
```
13
- $ cargo run -- <filename-with-script-asm.bs>
37
+ # using the binary
38
+ $ btcexec <script.bs>
39
+ # using cargo run
40
+ $ cargo run -- <script.bs>
14
41
```
15
42
43
+ ## WASM
44
+
45
+ There are wasm bindings provided. For API documentation, see the ` src/wasm.rs ` a file.
16
46
47
+ To build the WASM bindings, [ install wasm-pack] ( https://rustwasm.github.io/wasm-pack/installer/ )
48
+ and then run the following script:
49
+
50
+ ```
51
+ ./build-wasm.sh
52
+ ```
You can’t perform that action at this time.
0 commit comments