Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix method help typos #5157

Merged
merged 4 commits into from
Feb 10, 2021
Merged

Fix method help typos #5157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ce9bc1
Fix method help typos
ghubstan Feb 5, 2021
433079a
Add missing backslash in multi line command
ghubstan Feb 5, 2021
6890ba6
Fix typo
ghubstan Feb 5, 2021
ae2e60c
Fix typo
ghubstan Feb 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/main/resources/help/canceloffer-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

2 changes: 1 addition & 1 deletion core/src/main/resources/help/confirmpaymentreceived-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion core/src/main/resources/help/confirmpaymentstarted-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
22 changes: 20 additions & 2 deletions core/src/main/resources/help/createoffer-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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,
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
4 changes: 2 additions & 2 deletions core/src/main/resources/help/getbalance-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion core/src/main/resources/help/getmyoffer-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

2 changes: 1 addition & 1 deletion core/src/main/resources/help/getoffer-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

4 changes: 2 additions & 2 deletions core/src/main/resources/help/gettrade-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion core/src/main/resources/help/gettransaction-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion core/src/main/resources/help/keepfunds-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions core/src/main/resources/help/sendbsq-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ sendbsq - send BSQ to an external wallet
SYNOPSIS
--------
sendbsq
--address=<btc-address>
--amount=<btc-amount>
--address=<bsq-address>
--amount=<bsq-amount>
[--tx-fee-rate=<sats/byte>]

DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/resources/help/sendbtc-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
4 changes: 3 additions & 1 deletion core/src/main/resources/help/takeoffer-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions core/src/main/resources/help/withdrawfunds-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
--address=2N5J6MyjAsWnashimGiNwoRzUXThsQzRmbv
$ ./bisq-cli --password=xyz --port=9998 withdrawfunds --trade-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
--address=2N5J6MyjAsWnashimGiNwoRzUXThsQzRmbv \
--memo="note to self"