| .github | ||
| app | ||
| app-commons | ||
| app-commons-test/src/test/scala/org/bitcoins/commons | ||
| async-utils/src/main/scala/org/bitcoins/asyncutil | ||
| async-utils-test/src/test/scala/org/bitcoins/asyncutil | ||
| bench | ||
| bitcoin-s-docs | ||
| bitcoind-rpc | ||
| bitcoind-rpc-test | ||
| chain | ||
| chain-test | ||
| clightning-rpc | ||
| clightning-rpc-test | ||
| core | ||
| core-test | ||
| crypto | ||
| crypto-test | ||
| db-commons | ||
| db-commons-test/src/test | ||
| dlc-node | ||
| dlc-node-test | ||
| dlc-oracle/src/main | ||
| dlc-oracle-test/src/test/scala/org/bitcoins/dlc/oracle | ||
| dlc-test/src/test/scala/org/bitcoins/dlc | ||
| dlc-wallet/src/main | ||
| dlc-wallet-test | ||
| docs | ||
| eclair-rpc | ||
| eclair-rpc-test | ||
| esplora/src/main/scala/org/bitcoins/esplora | ||
| esplora-test/src/test/scala/org/bitcoins/esplora | ||
| fee-provider/src/main/scala/org/bitcoins/feeprovider | ||
| fee-provider-test/src/test/scala/org/bitcoins/feeprovider | ||
| key-manager | ||
| key-manager-test/src/test/scala/org/bitcoins/keymanager | ||
| lnd-rpc | ||
| lnd-rpc-test | ||
| node | ||
| node-test | ||
| oracle-explorer-client/src | ||
| project | ||
| release-notes | ||
| secp256k1-zkp@9dd53912dc | ||
| secp256k1jni | ||
| testkit | ||
| testkit-core | ||
| tor | ||
| tor-test/src/test/scala/org/bitcoins/tor | ||
| wallet | ||
| wallet-test | ||
| website | ||
| zmq | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| .scalafmt.conf | ||
| build.sbt | ||
| CONTRIBUTING.md | ||
| docker-compose.yml | ||
| Dockerfile | ||
| inThisBuild.sbt | ||
| LICENSE | ||
| README.md | ||
| try-bitcoin-s.sh | ||
Feature-rich toolkit for making Bitcoin and Lightning applications on the JVM.
For a complete guide on how to get started with Bitcoin-S, see our website at Bitcoin-S.org.
Contents
- Running bitcoin-s
- What is bitcoin-s?
- Is bitcoin-s production ready?
- Can I trust the code in bitcoin-s?
- Getting started (non-developers)
- Getting setup (developers)
- Adding bitcoin-s to your library
- Docker images
- Contributing
- Good first issues
- License
Running bitcoin-s
You have three options to run bitcoin-s. Here are the instructions.
We recommend using the web frontend for beginners.
Docker
In this repo, you can just run
APP_PASSWORD=topsecret docker-compose up
which will spin up a docker environment that starts syncing the backend and will allow you to visit
the web frontend of the wallet at localhost:30002
What is bitcoin-s?
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 or twitter!
Is bitcoin-s production ready?
Please see our latest releases here.
Warning! While we try out best to test every pull request in master, this branch may not be stable! Bad things can happen to your node! Beware!
Can I trust the code in bitcoin-s?
Please audit and verify any and all code in this toolkit for its suitability and validity. This includes reviewing any and all dependencies.
Getting started (non-developers)
For a complete guide on how to get started with bitcoin-s, see our Getting started.
This link is intended for individuals who are just interested in installing bitcoin-s rather than developing. If you are interested in development, see Getting setup below.
Getting setup (developers)
For a complete guide on how to get setup with bitcoin-s, see our Getting setup.
This link is intended for setting up development of bitcoin-s. If you want to just install bitcoin-s rather than develop, see Getting started above.
Adding bitcoin-s to your library
The latest release of bitcoin-s is 1.8.0, here is how you can use the dependencies in your projects:
libraryDependencies += "org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-crypto" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-chain" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-oracle" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-oracle-explorer-client" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-app-commons" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-db-commons" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-fee-provider" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-lnd-rpc" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-node" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-wallet" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit-core" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-tor" % "1.8.0"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-cli" % "1.8.0"
Docker images
We publish docker images to docker hub on every PR merge and tag on github. You can obtain the images for both the app server and oracle server on these docker hub repos
Contributing
Bitcoin-S is an open source project where anyone is welcome to contribute. All contributions are encouraged and appreciated, whether that is code, testing, documentation or something else entirely.
See here for more information.
Good first issues
Here is a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with the bitcoin-s contribution process.
License
Bitcoin-s is MIT licensed, as found in the LICENSE file.