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 > Intro and Getting Started · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "## Philosophy" / > < meta name = "docsearch:version" content = "next" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Intro and Getting Started · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "## Philosophy" / > < 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');
2023-11-22 16:47:32 +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 > Getting Started< / 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 navListItemActive" > < 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" > < 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" > Gen
2019-06-20 14:53:06 +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');
2019-12-13 15:35:21 -06:00
var headings = document.querySelector('.toc-headings');
2019-06-20 14:53:06 +00:00
headings & & headings.addEventListener('click', function(event) {
2019-12-13 15:35:21 -06:00
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
2019-06-20 14:53:06 +00:00
}
}, 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);
};
}
});
2020-03-18 15:20:07 +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/getting-started.md" target = "_blank" rel = "noreferrer noopener" > Edit< / a > < h1 id = "__docusaurus" class = "postHeaderTitle" > Intro and Getting Started< / h1 > < / header > < article > < div > < span > < h2 > < a class = "anchor" aria-hidden = "true" id = "philosophy" > < / a > < a href = "#philosophy" 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 > Philosophy< / h2 >
< p > Bitcoin-S is a loosely coupled set of cryptocurrency libraries for the JVM. They work well together, but also can be used
independently. This project's goal is NOT to be a full node implementation, rather a set of scalable cryptocurrency libraries
that use industry standard tools (rather than esoteric tech often found in cryptocurrency) where possible to make the lives of professional
software engineers, security engineers, devops engineers and accountants easier.
We are rapidly iterating on development with the goal of getting to a set of stable APIs that only change when the underlying bitcoin protocol changes.< / p >
< p > If you are a professional working a cryptocurrency business and
2020-06-17 14:02:56 +00:00
have feedback on how to make your lives easier, please reach out on < a href = "https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" > slack< / a > ,
2020-03-18 15:20:07 +00:00
< a href = "https://gitter.im/bitcoin-s-core/" > gitter< / a > or < a href = "https://twitter.com/Chris_Stewart_5/" > twitter< / a > !< / p >
2021-02-20 11:44:14 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "getting-prebuilt-artifacts" > < / a > < a href = "#getting-prebuilt-artifacts" 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 prebuilt artifacts< / h2 >
2021-03-05 13:53:22 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "java-binaries" > < / a > < a href = "#java-binaries" 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 binaries< / h3 >
2021-06-21 11:41:01 +00:00
< p > < details > < / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "latest-release" > < / a > < a href = "#latest-release" 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 > Latest release< / h4 >
< p > Please see the release page on github, you can find it < a href = "https://github.com/bitcoin-s/bitcoin-s/releases" > here< / a > < / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "master-builds" > < / a > < a href = "#master-builds" 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 > Master builds< / h4 >
< p > We build installers for mac, linux and windows everytime a PR is merged to master.< / p >
< p > You can find the latest builds at this link:< / p >
< p > < a href = "https://github.com/bitcoin-s/bitcoin-s/actions/workflows/release.yml" > https://github.com/bitcoin-s/bitcoin-s/actions/workflows/release.yml< / a > < / p >
< p > Here is what the installers look like< / p >
2021-07-06 16:15:27 +00:00
< p > < img src = "/img/doc-imgs/github-artifacts.png" alt = "installers" > < / p >
2021-04-21 12:50:07 +00:00
< p > < / details > < / p >
2021-03-05 13:53:22 +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-04-21 12:50:07 +00:00
< p > < details >
We publish docker images to docker hub on every PR merge and tag on github.
2021-03-05 13:53:22 +00:00
You can obtain the images for both the app server and oracle server on these
docker hub repos< / p >
< p > < a href = "https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated" > bitcoin-s-server docker hub repo< / a > < / p >
2021-04-21 12:50:07 +00:00
< p > < a href = "https://hub.docker.com/r/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated" > bitcoin-s-oracle-server docker hub repo< / a >
< / details > < / p >
2021-03-05 13:53:22 +00:00
< h3 > < a class = "anchor" aria-hidden = "true" id = "library-jars" > < / a > < a href = "#library-jars" 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 > Library jars< / h3 >
2021-04-21 12:50:07 +00:00
< p > < details >
Add this to your < code > build.sbt< / code > :< / p >
< pre > < code class = "hljs css language-scala" >
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-bitcoind-rpc"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2019-06-20 14:53:06 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-core"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2019-06-20 14:53:06 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-chain"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2020-03-18 15:20:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-dlc-oracle"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2019-06-20 14:53:06 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-eclair-rpc"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2019-06-20 14:53:06 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-fee-provider"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2021-04-21 12:50:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-key-manager"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2020-03-18 15:20:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-lnd-rpc"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2021-04-21 12:50:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-node"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2020-03-18 15:20:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-oracle-explorer-client"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2021-04-21 12:50:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > % < span class = "hljs-string" > "bitcoin-s-secp256k1jni"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2021-04-21 12:50:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-testkit-core"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2020-03-18 15:20:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-testkit"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2019-06-20 14:53:06 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-wallet"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2021-04-21 12:50:07 +00:00
2025-01-25 15:35:06 +00:00
libraryDependencies += < span class = "hljs-string" > "org.bitcoin-s"< / span > %% < span class = "hljs-string" > "bitcoin-s-zmq"< / span > % < span class = "hljs-string" > "1.9.10"< / span >
2021-04-21 12:50:07 +00:00
2019-06-20 14:53:06 +00:00
< / code > < / pre >
< h3 > < a class = "anchor" aria-hidden = "true" id = "nightly-builds" > < / a > < a href = "#nightly-builds" 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 > Nightly builds< / h3 >
< p > You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your < code > build.sbt< / code > . The most
2025-03-11 19:24:27 +00:00
recent snapshot published is < code > 1.9.10-57-fb49548e-SNAPSHOT< / code > .< / p >
2019-06-20 14:53:06 +00:00
< p > To fetch snapshots, you will need to add the correct
resolver in your < code > build.sbt< / code > :< / p >
2021-02-02 13:37:52 +00:00
< pre > < code class = "hljs css language-sbt" > resolvers += Resolver.sonatypeRepo(< span class = "hljs-string" > "snapshots"< / span > )
2020-07-08 19:59:51 +00:00
< / code > < / pre >
< p > The official maven repo for releases is< / p >
< p > < a href = "https://repo1.maven.org/maven2/org/bitcoin-s/" > https://repo1.maven.org/maven2/org/bitcoin-s/< / a > < / p >
< p > The repo for snapshots, which are published after everytime something is merged to master:< / p >
< p > < a href = "https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/" > https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/< / a > < / p >
2021-04-21 12:50:07 +00:00
< p > < / details > < / p >
2020-07-08 19:59:51 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "building-jars-yourself" > < / a > < a href = "#building-jars-yourself" 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 JARs yourself< / h2 >
2021-05-07 23:27:00 +00:00
< p > Please see < a href = "/docs/next/getting-setup" > our setup docs< / a > < / p >
2021-03-05 13:53:22 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "if-you-want-to-setup-bitcoin-s-locally-for-development" > < / a > < a href = "#if-you-want-to-setup-bitcoin-s-locally-for-development" 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 > If you want to setup Bitcoin-S locally for development< / h2 >
2021-05-07 23:27:00 +00:00
< p > Please see < a href = "/docs/next/getting-setup" > our setup docs< / a > < / p >
2025-01-01 16:02:04 +00:00
< / span > < / div > < / article > < / div > < div class = "docs-prevnext" > < a class = "docs-next button" href = "/docs/next/bips" > < span > Supported BIPs< / span > < span class = "arrow-next" > →< / span > < / a > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < li > < a href = "#philosophy" > Philosophy< / a > < / li > < li > < a href = "#getting-prebuilt-artifacts" > Getting prebuilt artifacts< / a > < ul class = "toc-headings" > < li > < a href = "#java-binaries" > Java binaries< / a > < / li > < li > < a href = "#docker" > Docker< / a > < / li > < li > < a href = "#library-jars" > Library jars< / a > < / li > < li > < a href = "#nightly-builds" > Nightly builds< / a > < / li > < / ul > < / li > < li > < a href = "#building-jars-yourself" > Building JARs yourself< / a > < / li > < li > < a href = "#if-you-want-to-setup-bitcoin-s-locally-for-development" > If you want to setup Bitcoin-S locally for development< / 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 © 2025 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-06-20 14:53:06 +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 >
