Zephyr - Lightweight PIVX client

Licence: MIT Licence
Author: Thomas Voegtlin
Language: Python (>= 3.6)
Homepage: https://github.com/mrcarlanthony/Zephyr-wallet

Getting started

Use source distribution

Zephyr is a pure python application. If you want to use the Qt interface, install the Qt dependencies:

sudo apt-get install python3-pyqt5

If you downloaded the official package (tar.gz), you can run Zephyr from its root directory without installing it on your system; all the python dependencies are included in the 'packages' directory (except quark_hash).

To install quark_hash dependency in the 'packages' dir run once:

python3 -m pip install -t packages quark_hash

To install precise tested versions of HW libs (trezor, ledeger, etc) run once:

python3 -m pip install -t packages -r contrib/deterministic-build/requirements-hw.txt

To install precise tested version of pyqt5 run once:

python3 -m pip install -t packages -r contrib/deterministic-build/requirements-binaries.txt

To run Zephyr from its root directory, just do:

./zephyr

You can also install Zephyr on your system, by running this command:

sudo apt-get install python3-setuptools
python3 -m pip install .[fast]

This will download and install the Python dependencies used by Zephyr instead of using the 'packages' directory. The 'fast' extra contains some optional dependencies that we think are often useful but they are not strictly needed.

If you cloned the git repository, you need to compile extra files before you can run Zephyr. Read the next section, "Development Version".

Using Tor proxy

Starting from Zephyr release 0.9.1 automatic Tor Proxy detection and use on wallet startup is added to Network preferences.

To use Tor Proxy on Ubuntu set it up with:

sudo apt-get install tor
sudo service tor start

Other platforms setup is described at docs/tor.md

Development version

Check out the code from GitHub:

git clone https://github.com/mrcarlanthony/Zephyr-wallet.git
cd zephyr

Run install (this should install dependencies):

python3 -m pip install .[fast]

Compile the protobuf description file:

sudo apt-get install protobuf-compiler
protoc --proto_path=zephyr --python_out=zephyr zephyr_code/paymentrequest.proto