Copyright (c) 2017-2018, The Electroneum Project
Copyright (c) 2014-2017, The Monero Project
Portions Copyright (c) 2012-2013, The Cryptonote developers
Electroneum is a private, secure, untraceable, mobile based cryptocurrency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.
Privacy: Electroneum uses a cryptographically sound system to allow you to send and receive funds without your transactions being easily revealed on the blockchain (the ledger of transactions that everyone has). This ensures that your purchases, receipts, and all transfers remain absolutely private by default.
Security: Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have a 25 word mnemonic seed that is only displayed once, and can be written down to backup the wallet. Wallet files are encrypted with a passphrase to ensure they are useless if stolen.
Untraceability: By taking advantage of ring signatures, a special property of a certain type of cryptography, Electroneum is able to ensure that transactions are not only untraceable, but have an optional measure of ambiguity that ensures that transactions cannot easily be tied back to an individual user or computer.
About this Project
This is the core implementation of Electroneum. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Electroneum that uses the protocol and network in a compatible manner.
As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.
Anyone is welcome to contribute to Electroneum's codebase! If you have a fix or code change, feel free to submit it as a pull request directly to the "master" branch. In cases where the change is relatively small or does not affect other parts of the codebase it may be merged in immediately by any one of the collaborators. On the other hand, if the change is particularly large or complex, it is expected that it will be discussed at length either well in advance of the pull request being submitted, or even directly on the pull request.
If you want to help out, see CONTRIBUTING for a set of guidelines.
Scheduled software upgrades
|Software upgrade block height||Date||Fork version||Minimum Electroneum version||Recommended Electroneum version||Details|
|307500||2018-05-30||v6||v188.8.131.52||v184.108.40.206||Disable Mixin, Disable RingCT, Base Fee to 0.10 from 0.01, 120s Block Time, Anti-Asic Resistance|
X's indicate that these details have not been determined as of commit date.
Vulnerability Response Process
Installing Electroneum from a Package
Packages are available for
Ubuntu and snap supported systems, via a community contributed build.
snap install electroneum --beta
Installing a snap is very quick. Snaps are secure. They are isolated with all of their dependencies. Snaps also auto update when a new version is released.
Arch Linux (via AUR):
docker build -t electroneum . # either run in foreground docker run -it -v /electroneum/chain:/root/.electroneum -v /electroneum/wallet:/wallet -p 26967:26967 electroneum # or in background docker run -it -d -v /electroneum/chain:/root/.electroneum -v /electroneum/wallet:/wallet -p 26967:26967 electroneum
Packaging for your favorite distribution would be a welcome contribution!
Compiling Electroneum from Source
The following table summarizes the tools and libraries required to build. A
few of the libraries are also included in this repository (marked as
"Vendored"). By default, the build uses the library installed on the system,
and ignores the vendored sources. However, if no library is found installed on
the system, then the vendored source will be built and used. The vendored
sources are also used for statically-linked builds because distribution
packages often include only shared library binaries (
.so) but not static
library archives (
|Dep||Min. Version||Vendored||Debian/Ubuntu Pkg||Arch Pkg||Optional||Purpose|
[^] On Debian/Ubuntu
libgtest-dev only includes sources and headers. You must
build the library binary manually. This can be done with the following command
sudo apt-get install libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv libg* /usr/lib/
Electroneum uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.
On Linux and OS X
Install the dependencies
Change to the root of the source code directory and build:
cd electroneum make
Optional: If your machine has several cores and enough memory, enable parallel build by running
make -j<number of threads>instead of
make. For this to be worthwhile, the machine should have one core and about 2GB of RAM available per thread.
The resulting executables can be found in
Run electroneum with
Optional: build and run the test suite to verify the binaries:
coreteststest may take a few hours to complete.
Optional: to build binaries suitable for debugging:
Optional: to build statically-linked binaries:
Optional: build documentation in
graphvizis not installed):
HAVE_DOT=YES doxygen Doxyfile
Binaries for Windows are built on Windows using the MinGW toolchain within MSYS2 environment. The MSYS2 environment emulates a POSIX system. The toolchain runs within the environment and cross-compiles binaries that can run outside of the environment as a regular Windows application.
Preparing the Build Environment
Download and install the MSYS2 installer, either the 64-bit or the 32-bit package, depending on your system.
Open the MSYS shell via the
Update packages using pacman:
Exit the MSYS shell using Alt+F4
Edit the properties for the
MSYS2 Shellshortcut changing "msys2_shell.bat" to "msys2_shell.cmd -mingw64" for 64-bit builds or "msys2_shell.cmd -mingw32" for 32-bit builds
Restart MSYS shell via modified shortcut and update packages again using pacman:
To build for 64-bit Windows:
pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost
To build for 32-bit Windows:
pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost
Open the MingW shell via
MinGW-w64-Win64 Shellshortcut on 64-bit Windows or
MinGW-w64-Win64 Shellshortcut on 32-bit Windows. Note that if you are running 64-bit Windows, you will have both 64-bit and 32-bit MinGW shells.
If you are on a 64-bit system, run:
If you are on a 32-bit system, run:
The resulting executables can be found in
Building Portable Statically Linked Binaries
By default, in either dynamically or statically linked builds, binaries target the specific host processor on which the build happens and are not portable to other processors. Portable binaries can be built using the following targets:
make release-static-64builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processors
make release-static-32builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processors
make release-static-armv8builds binaries on Linux portable across POSIX systems on armv8 processors
make release-static-armv7builds binaries on Linux portable across POSIX systems on armv7 processors
make release-static-armv6builds binaries on Linux portable across POSIX systems on armv6 processors
make release-static-win64builds binaries on 64-bit Windows portable across 64-bit Windows systems
make release-static-win32builds binaries on 64-bit or 32-bit Windows portable across 32-bit Windows systems
The build places the binary in
bin/ sub-directory within the build directory
from which cmake was invoked (repository root by default). To run in
To list all available options, run
./bin/electroneumd --help. Options can be
specified either on the command line or in a configuration file passed by the
--config-file argument. To specify an option in the configuration file, add
a line with the syntax
argumentname is the name
of the argument without the leading dashes, for example
To run in background:
./bin/electroneumd --log-file electroneumd.log --detach
To run as a systemd service, copy
/etc/. The example
service assumes that the user
and its home is the data directory specified in the example
If you're on Mac, you may need to add the
--max-concurrency 1 option to
electroneum-wallet-cli, and possibly electroneumd, if you get crashes refreshing.
Whilst Electroneum isn't made to integrate with Tor, it can be used wrapped with torsocks, by setting the following configuration parameters and environment variables:
--p2p-bind-ip 127.0.0.1on the command line or
p2p-bind-ip=127.0.0.1in electroneumd.conf to disable listening for connections on external interfaces.
--no-igdon the command line or
no-igd=1in electroneumd.conf to disable IGD (UPnP port forwarding negotiation), which is pointless with Tor.
DNS_PUBLIC=tcp://x.x.x.xwhere x.x.x.x is the IP of the desired DNS server, for DNS requests to go over TCP, so that they are routed through Tor. When IP is not specified, electroneumd uses the default list of servers defined in src/common/dns_utils.cpp.
TORSOCKS_ALLOW_INBOUND=1to tell torsocks to allow monerod to bind to interfaces to accept connections from the wallet. On some Linux systems, torsocks allows binding to localhost by default, so setting this variable is only necessary to allow binding to local LAN/VPN interfaces to allow wallets to connect from remote hosts. On other systems, it may be needed for local wallets as well.
- Do NOT pass
--detachwhen running through torsocks with systemd, (see utils/systemd/electroneumd.service for details).
- If you use the wallet with a Tor daemon via the loopback IP (eg, 127.0.0.1:9050),
--untrusted-daemonunless it is your own hidden service. Example command line to start electroneumd through Tor: DNS_PUBLIC=tcp torsocks electroneumd --p2p-bind-ip 127.0.0.1 --no-igd
Using Tor on Tails
TAILS ships with a very restrictive set of firewall rules. Therefore, you need to add a rule to allow this connection too, in addition to telling torsocks to allow inbound connections. Full example:
sudo iptables -I OUTPUT 2 -p tcp -d 127.0.0.1 -m tcp --dport 26968 -j ACCEPT DNS_PUBLIC=tcp torsocks ./electroneumd --p2p-bind-ip 127.0.0.1 --no-igd --rpc-bind-ip 127.0.0.1 \ --data-dir /home/amnesia/Persistent/your/directory/to/the/blockchain