README.md 1.39 KB
Newer Older
zeroleak's avatar
zeroleak committed
1 2
[![Build Status](https://travis-ci.org/Samourai-Wallet/whirlpool-client-cli.svg?branch=develop)](https://travis-ci.org/Samourai-Wallet/whirlpool-client-cli)
[![](https://jitpack.io/v/Samourai-Wallet/whirlpool-client-cli.svg)](https://jitpack.io/#Samourai-Wallet/whirlpool-client-cli)
zeroleak's avatar
zeroleak committed
3

zeroleak's avatar
zeroleak committed
4
# whirlpool-client-gui
zeroleak's avatar
zeroleak committed
5

zeroleak's avatar
zeroleak committed
6
Desktop GUI for [Whirlpool](https://code.samourai.io/whirlpool/Whirlpool) by Samourai-Wallet.
zeroleak's avatar
zeroleak committed
7

zeroleak's avatar
zeroleak committed
8 9 10 11 12
## Requirements
- Java 8+ (OpenJDK 8+ recommended)
- A pairing payload obtained from Samourai Wallet (Android)


zeroleak's avatar
zeroleak committed
13
## Files
zeroleak's avatar
zeroleak committed
14
Whirlpool files are stored in ```userData``` which varies depending on your OS:
zeroleak's avatar
zeroleak committed
15 16 17
- MacOS: ```~/Library/Application Support/whirlpool-gui```
- Windows: ```%APPDATA%/whirlpool-gui```
- Linux: ```$XDG_CONFIG_HOME/whirlpool-gui``` or ```~/.config/whirlpool-gui```
zeroleak's avatar
zeroleak committed
18

19

zeroleak's avatar
zeroleak committed
20
#### Logs
zeroleak's avatar
zeroleak committed
21 22 23
- logs for GUI: ```whirlpool-gui.log```
- logs for CLI (when local): ```whirlpool-cli.log```

zeroleak's avatar
zeroleak committed
24
#### Configuration file
zeroleak's avatar
zeroleak committed
25 26
- CLI configuration: ```whirlpool-cli-config.properties```

zeroleak's avatar
zeroleak committed
27
#### System files
zeroleak's avatar
zeroleak committed
28 29 30 31
- CLI state for wallet: ```whirlpool-cli-state-xxx.properties```
- CLI state for utxos: ```whirlpool-cli-utxos-xxx.properties```


zeroleak's avatar
zeroleak committed
32
## Resources
33

zeroleak's avatar
zeroleak committed
34 35 36 37
- [whirlpool](https://code.samourai.io/whirlpool/Whirlpool)
- [whirlpool-protocol](https://code.samourai.io/whirlpool/whirlpool-protocol)
- [whirlpool-client](https://code.samourai.io/whirlpool/whirlpool-client)
- [whirlpool-server](https://code.samourai.io/whirlpool/whirlpool-server)