Skip to content

Commit

Permalink
Merge pull request #3 from rex4539/fix-typos
Browse files Browse the repository at this point in the history
Fix typos and cleanup
  • Loading branch information
TheTrunk authored Jul 28, 2018
2 parents 6334805 + 2012a4d commit 3e454be
Show file tree
Hide file tree
Showing 34 changed files with 185 additions and 185 deletions.
2 changes: 1 addition & 1 deletion .project
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>ZCashUNOfficialSwingWalletUI</name>
<name>ZcashUNOfficialSwingWalletUI</name>
<comment></comment>
<projects>
</projects>
Expand Down
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# [ZCash](https://z.cash/) Desktop GUI Wallet
# [Zcash](https://z.cash/) Desktop GUI Wallet

## *Latest Releases:* **[Linux](https://github.com/TheTrunk/zcash-swing-wallet/releases/tag/v1.1.1) [Windows](https://github.com/TheTrunk/zcash-swing-wallet/releases/tag/v1.1.2) [MacOS](https://github.com/TheTrunk/zcash-swing-wallet/releases/tag/v1.1.4)**
## *Latest Releases:* **[Linux](https://github.com/TheTrunk/zcash-swing-wallet/releases/tag/v1.1.1) [Windows](https://github.com/TheTrunk/zcash-swing-wallet/releases/tag/v1.1.2) [macOS](https://github.com/TheTrunk/zcash-swing-wallet/releases/tag/v1.1.4)**

## Graphical user interface wrapper for the [ZCash](https://z.cash/) command line tools
## Graphical user interface wrapper for the [Zcash](https://z.cash/) command line tools

This program provides a Graphical User Interface (GUI) for the ZCash client tools that acts as a wrapper and
This program provides a Graphical User Interface (GUI) for the Zcash client tools that acts as a wrapper and
presents the information in a user-friendly manner.

