2021-05-26 19:29:17 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Application Configuration · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "Bitcoin-S uses [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md)" / > < meta name = "docsearch:version" content = "next" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Application Configuration · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "Bitcoin-S uses [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md)" / > < meta property = "og:image" content = "https://bitcoin-s.org/img/undraw_online.svg" / > < meta name = "twitter:card" content = "summary" / > < meta name = "twitter:image" content = "https://bitcoin-s.org/img/undraw_tweetstorm.svg" / > < link rel = "shortcut icon" href = "/img/favicon.ico" / > < link rel = "stylesheet" href = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" / > < link rel = "stylesheet" href = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" / > < script >
2020-04-02 12:36:04 +00:00
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61958686-2', 'auto');
ga('send', 'pageview');
2021-07-06 16:15:27 +00:00
< / script > < link rel = "stylesheet" href = "/css/code-block-buttons.css" / > < script type = "text/javascript" src = "https://buttons.github.io/buttons.js" > < / script > < script type = "text/javascript" src = "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js" > < / script > < script type = "text/javascript" src = "https://fonts.googleapis.com/css?family=Montserrat:500" > < / script > < script type = "text/javascript" src = "https://www.googletagmanager.com/gtag/js?id=UA-61958686-2" > < / script > < script type = "text/javascript" src = "/js/code-block-buttons.js" > < / script > < script src = "/js/scrollSpy.js" > < / script > < link rel = "stylesheet" href = "/css/main.css" / > < script src = "/js/codetabs.js" > < / script > < / head > < body class = "sideNavVisible separateOnPageNav" > < div class = "fixedHeaderContainer" > < div class = "headerWrapper wrapper" > < header > < a href = "/" > < img class = "logo" src = "/img/favicon.ico" alt = "bitcoin-s" / > < h2 class = "headerTitleWithLogo" > bitcoin-s< / h2 > < / a > < a href = "/versions" > < h3 > next< / h3 > < / a > < div class = "navigationWrapper navigationSlider" > < nav class = "slidingNav" > < ul class = "nav-site nav-site-internal" > < li class = "siteNavGroupActive" > < a href = "/docs/next/core/core-intro" target = "_self" > Docs< / a > < / li > < li class = "" > < a href = "download" target = "_self" > Download< / a > < / li > < li class = "" > < a href = "/api/org/bitcoins" target = "_self" > API< / a > < / li > < li class = "" > < a href = "/help" target = "_self" > Help< / a > < / li > < li class = "navSearchWrapper reactNavSearchWrapper" > < input type = "text" id = "search_input_react" placeholder = "Search" title = "Search" / > < / li > < / ul > < / nav > < / div > < / header > < / div > < / div > < div class = "navPusher" > < div class = "docMainWrapper wrapper" > < div class = "docsNavContainer" id = "docsNav" > < nav class = "toc" > < div class = "toggleNav" > < section class = "navWrapper wrapper" > < div class = "navBreadcrumb wrapper" > < div class = "navToggle" id = "navToggler" > < div class = "hamburger-menu" > < div class = "line1" > < / div > < div class = "line2" > < / div > < div class = "line3" > < / div > < / div > < / div > < h2 > < i > › < / i > < span > Configuration< / span > < / h2 > < div class = "tocToggler" id = "tocToggler" > < i class = "icon-toc" > < / i > < / div > < / div > < div class = "navGroups" > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Getting Started< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/getting-started" > Intro and Getting Started< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/bips" > Supported BIPs< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Getting Setup< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/getting-setup" > Getting Bitcoin-S installed on your machine< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Applications< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/cli" > CLI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/server" > Application Server< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/gui" > GUI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/server-systemd" > Systemd installation< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Chain< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/chain" > Blockchain Verification< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/filter-sync" > Syncing Blockfilters< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/chain-query-api" > Chain Query API< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Configuration< / h3 > < ul class = "" > < li class = "navListItem navListItemActive" > < a class = "navItem" href = "/docs/next/config/configuration" > Application Configuration< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Core Module< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/core-intro" > Core Module< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/addresses" > Generating Addresses< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/hd-keys" > HD Key Gen
2021-05-26 19:29:17 +00:00
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length ; i + + ) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length ; j + + ) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings & & headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
< / script > < / nav > < / div > < div class = "container mainContainer docsContainer" > < div class = "wrapper" > < div class = "post" > < header class = "postHeader" > < a class = "edit-page-link button" href = "https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/config/configuration.md" target = "_blank" rel = "noreferrer noopener" > Edit< / a > < h1 id = "__docusaurus" class = "postHeaderTitle" > Application Configuration< / h1 > < / header > < article > < div > < span > < p > Bitcoin-S uses < a href = "https://github.com/lightbend/config/blob/master/HOCON.md" > HOCON< / a >
2021-04-07 13:43:19 +00:00
to configure various parts of the application the library offers. HOCON is a superset of JSON, that is, all valid JSON
is valid HOCON.< / p >
2019-08-26 12:25:44 +00:00
< p > All configuration for Bitcoin-S is under the < code > bitcoin-s< / code > key.< / p >
2021-04-07 13:43:19 +00:00
< p > If you have a file < code > application.conf< / code > anywhere on your classpath when using bitcoin-s, the values there take precedence
over the ones found in our
< code > reference.conf< / code > . We also look for the file < code > bitcoin-s.conf< / code > in the current Bitcoin-S data directory.< / p >
2019-08-26 12:25:44 +00:00
< p > The resolved configuration gets parsed by
2021-02-02 13:37:52 +00:00
< a href = "/api/org/bitcoins/db/AppConfig" > < code > AppConfig< / code > < / a > .
2021-04-07 13:43:19 +00:00
< code > AppConfig< / code > is an abstract class that's implemented by corresponding case classes in the < code > wallet< / code > , < code > chain< / code > and < code > node< / code >
projects. Here's some examples of how to construct a wallet configuration:< / p >
2019-08-26 12:25:44 +00:00
< pre > < code class = "hljs css language-scala" > < span class = "hljs-keyword" > import< / span > org.bitcoins.wallet.config.< span class = "hljs-type" > WalletAppConfig< / span >
< span class = "hljs-keyword" > import< / span > com.typesafe.config.< span class = "hljs-type" > ConfigFactory< / span >
< span class = "hljs-keyword" > import< / span > java.nio.file.< span class = "hljs-type" > Paths< / span >
< span class = "hljs-keyword" > import< / span > scala.util.< span class = "hljs-type" > Properties< / span >
2020-04-25 16:38:28 +00:00
< span class = "hljs-keyword" > import< / span > scala.concurrent.< span class = "hljs-type" > ExecutionContext< / span > .< span class = "hljs-type" > Implicits< / span > .global
2019-08-26 12:25:44 +00:00
< span class = "hljs-comment" > // reads $HOME/.bitcoin-s/< / span >
2020-08-14 14:08:00 +00:00
< span class = "hljs-keyword" > val< / span > defaultConfig = < span class = "hljs-type" > WalletAppConfig< / span > .fromDefaultDatadir()
2019-08-26 12:25:44 +00:00
< span class = "hljs-comment" > // reads a custom data directory< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-keyword" > val< / span > customDirectory = < span class = "hljs-type" > Paths< / span > .get(< span class = "hljs-type" > Properties< / span > .userHome, < span class = "hljs-string" > "custom-bitcoin-s-directory"< / span > )
2020-08-14 14:08:00 +00:00
< span class = "hljs-keyword" > val< / span > configFromCustomDatadir = < span class = "hljs-type" > WalletAppConfig< / span > (customDirectory)
2019-08-26 12:25:44 +00:00
< span class = "hljs-comment" > // reads a custom data directory and overrides the network to be testnet3< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-keyword" > val< / span > customOverride = < span class = "hljs-type" > ConfigFactory< / span > .parseString(< span class = "hljs-string" > "bitcoin-s.network = testnet3"< / span > )
2020-08-14 14:08:00 +00:00
< span class = "hljs-keyword" > val< / span > configFromCustomDirAndOverride = < span class = "hljs-type" > WalletAppConfig< / span > (customDirectory, customOverride)
2019-08-26 12:25:44 +00:00
< / code > < / pre >
2021-04-07 13:43:19 +00:00
< p > You can pass as many < code > com.typesafe.config.Config< / code > s as you'd like. If any keys appear multiple times the last one
encountered takes precedence.< / p >
2020-08-01 20:56:15 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "command-line-options" > < / a > < a href = "#command-line-options" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Command Line Options< / h2 >
< p > There are a few command line options available that take precedence over configuration file.< / p >
< ul >
< li > < p > < code > --datadir < directory> < / code > < / p >
< p > < code > datadir< / code > sets the data directory instead of using the default < code > $HOME/.bitcoin-s< / code > < / p > < / li >
2020-12-22 13:47:19 +00:00
< li > < p > < code > --rpcbind < ip> < / code > < / p >
< p > < code > rpcbind< / code > sets the interface the rpc server binds to instead of using the default < code > 127.0.0.1< / code > < / p > < / li >
2020-08-01 20:56:15 +00:00
< li > < p > < code > --rpcport < port> < / code > < / p >
< p > < code > rpcport< / code > sets the port the rpc server binds to instead of using the default < code > 9999< / code > < / p > < / li >
< li > < p > < code > --force-recalc-chainwork< / code > < / p >
2021-04-07 13:43:19 +00:00
< p > < code > force-recalc-chainwork< / code > will force a recalculation of the entire chain's chain work, this can be useful if there is
an incompatible migration or if it got out of sync.< / p > < / li >
2020-12-11 22:35:47 +00:00
< li > < p > < code > -Dlogback.configurationFile=/path/to/config.xml< / code > < / p >
2021-04-07 13:43:19 +00:00
< p > You can set a custom logback configuration. If you need help creating a custom logback file you can
read < a href = "http://logback.qos.ch/manual/configuration.html" > the logback configuration documentation< / a > .< / p > < / li >
2020-08-01 20:56:15 +00:00
< / ul >
2019-08-26 12:25:44 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "internal-configuration" > < / a > < a href = "#internal-configuration" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Internal configuration< / h2 >
2021-04-07 13:43:19 +00:00
< p > Database connections are also configured by using HOCON. This is done
in < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/master/db-commons/src/main/resources/reference.conf" > < code > reference.conf< / code > < / a >
inside the < code > db-commons< / code > module. The options exposed here are < strong > not< / strong > intended to be used by users of Bitcoin-S, and are
internal only.< / p >
2020-03-04 15:49:12 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "database-migrations" > < / a > < a href = "#database-migrations" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Database Migrations< / h2 >
< p > All of our modules that require databases now have database migrations. The tool we use for these migrations is
called < a href = "https://flywaydb.org/" > flyway< / a > . To find your projects migraitons, you need to look inside of the
< code > [project-name]/src/main/resources/[database-name]/migration/< / code > . For example, the chain projects migrations live under
the path < code > chain/src/main/resources/chaindb/migration/V1__chain_db_baseline.sql< / code > .< / p >
2021-04-07 13:43:19 +00:00
< p > Migrations can be executed by calling
the < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/e387d075b0ff2e0a0fec15788fcb48e4ddc4d9d5/db-commons/src/main/scala/org/bitcoins/db/DbManagement.scala#L92" > < code > DbManagement.migrate()< / code > < / a >
method. Migrations are applied by default on server startup, via
the < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/master/db-commons/src/main/scala/org/bitcoins/db/AppConfig.scala#L49" > < code > AppConfig.start()< / code > < / a >
2020-03-04 15:49:12 +00:00
method.< / p >
< p > These migrations are setup so that project's databases and migrations are independent of each other. Therefore if you
2021-04-07 13:43:19 +00:00
want to use the < code > bitcoin-s-chain< / code > project, but not the < code > bitcoin-s-wallet< / code > project, wallet migrations are not applied. It
should be noted if you are using a module as a library, you are responsible for configuring the database via
2020-03-04 15:49:12 +00:00
< a href = "https://scala-slick.org/doc/3.3.1/database.html#using-typesafe-config" > slick's configuration< / a > and calling
2020-08-27 19:49:50 +00:00
< a href = "https://github.com/bitcoin-s/bitcoin-s/blob/master/db-commons/src/main/scala/org/bitcoins/db/AppConfig.scala#L49" > < code > AppConfig.start()< / code > < / a >
2020-03-04 15:49:12 +00:00
to ensure the entire module is initialized correctly.< / p >
2020-01-27 13:32:43 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "example-configuration-file" > < / a > < a href = "#example-configuration-file" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Example Configuration File< / h2 >
< pre > < code class = "hljs css language-$xslt" > bitcoin-s {
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > datadir< / span > = ${HOME}/.bitcoin-s
< span class = "hljs-attr" > network< / span > = regtest < span class = "hljs-comment" > # regtest, testnet3, mainnet, signet< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > dbDefault< / span > = {
< span class = "hljs-attr" > dataSourceClass< / span > = slick.jdbc.DatabaseUrlDataSource
< span class = "hljs-attr" > profile< / span > = < span class = "hljs-string" > "slick.jdbc.SQLiteProfile$"< / span >
db {
< span class = "hljs-comment" > # for information on parameters available here see< / span >
< span class = "hljs-comment" > # https://scala-slick.org/doc/3.3.1/api/index.html#slick.jdbc.JdbcBackend$DatabaseFactoryDef@forConfig(String,Config,Driver,ClassLoader):Database< / span >
< span class = "hljs-attr" > path< / span > = ${bitcoin-s.datadir}/${bitcoin-s.network}/
< span class = "hljs-attr" > driver< / span > = org.sqlite.JDBC
< span class = "hljs-attr" > user< / span > = < span class = "hljs-string" > ""< / span >
< span class = "hljs-attr" > password< / span > = < span class = "hljs-string" > ""< / span >
< span class = "hljs-attr" > host< / span > = localhost
< span class = "hljs-attr" > port< / span > = < span class = "hljs-number" > 5432< / span >
< span class = "hljs-comment" > # this needs to be set to 1 for SQLITE as it does not support concurrent database operations< / span >
< span class = "hljs-comment" > # see: https://github.com/bitcoin-s/bitcoin-s/pull/1840< / span >
< span class = "hljs-attr" > numThreads< / span > = < span class = "hljs-number" > 1< / span >
< span class = "hljs-attr" > queueSize=5000< / span >
< span class = "hljs-attr" > connectionPool< / span > = < span class = "hljs-string" > "HikariCP"< / span >
< span class = "hljs-attr" > registerMbeans< / span > = < span class = "hljs-literal" > true< / span >
}
< span class = "hljs-attr" > hikari-logging< / span > = < span class = "hljs-literal" > false< / span >
2021-04-21 12:50:07 +00:00
< span class = "hljs-attr" > hikari-logging-interval< / span > = < span class = "hljs-number" > 10< / span > minute
2021-02-02 13:37:52 +00:00
}
2020-10-01 19:52:43 +00:00
bitcoind-rpc {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # bitcoind rpc username< / span >
< span class = "hljs-attr" > rpcuser< / span > = user
< span class = "hljs-comment" > # bitcoind rpc password< / span >
< span class = "hljs-attr" > rpcpassword< / span > = password
< span class = "hljs-comment" > # Binary location of bitcoind< / span >
< span class = "hljs-attr" > binary< / span > = ${HOME}/.bitcoin-s/binaries/bitcoind/bitcoin-< span class = "hljs-number" > 0.20< / span > .< span class = "hljs-number" > 1< / span > /bin/bitcoind
< span class = "hljs-comment" > # bitcoind datadir< / span >
< span class = "hljs-attr" > datadir< / span > = ${HOME}/.bitcoin
< span class = "hljs-comment" > # bitcoind network binding< / span >
< span class = "hljs-attr" > bind< / span > = localhost
< span class = "hljs-comment" > # bitcoind p2p port< / span >
< span class = "hljs-attr" > port< / span > = < span class = "hljs-number" > 8333< / span >
< span class = "hljs-comment" > # bitcoind rpc binding< / span >
< span class = "hljs-attr" > rpcbind< / span > = localhost
< span class = "hljs-comment" > # bitcoind rpc port< / span >
< span class = "hljs-attr" > rpcport< / span > = < span class = "hljs-number" > 8332< / span >
2021-04-21 12:50:07 +00:00
< span class = "hljs-comment" > # bitcoind zmq raw tx< / span >
< span class = "hljs-attr" > zmqpubrawtx< / span > = < span class = "hljs-string" > "tcp://127.0.0.1:28332"< / span >
< span class = "hljs-comment" > # bitcoind zmq raw block< / span >
< span class = "hljs-attr" > zmqpubrawblock< / span > = < span class = "hljs-string" > "tcp://127.0.0.1:28333"< / span >
< span class = "hljs-comment" > # bitcoind zmq hash tx< / span >
< span class = "hljs-attr" > zmqpubhashtx< / span > = < span class = "hljs-string" > "tcp://127.0.0.1:28330"< / span >
< span class = "hljs-comment" > # bitcoind zmq raw block< / span >
< span class = "hljs-attr" > zmqpubhashblock< / span > = < span class = "hljs-string" > "tcp://127.0.0.1:28331"< / span >
2020-10-01 19:52:43 +00:00
}
2020-01-27 13:32:43 +00:00
node {
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > mode< / span > = neutrino < span class = "hljs-comment" > # neutrino, spv, bitcoind< / span >
2020-01-27 13:32:43 +00:00
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > peers< / span > = [] < span class = "hljs-comment" > # a list of peer addresses in form "hostname:portnumber"< / span >
< span class = "hljs-comment" > # (e.g. "neutrino.testnet3.suredbits.com:18333")< / span >
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # Port number is optional, the default value is 8333 for mainnet,< / span >
< span class = "hljs-comment" > # 18333 for testnet and 18444 for regtest.< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > hikari-logging< / span > = < span class = "hljs-literal" > true< / span >
2021-04-21 12:50:07 +00:00
< span class = "hljs-attr" > hikari-logging-interval< / span > = < span class = "hljs-number" > 10< / span > minute
2020-01-27 13:32:43 +00:00
}
2021-07-13 19:49:07 +00:00
proxy {
< span class = "hljs-comment" > # You can configure SOCKS5 proxy to use Tor for outgoing connections< / span >
< span class = "hljs-attr" > enabled< / span > = < span class = "hljs-literal" > false< / span >
< span class = "hljs-attr" > host< / span > = < span class = "hljs-string" > "127.0.0.1"< / span >
< span class = "hljs-attr" > port< / span > = < span class = "hljs-number" > 9050< / span >
}
2020-01-27 13:32:43 +00:00
chain {
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > force-recalc-chainwork< / span > = < span class = "hljs-literal" > false< / span >
2020-01-27 13:32:43 +00:00
neutrino {
2021-01-28 23:21:34 +00:00
filter-header-batch-size.< span class = "hljs-attr" > default< / span > = < span class = "hljs-number" > 2000< / span >
filter-header-batch-size.< span class = "hljs-attr" > regtest< / span > = < span class = "hljs-number" > 10< / span >
< span class = "hljs-comment" > # You can set a network specific filter-header-batch-size< / span >
< span class = "hljs-comment" > # by adding a trailing `.networkId` (main, test, regtest)< / span >
< span class = "hljs-comment" > # It is recommended to keep the main and test batch size high< / span >
< span class = "hljs-comment" > # to keep the sync time fast, however, for regtest it should be small< / span >
< span class = "hljs-comment" > # so it does not exceed the chain size.< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > filter-batch-size< / span > = < span class = "hljs-number" > 1000< / span >
2020-01-27 13:32:43 +00:00
}
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > hikari-logging< / span > = < span class = "hljs-literal" > true< / span >
2021-04-21 12:50:07 +00:00
< span class = "hljs-attr" > hikari-logging-interval< / span > = < span class = "hljs-number" > 10< / span > minute
2020-01-27 13:32:43 +00:00
}
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # settings for wallet module< / span >
2020-01-27 13:32:43 +00:00
wallet {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # You can have multiple wallets by setting a different< / span >
< span class = "hljs-comment" > # wallet name for each of them. They will each have< / span >
< span class = "hljs-comment" > # their own unique seed and database or schema,< / span >
< span class = "hljs-comment" > # depending on the database driver.< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-comment" > # The wallet name can contain letters, numbers, and underscores '_'.< / span >
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # walletName = MyWallet0< / span >
2020-12-22 12:44:39 +00:00
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > defaultAccountType< / span > = segwit < span class = "hljs-comment" > # legacy, segwit, nested-segwit< / span >
2020-01-27 13:32:43 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > bloomFalsePositiveRate< / span > = < span class = "hljs-number" > 0.0001< / span > < span class = "hljs-comment" > # percentage< / span >
2020-01-27 13:32:43 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > addressGapLimit< / span > = < span class = "hljs-number" > 20< / span >
2020-01-27 13:32:43 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > discoveryBatchSize< / span > = < span class = "hljs-number" > 100< / span >
2020-04-08 22:00:11 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-attr" > requiredConfirmations< / span > = < span class = "hljs-number" > 6< / span >
2020-04-10 19:28:53 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # How big the address queue size is before we throw an exception< / span >
< span class = "hljs-comment" > # because of an overflow< / span >
< span class = "hljs-attr" > addressQueueSize< / span > = < span class = "hljs-number" > 10< / span >
2020-04-10 19:28:53 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # How long we attempt to generate an address for< / span >
< span class = "hljs-comment" > # before we timeout< / span >
< span class = "hljs-attr" > addressQueueTimeout< / span > = < span class = "hljs-number" > 5< / span > seconds
2021-02-02 13:37:52 +00:00
2021-04-07 13:43:19 +00:00
< span class = "hljs-comment" > # How often the wallet will rebroadcast unconfirmed transactions< / span >
< span class = "hljs-attr" > rebroadcastFrequency< / span > = < span class = "hljs-number" > 4< / span > hours
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > hikari-logging< / span > = < span class = "hljs-literal" > true< / span >
2021-04-21 12:50:07 +00:00
< span class = "hljs-attr" > hikari-logging-interval< / span > = < span class = "hljs-number" > 10< / span > minute
2020-12-11 22:35:47 +00:00
}
2020-11-11 19:29:05 +00:00
2020-12-11 22:35:47 +00:00
keymanager {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # You can optionally set a BIP 39 password< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-comment" > # bip39password = "changeMe"< / span >
2020-12-02 14:09:47 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # Password that your seed is encrypted with< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > aesPassword< / span > = changeMe
2020-12-11 22:35:47 +00:00
}
2020-12-02 14:09:47 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # Bitcoin-S provides manny different fee providers< / span >
< span class = "hljs-comment" > # You can configure your server to use any of them< / span >
< span class = "hljs-comment" > # Below is some examples of different options< / span >
2020-11-05 14:31:53 +00:00
fee-provider {
2021-02-02 13:37:52 +00:00
< span class = "hljs-comment" > # name = mempoolspace # Uses mempool.space's api< / span >
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The target is optional for mempool.space< / span >
< span class = "hljs-comment" > # It refers to the expected number of blocks until confirmation< / span >
< span class = "hljs-comment" > # target = 6< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-comment" > # name = bitcoinerlive # Uses bitcoiner.live's api< / span >
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The target is optional for Bitcoiner Live< / span >
< span class = "hljs-comment" > # It refers to the expected number of blocks until confirmation< / span >
< span class = "hljs-comment" > # target = 6< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-comment" > # name = bitgo # Uses BitGo's api< / span >
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The target is optional for BitGo< / span >
< span class = "hljs-comment" > # It refers to the expected number of blocks until confirmation< / span >
< span class = "hljs-comment" > # target = 6< / span >
< span class = "hljs-comment" > # name = constant # A constant fee rate in sats/vbyte< / span >
< span class = "hljs-comment" > # target = 1 # Will always use 1 sat/vbyte< / span >
2020-11-05 14:31:53 +00:00
}
server {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The port we bind our rpc server on< / span >
< span class = "hljs-attr" > rpcport< / span > = < span class = "hljs-number" > 9999< / span >
2020-12-22 13:47:19 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The ip address we bind our server too< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > rpcbind< / span > = < span class = "hljs-string" > "127.0.0.1"< / span >
}
oracle {
2021-02-16 17:07:43 +00:00
< span class = "hljs-comment" > # The port we bind our rpc server on< / span >
2021-02-17 16:00:18 +00:00
< span class = "hljs-attr" > rpcport< / span > = < span class = "hljs-number" > 9998< / span >
2021-02-16 17:07:43 +00:00
< span class = "hljs-comment" > # The ip address we bind our server too< / span >
< span class = "hljs-attr" > rpcbind< / span > = < span class = "hljs-string" > "127.0.0.1"< / span >
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > hikari-logging< / span > = < span class = "hljs-literal" > true< / span >
2021-04-21 12:50:07 +00:00
< span class = "hljs-attr" > hikari-logging-interval< / span > = < span class = "hljs-number" > 10< / span > minute
2021-02-19 16:35:51 +00:00
db {
< span class = "hljs-attr" > path< / span > = ${bitcoin-s.datadir}/oracle/
}
2021-01-29 17:59:35 +00:00
}
2021-07-19 15:19:02 +00:00
testkit {
pg {
< span class = "hljs-comment" > #enabled postgres backend database for all test cases< / span >
< span class = "hljs-attr" > enabled< / span > = < span class = "hljs-literal" > false< / span >
}
}
2020-01-27 13:32:43 +00:00
}
akka {
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > loglevel< / span > = < span class = "hljs-string" > "OFF"< / span >
< span class = "hljs-attr" > stdout-loglevel< / span > = < span class = "hljs-string" > "OFF"< / span >
2020-01-27 13:32:43 +00:00
http {
2020-11-05 14:31:53 +00:00
client {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The time after which an idle connection will be automatically closed.< / span >
< span class = "hljs-comment" > # Set to `infinite` to completely disable idle connection timeouts.< / span >
2020-12-11 22:35:47 +00:00
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # some requests potentially take a long time, like generate and prune< / span >
< span class = "hljs-attr" > idle-timeout< / span > = < span class = "hljs-number" > 5< / span > minutes
2020-12-11 22:35:47 +00:00
}
2020-12-02 14:09:47 +00:00
2020-12-11 22:35:47 +00:00
server {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # The amount of time until a request times out on the server< / span >
< span class = "hljs-comment" > # If you have a large payload this may need to be bumped< / span >
< span class = "hljs-comment" > # https://doc.akka.io/docs/akka-http/current/common/timeouts.html#request-timeout< / span >
< span class = "hljs-attr" > request-timeout< / span > = < span class = "hljs-number" > 10< / span > s
2020-12-02 14:09:47 +00:00
}
2020-01-27 13:32:43 +00:00
}
actor {
2020-11-05 14:31:53 +00:00
debug {
2021-01-28 23:21:34 +00:00
< span class = "hljs-comment" > # enable DEBUG logging of all AutoReceiveMessages (Kill, PoisonPill etc.)< / span >
< span class = "hljs-attr" > autoreceive=< / span > off
< span class = "hljs-comment" > # enable function of LoggingReceive, which is to log any received message at< / span >
< span class = "hljs-comment" > # DEBUG level< / span >
< span class = "hljs-attr" > receive< / span > = on
< span class = "hljs-comment" > # enable DEBUG logging of unhandled messages< / span >
< span class = "hljs-attr" > unhandled< / span > = off
< span class = "hljs-comment" > # enable DEBUG logging of actor lifecycle changes< / span >
< span class = "hljs-attr" > lifecycle< / span > = off
< span class = "hljs-attr" > event-stream=off< / span >
2020-01-27 13:32:43 +00:00
}
}
}
2021-01-28 23:21:34 +00:00
< / code > < / pre >
2020-06-08 12:26:22 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "database-configuration" > < / a > < a href = "#database-configuration" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Database configuration< / h2 >
2021-04-07 13:43:19 +00:00
< p > By default, bitcoin-s uses Sqlite to store its data. It creates three Sqlite databases
in < code > ~/.bitcoin-s/${network}< / code > : < code > chain.sqlite< / code > for < code > chain< / code > project,
< code > node.sqlite< / code > for < code > node< / code > project and < code > wallet.sqlite< / code > the wallet. This is the default configuration, it doesn't require
additional changes in the config file.< / p >
< p > < code > bitcoin-s< / code > also supports PostgreSQL as a database backend. In order to use a PostgreSQL database for all project you
need to add following into your config file:< / p >
2020-06-08 12:26:22 +00:00
< pre > < code class = "hljs css language-$xslt" > bitcoin-s {
2021-02-02 13:37:52 +00:00
common {
< span class = "hljs-attr" > profile< / span > = < span class = "hljs-string" > "slick.jdbc.PostgresProfile$"< / span >
2020-06-08 12:26:22 +00:00
db {
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > driver< / span > = org.postgresql.Driver
2020-12-22 12:44:39 +00:00
2021-02-02 13:37:52 +00:00
< span class = "hljs-comment" > # these 3 options will result into a jdbc url of< / span >
< span class = "hljs-comment" > # "jdbc:postgresql://localhost:5432/database"< / span >
< span class = "hljs-attr" > name< / span > = database
< span class = "hljs-attr" > host< / span > = localhost
< span class = "hljs-attr" > port< / span > = < span class = "hljs-number" > 5432< / span >
2020-12-22 12:44:39 +00:00
2021-02-02 13:37:52 +00:00
< span class = "hljs-attr" > user< / span > = < span class = "hljs-string" > "user"< / span >
< span class = "hljs-attr" > password< / span > = < span class = "hljs-string" > "topsecret"< / span >
< span class = "hljs-attr" > numThreads< / span > = < span class = "hljs-number" > 5< / span >
< span class = "hljs-comment" > # http://scala-slick.org/doc/3.3.3/database.html< / span >
< span class = "hljs-attr" > connectionPool< / span > = < span class = "hljs-string" > "HikariCP"< / span >
< span class = "hljs-attr" > registerMbeans< / span > = < span class = "hljs-literal" > true< / span >
2020-06-08 12:26:22 +00:00
}
}
2020-08-26 19:32:30 +00:00
2021-02-02 13:37:52 +00:00
chain.< span class = "hljs-attr" > profile< / span > = ${bitcoin-s.common.profile}
chain.< span class = "hljs-attr" > db< / span > = ${bitcoin-s.common.db}
chain.db.< span class = "hljs-attr" > poolName< / span > = < span class = "hljs-string" > "chain-connection-pool"< / span >
node.< span class = "hljs-attr" > profile< / span > = ${bitcoin-s.common.profile}
node.< span class = "hljs-attr" > db< / span > = ${bitcoin-s.common.db}
node.db.< span class = "hljs-attr" > poolName< / span > = < span class = "hljs-string" > "node-connection-pool"< / span >
2020-08-26 19:32:30 +00:00
2021-02-02 13:37:52 +00:00
wallet.< span class = "hljs-attr" > profile< / span > = ${bitcoin-s.common.profile}
wallet.< span class = "hljs-attr" > db< / span > = ${bitcoin-s.common.db}
wallet.db.< span class = "hljs-attr" > poolName< / span > = < span class = "hljs-string" > "wallet-connection-pool"< / span >
2020-12-11 22:35:47 +00:00
2021-02-02 13:37:52 +00:00
oracle.< span class = "hljs-attr" > profile< / span > = ${bitcoin-s.common.profile}
oracle.< span class = "hljs-attr" > db< / span > = ${bitcoin-s.common.db}
oracle.db.< span class = "hljs-attr" > poolName< / span > = < span class = "hljs-string" > "oracle-connection-pool"< / span >
2020-06-08 12:26:22 +00:00
}
< / code > < / pre >
2020-08-26 19:32:30 +00:00
< p > The database driver will create a separate SQL namespace for each sub-project: < code > chain< / code > , < code > node< / code > and < code > wallet< / code > .< / p >
2021-04-07 13:43:19 +00:00
< p > Also you can use mix databases and drivers in one configuration. For example, This configuration file enables Sqlite
for < code > node< / code > project (it's default, so its configuration is omitted), and < code > walletdb< / code > and < code > chaindb< / code > PostgreSQL databases
for < code > wallet< / code > and < code > chain< / code > projects:< / p >
2020-06-08 12:26:22 +00:00
< pre > < code class = "hljs css language-$xslt" > bitcoin-s {
chain {
2021-02-02 13:37:52 +00:00
< span class = "hljs-built_in" > profile < / span > = < span class = "hljs-string" > "slick.jdbc.PostgresProfile$"< / span >
2020-06-08 12:26:22 +00:00
db {
2021-02-02 13:37:52 +00:00
driver = org.postgresql.Driver
name = chaindb
host = localhost
< span class = "hljs-built_in" > port < / span > = 5432
< span class = "hljs-built_in" > user < / span > = < span class = "hljs-string" > "user"< / span >
password = < span class = "hljs-string" > "topsecret"< / span >
2020-06-08 12:26:22 +00:00
}
}
wallet {
2021-02-02 13:37:52 +00:00
< span class = "hljs-built_in" > profile < / span > = < span class = "hljs-string" > "slick.jdbc.PostgresProfile$"< / span >
2020-06-08 12:26:22 +00:00
db {
2021-02-02 13:37:52 +00:00
driver = org.postgresql.Driver
name = walletdb
host = localhost
< span class = "hljs-built_in" > port < / span > = 5432
< span class = "hljs-built_in" > user < / span > = < span class = "hljs-string" > "user"< / span >
password = < span class = "hljs-string" > "topsecret"< / span >
2020-06-08 12:26:22 +00:00
}
}
}
< / code > < / pre >
2021-05-26 19:29:17 +00:00
< / span > < / div > < / article > < / div > < div class = "docs-prevnext" > < a class = "docs-prev button" href = "/docs/next/chain/chain-query-api" > < span class = "arrow-prev" > ← < / span > < span > Chain Query API< / span > < / a > < a class = "docs-next button" href = "/docs/next/core/core-intro" > < span > Core Module< / span > < span class = "arrow-next" > →< / span > < / a > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < li > < a href = "#command-line-options" > Command Line Options< / a > < / li > < li > < a href = "#internal-configuration" > Internal configuration< / a > < / li > < li > < a href = "#database-migrations" > Database Migrations< / a > < / li > < li > < a href = "#example-configuration-file" > Example Configuration File< / a > < / li > < li > < a href = "#database-configuration" > Database configuration< / a > < / li > < / ul > < / nav > < / div > < footer class = "nav-footer" id = "footer" > < section class = "sitemap" > < a href = "/" class = "nav-home" > < img src = "/img/favicon.ico" alt = "bitcoin-s" width = "66" height = "58" / > < / a > < div > < h5 > Docs< / h5 > < a href = "/docs/en/getting-started" > Getting Started< / a > < a href = "/docs/en/core/core-intro" > Guides< / a > < a href = "/api/org/bitcoins" > API Reference< / a > < / div > < div > < h5 > Community< / h5 > < a href = "/en/users.html" > User Showcase< / a > < a href = "https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target = "_blank" rel = "noreferrer noopener" > Slack< / a > < a href = "https://gitter.im/bitcoin-s-core/" > Gitter chat< / a > < / div > < div > < h5 > More< / h5 > < a href = "https://github.com/bitcoin-s/bitcoin-s" > GitHub< / a > < a class = "github-button" href = "https://github.com/bitcoin-s/bitcoin-s" data-icon = "octicon-star" data-count-href = "/bitcoin-s/bitcoin-s-core/stargazers" data-show-count = "true" data-count-aria-label = "# stargazers on GitHub" aria-label = "Star this project on GitHub" > Star< / a > < / div > < / section > < section class = "copyright" > Copyright © 2021 Suredbits & the bitcoin-s developers< / section > < / footer > < / div > < script type = "text/javascript" src = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js" > < / script > < script >
2019-08-26 12:25:44 +00:00
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search & & search.focus();
}
});
< / script > < script >
var search = docsearch({
apiKey: '0a510688bf8448e19aeb380377d328d3',
indexName: 'bitcoin-s',
inputSelector: '#search_input_react'
});
< / script > < / body > < / html >
