The Oracle Server is a DLC Oracle with functionality for creating events and attesting to them.
You can interact with the oracle server with
The following a guide is for how to build the oracle server. If you are looking for the documentation on how to use the oracle server, checkout this page.
Step 1: Java and Scala
To get started you will need Java, Scala, and some other nice tools installed, luckily the Scala team has an easy setup process!
Simply follow the instructions in this short blog to get started.
Step 2: Bitcoin-S Repository
Now, it is time to clone the Bitcoin-S repository by running
git clone --depth 100 --recursive [email protected]:bitcoin-s/bitcoin-s.git
or alternatively, if you do not have ssh setup with github, you can run
git clone --depth 100 --recursive https://github.com/bitcoin-s/bitcoin-s.git
Next, you will want to execute the commands
cd bitcoin-s git submodule update
to download the secp256k1 submodule, this is so cryptographic functions like signing will be faster.
Step 3: Building the Oracle Server
In this example we are going to use
universal:stage which will produce bash scripts we can easily execute. You can stage the server with the following command.
This will produce a script to execute bitcoin-s which you can start with
Alternatively you can run the server by just using:
Using an existing docker image
We publish docker images on every PR that is merged to bitcoin-s.
You can find the docker repo for the oracle server here
Building our own docker image
You can build a docker image with the following commands
This will build a
Dockerfile that is located in
You can publish to your local docker repository by using
docker:publishLocal instead of
You can now build the docker image with
docker build app/oracle-server/target/docker/stage/ -t bitcoin-s-oracle-server:latest
Finally, let's run the image! It's important that you correctly configure port forwarding with the docker container so
you can interact with the running container with
curl. By default, our oracle
server listens for requests on port
This means we need to forward requests on the host machine to the docker container correctly.
This can be done with the following command
docker run -d -p 9998:9998 bitcoin-s-oracle-server:latest
Now you can send requests with
Here is an example with
./bitcoin-s-cli getpublickey c9c9fe2772330b0d61a2efbfacabf5cab1137710a69f0e12f1eb3dbb74f7ea54
For more information on build configuration options with
sbt please see the sbt native packager docs
Step 4: Configuration
Java binary configuration
If you would like to pass in a custom datadir for your server, you can do
./app/oracle-server/target/universal/stage/bin/bitcoin-s-oracle-server --datadir /path/to/datadir/
To use a config file that is not the
bitcoin-s.conf file in your datadir, you can do
./app/oracle-server/target/universal/stage/bin/bitcoin-s-oracle-server --conf /path/to/file.conf
You can also pass in a custom
rpcport to bind to
./app/oracle-server/target/universal/stage/bin/bitcoin-s-oracle-server --rpcport 12345
For more information on configuring the server please see our configuration document.
For more information on how to use our built in
cli to interact with the server please see the cli docs.
In this example, we are using the latest docker image published to our docker hub
which is referenced by
You can use bitcoin-s with docker volumes. You can also pass in a custom configuration at container runtime.
Using a docker volume
docker volume create bitcoin-s docker run -p 9998:9998 \ --mount source=bitcoin-s,target=/home/bitcoin-s/ bitcoinscala/bitcoin-s-oracle-server:latest
Now you can re-use this volume across container runs. It will keep the same oracle database
and seeds directory located at
/home/bitcoin-s/.bitcoin-s/seeds in the volume.
Using a custom bitcoin-s configuration with docker
You can also specify a custom bitcoin-s configuration at container runtime. You can mount the configuration file on the docker container and that configuration will be used in the docker container runtime rather than the default one we provide here
You can do this with the following command
docker run -p 9998:9998 \ --mount type=bind,source=/my/new/config/,target=/home/bitcoin-s/.bitcoin-s/ \ bitcoinscala/bitcoin-s-oracle-server:latest --conf /home/bitcoin-s/.bitcoin-s/bitcoin-s.conf
Note: If you adjust the
bitcoin-s.oracle.rpcport setting you will need to adjust
-p 9998:9998 port mapping on the docker container to adjust for this.