![Screenshot](https://github.com/TheTrunk/zcash-swing-wallet/raw/master/docs/zcashwallet.png "Main Window")

**This wallet is targeted at advanced users who understand the implications of running a full Zcash node on**
**the local machine, maintaining a full local copy of the blockchain, maintaining and backing up the**
**Zcash nodes's `wallet.dat` file etc! The wallet is not suitable for novice crypto-currency users!**
**Zcash nodes' `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 ZCash. Using the wallet**
**SECURITY WARNING: Encryption of the wallet.dat file is not yet supported for Zcash. 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.**
Expand All @@ -31,9 +31,9 @@ presents the information in a user-friendly manner.

## Building, installing and running the Wallet GUI

Before installing the Desktop GUI Wallet you need to have ZCash up and running. The following
Before installing the Desktop GUI Wallet you need to have Zcash up and running. The following
[guide](https://github.com/zcash/zcash/blob/master/README.md)
explains how to set up [ZCash](https://z.cash/).
explains how to set up [Zcash](https://z.cash/).

**For security reasons it is recommended to always build the GUI wallet program from GitHub**
**[source](https://github.com/TheTrunk/zcash-swing-wallet/archive/master.zip).**
Expand All @@ -42,7 +42,7 @@ The details of how to build it are described below (easy to follow).

1. Operating system and tools

This program supports Linux and Mac OS X and Windows.
This program supports Linux, macOS 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:
```
Expand Down Expand Up @@ -81,28 +81,28 @@ The details of how to build it are described below (easy to follow).
file `./build/jars/ZCashSwingWalletUI.jar`. In addition the JAR file
`bitcoinj-core-0.14.5.jar` is also necessary to run the wallet.

3. Installing the built ZCash GUI wallet
3. Installing the built Zcash GUI wallet

3.1. If you have built ZCash from source code:
3.1. If you have built Zcash from source code:

Assuming you have already built from source code [ZCash](https://z.cash/) in directory `/home/user/zcash/src` (for example - this is the typical build dir. for ZCash v1.1.0) which contains the command line tools `zcash-cli` and `zcashd` you need to take the created JAR files and copy them to directory `/home/user/zcash/src` (the same dir. that contains `zcash-cli` and `zcashd`). Example copy command:
Assuming you have already built from source code [Zcash](https://z.cash/) in directory `/home/user/zcash/src` (for example - this is the typical build dir. for Zcash v1.1.0) which contains the command line tools `zcash-cli` and `zcashd` you need to take the created JAR files and copy them to directory `/home/user/zcash/src` (the same dir. that contains `zcash-cli` and `zcashd`). Example copy command:
```
user@ubuntu:~/build-dir/zcash-swing-wallet$ cp -R -v ./build/jars/* /home/user/zcash/src
```
4. Running the installed ZCash GUI wallet
4. Running the installed Zcash GUI wallet
It may be run from command line or started from another GUI tool (e.g. file manager).
Assuming you have already installed [ZCash](https://z.cash/) and the GUI Wallet `ZCashSwingWalletUI.jar` in
Assuming you have already installed [Zcash](https://z.cash/) and the GUI Wallet `ZCashSwingWalletUI.jar` in
directory `/home/user/zcash/src` one way to run it from command line is:
```
user@ubuntu:~/build-dir/zcash-swing-wallet$ java -jar /home/user/zcash/src/ZCashSwingWalletUI.jar
```
If you are using Ubuntu (or similar ;) Linux you may instead just use the file manager and
right-click on the `ZCashSwingWalletUI.jar` file and choose the option "Open with OpenJDK 8 Runtime".
This will start the ZCash GUI wallet.
This will start the Zcash GUI wallet.
**Important:** the ZCash configuration file `~/.zcash/zcash.conf` needs to be correctly set up for the GUI
**Important:** the Zcash configuration file `~/.zcash/zcash.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
Expand All @@ -126,18 +126,18 @@ SOFTWARE.
### Known issues and limitations
1. Issue: The ZCash Desktop GUI Wallet is not compatible with applications that modify the ZCash `wallet.dat` file. The wallet should not be used
1. Issue: The Zcash Desktop GUI Wallet is not compatible with applications that modify the Zcash `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.
1. 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.
1. 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 `~/.ZCashSwingWalletUI/messaging` may be manually renamed or deleted (when the wallet is stopped). **CAUTION: all messaging history will be lost in this case!**
1. Limitation: Wallet encryption has been temporarily disabled in ZCash due to stability problems. A corresponding issue
[#1552](https://github.com/zcash/zcash/issues/1552) has been opened by the ZCash developers. Correspondingly
wallet encryption has been temporarily disabled in the ZCash Desktop GUI Wallet.
1. Limitation: Wallet encryption has been temporarily disabled in Zcash due to stability problems. A corresponding issue
[#1552](https://github.com/zcash/zcash/issues/1552) has been opened by the Zcash developers. Correspondingly
wallet encryption has been temporarily disabled in the Zcash Desktop GUI Wallet.
The latter needs to be disabled.
1. Limitation: The list of transactions does not show all outgoing ones (specifically outgoing Z address
transactions). A corresponding issue [#1438](https://github.com/zcash/zcash/issues/1438) has been opened
for the ZCash developers.
for the Zcash developers.
1. Limitation: The CPU percentage shown to be taken by zcashd on Linux is the average for the entire lifetime
of the process. This is not very useful. This will be improved in future versions.
1. Limitation: When using a natively compiled wallet version (e.g. `ZCashSwingWalletUI.exe` for Windows) on a
Expand Down
24 changes: 12 additions & 12 deletions docs/ReleaseUbuntuRepository.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## [ZCash](https://z.cash/) Desktop GUI Wallet APT repository for Debian/Ubuntu Linux
## [Zcash](https://z.cash/) Desktop GUI Wallet APT repository for Debian/Ubuntu Linux

This is a [ZCash](https://z.cash/) Desktop GUI Wallet made available through a package repository
This is a [Zcash](https://z.cash/) Desktop GUI Wallet made available through a package repository
for Debian/Ubuntu (and similar) Linux systems.

![Screenshot](zcashwallet.png "Main Window")
Expand All @@ -9,7 +9,7 @@ for Debian/Ubuntu (and similar) Linux systems.
**the local machine, maintaining a full local copy of the blockchain, maintaining and backing up the**
**Zcash 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 ZCash. Using the wallet**
**SECURITY WARNING: Encryption of the wallet.dat file is not yet supported for Zcash. 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.**
Expand All @@ -19,8 +19,8 @@ for Debian/Ubuntu (and similar) Linux systems.
**Users need to be prepared to fix such problems manually as described in the [troubleshooting guide](TroubleshootingGuide.md).**
**Doing so requires command line skills.**

### Installing the ZCash Desktop GUI Wallet on Linux
*Zcash is needed to be installed, follow https://z.cash/download.html prior installing this Swing wallet.*
### Installing the Zcash Desktop GUI Wallet on Linux
*Zcash is needed to be installed, follow https://z.cash/download.html prior to installing this Swing wallet.*

To setup the APT repository and install packages, using a terminal run the following commands
```
Expand All @@ -32,9 +32,9 @@ sudo apt-get update
sudo apt-get install zcashswingwallet
```

### Running the ZCash Desktop GUI Wallet on Linux
### Running the Zcash Desktop GUI Wallet on Linux

To launch the ZCash Desktop GUI Wallet you can just search and click on it in the Ubuntu unity menu or alternatively, run the command `zcashswingwallet` from a terminal:
To launch the Zcash Desktop GUI Wallet you can just search and click on it in the Ubuntu unity menu or alternatively, run the command `zcashswingwallet` from a terminal:
```
zcashswingwallet
```
Expand All @@ -52,13 +52,13 @@ SOFTWARE.
### Known issues and limitations
1. 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.
1. 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 `~/.ZCashSwingWalletUI/messaging` may be manually renamed or deleted (when the wallet is stopped). **CAUTION: all messaging history will be lost in this case!**
1. Limitation: Wallet encryption has been temporarily disabled in ZCash due to stability problems. A corresponding issue
[#1552](https://github.com/zcash/zcash/issues/1552) has been opened by the ZCash developers. Correspondingly
wallet encryption has been temporarily disabled in the ZCash Desktop GUI Wallet.
1. Limitation: Wallet encryption has been temporarily disabled in Zcash due to stability problems. A corresponding issue
[#1552](https://github.com/zcash/zcash/issues/1552) has been opened by the Zcash developers. Correspondingly
wallet encryption has been temporarily disabled in the Zcash Desktop GUI Wallet.
1. Issue: GUI data tables (transactions/addresses etc.) allow copying of data via double click but also allow editing.
The latter needs to be disabled.
1. Limitation: The list of transactions does not show all outgoing ones (specifically outgoing Z address
transactions). A corresponding issue [#1438](https://github.com/zcash/zcash/issues/1438) has been opened
for the ZCash developers.
for the Zcash developers.
1. Limitation: The CPU percentage shown to be taken by zcashd on Linux is the average for the entire lifetime
of the process. This is not very useful. This will be improved in future versions.
of the process. This is not very useful. This will be improved in future versions.
8 changes: 4 additions & 4 deletions docs/TroubleshootingGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ When wallet problems occur, the information about the errors that caused the iss
```
Linux: ~/.ZCashSwingWalletUI/ZCashGUIWallet_xxxx_xx_debug.log
Windows: %LOCALAPPDATA%/ZCashSwingWalletUI/ZCashGUIWallet_xxxx_xx_debug.log
Mac OS: ~/Library/Application Support/ZCashSwingWalletUI/ZCashGUIWallet_xxxx_xx_debug.log
macOS: ~/Library/Application Support/ZCashSwingWalletUI/ZCashGUIWallet_xxxx_xx_debug.log
```
`zcashd` that is automatically started by the wallet, stores its logs at locations:
```
Linux: ~/.zcash/debug.log,
Windows: %APPDATA%/Zcash/debug.log
Mac OS: ~/Library/Application Support/Zcash/debug.log
macOS: ~/Library/Application Support/Zcash/debug.log
```
The log files are the first place too look for clues as to the nature of problem.
The log files are the first place to look for clues as to the nature of problem.

### Common Problem 1 - wallet fails during start up

Expand All @@ -32,7 +32,7 @@ works in 90%+ of cases is to start `zcashd` manually with a `-reindex` option fr
```
zcashd -reindex
```
For non-technical users here is some information on how to open a terminal on [Windows](https://www.lifewire.com/how-to-open-command-prompt-2618089) and [Mac OS](https://www.wikihow.com/Open-a-Terminal-Window-in-Mac). The full command on Mac OS is:
For non-technical users here is some information on how to open a terminal on [Windows](https://www.lifewire.com/how-to-open-command-prompt-2618089) and [macOS](https://www.wikihow.com/Open-a-Terminal-Window-in-Mac). The full command on macOS is:
```
/Applications/ZcashWallet.app/Contents/Java/zcashd -reindex
```
Expand Down
4 changes: 2 additions & 2 deletions installer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

<parent>
<groupId>z.cash</groupId>
<artifactId>ZCashUNOfficialSwingWalletUI</artifactId>
<artifactId>ZcashUNOfficialSwingWalletUI</artifactId>
<version>0.82.9-SNAPSHOT</version>
</parent>

<artifactId>installer</artifactId>
<name>ZCash Wallet Installer</name>
<name>Zcash Wallet Installer</name>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down
2 changes: 1 addition & 1 deletion installer/src/main/izpack/i18n/customLangPack.xml_eng
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<langpack>
<str id="installer.reversetitle" txt="$APP_NAME $APP_VER"/>
<str id="installation.panel.header" txt="ZCash Desktop GUI Wallet binary release 0.80.5 for Windows"/>
<str id="installation.panel.header" txt="Zcash Desktop GUI Wallet binary release 0.80.5 for Windows"/>
</langpack>
4 changes: 2 additions & 2 deletions installer/src/main/izpack/i18n/zcashPacksLang.xml_eng
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<langpack>
<str id="myApplicationPack" txt="ZCash Desktop GUI Wallet"/>
<str id="myApplicationPack.description" txt="ZCash Desktop GUI Wallet"/>
<str id="myApplicationPack" txt="Zcash Desktop GUI Wallet"/>
<str id="myApplicationPack.description" txt="Zcash Desktop GUI Wallet"/>
</langpack>
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
<modelVersion>4.0.0</modelVersion>

<groupId>z.cash</groupId>
<artifactId>ZCashUNOfficialSwingWalletUI</artifactId>
<artifactId>ZcashUNOfficialSwingWalletUI</artifactId>
<version>0.82.9-SNAPSHOT</version>
<packaging>pom</packaging>
<name>ZCash UNOfficial Swing Wallet UI</name>
<name>Zcash UNOfficial Swing Wallet UI</name>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down Expand Up @@ -135,4 +135,4 @@
</build>
</profile>
</profiles>
</project>
</project>
4 changes: 2 additions & 2 deletions src/build/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@

<!-- TODO: As of Nov 2017 the IPFS wallet integration is suspended.
<target name="unpackIPFSForMacOS" if="isMacOS">
<echo message="Using the IPFS packaged executable on Mac OS..." />
<echo message="Using the IPFS packaged executable on macOS..." />
<mkdir dir="${temp.dir}"/>
<gunzip src="${basedir}/lib/go-ipfs_v0.4.11_darwin-amd64.tar.gz" dest="${temp.dir}/ipfs.tar"/>
</target>
Expand Down Expand Up @@ -191,7 +191,7 @@
</target>

<target name="buildit" depends="clean,jar,copyothers,ubuntuPackage">
<echo message="Built ZCash Desktop GUI Wallet with JDK ${ant.java.version}"/>
<echo message="Built Zcash Desktop GUI Wallet with JDK ${ant.java.version}"/>
<!-- Final cleanup -->
<delete dir="${classes.dir}"/>
<delete dir="${temp.dir}"/>
Expand Down
8 changes: 4 additions & 4 deletions src/java/com/vaklinov/zcashui/AddressesPanel.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@


/**
* Addresses panel - shows T/Z addresses and their balnces.
* Addresses panel - shows T/Z addresses and their balances.
*/
public class AddressesPanel
extends WalletTabPanel
Expand Down Expand Up @@ -285,7 +285,7 @@ private void createNewAddress(boolean isZAddress)

if (dBalance > 0)
{
Log.warning("New address {0} generated by ZCASHD has been used before. Will generate another!", address);
Log.warning("New address {0} generated by zcashd has been used before. Will generate another!", address);
}
} while (dBalance > 0);

Expand Down Expand Up @@ -411,7 +411,7 @@ private String[][] getAddressBalanceDataFromWallet()
// Z Addresses - they are OK
String[] zAddresses = clientCaller.getWalletZAddresses();

// T Addresses listed with the list received by addr comamnd
// T Addresses listed with the list received by addr command
String[] tAddresses = this.clientCaller.getWalletAllPublicAddresses();
Set<String> tStoredAddressSet = new HashSet<>();
for (String address : tAddresses)
Expand Down Expand Up @@ -515,4 +515,4 @@ private String[][] getAddressBalanceDataFromWallet()
return addressBalances;
}

}
}
2 changes: 1 addition & 1 deletion src/java/com/vaklinov/zcashui/CommandExecutor.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@


/**
* Executes a command and retruns the result.
* Executes a command and returns the result.
*/
public class CommandExecutor
{
Expand Down
Loading

0 comments on commit 3e454be

Please sign in to comment.