bitcoin-s/docs/applications/server.md

id	title
server	Application Server

App server

The server project is the aggregation of these three sub projects

1. Wallet
2. Chain
3. Node

The server project provides a away to access information from these three projects via a JSON RPC.

Building the server

You can build the server with the sbt native packager. The native packager offers numerous ways to package the project.

In this example we are going to use stage which will produce bash scripts we can easily execute. You can stage the server with the following command.

sbt appServer/universal:stage

This will produce a script to execute bitcoin-s which you can start with

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

Installation

Linux

For server side installation you'll need to install a Java Virtual Machine first.

sudo apt install openjdk-11-jdk-headless

Then build a Bitcoin-S server as described above and copy it into /usr/local:

sudo cp -r app/server/target/universal/stage /usr/local/bitcoin-s
sudo chmod +x /usr/local/bitcoin-s/bin/bitcoin-s-server

The server process will run in the background and use a separate user for security reasons. This user does not have admin rights and cannot change the system configuration.

sudo adduser bitcoins

In this case you'll need to put the config file into /home/bitcoins/.bitcoin-s/bitcoin-s.conf.

To start the server as a daemon on system startup we'll need to configure a systemd service. Create bitcoin-s.service file using your favorite text editor.

sudo nano /etc/systemd/system/bitcoin-s.service

Then copy this script into the editor, then save end exit.

[Unit]
Description=Bitcoin-S Node
After=network.target

[Service]
ExecStart=/usr/local/bitcoin-s/bin/bitcoin-s-server

User=bitcoins
Group=bitcoins

Type=simple
Restart=always
RestartSec=60

PrivateTmp=true
ProtectSystem=full
NoNewPrivileges=true
PrivateDevices=true

[Install]
WantedBy=multi-user.target

Enable the service:

sudo systemctl enable bitcoin-s.service

Start the server.

sudo systemctl start bitcoin-s.service

The server will write all logs into /var/log/syslog.

Configuration

If you would like to pass in a custom datadir for your server, you can do

./app/server/target/universal/stage/bin/bitcoin-s-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/server/target/universal/stage/bin/bitcoin-s-server --conf /path/to/file.conf

You can also pass in a custom rpcport to bind to

./app/server/target/universal/stage/bin/bitcoin-s-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 cli.md

Server Endpoints

Blockchain

• getblockcount - Get the current block height
• getfiltercount - Get the number of filters
• getfilterheadercount - Get the number of filter headers
• getbestblockhash - Get the best block hash
• decoderawtransaction tx - Decode the given raw hex transaction
  • tx - Transaction encoded in hex to decode

Wallet

• rescan [options] - Rescan for wallet UTXOs
  • --force - Clears existing wallet records. Warning! Use with caution!
  • --batch-size <value> - Number of filters that can be matched in one batch
  • --start <value> - Start height
  • --end <value> - End height
  • --ignorecreationtime - Ignores the wallet creation date and will instead do a full rescan
• isempty - Checks if the wallet contains any data
• getbalance [options] - Get the wallet balance
  • --sats - Display balance in satoshis
• getconfirmedbalance [options] - Get the wallet balance of confirmed utxos
  • --sats - Display balance in satoshis
• getunconfirmedbalance [options] - Get the wallet balance of unconfirmed utxos
  • --sats - Display balance in satoshis
• getutxos - Returns list of all wallet utxos
• getaddresses - Returns list of all wallet addresses currently being watched
• getspentaddresses - Returns list of all wallet addresses that have received funds and been spent
• getfundedaddresses - Returns list of all wallet addresses that are holding funds
• getunusedaddresses - Returns list of all wallet addresses that have not been used
• getaccounts - Returns list of all wallet accounts
• createnewaccount - Creates a new wallet account
• getaddressinfo address - Returns list of all wallet accounts
  • address - Address to get information about
• getnewaddress - Get a new address
• sendtoaddress address amount [options] - Send money to the given address
  • address - Address to send to
  • amount - Amount to send in BTC
  • --feerate <value> - Fee rate in sats per virtual byte
• sendfromoutpoints outpoints address amount [options] - Send money to the given address
  • outpoints - Out Points to send from
  • address - Address to send to
  • amount - Amount to send in BTC
  • --feerate <value> - Fee rate in sats per virtual byte
• sendwithalgo address amount algo [options] - Send money to the given address using a specific coin selection algo
  • address - Address to send to
  • amount - Amount to send in BTC
  • algo - Coin selection algo
  • --feerate <value> - Fee rate in sats per virtual byte
• signpsbt psbt - Signs the PSBT's inputs with keys that are associated with the wallet
  • psbt - PSBT to sign
• opreturncommit message [options] - Creates OP_RETURN commitment transaction
  • message - message to put into OP_RETURN commitment
  • --hashMessage - should the message be hashed before commitment
  • --feerate <value> - Fee rate in sats per virtual byte
• bumpfeecpfp txid feerate - Bump the fee of the given transaction id with a child tx using the given fee rate
  • txid - Id of transaction to bump fee
  • feerate - Fee rate in sats per virtual byte of the child transaction
• bumpfeerbf txid feerate - Replace given transaction with one with the new fee rate
  • txid - Id of transaction to bump fee
  • feerate - New fee rate in sats per virtual byte
• gettransaction txid - Get detailed information about in-wallet transaction
  • txid - The transaction id
• lockunspent unlock transactions - Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs.
  • unlock - Whether to unlock (true) or lock (false) the specified transactions
  • transactions - The transaction outpoints to unlock/lock
• importseed walletname words passphrase - Imports a mnemonic seed as a new seed file
  • walletname - Name to associate with this seed
  • words - Mnemonic seed words, space separated
  • passphrase - Passphrase to encrypt this seed with
• importxprv walletname xprv passphrase - Imports a mnemonic seed as a new seed file
  • walletname - Name to associate with this seed
  • xprv - base58 encoded extended private key
  • passphrase - Passphrase to encrypt this seed with
• keymanagerpassphrasechange oldpassphrase newpassphrase - Changes the wallet passphrase
  • oldpassphrase - The current passphrase
  • newpassphrase - The new passphrase
• keymanagerpassphraseset passphrase - Encrypts the wallet with the given passphrase
  • passphrase - The passphrase to encrypt the wallet with

Network

• getpeers - List the connected peers
• stop - Request a graceful shutdown of Bitcoin-S
• sendrawtransaction tx Broadcasts the raw transaction
  • tx - Transaction serialized in hex

PSBT

• decodepsbt psbt - Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.
  • psbt - PSBT serialized in hex or base64 format
• combinepsbts psbts - Combines all the given PSBTs
  • psbts - PSBTs serialized in hex or base64 format
• joinpsbts psbts - Combines all the given PSBTs
  • psbts - PSBTs serialized in hex or base64 format
• finalizepsbt psbt - Finalizes the given PSBT if it can
  • psbt - PSBT serialized in hex or base64 format
• extractfrompsbt psbt - Extracts a transaction from the given PSBT if it can
  • psbt - PSBT serialized in hex or base64 format
• converttopsbt unsignedTx - Creates an empty psbt from the given transaction
  • unsignedTx - serialized unsigned transaction in hex

Sign PSBT with Wallet Example

Bitcoin-S CLI:

$ bitcoin-s-cli signpsbt cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA
cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA

CURL:

$ curl --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "signpsbt", "params": ["cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA"]}' -H "Content-Type: application/json" http://127.0.0.1:9999/
{"result":"cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA","error":null}