mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2025-01-18 21:35:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve CLI takeoffer man-page param descriptions

Browse Source
This commit is contained in:
ghubstan 2022-09-11 12:26:00 -03:00
parent 35f4fe14b2
commit d32fd4e97b
No known key found for this signature in database
GPG Key ID: E35592D6800A861E
1 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
core/src/main/resources/help/takeoffer-help.txt
View File

@ -6,21 +6,28 @@ takeoffer - take an offer to buy or sell BTC
SYNOPSIS
--------
takeoffer
takeoffer (Bisq v1 Protocol)
--offer-id=<offer-id>
--payment-account=<payment-acct-id>
[--fee-currency=<btc|bsq>]
[--amount=<offer.min-btc-amount >= amount <= offer.btc-amount>]
takeoffer (BSQ Swap)
--offer-id=<offer-id>
[--amount=<offer.min-btc-amount >= amount <= offer.btc-amount>]
DESCRIPTION
-----------
Take an existing offer. There are currently two types offers and trade protocols.
BSQ swap offers
The takeoffer command only requires an offer-id parameter, and sufficient BSQ and BTC
to cover the trade amount and the taker fee. The amount parameter is optional.
The trade (swap) will be executed immediately after being successfully taken.
The takeoffer command only requires an offer-id parameter, and sufficient BSQ and/or BTC
to cover the trade amount and the taker fee.
The amount parameter is optional.
The payment-account parameter is invalid; BSQ Swap transactions use the default BsqSwapAccount.
The fee-currency parameter is invalid; BSQ is always used to pay BSQ swap trade fees.
The swap will be executed immediately after being successfully taken.
Version 1 protocol fiat and BSQ offers
@ -33,11 +40,15 @@ OPTIONS
The ID of the buy or sell offer to take.
--payment-account
The ID of the fiat payment account used to send or receive funds during the trade.
The ID of the fiat payment account used to send or receive funds during the Bisq v1 protocol trade.
The payment account's payment method must match that of the offer.
This parameter is not valid for taking BSQ Swaps, due to swaps' different transaction structure,
where the default BsqSwapAccount is used.
--fee-currency
The wallet currency used to pay the Bisq trade taker fee (BSQ|BTC). Default is BTC
The wallet currency used to pay a Bisq v1 protocol trade's taker fee (BSQ|BTC). Default is BTC.
This parameter is not valid for taking BSQ Swaps, due to swaps' different transaction structure,
where BSQ is always used to BSQ swap trade fees.
--amount
The trade's intended btc amount. The amount must be within the offer's min-amount and (max) amount range.
@ -56,5 +67,5 @@ To take an offer with ID 83e8b2e2-51b6-4f39-a748-3ebd29c22aea
and setting the trade amount = the offer's min-amount (0.025 BTC):
$ ./bisq-cli --password=xyz --port=9998 takeoffer --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
--payment-account=fe20cdbd-22be-4b8a-a4b6-d2608ff09d6e \
-fee-currency=bsq \
--fee-currency=bsq \
--amount=0.025