2022-11-16 16:25:04 +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 = "1.9.7" / > < 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');
2022-11-16 16:25:04 +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 > 1.9.7< / h3 > < / a > < div class = "navigationWrapper navigationSlider" > < nav class = "slidingNav" > < ul class = "nav-site nav-site-internal" > < li class = "" > < a href = "/docs/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 = "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/applications/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 >
2019-12-16 12:03:51 +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 >
< p > All configuration for Bitcoin-S is under the < code > bitcoin-s< / code > key.< / p >
< 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 >
< p > The resolved configuration gets parsed by
< a href = "../../db-commons/src/main/scala/org/bitcoins/db/AppConfig.scala" > < code > AppConfig< / code > < / a > .
< 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 >
< 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 >
< span class = "hljs-comment" > // reads $HOME/.bitcoin-s/< / span >
< span class = "hljs-keyword" > val< / span > defaultConfig = < span class = "hljs-type" > WalletAppConfig< / span > .fromDefaultDatadir()
< 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 > )
2019-12-16 12:03:51 +00:00
< span class = "hljs-keyword" > val< / span > configFromCustomDatadir = < span class = "hljs-type" > WalletAppConfig< / span > (customDirectory)
< 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 > )
2019-12-16 12:03:51 +00:00
< span class = "hljs-keyword" > val< / span > configFromCustomDirAndOverride = < span class = "hljs-type" > WalletAppConfig< / span > (customDirectory, customOverride)
< / code > < / pre >
< 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 >
< 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 >
< p > Database connections are also configured by using HOCON. This is done in
< a href = "../../db-commons/src/main/resources/db.conf" > < code > db.conf< / code > < / a > . The options
exposed here are < strong > not< / strong > intended to
be used by users of Bitcoin-S, and are internal only.< / p >
2020-03-19 12:41:03 +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 >
< 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.initialize()< / code > < / a >
method.< / p >
< p > These migrations are setup so that project's databases and migrations are independent of each other. Therefore if you
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
< a href = "https://scala-slick.org/doc/3.3.1/database.html#using-typesafe-config" > slick's configuration< / a > and calling
< a href = "https://github.com/bitcoin-s/bitcoin-s/blob/master/db-commons/src/main/scala/org/bitcoins/db/AppConfig.scala#L49" > < code > AppConfig.initialize()< / code > < / a >
to ensure the entire module is initialized correctly.< / p >
< 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-02-02 13:37:52 +00:00
datadir = < span class = "hljs-variable" > ${HOME}< / span > /.bitcoin-s
< span class = "hljs-built_in" > network < / span > = regtest # regtest, testnet3, mainnet
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
< span class = "hljs-built_in" > logging < / span > {
level = WARN # trace, debug, info, warn, error, off
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# You can also tune specific module loggers.
# They each take the same levels as above.
# < span class = "hljs-keyword" > If< / span > they are commented out (as they are
# by default), `logging.level` gets used
# instead.
# The available loggers are:
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
#< span class = "hljs-built_in" > incoming < / span > < span class = "hljs-keyword" > and< / span > outgoing P2P messages
# p2p = < span class = "hljs-builtin-name" > info< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# verification of block headers, merkle trees
# chain-verification = < span class = "hljs-builtin-name" > info< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# generation of addresses, signing of TXs
# key-handling = < span class = "hljs-builtin-name" > info< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# wallet operations < span class = "hljs-keyword" > not< / span > related < span class = "hljs-keyword" > to< / span > key management
# wallet = < span class = "hljs-builtin-name" > info< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# HTTP RPC< span class = "hljs-built_in" > server
< / span > # http = < span class = "hljs-builtin-name" > info< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# Database interactions
# database = < span class = "hljs-builtin-name" > info< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# whether < span class = "hljs-keyword" > or< / span > < span class = "hljs-keyword" > not< / span > < span class = "hljs-keyword" > to< / span > write < span class = "hljs-keyword" > to< / span > the log file
disable-file = < span class = "hljs-literal" > false< / span >
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# whether < span class = "hljs-keyword" > or< / span > < span class = "hljs-keyword" > not< / span > < span class = "hljs-keyword" > to< / span > log < span class = "hljs-keyword" > to< / span > stdout
disable-console = < span class = "hljs-literal" > false< / span >
2020-03-19 12:41:03 +00:00
}
node {
2021-02-02 13:37:52 +00:00
mode = neutrino # neutrino, spv
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
peers = [] # a list of< span class = "hljs-built_in" > peer < / span > addresses < span class = "hljs-keyword" > in< / span > form < span class = "hljs-string" > "hostname:portnumber"< / span >
# (e.g. < span class = "hljs-string" > "neutrino.testnet3.suredbits.com:18333"< / span > )
#< span class = "hljs-built_in" > Port < / span > number is optional, the< span class = "hljs-built_in" > default < / span > value is 8333 < span class = "hljs-keyword" > for< / span > mainnet,
# 18333 < span class = "hljs-keyword" > for< / span > testnet < span class = "hljs-keyword" > and< / span > 18444 < span class = "hljs-keyword" > for< / span > regtest.
2020-03-19 12:41:03 +00:00
}
chain {
neutrino {
2021-02-02 13:37:52 +00:00
filter-header-batch-size = 2000
filter-batch-size = 100
2020-03-19 12:41:03 +00:00
}
}
2021-02-02 13:37:52 +00:00
#< span class = "hljs-built_in" > settings < / span > < span class = "hljs-keyword" > for< / span > wallet module
2020-03-19 12:41:03 +00:00
wallet {
2021-02-02 13:37:52 +00:00
defaultAccountType = legacy # legacy, segwit, nested-segwit
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
bloomFalsePositiveRate = 0.0001 # percentage
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
addressGapLimit = 20
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
discoveryBatchSize = 100
requiredConfirmations = 6
2020-03-19 12:41:03 +00:00
}
}
akka {
2021-02-02 13:37:52 +00:00
loglevel = < span class = "hljs-string" > "OFF"< / span >
stdout-loglevel = < span class = "hljs-string" > "OFF"< / span >
2020-03-19 12:41:03 +00:00
http {
2021-02-02 13:37:52 +00:00
< span class = "hljs-built_in" > client < / span > {
# The time after which an idle< span class = "hljs-built_in" > connection < / span > will be automatically closed.
# < span class = "hljs-builtin-name" > Set< / span > < span class = "hljs-keyword" > to< / span > `infinite` < span class = "hljs-keyword" > to< / span > completely < span class = "hljs-builtin-name" > disable< / span > idle< span class = "hljs-built_in" > connection < / span > timeouts.
2020-03-19 12:41:03 +00:00
2021-02-02 13:37:52 +00:00
# some requests potentially take a long time, like generate < span class = "hljs-keyword" > and< / span > prune
idle-timeout = 5 minutes
2020-03-19 12:41:03 +00:00
}
}
actor {
2021-02-02 13:37:52 +00:00
< span class = "hljs-builtin-name" > debug< / span > {
# < span class = "hljs-builtin-name" > enable< / span > < span class = "hljs-builtin-name" > DEBUG< / span > < span class = "hljs-built_in" > logging < / span > of all AutoReceiveMessages (Kill, PoisonPill etc.)
autoreceive= off
# < span class = "hljs-builtin-name" > enable< / span > function of LoggingReceive, which is < span class = "hljs-keyword" > to< / span > log any received message at
# < span class = "hljs-builtin-name" > DEBUG< / span > level
receive = on
# < span class = "hljs-builtin-name" > enable< / span > < span class = "hljs-builtin-name" > DEBUG< / span > < span class = "hljs-built_in" > logging < / span > of unhandled messages
unhandled = off
# < span class = "hljs-builtin-name" > enable< / span > < span class = "hljs-builtin-name" > DEBUG< / span > < span class = "hljs-built_in" > logging < / span > of actor lifecycle changes
lifecycle = off
< span class = "hljs-attribute" > event-stream< / span > =off
2020-03-19 12:41:03 +00:00
}
}
}
< / code > < / pre >
2022-01-04 15:29:38 +00:00
< / span > < / div > < / article > < / div > < div class = "docLastUpdate" > < em > Last updated on 4/8/2020 by Ben Carman< / em > < / div > < div class = "docs-prevnext" > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < 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 > < / 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 © 2022 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-12-16 12:03:51 +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 >
