search

monero-ecosystem / pymonero

Python Monero, a fork of monero-project/monero to deliver python c++ bindings
https://getmonero.org
Other
13 stars 5 forks source link
blockchain cryptocurrency cython first-timers help-wanted monero pybind11 python python-library python3 pythonbinding

readme

Goal

Dependancies

Clone, Build & Run

Note : You can verify is wallet was created with :

Developed on Ubuntu with python 3.5 only (Don't think it works with legacy 2.7)

Python wallet/api Module descriptions

Latest version:

PYBIND11_MODULE(pywallet_api, m) {
    m.doc() = "pbdoc() ..";

    // =============================
    // TRANSACTION HISTORY
    // =============================
    py::class_<Monero::TransactionInfoImpl>(m, "TransactionInfo")
        .def(py::init<>())
        .def("direction", &Monero::TransactionInfoImpl::direction)
        .def("isPending", &Monero::TransactionInfoImpl::isPending)
        .def("isFailed", &Monero::TransactionInfoImpl::isFailed)
        .def("amount", &Monero::TransactionInfoImpl::amount)
        .def("fee", &Monero::TransactionInfoImpl::fee)
        .def("blockHeight", &Monero::TransactionInfoImpl::blockHeight)
        .def("subaddrIndex", &Monero::TransactionInfoImpl::subaddrIndex)
        .def("subaddrAccount", &Monero::TransactionInfoImpl::subaddrAccount)
        .def("label", &Monero::TransactionInfoImpl::label)
        .def("confirmations", &Monero::TransactionInfoImpl::confirmations)
        .def("unlockTime", &Monero::TransactionInfoImpl::unlockTime)
        .def("hash", &Monero::TransactionInfoImpl::hash)
        .def("timestamp", &Monero::TransactionInfoImpl::timestamp)
        .def("paymentId", &Monero::TransactionInfoImpl::paymentId)
        .def("transfers", &Monero::TransactionInfoImpl::transfers);

    py::class_<PyTransactionHistory>(m, "TransactionHistory")
        .def(py::init<>())
        .def("count", &PyTransactionHistory::count)
        .def("transaction", &PyTransactionHistory::transaction)
        .def("transactionById", &PyTransactionHistory::transactionById)
        .def("getAll", &PyTransactionHistory::getAll)
        .def("refresh", &PyTransactionHistory::refresh)
        ;

    // =============================
    // PENDING TRANSACTION
    // =============================
    py::class_<Monero::PendingTransactionImpl>(m, "PendingTransaction")
        //.def(py::init<>())
        .def("status", &Monero::PendingTransactionImpl::status)
        .def("errorString", &Monero::PendingTransactionImpl::errorString)
        .def("commit", &Monero::PendingTransactionImpl::commit)
        .def("amount", &Monero::PendingTransactionImpl::amount)
        .def("dust", &Monero::PendingTransactionImpl::dust)
        .def("fee", &Monero::PendingTransactionImpl::fee)
        .def("txid", &Monero::PendingTransactionImpl::txid)
        .def("txCount", &Monero::PendingTransactionImpl::txCount)
        .def("subaddrAccount", &Monero::PendingTransactionImpl::subaddrAccount)
        .def("subaddrIndices", &Monero::PendingTransactionImpl::subaddrIndices);

    py::enum_<Monero::PendingTransaction::Status>(m, "Status")
        .value("Status_Ok", Monero::PendingTransaction::Status::Status_Ok)
        .value("Status_Error", Monero::PendingTransaction::Status::Status_Error)
        .value("Status_Critical", Monero::PendingTransaction::Status::Status_Critical)
        .export_values();

    py::enum_<Monero::PendingTransaction::Priority>(m, "Priority")
        .value("Priority_Default", Monero::PendingTransaction::Priority::Priority_Default)
        .value("Priority_Low", Monero::PendingTransaction::Priority::Priority_Low)
        .value("Priority_Medium", Monero::PendingTransaction::Priority::Priority_Medium)
        .value("Priority_High", Monero::PendingTransaction::Priority::Priority_High)
        .value("Priority_Last", Monero::PendingTransaction::Priority::Priority_Last)
        .export_values();
    // ===============================

    // =============================
    // UNSIGNED TRANSACTION
    // =============================
    py::class_<Monero::UnsignedTransactionImpl>(m, "UnsignedTransaction")
        //.def(py::init<>())
        .def("status", &Monero::UnsignedTransactionImpl::status)
        .def("errorString", &Monero::UnsignedTransactionImpl::errorString)
        .def("amount", &Monero::UnsignedTransactionImpl::amount)
        .def("fee", &Monero::UnsignedTransactionImpl::fee)
        .def("mixin", &Monero::UnsignedTransactionImpl::mixin)
        .def("confirmationMessage", &Monero::UnsignedTransactionImpl::confirmationMessage)
        .def("paymentId", &Monero::UnsignedTransactionImpl::paymentId)
        .def("recipientAddress", &Monero::UnsignedTransactionImpl::recipientAddress)
        .def("minMixinCount", &Monero::UnsignedTransactionImpl::minMixinCount)
        .def("txCount", &Monero::UnsignedTransactionImpl::txCount)
        .def("sign", &Monero::UnsignedTransactionImpl::sign)
        ;
    // =============================

    // =============================
    // WALLET
    // =============================
    py::class_<PyWallet>(m, "Wallet")
        .def(py::init<>())
        .def_property("m_wallet", &PyWallet::getWallet, &PyWallet::setWallet)
        .def("seed", &PyWallet::seed)
        .def("getSeedLanguage", &PyWallet::getSeedLanguage)
        .def("setSeedLanguage", &PyWallet::setSeedLanguage)
        .def("status", &PyWallet::status)
        .def("errorString", &PyWallet::errorString)
        .def("setPassword", &PyWallet::setPassword)
        .def("address", &PyWallet::address)
        .def("mainAddress", &PyWallet::mainAddress)
        .def("path", &PyWallet::path)
        .def("testnet", &PyWallet::testnet)
        .def("hardForkInfo", &PyWallet::hardForkInfo)
        .def("useForkRules", &PyWallet::useForkRules)
        .def("integratedAddress", &PyWallet::integratedAddress)
        .def("secretViewKey", &PyWallet::secretViewKey)
        .def("publicViewKey", &PyWallet::publicViewKey)
        .def("secretSpendKey", &PyWallet::secretSpendKey)
        .def("publicSpendKey", &PyWallet::publicSpendKey)
        .def("store", &PyWallet::store)
        .def("filename", &PyWallet::filename)
        .def("keysFilename", &PyWallet::keysFilename)
        .def("init", &PyWallet::init)
        //.def_static("init", &PyWallet::init)
        .def("createWatchOnly", &PyWallet::createWatchOnly)
        .def("setRefreshFromBlockHeight", &PyWallet::setRefreshFromBlockHeight)
        .def("getRefreshFromBlockHeight", &PyWallet::getRefreshFromBlockHeight)
        .def("setRecoveringFromSeed", &PyWallet::setRecoveringFromSeed)
        .def("connectToDaemon", &PyWallet::connectToDaemon)
        .def("setTrustedDaemon", &PyWallet::setTrustedDaemon)
        .def("trustedDaemon", &PyWallet::trustedDaemon)
        .def("balance", &PyWallet::balance)
        .def("balanceAll", &PyWallet::balanceAll)
        .def("unlockedBalance", &PyWallet::unlockedBalance)
        .def("unlockedBalanceAll", &PyWallet::unlockedBalanceAll)
        .def("watchOnly", &PyWallet::watchOnly)
        .def("blockChainHeight", &PyWallet::blockChainHeight)
        .def("approximateBlockChainHeight", &PyWallet::approximateBlockChainHeight)
        .def("daemonBlockChainHeight", &PyWallet::daemonBlockChainHeight)
        .def("daemonBlockChainTargetHeight", &PyWallet::daemonBlockChainTargetHeight)
        .def("synchronized", &PyWallet::synchronized)
        .def("displayAmount", &PyWallet::displayAmount)
        .def("amountFromString", &PyWallet::amountFromString)
        .def("amountFromDouble", &PyWallet::amountFromDouble)
        .def("genPaymentId", &PyWallet::genPaymentId)
        .def("paymentIdValid", &PyWallet::paymentIdValid)
        .def("addressValid", &PyWallet::addressValid)
        .def("keyValid", &PyWallet::keyValid)
        .def("paymentIdFromAddress", &PyWallet::paymentIdFromAddress)
        .def("maximumAllowedAmount", &PyWallet::maximumAllowedAmount)
        // .def("init", &PyWallet::init,
        //     py::arg("argv0"),
        //     py::arg("default_log_base_name"))
        .def("debug", &PyWallet::debug)
        .def("startRefresh", &PyWallet::startRefresh)
        .def("pauseRefresh", &PyWallet::pauseRefresh)
        .def("refresh", &PyWallet::refresh)
        .def("refreshAsync", &PyWallet::refreshAsync)
        .def("setAutoRefreshInterval", &PyWallet::setAutoRefreshInterval)
        .def("autoRefreshInterval", &PyWallet::autoRefreshInterval)
        .def("addSubaddressAccount", &PyWallet::addSubaddressAccount)
        .def("numSubaddressAccounts", &PyWallet::numSubaddressAccounts)
        .def("numSubaddresses", &PyWallet::numSubaddresses)
        .def("addSubaddress", &PyWallet::addSubaddress)
        .def("getSubaddressLabel", &PyWallet::getSubaddressLabel)
        .def("setSubaddressLabel", &PyWallet::setSubaddressLabel)
        .def("submitTransaction", &PyWallet::submitTransaction)
        .def("exportKeyImages", &PyWallet::exportKeyImages)
        .def("importKeyImages", &PyWallet::importKeyImages)
        .def("defaultMixin", &PyWallet::defaultMixin)
        .def("setDefaultMixin", &PyWallet::setDefaultMixin)
        .def("setUserNote", &PyWallet::setUserNote)
        .def("getUserNote", &PyWallet::getUserNote)
        .def("getTxKey", &PyWallet::getTxKey)
        .def("checkTxKey", &PyWallet::checkTxKey)
        .def("getTxProof", &PyWallet::getTxProof)
        .def("checkTxProof", &PyWallet::checkTxProof)
        .def("getSpendProof", &PyWallet::getSpendProof)
        .def("checkSpendProof", &PyWallet::checkSpendProof)
        .def("getReserveProof", &PyWallet::getReserveProof)
        .def("checkReserveProof", &PyWallet::checkReserveProof)
        .def("signMessage", &PyWallet::signMessage)
        .def("verifySignedMessage", &PyWallet::verifySignedMessage)
        .def("parse_uri", &PyWallet::parse_uri)
        .def("getDefaultDataDir", &PyWallet::getDefaultDataDir)
        .def("rescanSpent", &PyWallet::rescanSpent)
        .def("lightWalletLogin", &PyWallet::lightWalletLogin)
        .def("lightWalletImportWalletRequest", &PyWallet::lightWalletImportWalletRequest)
        .def("connected", &PyWallet::connected)
        .def("createTransaction", &PyWallet::createTransaction)
        .def("createSweepUnmixableTransaction", &PyWallet::createSweepUnmixableTransaction)
        .def("loadUnsignedTx", &PyWallet::loadUnsignedTx)
        ;

        py::enum_<Monero::Wallet::ConnectionStatus>(m, "ConnectionStatus")
            .value("ConnectionStatus_Disconnected", Monero::Wallet::ConnectionStatus::ConnectionStatus_Disconnected)
            .value("ConnectionStatus_Connected", Monero::Wallet::ConnectionStatus::ConnectionStatus_Connected)
            .value("ConnectionStatus_WrongVersion", Monero::Wallet::ConnectionStatus::ConnectionStatus_WrongVersion)
            .export_values();

        py::enum_<Monero::Wallet::Status>(m, "Status")
            .value("Status_Ok", Monero::Wallet::Status::Status_Ok)
            .value("Status_Error", Monero::Wallet::Status::Status_Error)
            .value("Status_Critical", Monero::Wallet::Status::Status_Critical)
            .export_values();
    // =============================

    // =============================
    // WALLET MANAGER
    // =============================
    py::class_<PyWalletManager>(m, "WalletManager")
        .def(py::init<>())
        .def("walletExists", &PyWalletManager::walletExists)
        .def_property("manager", &PyWalletManager::getManager, &PyWalletManager::setManager)
        .def("createWallet", &PyWalletManager::createWallet)
        .def("openWallet", &PyWalletManager::openWallet)
        .def("recoveryWallet", &PyWalletManager::recoveryWallet, py::arg("path"),
                    py::arg("password"),
                    py::arg("mnemonic"),
                    py::arg("testnet") = 0,
                    py::arg("restoreHeight") = 0)

        .def("createWalletFromKeys", &PyWalletManager::createWalletFromKeys, py::arg("path"),
                    py::arg("password"),
                    py::arg("language"),
                    py::arg("testnet") = 0,
                    py::arg("restoreHeight") = 0,
                    py::arg("addressString"),
                    py::arg("viewKeyString"),
                    py::arg("spendKeyString"))

        .def("closeWallet", &PyWalletManager::closeWallet)
        .def("verifyWalletPassword", &PyWalletManager::verifyWalletPassword)
        .def("findWallets", &PyWalletManager::findWallets)
        .def("errorString", &PyWalletManager::errorString)
        .def("setDaemonAddress", &PyWalletManager::setDaemonAddress)
        .def("connected", &PyWalletManager::connected)
        .def("blockchainHeight", &PyWalletManager::blockchainHeight)
        .def("blockchainTargetHeight", &PyWalletManager::blockchainTargetHeight)
        .def("networkDifficulty", &PyWalletManager::networkDifficulty)
        .def("miningHashRate", &PyWalletManager::miningHashRate)
        .def("blockTarget", &PyWalletManager::blockTarget)
        .def("isMining", &PyWalletManager::isMining)
        .def("startMining", &PyWalletManager::startMining)
        .def("stopMining", &PyWalletManager::stopMining)
        .def("resolveOpenAlias", &PyWalletManager::resolveOpenAlias)
        ;

    py::class_<PyWalletManagerFactory>(m, "WalletManagerFactory")
        //.def(py::init<>())
        .def_static("setLogLevel", &PyWalletManagerFactory::setLogLevel)
        .def_static("getWalletManager", &PyWalletManagerFactory::getWalletManager);

Blockchain DB Mappings

Blockchain DB python module

PYBIND11_MODULE(pyblockchain_db_api, m) {
    m.doc() = "pbdoc() ..";

    // For returning values of vector<string>
    py::class_<std::vector<std::string>>(m, "VectorString")
        .def(py::init<>())
        .def("clear", &std::vector<std::string>::clear)
        .def("pop_back", &std::vector<std::string>::pop_back)
        .def("__len__", [](const std::vector<std::string> &v) { return v.size(); })
        .def("__iter__", [](std::vector<std::string> &v) {
            return py::make_iterator(v.begin(), v.end());
        }, py::keep_alive<0, 1>()) /* Keep vector alive while iterator is used */
        ;

    py::class_<crypto::hash>(m, "CryptoHash")
        .def(py::init<>())
        .def("data", [](const crypto::hash &h) {
            // We can change returned format as we see fit
            return short_hash_str(h);
        })
    ;

    py::class_<cryptonote::transaction>(m, "Transaction")
        // .def(py::init<>())
        // .def(py::init<cryptonote::transaction &>())
        .def_readonly("hash", &cryptonote::transaction::hash)
        .def_readonly("blob_size", &cryptonote::transaction::blob_size)
    ;

    py::class_<cryptonote::block_header>(m, "BlockHeader")
        .def_readonly("prev_id", &cryptonote::block_header::prev_id)
        .def_readonly("major_version", &cryptonote::block_header::major_version)
        .def_readonly("minor_version", &cryptonote::block_header::minor_version)
        .def_readonly("timestamp", &cryptonote::block_header::timestamp)
        .def_readonly("nonce", &cryptonote::block_header::nonce)
    ;

    py::class_<cryptonote::block>(m, "Block")
        .def("is_hash_valid", &cryptonote::block::is_hash_valid)
        .def_readonly("miner_tx", &cryptonote::block::miner_tx)
        .def_readonly("tx_hashes", &cryptonote::block::tx_hashes)
    ;

    py::class_<PyBlockchainDb>(m, "PyBlockchainDb")
        .def(py::init<>())
        .def("height", &PyBlockchainDb::height)
        .def("sync", &PyBlockchainDb::sync)
        .def("get_filenames", &PyBlockchainDb::get_filenames)
        .def("safesyncmode", &PyBlockchainDb::safesyncmode)
        .def("reset", &PyBlockchainDb::reset)
        .def("get_db_name", &PyBlockchainDb::get_db_name)
        .def("lock", &PyBlockchainDb::lock)
        .def("unlock", &PyBlockchainDb::unlock)
        .def("block_exists", &PyBlockchainDb::block_exists)
        .def("get_block_height", &PyBlockchainDb::get_block_height)
        .def("get_block_header", &PyBlockchainDb::get_block_header)
        .def("top_block_hash", &PyBlockchainDb::top_block_hash)
        .def("get_top_block", &PyBlockchainDb::get_top_block)
        .def("get_block_hash_from_height", &PyBlockchainDb::get_block_hash_from_height)
        .def("get_blocks_range", &PyBlockchainDb::get_blocks_range)

        // TODO:: Add the rest of the mappings

        .def("open", &PyBlockchainDb::open)
        .def("close", &PyBlockchainDb::close)
        ;

    // py::bind_vector<std::vector<std::string>>(m, "VectorString");

    #ifdef VERSION_INFO
        m.attr("__version__") = VERSION_INFO;
    #else
        m.attr("__version__") = "dev";
    #endif
}

Monero

Copyright (c) 2014-2018 The Monero Project.
Portions Copyright (c) 2012-2013 The Cryptonote developers.

Development resources

Vulnerability response

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:

Announcements

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 i686
Ubuntu 16.04 amd64 Ubuntu 16.04 amd64
Ubuntu 16.04 armv7 Ubuntu 16.04 armv7
Debian Stable armv8 Debian armv8
OSX 10.11 amd64 OSX 10.11 amd64
OSX 10.12 amd64 OSX 10.12 amd64
OSX 10.13 amd64 OSX 10.13 amd64
FreeBSD 11 amd64 FreeBSD 11 amd64
DragonFly BSD 4.6 amd64 DragonFly BSD amd64
Windows (MSYS2/MinGW) i686 Windows (MSYS2/MinGW) i686
Windows (MSYS2/MinGW) amd64 Windows (MSYS2/MinGW) amd64

Coverage

Type Status
Coverity Coverity Status
Coveralls Coveralls Status
License 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.

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

<<<<<<< HEAD Monero uses a fixed-schedule mandatory software upgrade (hard fork) mechanism to implement new features. This means that users of Monero (end users and service providers) need to run current versions and upgrade their software on a regular schedule. Mandatory software upgrades occur during the months of March and September. The required software for these upgrades will be available prior to the scheduled date. Please check the repository prior to this date for the proper 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.

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.

8fdf645397654956b74d6ddcd79f94bfa7bf2c5f

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
XXXXXXX 2019-04-XX XX XXXXXXXXX XXXXXXXXX X

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

Release staging schedule and protocol

<<<<<<< HEAD Approximately three months prior to a scheduled mandatory 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.

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.

8fdf645397654956b74d6ddcd79f94bfa7bf2c5f

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

Debian / Ubuntu one liner for all dependencies
sudo apt update && sudo apt install build-essential cmake pkg-config libboost-all-dev libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libldns-dev libexpat1-dev doxygen graphviz libpgm-dev

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 that invokes cmake commands as needed.

On Linux and OS X

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.

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:

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.

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

On Windows:

Binaries for Windows are built on Windows using the MinGW toolchain within MSYS2 environment. The MSYS2 environment emulates a POSIX system. The toolchain runs within the environment and cross-compiles binaries that can run outside of the environment as a regular Windows application.

Preparing the build environment

Cloning

Building

On FreeBSD:

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

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

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

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.

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

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

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

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

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

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

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

Build cppzmq

Build the cppzmq bindings.

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

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

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

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

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

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

On Solaris:

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

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

Then you can run make as usual.

On Linux for Android (using docker):

    # Build image (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:

Cross Compiling

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

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.

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

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.

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

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:

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.

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

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

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:

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.

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.