XillyBus IP-Core Turnkey-4-FPGA-PCIe

Skip to main content

Announcing Xillybus for USB
Announcing Xillybus for High Performance Computing

• Home
• Download
• Documentation
• Licensing
• IP Core Factory
• Contact

An FPGA IP core for easy DMA over PCIe with Windows and Linux

A simple turnkey solution

• Xillybus consists of an FPGA IP core and a driver for the computer: All the low-level design is already done. Read more...
• Drivers are included in Ubuntu Linux distributions out of the box.
• FPGA designers interface with the IP core through a standard FIFO or dual-port memory
• Computer software programmers work in userspace with files, following classic UNIX programming style
• Works intuitively on both sides
• True streaming feel, no need to manage buffers. Any amount of data dropped on one side appears on the other.
• No complicated API to learn on either side.
• No driver programming
• Based upon PCI Express or AXI bus
• No PCI Express or other bus development
• Runs out-of-the-box on Windows 7 and recent Linux distributions

Features

• Very fast setup: A day or two is the typical lead time from downloading core & drivers to an end-to-end integration between host application and dedicated logic on FPGA.
• Try it first: Get your own custom built IP core for evaluation, and test it in your real design.
• Portability: Seamless transition between Xilinx and Intel FPGAs, Linux and Windows
• Robust pipe communication stream that just works.
• Scalable and flexible: Up to 160 FIFOs sharing a single PCIe link.
• Cuts development risk, cost and schedule dramatically
• Straightforward use for designers
• DMA used exclusively for data transfers, hence minimal load on processor.
• Low latency
• Intuitive data flow in both ends
• Custom generation of core to meet client's needs

Applications

• Data acquisition
• HPC (High Performance Computing)
• FPGA control from host
• Easy design of peripherals
• Interface with dedicated hardware
• Logic verification on hardware
• Fast development of dedicated lab equipment
• Debugging (Chipscope on steroids)
• Data interchange with High Level Synthesis (HLS) function

Host platforms

• Anything with PCIe: Common PC computers, PC-on-board (PCI/104-Express) and embedded processors (e.g. i.MX 6)
• Xilinx' Zynq-7000 EPP
• Intel Cyclone V SoC
• Microblaze soft processor with AXI4 bus
  

Download

•  IP core product brief

Try Xillybus with your application data from the FPGA to the host and vice versa. It's not just a demo, it works for real. Connect your application data to a standard FIFO, boot the computer or FPGA with either Windows or Linux, and see how easy it is to talk with your FPGA!

Click here for more about how Xillybus works.

© Copyright 2010-2018 Xillybus Ltd. | Email for inquiries: general@xillybus.com

Monero FPGA-Offload Bitstreams

---

For References Purposes Only Monero FPGA-Offload Bitstreams.

---

---

---

The website and initial downloads are now available at:
www.zetheron.com

PLEASE REALIZE THAT TO ACHIEVE THE FULL ADVERTISED HASH RATES REQUIRES EXTENSIVE MODIFICATIONS TO THE STOCK VCU1525 BOARD, as described here:
http://zetheron.com/index.php/hardware-modifications/

If you are interested in exploring FPGA mining, it is strongly recommended that you reach each page on the website in detail.

******************************************************


People asked me to make a new thread on this topic, so here it is.
Here are some pics and video of my 8 x Xilinx VCU1525 rig.

---

---

---

---

---

---

---

Each VCU1525 card has one Xilinx VU9P Virtex Ultrascale+ FPGA.  Hash rate for the whole rig combined is:

Keccak (Smartcash, Maxcoin):
136GH/s (17GH/s per card x eight) ($160/day at Apr-30 prices)

Tribus (Denarius, Virtus):
16.8GH/s (2.1GH/s per card x eight) ($304/day at Apr-30 prices)

Phi1612 (Luxcoin, Folm):
5.2GH/s (650MH/s per card x eight) ($456/day at Apr-30 prices)

Skunhash (Various coins):
10.4GH/s (1.3GH/s per card x eight) ($261/day at Apr-30 prices)

Those yield around US$20-$57 per card per day ($160-$456 per day for the rig).

Each VCU1525 card costs $4000, or $32K for the whole rig.

At $160-$456 per day, ROI is 70-200 days depending on the algorithm.  I'm not the only one mining with these cards.

Apparently some guy in Germany is getting 64KH/s with Cryptonight-V7 on the same VCU1525's, earning him over $100 per day per card or $800+ per day for a whole rig.

UPDATE JUNE 2/2018:
The 64KH/s hash rate is mostly likely fake.
GPU_Hoarder has achieved 22KH/s which is the true hash rate for CN7

Next up on my implementation list is SHA-224 and Neoscrypt.

I am also developing for the Bittware XUPP3R-VU9P which is an almost identical board as the VCU1525.

