Copyright (c) 2018 The MoneroV Project.
Copyright (c) 2014-2018 The Monero Project.
Portions Copyright (c) 2012-2013 The Cryptonote developers.
- Website: monerov.org
- Github: https://github.com/monerov/monerov-gui
- Mail: [email protected]
| Operating System | Processor | Build |
|---|---|---|
| Ubuntu 16.04 | amd64 | |
| OSX 10.12 | amd64 | |
| Windows (MSYS2/MinGW) | amd64 |
MoneroV is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.
Privacy: MoneroV 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, MoneroV 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.
This is the core implementation of MoneroV. 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 MoneroV 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 MoneroV'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.
See LICENSE.
MoneroV uses a fixed-schedule mandatory software upgrade (hard fork) mechanism to implement new features. This means that users of MoneroV (end users and service providers) need to run current versions and upgrade their software on a regular schedule. Mandatory software upgrades occur during the months of March and September. 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 MoneroV 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 MoneroV version | Recommended MoneroV 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 |
| 1564966 | 2018-05-03 | v8 | v0.13.0.0 | v0.13.0.0 | MoneroV split height |
X's indicate that these details have not been determined as of commit date.
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.
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/
Clone recursively to pull-in needed submodule(s):
$ git clone --recursive https://github.com/monerov/monerov.git
If you already have a repo cloned, initialize and update:
$ cd monerov && git submodule init && git submodule update
MoneroV uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.
-
Install the dependencies
-
Change to the root of the source code directory and build:
cd monerov makeOptional: If your machine has several cores and enough memory, enable parallel build by running
make -j<number of threads>instead ofmake. 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.hppfrom https://github.com/zeromq/cppzmq to/usr/local/includeshould fix that error. -
The resulting executables can be found in
build/release/bin -
Add
PATH="$PATH:$HOME/monerov/build/release/bin"to.profile -
Run MoneroV with
monerovd --detach -
Optional: build and run the test suite to verify the binaries:
make release-testNOTE:
core_teststest 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
You might need to build static librarie with -fPIC.
-
Optional: build documentation in
doc/html(omitHAVE_DOT=YESifgraphvizis not installed):HAVE_DOT=YES doxygen Doxyfile
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 upgradeto install all of the latest software -
Install the dependencies for MoneroV 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 monerov and checkout most recent release version:
git clone --recursive https://github.com/monerov/monerov.git
cd monerov
git checkout master
- Build:
make release
-
Wait 4-6 hours
-
The resulting executables can be found in
build/release/bin -
Add
PATH="$PATH:$HOME/monerov/build/release/bin"to.profile -
Run MoneroV with
monerovd --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
If you are using the older Raspbian Jessie image, compiling MoneroV is a bit more complicated. The version of Boost available in the Debian Jessie repositories is too old to use with MoneroV, 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 upgradeto 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 MoneroV except
libunwindandlibboost-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
- Wait ~8 hours
sudo ./bjam install
-
Wait ~4 hours
-
From here, follow the general Raspberry Pi instructions from the "Clone monerov and checkout most recent release version" step.
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 Shellshortcut -
Update packages using pacman:
pacman -Syuu -
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:
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-libsodiumTo 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 Shellshortcut on 64-bit Windows orMinGW-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.
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
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_64builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processorsmake release-static-linux-i686builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processorsmake release-static-linux-armv8builds binaries on Linux portable across POSIX systems on armv8 processorsmake release-static-linux-armv7builds binaries on Linux portable across POSIX systems on armv7 processorsmake release-static-linux-armv6builds binaries on Linux portable across POSIX systems on armv6 processorsmake release-static-win64builds binaries on 64-bit Windows portable across 64-bit Windows systemsmake 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
foreground:
./bin/monerovd
To list all available options, run ./bin/monerovd --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/monerovd --log-file monerovd.log --detach
To run as a systemd service, copy
monerovd.service to /etc/systemd/system/ and
monerovd.conf to /etc/. The example
service assumes that the user monerov 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
monerov-wallet-cli, and possibly monerovd, if you get crashes refreshing.
See README.i18n.md.
While MoneroV isn't made to integrate with Tor, it can be used wrapped with torsocks, if you add --p2p-bind-ip 127.0.0.1 to the monerod command line. You also want to set DNS requests to go over TCP, so they'll be routed through Tor, by setting DNS_PUBLIC=tcp or use a particular DNS server with DNS_PUBLIC=tcp://a.b.c.d (default is 8.8.4.4, which is Google DNS). You may also disable IGD (UPnP port forwarding negotiation), which is pointless with Tor. To allow local connections from the wallet, you might have to add TORSOCKS_ALLOW_INBOUND=1, some OSes need it and some don't. Example:
DNS_PUBLIC=tcp torsocks monerovd --p2p-bind-ip 127.0.0.1 --no-igd
or:
DNS_PUBLIC=tcp TORSOCKS_ALLOW_INBOUND=1 torsocks monerovd --p2p-bind-ip 127.0.0.1 --no-igd
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 19091 -j ACCEPT
DNS_PUBLIC=tcp torsocks ./monerovd --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
./monerov-wallet-cli
This section contains general instructions for debugging failed installs or problems encountered with MoneroV. First ensure you are running the latest version built from the Github repo.
We generally use the tool gdb (GNU debugger) to provide stack trace functionality, and ulimit to provide core dumps in builds which crash or segfault.
- To use gdb in order to obtain a stack trace for a build that has stalled:
Run the build.
Once it stalls, enter the following command:
gdb /path/to/monerovd `pidof monerovd`
Type thread apply all bt within gdb in order to obtain the stack trace
- If however the core dumps or segfaults:
Enter ulimit -c unlimited on the command line to enable unlimited filesizes for core dumps
Enter echo core | sudo tee /proc/sys/kernel/core_pattern to stop cores from being hijacked by other tools
Run the build.
When it terminates with an output along the lines of "Segmentation fault (core dumped)", there should be a core dump file in the same directory as monerovd. It may be named just core, or core.xxxx with numbers appended.
You can now analyse this core dump with gdb as follows:
gdb /path/to/monerovd /path/to/dumpfile
Print the stack trace with bt
- To run monerov within gdb:
Type gdb /path/to/monerovd
Pass command-line options with --args followed by the relevant arguments
Type run to run monerovd
We use the tool valgrind for this.
Run with valgrind /path/to/monerovd. It will be slow.
Instructions for debugging suspected blockchain corruption as per @HYC
There is an mdb_stat command in the LMDB source that can print statistics about the database but it's not routinely built. This can be built with the following command:
cd ~/monerov/external/db_drivers/liblmdb && make
The output of mdb_stat -ea <path to blockchain dir> will indicate inconsistencies in the blocks, block_heights and block_info table.
The output of mdb_dump -s blocks <path to blockchain dir> and mdb_dump -s block_info <path to blockchain dir> is useful for indicating whether blocks and block_info contain the same keys.
These records are dumped as hex data, where the first line is the key and the second line is the data.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent