1.8.0

Edit

Getting Bitcoin-S installed on your machine

This documentation is intended for setting up development of bitcoin-s. If you want to just install bitcoin-s rather than develop, see getting-started

Getting Setup With Bitcoin-S

Step 1: Developer Runtimes

Scala/Java

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.

If you don't like curl, you can use OS specific package managers to install coursier here

bitcoin-s requires java9+ for development environments. If you do not have java9+ installed, you will not be able to build bitcoin-s. You will run into this error if you are on java8 or lower

If you follow the coursier route, you can switch to a java11 version by running

cs java --jvm adopt:11 --setup

Scala.js

We support publishing of scala.js artifacts. This library will compile Scala source code into javascript artifacts.

To be able to run scala js tests, you need to have the Node.js installed. You can install it from here

Step 2: Bitcoin-S Repository

Now, it is time to clone the Bitcoin-S repository by running

git clone --depth 500 --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 500 --recursive https://github.com/bitcoin-s/bitcoin-s.git

Optional: Running full test suite

WARNING: This should not be done on low resource machines. Running the entire test suite requires at minimum of 4GB of RAM on the machine you are running this on.

To run the entire test suite, you need to download all bitcoind instances and eclair instances. This is needed for unit tests or binding bitcoin-s to a bitcoind instance if you do not have locally running instances.

sbt downloadBitcoind
sbt downloadEclair

If you want to run the entire test suite you can run the following command after you download bitcoind and eclair.

sbt test

Step 3: Configuration

Now that we have the bitcoin-s repo setup, we want to create our application configurations.

First, create a $HOME/.bitcoin-s directory via mkdir or an equivalent command.

Next, create a bitcoin-s.conf file in $HOME/.bitcoin-s. Here is an example configuration file. The only thing that you will need to change is the peers list to which you will want to add "localhost:18444" if you want to run in regtest.

Step 4: Building the Server and Setting Up the CLI

We are finally ready to start running some programs! Follow the instructions here to build the server.

Then, follow these instructions to setup the CLI.

Step 5: Setting Up A Bitcoin-S Node

There are 2 ways to use the bitcoin-s server. It can either be as a neutrino node or use bitcoind as a backend. This can be configured by the configuration option bitcoin-s.node.mode choosing either neutrino or bitcoind.

Neutrino Node

To use a neutrino server you need to be paired with a bitcoin node that can serve compact filters. Suredbits runs a mainnet and testnet node you can connect to them by setting your peers config option in the $HOME/.bitcoin-s/bitcoin-s.conf to:

Mainnet:

bitcoin-s.node.peers = ["neutrino.suredbits.com:8333"]

Testnet:

bitcoin-s.node.peers = ["neutrino.testnet3.suredbits.com:18333"]

If you would like to use your own node you can either use the bitcoind backend option or connect to your own compatible node. There is no released version of bitcoind that is neutrino compatible, so you will either have to compile the latest master yourself, or use the experimental version provided by running sbt downloadBitcoind.

After building your bitcoin-s server, properly configuring it to be in neutrino mode you can start your server with:

./app/server/target/universal/stage/bin/bitcoin-s-server

and once this is done, you should be able to communicate with the server using

./app/cli/target/universal/stage/bin/bitcoin-s-cli getnewaddress

Bitcoind Backend

We recommend creating a directory someplace in which to run your bitcoind node. Once you have this directory created, add the following bitcoin.conf file to it:

regtest=1
server=1
rpcuser=[your username here]
rpcpassword=[your password here]
daemon=1
blockfilterindex=1
peerblockfilters=1
debug=1
txindex=1

If you already have a bitcoind node running and would like to connect your bitcoin-s server to it you can set your node's mode to bitcoind.

You will need to configure bitcoin-s to be able to find your bitcoind. If you would only like bitcoin-s to connect to bitcoind and start it itself then you only need to properly set the rpcuser, and rpcpassword options. If you would like bitcoin-s to launch bitcoind on start up you will need to set the other configuration options. These options should default to use the latest bitcoind downloaded from sbt downloadBitcoind.

bitcoin-s {
    bitcoind-rpc {
        # bitcoind rpc username
        rpcuser = user
        # bitcoind rpc password
        rpcpassword = password

        # Binary location of bitcoind
        binary = ${HOME}/.bitcoin-s/binaries/bitcoind/bitcoin-0.20.1/bin/bitcoind
        # bitcoind datadir
        datadir = ${HOME}/.bitcoin
        # bitcoind network binding
        bind = localhost
        # bitcoind p2p port
        port = 8333
        # bitcoind rpc binding
        rpcbind = localhost
        # bitcoind rpc port
        rpcport = 8332
    }
}

Step 6 (Optional): Moving To Testnet

To run your Bitcoin-S Server on testnet, simply change network = testnet3 and change your bitcoin-s.node.peers = ["neutrino.testnet3.suredbits.com:18333"] in your $HOME/.bitcoin-s/bitcoin-s.conf file. This will allow you to connect to Suredbits' neutrino-enabled bitcoind node. Keep in mind then when you restart your server, it will begin initial sync which will take many hours as all block filters for all testnet blocks will be downloaded. If you wish to speed this process up, download this snapshot, unzip it and put the file in your $HOME/.bitcoin-s/testnet3 directory and then from there, run

This will start syncing your testnet node from block header ~1,900,000 rather than starting from zero.

$ unzip chaindb-testnet-2021-02-03.zip
$ mv chaindb.sqlite ~/.bitcoin-s/testnet3/

This should take a couple minutes to execute, but once it is done, you will only have a short while left to sync once you start your server.

Last updated on 10/20/2021 by Chris Stewart
← Supported BIPsCLI →