C++ implementation of the Ethereum Execution Layer (EL) protocol based on the Erigon architecture.
Silkworm is a greenfield C++ implementation of the Ethereum protocol based on the Erigon architecture. It aims to be the fastest Ethereum client while maintaining the high quality and readability of its source code. Silkworm uses libmdbx as the database engine.
Silkworm was conceived as an evolution of the Erigon project, as outlined in its release commentary.
Silkworm is under active development and hasn't reached the alpha phase yet. Hence, there have been no releases so far.
At the very beginning, one of the main goals of Silkworm was implementing high-performance C++ libraries to be used directly within Erigon itself. Recently we focused again on this initial target, making it our highest priority and delivering the first release of Erigon++ starting from Erigon 2.59.0.
Please note that Erigon++ is just a fancy name for identifying such usage of Silkworm libraries within Erigon, which can be selectively enabled by specifying optional flags in Erigon command-line.
There are two possible usages of Erigon++:
--silkworm.exec [enables historical block execution powered by Silkworm]
--silkworm.rpc [enables Ethereum JSON-RPC API powered by Silkworm]
--silkworm.sentry [enables Execution Layer p2p networking powered by Silkworm]
To obtain Silkworm source code for the first time:
git clone --recurse-submodules https://github.com/erigontech/silkworm.git
cd silkworm
Silkworm uses a few git submodules (some of which have their own submodules). So after you've updated to the latest code with
git pull
update the submodules as well by running
git submodule update --init --recursive
Building Silkworm requires:
Conan requires Python, and can be installed using:
pip3 install --user conan==1.64.1 chardet
On Linux the conan binary gets installed into $HOME/.local/bin
which is typically in PATH already.
On macOS need to add the binary to PATH manually:
export "PATH=$HOME/Library/Python/3.9/bin:$PATH"
Once the prerequisites are installed, bootstrap cmake by running
mkdir build
cd build
cmake ..
(In the future you don't have to run cmake ..
again.)
A custom Conan "profile" can be passed via a cmake argument, for example:
cmake .. -DCONAN_PROFILE=macos_arm64_clang_13_debug
will use "debug" configuration builds of dependencies.
See available profiles in cmake/profiles.
The conan packages could also be pre-installed using conan install:
conan install --install-folder=build/conan --build=missing --profile=cmake/profiles/macos_arm64_clang_13_debug .
Then run the build itself
make -j
Note about parallel builds using -j
: if not specified the exact number of parallel tasks, the compiler will spawn as many
as the cores available. That may cause OOM errors if the build is executed on a host with a large number of cores but a relatively
small amount of RAM. To work around this, either specify -jn
where n
is the number of parallel tasks you want to allow or
remove -j
completely. Typically, for Silkworm each compiler job requires 4GB of RAM. So, if your total RAM is 16GB, for example,
then -j4
should be OK, while -j8
is probably not. It also means that you need a machine with at least 4GB RAM to compile Silkworm.
Now you can run the unit tests
make test
or the Ethereum EL Tests
cmd/test/ethereum
Note! Windows builds are maintained for compatibility/portability reasons. However, due to the lack of 128-bit integers support by MSVC, execution performance is inferior when compared to Linux builds.
CTRL+Shift+B
%USERPROFILE%\CMakeBuilds\silkworm\build
If you want to change this path simply edit CMakeSettings.json
file.Note ! Memory compression on Windows 10/11
Windows 10/11 provide a memory compression feature which makes available more RAM than what physically mounted at cost of extra CPU cycles to compress/decompress while accessing data. As MDBX is a memory mapped file this feature may impact overall performances. Is advisable to have memory compression off.
Use the following steps to detect/enable/disable memory compression:
Get-MMAgent
(check whether memory compression is enabled)Disable-MMAgent -mc
and rebootEnable-MMAgent -mc
and rebootNote: at current state of development Silkworm can't actually sync the chain like Erigon does.
You can try to run Silkworm to test just the sync on the pre-Merge Ethereum chain. In order to do that you need to:
Erigon Sentry
component from branch release/2.60
STOP_AT_BLOCK
to a value < 15'537'351 (e.g. STOP_AT_BLOCK=15000000)git clone --recurse-submodules https://github.com/erigontech/erigon.git
cd erigon
git checkout release/2.60
make sentry
./build/bin/sentry
export STOP_AT_BLOCK=15000000
./cmd/silkworm
git clone --recurse-submodules https://github.com/erigontech/erigon.git
cd erigon
git checkout release/2.60
make sentry
./build/bin/sentry.exe
$env:STOP_AT_BLOCK=15000000
./cmd/silkworm.exe
If you want to contribute, you can read our contribution guidelines.
Silkworm is licensed under the terms of the Apache license. See LICENSE for more information.