2021-04-21 12:50:07 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Application Server · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "## App server" / > < meta name = "docsearch:version" content = "next" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Application Server · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "## App server" / > < 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-03-16 14:17:59 +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 > Applications< / 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 > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/ui-setup" > Installing the DLC Wallet UI< / 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 navListItemActive" > < 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" > < 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" > Genera
2019-12-16 12:03:51 +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);
};
}
});
2021-02-20 11:44:14 +00:00
< / 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/applications/server.md" target = "_blank" rel = "noreferrer noopener" > Edit< / a > < h1 id = "__docusaurus" class = "postHeaderTitle" > Application Server< / h1 > < / header > < article > < div > < span > < h2 > < a class = "anchor" aria-hidden = "true" id = "app-server" > < / a > < a href = "#app-server" 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 > App server< / h2 >
2020-08-27 19:49:50 +00:00
< p > The server project is the aggregation of these three sub projects< / p >
2019-12-04 13:32:15 +00:00
< ol >
2020-03-13 15:02:35 +00:00
< li > < a href = "/docs/next/wallet/wallet" > Wallet< / a > < / li >
< li > < a href = "/docs/next/chain/chain" > Chain< / a > < / li >
2020-03-15 21:19:52 +00:00
< li > < a href = "/docs/next/node/node" > Node< / a > < / li >
2019-12-04 13:32:15 +00:00
< / ol >
< p > The server project provides a away to access information from these three projects via a JSON RPC.< / p >
2021-02-20 11:44:14 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "building-the-server" > < / a > < a href = "#building-the-server" 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 > Building the server< / h2 >
< h3 > < a class = "anchor" aria-hidden = "true" id = "java-binary" > < / a > < a href = "#java-binary" 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 > Java binary< / h3 >
2019-12-04 13:32:15 +00:00
< p > You can build the server with the < a href = "https://github.com/sbt/sbt-native-packager" > sbt native packager< / a > .
The native packager offers < a href = "https://github.com/sbt/sbt-native-packager#examples" > numerous ways to package the project< / a > .< / p >
2020-08-13 17:04:31 +00:00
< p > In this example we are going to use < code > stage< / code > which will produce bash scripts we can easily execute. You can stage the server with the following command.< / p >
2020-10-13 20:57:52 +00:00
< pre > < code class = "hljs css language-bash" > sbt appServer/universal:stage
2019-12-04 13:32:15 +00:00
< / code > < / pre >
< p > This will produce a script to execute bitcoin-s which you can start with< / p >
2021-02-02 13:37:52 +00:00
< pre > < code class = "hljs css language-bash" > ./app/server/target/universal/stage/bin/bitcoin< span class = "hljs-_" > -s< / span > -server
2019-12-04 13:32:15 +00:00
< / code > < / pre >
2021-02-20 11:44:14 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "docker" > < / a > < a href = "#docker" 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 > Docker< / h3 >
2021-02-19 16:35:51 +00:00
< p > The oracle server also has docker support. You can build a docker image with the following commands< / p >
2021-02-20 11:44:14 +00:00
< h4 > < a class = "anchor" aria-hidden = "true" id = "using-an-existing-docker-image" > < / a > < a href = "#using-an-existing-docker-image" 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 > Using an existing docker image< / h4 >
< p > We publish docker images on every PR that is merged to bitcoin-s.< / p >
< p > You can find the docker repo for the app server < a href = "https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated" > here< / a > < / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "building-a-docker-image" > < / a > < a href = "#building-a-docker-image" 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 > Building a docker image< / h4 >
2021-02-19 16:35:51 +00:00
< pre > < code class = "hljs" > < span class = "hljs-keyword" > sbt < / span > < span class = "hljs-string" > "appServer/docker:stage"< / span >
< / code > < / pre >
< p > This will build a < code > Dockerfile< / code > that is located in < code > app/server/target/docker/stage< / code > < / p >
< p > You can now build the docker image with< / p >
2022-03-29 13:35:36 +00:00
< pre > < code class = "hljs" > docker build app< span class = "hljs-regexp" > /server/< / span > target< span class = "hljs-regexp" > /docker/< / span > stage< span class = "hljs-regexp" > / -t bitcoinscala/< / span > bitcoin-s-< span class = "hljs-string" > server:< / span > latest
2021-02-19 16:35:51 +00:00
< / code > < / pre >
< p > Finally, let's run the image! It's important that you correctly configure port forwarding with the docker container so
you can interact with the running container with < code > bitcoin-s-cli< / code > or < code > curl< / code > . By default, our oracle
2022-01-12 20:48:55 +00:00
server listens for requests on port < code > 9999< / code > . By default, the server listens for websocket connections on port < code > 19999< / code > at < code > /events< / code > .< / p >
2021-02-19 16:35:51 +00:00
< p > This means we need to forward requests on the host machine to the docker container correctly.< / p >
< p > This can be done with the following command< / p >
2022-04-21 11:48:03 +00:00
< pre > < code class = "hljs" > docker run -d -p < span class = "hljs-number" > 9999< / span > :< span class = "hljs-number" > 9999< / span > -p < span class = "hljs-number" > 19999< / span > :< span class = "hljs-number" > 19999< / span > -e BITCOIN_S_SERVER_RPC_PASSWORD=< span class = "hljs-string" > 'topsecret'< / span > bitcoinscala/bitcoin-s-server:latest
2021-02-19 16:35:51 +00:00
< / code > < / pre >
< p > Now you can send requests with < code > bitcoin-s-cli< / code > or < code > curl< / code > .
Here is an example with < code > bitcoin-s-cli< / code > < / p >
2022-04-21 11:48:03 +00:00
< pre > < code class = "hljs" > < span class = "hljs-string" > ./bitcoin-s-cli< / span > getblockcount < span class = "hljs-params" > --password< / span > topsecret
10000
2021-02-19 16:35:51 +00:00
< / code > < / pre >
< p > For more information on build configuration options with < code > sbt< / code > please see the < a href = "https://sbt-native-packager.readthedocs.io/en/latest/formats/docker.html#tasks" > sbt native packager docs< / a > < / p >
2021-02-20 11:44:14 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "configuration" > < / a > < a href = "#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 > Configuration< / h2 >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "java-binary-configuration" > < / a > < a href = "#java-binary-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 > Java binary configuration< / h3 >
2020-02-24 16:14:47 +00:00
< p > If you would like to pass in a custom datadir for your server, you can do< / p >
2021-02-02 13:37:52 +00:00
< pre > < code class = "hljs css language-bash" > ./app/server/target/universal/stage/bin/bitcoin< span class = "hljs-_" > -s< / span > -server --datadir /path/to/datadir/
2020-02-24 16:14:47 +00:00
< / code > < / pre >
2020-08-13 17:04:31 +00:00
< p > To use a config file that is not the < code > bitcoin-s.conf< / code > file in your datadir, you can do< / p >
2021-02-02 13:37:52 +00:00
< pre > < code class = "hljs css language-bash" > ./app/server/target/universal/stage/bin/bitcoin< span class = "hljs-_" > -s< / span > -server --conf /path/to/file.conf
2020-08-13 17:04:31 +00:00
< / code > < / pre >
2020-05-05 12:03:45 +00:00
< p > You can also pass in a custom < code > rpcport< / code > to bind to< / p >
2021-02-02 13:37:52 +00:00
< pre > < code class = "hljs css language-bash" > ./app/server/target/universal/stage/bin/bitcoin< span class = "hljs-_" > -s< / span > -server --rpcport 12345
2020-05-05 12:03:45 +00:00
< / code > < / pre >
2022-01-12 20:48:55 +00:00
< p > Or set a custom < code > wsport< / code > to bind to< / p >
< pre > < code class = "hljs css language-bash" > ./app/server/target/universal/stage/bin/bitcoin< span class = "hljs-_" > -s< / span > -server --wsport 54321
< / code > < / pre >
2021-05-26 19:29:17 +00:00
< p > For more information on configuring the server please see our < a href = "/docs/next/config/configuration" > configuration< / a > document< / p >
2019-12-04 13:32:15 +00:00
< p > For more information on how to use our built in < code > cli< / code > to interact with the server please see < a href = "/docs/next/applications/cli" > /docs/next/applications/cli< / a > < / p >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "docker-configuration" > < / a > < a href = "#docker-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 > Docker configuration< / h3 >
2021-03-05 13:53:22 +00:00
< p > In this example, we are using the latest docker image published to our < a href = "https://hub.docker.com/repository/docker/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated" > docker hub< / a >
which is referenced by < code > bitcoinscala/bitcoin-s-server:latest< / code > < / p >
2021-02-26 16:03:42 +00:00
< p > You can use bitcoin-s with docker volumes. You can also pass in a custom configuration at container runtime.< / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "using-a-docker-volume" > < / a > < a href = "#using-a-docker-volume" 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 > Using a docker volume< / h4 >
< pre > < code class = "hljs css language-basrc" > docker < span class = "hljs-keyword" > volume< / span > < span class = "bash" > create bitcoin< span class = "hljs-_" > -s< / span > < / span >
2022-01-12 20:48:55 +00:00
docker < span class = "hljs-keyword" > run< / span > < span class = "bash" > -p 9999:9999 -p 19999:19999 \
2021-03-05 13:53:22 +00:00
--mount < span class = "hljs-built_in" > source< / span > =bitcoin< span class = "hljs-_" > -s< / span > ,target=/home/bitcoin< span class = "hljs-_" > -s< / span > / bitcoinscala/bitcoin< span class = "hljs-_" > -s< / span > -server:latest< / span >
2021-02-26 16:03:42 +00:00
< / code > < / pre >
< p > Now you can re-use this volume across container runs. It will keep the same oracle database
and seeds directory located at < code > /home/bitcoin-s/.bitcoin-s/seeds< / code > in the volume.< / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "using-a-custom-bitcoin-s-configuration-with-docker" > < / a > < a href = "#using-a-custom-bitcoin-s-configuration-with-docker" 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 > Using a custom bitcoin-s configuration with docker< / h4 >
< p > You can also specify a custom bitcoin-s configuration at container runtime.
You can mount the configuration file on the docker container and that
configuration will be used in the docker container runtime rather than
the default one we provide < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/master/app/oracle-server/src/universal/docker-application.conf" > here< / a > < / p >
< p > You can do this with the following command< / p >
2022-01-12 20:48:55 +00:00
< pre > < code class = "hljs css language-bashrc" > docker run -p < span class = "hljs-number" > 9999< / span > :< span class = "hljs-number" > 9999< / span > -p < span class = "hljs-number" > 19999< / span > :< span class = "hljs-number" > 19999< / span > \
2021-02-26 16:03:42 +00:00
--mount type=< span class = "hljs-keyword" > bind< / span > ,source=< span class = "hljs-regexp" > /my/new< / span > < span class = "hljs-regexp" > /config/< / span > ,target=< span class = "hljs-regexp" > /home/bitcoin< / span > -< span class = "hljs-regexp" > s/.bitcoin-s/ \
2021-03-05 13:53:22 +00:00
bitcoinscala/bitcoin< / span > -< span class = "hljs-keyword" > s< / span > -server:latest --conf /home/bitcoin-< span class = "hljs-keyword" > s< / span > /.bitcoin-< span class = "hljs-keyword" > s< / span > /bitcoin-s.conf
2021-02-26 16:03:42 +00:00
< / code > < / pre >
< p > Note: If you adjust the < code > bitcoin-s.server.rpcport< / code > setting you will need to adjust
the < code > -p 9999:9999< / code > port mapping on the docker container to adjust for this.< / p >
< h2 > < a class = "anchor" aria-hidden = "true" id = "server-endpoints" > < / a > < a href = "#server-endpoints" 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 > Server Endpoints< / h2 >
2021-09-27 13:07:24 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "common" > < / a > < a href = "#common" 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 > Common< / h3 >
< ul >
< li > < code > getversion< / code > - The version of our application you are using< / li >
2021-12-20 14:58:58 +00:00
< li > < code > zipdatadir< / code > < code > location< / code > - Backs up the datadir in a safe and consistent manner.
< ul >
< li > < code > location< / code > - The locations of the backup zip< / li >
< / ul > < / li >
2021-09-27 13:07:24 +00:00
< / ul >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "blockchain" > < / a > < a href = "#blockchain" 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 > Blockchain< / h3 >
2020-06-08 12:26:22 +00:00
< ul >
< li > < code > getblockcount< / code > - Get the current block height< / li >
< li > < code > getfiltercount< / code > - Get the number of filters< / li >
< li > < code > getfilterheadercount< / code > - Get the number of filter headers< / li >
< li > < code > getbestblockhash< / code > - Get the best block hash< / li >
2021-03-22 18:24:59 +00:00
< li > < code > getblockheader< / code > - Returns information about block header < hash >
< ul >
< li > < code > hash< / code > - The block hash< / li >
< / ul > < / li >
2020-10-13 20:57:52 +00:00
< li > < code > decoderawtransaction< / code > < code > tx< / code > - < code > Decode the given raw hex transaction< / code >
< ul >
< li > < code > tx< / code > - Transaction encoded in hex to decode< / li >
< / ul > < / li >
2021-12-22 22:47:06 +00:00
< li > < code > getmediantimepast< / code > - Returns the median time past< / li >
2020-06-08 12:26:22 +00:00
< / ul >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "wallet" > < / a > < a href = "#wallet" 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 > Wallet< / h3 >
2020-06-08 12:26:22 +00:00
< ul >
< li > < code > rescan< / code > < code > [options]< / code > - Rescan for wallet UTXOs
< ul >
< li > < code > --force< / code > - Clears existing wallet records. Warning! Use with caution!< / li >
< li > < code > --batch-size < value> < / code > - Number of filters that can be matched in one batch< / li >
< li > < code > --start < value> < / code > - Start height< / li >
< li > < code > --end < value> < / code > - End height< / li >
< li > < code > --ignorecreationtime< / code > - Ignores the wallet creation date and will instead do a full rescan< / li >
< / ul > < / li >
< li > < code > isempty< / code > - Checks if the wallet contains any data< / li >
2021-02-02 13:37:52 +00:00
< li > < code > walletinfo< / code > - Returns data about the current wallet being used< / li >
2020-06-08 12:26:22 +00:00
< li > < code > getbalance< / code > < code > [options]< / code > - Get the wallet balance
< ul >
< li > < code > --sats< / code > - Display balance in satoshis< / li >
< / ul > < / li >
< li > < code > getconfirmedbalance< / code > < code > [options]< / code > - Get the wallet balance of confirmed utxos
< ul >
< li > < code > --sats< / code > - Display balance in satoshis< / li >
< / ul > < / li >
< li > < code > getunconfirmedbalance< / code > < code > [options]< / code > - Get the wallet balance of unconfirmed utxos
< ul >
< li > < code > --sats< / code > - Display balance in satoshis< / li >
< / ul > < / li >
2021-05-04 21:50:41 +00:00
< li > < code > getbalances< / code > < code > [options]< / code > - Get the wallet balance by utxo state
< ul >
< li > < code > --sats< / code > - Display balance in satoshis< / li >
< / ul > < / li >
2020-06-08 12:26:22 +00:00
< li > < code > getutxos< / code > - Returns list of all wallet utxos< / li >
< li > < code > getaddresses< / code > - Returns list of all wallet addresses currently being watched< / li >
< li > < code > getspentaddresses< / code > - Returns list of all wallet addresses that have received funds and been spent< / li >
< li > < code > getfundedaddresses< / code > - Returns list of all wallet addresses that are holding funds< / li >
< li > < code > getunusedaddresses< / code > - Returns list of all wallet addresses that have not been used< / li >
< li > < code > getaccounts< / code > - Returns list of all wallet accounts< / li >
2021-02-02 13:37:52 +00:00
< li > < code > walletinfo< / code > - Returns meta information about the wallet< / li >
2020-06-08 12:26:22 +00:00
< li > < code > createnewaccount< / code > - Creates a new wallet account< / li >
< li > < code > getaddressinfo< / code > < code > address< / code > - Returns list of all wallet accounts
< ul >
< li > < code > address< / code > - Address to get information about< / li >
< / ul > < / li >
< li > < code > getnewaddress< / code > - Get a new address< / li >
2021-05-03 13:31:12 +00:00
< li > < code > listreservedutxos< / code > - lists all utxos that are reserved in the wallet< / li >
2020-06-08 12:26:22 +00:00
< li > < code > sendtoaddress< / code > < code > address< / code > < code > amount< / code > < code > [options]< / code > - Send money to the given address
< ul >
< li > < code > address< / code > - Address to send to< / li >
< li > < code > amount< / code > - Amount to send in BTC< / li >
< li > < code > --feerate < value> < / code > - Fee rate in sats per virtual byte< / li >
< / ul > < / li >
< li > < code > sendfromoutpoints< / code > < code > outpoints< / code > < code > address< / code > < code > amount< / code > < code > [options]< / code > - Send money to the given address
< ul >
< li > < code > outpoints< / code > - Out Points to send from< / li >
< li > < code > address< / code > - Address to send to< / li >
< li > < code > amount< / code > - Amount to send in BTC< / li >
< li > < code > --feerate < value> < / code > - Fee rate in sats per virtual byte< / li >
< / ul > < / li >
2021-06-16 19:58:19 +00:00
< li > < code > sweepwallet< / code > < code > address< / code > < code > [options]< / code > - Sends the entire wallet balance to the given address
< ul >
< li > < code > address< / code > - Address to send to< / li >
< li > < code > --feerate < value> < / code > - Fee rate in sats per virtual byte< / li >
< / ul > < / li >
2020-06-08 12:26:22 +00:00
< li > < code > sendwithalgo< / code > < code > address< / code > < code > amount< / code > < code > algo< / code > < code > [options]< / code > - Send money to the given address using a specific coin selection algo
< ul >
< li > < code > address< / code > - Address to send to< / li >
< li > < code > amount< / code > - Amount to send in BTC< / li >
< li > < code > algo< / code > - Coin selection algo< / li >
< li > < code > --feerate < value> < / code > - Fee rate in sats per virtual byte< / li >
< / ul > < / li >
2020-12-11 22:35:47 +00:00
< li > < code > signpsbt< / code > < code > psbt< / code > - Signs the PSBT's inputs with keys that are associated with the wallet
< ul >
< li > < code > psbt< / code > - PSBT to sign< / li >
< / ul > < / li >
2020-06-08 12:26:22 +00:00
< li > < code > opreturncommit< / code > < code > message< / code > < code > [options]< / code > - Creates OP_RETURN commitment transaction
< ul >
< li > < code > message< / code > - message to put into OP_RETURN commitment< / li >
< li > < code > --hashMessage< / code > - should the message be hashed before commitment< / li >
< li > < code > --feerate < value> < / code > - Fee rate in sats per virtual byte< / li >
< / ul > < / li >
2020-12-22 22:34:32 +00:00
< li > < code > bumpfeecpfp< / code > < code > txid< / code > < code > feerate< / code > - Bump the fee of the given transaction id with a child tx using the given fee rate
< ul >
< li > < code > txid< / code > - Id of transaction to bump fee< / li >
< li > < code > feerate< / code > - Fee rate in sats per virtual byte of the child transaction< / li >
< / ul > < / li >
< li > < code > bumpfeerbf< / code > < code > txid< / code > < code > feerate< / code > - Replace given transaction with one with the new fee rate
< ul >
< li > < code > txid< / code > - Id of transaction to bump fee< / li >
< li > < code > feerate< / code > - New fee rate in sats per virtual byte< / li >
< / ul > < / li >
2020-12-22 12:44:39 +00:00
< li > < code > gettransaction< / code > < code > txid< / code > - Get detailed information about in-wallet transaction < txid >
< ul >
< li > < code > txid< / code > - The transaction id< / li >
< / ul > < / li >
2020-09-29 22:14:01 +00:00
< li > < code > lockunspent< / code > < code > unlock< / code > < code > transactions< / code > - Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs.
< ul >
< li > < code > unlock< / code > - Whether to unlock (true) or lock (false) the specified transactions< / li >
2021-04-29 22:18:07 +00:00
< li > < code > transactions< / code > - The transaction outpoints to unlock/lock, empty to apply to all utxos< / li >
2020-09-29 22:14:01 +00:00
< / ul > < / li >
2020-12-22 12:44:39 +00:00
< li > < code > importseed< / code > < code > walletname< / code > < code > words< / code > < code > passphrase< / code > - Imports a mnemonic seed as a new seed file
< ul >
< li > < code > walletname< / code > - Name to associate with this seed< / li >
< li > < code > words< / code > - Mnemonic seed words, space separated< / li >
< li > < code > passphrase< / code > - Passphrase to encrypt this seed with< / li >
< / ul > < / li >
< li > < code > importxprv< / code > < code > walletname< / code > < code > xprv< / code > < code > passphrase< / code > - Imports a mnemonic seed as a new seed file
< ul >
< li > < code > walletname< / code > - Name to associate with this seed< / li >
< li > < code > xprv< / code > - base58 encoded extended private key< / li >
< li > < code > passphrase< / code > - Passphrase to encrypt this seed with< / li >
< / ul > < / li >
< li > < code > keymanagerpassphrasechange< / code > < code > oldpassphrase< / code > < code > newpassphrase< / code > - Changes the wallet passphrase
2020-12-11 22:35:47 +00:00
< ul >
< li > < code > oldpassphrase< / code > - The current passphrase< / li >
< li > < code > newpassphrase< / code > - The new passphrase< / li >
< / ul > < / li >
2020-12-22 12:44:39 +00:00
< li > < code > keymanagerpassphraseset< / code > < code > passphrase< / code > - Encrypts the wallet with the given passphrase
2020-12-11 22:35:47 +00:00
< ul >
< li > < code > passphrase< / code > - The passphrase to encrypt the wallet with< / li >
< / ul > < / li >
2020-06-08 12:26:22 +00:00
< / ul >
2021-09-02 13:44:28 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "dlc" > < / a > < a href = "#dlc" 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 > DLC< / h3 >
< ul >
2021-10-05 11:56:05 +00:00
< li > < code > createcontractinfo< / code > < code > announcement< / code > < code > totalCollateral< / code > < code > payouts< / code >
< ul >
< li > the announcement to build the contract info for< / li >
< li > the total amount of collateral in the DLC< / li >
2021-10-16 01:20:32 +00:00
< li > The payouts can be in two formats
< ol >
< li > < code > { " outcomes" : { " outcome0" : 0, " outcome1" : 1, ... }}< / code > . The number is the amount of sats paid to YOU for that outcome.< / li >
< li > < code > [{" outcome" :0," payout" :0," extraPrecision" :0," isEndpoint" :true}, {" outcome" :1," payout" :1," extraPrecision" :0," isEndpoint" :true}, ...]< / code > < / li >
< / ol > < / li >
2021-10-05 11:56:05 +00:00
< / ul > < / li >
2021-09-03 15:08:41 +00:00
< li > < code > decodecontractinfo< / code > < code > contractinfo< / code > - Decodes a contract info into json
< ul >
< li > < code > contractinfo< / code > - Hex encoded contract info< / li >
< / ul > < / li >
< li > < code > decodeoffer< / code > < code > offer< / code > - Decodes an offer message into json
< ul >
< li > < code > offer< / code > - Hex encoded dlc offer message< / li >
< / ul > < / li >
2021-12-01 20:00:31 +00:00
< li > < code > decodeaccept< / code > < code > accept< / code > - Decodes an accept message into json
< ul >
< li > < code > accept< / code > - Hex encoded dlc accept message< / li >
< / ul > < / li >
< li > < code > decodesign< / code > < code > sign< / code > - Decodes a sign message into json
< ul >
< li > < code > sign< / code > - Hex encoded dlc sign message< / li >
< / ul > < / li >
2021-09-03 15:08:41 +00:00
< li > < code > decodeannouncement< / code > < code > announcement< / code > - Decodes an oracle announcement message into json
< ul >
< li > < code > announcement< / code > - Hex encoded oracle announcement message< / li >
< / ul > < / li >
< li > < code > decodeattestments< / code > < code > attestments< / code > - Decodes an oracle attestments message into json
< ul >
< li > < code > attestments< / code > - Hex encoded oracle attestments message< / li >
< / ul > < / li >
2021-09-02 13:44:28 +00:00
< li > < code > getdlchostaddress< / code > - Returns the public listening address of the DLC Node< / li >
< li > < code > createdlcoffer< / code > < code > contractInfo< / code > < code > collateral< / code > < code > [feerate]< / code > < code > locktime< / code > < code > refundlocktime< / code > - Creates a DLC offer that another party can accept
< ul >
< li > < code > contractInfo< / code > - Hex encoded contractInfo message< / li >
< li > < code > collateral< / code > - Satoshis to fund your side of the DLC< / li >
< li > < code > feerate< / code > - Fee rate for both funding and closing transactions, in sats/vbytes< / li >
< li > < code > locktime< / code > - Locktime of the contract execution transactions< / li >
< li > < code > refundlocktime< / code > - Locktime of the refund transaction< / li >
< / ul > < / li >
< li > < code > acceptdlc< / code > < code > offer< / code > < code > peer< / code > - Accepts a DLC offer given from another party
< ul >
< li > < code > offer< / code > - Hex encoded dlc offer message< / li >
< li > < code > peer< / code > - Peer's network address< / li >
< / ul > < / li >
< li > < code > acceptdlcoffer< / code > < code > offer< / code > - Accepts a DLC offer given from another party
< ul >
< li > < code > offer< / code > - Hex encoded offer message< / li >
< / ul > < / li >
< li > < code > acceptdlcofferfromfile< / code > < code > path< / code > < code > [destination]< / code > - Accepts a DLC offer given from another party
< ul >
< li > < code > path< / code > - Path to dlc offer file< / li >
< li > < code > destination< / code > - Path to write dlc accept message< / li >
< / ul > < / li >
2022-04-21 18:27:52 +00:00
< li > < code > contact-add< / code > < code > alias< / code > < code > address< / code > < code > memo< / code >
< ul >
< li > < code > alias< / code > - alias for the address like a name< / li >
< li > < code > address< / code > - the tor address for the peer< / li >
< li > < code > memo< / code > - a memo for this contact< / li >
< / ul > < / li >
< li > < code > contacts-list< / code > - lists all contacts in the wallet< / li >
< li > < code > contact-remove< / code > < code > address< / code >
< ul >
< li > < code > address< / code > - the tor address for the peer to remove< / li >
< / ul > < / li >
2021-09-02 13:44:28 +00:00
< li > < code > signdlc< / code > < code > accept< / code > - Signs a DLC
< ul >
< li > < code > accept< / code > - Hex encoded dlc accept message< / li >
< / ul > < / li >
< li > < code > signdlcfromfile< / code > < code > path< / code > < code > [destination]< / code > - Signs a DLC
< ul >
< li > < code > path< / code > - Path to dlc accept file< / li >
< li > < code > destination< / code > - Path to write dlc sign message< / li >
< / ul > < / li >
< li > < code > adddlcsigs< / code > < code > sigs< / code > - Adds DLC Signatures into the database
< ul >
< li > < code > sigs< / code > - Hex encoded dlc sign message< / li >
< / ul > < / li >
< li > < code > adddlcsigsfromfile< / code > < code > path< / code > - Adds DLC Signatures into the database
< ul >
< li > < code > path< / code > - Path to dlc sign file< / li >
< / ul > < / li >
< li > < code > adddlcsigsandbroadcast< / code > < code > sigs< / code > - Adds DLC Signatures into the database and broadcasts the funding transaction
< ul >
< li > < code > sigs< / code > - Hex encoded dlc sign message< / li >
< / ul > < / li >
< li > < code > adddlcsigsandbroadcastfromfile< / code > < code > path< / code > - Adds DLC Signatures into the database and broadcasts the funding transaction
< ul >
< li > < code > path< / code > - Path to dlc sign file< / li >
< / ul > < / li >
< li > < code > getdlcfundingtx< / code > < code > contractId< / code > - Returns the Funding Tx corresponding to the DLC with the given contractId
< ul >
< li > < code > contractId< / code > - ContractId of the DLC< / li >
< / ul > < / li >
< li > < code > broadcastdlcfundingtx< / code > < code > contractId< / code > - Broadcasts the funding Tx corresponding to the DLC with the given contractId
< ul >
< li > < code > contractId< / code > - ContractId of the DLC< / li >
< / ul > < / li >
< li > < code > executedlc< / code > < code > contractId< / code > < code > oraclesigs< / code > < code > [options]< / code > - Executes the DLC with the given contractId
< ul >
< li > < code > contractId< / code > - ContractId of the DLC< / li >
< li > < code > oraclesigs< / code > - Array of oracle attestations< / li >
< li > < code > --noBroadcast< / code > - Gives full serialized transaction instead of broadcasting< / li >
< / ul > < / li >
< li > < code > executedlcrefund< / code > < code > contractId< / code > < code > [options]< / code > - Executes the Refund transaction for the given DLC
< ul >
< li > < code > contractId< / code > - ContractId of the DLC< / li >
< li > < code > --noBroadcast< / code > - Gives full serialized transaction instead of broadcasting< / li >
< / ul > < / li >
< li > < code > canceldlc< / code > < code > dlcId< / code > - Cancels a DLC and unreserves used utxos
< ul >
< li > < code > dlcId< / code > - Internal id of the DLC< / li >
< / ul > < / li >
< li > < code > getdlcs< / code > - Returns all dlcs in the wallet< / li >
< li > < code > getdlc< / code > < code > dlcId< / code > - Gets a specific dlc in the wallet
< ul >
< li > < code > dlcId< / code > - Internal id of the DLC< / li >
< / ul > < / li >
2022-03-04 03:46:26 +00:00
< li > < code > offer-add< / code > < code > offerTLV< / code > < code > peerAddress< / code > < code > message< / code > - Puts an incoming offer into the inbox
2022-02-28 20:50:27 +00:00
< ul >
< li > < code > offerTLV< / code > - Offer TLV< / li >
< li > < code > peer< / code > - Peer URI (optional)< / li >
< li > < code > message< / code > - Peer's message or note (optional)< / li >
< / ul > < / li >
2022-03-04 03:46:26 +00:00
< li > < code > " offer-remove< / code > < code > hash< / code > - Remove an incoming offer from inbox
2022-02-28 20:50:27 +00:00
< ul >
< li > < code > hash< / code > - Hash of the offer TLV< / li >
< / ul > < / li >
2022-03-04 03:46:26 +00:00
< li > < code > offer-send< / code > < code > offerOrTempContractId< / code > < code > peerAddress< / code > < code > message< / code > - Sends an offer to a peer. < code > offerOrTempContractId< / code > is either an offer TLV or a temporary contract ID.< / li >
2022-02-28 20:50:27 +00:00
< li > < code > offers-list< / code > - List all incoming offers from the inbox< / li >
2022-03-07 20:53:24 +00:00
< li > < code > getdlcoffer< / code > < code > tempContractId< / code > - Gets a DLC offer by temporary contract ID.< / li >
2022-03-09 22:02:34 +00:00
< li > < code > getaddresslabel< / code > < code > address< / code > - gets all labels for an address< / li >
< li > < code > getaddresslabels< / code > - returns all addresses with labels in the wallet< / li >
< li > < code > dropaddresslabel< / code > < code > address< / code > < code > label< / code > - drops the label for a given address< / li >
< li > < code > dropaddresslabels< / code > < code > address< / code > - drops all labels for the given address< / li >
2021-09-02 13:44:28 +00:00
< / ul >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "network" > < / a > < a href = "#network" 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 > Network< / h3 >
2020-06-08 12:26:22 +00:00
< ul >
< li > < code > getpeers< / code > - List the connected peers< / li >
< li > < code > stop< / code > - Request a graceful shutdown of Bitcoin-S< / li >
< li > < code > sendrawtransaction< / code > < code > tx< / code > < code > Broadcasts the raw transaction< / code >
< ul >
< li > < code > tx< / code > - Transaction serialized in hex< / li >
< / ul > < / li >
< / ul >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "psbt" > < / a > < a href = "#psbt" 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 > PSBT< / h3 >
2020-06-08 12:26:22 +00:00
< ul >
2020-12-11 22:35:47 +00:00
< li > < code > decodepsbt< / code > < code > psbt< / code > - Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.
< ul >
< li > < code > psbt< / code > - PSBT serialized in hex or base64 format< / li >
< / ul > < / li >
2020-06-08 12:26:22 +00:00
< li > < code > combinepsbts< / code > < code > psbts< / code > - Combines all the given PSBTs
< ul >
< li > < code > psbts< / code > - PSBTs serialized in hex or base64 format< / li >
< / ul > < / li >
< li > < code > joinpsbts< / code > < code > psbts< / code > - Combines all the given PSBTs
< ul >
< li > < code > psbts< / code > - PSBTs serialized in hex or base64 format< / li >
< / ul > < / li >
< li > < code > finalizepsbt< / code > < code > psbt< / code > - Finalizes the given PSBT if it can
< ul >
< li > < code > psbt< / code > - PSBT serialized in hex or base64 format< / li >
< / ul > < / li >
< li > < code > extractfrompsbt< / code > < code > psbt< / code > - Extracts a transaction from the given PSBT if it can
< ul >
< li > < code > psbt< / code > - PSBT serialized in hex or base64 format< / li >
< / ul > < / li >
< li > < code > converttopsbt< / code > < code > unsignedTx< / code > - Creates an empty psbt from the given transaction
< ul >
< li > < code > unsignedTx< / code > - serialized unsigned transaction in hex< / li >
< / ul > < / li >
< / ul >
2021-02-26 16:03:42 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "util" > < / a > < a href = "#util" 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 > Util< / h3 >
2021-02-02 13:37:52 +00:00
< ul >
< li > < code > createmultisig< / code > < code > nrequired< / code > < code > keys< / code > < code > [address_type]< / code > - Creates a multi-signature address with n signature of m keys required.
< ul >
< li > < code > nrequired< / code > - The number of required signatures out of the n keys.< / li >
< li > < code > keys< / code > - The hex-encoded public keys.< / li >
< li > < code > address_type< / code > -The address type to use. Options are " legacy" , " p2sh-segwit" , and " bech32" < / li >
< / ul > < / li >
2021-04-28 22:36:08 +00:00
< li > < code > estimatefee< / code > - Returns the recommended fee rate using the fee provider< / li >
2021-02-02 13:37:52 +00:00
< / ul >
2021-02-26 16:03:42 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "sign-psbt-with-wallet-example" > < / a > < a href = "#sign-psbt-with-wallet-example" 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 > Sign PSBT with Wallet Example< / h2 >
2020-12-11 22:35:47 +00:00
< p > Bitcoin-S CLI:< / p >
2022-02-12 14:42:12 +00:00
< pre > < code class = "hljs css language-bash" > bitcoin< span class = "hljs-_" > -s< / span > -cli signpsbt cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA
2020-12-11 22:35:47 +00:00
cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA
< / code > < / pre >
< p > CURL:< / p >
2022-02-12 14:42:12 +00:00
< pre > < code class = "hljs css language-bash" > curl --data-binary < span class = "hljs-string" > '{"jsonrpc": "1.0", "id": "curltest", "method": "signpsbt", "params": ["cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA"]}'< / span > -H < span class = "hljs-string" > "Content-Type: application/json"< / span > http://127.0.0.1:9999/
2021-02-02 13:37:52 +00:00
{< span class = "hljs-string" > "result"< / span > :< span class = "hljs-string" > "cHNidP8BAP0FAQIAAAABWUWxYiPKgdGfXcIxJ6MRDxEpUecw59Gk4NpROI5oukoBAAAAAAAAAAAEPttkvdwAAAAXqRSOVAp6Qe/u2hq74e/ThB8foBKn7IfZYMgGCAAAAADbmaQ2nwAAAEdRIQLpfVqyaL9Jb/IkveatNyVeONE8Q/6TzXAWosxLo9e21SECc5G3XiK7xKLlkBG7prMx7p0fMeQwMH5e9H10mBon39JSrtgtgjjLAQAAUGMhAn2YaZnv25I6d6vbb1kw6Xp5IToDrEzl/0VBIW21gHrTZwXg5jGdALJ1IQKyNpDNiOiN6lWpYethib04+XC9bpFXrdpec+xO3U5IM2is9ckf5AABAD0CAAAAAALuiOL0rRcAABYAFPnpLByQq1Gg3vwiP6qR8FmOOjwxvVllM08DAAALBfXJH+QAsXUAAK4AAAAAAQcBAAAAAAAA"< / span > ,< span class = "hljs-string" > "error"< / span > :null}
2020-12-11 22:35:47 +00:00
< / code > < / pre >
2021-12-25 17:40:25 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "websocket-endpoints" > < / a > < a href = "#websocket-endpoints" 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 > Websocket endpoints< / h2 >
< p > Bitcoin-s offers websocket endpoints. By default, the endpoint is < code > ws://localhost:1999/events< / code > < / p >
< p > You can configure where how the endpoints are configured inside your < code > bitcoin-s.conf< / code > < / p >
< pre > < code class = "hljs" > < span class = "hljs-attr" > bitcoin-s.server.wsbind< / span > =localhost
< span class = "hljs-attr" > bitcoin-s.server.wsport< / span > =< span class = "hljs-number" > 19999< / span >
< / code > < / pre >
< p > These events are implemented using our < a href = "/docs/next/wallet/wallet-callbacks#wallet-callbacks" > internal callback mechanism< / a > .< / p >
< p > An example event that is defined is our < code > blockprocess< / code > event.
Everytime our wallet processes a block, our wallet will notify you via websockets.
Here is an example payload< / p >
< p > The current types of events defined are< / p >
< ol >
< li > < code > txprocessed< / code > - when the wallet processes a transaction. Every transaction in a block will get relayed currently< / li >
< li > < code > reservedutxos< / code > - when the wallet reserves OR unreserves utxos< / li >
< li > < code > newaddress< / code > - when the wallet generates a new address< / li >
< li > < code > txbroadcast< / code > - when the wallet broadcasts a tx< / li >
< li > < code > blockprocessed< / code > - when the wallet processes a block< / li >
< / ol >
< pre > < code class = "hljs" > {< span class = "hljs-attr" > "type"< / span > :< span class = "hljs-string" > "blockprocessed"< / span > ,< span class = "hljs-attr" > "payload"< / span > :{< span class = "hljs-attr" > "raw"< / span > :< span class = "hljs-string" > "04e0ff2ffce8c3e866e367d305886a3f9d353e557524f61f9cf0c26c46000000000000001206d2e396387bff1c13cbe572d4646abae1ae405f4066ab5e6f5edd6d8f028008a8bb61ffff001af23dd47e"< / span > ,< span class = "hljs-attr" > "hash"< / span > :< span class = "hljs-string" > "00000000000000de21f23f6945f028d5ecb47863428f6e9e035ab2fb7a3ef356"< / span > ,< span class = "hljs-attr" > "confirmations"< / span > :< span class = "hljs-number" > 1< / span > ,< span class = "hljs-attr" > "height"< / span > :< span class = "hljs-number" > 2131641< / span > ,< span class = "hljs-attr" > "version"< / span > :< span class = "hljs-number" > 805298180< / span > ,< span class = "hljs-attr" > "versionHex"< / span > :< span class = "hljs-string" > "2fffe004"< / span > ,< span class = "hljs-attr" > "merkleroot"< / span > :< span class = "hljs-string" > "80028f6ddd5e6f5eab66405f40aee1ba6a64d472e5cb131cff7b3896e3d20612"< / span > ,< span class = "hljs-attr" > "time"< / span > :< span class = "hljs-number" > 1639688200< / span > ,< span class = "hljs-attr" > "mediantime"< / span > :< span class = "hljs-number" > 1639688200< / span > ,< span class = "hljs-attr" > "nonce"< / span > :< span class = "hljs-number" > 2127838706< / span > ,< span class = "hljs-attr" > "bits"< / span > :< span class = "hljs-string" > "1a00ffff"< / span > ,< span class = "hljs-attr" > "difficulty"< / span > :< span class = "hljs-number" > 1.6069135243303364E60< / span > ,< span class = "hljs-attr" > "chainwork"< / span > :< span class = "hljs-string" > "00000000000000000000000000000000000000000000062438437ddd009e698b"< / span > ,< span class = "hljs-attr" > "previousblockhash"< / span > :< span class = "hljs-string" > "00000000000000466cc2f09c1ff62475553e359d3f6a8805d367e366e8c3e8fc"< / span > ,< span class = "hljs-attr" > "nextblockhash"< / span > :< span class = "hljs-literal" > null< / span > }}
< / code > < / pre >
2022-01-04 15:29:38 +00:00
< / span > < / div > < / article > < / div > < div class = "docs-prevnext" > < a class = "docs-prev button" href = "/docs/next/applications/cli" > < span class = "arrow-prev" > ← < / span > < span > CLI< / span > < / a > < a class = "docs-next button" href = "/docs/next/applications/gui" > < span > GUI< / span > < span class = "arrow-next" > →< / span > < / a > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < li > < a href = "#app-server" > App server< / a > < / li > < li > < a href = "#building-the-server" > Building the server< / a > < ul class = "toc-headings" > < li > < a href = "#java-binary" > Java binary< / a > < / li > < li > < a href = "#docker" > Docker< / a > < / li > < / ul > < / li > < li > < a href = "#configuration" > Configuration< / a > < ul class = "toc-headings" > < li > < a href = "#java-binary-configuration" > Java binary configuration< / a > < / li > < li > < a href = "#docker-configuration" > Docker configuration< / a > < / li > < / ul > < / li > < li > < a href = "#server-endpoints" > Server Endpoints< / a > < ul class = "toc-headings" > < li > < a href = "#common" > Common< / a > < / li > < li > < a href = "#blockchain" > Blockchain< / a > < / li > < li > < a href = "#wallet" > Wallet< / a > < / li > < li > < a href = "#dlc" > DLC< / a > < / li > < li > < a href = "#network" > Network< / a > < / li > < li > < a href = "#psbt" > PSBT< / a > < / li > < li > < a href = "#util" > Util< / a > < / li > < / ul > < / li > < li > < a href = "#sign-psbt-with-wallet-example" > Sign PSBT with Wallet Example< / a > < / li > < li > < a href = "#websocket-endpoints" > Websocket endpoints< / 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-04 13:32:15 +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 >
