forked from bisq-network/bisq
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: HenrikJannsen <[email protected]>
- Loading branch information
1 parent
4595e40
commit bf25aae
Showing
3 changed files
with
42 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters