|
|
|
|
@ -1,673 +1,162 @@
|
|
|
|
|
# Monero
|
|
|
|
|
# ~~Mo~~Wownero - Such privacy! Many coins! Wow! 🐕
|
|
|
|
|
|
|
|
|
|
Copyright (c) 2014-2022 The Monero Project.
|
|
|
|
|
Copyright (c) 2014-2023 The Monero Project.
|
|
|
|
|
Portions Copyright (c) 2012-2013 The Cryptonote developers.
|
|
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
|
|
|
|
|
- [Development resources](#development-resources)
|
|
|
|
|
- [Vulnerability response](#vulnerability-response)
|
|
|
|
|
- [Research](#research)
|
|
|
|
|
- [Announcements](#announcements)
|
|
|
|
|
- [Translations](#translations)
|
|
|
|
|
- [Coverage](#coverage)
|
|
|
|
|
- [Introduction](#introduction)
|
|
|
|
|
- [About this project](#about-this-project)
|
|
|
|
|
- [Supporting the project](#supporting-the-project)
|
|
|
|
|
- [License](#license)
|
|
|
|
|
- [Contributing](#contributing)
|
|
|
|
|
- [Scheduled software upgrades](#scheduled-software-upgrades)
|
|
|
|
|
- [Release staging schedule and protocol](#release-staging-schedule-and-protocol)
|
|
|
|
|
- [Compiling Monero from source](#compiling-monero-from-source)
|
|
|
|
|
- [Dependencies](#dependencies)
|
|
|
|
|
- [Internationalization](#Internationalization)
|
|
|
|
|
- [Using Tor](#using-tor)
|
|
|
|
|
- [Pruning](#Pruning)
|
|
|
|
|
- [Debugging](#Debugging)
|
|
|
|
|
- [Known issues](#known-issues)
|
|
|
|
|
|
|
|
|
|
## Development resources
|
|
|
|
|
|
|
|
|
|
- Web: [getmonero.org](https://getmonero.org)
|
|
|
|
|
- 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 Libera](https://web.libera.chat/#monero-dev)
|
|
|
|
|
- It is HIGHLY recommended that you join the #monero-dev IRC channel if you are developing software that uses Monero. Due to the nature of this open source software project, joining this channel and idling is the best way to stay updated on best practices and new developments in the Monero ecosystem. All you need to do is join the IRC channel and idle to stay updated with the latest in Monero development. If you do not, you risk wasting resources on developing integrations that are not compatible with the Monero network. The Monero core team and community continuously make efforts to communicate updates, developments, and documentation via other platforms – but for the best information, you need to talk to other Monero developers, and they are on IRC. #monero-dev is about Monero development, not getting help about using Monero, or help about development of other software, including yours, unless it also pertains to Monero code itself. For these cases, checkout #monero.
|
|
|
|
|
|
|
|
|
|
## Vulnerability response
|
|
|
|
|
|
|
|
|
|
- Our [Vulnerability Response Process](https://github.com/monero-project/meta/blob/master/VULNERABILITY_RESPONSE_PROCESS.md) encourages responsible disclosure
|
|
|
|
|
- We are also available via [HackerOne](https://hackerone.com/monero)
|
|
|
|
|
|
|
|
|
|
## Research
|
|
|
|
|
|
|
|
|
|
The [Monero Research Lab](https://src.getmonero.org/resources/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 the Monero research community if you have questions, wish to collaborate, or would like guidance to help avoid unnecessarily duplicating earlier or known work.
|
|
|
|
|
|
|
|
|
|
The Monero research community is available on IRC in [#monero-research-lab on Libera](https://web.libera.chat/#monero-research-lab), which is also accessible via Matrix.
|
|
|
|
|
|
|
|
|
|
## Announcements
|
|
|
|
|
|
|
|
|
|
- You can subscribe to an [announcement listserv](https://lists.getmonero.org) 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, Weblate, on [translate.getmonero.org]( https://translate.getmonero.org/projects/monero/cli-wallet/). 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 Weblate, you can find a guide with screenshots [here](https://github.com/monero-ecosystem/monero-translations/blob/master/weblate.md).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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](https://github.com/monero-ecosystem/monero-translations#contacts).
|
|
|
|
|
|
|
|
|
|
## Coverage
|
|
|
|
|
|
|
|
|
|
| Type | Status |
|
|
|
|
|
|-----------|--------|
|
|
|
|
|
| Coverity | [](https://scan.coverity.com/projects/9657/)
|
|
|
|
|
| OSS Fuzz | [](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:monero)
|
|
|
|
|
| Coveralls | [](https://coveralls.io/github/monero-project/monero?branch=master)
|
|
|
|
|
| License | [](https://opensource.org/licenses/BSD-3-Clause)
|
|
|
|
|
## Resources
|
|
|
|
|
|
|
|
|
|
- IRC: [OFTC #wownero](https://webchat.oftc.net/?channels=wownero)
|
|
|
|
|
- Web: [wownero.org](https://wownero.org)
|
|
|
|
|
- Twitter: [@w0wn3r0](https://twitter.com/w0wn3r0)
|
|
|
|
|
- Reddit: [/r/wownero](https://www.reddit.com/r/wownero)
|
|
|
|
|
- Mail: [wownero@wownero.org](mailto:wownero@wownero.org)
|
|
|
|
|
- Git: [git.wownero.com/wownero/wownero](https://git.wownero.com/wownero/wownero)
|
|
|
|
|
- Wownero Funding System: [funding.wownero.com](https://funding.wownero.com)
|
|
|
|
|
- Wownero Forum: [forum.wownero.com](https://forum.wownero.com)
|
|
|
|
|
- Discord: [discord.gg/ykZyAzJhDK](https://discord.com/invite/ykZyAzJhDK)
|
|
|
|
|
- Telegram: [t.me/wownero](https://t.me/wownero)
|
|
|
|
|
- Wowlet Desktop Wallet: [git.wownero.com/wowlet/wowlet](https://git.wownero.com/wowlet/wowlet/releases)
|
|
|
|
|
- Stack Wallet iOS & Android Mobile Wallet: [stackwallet.com](https://stackwallet.com)
|
|
|
|
|
- Wonerujo Android Mobile Wallet: [google store](https://play.google.com/store/apps/details?id=com.m2049r.wowwallet)
|
|
|
|
|
- Elite Wallet Android Mobile Wallet: [github](https://github.com/Elite-Labs/EliteWallet)
|
|
|
|
|
- Public Node Status: [monero.fail](https://monero.fail/?crypto=wownero)
|
|
|
|
|
- Wownero Memes: [suchwow.xyz](https://suchwow.xyz/posts/top)
|
|
|
|
|
- Market Info: [coinmarketcap.com](https://coinmarketcap.com/currencies/wownero), [coingecko.com](https://www.coingecko.com/en/coins/wownero/usd)
|
|
|
|
|
|
|
|
|
|
## Exchanges
|
|
|
|
|
|
|
|
|
|
- [AltQuick](https://altquick.com/market/Wownero)
|
|
|
|
|
- [Majestic Bank](https://majesticbank.sc)
|
|
|
|
|
- [TradeOgre](https://tradeogre.com/exchange/BTC-WOW)
|
|
|
|
|
|
|
|
|
|
### Blockchain Explorers
|
|
|
|
|
|
|
|
|
|
- https://explore.wownero.com
|
|
|
|
|
- https://muchwow.lol
|
|
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
Wownero is a privacy-centric memecoin that was fairly launched on April 1, 2018 with no pre-mine, stealth-mine or ICO. Wownero has a maximum supply of around 184 million WOW with a slow and steady emission over 50 years. It is a fork of Monero, but with its own genesis block, so there is no degradation of privacy due to ring signatures using different participants for the same tx outputs on opposing forks.
|
|
|
|
|
|
|
|
|
|
**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 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 should be encrypted with a strong passphrase to ensure they are useless if ever stolen.
|
|
|
|
|
## Supporting the project
|
|
|
|
|
|
|
|
|
|
**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.
|
|
|
|
|
Wownero is a 100% community-sponsored endeavor. Supporting services are also graciously provided by sponsors:
|
|
|
|
|
|
|
|
|
|
**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.
|
|
|
|
|
[<img src="https://git.wownero.com/wownero/meta/raw/branch/master/images/macstadium.png"
|
|
|
|
|
alt="MacStadium"
|
|
|
|
|
height="100">](https://www.macstadium.com)
|
|
|
|
|
[<img src="https://git.wownero.com/wownero/meta/raw/branch/master/images/jetbrains.png"
|
|
|
|
|
alt="JetBrains"
|
|
|
|
|
height="100">](https://www.jetbrains.com)
|
|
|
|
|
|
|
|
|
|
## About this project
|
|
|
|
|
Developers are volunteers doing this mostly for shits and giggles. If you would like to support our shenanigans and stimulant addictions, please consider donating to [WFS proposals](https://funding.wownero.com/proposals) or the dev slush fund.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
### Donation Addresses
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
WOW: `Wo3MWeKwtA918DU4c69hVSNgejdWFCRCuWjShRY66mJkU2Hv58eygJWDJS1MNa2Ge5M1WjUkGHuLqHkweDxwZZU42d16v94mP`
|
|
|
|
|
|
|
|
|
|
**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.
|
|
|
|
|
- view key: `e62e40bfd5ca7e3a7f199602a3c97df511780489e1c1861884b00c28abaea406`
|
|
|
|
|
|
|
|
|
|
## Supporting the project
|
|
|
|
|
XMR: `44SQVPGLufPasUcuUQSZiF5c9BFzjcP8ucDxzzFDgLf1VkCEFaidJ3u2AhSKMhPLKA3jc2iS8wQHFcaigM6fXmo6AnFRn5B`
|
|
|
|
|
|
|
|
|
|
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](https://openalias.org) standard. Alternatively, you can send XMR to the Monero donation address via the `donate` command (type `help` in the command-line wallet for details).
|
|
|
|
|
- view key: `cb83681c31db0c79adf18f25b2a6d05f86db1109385b4928930e2acf49a3ed0b`
|
|
|
|
|
|
|
|
|
|
The Monero donation address is:
|
|
|
|
|
`888tNkZrPN6JsEgekjMnABU4TBzc2Dt29EPAvkRxbANsAnjyPbb3iQ1YBRk1UXcdRsiKc9dhwMVgN5S9cQUiyoogDavup3H`
|
|
|
|
|
Viewkey:
|
|
|
|
|
`f359631075708155cc3d92a32b75a7d02a5dcf27756707b47a2b31b21c389501`
|
|
|
|
|
Base address for restoring with address and viewkey:
|
|
|
|
|
`44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A`
|
|
|
|
|
BTC: `bc1qcw9zglp3fxyl25zswemw7jczlqryms2lsmu464`
|
|
|
|
|
|
|
|
|
|
The Bitcoin donation address is:
|
|
|
|
|
`1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H`
|
|
|
|
|
### Open Collective
|
|
|
|
|
|
|
|
|
|
Core development funding and/or some supporting services are also graciously provided by [sponsors](https://www.getmonero.org/community/sponsorships/):
|
|
|
|
|
Open Collective is an online funding platform for open source software and collaborative communities. The platform brings together legal entities that act as a “Fiscal Host”, “Collectives” (unincorporated, community-based projects), and individuals interested in supporting projects with donations. Fiscal hosts hold donations for collectives in trust and handle all the taxes and legal stuff.
|
|
|
|
|
|
|
|
|
|
[<img width="150" src="https://www.getmonero.org/img/sponsors/tarilabs.png"/>](https://tarilabs.com/)
|
|
|
|
|
[<img width="150" src="https://www.getmonero.org/img/sponsors/globee.png"/>](https://globee.com/)
|
|
|
|
|
[<img width="150" src="https://www.getmonero.org/img/sponsors/symas.png"/>](https://symas.com/)
|
|
|
|
|
[<img width="150" src="https://www.getmonero.org/img/sponsors/forked_logo.png"/>](http://www.forked.net/)
|
|
|
|
|
[<img width="150" src="https://www.getmonero.org/img/sponsors/macstadium.png"/>](https://www.macstadium.com/)
|
|
|
|
|
Wownero is hosted by Open Collective Europe, a Brussels-based non-profit that hosts many other collectives, such as Manjaro, EndeavourOS, Xfce, and peertube.social. If you would like donate to the Wownero Project using this method, you can check out our [Wownero - Open Collective](https://opencollective.com/wownero) page.
|
|
|
|
|
|
|
|
|
|
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](https://bitcointalk.org/index.php?topic=583449.0).
|
|
|
|
|
## Release staging and Contributing
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
**Anyone is welcome to contribute to Wownero's codebase!**
|
|
|
|
|
|
|
|
|
|
See [LICENSE](LICENSE).
|
|
|
|
|
If you have a fix or code change, feel free to submit it as a pull request. Ahead of a scheduled software upgrade, a development branch will be created with the new release version tag. Pull requests that address bugs should be made to Master. Pull requests that require review and testing (generally, optimizations and new features) should be made to the development branch. All pull requests will be considered safe until the US dollar valuation of 1 Wownero equals $1000. After this valuation has been reached, more research will be needed to introduce experimental cryptography and/or code into the codebase.
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
Things to Do, Work in Progress, and Help Wanted tasks are tracked in the [Meta](https://git.wownero.com/wownero/meta/issues) repo.
|
|
|
|
|
|
|
|
|
|
If you want to help out, see [CONTRIBUTING](docs/CONTRIBUTING.md) for a set of guidelines.
|
|
|
|
|
Join `#wownero` on IRC OFTC to participate in development conversation.
|
|
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
Wownero uses a fixed-schedule software upgrade (hard fork) mechanism to implement new features. This means that users of Wownero (end users and service providers) should run current versions and upgrade their software on a regular schedule. 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 Wownero 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](https://youtu.be/KOO5S4vxi0o)
|
|
|
|
|
| 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.2 | 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.2 | forbid old RingCT transaction format
|
|
|
|
|
| 1978433 | 2019-11-30 | v12 | v0.15.0.0 | v0.16.0.0 | New PoW based on RandomX, only allow >= 2 outputs, change to the block median used to calculate penalty, v1 coinbases are forbidden, rct sigs in coinbase forbidden, 10 block lock time for incoming outputs
|
|
|
|
|
| 2210000 | 2020-10-17 | v13 | v0.17.0.0 | v0.17.3.2 | New CLSAG transaction format
|
|
|
|
|
| 2210720 | 2020-10-18 | v14 | v0.17.1.1 | v0.17.3.2 | forbid old MLSAG transaction format
|
|
|
|
|
| 2688888 | 2022-08-13 | v15 | v0.18.0.0 | v0.18.2.0 | ringsize = 16, bulletproofs+, view tags, adjusted dynamic block weight algorithm
|
|
|
|
|
| 2689608 | 2022-08-14 | v16 | v0.18.0.0 | v0.18.2.0 | forbid old v14 transaction format
|
|
|
|
|
| XXXXXXX | XXX-XX-XX | XXX | vX.XX.X.X | vX.XX.X.X | XXX |
|
|
|
|
|
| Software upgrade block height | Date | Release Name | Minimum Wownero version | Recommended Wownero version | Details |
|
|
|
|
|
|-------------------------------|------------| ----------------- |-------------------------|-----------------------------| ---------------------------------------------------------------------------------- |
|
|
|
|
|
| 1 | 2018-04-01 | Awesome Akita | v0.1.0.0 | v0.1.0.0 | Cryptonight variant 1, ringsize >= 8, sorted inputs
|
|
|
|
|
| 69,69 | 2018-04-24 | Busty Brazzers | v0.2.0.0 | v0.2.0.0 | Bulletproofs, LWMA difficulty algorithm, ringsize >= 10, reduce unlock to 4
|
|
|
|
|
| 53,666 | 2018-10-06 | Cool Cage | v0.3.0.0 | v0.3.1.3 | Cryptonight variant 2, LWMA v2, ringsize = 22, MMS
|
|
|
|
|
| 63,469 | 2018-11-11 | Dank Doge | v0.4.0.0 | v0.4.0.0 | LWMA v4
|
|
|
|
|
| 81,769 | 2019-02-19 | Erotic EggplantEmoji | v0.5.0.0 | v0.5.0.2 | Cryptonight/wow, LWMA v1 with N=144, Updated Bulletproofs, Fee Per Byte, Auto-churn
|
|
|
|
|
| 114,969 | 2019-06-14 | F For Fappening | v0.6.1.0 | v0.6.1.2 | RandomWOW, new block weight algorithm, slightly more efficient RingCT format
|
|
|
|
|
| 160,777 | 2019-11-20 | Gaping Goatse | v0.7.0.0 | v0.7.1.0 | Only allow >= 2 outputs, change to the block median used to calculate penalty, rct sigs in coinbase forbidden, 4 unlock time as protocol rule
|
|
|
|
|
| - | 2020-06-28 | Hallucinogenic Hypnotoad | v0.8.0.0 | v0.8.0.2 | Dandelion++ support
|
|
|
|
|
| 253,999 | 2020-10-09 | Illiterate Illuminati | v0.9.0.0 | v0.9.3.3 | Dynamic coinbase unlock (up to 1 mo.), Deterministic unlock times, Enforce maximum coinbase amount, show_qr_code wallet command, CLSAG
|
|
|
|
|
| 331,170 | 2021-07-04 | Junkie Jeff | v0.10.0.0 | v0.10.2.0 | Bulletproofs+, Miner Block Header Signing, Vote by Block, Change coinbase unlock time to 1 day, Reset difficulty and switch back to Monero's difficulty algorithm
|
|
|
|
|
| 514,000 | 2023-04-01 | Kunty Karen | v0.11.0.0 | v0.11.1.0 | View tags, fee changes, adjusted dynamic block weight algorithm, multisig security fixes, RPC broadcast node donation sub-address, Limit tx_extra max size to ~1kb, 12-hour difficulty adjustment window
|
|
|
|
|
|
|
|
|
|
X's indicate that these details have not been determined as of commit date.
|
|
|
|
|
|
|
|
|
|
\* indicates estimate 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 | Void pkg | Fedora pkg | Optional | Purpose |
|
|
|
|
|
| ------------ | ------------- | -------- | -------------------- | ------------ | ------------------ | ------------------- | -------- | --------------- |
|
|
|
|
|
| GCC | 5 | NO | `build-essential` | `base-devel` | `base-devel` | `gcc` | NO | |
|
|
|
|
|
| CMake | 3.5 | NO | `cmake` | `cmake` | `cmake` | `cmake` | NO | |
|
|
|
|
|
| pkg-config | any | NO | `pkg-config` | `base-devel` | `base-devel` | `pkgconf` | NO | |
|
|
|
|
|
| Boost | 1.58 | NO | `libboost-all-dev` | `boost` | `boost-devel` | `boost-devel` | NO | C++ libraries |
|
|
|
|
|
| OpenSSL | basically any | NO | `libssl-dev` | `openssl` | `libressl-devel` | `openssl-devel` | NO | sha256 sum |
|
|
|
|
|
| libzmq | 4.2.0 | NO | `libzmq3-dev` | `zeromq` | `zeromq-devel` | `zeromq-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` | `unbound-devel` | NO | DNS resolver |
|
|
|
|
|
| libsodium | ? | NO | `libsodium-dev` | `libsodium` | `libsodium-devel` | `libsodium-devel` | NO | cryptography |
|
|
|
|
|
| libunwind | any | NO | `libunwind8-dev` | `libunwind` | `libunwind-devel` | `libunwind-devel` | YES | Stack traces |
|
|
|
|
|
| liblzma | any | NO | `liblzma-dev` | `xz` | `liblzma-devel` | `xz-devel` | YES | For libunwind |
|
|
|
|
|
| libreadline | 6.3.0 | NO | `libreadline6-dev` | `readline` | `readline-devel` | `readline-devel` | YES | Input editing |
|
|
|
|
|
| expat | 1.1 | NO | `libexpat1-dev` | `expat` | `expat-devel` | `expat-devel` | YES | XML parsing |
|
|
|
|
|
| GTest | 1.5 | YES | `libgtest-dev`[1] | `gtest` | `gtest-devel` | `gtest-devel` | YES | Test suite |
|
|
|
|
|
| ccache | any | NO | `ccache` | `ccache` | `ccache` | `ccache` | YES | Compil. cache |
|
|
|
|
|
| Doxygen | any | NO | `doxygen` | `doxygen` | `doxygen` | `doxygen` | YES | Documentation |
|
|
|
|
|
| Graphviz | any | NO | `graphviz` | `graphviz` | `graphviz` | `graphviz` | YES | Documentation |
|
|
|
|
|
| lrelease | ? | NO | `qttools5-dev-tools` | `qt5-tools` | `qt5-tools` | `qt5-linguist` | YES | Translations |
|
|
|
|
|
| libhidapi | ? | NO | `libhidapi-dev` | `hidapi` | `hidapi-devel` | `hidapi-devel` | YES | Hardware wallet |
|
|
|
|
|
| libusb | ? | NO | `libusb-1.0-0-dev` | `libusb` | `libusb-devel` | `libusbx-devel` | YES | Hardware wallet |
|
|
|
|
|
| libprotobuf | ? | NO | `libprotobuf-dev` | `protobuf` | `protobuf-devel` | `protobuf-devel` | YES | Hardware wallet |
|
|
|
|
|
| protoc | ? | NO | `protobuf-compiler` | `protobuf` | `protobuf` | `protobuf-compiler` | YES | Hardware wallet |
|
|
|
|
|
| libudev | ? | NO | `libudev-dev` | `systemd` | `eudev-libudev-devel` | `systemd-devel` | YES | Hardware wallet |
|
|
|
|
|
|
|
|
|
|
[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`
|
|
|
|
|
then:
|
|
|
|
|
|
|
|
|
|
* on Debian:
|
|
|
|
|
`sudo mv libg* /usr/lib/`
|
|
|
|
|
* on Ubuntu:
|
|
|
|
|
`sudo mv lib/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:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo apt update && sudo apt install build-essential cmake pkg-config libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libexpat1-dev libpgm-dev qttools5-dev-tools libhidapi-dev libusb-1.0-0-dev libprotobuf-dev protobuf-compiler libudev-dev libboost-chrono-dev libboost-date-time-dev libboost-filesystem-dev libboost-locale-dev libboost-program-options-dev libboost-regex-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev python3 ccache doxygen graphviz
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install all dependencies at once on Arch:
|
|
|
|
|
```
|
|
|
|
|
sudo pacman -Syu --needed base-devel cmake boost openssl zeromq libpgm unbound libsodium libunwind xz readline expat gtest python3 ccache doxygen graphviz qt5-tools hidapi libusb protobuf systemd
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install all dependencies at once on Fedora:
|
|
|
|
|
```
|
|
|
|
|
sudo dnf install gcc gcc-c++ cmake pkgconf boost-devel openssl-devel zeromq-devel openpgm-devel unbound-devel libsodium-devel libunwind-devel xz-devel readline-devel expat-devel gtest-devel ccache doxygen graphviz qt5-linguist hidapi-devel libusbx-devel protobuf-devel protobuf-compiler systemd-devel
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install all dependencies at once on openSUSE:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo zypper ref && sudo zypper in cppzmq-devel libboost_chrono-devel libboost_date_time-devel libboost_filesystem-devel libboost_locale-devel libboost_program_options-devel libboost_regex-devel libboost_serialization-devel libboost_system-devel libboost_thread-devel libexpat-devel libminiupnpc-devel libsodium-devel libunwind-devel unbound-devel cmake doxygen ccache fdupes gcc-c++ libevent-devel libopenssl-devel pkgconf-pkg-config readline-devel xz-devel libqt5-qttools-devel patterns-devel-C-C++-devel_C_C++
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install all dependencies at once on macOS with the provided Brewfile:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
brew update && brew bundle --file=contrib/brew/Brewfile
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
FreeBSD 12.1 one-liner required to build dependencies:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
pkg install git gmake cmake pkgconf boost-libs libzmq4 libsodium unbound
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*Note*: If there are submodule differences between branches, you may need
|
|
|
|
|
to use `git submodule sync && git submodule update` after changing branches
|
|
|
|
|
to build successfully.
|
|
|
|
|
|
|
|
|
|
### 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.18
|
|
|
|
|
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*: 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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
* **Optional**: use ccache not to rebuild translation units, that haven't really changed. Monero's CMakeLists.txt file automatically handles it
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
sudo apt install ccache
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### 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 v0.18.2.0
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
* Build:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
USE_SINGLE_BUILDDIR=1 make release
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
* Wait 4-6 hours
|
|
|
|
|
|
|
|
|
|
* The resulting executables can be found in `build/release/bin`
|
|
|
|
|
|
|
|
|
|
* Add `export PATH="$PATH:$HOME/monero/build/release/bin"` to `$HOME/.profile`
|
|
|
|
|
|
|
|
|
|
* Run `source $HOME/.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 for `libunwind` and `libboost-all-dev`
|
|
|
|
|
|
|
|
|
|
* Install the latest version of boost (this may first require invoking `apt-get remove --purge libboost*-dev` to remove a previous version if you're not using a clean install):
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd
|
|
|
|
|
wget https://sourceforge.net/projects/boost/files/boost/1.72.0/boost_1_72_0.tar.bz2
|
|
|
|
|
tar xvfo boost_1_72_0.tar.bz2
|
|
|
|
|
cd boost_1_72_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:
|
|
|
wowario
j-berman
jeffro256
tobtoht
selsta
Boog900
_XxFedexX_
thotbot
hinto-janaiyo
moneromooo-monero
luigi1111
rbrunner7
Crypto City
Lee *!* Clagett
SChernykh
tevador
Francois Beutin
almalh