diff --git a/README.md b/README.md index ecf9ffa9dce009236a176448eac4632e06f0113f..2418af57a73b61082d7810cd3dc619ac2ac215ca 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# symbolic_execution -A symbolic executor +# Chaussette: A symbolic execution tool for Bitcoin scripts +A symbolic executor for Bitcoin scripts. + +Please refer to the [official paper](https://orbi.uliege.be/handle/2268/305862) for an overview of the tool and results obtained with it. + +## Run the tool on the preconfigures tests +The best way to start playing with the tool is probably to look at the tests located at [tests/language/bitcoin/test_parser.py](tests/language/bitcoin/test_parser.py). + +Once [Docker](https://docs.docker.com/engine/install/) is installed, those tests can easily be run with the following command: +``` +make +``` + +More information on make is available at [gnu.org](https://www.gnu.org/software/make/). + +This prior command will take care of generating a container with all the necessary libraries to run the code. + +Our tool is known to have a very low rate of false positives and negatives (refer to the paper), but still contain some. Some tests which are currently encoded are expected to fail. Currently, I haven't plan to fix those errors. + + \ No newline at end of file diff --git a/pics/failed_tests_screenshot.png b/pics/failed_tests_screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..05d8d83740bd6ec486a65a9241d64889f0eece26 Binary files /dev/null and b/pics/failed_tests_screenshot.png differ