0cfad33fae
* Add 1.9.4 website, add 1.9.4 release notes * Add versioned sidebars * Bump more versions to 1.9.4 * update release notes
4.7 KiB
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
- Getting started (non-developers)
- Adding bitcoin-s to your library
- Docker images
- Contributing
- Good first issues
- License
Running bitcoin-s
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:3002
or you can build and run the electron app natively.
git clone https://github.com/bitcoin-s/bitcoin-s-ts.git
cd bitcoin-s-ts && ./build-wallet-electron.sh
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.9.4, here is how you can use the dependencies in your projects:
libraryDependencies += "org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-crypto" % "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-oracle-explorer-client" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-app-commons" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-db-commons" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-fee-provider" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-lnd-rpc" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-node" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-wallet" % "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-zmq" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-tor" % "1.9.4"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-cli" % "1.9.4"
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.