mirror of
https://github.com/bisq-network/bisq.git
synced 2025-02-24 07:07:43 +01:00
Add method help docs
This commit is contained in:
parent
629f408bdf
commit
03f6c2a4d3
4 changed files with 143 additions and 0 deletions
46
core/src/main/resources/help/createpaymentacct-help.txt
Normal file
46
core/src/main/resources/help/createpaymentacct-help.txt
Normal file
|
@ -0,0 +1,46 @@
|
|||
createpaymentacct
|
||||
|
||||
NAME
|
||||
----
|
||||
createpaymentacct - create a payment account
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
createpaymentacct
|
||||
--payment-account-form=<path>
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Create a Bisq trading account with a payment account form.
|
||||
|
||||
The details of the payment account are defined in a manually edited json file generated
|
||||
by a getpaymentacctform command, e.g.,
|
||||
|
||||
{
|
||||
"_COMMENTS_": [
|
||||
"Do not manually edit the paymentMethodId field.",
|
||||
"Edit the salt field only if you are recreating a payment account on a new installation and wish to preserve the account age."
|
||||
],
|
||||
"paymentMethodId": "SEPA",
|
||||
"accountName": "your accountname",
|
||||
"bic": "your bic",
|
||||
"country": "your country",
|
||||
"holderName": "your holdername",
|
||||
"iban": "your iban",
|
||||
"salt": ""
|
||||
}
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
To create a new SEPA payment account, find the payment-method-id for the getpaymentacctform command:
|
||||
$ ./bisq-cli --password=xyz --port=9998 getpaymentmethods
|
||||
|
||||
Get a new, blank SEPA payment account form:
|
||||
$ ./bisq-cli --password=xyz --port=9998 getpaymentacctform --payment-method-id=SEPA
|
||||
|
||||
The previous command created a json file named sepa_1610817857085.json. The timestamp
|
||||
in the file name is to ensure each generated file is uniquely named (you can rename the file).
|
||||
|
||||
Manually edit the json file, and pass the file's path to the createpaymentacct command:
|
||||
$ ./bisq-cli --password=xyz --port=9998 createpaymentacct --payment-account-form=sepa_1610817857085.json
|
23
core/src/main/resources/help/getaddressbalance-help.txt
Normal file
23
core/src/main/resources/help/getaddressbalance-help.txt
Normal file
|
@ -0,0 +1,23 @@
|
|||
getaddressbalance
|
||||
|
||||
NAME
|
||||
----
|
||||
getaddressbalance - get btc address balance
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
getaddressbalance
|
||||
--address=<btc-address>
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Returns the balance of a BTC address in the Bisq server's wallet.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
--address=<btc-address>
|
||||
The BTC address.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
$ ./bisq-cli --password=xyz --port=9998 getaddressbalance -address=bcrt1qygvsqmyt8jyhtp7l3zwqm7s7v3nar6vkc2luz3
|
30
core/src/main/resources/help/getbalance-help.txt
Normal file
30
core/src/main/resources/help/getbalance-help.txt
Normal file
|
@ -0,0 +1,30 @@
|
|||
getbalance
|
||||
|
||||
NAME
|
||||
----
|
||||
getbalance - get wallet balance(s)
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
getbalance
|
||||
[--currency-code=<bsq|btc>]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Returns full balance information for Bisq BSQ and/or BTC wallets.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
--currency-code=<bsq|btc>
|
||||
The three letter Bisq wallet crypto currency code.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
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
|
||||
|
||||
Show full BTC wallet balance information:
|
||||
$ ./bisq-cli --password=xyz --port=9998 getbalance --currency-code=btc
|
44
core/src/main/resources/help/getpaymentacctform-help.txt
Normal file
44
core/src/main/resources/help/getpaymentacctform-help.txt
Normal file
|
@ -0,0 +1,44 @@
|
|||
getpaymentacctform
|
||||
|
||||
NAME
|
||||
----
|
||||
getpaymentacctform - get a blank payment account form for a payment method
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
getpaymentacctform
|
||||
--payment-method-id=<payment-method-id>
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Returns a new, blank payment account form as a json file, e.g.,
|
||||
|
||||
{
|
||||
"_COMMENTS_": [
|
||||
"Do not manually edit the paymentMethodId field.",
|
||||
"Edit the salt field only if you are recreating a payment account on a new installation and wish to preserve the account age."
|
||||
],
|
||||
"paymentMethodId": "CLEAR_X_CHANGE",
|
||||
"accountName": "your accountname",
|
||||
"emailOrMobileNr": "your emailormobilenr",
|
||||
"holderName": "your holdername",
|
||||
"salt": ""
|
||||
}
|
||||
|
||||
This form is manually edited, and used as a parameter to the createpaymentacct command,
|
||||
which creates the new payment account.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
To create a new CLEAR_X_CHANGE (Zelle) payment account, find the payment-method-id for
|
||||
the getpaymentacctform command:
|
||||
$ ./bisq-cli --password=xyz --port=9998 getpaymentmethods
|
||||
|
||||
Get a new, blank CLEAR_X_CHANGE (Zelle) payment account form:
|
||||
$ ./bisq-cli --password=xyz --port=9998 getpaymentacctform --payment-method-id=CLEAR_X_CHANGE_ID
|
||||
|
||||
The previous command created a json file named clear_x_change_1610818248040.json. The timestamp
|
||||
in the file name is to ensure each generated file is uniquely named (you can rename the file).
|
||||
|
||||
Manually edit the json file, and pass the file's path to the createpaymentacct command:
|
||||
$ ./bisq-cli --password=xyz --port=9998 createpaymentacct --payment-account-form=clear_x_change_1610818248040.json
|
Loading…
Add table
Reference in a new issue