diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 203 |
1 files changed, 179 insertions, 24 deletions
@@ -1,9 +1,6 @@ # Monero -Copyright (c) 2014-2016, The Monero Project - -[](https://travis-ci.org/monero-project/monero) -[](https://coveralls.io/github/monero-project/monero?branch=master) +Copyright (c) 2014-2017, The Monero Project ## Development Resources @@ -11,7 +8,31 @@ Copyright (c) 2014-2016, The Monero Project - Forum: [forum.getmonero.org](https://forum.getmonero.org) - Mail: [dev@getmonero.org](mailto:dev@getmonero.org) - GitHub: [https://github.com/monero-project/monero](https://github.com/monero-project/monero) -- IRC: [#monero-dev on Freenode](irc://chat.freenode.net/#monero-dev) +- IRC: [#monero-dev on Freenode](http://webchat.freenode.net/?randomnick=1&channels=%23monero-dev&prompt=1&uio=d4) + +## Build + +| Operating System | Processor | Status | +| --------------------- | -------- |--------| +| Ubuntu 16.04 | i686 | [](https://build.getmonero.org/builders/monero-static-ubuntu-i686) +| Ubuntu 16.04 | amd64 | [](https://build.getmonero.org/builders/monero-static-ubuntu-amd64) +| Ubuntu 16.04 | armv7 | [](https://build.getmonero.org/builders/monero-static-ubuntu-arm7) +| Debian Stable | armv8 | [](https://build.getmonero.org/builders/monero-static-debian-armv8) +| OSX 10.10 | amd64 | [](https://build.getmonero.org/builders/monero-static-osx-10.10) +| OSX 10.11 | amd64 | [](https://build.getmonero.org/builders/monero-static-osx-10.11) +| OSX 10.12 | amd64 | [](https://build.getmonero.org/builders/monero-static-osx-10.12) +| FreeBSD 11 | amd64 | [](https://build.getmonero.org/builders/monero-static-freebsd64) +| DragonFly BSD 4.6 | amd64 | [](https://build.getmonero.org/builders/monero-static-dragonflybsd-amd64) +| Windows (MSYS2/MinGW) | i686 | [](https://build.getmonero.org/builders/monero-static-win32) +| Windows (MSYS2/MinGW) | amd64 | [](https://build.getmonero.org/builders/monero-static-win64) + +## Coverage + +| Type | Status | +|-----------|--------| +| Coverity | [](https://scan.coverity.com/projects/9657/) +| Coveralls | [](https://coveralls.io/github/monero-project/monero?branch=master) +| License | [](https://opensource.org/licenses/BSD-3-Clause) ## Introduction @@ -19,7 +40,7 @@ Monero is a private, secure, untraceable, decentralised digital currency. You ar **Privacy:** Monero 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 24 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. +**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. @@ -29,7 +50,7 @@ This is the core implementation of Monero. It is open source and completely free 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 Monero's codebase!** If you have a fix or code change, feel free to submit is 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. +**Anyone is welcome to contribute to Monero'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. ## Supporting the Project @@ -41,6 +62,8 @@ The Monero donation address is: `44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft The Bitcoin donation address is: `1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H` +*Note: you can easily donate XMR to the Monero donation address by using the `donate` command. Type `help` in the command-line wallet for details.* + Core development funding and/or some supporting services are also graciously provided by sponsors: [<img width="80" src="https://static.getmonero.org/images/sponsors/mymonero.png"/>](https://mymonero.com) @@ -57,11 +80,34 @@ There are also several mining pools that kindly donate a portion of their fees, See [LICENSE](LICENSE). +# Contributing + +If you want to help out, see [CONTRIBUTING](CONTRIBUTING.md) for a set of guidelines. + +## Vulnerability Response Process + +See [Vulnerability Response Process](VULNERABILITY_RESPONSE_PROCESS.md). + +## Monero software updates and consensus protocol changes (hard fork schedule) + +Monero uses a fixed-schedule hard fork mechanism to implement new features. This means that users of Monero (end users and service providers) need to run current versions and update their software on a regular schedule. Here is the current schedule, versions, and compatibility. +Dates are provided in the format YYYY-MM-DD. + + +| Fork Date | Consensus version | Minimum Monero Version | Recommended Monero Version | Details | +| ----------------- | ----------------- | ---------------------- | -------------------------- | ------------------ | +| 2016-09-21 | v3 | v0.9.4 | v0.10.0 | Splits coinbase into denominations | +| 2017-01-05 | v4 | v0.10.1 | v0.10.2.1 | Allow normal and RingCT transactions | +| 2017-04-15 | v5 | v0.10.3.0 | v0.10.3.1 | Adjusted minimum blocksize and fee algorithm | +| 2017-09-21 | v6 | Not determined as of 2017-03-27 | Not determined as of 2017-03-27 | Allow only RingCT transactions | + ## Installing Monero from a Package Packages are available for -* Arch Linux via AUR: [`bitmonero-git`](https://aur.archlinux.org/packages/bitmonero-git) +* Arch Linux (via [AUR](https://aur.archlinux.org/)): + - Stable release: [`monero`](https://aur.archlinux.org/packages/monero) + - Bleeding edge: [`bitmonero-git`](https://aur.archlinux.org/packages/bitmonero-git) * OS X via [Homebrew](http://brew.sh) @@ -98,20 +144,20 @@ library archives (`.a`). | GCC | 4.7.3 | NO | `build-essential` | `base-devel` | NO | | | CMake | 3.0.0 | NO | `cmake` | `cmake` | NO | | | pkg-config | any | NO | `pkg-config` | `base-devel` | NO | | -| Boost | 1.58 | NO | `libboost-all-dev` | `boost` | NO | | -| BerkeleyDB | 4.8 | NO | `libdb{,++}-dev` | `db` | NO | | -| libevent | 2.0 | NO | `libevent-dev` | `libevent` | NO | | -| libunbound | 1.4.16 | YES | `libunbound-dev` | `unbound` | NO | | +| Boost | 1.58 | NO | `libboost-all-dev` | `boost` | NO | C++ libraries | +| OpenSSL | basically any | NO | `libssl-dev` | `openssl` | NO | sha256 sum | +| libunbound | 1.4.16 | YES | `libunbound-dev` | `unbound` | NO | DNS resolver | | libminiupnpc | 2.0 | YES | `libminiupnpc-dev` | `miniupnpc` | YES | NAT punching | -| libunwind | any | NO | `libunwind8-dev` | `libunwind` | YES | stack traces | -| ldns | 1.6.17 | NO | `libldns-dev` | `ldns` | YES | ? | -| expat | 1.1 | NO | `libexpat1-dev` | `expat` | YES | ? | -| GTest | 1.5 | YES | `libgtest-dev`^ | `gtest` | YES | test suite | -| Doxygen | any | NO | `doxygen` | `doxygen` | YES | documentation | -| Graphviz | any | NO | `graphviz` | `graphviz` | YES | documentation | +| libunwind | any | NO | `libunwind8-dev` | `libunwind` | YES | Stack traces | +| liblzma | any | NO | `liblzma-dev` | `xz` | YES | For libunwind | +| ldns | 1.6.17 | NO | `libldns-dev` | `ldns` | YES | SSL toolkit | +| expat | 1.1 | NO | `libexpat1-dev` | `expat` | YES | XML parsing | +| GTest | 1.5 | YES | `libgtest-dev`^ | `gtest` | YES | Test suite | +| Doxygen | any | NO | `doxygen` | `doxygen` | YES | Documentation | +| Graphviz | any | NO | `graphviz` | `graphviz` | YES | Documentation | [^] On Debian/Ubuntu `libgtest-dev` only includes sources and headers. You must -build the library binary manually. +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/ ``` ### Build instructions @@ -131,7 +177,11 @@ invokes cmake commands as needed. 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 `build/release/bin`. +* The resulting executables can be found in `build/release/bin` + +* Add `PATH="$PATH:$HOME/monero/build/release/bin"` to `.profile` + +* Run Monero with `monerod --detach` * **Optional**: build and run the test suite to verify the binaries: @@ -151,6 +201,50 @@ invokes cmake commands as needed. HAVE_DOT=YES doxygen Doxyfile +#### On the Raspberry Pi + +Tested on a Raspberry Pi 2 with a clean install of minimal Debian Jessie from https://www.raspberrypi.org/downloads/raspbian/ + +* `apt-get update && apt-get upgrade` to install all of the latest software + +* Install the dependencies for Monero except libunwind and libboost-all-dev + +* 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 +``` +* 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.62.0/boost_1_62_0.tar.bz2 + tar xvfo boost_1_62_0.tar.bz2 + cd boost_1_62_0 + ./bootstrap.sh + sudo ./b2 +``` +* Wait ~8 hours + + sudo ./bjam install + +* Wait ~4 hours + +* Change to the root of the source code directory and build: + + cd monero + make release + +* Wait ~4 hours + +* The resulting executables can be found in `build/release/bin` + +* Add `PATH="$PATH:$HOME/monero/build/release/bin"` to `.profile` + +* Run Monero with `monerod --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 #### On Windows: @@ -203,7 +297,7 @@ application. ### On FreeBSD: -The project can be built from scratch by following instructions for Linux above. +The project can be built from scratch by following instructions for Linux above. If you are running monero 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 Monero into the ports tree in the near future, which will aid in managing installations using ports or packages. @@ -228,9 +322,9 @@ By default, in either dynamically or statically linked builds, binaries target t * ```make release-static-64``` builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processors * ```make release-static-32``` builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processors -* ```make release-static-arm8``` builds binaries on Linux on armv8 portable across POSIX systems on armv8 processors -* ```make release-static-arm7``` builds binaries on Linux on armv7 portable across POSIX systems on armv7 processors -* ```make release-static-arm6``` builds binaries on Linux on armv7 or armv6 portable across POSIX systems on armv6 processors, such as the Raspberry Pi +* ```make release-static-armv8``` builds binaries on Linux portable across POSIX systems on armv8 processors +* ```make release-static-armv7``` builds binaries on Linux portable across POSIX systems on armv7 processors +* ```make release-static-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 @@ -292,3 +386,64 @@ While monerod and monero-wallet-cli do not use readline directly, most of the fu Note: rlwrap will save things like your seed and private keys, if you supply them on prompt. You may want to not use rlwrap when you use simplewallet to restore from seed, etc. +# Debugging + +This section contains general instructions for debugging failed installs or problems encountered with Monero. First ensure you are running the latest version built from the github repo. + +## Obtaining Stack Traces and Core Dumps on Unix Systems + +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/monerod `pidof monerod` +``` + +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 + +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 monerod. + +You can now analyse this core dump with `gdb` as follows: + +`gdb /path/to/monerod /path/to/dumpfile` + +Print the stack trace with `bt` + +* To run monero within gdb: + +Type `gdb /path/to/monerod` + +Pass command-line options with `--args` followed by the relevant arguments + +Type `run` to run monerod + +## Analysing Memory Corruption + +We use the tool `valgrind` for this. + +Run with `valgrind /path/to/monerod`. It will be slow. + +## LMDB + +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 ~/monero/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. |