status-im / nimbus-eth1

Nimbus: ultra-light Ethereum execution layer client Introduction This repository contains development work on an execution-layer client to pair with our consensus-layer client. This client focuses on efficiency and security and strives to be as light-weight as possible in terms of resources used. This repository is also home to: • Nimbus Portal client, a Portal Network light client. • Nimbus Verified Proxy All consensus-layer client development is happening in parallel in the nimbus-eth2 repository. Development Updates For more detailed write-ups on the development progress, follow the Nimbus blog. Building & Testing Prerequisites • GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer. Obtaining the prerequisites through the Nix package manager *Experimental* Users of the Nix package manager can install all prerequisites simply by running: Build & Develop POSIX-compatible OS To run a command that might use binaries from the Status Nim fork: Windows _(Experimental support!)_ Install Mingw-w64 for your architecture using the "MinGW-W64 Online Installer" (first link under the directory listing). Run it and select your architecture in the setup menu ("i686" on 32-bit, "x86\_64" on 64-bit), set the threads to "win32" and the exceptions to "dwarf" on 32-bit and "seh" on 64-bit. Change the installation directory to "C:\mingw-w64" and add it to your system PATH in "My Computer"/"This PC" -> Properties -> Advanced system settings -> Environment Variables -> Path -> Edit -> New -> C:\mingw-w64\mingw64\bin (it's "C:\mingw-w64\mingw32\bin" on 32-bit) Install Git for Windows and use it to clone Nimbus. Install cmake. After adding the Git bin directory to your path open a "Git Bash" shell: After installing Mingw-w64 and adding it to your path you should have the tool available. Next create a link from to : You can now follow those instructions in the previous section. For example: Raspberry PI *Experimental* The code can be compiled on a Raspberry PI: • Raspberry Pi 4+ • 64GB SD Card (less might work too, but the default recommended 4-8GB will probably be too small) • Rasbian Buster Lite - Lite version is enough to get going and will save some disk space! Assuming you're working with a freshly written image: Android *Experimental* Code can be compiled and run on Android devices Environment setup • Install the Termux app from FDroid or the Google Play store • Install a PRoot of your choice following the instructions for your preferred distribution. Note, the Ubuntu PRoot is known to contain all Nimbus prerequisites compiled on Arm64 architecture (common architecture for Android devices). Depending on the distribution, it may require effort beyond the scope of this guide to get all prerequisites. *Assuming Ubuntu PRoot is used* Experimental make variables Apart from standard Make flags (see link in the next chapter), the following Make variables can be set to control which version of a virtual engine is compiled. The variables are listed with decreasing priority (in case of doubt, the lower prioritised variable is ignored when the higher on is available.) • BOEHM_GC=1 Change garbage collector to . This might help debugging in certain cases when the is involved in a memory corruption or corruption camouflage. • ENABLE_LINE_NUMBERS=1 Enables logger to print out source code location with log message For these variables, using <variable>=0 is ignored and <variable>=2 has the same effect as <variable>=1 (ditto for other numbers.) Development tips Interesting Make variables and targets are documented in the nimbus-build-system repo. • you can control the Makefile's verbosity with the V variable (defaults to 0): • same for the Chronicles log level: • pass arbitrary parameters to the Nim compiler: • if you want to use SSH keys with GitHub (also handles submodules): • force a Nim compiler rebuild: Git submodule workflow Working on a dependency: It's important that you only update the submodule commit after it's available upstream. You might want to do this on a new branch of the superproject, so you can make a GitHub PR for it and see the CI test results. Don't update all Git submodules at once, just because you found the relevant Git command or target. You risk updating submodules to other people's latest commits when they are not ready to be used in the superproject. Adding the submodule "https://github.com/status-im/foo" to "vendor/foo": Removing the submodule "vendor/bar": Checking out older commits, either to bisect something or to reproduce an older build: Running a dependency's test suite using instead of (which cannot be convinced not to run a dependency check, thus clashing with our jury-rigged "vendor/.nimble/pkgs"): Metric visualisation Install Prometheus and Grafana. On Gentoo, it's . Start the Grafana server. On Gentoo it's . Go to http://localhost:3000, log in with admin:admin and change the password. Add Prometheus as a data source. The default address of http://localhost:9090 is OK, but Grafana 6.3.5 will not apply that semitransparent default you see in the form field, unless you click on it. Create a new dashboard. Click on its default title in the upper left corner ("New Dashboard"). In the new page, click "Import dashboard" in the right column and upload "metrics/grafana/grafana.infra.status.im.json". In the main panel, there's a hidden button used to assign metrics to the left or right Y-axis - it's the coloured line on the left of the metric name, in the graph legend. To see a single metric, click on its name in the legend. Click it again to go back to the combined view. To edit a panel, click on its title and select "Edit". Obligatory screenshot. Troubleshooting Report any errors you encounter, please, if not already documented! • Turn it off and on again: License Licensed and distributed under either of • MIT license: LICENSE-MIT or https://opensource.org/licenses/MIT or • Apache License, Version 2.0…