Intro and Getting Started
Philosophy
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.
If you are a professional working a cryptocurrency business and have feedback on how to make your lives easier, please reach out on slack, gitter or twitter!
Getting prebuilt artifacts
Java binaries
Latest release
Please see the release page on github, you can find it here
Master builds
We build installers for mac, linux and windows everytime a PR is merged to master.
You can find the latest builds at this link:
https://github.com/bitcoin-s/bitcoin-s/actions/workflows/release.yml
Here is what the installers look like
Docker
bitcoin-s-server docker hub repo
bitcoin-s-oracle-server docker hub repo
Library jars
build.sbt
:
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-chain" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-oracle" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-fee-provider" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-lnd-rpc" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-oracle-explorer-client" % "1.9.4"
libraryDependencies += "org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit-core" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "1.9.4"
Nightly builds
You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your build.sbt
. The most
recent snapshot published is 1.9.4-41-6d0c7689-20221003-0941-SNAPSHOT
.
To fetch snapshots, you will need to add the correct
resolver in your build.sbt
:
resolvers += Resolver.sonatypeRepo("snapshots")
The official maven repo for releases is
https://repo1.maven.org/maven2/org/bitcoin-s/
The repo for snapshots, which are published after everytime something is merged to master:
https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/
Building JARs yourself
Please see our setup docs
If you want to setup Bitcoin-S locally for development
Please see our setup docs