Skip to content

Commit

Permalink
Add run instructions to readme
Browse files Browse the repository at this point in the history
Signed-off-by: HenrikJannsen <[email protected]>
  • Loading branch information
HenrikJannsen committed Jun 6, 2024
1 parent 4595e40 commit bf25aae
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 14 deletions.
52 changes: 39 additions & 13 deletions restapi/README.md
Original file line number Diff line number Diff line change
@@ -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:
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
```
--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]

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
```

To run 'RestApiMain' you need to have Bitcoin node running and have 'blocknotify' in the `bitcoin.conf` set up.


2 changes: 2 additions & 0 deletions restapi/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ plugins {

mainClassName = 'bisq.restapi.RestApiMain'

distTar.enabled = false

dependencies {
implementation project(':common')
implementation project(':p2p')
Expand Down
2 changes: 1 addition & 1 deletion restapi/src/main/java/bisq/restapi/RestApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down

0 comments on commit bf25aae

Please sign in to comment.