mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2025-03-19 21:45:36 +01:00
305 lines
No EOL
30 KiB
HTML
305 lines
No EOL
30 KiB
HTML
<!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"/><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>
|
||
(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');
|
||
</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="/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></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></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></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 Generation</a></li><li class="navListItem"><a class="navItem" href="/docs/next/core/adding-spks">Adding New Script Types</a></li><li class="navListItem"><a class="navItem" href="/docs/next/core/spending-info">Signing Transactions</a></li><li class="navListItem"><a class="navItem" href="/docs/next/core/psbts">Partially Signed Bitcoin Transactions</a></li><li class="navListItem"><a class="navItem" href="/docs/next/core/txbuilder">TxBuilder Example</a></li><li class="navListItem"><a class="navItem" href="/docs/next/core/lightning-network">Lightning Network Data Types</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Crypto Module</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/crypto/crypto-intro">Crypto Module</a></li><li class="navListItem"><a class="navItem" href="/docs/next/crypto/sign">Sign API</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Fee Provider</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/fee-provider/fee-provider">Fee Provider</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Key Manager</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/key-manager/key-manager">Key Manager</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Node</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/node/node">Light Client</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Wallet</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/wallet/wallet">Wallet</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/wallet-callbacks">Wallet Callbacks</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/wallet-get-address">Wallet Get Address APIs</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/address-tagging">Address and UTXO tagging</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/chain-query-api">Chain Query API</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/node-api">Node API</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/dlc">Executing A DLC with Bitcoin-S</a></li><li class="navListItem"><a class="navItem" href="/docs/next/wallet/wallet-rescan">Wallet Rescans</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">RPC Clients</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/rpc/rpc-clients-intro">Introduction</a></li><li class="navListItem"><a class="navItem" href="/docs/next/rpc/rpc-eclair">Eclair</a></li><li class="navListItem"><a class="navItem" href="/docs/next/rpc/rpc-bitcoind">bitcoind/Bitcoin Core</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Secp256k1</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/secp256k1/secp256k1">Secp256k1</a></li><li class="navListItem"><a class="navItem" href="/docs/next/secp256k1/jni-modify">Adding to Secp256k1 JNI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Testkit</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/testkit/testkit">Testkit</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Contributing</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/contributing">Contributing</a></li><li class="navListItem"><a class="navItem" href="/docs/next/contributing-website">Contributing to the website</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/security">Security</a></li></ul></div></div></section></div><script>
|
||
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>
|
||
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-keyword">import</span> scala.concurrent.<span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global
|
||
|
||
<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-literal">false</span>)
|
||
|
||
|
||
<span class="hljs-comment">// reads a custom data directory</span>
|
||
<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>)
|
||
<span class="hljs-keyword">val</span> configFromCustomDatadir = <span class="hljs-type">WalletAppConfig</span>(customDirectory, <span class="hljs-literal">false</span>)
|
||
|
||
<span class="hljs-comment">// reads a custom data directory and overrides the network to be testnet3</span>
|
||
<span class="hljs-keyword">val</span> customOverride = <span class="hljs-type">ConfigFactory</span>.parseString(<span class="hljs-string">"bitcoin-s.network = testnet3"</span>)
|
||
<span class="hljs-keyword">val</span> configFromCustomDirAndOverride = <span class="hljs-type">WalletAppConfig</span>(customDirectory, <span class="hljs-literal">false</span>, 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>
|
||
<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 {
|
||
datadir = <span class="hljs-variable">${HOME}</span>/.bitcoin-s
|
||
<span class="hljs-built_in"> network </span>= regtest # regtest, testnet3, mainnet
|
||
|
||
<span class="hljs-built_in"> logging </span>{
|
||
# Ignore bitcoin-s<span class="hljs-built_in"> logging config </span><span class="hljs-keyword">and</span> use a logback<span class="hljs-built_in"> config
|
||
</span> logback = <span class="hljs-literal">false</span>
|
||
|
||
level = WARN # trace, debug, info, warn, error, off
|
||
|
||
# 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:
|
||
|
||
#<span class="hljs-built_in"> incoming </span><span class="hljs-keyword">and</span> outgoing P2P messages
|
||
# p2p = <span class="hljs-builtin-name">info</span>
|
||
|
||
# verification of block headers, merkle trees
|
||
# chain-verification = <span class="hljs-builtin-name">info</span>
|
||
|
||
# generation of addresses, signing of TXs
|
||
# key-handling = <span class="hljs-builtin-name">info</span>
|
||
|
||
# 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>
|
||
|
||
# HTTP RPC<span class="hljs-built_in"> server
|
||
</span> # http = <span class="hljs-builtin-name">info</span>
|
||
|
||
# Database interactions
|
||
# database = <span class="hljs-builtin-name">info</span>
|
||
|
||
# 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>
|
||
|
||
# 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>
|
||
}
|
||
|
||
node {
|
||
mode = neutrino # neutrino, spv
|
||
|
||
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.
|
||
}
|
||
|
||
chain {
|
||
neutrino {
|
||
filter-header-batch-size = 2000
|
||
filter-header-batch-size.regtest = 10
|
||
# You can <span class="hljs-builtin-name">set</span> a<span class="hljs-built_in"> network </span>specific filter-header-batch-size
|
||
# by adding a trailing `.networkId` (main, test, regtest)
|
||
# It is recommended <span class="hljs-keyword">to</span> keep the main <span class="hljs-keyword">and</span> test batch size high
|
||
# <span class="hljs-keyword">to</span> keep the sync time fast, however, <span class="hljs-keyword">for</span> regtest it should be small
|
||
# so it does <span class="hljs-keyword">not</span> exceed the chain size.
|
||
|
||
filter-batch-size = 100
|
||
}
|
||
}
|
||
|
||
#<span class="hljs-built_in"> settings </span><span class="hljs-keyword">for</span> wallet module
|
||
wallet {
|
||
defaultAccountType = legacy # legacy, segwit, nested-segwit
|
||
|
||
bloomFalsePositiveRate = 0.0001 # percentage
|
||
|
||
addressGapLimit = 20
|
||
|
||
discoveryBatchSize = 100
|
||
|
||
requiredConfirmations = 6
|
||
|
||
# How big the<span class="hljs-built_in"> address queue </span>size is before we throw an exception
|
||
# because of an overflow
|
||
addressQueueSize = 10
|
||
|
||
# How long we attempt <span class="hljs-keyword">to</span> generate an<span class="hljs-built_in"> address </span><span class="hljs-keyword">for</span>
|
||
# before we timeout
|
||
addressQueueTimeout = 5 seconds
|
||
|
||
}
|
||
|
||
<span class="hljs-built_in"> server </span>{
|
||
# The<span class="hljs-built_in"> port </span>we bind our rpc<span class="hljs-built_in"> server </span>on
|
||
rpcport = 9999
|
||
}
|
||
}
|
||
|
||
|
||
akka {
|
||
loglevel = <span class="hljs-string">"OFF"</span>
|
||
stdout-loglevel = <span class="hljs-string">"OFF"</span>
|
||
http {
|
||
<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.
|
||
|
||
# some requests potentially take a long time, like generate <span class="hljs-keyword">and</span> prune
|
||
idle-timeout = 5 minutes
|
||
}
|
||
}
|
||
|
||
|
||
actor {
|
||
<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
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<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>
|
||
<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>
|
||
<pre><code class="hljs css language-$xslt">bitcoin-s {
|
||
common {
|
||
<span class="hljs-built_in"> profile </span>= <span class="hljs-string">"slick.jdbc.PostgresProfile$"</span>
|
||
db {
|
||
url = <span class="hljs-string">"jdbc:postgresql://localhost:5432/database"</span>
|
||
driver = <span class="hljs-string">"org.postgresql.Driver"</span>
|
||
username = <span class="hljs-string">"user"</span>
|
||
password = <span class="hljs-string">"topsecret"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<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>
|
||
<pre><code class="hljs css language-$xslt">bitcoin-s {
|
||
chain {
|
||
<span class="hljs-built_in"> profile </span>= <span class="hljs-string">"slick.jdbc.PostgresProfile$"</span>
|
||
db {
|
||
url = <span class="hljs-string">"jdbc:postgresql://localhost:5432/chaindb"</span>
|
||
driver = <span class="hljs-string">"org.postgresql.Driver"</span>
|
||
username = <span class="hljs-string">"user"</span>
|
||
password = <span class="hljs-string">"topsecret"</span>
|
||
}
|
||
}
|
||
wallet {
|
||
<span class="hljs-built_in"> profile </span>= <span class="hljs-string">"slick.jdbc.PostgresProfile$"</span>
|
||
db {
|
||
url = <span class="hljs-string">"jdbc:postgresql://localhost:5432/walletdb"</span>
|
||
driver = <span class="hljs-string">"org.postgresql.Driver"</span>
|
||
username = <span class="hljs-string">"user"</span>
|
||
password = <span class="hljs-string">"topsecret"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/chain/filter-sync"><span class="arrow-prev">← </span><span>Syncing Blockfilters</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="#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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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>
|
||
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> |