btcs

bitcoin script parser/evaluator/compiler/decompiler
git clone git://jb55.com/btcs
Log | Files | Refs | README | LICENSE

README.md (866B)

      1 
      2 # btcs
      3 
      4 [![Build Status](https://travis-ci.org/jb55/btcs.svg)](https://travis-ci.org/jb55/btcs)
      5 
      6   bitcoin script parser/evaluator/compiler/decompiler
      7 
      8   **WARNING**: This is not a consensus-critical implementation of
      9   bitcoin script. Make sure to actually test your script on testnet or
     10   with something like [btcdeb](https://github.com/kallewoof/btcdeb).
     11 
     12 ## Motivation
     13 
     14   I wanted a better way to hack on Bitcoin scripts
     15 
     16 ## Installing
     17 
     18 deps: `python3`, `bison`, `flex`, a C compiler
     19 
     20     $ make install
     21 
     22 with nix:
     23 
     24     $ nix-env -if .
     25 
     26 ## TODOs
     27 
     28 - [X] Tokenizer
     29 - [ ] Evaluator (partially complete)
     30 - [X] Compiler
     31 - [X] Decompiler
     32 - [X] Docs
     33 
     34 ## Usage
     35 
     36   Work in progress. Some OPs are working:
     37 
     38 ```
     39 $ btcs 1 2 16 3dup 2swap
     40 
     41 script      1 2 16 OP_3DUP OP_2SWAP
     42 script_hex  5152606f72
     43 stack       1 2 2 16 16 1
     44 stack_hex   010202101001
     45 results     success
     46 ```