I'm planning on releasing the first bitstreams (FPGA config files) to the public May 30 with an embedded 4% development fee.

If you are interested in acquiring hardware, contact jason.harvey@avnet.com for the VCU1525, or Christian Robichaud of Bittware, for the Bittware XUPP3R-VU9P (crobichaud@bittware.com).

Tell them you were referred by Zetheron Technology and you want the cards for crypto-mining and they can expedite the lead time, which is currently around 4 weeks.

The intro price (at Avnet) on the VCU1525 is $3995 USD, but it will be going up to around $5K in July.

The Bittware XUPP3R-VU9P crypto version is $5895 USD, and has two advantages over the VCU1525:

_(advantage-#1): It has four QSFP28 100G ports so you can daisy chain 4 FPGA's together to mine Xevan at 162MH/s.

_(advantage-#2): It has flexible memory options, so you can install either DDR4 or QDRII+ SRAM; the QDR memory gives way faster hash rates on Equihash vs. DDR4.  

I've been in communication with many members of this forum who are already organizing a group buy.

JUNE 2/2018:
The above information is superseded by information posted on the Hardware page at www.zetheron.com ...

Pics:
https://drive.google.com/open?id=1Oh8VV0CDi-R6ls4Up9n7uJk5_gVp5OK2
https://drive.google.com/open?id=11NQoU-R08u9kJkJIMTleqe2wTaTj2jw2

5 second video to hear the noise level:
https://drive.google.com/open?id=1PYJ1Ht7r3s9zmMisEIpsngbW7C9EIENl

You'll notice the blue USB cables from the riser cards are *not* plugged into the motherboard.

The risers are only used to power the FPGA cards.  The black USB cables plug directly into the FPGA cards and directly into motherboard USB slots.

To get enough full bandwidth USB slots I have added an extra 4xUSB3-to-PCIe adapter card.

The whole rig is powered by a single Rosewill Hercules 1600W supply, each card burns 100-160W depending on the algorithm.

Any decent mining motherboard will work, the load on the CPU is very low.  Any GPU rig can be immediately converted to FPGA by swapping out the GPU cards and replacing them with FPGA cards and performing the USB cable adjustment as I described.

Personally I am hoping to sell my 48 GPU's and replace them all with FPGA's but I have been so busy with the FPGA programming I haven't had time yet.

I am also releasing bitstreams for the Avnet KU040 FPGA board and the Nexys Video FPGA board, although due to the small size of those FPGA's they can only mine a couple of algorithms profitably, and if you are serious I suggest a VU9P board.

If you are skeptical then I suggest just waiting until someone else you know has an FPGA rig up and running and you can make a decision then.

Keep in mind these chips are fully re-programmable and can mine any algorithm.

A lot people are mining with them in secret.  I hope others follow my lead and start to release their software/bitstreams publicly.

I also suggest searching non-English forums and trying to convince the others who are using these cards to publish their software.

Once the community has switched over to high end FPGA's, crypto as a whole will be far more ASIC resistant, because developing an ASIC will then have a poor ROI.

Consider that this 8 x VCU1525 can mine Skein and Myriad-Groestl and make about $7 per card per day ($56/day for the rig); not a great profit, but that is amazing considering you are competing directly against Baikal X10's which are ASIC machines.

The fact that you can still make a profit (with FPGA's) when mining directly against an ASIC shows how this technology can change the crypto landscape.

---

Additional Free Bitcoin Mining Applications

MinePeon: Open source and may need WinDisk32Imager.
EasyMiner: A GUI based miner for Windows, Linux and Android. EasyMiner acts as a convenient wrapper for the built in CG; BFGminer softwares. It auto configures your Bitcoin miners and provides performance graphs to for easy visualization of your Bitcoin mining activity.
BFGMiner: A modular ASIC, FPGA, GPU and CPU miner written in C, cross platform for Linux, Mac, and Windows including support for OpenWrt-capable routers.
CGMiner: This is a multi-threaded multi-pool GPU, FPGA and ASIC miner with ATI GPU monitoring, (over)clocking and fanspeed support for bitcoin and derivative coins.
50Miner: A GUI frontend for Windows (Poclbm, Phoenix, DiabloMiner).
BTCMiner: Bitcoin Miner for ZTEX FPGA Boards
BitMoose: Run Miners as a Windows Service.
Poclbm: Python/OpenCL GPU miner (GUI (Windows and MacOS X))
Poclbm-mod: more efficient version of Poclbm (GUI)
DiabloMiner: Java/OpenCL GPU miner (MAC OS X GUI)
RPC Miner: remote RPC miner (MAC OS X GUI)
Phoenix miner: Released in 2011. Free and open source.
CPU Miner: Mining software for solo or pooled mining.
Ufasoft Miner: CPU/GPU miner for Windows pooled mining.
Pyminer: Released in 2011. CPU mining client.
Remote Miner: Open source Bitcoin miner for pooled mining. Works with RPC Miner.
Open Source FPGA Bitcoin Miner: Released in 2011. Makes use of a compatible FPGA Board. Can be used to mine in a pool or solo.

---

Throwback Into the Year 2013:

This is an extremely significant blog post, because the large mining exchanges

FPGA Adaptive Self-Healing Bitstreams: Cryptocurrency

FPGA Mining Cards & Software Downloads:

OptEdited Article...

The FPGA discord group (https://discord.gg/25DpDCS) now has more than 3,000 members.

There are professional high level profiles companies, and individuals working on public mining software for the Xilinx FPGA UltraScale+ platforms throughout the world and have gave insider comments and algorithm advice and downloads urls at: (https://discord.gg/25DpDCS).

This signature Intense competition to produce the fastest mining software, new algorithms, and technologies -by example at the: (https://discord.gg/25DpDCS).

Most algorithms are worked by technology based independently entities passing through this site sharing ideas and inovators as exampled here at:
"Zetheron Dynavolt Technologies"   --  who are a FPGA Software and Resource.


Core Voltage Adjustments:
Orders will open soon for the Zetheron Dynavolt device ($95) which allows a 30% hash boost and dynamic voltage/current monitoring.

In the mean time if you have a DC1613A dongle and would like to build an adapter cable, the procedure is here:
VCU1525 – DC1613A Adapter Assembly Guide

You can now buy the fully modded DC1613A cable from:
https://shop.fpga.guide.

Preliminary document describing KU040 modifications (NOT FINAL):
KU040 Modifications to Power Supply

---

BTC

---

---

---

---

• Bittware CVP-13 can be ordered with or without water cooled card components.  
• Xilinx Virtex UltraScale+ VU13P 2E FPGA is the core engine of the CVP-13 PCIe BittWare card.
  Currently the Xilinx Virtex UltraScale+ VU13P 2E FPGA / CVP-13 PCIe , is the most powerful FPGA available for purchase to the general public; read more about it here. 
  Xilinx VU13P FPGA provide up to 300 amps of current to the FPGA.  
• With 46% more logic and 30% more on-chip memory than previous Xilinx FPGA chips.
  A larger power supply +plus is needed/recomended.
  The Xilinx CVP-13 FPGA Virtex-7 Ultrascale+ chip is an average of 50% faster than the BCU1525 (VU9 FPGA). 
  The Xilinx CVP-13 FPGA Virtex-7 Ultrascale+ PCIe board costs $5750-$6000 depending on the type of cooling.   
• Purchase the CVP-13 FPGA Virtex-7 Ultrascale+ PCIe board here: 
  https://store.mineority.io/sqrl/cvp13/   
  The Xilinx VU13P FPGA core-design is big enough to run the X16R (550-650MH/s) and X17 (710MH/s) algorithms, although Zetheron Technology will not have these algorithms completed until Spring 2019.
  Bittware XUPVV4-VU9P or watercooled versions.  
• The BitWare XUPVV4-VU9P or watercooled version PCIe boards have current limit variable of 150A, because the cold temperature of the FPGA reduces power consumption, and is an equal hash rate to the 170A air cooled board.  
• This BitWare XUPVV4-VU9P card is available now and the price is by quotation only and you need a large order to get a good price here:
• https://www.bittware.com/fpga/xilinx/boards/xupvv4/

123

WARNING!!!! 
Crypto-mining algorithms can stress FPGA boards to the maximum in terms of current and high lethal temperatures.

Running a bitstream beyond what your hardware is capable of cooling or supporting can result in TOTAL FAILURE, permanent damage to you hardware within hours into junk disrepair.

It is the responsibility of each and every cryptocurrency miner to be educated and factually understand the technological limitations of their hardware.

If you are uncertain, if you are new to the cryptocurreny FPGA mining the you musty join the FPGA Discord listed above.
Feel free to ask the Discord members about safe limits, user guides, manuals, tutotials and more.

For the VCU1525, we recommend that air-cooled cards not exceed 170A core current.

With immersion water-cooling there is no upper limit for this PCIe FPGA card, because it is a on-chip software-switch built-in safety mechanism that most modern cards have if they are properly designed and built.

Various bitstreams require different operating voltages. The required operating voltage is listed in brackets.

Operating the bitstream at a different voltage than the recommended voltage can cause hash errors, and-or most often hardware failures.

Maximum hash rate usually requires under-volting the card *and* immersion water-cooling.

Remind yourself often, stay vigilant and mindful that for all boards, it is the power regulators that fail first, NOT THE FPGA.

The FPGA temperature is only an indirect indicator of the temperature of the critical power regulators.

Please see the Hardware Modifications page for a simple change you can make to VCU1525 boards to "Cool The Regulators More Effectively".

Currently the highest ‘stress’ bitstream we, ("Zetheron Dynavolt Technologies"), offer is the 17GH/s 0xToken bitstream for the VCU1525/BCU1525/XBB1525.

This bitstream requires operating at 0.76V (no more, no less) and requires immersion water-cooling to hold the FPGA below 50C / 122F temperature range.

123

FPGA  Raw Data Bitstream For Downloads:

http://zetheron.com/Downloads/

Algorithm *********************	Best Coins *****************	PC Mining Software Download ****************	Mining Guide & Instructions **********************	Xilinx VCU1525, BCU1525 XBB1525 ***********************	Bittware XUPVV4-VU9 Bittware CVP-9 *******************	Bittware XUPVV4-VU13 Bittware CVP-13 ******************	Bittware XUPP3R ********************	Avnet AES-KU040-DB-G ********************	Huawei VU9P ****************
0xToken	0xBitcoin 0xBitcoincash Atlantis	FX Tokenminer	0xToken Instructions	8.8GH/s .BIT (0.85V) 10GH/s .BIT(0.85V) 11.55GH/s .BIT (0.72V) 13GH/s .BIT (0.72V) 15GH/s .BIT (0.72V) 15GH/s .MCS (0.72V) 17GH/s .BIT (0.76V)**	15GH/s .BIT (0.72V)	coming soon	6GH/s .BIT (0.68V) 10GH/s .BIT (0.72V)	200MH/s .BIT (0.95V) 2.28GH/s .BIT (0.95V) 2.40GH/s .BIT (0.95V)	coming soon
Keccak	XDNA SmartCash Maxcoin	coming soon
Neoscrypt	Feathercoin Gobyte Vivo	Oct-15 target
Secret Algorithm 1	Undisclosed	Sep-10 target
Secret Algorithm 2	Undisclosed	Sep-17 target
Secret Algorithm 3	Undisclosed	Sept-24 target
Secret Algorithm 4	Undisclosed	Sept-30 target
Secret Algorithm 5	Undisclosed	Sept-30 target

 

The 17GH/s bitstream requires that the mining software ‘report’ a voltage of 0.76V, (displayed on the mining command window), you may need to configure the ‘setpoint’ voltage to 0.80V in the LTPowerPlay software with the DC1613A, since the current is so high the voltage will drop by the time it reaches the FPGA core.  

 

If the ‘reported’ voltage is less than 0.76V in the mining window, hash errors will occur. 

If the voltage drops to 0.72V, there will massive hash errors. 

To hold the voltage at 0.76V requires immersion water-cooling blocks on the voltage regulators and the FPGA chip and lately other chips if you desire.

Opposed to an air cooled board, the immersion water-cooling blocks, will pull more power and the core voltage will drop uncontrollably until the board shuts down. 

If you set the core voltage to 0.80V in LTPowerPlay, and use BC-888 or Electrocool-100 dielectric immersion liquids to cool the board, you should be able to run continuously at 17GH/s without errors @ less than 0.1% and reported core voltage stable at 0.76V.

The following table shows the FPGA core current drawn by the VU9P FPGA when mining 0xToken at different hash rates and core voltages:

0xToken VU9P Iccint Current Table

8.8GH/s at 0.85V = 141.6A core current
8.8GH/s at 0.72V = 112.8A
8.8GH/s at 0.68V = 105.3A
8.8GH/s at 0.64V = 98.1A
8.8GH/s at 0.60V = 91.2A (2% errors)
10GH/s at 0.85V = 163.5A
10GH/s at 0.72V = 130.5A
10GH/s at 0.65V = 114A
13GH/s at 0.72V = 159.6A
13GH/s at 0.70V = 153.9A
13GH/s at 0.68V = 148.5A
13GH/s at 0.66V = 143.4A
15GH/s at 0.72V = 187.5A
15GH/s at 0.70V = 177.9A
17GH/s at 0.76V = 217A

Drivers:
Install the FTDI D2XX drivers from the FTDI website here:     http://www.ftdichip.com/Drivers/D2XX.htm

Install the Windows version of the drivers).
Download Vivado Lab Edition here:       
https://www.xilinx.com/support/download.html
 

 (Download the Windows version of Vivado LAB edition).
For the Avnet KU040 board you will need the Silicon Labs VCP drivers here:
https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers

Installation/Operating instructions:
Download the instructions for the VCU1525 here. 

For the KU040, the procedure is the same, but you must also install the Silicon Labs VCP drivers from the link above. 

There is also an instructional video compiled by an independent 3rd party (The Technicals) here:

Videos Developed by: Think Up Themes Ltd. Powered by WordPress.

---

Xilinx Archives Since 2012 for:
Xilinx Virtex 7 V2000T PCI Express Board X690T HTG-700 and other 
development Xilinx boards.

[Enter Data Set Here]

FPGA Group-Venture-Capital Contacts: Cryptocurrency

---

FPGA InfoSec Contact:

---

---

IMPORTANT: If you have questions about FPGA mining, please visit https://fpga.guide.

This links to a 3rd party website that has compiled an excellent guide for people new to FPGA mining.

---

To send an inquiry directly to Zetheron Technology please e-mail info@zetheron.com.  For a list of supported hardware devices see the Hardware page.

If your FPGA device is not on the list of supported devices, we are unable to help you.  We are currently overwhelmed with inquiries.

Please allow 7+ days for a response. In the mean time we suggest joining the FPGA discord channel which has 1000+ members who can help answer your questions about FPGA mining.

You can join here:
https://discord.gg/25DpDCS

---

---

---

---

---

---

---

---

Frequently Asked Questions

• What is the Ethereum hash rate?
• Answer:  The VU9P FPGA cannot mine Ethereum any better than a GPU.  In fact your ROI will be better with a GPU for Ethereum.
• How can I order FPGA cards from you?
• Answer:  Zetheron Technology does not sell any hardware or software.  Software is free with an embedded 4% development fee.  Hardware must be purchased from: https://store.mineority.io, https://shop.fpga.guide, www.avnet.com, www.bittware.com
• Can I send my FPGA cards to you and have them programmed?
• No — you dowload *.bit configuration files from the Zetheron website or from websites of other developers and you load them into the FPGA using a program called Vivado Lab Edition.  So you load the configuration files into the FPGA cards yourself.  It is very simple.
• Do other companies offer mining software for the VU9P FPGA platform?
• Yes, there are now at least 7 different individuals or companies working on developing public mining software for this platform.  You can communicate with all of them in the FPGA Discord channel (linked above).

---

SuperFPGA/Monero 28-G/hs FPGA

SuperFPGA - Adaptable. Intelligent.

Vendor	Personal Homepage
BEEcube	BEEcube
DINI GROUP	DINI GROUP
HiTech Global	HiTech Global

Board Name	Personal Homepage	FPGA
BEEcube bee4	BEEcube bee4	Quad Xilinx Virtex-6 550T FFG1759
BEEcube bee7	BEEcube bee7	Quad Xilinx Virtex-7 690T FFG1927
ATCA-3671	ATCA-3671	Quad Xilinx Virtex-7 690T FFG1927
NetFPGA SUME	NetFPGA SUME	Xilinx Virtex-7 690T FFG1761
VC709	VC709	Xilinx Virtex-7 690T FFG1761
DNV6_F2PCIe	DNV6_F2PCIe	Dual Xilinx Virtex-6 760 FFG1760
DN-DualV6-PCIe-4	DN-DualV6-PCIe-4	Dual Xilinx Virtex-6 365T FFG1156
HTG-600	HTG-600	Xilinx Virtex-6 550T FFG1759
HTG-700	HTG-700	Xilinx Virtex-7 690T FFG1761

---

BTC

---

---

---

---

Welcome to join me. If you have any issues or try these boards, please contact superfpga@163.com

I collected and validated some good algorithms by myself, please click here！

SuperFPGA

www.superfpga.com 鲁ICP备19008699号-1

Monero-(XMR) 30-G/hs FPGA

Monero

Copyright © 2014-2019 The Monero Project.
Portions Copyright © 2012-2013 The Cryptonote developers.

---

BTC

---

---

---

---

---

Table of Contents

• Development resources
• Vulnerability response
• Research
• Announcements
• Translations
• Build
  • IMPORTANT
• Coverage
• Introduction
• About this project
• Supporting the project
• License
• Contributing
• Scheduled software upgrades
• Release staging schedule and protocol
• Compiling Monero from source
  • Dependencies

Development resources

• Web: getmonero.org
• Forum: forum.getmonero.org
• Mail: dev@getmonero.org
• GitHub: https://github.com/monero-project/monero
• IRC: #monero-dev on Freenode

Vulnerability response

• Our Vulnerability Response Process encourages responsible disclosure
• We are also available via HackerOne

Research

The Monero Research Lab is an open forum where the community coordinates research into Monero cryptography, protocols, fungibility, analysis, and more. We welcome collaboration and contributions from outside researchers! Because not all Lab work and publications are distributed as traditional preprints or articles, they may be easy to miss if you are conducting literature reviews for your own Monero research. You are encouraged to get in touch with our researchers if you have questions, wish to collaborate, or would like guidance to help avoid unnecessarily duplicating earlier or known work.
Our researchers are available on IRC in #monero-research-lab on Freenode or by email:

• Sarang Noether, Ph.D.: sarang@getmonero.org or sarang.noether@protonmail.com; research repository
• Surae Noether (Brandon Goodell), Ph.D.: surae@getmonero.org or surae.noether@protonmail.com; research repository

Announcements

• You can subscribe to an announcement listserv to get critical announcements from the Monero core team. The announcement list can be very helpful for knowing when software updates are needed.

Translations

The CLI wallet is available in different languages. If you want to help translate it, see our self-hosted localization platform, Pootle, on translate.getmonero.org. Every translation must be uploaded on the platform, pull requests directly editing the code in this repository will be closed. If you need help with Pootle, you can find a guide with screenshots here.
If you need help/support/info about translations, contact the localization workgroup. You can find the complete list of contacts on the repository of the workgroup: monero-translations.

Build

IMPORTANT

These builds are of the master branch, which is used for active development and can be either unstable or incompatible with release software. Please compile release branches.

Operating System	Processor	Status
Ubuntu 16.04	i686
Ubuntu 16.04	amd64
Ubuntu 16.04	armv7
Debian Stable	armv8
macOS 10.11	amd64
macOS 10.12	amd64
macOS 10.13	amd64
FreeBSD 11	amd64
DragonFly BSD 4.6	amd64
Windows (MSYS2/MinGW)	i686
Windows (MSYS2/MinGW)	amd64

Coverage

Type	Status
Coverity
Coveralls
License

Introduction

Monero 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: 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 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.
Decentralization: The utility of monero depends on its decentralised peer-to-peer consensus network - anyone should be able to run the monero software, validate the integrity of the blockchain, and participate in all aspects of the monero network using consumer-grade commodity hardware. Decentralization of the monero network is maintained by software development that minimizes the costs of running the monero software and inhibits the proliferation of specialized, non-commodity hardware.

About this project

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

Monero is a 100% community-sponsored endeavor. If you want to join our efforts, the easiest thing you can do is support the project financially. Both Monero and Bitcoin donations can be made to donate.getmonero.org if using a client that supports the OpenAlias standard. Alternatively you can send XMR to the Monero donation address via the donate command (type help in the command-line wallet for details).
The Monero donation address is: 44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A (viewkey: f359631075708155cc3d92a32b75a7d02a5dcf27756707b47a2b31b21c389501)
The Bitcoin donation address is: 1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H
Core development funding and/or some supporting services are also graciously provided by sponsors:

There are also several mining pools that kindly donate a portion of their fees, a list of them can be found on our Bitcointalk post.

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.3.0 | Cryptonight variant 1, ringsize >= 7, sorted inputs | 1685555 | 2018-10-18 | v8 | v0.13.0.0 | v0.13.0.4 | max transaction size at half the penalty free block size, bulletproofs enabled, cryptonight variant 2, fixed ringsize 11 | 1686275 | 2018-10-19 | v9 | v0.13.0.0 | v0.13.0.4 | bulletproofs required | 1788000 | 2019-03-09 | v10 | v0.14.0.0 | v0.14.1.0 | New PoW based on Cryptonight-R, new block weight algorithm, slightly more efficient RingCT format | 1788720 | 2019-03-10 | v11 | v0.14.0.0 | v0.14.1.0 | forbid old RingCT transaction format | XXXXXXX | 2019-10-XX | XX | XXXXXXXXX | XXXXXXXXX | X
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 Monero 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.5	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
OpenPGM	?	NO	libpgm-dev	libpgm	openpgm-devel	NO	For ZeroMQ
libnorm[2]	?	NO	libnorm-dev		`	YES	For ZeroMQ
libunbound	1.4.16	YES	libunbound-dev	unbound	unbound-devel	NO	DNS resolver
libsodium	?	NO	libsodium-dev	libsodium	libsodium-devel	NO	cryptography
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[1]	gtest	gtest-devel	YES	Test suite
Doxygen	any	NO	doxygen	doxygen	doxygen	YES	Documentation
Graphviz	any	NO	graphviz	graphviz	graphviz	YES	Documentation

[1] 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/ [2] libnorm-dev is needed if your zmq library was built with libnorm, and not needed otherwise
Install all dependencies at once on Debian/Ubuntu:

Install all dependencies at once on macOS with the provided Brewfile:
``` brew update && brew bundle --file=contrib/brew/Brewfile ```

FreeBSD one liner for required to build dependencies
```pkg install git gmake cmake pkgconf boost-libs cppzmq libsodium```

### Cloning the repository

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

`$ git clone --recursive https://github.com/monero-project/monero`

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

`$ cd monero && git submodule init && git submodule update`

### Build instructions

Monero uses the CMake build system and a top-level [Makefile](Makefile) that
invokes cmake commands as needed.

#### On Linux and macOS

* Install the dependencies
* Change to the root of the source code directory, change to the most 

recent release branch, and build:

    ```bash
    cd monero
    git checkout release-v0.14
    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 macOS, installing `zmq.hpp` from
    https://github.com/zeromq/cppzmq to `/usr/local/include` should fix that error.

    *Note*: The instructions above will compile the most stable release of the
    Monero software. If you would like to use and test the most recent software,
    use ```git checkout master```. The master branch may contain updates that are
    both unstable and incompatible with release software, though testing is always
    encouraged.

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

    ```bash
    make release-test
    ```

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

* **Optional**: to build binaries suitable for debugging:

    ```bash
    make debug
    ```

* **Optional**: to build statically-linked binaries:

    ```bash
    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):

    ```bash
    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](#note-for-raspbian-jessie-users).

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

* Install the dependencies for Monero from the 'Debian' column in the table above.

* Increase the system swap size:

    ```bash
    sudo /etc/init.d/dphys-swapfile stop  
    sudo nano /etc/dphys-swapfile  
    CONF_SWAPSIZE=2048
    sudo /etc/init.d/dphys-swapfile start
    ```

* If using an external hard disk without an external power supply, ensure it gets enough power to avoid hardware issues when syncing, by adding the line "max_usb_current=1" to /boot/config.txt

* Clone monero and checkout the most recent release version:

    ```bash
    git clone https://github.com/monero-project/monero.git
    cd monero
    git checkout tags/v0.14.1.0
    ```

* Build:

    ```bash
    make release
    ```

* Wait 4-6 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

#### *Note for Raspbian Jessie users:*

If you are using the older Raspbian Jessie image, compiling Monero is a bit more complicated. The version of Boost available in the Debian Jessie repositories is too old to use with Monero, 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

    ```bash
    sudo /etc/init.d/dphys-swapfile stop
    sudo nano /etc/dphys-swapfile
    CONF_SWAPSIZE=2048
    sudo /etc/init.d/dphys-swapfile start
    ```


* Then, install the dependencies for Monero 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):

    ```bash
    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

    ```bash    
    sudo ./bjam cxxflags=-fPIC cflags=-fPIC -a install
    ```

* Wait ~4 hours

* From here, follow the [general Raspberry Pi instructions](#on-the-raspberry-pi) from the "Clone monero and checkout most recent release version" step.

#### On Windows:

Binaries for Windows are built on Windows using the MinGW toolchain within
[MSYS2 environment](https://www.msys2.org). 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](https://www.msys2.org), 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:  

    ```bash
    pacman -Syu
    ```

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

    ```bash
    pacman -Syu
    ```


* Install dependencies:

    To build for 64-bit Windows:

    ```bash
    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 mingw-w64-x86_64-hidapi
    ```

    To build for 32-bit Windows:

    ```bash
    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 mingw-w64-i686-hidapi
    ```

* 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.

**Cloning**

* To git clone, run:

    ```bash
    git clone --recursive https://github.com/monero-project/monero.git
    ```

**Building**

* Change to the cloned directory, run:

    ```bash
    cd monero
    ```

* If you would like a specific [version/tag](https://github.com/monero-project/monero/tags), do a git checkout for that version. eg. 'v0.14.1.0'. If you don't care about the version and just want binaries from master, skip this step:
 
    ```bash
    git checkout v0.14.1.0
    ```

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

    ```bash
    make release-static-win64
    ```

* If you are on a 32-bit system, run:

    ```bash
    make release-static-win32
    ```

* The resulting executables can be found in `build/release/bin`

* **Optional**: to build Windows binaries suitable for debugging on a 64-bit system, run:

    ```bash
    make debug-static-win64
    ```

* **Optional**: to build Windows binaries suitable for debugging on a 32-bit system, run:

    ```bash
    make debug-static-win32
    ```

* The resulting executables can be found in `build/debug/bin`

### On FreeBSD:

The project can be built from scratch by following instructions for Linux above(but use `gmake` instead of `make`). 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.

### 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++ 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 Monero.

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 and 6.3

You will need to add a few packages to your system. `pkg_add cmake 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`.

```bash
# 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 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 monero:

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

OpenBSD >= 6.4

You will need to add a few packages to your system. pkg_add cmake gmake zeromq cppzmq libiconv boost.
The doxygen and graphviz packages are optional and require the xbase set.
Build monero: env DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/usr/local gmake release-static
Note: you may encounter the following error, when compiling the latest version of monero as a normal user:

LLVM ERROR: out of memory
c++: error: unable to execute command: Abort trap (core dumped)

Then you need to increase the data ulimit size to 2GB and try again: ulimit -d 2000000

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 (for ARM 32-bit)
docker build -f utils/build_scripts/android32.Dockerfile -t monero-android .
# Build image (for ARM 64-bit)
docker build -f utils/build_scripts/android64.Dockerfile -t monero-android .
# Create container
docker create -it --name monero-android monero-android bash
# Get binaries
docker cp monero-android:/src/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

Cross Compiling

You can also cross-compile static binaries on Linux for Windows and macOS with the depends system.

• make depends target=x86_64-linux-gnu for 64-bit linux binaries.
• make depends target=x86_64-w64-mingw32 for 64-bit windows binaries.
  • Requires: python3 g++-mingw-w64-x86-64 wine1.6 bc
• make depends target=x86_64-apple-darwin11 for macOS binaries.
  • Requires: cmake imagemagick libcap-dev librsvg2-bin libz-dev libbz2-dev libtiff-tools python-dev
• make depends target=i686-linux-gnu for 32-bit linux binaries.
  • Requires: g++-multilib bc
• make depends target=i686-w64-mingw32 for 32-bit windows binaries.
  • Requires: python3 g++-mingw-w64-i686
• make depends target=arm-linux-gnueabihf for armv7 binaries.
  • Requires: g++-arm-linux-gnueabihf
• make depends target=aarch64-linux-gnu for armv8 binaries.
  • Requires: g++-aarch64-linux-gnu

The required packages are the names for each toolchain on apt. Depending on your distro, they may have different names.
Using depends might also be easier to compile Monero on Windows than using MSYS. Activate Windows Subsystem for Linux (WSL) with a distro (for example Ubuntu), install the apt build-essentials and follow the depends steps as depicted above.
The produced binaries still link libc dynamically. If the binary is compiled on a current distribution, it might not run on an older distribution with an older installation of libc. Passing -DBACKCOMPAT=ON to cmake will make sure that the binary will run on systems having at least libc version 2.17.

Installing Monero from a package

DISCLAIMER: These packages are not part of this repository or maintained by this project’s contributors, and as such, do not go through the same review process to ensure their trustworthiness and security.
Packages are available for

• Ubuntu and snap supported systems, via a community contributed build.
  

  snap install monero --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):
  
  • Stable release: monero
  • Bleeding edge: monero-git
• Void Linux:
  

  xbps-install -S monero
  

• GuixSD
  

  guix package -i monero
  

• Docker
  

  # Build using all available cores
  docker build -t monero .
      
  # or build using a specific number of cores (reduce RAM requirement)
  docker build --build-arg NPROC=1 -t monero .
      
  # either run in foreground
  docker run -it -v /monero/chain:/root/.bitmonero -v /monero/wallet:/wallet -p 18080:18080 monero
      
  # or in background
  docker run -it -d -v /monero/chain:/root/.bitmonero -v /monero/wallet:/wallet -p 18080:18080 monero
  

• The build needs 3 GB space.
• Wait one hour or more

Packaging for your favorite distribution would be a welcome contribution!

Running monerod

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/monerod

To list all available options, run ./bin/monerod --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/monerod --log-file monerod.log --detach

To run as a systemd service, copy monerod.service to /etc/systemd/system/ and monerod.conf to /etc/. The example service assumes that the user monero 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 monero-wallet-cli, and possibly monerod, if you get crashes refreshing.

Internationalization

See README.i18n.md.

Using Tor

There is a new, still experimental, integration with Tor. The feature allows connecting over IPv4 and Tor simulatenously - IPv4 is used for relaying blocks and relaying transactions received by peers whereas Tor is used solely for relaying transactions received over local RPC. This provides privacy and better protection against surrounding node (sybil) attacks.

While Monero 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.1 on the command line or p2p-bind-ip=127.0.0.1 in monerod.conf to disable listening for connections on external interfaces.
• --no-igd on the command line or no-igd=1 in monerod.conf to disable IGD (UPnP port forwarding negotiation), which is pointless with Tor.
• DNS_PUBLIC=tcp or DNS_PUBLIC=tcp://x.x.x.x where 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, monerod uses the default list of servers defined in src/common/dns_utils.cpp.
• TORSOCKS_ALLOW_INBOUND=1 to 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 --detach when running through torsocks with systemd, (see utils/systemd/monerod.service for details).
• If you use the wallet with a Tor daemon via the loopback IP (eg, 127.0.0.1:9050), then use --untrusted-daemon unless it is your own hidden service.

Example command line to start monerod through Tor:

DNS_PUBLIC=tcp torsocks monerod --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 18081 -j ACCEPT
DNS_PUBLIC=tcp torsocks ./monerod --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

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
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 monerod. 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/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

There are two tools available:

ASAN

Configure Monero with the -D SANITIZE=ON cmake flag, eg:

cd build/debug && cmake -D SANITIZE=ON -D CMAKE_BUILD_TYPE=Debug ../..

You can then run the monero tools normally. Performance will typically halve.

valgrind

Install valgrind and run as valgrind /path/to/monerod. It will be very 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.