zkSync Era is a layer 2 rollup that uses zero-knowledge proofs to scale Ethereum without compromising on security or decentralization. As it's EVM-compatible (with Solidity/Vyper), 99% of Ethereum projects can redeploy without needing to refactor or re-audit any code. zkSync Era also uses an LLVM-based compiler that will eventually enable developers to write smart contracts in popular languages such as C++ and Rust.
This directory and its sub-directories contain the source code for the zkEVM fork of the LLVM framework, a toolkit for the construction of highly optimized compilers, optimizers, and run-time environments used by the Solidity and Vyper compilers developed by Matter Labs.
Welcome to the zkEVM LLVM project!
The project has multiple components. The core of the project is
the llvm directory. This contains all of the tools, libraries, and header
files needed to process intermediate representations and convert them into
object files. Tools include an assembler, disassembler, bitcode analyzer, and
bitcode optimizer. These tools are not yet officially supported for third-party front-ends.
It also contains zkEVM modifications of the standard LLVM regression tests.
The zkEVM back-end is called EraVM, and the architecture is called eravm.
The zkEVM LLVM framework must be built with our tool called zkevm-llvm:
-
Install some tools system-wide:
1.a.apt install cmake ninja-build clang-13 lld-13on a Debian-based Linux, with optionalmusl-toolsif you need amuslbuild
1.b.pacman -S cmake ninja clang lldon an Arch-based Linux
1.c. On MacOS, install the HomeBrew package manager (being careful to install it as the appropriate user), thenbrew install cmake ninja coreutils. Install your choice of a recent LLVM/Clang compiler, e.g. via Xcode, Apple’s Command Line Tools, or your preferred package manager.
1.d. Their equivalents with other package managers -
Currently we are not pinned to any specific version of Rust, so just install the latest stable build for your platform. Also install the
musltarget if you are compiling on Linux in order to distribute the binaries:rustup target add x86_64-unknown-linux-musl -
Install the zkEVM LLVM framework builder:
3.a.
cargo install compiler-llvm-builderon MacOS, or Linux for personal use
3.b.cargo install compiler-llvm-builder --target x86_64-unknown-linux-muslon Linux for distributionThe builder is not the zkEVM LLVM framework itself, but a tool that clones its repository and runs the sequence of build commands. By default it is installed in
~/.cargo/bin/, which is recommended to be added to your$PATH. -
In a directory in which you want the
llvmdirectory, create anLLVM.lockfile with the URL and branch or tag you want to build. For example:
url = "<THIS REPO URL>"
branch = "<THIS REPO BRANCH>"
-
Run the builder to clone and build the zkevm LLVM framework:
5.1.zkevm-llvm clone
5.2.zkevm-llvm buildThe build artifacts will end up in the
./target-llvm/target-final/directory. You may point yourLLVM_SYS_150_PREFIXto that directory to use this build as a compiler dependency. If built with the--enable-testsoption, test tools will be in the./target-llvm/build-final/directory, along with copies of the build artifacts.
- If you get a “failed to authenticate when downloading repository… if the git CLI succeeds then net.git-fetch-with-cli may help here” error,
then prepending the
cargocommand withCARGO_NET_GIT_FETCH_WITH_CLI=truemay help. - Unset any LLVM-related environment variables you may have set.
The zkEVM fork of the LLVM framework is distributed under the terms of Apache License, Version 2.0 with LLVM Exceptions, (LICENSE or https://llvm.org/LICENSE.txt)
zkSync Era has been through extensive testing and audits, and although it is live, it is still in alpha state and will undergo further audits and bug bounty programs. We would love to hear our community's thoughts and suggestions about it! It's important to note that forking it now could potentially lead to missing important security updates, critical features, and performance improvements.