The Bisq pricenode is a simple HTTP service that fetches, transforms and relays data from third-party price providers to Bisq exchange clients on request. Available prices include:
- Bitcoin exchange rates, available at
/getAllMarketPrices, and - Bitcoin mining fee rates, available at
/getFees
Pricenodes are deployed in production as Tor hidden services. This is not because the location of these nodes needs to be kept secret, but rather so that Bisq exchange clients do not need to exit the Tor network in order to get price data.
Anyone can run a pricenode, but it must be discoverable in order for it to do any good. For exchange clients to discover your pricenode, its .onion address must be hard-coded in the Bisq exchange client's ProvidersRepository class. Alternatively, users can point explicitly to given pricenode (or set of pricenodes) with the exchange client's --providers command line option.
Pricenodes can be deployed anywhere Java and Tor binaries can be run. Instructions below cover deployment on localhost, and instructions how to deploy on Heroku are also available.
Pricenodes should be cheap to run with regard to both time and money. The application itself is non-resource intensive and can be run on the low-end of most providers' paid tiers.
A pricenode operator's main responsibilities are to ensure their node(s) are available and up-to-date. Releases are currently source-only, with the assumption that most operators will favor Git-based "push to deploy" workflows. To stay up to date with releases, operators can subscribe to this repository's releases.atom feed and/or get notifications in the #pricenode Slack channel.
Operating a production pricenode is a valuable service to the Bisq network, and operators should issue BSQ compensation requests accordingly.
To run a pricenode, you will need:
- JDK 8 if you want to build and run a node locally.
- The
torbinary (e.g.brew install tor) if you want to run a hidden service locally.
This repo has a dependency on git submodule bisq. There are two ways to clone it before it can be compiled:
# 1) Use the --recursive option in the clone command:
$ git clone --recursive https://github.com/bisq-network/bisq-pricenode.git
# 2) Do a normal clone, and pull down the bisq repo dependency with two git submodule commands:
$ git clone https://github.com/bisq-network/bisq-pricenode.git
$ cd bisq-pricenode
$ git submodule init
$ git submodule update
To build:
$ ./gradlew clean build
Run the one-command installer:
curl -s https://raw.githubusercontent.com/bisq-network/bisq-pricenode/main/scripts/install_pricenode_debian.sh | sudo bashAt the end of the installer script, it should print your Tor onion hostname.
To manually test endpoints, run each of the following:
curl http://localhost:8080/getAllMarketPrices
curl http://localhost:8080/getFees
curl http://localhost:8080/getParams
curl http://localhost:8080/infoIf you run a main pricenode, you also are obliged to activate the monitoring feed by running
bash <(curl -s https://raw.githubusercontent.com/bisq-network/bisq-monitor/main/scripts/install_collectd_debian.sh)Follow the instruction given by the script and report your certificate to the @bisq-network/monitoring team.
Furthermore, you are obliged to provide network size data to the monitor by running
curl -s https://raw.githubusercontent.com/bisq-network/bisq-pricenode/main/scripts/install_networksize_debian.sh | sudo bashUpdate your bisq code in /bisq/bisq with git pull
Then build an updated pricenode:
./gradlew :pricenode:installDist -x test
The pricenode exposes a service API to Bisq clients under /getFees.
This API returns a mining fee rate estimate, representing an average of several mining fee rate values retrieved from different mempool.space instances.
To configure which mempool.space instances are queried to calculate this average, see the relevant section in the file application.properties.