Commit 0b52e51d authored by zeroleak's avatar zeroleak
Browse files

cleanup

parent 0ba6bdf9
......@@ -17,7 +17,7 @@ You can setup whirlpool-client-cli in 2 ways:
java -jar target/whirlpool-client-version-run.jar
[--listen[=8899]] [--authenticate]
[--mixs-target=]
[--debug] [--debug-client] [--pushtx=auto|interactive|http://user:password@host:port] [--scode=] [--tx0-max-outputs=] {args...}
[--debug] [--debug-client] [--scode=] [--tx0-max-outputs=] {args...}
```
#### Optional arguments:
......@@ -27,10 +27,6 @@ java -jar target/whirlpool-client-version-run.jar
#### Tech arguments: you probably shouldn't use it
- debug: display debug logs from cli
- debug-client: display debug logs from whirlpool-client
- pushtx: specify how to broadcast transactions (tx0, aggregate).
* auto: by default, tx are broadcasted through Samourai service.
* interactive: print raw tx and pause to let you broadcast it manually.
* http://user:password@host:port: rpc connection to your own bitcoin node (connection is not encrypted, use on trusted network only).
- scode: optional scode to use for tx0
- tx0-max-outputs: tx0 outputs limit
......@@ -48,7 +44,7 @@ java -jar target/whirlpool-client-version-run.jar --list-pools
You need a wallet holding funds to mix.
```
[--pool=] [--client-delay=5] [--tx0-delay=20]
[--client-delay=5] [--tx0-delay=20]
[--auto-tx0=poolId] [--auto-mix] [--auto-aggregate-postmix]
```
......@@ -56,7 +52,6 @@ Example:
```
java -jar target/whirlpool-client-version-run.jar
```
- pool: poolId(s) to use, ordered by priority and separated by ','. ie: '0.1btc,0.01btc'. By default all pools will be used.
- client-delay: delay (in seconds) between each connexion
- tx0-delay: delay (in seconds) between each tx0 (from --auto-tx0)
- auto-tx0: automatically run tx0 from deposit for specified pool when premix wallet is empty
......@@ -90,13 +85,11 @@ java -jar target/whirlpool-client-version-run.jar --aggregate-postmix
```
- aggregate-postmix: move funds back to premix-wallet. Or --aggregate-postmix=address to move funds to a specific address.
### Configuration override
Local configuration can be overriden with:
```
--api-key=
```
### Expert configuration
## Advanced configuration
### Tor
```
cli.torConfig.executable = /path/to/bin/tor
```
......@@ -108,13 +101,30 @@ cli.torConfig.executable = /path/to/bin/tor
cli.torConfig.onionServer = true
cli.torConfig.onionBackend = true
```
How to connect to whirlpool server and wallet backend:
- `true`: connect to Tor v3 hidden services
- `false`: connect to clearnet over Tor
When tor enabled, connect to whirlpool server or wallet backend through:
- `true`: Tor hidden services
- `false`: clearnet over Tor
### PushTx
```
cli.pushtx = auto
```
Specify how to broadcast transactions (tx0, aggregate).
* auto: by default, tx are broadcasted through Samourai service.
* interactive: print raw tx and pause to let you broadcast it manually.
* http://user:password@host:port: rpc connection to your own bitcoin node (connection is not encrypted, use on trusted network only).
### API
whirlpool-client-cli can be managed with a REST API. See [README-API.md](README-API.md)
### ApiKey override
Local configuration can be overriden with:
```
--api-key=
```
## Build instructions
Build with maven:
......
......@@ -68,7 +68,6 @@ public class ApplicationTest extends AbstractApplicationTest {
"--seed-words=all all all all all all all all all all all all",
"--mixs=5",
"--debug",
"--pool=1btc",
"--test-mode"
};
ApplicationArguments appArgs = new DefaultApplicationArguments(args);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment