From 5ce9bc184d502e9e9b7ccff32f9c67375421d289 Mon Sep 17 00:00:00 2001 From: ghubstan <36207203+ghubstan@users.noreply.github.com> Date: Fri, 5 Feb 2021 15:27:08 -0300 Subject: [PATCH 1/4] Fix method help typos And add a createoffer example. --- .../main/resources/help/canceloffer-help.txt | 2 +- .../help/confirmpaymentreceived-help.txt | 2 +- .../help/confirmpaymentstarted-help.txt | 2 +- .../main/resources/help/createoffer-help.txt | 22 +++++++++++++++++-- .../main/resources/help/getbalance-help.txt | 4 ++-- .../main/resources/help/getmyoffer-help.txt | 2 +- .../src/main/resources/help/getoffer-help.txt | 2 +- .../src/main/resources/help/gettrade-help.txt | 4 ++-- .../resources/help/gettransaction-help.txt | 2 +- .../main/resources/help/keepfunds-help.txt | 2 +- core/src/main/resources/help/sendbtc-help.txt | 2 +- .../main/resources/help/takeoffer-help.txt | 4 +++- .../resources/help/withdrawfunds-help.txt | 4 ++-- 13 files changed, 37 insertions(+), 17 deletions(-) diff --git a/core/src/main/resources/help/canceloffer-help.txt b/core/src/main/resources/help/canceloffer-help.txt index 248656396e3..0155d9c1859 100644 --- a/core/src/main/resources/help/canceloffer-help.txt +++ b/core/src/main/resources/help/canceloffer-help.txt @@ -22,5 +22,5 @@ OPTIONS EXAMPLES -------- To cancel an offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea: -$ ./bisq-cli --password=xyz --port=9998 canceloffer -offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 canceloffer --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea diff --git a/core/src/main/resources/help/confirmpaymentreceived-help.txt b/core/src/main/resources/help/confirmpaymentreceived-help.txt index dc43cba2fa4..4e460b4bfbd 100644 --- a/core/src/main/resources/help/confirmpaymentreceived-help.txt +++ b/core/src/main/resources/help/confirmpaymentreceived-help.txt @@ -24,4 +24,4 @@ EXAMPLES -------- A BTC seller has taken an offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea, and has recently received the required fiat payment from the buyer's fiat account: -$ ./bisq-cli --password=xyz --port=9998 confirmpaymentreceived -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 confirmpaymentreceived --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea diff --git a/core/src/main/resources/help/confirmpaymentstarted-help.txt b/core/src/main/resources/help/confirmpaymentstarted-help.txt index e266e2ef3e6..c83907b58c4 100644 --- a/core/src/main/resources/help/confirmpaymentstarted-help.txt +++ b/core/src/main/resources/help/confirmpaymentstarted-help.txt @@ -23,4 +23,4 @@ EXAMPLES -------- A BTC buyer has taken an offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea, and has recently initiated the required fiat payment to the seller's fiat account: -$ ./bisq-cli --password=xyz --port=9998 confirmpaymentstarted -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 confirmpaymentstarted --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea diff --git a/core/src/main/resources/help/createoffer-help.txt b/core/src/main/resources/help/createoffer-help.txt index 536e2596b65..93c05a8cf80 100644 --- a/core/src/main/resources/help/createoffer-help.txt +++ b/core/src/main/resources/help/createoffer-help.txt @@ -54,11 +54,29 @@ OPTIONS EXAMPLES -------- + To create a BUY 0.125 BTC with EUR offer at the current market price, using a payment account with ID 7413d263-225a-4f1b-837a-1e3094dc0d77, putting up a 30 percent security deposit, and paying the Bisq maker trading fee in BSQ: -$ ./bisq-cli --password=xyz --port=9998 createoffer --payment-account=7413d263-225a-4f1b-837a-1e3094dc0d77 --direction=buy --currency-code=eur --amount=0.125 --market-price-margin=0.00 --security-deposit=30.0 --fee-currency=bsq +$ ./bisq-cli --password=xyz --port=9998 createoffer --payment-account=7413d263-225a-4f1b-837a-1e3094dc0d77 \ + --direction=buy \ + --currency-code=eur \ + --amount=0.125 \ + --market-price-margin=0.00 \ + --security-deposit=30.0 \ + --fee-currency=bsq - (TODO another 3 examples: selling @ mkt price, buying a fixed price, selling at fixed price...) +To create a SELL 0.006 BTC with USD offer + at a fixed price of 40,000 USD, + using a payment account with ID 7413d263-225a-4f1b-837a-1e3094dc0d77, + putting up a 25 percent security deposit, + and paying the Bisq maker trading fee in BTC: +$ ./bisq-cli --password=xyz --port=9998 createoffer --payment-account=7413d263-225a-4f1b-837a-1e3094dc0d77 \ + --direction=sell \ + --currency-code=usd \ + --amount=0.006 \ + --fixed-price=40000 \ + --security-deposit=25.0 \ + --fee-currency=btc diff --git a/core/src/main/resources/help/getbalance-help.txt b/core/src/main/resources/help/getbalance-help.txt index 52e27e8de98..9426373be74 100644 --- a/core/src/main/resources/help/getbalance-help.txt +++ b/core/src/main/resources/help/getbalance-help.txt @@ -24,7 +24,7 @@ Show full BSQ and BTC wallet balance information: $ ./bisq-cli --password=xyz --port=9998 getbalance Show full BSQ wallet balance information: -$ ./bisq-cli --password=xyz --port=9998 getbalance --currency-code=bsq +$ ./bisq-cli --password=xyz --port=9998 getbalance --currency-code=bsq Show full BTC wallet balance information: -$ ./bisq-cli --password=xyz --port=9998 getbalance --currency-code=btc +$ ./bisq-cli --password=xyz --port=9998 getbalance --currency-code=btc diff --git a/core/src/main/resources/help/getmyoffer-help.txt b/core/src/main/resources/help/getmyoffer-help.txt index c8ac347678a..66cabd93483 100644 --- a/core/src/main/resources/help/getmyoffer-help.txt +++ b/core/src/main/resources/help/getmyoffer-help.txt @@ -21,5 +21,5 @@ OPTIONS EXAMPLES -------- To view your offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea: -$ ./bisq-cli --password=xyz --port=9998 getmyoffer -offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 getmyoffer --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea diff --git a/core/src/main/resources/help/getoffer-help.txt b/core/src/main/resources/help/getoffer-help.txt index 8c42e552e11..a722f1f428c 100644 --- a/core/src/main/resources/help/getoffer-help.txt +++ b/core/src/main/resources/help/getoffer-help.txt @@ -22,5 +22,5 @@ OPTIONS EXAMPLES -------- To view an offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea: -$ ./bisq-cli --password=xyz --port=9998 getoffer -offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 getoffer --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea diff --git a/core/src/main/resources/help/gettrade-help.txt b/core/src/main/resources/help/gettrade-help.txt index 1c54c96ab58..4cf64584cc4 100644 --- a/core/src/main/resources/help/gettrade-help.txt +++ b/core/src/main/resources/help/gettrade-help.txt @@ -26,7 +26,7 @@ OPTIONS EXAMPLES -------- To see the summary of a trade with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea: -$ ./bisq-cli --password=xyz --port=9998 gettrade -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 gettrade --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea To see the full contract for a trade with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea: -$ ./bisq-cli --password=xyz --port=9998 gettrade -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea --show-contract=true +$ ./bisq-cli --password=xyz --port=9998 gettrade --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea --show-contract=true diff --git a/core/src/main/resources/help/gettransaction-help.txt b/core/src/main/resources/help/gettransaction-help.txt index 6b1b7b05cec..3d16f3c2970 100644 --- a/core/src/main/resources/help/gettransaction-help.txt +++ b/core/src/main/resources/help/gettransaction-help.txt @@ -24,4 +24,4 @@ EXAMPLES -------- To see the summary of a transaction with ID 282dc2a5755219a49ee9f6d46a31a2cbaec6624beba96548180eccb1f004cdd8: $ ./bisq-cli --password=xyz --port=9998 gettransaction \ - -transaction-id=282dc2a5755219a49ee9f6d46a31a2cbaec6624beba96548180eccb1f004cdd8 + --transaction-id=282dc2a5755219a49ee9f6d46a31a2cbaec6624beba96548180eccb1f004cdd8 diff --git a/core/src/main/resources/help/keepfunds-help.txt b/core/src/main/resources/help/keepfunds-help.txt index 706ad5f2139..4e8232df043 100644 --- a/core/src/main/resources/help/keepfunds-help.txt +++ b/core/src/main/resources/help/keepfunds-help.txt @@ -28,4 +28,4 @@ EXAMPLES A BTC seller has informed the buyer that fiat payment has been received for trade with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea, and locked BTC has been released to the buyer. The BTC buyer closes out the trade by keeping the received BTC in her Bisq wallet: -$ ./bisq-cli --password=xyz --port=9998 keepfunds -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea +$ ./bisq-cli --password=xyz --port=9998 keepfunds --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea diff --git a/core/src/main/resources/help/sendbtc-help.txt b/core/src/main/resources/help/sendbtc-help.txt index 8cebcaae0d1..833612a6485 100644 --- a/core/src/main/resources/help/sendbtc-help.txt +++ b/core/src/main/resources/help/sendbtc-help.txt @@ -47,5 +47,5 @@ $ ./bisq-cli --password=xyz --port=9998 sendbtc --address=bcrt1qygvsqmyt8jyhtp7l Send 0.005 BTC to address bcrt1qygvsqmyt8jyhtp7l3zwqm7s7v3nar6vkc2luz3 with a transaction fee rate of 40 sats/byte, and save a memo with the send transaction: $ ./bisq-cli --password=xyz --port=9998 sendbtc --address=bcrt1qygvsqmyt8jyhtp7l3zwqm7s7v3nar6vkc2luz3 --amount=0.005 \ - --tx-fee-rate=40 + --tx-fee-rate=40 \ --memo="note to self" diff --git a/core/src/main/resources/help/takeoffer-help.txt b/core/src/main/resources/help/takeoffer-help.txt index 89ab21fc9c0..1290a008392 100644 --- a/core/src/main/resources/help/takeoffer-help.txt +++ b/core/src/main/resources/help/takeoffer-help.txt @@ -32,4 +32,6 @@ EXAMPLES To take an offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea using a payment account with ID fe20cdbd-22be-4b8a-a4b6-d2608ff09d6e, and paying the Bisq trading fee in BSQ: -$ ./bisq-cli --password=xyz --port=9998 takeoffer -offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea -payment-account=fe20cdbd-22be-4b8a-a4b6-d2608ff09d6e -fee-currency=bsq +$ ./bisq-cli --password=xyz --port=9998 takeoffer --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \ + --payment-account=fe20cdbd-22be-4b8a-a4b6-d2608ff09d6e \ + -fee-currency=bsq diff --git a/core/src/main/resources/help/withdrawfunds-help.txt b/core/src/main/resources/help/withdrawfunds-help.txt index dbef9e277d0..5c0f9b9c666 100644 --- a/core/src/main/resources/help/withdrawfunds-help.txt +++ b/core/src/main/resources/help/withdrawfunds-help.txt @@ -40,11 +40,11 @@ EXAMPLES A BTC seller has informed the buyer that fiat payment has been received for trade with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea, and locked BTC has been released to the buyer. The BTC buyer closes out the trade by sending the received BTC to an external BTC wallet: -$ ./bisq-cli --password=xyz --port=9998 withdrawfunds -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \ +$ ./bisq-cli --password=xyz --port=9998 withdrawfunds --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \ --address=2N5J6MyjAsWnashimGiNwoRzUXThsQzRmbv (bitcoin regtest address) A seller sends a trade's BTC proceeds to an external wallet, and includes an optional memo: -$ ./bisq-cli --password=xyz --port=9998 withdrawfunds -trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \ +$ ./bisq-cli --password=xyz --port=9998 withdrawfunds --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \ --address=2N5J6MyjAsWnashimGiNwoRzUXThsQzRmbv --memo="note to self" From 433079abc86fa0759ab7e7822d1c888d19d7eea6 Mon Sep 17 00:00:00 2001 From: ghubstan <36207203+ghubstan@users.noreply.github.com> Date: Fri, 5 Feb 2021 15:29:47 -0300 Subject: [PATCH 2/4] Add missing backslash in multi line command --- core/src/main/resources/help/withdrawfunds-help.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/main/resources/help/withdrawfunds-help.txt b/core/src/main/resources/help/withdrawfunds-help.txt index 5c0f9b9c666..edc69dddcb8 100644 --- a/core/src/main/resources/help/withdrawfunds-help.txt +++ b/core/src/main/resources/help/withdrawfunds-help.txt @@ -46,5 +46,5 @@ $ ./bisq-cli --password=xyz --port=9998 withdrawfunds --trade-id=83e8b2e2-51b6-4 A seller sends a trade's BTC proceeds to an external wallet, and includes an optional memo: $ ./bisq-cli --password=xyz --port=9998 withdrawfunds --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \ - --address=2N5J6MyjAsWnashimGiNwoRzUXThsQzRmbv + --address=2N5J6MyjAsWnashimGiNwoRzUXThsQzRmbv \ --memo="note to self" From 6890ba68b0b092bf25345745b9feadf2dfdd4780 Mon Sep 17 00:00:00 2001 From: ghubstan <36207203+ghubstan@users.noreply.github.com> Date: Fri, 5 Feb 2021 19:10:34 -0300 Subject: [PATCH 3/4] Fix typo --- core/src/main/resources/help/createoffer-help.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/main/resources/help/createoffer-help.txt b/core/src/main/resources/help/createoffer-help.txt index 93c05a8cf80..38ec0fd8daf 100644 --- a/core/src/main/resources/help/createoffer-help.txt +++ b/core/src/main/resources/help/createoffer-help.txt @@ -68,7 +68,7 @@ $ ./bisq-cli --password=xyz --port=9998 createoffer --payment-account=7413d263-2 --security-deposit=30.0 \ --fee-currency=bsq -To create a SELL 0.006 BTC with USD offer +To create a SELL 0.006 BTC for USD offer at a fixed price of 40,000 USD, using a payment account with ID 7413d263-225a-4f1b-837a-1e3094dc0d77, putting up a 25 percent security deposit, From ae2e60c7490ef6e2c3fe6ccc541373d1c31bf462 Mon Sep 17 00:00:00 2001 From: ghubstan <36207203+ghubstan@users.noreply.github.com> Date: Sat, 6 Feb 2021 14:04:30 -0300 Subject: [PATCH 4/4] Fix typo --- core/src/main/resources/help/sendbsq-help.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/src/main/resources/help/sendbsq-help.txt b/core/src/main/resources/help/sendbsq-help.txt index 20ec6ade22f..8a3e7d938ad 100644 --- a/core/src/main/resources/help/sendbsq-help.txt +++ b/core/src/main/resources/help/sendbsq-help.txt @@ -7,8 +7,8 @@ sendbsq - send BSQ to an external wallet SYNOPSIS -------- sendbsq - --address= - --amount= + --address= + --amount= [--tx-fee-rate=] DESCRIPTION