Skip to content

Latest commit

 

History

History
147 lines (118 loc) · 9.08 KB

README.md

File metadata and controls

147 lines (118 loc) · 9.08 KB
Raw

ZelCash Desktop GUI Wallet

Graphical user interface wrapper for the ZelCash command line tools

This program provides a Graphical User Interface (GUI) for the ZelCash client tools that acts as a wrapper and presents the information in a user-friendly manner. Thanks to the Zencash team who maintain the swing wallet, this is a fork of their V0.82.9.

Thank you to the Zencash Team

Screenshot

This wallet is targeted at advanced users who understand the implications of running a full Zel node on the local machine, maintaining a full local copy of the blockchain, maintaining and backing up the Zel nodes's wallet.dat file etc! The wallet is not suitable for novice crypto-currency users!

SECURITY WARNING: Encryption of the wallet.dat file is not yet supported for ZelCash. The ZelCore wallet is available for download as offers encryption by deafult of the wallet.dat You can download it here, https://zelcore.io Using the wallet on a system infected with malware may result in wallet data/funds being stolen. The wallet.dat needs to be backed up regularly (not just once - e.g. after every 30-40 outgoing transactions) and it must also be backed up after creating a new Z address.

STABILITY WARNING: The GUI wallet is as yet considered experimental! It is known to exhibit occasional stability problems related to running a full Zel node. Specifically if the locally running zelcashd cannot start properly due to issues with the local blockchain, the GUI cannot start either! Users need to be prepared to fix such problems manually as described in the troubleshooting guide. Doing so requires command line skills.

AUTO-DEPRECATION WARNING: Wallet binary releases for Mac/Windows contain ZEL full node binaries. These have an auto-deprecation feature: they are considered outdated after 18 weeks and stop working. So they need to be updated to a newer version before this term expires. Users need to ensure they use an up-to-date version of the wallet (e.g. update the wallet every two months or so).

Information on diagnosing some common problems may be found in this troubleshooting guide. //todo

Building, installing and running the Wallet GUI

For security reasons it is recommended to always build the GUI wallet program from GitHub source. The details of how to build it are described below (easy to follow).

  1. Operating system and tools

    As of June 2018 this program supports Linux and macOS X and Windows. The Linux tools you need to build and run the Wallet GUI are Git, Java (JDK8) and Ant. If using Ubuntu Linux, they may be installed via command:

    user@ubuntu:~/build-dir$ sudo apt-get install git default-jdk ant

    For RedHat/CentOS/Fedora-type Linux systems the command is (like):

    user@centos:~/build-dir$ sudo yum install java-1.8.0-openjdk git ant

    The name of the JDK package (java-1.8.0-openjdk) may vary depending on the Linux system, so you need to check it, if name java-1.8.0-openjdk is not accepted. If you have some other Linux distribution, please check your relevant documentation on installing Git, JDK and Ant. The commands git, java, javac and ant need to be startable from command line before proceeding with build.

  2. Building from source code

    As a start you need to clone the zelcash-swing-wallet Git repository:

    user@ubuntu:~/build-dir$ git clone https://github.com/zelcash/zelcash-swing-wallet.git

    Change the current directory:

    user@ubuntu:~/build-dir$ cd zelcash-swing-wallet/

    Issue the build command:

    user@ubuntu:~/build-dir/zelcash-swing-wallet$ ant -buildfile ./src/build/build.xml

    This takes a few seconds and when it finishes, it builds a JAR file ./build/jars/ZelCashSwingWalletUI.jar. You need to make this file executable:

    user@ubuntu:~/build-dir/zelcash-swing-wallet$ chmod u+x ./build/jars/ZelCashSwingWalletUI.jar

    At this point the build process is finished the built GUI wallet program is the JAR file ./build/jars/ZelCashSwingWalletUI.jar. In addition the JAR file bitcoinj-core-0.14.5.jar is also necessary to run the wallet.

  3. Installing the built ZelCash GUI wallet

    3.1. If you have built ZelCash from source code:

    Assuming you have already built from source code ZelCash in directory /home/user/zelcash/src (for example - this is the typical build dir. for ZelCash) which contains the command line tools zelcash-cli and zelcashd you need to take the created JAR files and copy them to directory /home/user/zelcash/src (the same dir. that contains zelcash-cli and zelcashd). Example copy command:

    user@ubuntu:~/build-dir/zelcash-swing-wallet$ cp -R -v ./build/jars/* /home/user/zelcash/src

  4. Running the installed ZelCash GUI wallet

    It may be run from command line or started from another GUI tool (e.g. file manager). Assuming you have already installed ZelCash and the GUI Wallet ZelCashSwingWalletUI.jar in directory /home/user/zelcash/src one way to run it from command line is:

    user@ubuntu:~/build-dir/zelcash-swing-wallet$ java -jar /home/user/zelcash/src/ZelCashSwingWalletUI.jar

    If you are using Ubuntu (or similar ;) Linux you may instead just use the file manager and right-click on the ZelCashSwingWalletUI.jar file and choose the option "Open with OpenJDK 8 Runtime". This will start the ZelCash GUI wallet.

    Important: the ZelCash configuration file ~/.zelcash/zelcash.conf needs to be correctly set up for the GUI wallet to work. Specifically the RPC user and password need to be set in it like:

    rpcuser=username
rpcpassword=wjQOHVDQFLwztWp1Ehs09q7gdjHAXjd4E

License

This program is distributed under an MIT License.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Known issues and limitations

  1. Issue: The ZelCash Desktop GUI Wallet is not compatible with applications that modify the ZEL wallet.dat file. The wallet should not be used with such applications on the same PC. For instance some distributed exchange applications are known to create watch-only addresses in the wallet.dat file that cause the GUI wallet to display a wrong balance and/or display addresses that do not belong to the wallet.
  2. Limitation: if two users exchange text messages via the messaging UI TAB and one of them has a system clock, substantially running slow or fast by more than 1 minute, it is possible that this user will see text messages appearing out of order.
  3. Limitation: if a messaging identity has been created (happens on first click on the messaging UI tab), then replacing the wallet.dat or changing the node configuration between mainnet and testnet will make the identity invalid. This will result in a wallet update error. To remove the error the directory ~/.ZelCashSwingWalletUI/messaging may be manually renamed or deleted (when the wallet is stopped). CAUTION: all messaging history will be lost in this case!
  4. Limitation: Wallet encryption has been temporarily disabled in ZelCash due to stability problems. A corresponding issue #1552 has been opened by the ZCash developers. Correspondingly wallet encryption has been temporarily disabled in the ZelCash Desktop GUI Wallet. The latter needs to be disabled.
  5. Limitation: The list of transactions does not show all outgoing ones (specifically outgoing Z address transactions). A corresponding issue #1438 has been opened for the ZCash developers.
  6. Limitation: The CPU percentage shown to be taken by zelcashd on Linux is the average for the entire lifetime of the process. This is not very useful. This will be improved in future versions.
  7. Limitation: When using a natively compiled wallet version (e.g. ZelCashSwingWalletUI.exe for Windows) on a very high resolution monitor with a specifically configured DPI scaling (enlargement) factor to make GUI elements look larger, the GUI elements of the wallet actually do not scale as expected. To correct this on Windows you need to right-click on ZelCashSwingWalletUI.exe and choose option:
Properties >> Compatibility >> Override High DPI scaling behavior >> Scaling Performed by (Application)