KEVM: Semantics of EVM in K

In this repository we provide a model of the EVM in K.

Documentation/Support

These may be useful for learning KEVM and K (newest to oldest):

To get support for KEVM, please join our Riot Room.

Repository Structure

The following files constitute the KEVM semantics:

  • network.md provides the status codes which are reported to an Ethereum client on execution exceptions.
  • json-rpc.md is an implementation of JSON RPC in K.
  • evm-types.md provides the (functional) data of EVM (256 bit words, wordstacks, etc...).
  • serialization.md provides helpers for parsing and unparsing data (hex strings, recursive-length prefix, merkle trees, etc.).
  • evm.md is the main KEVM semantics, containing the configuration and transition rules of EVM.

These additional files extend the semantics to make the repository more useful:

  • buf.md defines the #buf byte-buffer abstraction for use during symbolic execution.
  • abi.md defines the Contract ABI Specification for use in proofs and easy contract/function specification.
  • hashed-locations.md defines the #hashedLocation abstraction which makes it easier to specify Solidity-generate storage layouts.
  • edsl.md combines the previous three abstractions for ease-of-use.
  • state-loader.md provides functionality for EVM initialization and setup.
  • driver.md is an execution harness for KEVM, providing a simple language for describing tests/programs.

Installing/Building

K Backends

There are three backends of K available: LLVM (default) for concrete execution and Java (default) and Haskell for symbolic execution. This repository generates the build-products for each backend in .build/defn/.

System Dependencies

The following are needed for building/running KEVM:

For the exact dependencies check the Dockerfile.

Installing Z3

KEVM requires Z3 version 4.8.11, which you may need to install from a source build if your package manager supplies a different version. To do so, follow the instructions here after checking out the correct tag in the Z3 repository:

git clone https://github.com/Z3Prover/z3.git
cd z3
git checkout z3-4.8.11
python scripts/mk_make.py
cd build
make
sudo make install

Ubuntu

On Ubuntu >= 18.04 (for example):

sudo apt-get install --yes                                                             \
            autoconf bison clang-10 cmake curl flex gcc jq libboost-test-dev           \
            libcrypto++-dev libffi-dev libgflags-dev libjemalloc-dev libmpfr-dev       \
            libprocps-dev libsecp256k1-dev libssl-dev libtool libyaml-dev lld-10       \
            llvm-10-tools make maven netcat-openbsd openjdk-11-jdk pkg-config          \
            protobuf-compiler python3 python-pygments rapidjson-dev time zlib1g-dev

On Ubuntu < 18.04, you'll need to skip libsecp256k1-dev and instead build it from source (via our Makefile):

make libsecp256k1

Arch Linux

On ArchLinux:

sudo pacman -S                                               \
    base base-devel boost clang cmake crypto++ curl git gmp  \
    gflags jdk-openjdk jemalloc libsecp256k1 lld llvm maven  \
    mpfr protobuf python stack yaml-cpp zlib

MacOS

On OSX, using Homebrew, after installing the command line tools package:

brew tap homebrew/cask
brew install --cask java
brew install automake libtool gmp mpfr pkg-config maven libffi openssl protobuf python
make libsecp256k1

NOTE: Previous versions of these instructions required the user to use either the homebrew version of flex or the xcode command line tools version, with the wrong option giving an error. The current recommendation is to use the homebrew version.

Haskell Stack (all platforms)

  • Haskell Stack. Note that the version of the stack tool provided by your package manager might not be recent enough. Please follow installation instructions from the Haskell Stack website linked above.

To upgrade stack (if needed):

stack upgrade
export PATH=$HOME/.local/bin:$PATH

Build Dependencies

K Framework

The Makefile and kevm will work with either a (i) globally installed K, or (ii) a K submodule included in this repository. If you want to use the K submodule, follow these instructions get the submodule and build K:

git submodule update --init --recursive -- deps/k
make k-deps

If you don't need either the LLVM or Haskell backend, there are flags to skip them:

make k-deps SKIP_LLVM=true SKIP_HASKELL=true

Blockchain Plugin

You also need to get the blockchain plugin submodule and install it.

git submodule update --init --recursive -- deps/plugin
make plugin-deps

Building

Finally, you can build the semantics.

make build

Running Tests

The tests are run using the supplied Makefile. First, run make split-tests to generate some of the tests from the markdown files.

The following subsume all other tests:

  • make test: All of the quick tests.
  • make test-all: All of the quick and slow tests.

These are the individual test-suites (all of these can be suffixed with -all to also run slow tests):

When running tests with the Makefile, you can specify the TEST_CONCRETE_BACKEND (for concrete tests), or TEST_SYMBOLIC_BACKEND (for proofs).

For Developers

After building, the kevm executable will be located in the .build/usr/bin:$PATH directory . The one in the project root is a build artifact, don't use it. To make sure you are using the correct kevm, add this directory to your PATH:

export PATH=$(pwd)/.build/usr/bin:$PATH

Alternatively, if you work on multiple checkouts of evm-semantics, or other semantics, you could add the relative path .build/usr/bin to your PATH. Do note, however, that this is a security concern.

You can call kevm help to get a quick summary of how to use the script.

Run the file tests/ethereum-tests/LegacyTests/Constantinople/VMTests/vmArithmeticTest/add0.json:

kevm run tests/ethereum-tests/LegacyTests/Constantinople/VMTests/vmArithmeticTest/add0.json --schedule DEFAULT --mode VMTESTS

To run proofs, you can similarly use kevm. For example, to prove one of the specifications:

kevm prove tests/specs/erc20/ds/transfer-failure-1-a-spec.k --verif-module VERIFICATION

You can also debug proofs interactively:

kevm prove tests/specs/erc20/ds/transfer-failure-1-a-spec.k --verif-module VERIFICATION --debugger --debug-script kscript --backend haskell

Here, kscript is a file containing kore-repl commands. For example, we advise to put an alias for outputting the current configuration as a pretty-printed term (as opposed to raw kore term):

alias konfig = config | kast -i kore -o pretty -d .build/usr/lib/kevm/haskell /dev/stdin

Keeping .build up-to-date while developing

  • make build needs to be re-run if you touch any of this repos files.
  • make deps needs to be re-run if there is a submodule update (you did git submodule update --init --recursive and it actually did something).
  • If both deps and build need to be re-run, you need to do deps first.
  • make clean is a safe way to remove the .build directory, but then you need to re-run make deps (should be quick this time) and make build.

Media

This repository can build two pieces of documentation for you, the Jello Paper and the 2017 Devcon3 presentation.

System Dependencies

For the presentations in the media directory, you'll need pdflatex, commonly provided with texlive-full, and pandoc.

sudo apt install texlive-full pandoc

Building

To build all the PDFs (presentations and reports) available in the media/ directory, use:

make media

Resources

For more information about The K Framework, refer to these sources: