d0s3t3ch/wowlet
1
0
Fork 0
mirror of https://git.wownero.com/wowlet/wowlet.git synced 2024-08-15 01:03:14 +00:00
Code Issues Projects Releases Wiki Activity
wowlet/docs/HACKING.md

2.6 KiB
Raw Blame History

Documentation for developers

WOWlet 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).

Jetbrains Clion

WOWlet was developed using JetBrains Clion since it integrates nicely with CMake and comes with a built-in debugger. To pass CMake flags to CLion, go to File->Settings->Build->CMake, set Build Type to Debug and set your preferred CMake options/definitions.

Man Page

There is a WOWlet's manual page, which can be accessed with: man wowlet

If a new option is introduced, please be sure to update the options section in src/assets/wowlet.1.md, the month and year in line 3, and "manify" the document by running this command: pandoc wowlet.1.md -s -t man -o wowlet.1 && gzip wowlet.1

Requirements

(Possibly out-of-date)

Ubuntu/Debian

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 libpng-dev

CMake

After installing Qt you might have a folder called /home/$USER/Qt/. You need to pass this to CMake via the CMAKE_PREFIX_PATH definition.

-DCMAKE_PREFIX_PATH=/home/$USER/QtFooBar/5.15.0/gcc_64

There are some Wownero/WOWlet related options/definitions that you may pass, see also CMakeLists.txt.

At a bare minimum, recommended:

-DMANUAL_SUBMODULES=1 -DUSE_DEVICE_TREZOR=OFF -DUSE_SINGLE_BUILDDIR=ON -DDEV_MODE=ON

If you have OpenSSL installed at 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.

-DCMAKE_VERBOSE_MAKEFILE=ON

Enable debugging symbols:

-DCMAKE_BUILD_TYPE=Debug

Wowlet

It's best to install Tor locally as a service and start wowlet with --use-local-tor, this prevents the child process from starting up each time you launch WOWlet and thus saves time.

Ubuntu/Debian

apt install -y tor
sudo service tor start

To skip the wizards and open a wallet directly use --wallet-file:

./wowlet --use-local-tor --wallet-file /home/user/Wownero/wallets/bla.keys