Documentation for developers
Feather is developed primarily on Linux. It uses Qt 5.15.* and chances are that your distro's package manager has a lower version. It is therefore recommended that you install Qt manually using the online installer, which can be found here: https://www.qt.io/download (under open-source).
Feather was developed using JetBrains Clion since it integrates nicely
with CMake and comes with a built-in debugger. To pass CMake flags to CLion,
File->Settings->Build->CMake, set Build Type to
Debug and set your
preferred CMake options/definitions.
apt install -y git cmake libqrencode-dev build-essential cmake libboost-all-dev \ miniupnpc libunbound-dev graphviz doxygen libunwind8-dev pkg-config libssl-dev \ libzmq3-dev libsodium-dev libhidapi-dev libnorm-dev libusb-1.0-0-dev libpgm-dev \ libprotobuf-dev protobuf-compiler libgcrypt20-dev libzip-dev
brew install boost zmq openssl libpgm miniupnpc libsodium expat libunwind-headers \ protobuf libgcrypt qrencode ccache cmake pkgconfig git
After installing Qt you might have a folder called
/home/$user/Qt/. You need to pass this to CMake
CMAKE_PREFIX_PATH definition. For me this is:
There are some Monero/Feather related options/definitions that you may pass:
-DLOCALMONERO=OFF- disable LocalMonero feature
-DXMRIG=OFF- disable XMRig feature
-DTOR_BIN=/path/to/tor- Embed a Tor executable inside Feather
-DDONATE_BEG=OFF- disable the dreaded donate requests
-DCHECK_UPDATES=ON- enable checking for updates, only for standalone binaries
-DMANUAL_SUBMODULES=1 -DUSE_DEVICE_TREZOR=OFF -DUSE_SINGLE_BUILDDIR=ON -DDEV_MODE=ON
If you have OpenSSL installed in a custom location, try:
-DOPENSSL_INCLUDE_DIR=/usr/local/lib/openssl-1.1.1g/include -DOPENSSL_SSL_LIBRARY=/usr/local/lib/openssl-1.1.1g/libssl.so.1.1 -DOPENSSL_CRYPTO_LIBRARY=/usr/local/lib/openssl-1.1.1g/libcrypto.so.1.1
I prefer also enabling verbose makefiles, which may be useful in some situations.
Enable debugging symbols:
It's best to install Tor locally as a service and start Feather with
prevents the child process from starting up and saves time.
apt install -y tor sudo service tor start
brew install tor brew services start tor
To skip the wizards and open a wallet directly use
./feather --use-local-tor --wallet-file /home/user/Monero/wallets/bla.keys
It is recommended that you use
--stagenet for development. Testnet is also possible,
but you'll have to provide Feather a testnet node of your own.