mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-19 13:35:17 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/docs/1.9.0/getting-setup.html

229 lines
35 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on 8cda343fd3c7f0dd62ffcf639534a53128af7cc3
2022-04-18 18:55:09 +00:00
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Getting Bitcoin-S installed on your machine · bitcoin-s</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="&gt; This documentation is intended for setting up development of bitcoin-s."/><meta name="docsearch:version" content="1.9.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Getting Bitcoin-S installed on your machine · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="&gt; This documentation is intended for setting up development of bitcoin-s."/><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>1.9.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/1.9.0/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>Getting Setup</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/1.9.0/getting-started">Intro and Getting Started</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/bips">Supported BIPs</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Setup</h3><ul class=""><li class="navListItem navListItemActive"><a class="navItem" href="/docs/1.9.0/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/1.9.0/applications/cli">CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/applications/server">Application Server</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/applications/gui">GUI</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/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/1.9.0/chain/chain">Blockchain Verification</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/chain/filter-sync">Syncing Blockfilters</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/chain/chain-query-api">Chain Query API</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Configuration</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.9.0/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/1.9.0/core/core-intro">Core Module</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/core/addresses">Generating Addresses</a></li><li class="navListItem"><a class="navItem" href="/docs/1.9.0/core/hd
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/getting-setup.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Getting Bitcoin-S installed on your machine</h1></header><article><div><span><blockquote>
<p>This documentation is intended for setting up development of bitcoin-s.
If you want to just install bitcoin-s rather than develop,
see <a href="/docs/1.9.0/getting-started">getting-started</a></p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="getting-setup-with-bitcoin-s"></a><a href="#getting-setup-with-bitcoin-s" 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>Getting Setup With Bitcoin-S</h2>
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<!-- END doctoc -->
<ul>
<li><a href="#step-1--developer-runtimes">Step 1: Developer Runtimes</a>
<ul>
<li><a href="#scala-java">Scala/Java</a></li>
<li><a href="#scalajs">Scala.js</a></li>
</ul></li>
<li><a href="#step-2--bitcoin-s-repository">Step 2: Bitcoin-S Repository</a>
<ul>
<li><a href="#optional--running-full-test-suite">Optional: Running full test suite</a></li>
</ul></li>
<li><a href="#step-3--configuration">Step 3: Configuration</a></li>
<li><a href="#step-4--building-the-server-and-setting-up-the-cli">Step 4: Building the Server and Setting Up the CLI</a></li>
<li><a href="#step-5--setting-up-a-bitcoin-s-node">Step 5: Setting Up A Bitcoin-S Node</a>
<ul>
<li><a href="#neutrino-node">Neutrino Node</a></li>
<li><a href="#bitcoind-backend">Bitcoind Backend</a></li>
</ul></li>
<li><a href="#step-6--optional---moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li>
</ul>
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<h2><a class="anchor" aria-hidden="true" id="step-1-developer-runtimes"></a><a href="#step-1-developer-runtimes" 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>Step 1: Developer Runtimes</h2>
<h3><a class="anchor" aria-hidden="true" id="scalajava"></a><a href="#scalajava" 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>Scala/Java</h3>
<p>To get started you will need Java, Scala, and some other nice tools installed, luckily the Scala team has an easy setup process!</p>
<p>Simply follow the instructions in <a href="https://www.scala-lang.org/2020/06/29/one-click-install.html">this short blog</a> to get started.</p>
<p>If you don't like <code>curl</code>, you can use OS specific package managers to install coursier <a href="https://get-coursier.io/docs/2.0.0-RC2/cli-overview.html#installation">here</a></p>
<blockquote>
<p>bitcoin-s requires java9+ for development environments. If you do not have java9+ installed, you will not be able to build bitcoin-s.
<a href="https://github.com/bitcoin-s/bitcoin-s/issues/3298">You will run into this error if you are on java8 or lower</a></p>
</blockquote>
<p>If you follow the coursier route, <a href="https://get-coursier.io/docs/2.0.0-RC6-15/cli-java.html">you can switch to a java11 version by running</a></p>
<blockquote>
<p>cs java --jvm adopt:11 --setup</p>
</blockquote>
<h3><a class="anchor" aria-hidden="true" id="scalajs"></a><a href="#scalajs" 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>Scala.js</h3>
<p>We support publishing of <a href="https://www.scala-js.org/">scala.js</a> artifacts.
This library will compile Scala source code into javascript artifacts.</p>
<p>To be able to run scala js tests, you need to have the Node.js installed.
You can install it from <a href="https://nodejs.org/en/">here</a></p>
<h2><a class="anchor" aria-hidden="true" id="step-2-bitcoin-s-repository"></a><a href="#step-2-bitcoin-s-repository" 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>Step 2: Bitcoin-S Repository</h2>
<p>Now, it is time to clone the <a href="https://github.com/bitcoin-s/bitcoin-s/">Bitcoin-S repository</a> by running</p>
<pre><code class="hljs css language-bashrc">git <span class="hljs-keyword">clone</span> <span class="hljs-title">--depth</span> <span class="hljs-number">500</span> --recursive git@github.com:bitcoin-s/bitcoin-s.git
</code></pre>
<p>or alternatively, if you do not have ssh setup with github, you can run</p>
<pre><code class="hljs css language-bashrc">git <span class="hljs-keyword">clone</span> <span class="hljs-title">--depth</span> <span class="hljs-number">500</span> --recursive https://github.com/bitcoin-s/bitcoin-s.git
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="optional-running-full-test-suite"></a><a href="#optional-running-full-test-suite" 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>Optional: Running full test suite</h4>
<p><details></p>
<blockquote>
<p>WARNING: This should not be done on low resource machines. Running the entire test suite requires at minimum of 4GB
of RAM on the machine you are running this on.</p>
</blockquote>
<p>To run the entire test suite, you need to download all bitcoind instances and eclair instances. This is needed for unit tests
or binding bitcoin-s to a bitcoind instance if you do not have locally running instances.</p>
<p>If you want to run the entire test suite you can run the following command.</p>
<pre><code class="hljs css language-bashrc">sbt <span class="hljs-built_in">test</span>
</code></pre>
<p></details></p>
<h2><a class="anchor" aria-hidden="true" id="step-3-configuration"></a><a href="#step-3-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>Step 3: Configuration</h2>
<p>Now that we have the bitcoin-s repo setup, we want to create our application configurations.</p>
<p>First, create a <code>$HOME/.bitcoin-s</code> directory via <code>mkdir</code> or an equivalent command.</p>
<p>Next, create a <code>bitcoin-s.conf</code> file in <code>$HOME/.bitcoin-s</code>. <a href="/docs/1.9.0/config/configuration#example-configuration-file">Here is an example configuration file</a>.</p>
<h2><a class="anchor" aria-hidden="true" id="step-4-building-the-server-and-setting-up-the-cli"></a><a href="#step-4-building-the-server-and-setting-up-the-cli" 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>Step 4: Building the Server and Setting Up the CLI</h2>
<p>We are finally ready to start running some programs! Follow the <a href="/docs/1.9.0/applications/server#building-the-server">instructions here</a> to build the server.</p>
<p>Then, follow <a href="/docs/1.9.0/applications/cli">these instructions</a> to setup the CLI.</p>
<h2><a class="anchor" aria-hidden="true" id="step-5-setting-up-a-bitcoin-s-node"></a><a href="#step-5-setting-up-a-bitcoin-s-node" 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>Step 5: Setting Up A Bitcoin-S Node</h2>
<p>There are 2 ways to use the bitcoin-s server. It can either be as a neutrino node or use bitcoind as a backend.
This can be configured by the configuration option <code>bitcoin-s.node.mode</code> choosing either <code>neutrino</code> or <code>bitcoind</code>.</p>
<h3><a class="anchor" aria-hidden="true" id="neutrino-node"></a><a href="#neutrino-node" 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>Neutrino Node</h3>
<p><details>
To use a neutrino server you need to be paired with a bitcoin node that can serve compact filters.
<a href="https://suredbits.com/">Suredbits</a> runs a mainnet and testnet node you can connect to them by setting your <code>peers</code> config option in the <code>$HOME/.bitcoin-s/bitcoin-s.conf</code> to:</p>
<p>Mainnet:</p>
<p><code>bitcoin-s.node.peers = [&quot;neutrino.suredbits.com:8333&quot;]</code></p>
<p>Testnet:</p>
<p><code>bitcoin-s.node.peers = [&quot;neutrino.testnet3.suredbits.com:18333&quot;]</code></p>
<p>If you would like to use your own node you can either use the bitcoind backend option or connect to your own compatible node.</p>
<p>After building your bitcoin-s server and properly configuring it to be in <code>neutrino</code> mode you can start your server with:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-meta-keyword">/app/</span>server<span class="hljs-meta-keyword">/target/</span>universal<span class="hljs-meta-keyword">/stage/</span>bin/bitcoin-s-server
</code></pre>
<p>and once this is done, you should be able to communicate with the server using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-meta-keyword">/app/</span>cli<span class="hljs-meta-keyword">/target/</span>universal<span class="hljs-meta-keyword">/stage/</span>bin/bitcoin-s-cli getnewaddress
</code></pre>
<p></details></p>
<h3><a class="anchor" aria-hidden="true" id="bitcoind-backend"></a><a href="#bitcoind-backend" 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>Bitcoind Backend</h3>
<p><details>
We recommend creating a directory someplace in which to run your <code>bitcoind</code> node. Once you have this directory created, add the following <code>bitcoin.conf</code> file to it:</p>
<pre><code class="hljs"><span class="hljs-attr">regtest</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">server</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">rpcuser</span>=[your username here]
<span class="hljs-attr">rpcpassword</span>=[your password here]
<span class="hljs-attr">daemon</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">blockfilterindex</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">peerblockfilters</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">debug</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">txindex</span>=<span class="hljs-number">1</span>
</code></pre>
<p>If you already have a bitcoind node running and would like to connect your bitcoin-s server to it you can set your node's mode to <code>bitcoind</code>.</p>
<p>You will need to configure bitcoin-s to be able to find your bitcoind.
If you would only like bitcoin-s to connect to bitcoind and start it itself then you only need to properly set the <code>rpcuser</code>, and <code>rpcpassword</code> options.
If you would like bitcoin-s to launch bitcoind on start up you will need to set the other configuration options.
These options should default to use the latest bitcoind downloaded from <code>sbt downloadBitcoind</code>.</p>
<pre><code class="hljs css language-$xslt">bitcoin-s {
bitcoind-rpc {
# bitcoind rpc username
rpcuser =<span class="hljs-built_in"> user
</span> # bitcoind rpc password
rpcpassword = password
# Binary location of bitcoind
binary = <span class="hljs-variable">${HOME}</span>/.bitcoin-s/binaries/bitcoind/bitcoin-0.20.1/bin/bitcoind
# bitcoind datadir
datadir = <span class="hljs-variable">${HOME}</span>/.bitcoin
# bitcoind<span class="hljs-built_in"> network </span>host
connect = localhost
# bitcoind p2p<span class="hljs-built_in"> port
</span> <span class="hljs-built_in"> port </span>= 8333
# bitcoind rpc host
rpcconnect = localhost
# bitcoind rpc<span class="hljs-built_in"> port
</span> rpcport = 8332
}
}
</code></pre>
<p></details></p>
<h2><a class="anchor" aria-hidden="true" id="step-6-optional-moving-to-testnet"></a><a href="#step-6-optional-moving-to-testnet" 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>Step 6 (Optional): Moving To Testnet</h2>
<p>To run your Bitcoin-S Server on testnet, simply change <code>network = testnet3</code> and change
your <code>bitcoin-s.node.peers = [&quot;neutrino.testnet3.suredbits.com:18333&quot;]</code> in your <code>$HOME/.bitcoin-s/bitcoin-s.conf</code> file.
This will allow you to connect to Suredbits' neutrino-enabled <code>bitcoind</code> node.
Keep in mind then when you restart your server, it will begin initial sync which will take
many hours as all block filters for all testnet blocks will be downloaded.
If you wish to speed this process up,
download <a href="https://s3-us-west-2.amazonaws.com/www.suredbits.com/chaindb-testnet-2021-02-03.zip">this snapshot</a>, unzip it and put the file in your <code>$HOME/.bitcoin-s/testnet3</code> directory and then from there, run</p>
<p>This will start syncing your testnet node from block header ~1,900,000 rather than starting from zero.</p>
<pre><code class="hljs css language-bashrc">$ unzip chaindb-testnet<span class="hljs-number">-2021</span><span class="hljs-number">-02</span><span class="hljs-number">-03.</span>zip
$ mv chaindb.sqlite ~/.bitcoin-s/testnet3/
</code></pre>
<p>This should take a couple minutes to execute, but once it is done, you will only have a short while left to sync once you start your server.</p>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/12/2022 by Chris Stewart</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/1.9.0/bips"><span class="arrow-prev">← </span><span>Supported BIPs</span></a><a class="docs-next button" href="/docs/1.9.0/applications/cli"><span>CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-setup-with-bitcoin-s">Getting Setup With Bitcoin-S</a></li><li><a href="#step-1-developer-runtimes">Step 1: Developer Runtimes</a><ul class="toc-headings"><li><a href="#scalajava">Scala/Java</a></li><li><a href="#scalajs">Scala.js</a></li></ul></li><li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li><li><a href="#step-3-configuration">Step 3: Configuration</a></li><li><a href="#step-4-building-the-server-and-setting-up-the-cli">Step 4: Building the Server and Setting Up the CLI</a></li><li><a href="#step-5-setting-up-a-bitcoin-s-node">Step 5: Setting Up A Bitcoin-S Node</a><ul class="toc-headings"><li><a href="#neutrino-node">Neutrino Node</a></li><li><a href="#bitcoind-backend">Bitcoind Backend</a></li></ul></li><li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</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 &amp; 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>
Reference in a new issue Copy permalink