Skip to content
Electronero: the secure, private, mobile based cryptocurrency
Branch: master
Clone or download
Pull request Compare This branch is 57 commits ahead, 111 commits behind electronero:master.
shopglobal Future emissions adjustment (#2)
* hard fork v17

* emissions adjustment, for hard fork 17

* hard fork v17 pushed back block 650000

* Update cryptonote_basic_impl.cpp

* reduce network fees and rename shared ring db

* Update cryptonote_basic_impl.cpp

* update timestamps, heights of fork v17

* Update cryptonote_config.h

* adjustments

* Update cryptonote_basic_impl.cpp

* Update blockchain.cpp

* fork height v17 delayed

* fork height v17 delayed
Latest commit a0d8751 Mar 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmake Create CheckLinkerFlag.cmake Jun 10, 2018
contrib Update portable_storage_from_json.h Sep 28, 2018
external modules Jun 10, 2018
include
sponsors Update readme.md Sep 18, 2018
src Future emissions adjustment (#2) Mar 10, 2019
tests Update main.cpp Jul 11, 2018
translations Fix typos in various files Mar 15, 2018
utils systemd,readme: torsocks config for service Mar 10, 2018
.gitattributes cmake: support git info in released tarballs Oct 23, 2014
.gitignore cleanup Apr 21, 2018
.gitmodules Update .gitmodules Jul 29, 2018
CMakeLists.txt Update CMakeLists.txt Jul 7, 2018
CMakeLists_IOS.txt
CONTRIBUTING.md
Dockerfile Update Dockerfile Jun 12, 2018
Doxyfile
LICENSE
Makefile Update 2018 copyright Jan 26, 2018
README.i18n.md Update README.i18n.md May 30, 2018
README.md Update README.md Mar 8, 2019
arch_install.sh Create arch_install.sh Apr 18, 2018
import.sh
osx_install.sh Update osx_install.sh Apr 26, 2018
paper.html Create paper.html Jul 21, 2018
pm2.sh
retar.sh
rpc-test.sh Update rpc-test.sh Jul 12, 2018
rpcpm2.sh
snap Add snap symlink Feb 24, 2017
testnet-launch.sh
ubuntu_install.sh rebase Jun 9, 2018

README.md

Electronero Pulse

Source code forked from Electronero, based on Monero

Copyright (c) 2014-2018 The Monero Project. Portions Copyright (c) 2017-2018 The Electroneum developers. Portions Copyright (c) ~2018 The Masari developers. Portions Copyright (c) ~2018 The Sumokoin developers. Portions Copyright (c) ~2018 The Stellite developers. Portions Copyright (c) 2012-2013 The Cryptonote developers.

Development resources

Vulnerability response

Introduction

Electronero Pulse is a private, secure, untraceable, decentralised digital currency. You control your funds, and nobody can trace your transfers unless you allow them to do so.

Privacy: Electronero Pulse 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, Monero 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.

Sponsors

(https://mineful.com)

Supporting the project

Electronero Pulse is a 100% community-sponsored endeavor. If you want to join our efforts, the easiest thing you can do is support the project financially. Electronero donations can be made to the Electronero donation address via the donate command (type help in the command-line wallet for details). Else, here are our dev teams addresses. The funding goes to many developers who contribute and believe me, they are greatful for our assistance!

The Monero donation address is: 449JLhz9p6756c5tGACveuX76qa8UxMkFMd5uqG9SEJ3LcVJLjh4KvxJQ1Pf4yJmYgQRTrNPZhaga8eYynVqHfac9VWhF1m

The Bitcoin donation address is: 38jiBKevQHp8zhQpZ42bTvK4QpzzqWkA3K

The Electronero donation address is: etnkHfFuanNeTe3q9dux4d9cRiLkUR4hDffvhfTp6nbhEJ5R8TY4vdyZjT4BtWxnvSJ5nfD64eCAQfKMJHSym2dj8PQqeiKmBM

The Electroneum donation address is: etnkHfFuanNeTe3q9dux4d9cRiLkUR4hDffvhfTp6nbhEJ5R8TY4vdyZjT4BtWxnvSJ5nfD64eCAQfKMJHSym2dj8PQqeiKmBM

The Litecoin donation address is: LfUVH96Ey1jj1FzJSriE9kpSvL2eNzEBG5

The Bitcoin Cash donation address is: qpwvqz4kkhe96ggthpcg4aj5y62zftzxegwcl78a4u

The Sumokoin donation address is: Sumoo47CGenbHfZtpCVV4PRMSsXP38idFdt5JSj7VuJrD1nABoPHTBHgR6owQJfn1JU8BiWWohw4oiefGEjAn4GmbFYYtCcfPeT

About this project

This is the core implementation of Electronero Pulse. 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 Monero 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 Electronero'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.

License

See LICENSE.

Contributing

If you want to help out, see CONTRIBUTING for a set of guidelines.

Scheduled software upgrades

Monero uses a fixed-schedule software upgrade (hard fork) mechanism to implement new features. This means that users of Monero (end users and service providers) should run current versions and upgrade their software on a regular schedule. Software upgrades occur during the months of April and October. The required software for these upgrades will be available prior to the scheduled date. Please check the repository prior to this date for the proper Monero software version. Below is the historical schedule and the projected schedule for the next upgrade. Dates are provided in the format YYYY-MM-DD.

Software upgrade block height Date Fork version Minimum Monero version Recommended Monero version Details
1009827 2016-03-22 v2 v0.9.4 v0.9.4 Allow only >= ringsize 3, blocktime = 120 seconds, fee-free blocksize 60 kb
1141317 2016-09-21 v3 v0.9.4 v0.10.0 Splits coinbase into denominations
1220516 2017-01-05 v4 v0.10.1 v0.10.2.1 Allow normal and RingCT transactions
1288616 2017-04-15 v5 v0.10.3.0 v0.10.3.1 Adjusted minimum blocksize and fee algorithm
1400000 2017-09-16 v6 v0.11.0.0 v0.11.0.0 Allow only RingCT transactions, allow only >= ringsize 5
1546000 2018-04-06 v7 v0.12.0.0 v0.12.0.0 Cryptonight variant 1, ringsize >= 7, sorted inputs
337838 2018-07-11 v15 v12.3.0 v12.3.1 Cryptonight fast, variant 4, ringsize >=1
xxxxxx 2018-10-30 v16 v12.3.4 v12.3.5 ETNXP, supply burn

X's indicate that these details have not been determined as of commit date.

Release staging schedule and protocol

Approximately three months prior to a scheduled software upgrade, a branch from Master will be created with the new release version tag. Pull requests that address bugs should then be made to both Master and the new release branch. Pull requests that require extensive review and testing (generally, optimizations and new features) should not be made to the release branch.

Compiling Electronero Pulse from source

Dependencies

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 (.a).

Dep Min. version Vendored Debian/Ubuntu pkg Arch pkg Fedora Optional Purpose
GCC 4.7.3 NO build-essential base-devel gcc NO
CMake 3.0.0 NO cmake cmake cmake NO
pkg-config any NO pkg-config base-devel pkgconf NO
Boost 1.58 NO libboost-all-dev boost boost-devel NO C++ libraries
OpenSSL basically any NO libssl-dev openssl openssl-devel NO sha256 sum
libzmq 3.0.0 NO libzmq3-dev zeromq cppzmq-devel NO ZeroMQ library
libunbound 1.4.16 YES libunbound-dev unbound unbound-devel NO DNS resolver
libsodium ? NO libsodium-dev ? libsodium-devel NO libsodium
libminiupnpc 2.0 YES libminiupnpc-dev miniupnpc miniupnpc-devel YES NAT punching
libunwind any NO libunwind8-dev libunwind libunwind-devel YES Stack traces
liblzma any NO liblzma-dev xz xz-devel YES For libunwind
libreadline 6.3.0 NO libreadline6-dev readline readline-devel YES Input editing
ldns 1.6.17 NO libldns-dev ldns ldns-devel YES SSL toolkit
expat 1.1 NO libexpat1-dev expat expat-devel YES XML parsing
GTest 1.5 YES libgtest-dev^ gtest gtest-devel YES Test suite
Doxygen any NO doxygen doxygen doxygen YES Documentation
Graphviz any NO graphviz graphviz graphviz YES Documentation

[^] 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/

Cloning the repository

Clone recursively to pull-in needed submodule(s):

$ git clone --recursive https://github.com/electronero-pulse/electroneropulse

If you already have a repo cloned, initialize and update:

$ cd electronero && git submodule init && git submodule update

Build instructions

Electronero 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 electroneropulse
      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.

    Note: If cmake can not find zmq.hpp file on OS X, installing zmq.hpp from https://github.com/zeromq/cppzmq to /usr/local/include should fix that error.

  • The resulting executables can be found in build/release/bin

  • Add PATH="$PATH:$HOME/electroneropulse/build/release/bin" to .profile

  • Run Electronero with pulsed --detach

  • Optional: build and run the test suite to verify the binaries:

      make release-test
    

    NOTE: core_tests test may take a few hours to complete.

  • Optional: to build binaries suitable for debugging:

       make debug
    
  • Optional: to build statically-linked binaries:

       make release-static
    

Dependencies need to be built with -fPIC. Static libraries usually aren't, so you may have to build them yourself with -fPIC. Refer to their documentation for how to build them.

  • Optional: build documentation in doc/html (omit HAVE_DOT=YES if graphviz is not installed):

      HAVE_DOT=YES doxygen Doxyfile
    

On the Raspberry Pi

Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch (2017-09-07 or later) from https://www.raspberrypi.org/downloads/raspbian/. If you are using Raspian Jessie, please see note in the following section.

  • apt-get update && apt-get upgrade to install all of the latest software

  • Install the dependencies for Electronero from the 'Debian' column in the table above.

  • Increase the system swap size:

	sudo /etc/init.d/dphys-swapfile stop  
	sudo nano /etc/dphys-swapfile  
	CONF_SWAPSIZE=1024  
	sudo /etc/init.d/dphys-swapfile start  
  • Clone electronero and checkout most recent release version:
        git clone https://github.com/electronero-pulse/electroneropulse.git
	cd electroneropulse
  • Build:
        make release
  • Wait 4-6 hours

  • The resulting executables can be found in build/release/bin

  • Add PATH="$PATH:$HOME/electroneropulse/build/release/bin" to .profile

  • Run Electronero with pulsed --detach

  • You may wish to reduce the size of the swap file after the build has finished, and delete the boost directory from your home directory

Note for Raspbian Jessie users:

If you are using the older Raspbian Jessie image, compiling Electronero is a bit more complicated. The version of Boost available in the Debian Jessie repositories is too old to use with Electronero, and thus you must compile a newer version yourself. The following explains the extra steps, and has been tested on a Raspberry Pi 2 with a clean install of minimal Raspbian Jessie.

  • As before, apt-get update && apt-get upgrade to install all of the latest software, and increase the system swap size
	sudo /etc/init.d/dphys-swapfile stop  
	sudo nano /etc/dphys-swapfile  
	CONF_SWAPSIZE=1024  
	sudo /etc/init.d/dphys-swapfile start  
  • Then, install the dependencies for Electronero except libunwind and libboost-all-dev

  • Install the latest version of boost (this may first require invoking apt-get remove --purge libboost* to remove a previous version if you're not using a clean install):

	cd  
	wget https://sourceforge.net/projects/boost/files/boost/1.64.0/boost_1_64_0.tar.bz2  
	tar xvfo boost_1_64_0.tar.bz2  
	cd boost_1_64_0  
	./bootstrap.sh  
	sudo ./b2  
	sudo ./bjam install

On Windows:

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 MSYS2 Shell shortcut

  • Update packages using pacman:

      pacman -Syuu  
    
  • Exit the MSYS shell using Alt+F4

  • Edit the properties for the MSYS2 Shell shortcut 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:

      pacman -Syuu  
    
  • Install dependencies:

    To build for 64-bit Windows:

      pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium
    

    To build for 32-bit Windows:

      pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium
    
  • Open the MingW shell via MinGW-w64-Win64 Shell shortcut on 64-bit Windows or MinGW-w64-Win64 Shell shortcut on 32-bit Windows. Note that if you are running 64-bit Windows, you will have both 64-bit and 32-bit MinGW shells.

Building

  • If you are on a 64-bit system, run:

      make release-static-win64
    
  • If you are on a 32-bit system, run:

      make release-static-win32
    
  • The resulting executables can be found in build/release/bin

On FreeBSD:

The project can be built from scratch by following instructions for Linux above. If you are running electronero in a jail you need to add the flag: allow.sysvipc=1 to your jail configuration, otherwise lmdb will throw the error message: Failed to open lmdb environment: Function not implemented.

We expect to add Electronero into the ports tree in the near future, which will aid in managing installations using ports or packages.

On OpenBSD:

OpenBSD < 6.2

This has been tested on OpenBSD 5.8.

You will need to add a few packages to your system. pkg_add db cmake gcc gcc-libs g++ miniupnpc gtest.

The doxygen and graphviz packages are optional and require the xbase set.

The Boost package has a bug that will prevent librpc.a from building correctly. In order to fix this, you will have to Build boost yourself from scratch. Follow the directions here (under "Building Boost"): https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md

You will have to add the serialization, date_time, and regex modules to Boost when building as they are needed by Electronero.

To build: env CC=egcc CXX=eg++ CPP=ecpp DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/path/to/the/boost/you/built make release-static-64

OpenBSD >= 6.2

You will need to add a few packages to your system. pkg_add cmake miniupnpc zeromq libiconv.

The doxygen and graphviz packages are optional and require the xbase set.

Build the Boost library using clang. This guide is derived from: https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md

We assume you are compiling with a non-root user and you have doas enabled.

Note: do not use the boost package provided by OpenBSD, as we are installing boost to /usr/local.

# Create boost building directory
mkdir ~/boost
cd ~/boost

# Fetch boost source
ftp -o boost_1_64_0.tar.bz2 https://netcologne.dl.sourceforge.net/project/boost/boost/1.64.0/boost_1_64_0.tar.bz2

# MUST output: (SHA256) boost_1_64_0.tar.bz2: OK
echo "7bcc5caace97baa948931d712ea5f37038dbb1c5d89b43ad4def4ed7cb683332 boost_1_64_0.tar.bz2" | sha256 -c
tar xfj boost_1_64_0.tar.bz2

# Fetch and apply boost patches, required for OpenBSD
ftp -o boost_test_impl_execution_monitor_ipp.patch https://raw.githubusercontent.com/openbsd/ports/bee9e6df517077a7269ff0dfd57995f5c6a10379/devel/boost/patches/patch-boost_test_impl_execution_monitor_ipp
ftp -o boost_config_platform_bsd_hpp.patch https://raw.githubusercontent.com/openbsd/ports/90658284fb786f5a60dd9d6e8d14500c167bdaa0/devel/boost/patches/patch-boost_config_platform_bsd_hpp

# MUST output: (SHA256) boost_config_platform_bsd_hpp.patch: OK
echo "1f5e59d1154f16ee1e0cc169395f30d5e7d22a5bd9f86358f738b0ccaea5e51d boost_config_platform_bsd_hpp.patch" | sha256 -c
# MUST output: (SHA256) boost_test_impl_execution_monitor_ipp.patch: OK
echo "30cec182a1437d40c3e0bd9a866ab5ddc1400a56185b7e671bb3782634ed0206 boost_test_impl_execution_monitor_ipp.patch" | sha256 -c

cd boost_1_64_0
patch -p0 < ../boost_test_impl_execution_monitor_ipp.patch
patch -p0 < ../boost_config_platform_bsd_hpp.patch

# Start building boost
echo 'using clang : : c++ : <cxxflags>"-fvisibility=hidden -fPIC" <linkflags>"" <archiver>"ar" <striper>"strip"  <ranlib>"ranlib" <rc>"" : ;' > user-config.jam
./bootstrap.sh --without-icu --with-libraries=chrono,filesystem,program_options,system,thread,test,date_time,regex,serialization,locale --with-toolset=clang
./b2 toolset=clang cxxflags="-stdlib=libc++" linkflags="-stdlib=libc++" -sICONV_PATH=/usr/local
doas ./b2 -d0 runtime-link=shared threadapi=pthread threading=multi link=static variant=release --layout=tagged --build-type=complete --user-config=user-config.jam -sNO_BZIP2=1 -sICONV_PATH=/usr/local --prefix=/usr/local install

Build cppzmq

Build the cppzmq bindings.

We assume you are compiling with a non-root user and you have doas enabled.

# Create cppzmq building directory
mkdir ~/cppzmq
cd ~/cppzmq

# Fetch cppzmq source
ftp -o cppzmq-4.2.3.tar.gz https://github.com/zeromq/cppzmq/archive/v4.2.3.tar.gz

# MUST output: (SHA256) cppzmq-4.2.3.tar.gz: OK
echo "3e6b57bf49115f4ae893b1ff7848ead7267013087dc7be1ab27636a97144d373 cppzmq-4.2.3.tar.gz" | sha256 -c
tar xfz cppzmq-4.2.3.tar.gz

# Start building cppzmq
cd cppzmq-4.2.3
mkdir build
cd build
cmake ..
doas make install

Build electronero: env DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/usr/local make release-static

On Solaris:

The default Solaris linker can't be used, you have to install GNU ld, then run cmake manually with the path to your copy of GNU ld:

    mkdir -p build/release
    cd build/release
    cmake -DCMAKE_LINKER=/path/to/ld -D CMAKE_BUILD_TYPE=Release ../..
    cd ../..

Then you can run make as usual.

On Linux for Android (using docker):

    # Build image (select android64.Dockerfile for aarch64)
    cd utils/build_scripts/ && docker build -f android32.Dockerfile -t electronero-android .
    # Create container
    docker create -it --name electronero-android electronero-android bash
    # Get binaries
    docker cp electronero-android:/opt/android/electronero/build/release/bin .

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-linux-x86_64 builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processors
  • make release-static-linux-i686 builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processors
  • make release-static-linux-armv8 builds binaries on Linux portable across POSIX systems on armv8 processors
  • make release-static-linux-armv7 builds binaries on Linux portable across POSIX systems on armv7 processors
  • make release-static-linux-armv6 builds binaries on Linux portable across POSIX systems on armv6 processors
  • make release-static-win64 builds binaries on 64-bit Windows portable across 64-bit Windows systems
  • make release-static-win32 builds binaries on 64-bit or 32-bit Windows portable across 32-bit Windows systems

Running pulsed

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 foreground:

./bin/pulsed

To list all available options, run ./bin/pulsed --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=value, where argumentname is the name of the argument without the leading dashes, for example log-level=1.

To run in background:

./bin/pulsed --log-file pulsed.log --detach

To run as a systemd service, copy electroneropulse.service to /etc/systemd/system/ and pulsed.conf to /etc/. The example service assumes that the user electroneropulse exists and its home is the data directory specified in the example config.

If you're on Mac, you may need to add the --max-concurrency 1 option to pulse-wallet-cli, and possibly pulsed, if you get crashes refreshing.

You can’t perform that action at this time.