Dev

.gitignore

@@ -25,3 +25,6 @@ tests/resources/
 # checkpoints
 *.json
 .DS_Store
+
+# Test error log
+_coin/reference_tests/error.log

README.md

@@ -13,7 +13,7 @@ It is not production-ready, has not been audited, and future updates may introdu
 ## Structure
 
 The repository contains three folders
-1. **docker-riscv32**: Contains the recipe for an image that allows the compilation of C programs into the RISCV-32i architecture. Currently, the programs must be carefully crafted to be used inside BitVMX, using specific memory layouts, predefined input sections and the lack of support for now of the stdlib.  
+1. **docker-riscv32**: Contains the recipe for an image that allows the compilation of C programs into the RISCV-32i architecture. Currently, the programs must be carefully crafted to be used inside BitVMX, using specific memory layouts and predefined input sections. There is now the possibility to compile with the stdlib, it is not fully tested and may cause problems if it uses unimplemented syscalls.
 There are two subfolders: `compliance` which have the code necessary to create the RISCV compliance verification files, and `verifier` which helps with the compilation of a zero knowledge proof verifier program.
 2. **emulator**: The emulator is a library with a command line interface implemented in Rust which is used to execute the binary files compiled. Also this tool helps in the creation of the execution trace, the hash list of the execution necessary for the challenge protocol.
 3. **bitocoin-script-riscv**: This library contains the code that allows to verify any of the RISCV instructions on Bitcoin Script, and therefore challenge the execution of the CPU on-chain.  

_coin/compliance_tests/.gitignore

@@ -0,0 +1 @@
+build

_coin/compliance_tests/Dockerfile

@@ -0,0 +1,4 @@
+FROM riscv32:latest
+
+WORKDIR /riscv-tests
+

_coin/compliance_tests/README.md

@@ -0,0 +1,44 @@
+# RISC-V Compliance Tests
+
+This directory contains compliance tests that extend the tests from [riscv-tests](https://github.com/riscv-software-src/riscv-tests).
+
+## Building and Running Tests
+
+### 1. Build the Docker Image
+
+```bash
+docker build -t riscv-coin .
+```
+
+### 2. Compile the Tests
+
+```bash
+sudo ./docker-run-coin-compliance.sh riscv-coin ./build_all.sh
+```
+
+### 3. Run the Tests
+
+```bash
+./run_tests.sh
+```
+
+To verify that all scripts provide the same result in Bitcoin, use the `--verify` flag:
+
+```bash
+./run_tests.sh --verify
+```
+
+## Understanding Test Failures
+
+When tests fail, they will output something like `halt(5,200)`. To identify which test is failing:
+
+1. Take the first number (5 in this example)
+2. Subtract 1: `5 - 1 = 4`
+3. Divide by 2: `4 / 2 = 2`
+
+The result (2) is the test number that is failing.
+
+## Options
+
+- `./run_tests.sh` - Run tests without Bitcoin verification (faster)
+- `./run_tests.sh --verify` - Run tests with Bitcoin verification (slower but more thorough)

_coin/compliance_tests/build.sh

@@ -0,0 +1,3 @@
+$CC -static -march=rv32g -mabi=ilp32 -nostdlib -nostartfiles -Wl,--no-warn-rwx-segments -I./ -I./../../ -I/riscv-tests/isa/macros/scalar/ -T./linker/link.ld -o build/$1.elf /riscv-tests/isa/rv32ui/$1.S
+$QEMU -d in_asm -D build/$1.s build/$1.elf
+$DUMP -d build/$1.elf > build/$1_dump.s

_coin/compliance_tests/build_all.sh

@@ -0,0 +1,17 @@
+echo "Executing build_all.sh"
+chmod +x build.sh
+chmod +x build_mul.sh
+dos2unix build.sh
+dos2unix build_mul.sh
+
+for f in /riscv-tests/isa/rv32ui/*.S; do
+  filename=$(basename "${f%.*}")
+  echo $filename
+  ./build.sh $filename
+done
+
+for f in /riscv-tests/isa/rv32um/*.S; do
+  filename=$(basename "${f%.*}")
+  echo $filename
+   ./build_mul.sh $filename
+done

_coin/compliance_tests/build_mul.sh

@@ -0,0 +1,3 @@
+$CC -static -march=rv32g -mabi=ilp32 -nostdlib -nostartfiles -Wl,--no-warn-rwx-segments -I./ -I./../../ -I/riscv-tests/isa/macros/scalar/ -T./linker/link.ld -o build/$1.elf /riscv-tests/isa/rv32um/$1.S
+$QEMU -d in_asm -D build/$1.s build/$1.elf
+$DUMP -d build/$1.elf > build/$1_dump.s

_coin/compliance_tests/docker-run-coin-compliance.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Check if at least two arguments are provided
+if [ $# -lt 2 ]; then
+    echo "Usage: $0 container_name script_name [arguments]"
+    exit 1
+fi
+
+# Extract the first and second arguments
+container_name="$1"
+script_name="$2"
+
+# Collect all remaining arguments (starting from the third)
+arguments="${@:3}"
+
+echo "Using $container_name to execute script $script_name with arguments: $arguments"
+
+docker run --rm -it --name riscv-coin \
+	  -v "$PWD":/riscv-tests \
+	  riscv-coin:latest \
+    	  sh -c "chmod +x /riscv-tests/$script_name && /riscv-tests/$script_name $arguments"

_coin/compliance_tests/env/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012-2015, The Regents of the University of California (Regents).
+All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the Regents nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
+SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING
+OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF REGENTS HAS
+BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED
+HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE
+MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.