Add run instructions to readme

Signed-off-by: HenrikJannsen <boilingfrog@gmx.com>
This commit is contained in:
HenrikJannsen 2024-06-06 21:43:24 +07:00
parent 1c98f8b61e
commit 7577691f9e
No known key found for this signature in database
GPG Key ID: 02AA2BAE387C8307
3 changed files with 44 additions and 16 deletions

View File

@ -1,22 +1,48 @@
# Rest API application
# Rest API node
The Rest API application provides access to Bisq network data as well as Bisq DAO data.
Simple headless node with a Rest API to provide access to Bisq network data as well as Bisq DAO data.
It is used for Bisq 2 to request data about the DAO state as well as account age and account witness data for reputation use cases.
Program arguments to run 'RestApiMain' with Bitcoin Regtest and localhost mode:
```
--baseCurrencyNetwork=BTC_REGTEST
--useDevPrivilegeKeys=true
--useLocalhostForP2P=true
--appName=[your app name]
--fullDaoNode=true
--rpcUser=[Bitcoin rpc username]
--rpcPassword=[Bitcoin rpc password]
--rpcPort=18443
--rpcBlockNotificationPort=[port used in blocknotify]
```
To run 'RestApiMain' you need to have Bitcoin node running and have 'blocknotify' in the `bitcoin.conf` set up.
### Run Rest API node
Run the Gradle task:
```sh
./gradlew restapi:run
```
Or create a run scrip by:
```sh
./gradlew restapi:startBisqApp
```
And then run:
```sh
./bisq-restapi
```
### Customize with program arguments
Example program arguments for running at localhost with Regtest:
```sh
./bisq-restapi \
--baseCurrencyNetwork=BTC_REGTEST \
--useDevPrivilegeKeys=true \
--useLocalhostForP2P=true \
--nodePort=3333 \
--appName=bisq-BTC_REGTEST_restapi \
--fullDaoNode=true \
--rpcUser=[RPC USER] \
--rpcPassword=[RPC PW] \
--rpcPort=18443 \
--rpcBlockNotificationPort=5123
```

View File

@ -5,6 +5,8 @@ plugins {
mainClassName = 'bisq.restapi.RestApiMain'
distTar.enabled = false
dependencies {
implementation project(':common')
implementation project(':p2p')

View File

@ -69,7 +69,7 @@ public class RestApi extends ExecutableForAppWithP2p {
private SignVerifyService signVerifyService;
public RestApi() {
super("Bisq Data Node", "bisq-data-node", "bisq_data_node", Version.VERSION);
super("Bisq Rest Api", "bisq_restapi", "bisq_restapi", Version.VERSION);
}
public Config getConfig() {