mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2025-02-24 15:10:44 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add method help docs

Browse source
This commit is contained in:
ghubstan 2021-01-16 13:45:07 -03:00
parent ef4acc0b73
commit 629f408bdf
No known key found for this signature in database
GPG key ID: E35592D6800A861E
10 changed files with 314 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
core/src/main/resources/help/canceloffer-help.txt Normal file
View file

@ -0,0 +1,25 @@
canceloffer
NAME
----
canceloffer - cancel an existing offer to buy or sell BTC
SYNOPSIS
--------
canceloffer
--offer-id=<offer-id>
DESCRIPTION
-----------
Cancel an existing offer. The offer will be removed from other Bisq users' offer views.
OPTIONS
-------
--offer-id
The ID of the buy or sell offer to cancel.
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

27
core/src/main/resources/help/confirmpaymentreceived-help.txt Normal file
View file

@ -0,0 +1,27 @@
confirmpaymentreceived
NAME
----
confirmpaymentreceived - confirm payment has been received
SYNOPSIS
--------
confirmpaymentreceived
--trade-id=<trade-id>
DESCRIPTION
-----------
After the seller receives payment from the BTC buyer, confirmpaymentreceived notifies
the buyer the payment has arrived. The seller can release locked BTC only after the
this confirmation message has been sent.
OPTIONS
-------
--trade-id
The ID of the trade (the full offer-id).
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

26
core/src/main/resources/help/confirmpaymentstarted-help.txt Normal file
View file

@ -0,0 +1,26 @@
confirmpaymentstarted
NAME
----
confirmpaymentstarted - confirm payment has been sent
SYNOPSIS
--------
confirmpaymentstarted
--trade-id=<trade-id>
DESCRIPTION
-----------
After the buyer initiates payment to the BTC seller, confirmpaymentstarted notifies
the seller to begin watching for a funds deposit in her payment account.
OPTIONS
-------
--trade-id
The ID of the trade (the full offer-id).
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

25
core/src/main/resources/help/getmyoffer-help.txt Normal file
View file

@ -0,0 +1,25 @@
getmyoffer
NAME
----
getmyoffer - get your offer to buy or sell BTC
SYNOPSIS
--------
getmyoffer
--offer-id=<offer-id>
DESCRIPTION
-----------
List one of your existing offer's details.
OPTIONS
-------
--offer-id
The ID of your buy or sell offer.
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

33
core/src/main/resources/help/getmyoffers-help.txt Normal file
View file

@ -0,0 +1,33 @@
getmyoffers
NAME
----
getmyoffers - get your own buy or sell BTC offers for a fiat currency
SYNOPSIS
--------
getmyoffers
--direction=<buy|sell>
--currency-code=<eur|usd>
DESCRIPTION
-----------
List your existing offers for a direction (SELL|BUY) and currency (EUR|GBP|USD|BRL|...).
OPTIONS
-------
--direction
The direction of the offer (BUY or SELL).
--currency-code
The three letter code for the fiat used to buy or sell BTC, e.g., EUR, USD, BRL, ...
EXAMPLES
--------
List all of your existing BUY offers for BRL:
$ ./bisq-cli --password=xyz --port=9998 getmyoffers --direction=buy --currency-code=brl
List all of your existing SELL offers for EUR:
$ ./bisq-cli --password=xyz --port=9998 getmyoffers --direction=sell --currency-code=eur

26
core/src/main/resources/help/getoffer-help.txt Normal file
View file

@ -0,0 +1,26 @@
getoffer
NAME
----
getoffer - get an offer to buy or sell BTC
SYNOPSIS
--------
getoffer
--offer-id=<offer-id>
DESCRIPTION
-----------
List an existing offer's details. The offer cannot be one of your own, and be
available for the taking, or it will not be viewable.
OPTIONS
-------
--offer-id
The ID of the buy or sell offer to view.
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

39
core/src/main/resources/help/getoffers-help.txt Normal file
View file

@ -0,0 +1,39 @@
getoffers
NAME
----
getoffers - get available buy or sell BTC offers for a fiat currency
SYNOPSIS
--------
getoffers
--direction=<buy|sell>
--currency-code=<eur|usd>
DESCRIPTION
-----------
List existing offers for a direction (SELL|BUY) and currency (EUR|GBP|USD|BRL|...).
All of the listed offers will be available for the taking because you have a
matching payment account, and none of the offers listed will be one of yours.
OPTIONS
-------
--direction
The direction of the offer (BUY or SELL).
--currency-code
The three letter code for the fiat used to buy or sell BTC, e.g., EUR, USD, BRL, ...
EXAMPLES
--------
You have one Brazilian Real payment account with a face-to-face payment method type.
To view available offers to BUY BTC with BRL, created by other users with the same
face-to-fact account type:
$ ./bisq-cli --password=xyz --port=9998 getoffers --direction=buy --currency-code=brl
You have several EUR payment accounts, each with a different payment method type.
To view available offers to SELL BTC with EUR, created by other users having at
least one payment account that matches any of your own:
$ ./bisq-cli --password=xyz --port=9998 getoffers --direction=sell --currency-code=eur

32
core/src/main/resources/help/gettrade-help.txt Normal file
View file

@ -0,0 +1,32 @@
gettrade
NAME
----
gettrade - get a buy or sell BTC trade
SYNOPSIS
--------
gettrade
--trade-id=<trade-id>
[--show-contract=<true|false>]
DESCRIPTION
-----------
List details of a trade with the given trade-id. If the trade has not yet been completed,
the details can inform each side of the trade of the current phase of the trade protocol.
OPTIONS
-------
--trade-id
The ID of the trade (the full offer-id).
--show-contract
Optionally display the trade's full contract details in json format. The default = false.
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
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

31
core/src/main/resources/help/keepfunds-help.txt Normal file
View file

@ -0,0 +1,31 @@
keepfunds
NAME
----
keepfunds - keep BTC received during a trade in Bisq wallet
SYNOPSIS
--------
keepfunds
--trade-id=<trade-id>
DESCRIPTION
-----------
A BTC buyer completes the final step in the trade protocol by keeping received BTC in his
Bisq wallet. This step may not seem necessary from the buyer's perspective, but it is
necessary for correct transition of a trade's state to CLOSED, within the Bisq server.
The alternative way to close out the trade is to sen the received BTC to an external
BTC wallet, using the withdrawfunds command.
OPTIONS
-------
--trade-id
The ID of the trade (the full offer-id).
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

50
core/src/main/resources/help/withdrawfunds-help.txt Normal file
View file

@ -0,0 +1,50 @@
withdrawfunds
NAME
----
withdrawfunds - send BTC received during a trade to an external BTC wallet
SYNOPSIS
--------
withdrawfunds
--trade-id=<trade-id>
--address=<btc-address>
[--memo=<"memo">]
DESCRIPTION
-----------
A BTC buyer completes the final step in the trade protocol by sending received BTC to
an external BTC wallet.
The alternative way to close out the trade is to keep the received BTC in the Bisq wallet,
using the keepfunds command.
The buyer needs to complete the trade protocol using the keepfunds or withdrawfunds or command.
This step may not seem necessary from the buyer's perspective, but it is necessary for correct
transition of a trade's state to CLOSED, within the Bisq server.
OPTIONS
-------
--trade-id
The ID of the trade (the full offer-id).
--address
The destination btc address for the send btc transaction.
--memo
An optional memo to be saved with the send btc transaction.
A multi word memo must be enclosed in double quotes.
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 \
--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
--memo="note to self"