Description
Bitcoin-S is a Scala implementation of the Bitcoin protocol. Bitcoin is a decentralized, peer-to-peer cryptocurrency.
This specific library is the core functionality of bitcoin-s. For the rpc-client: https://github.com/bitcoin-s/bitcoin-s-rpc-client
Bitcoin-S-Core alternatives and similar packages
Based on the "Cryptography" category.
Alternatively, view Bitcoin-S-Core alternatives based on common mentions on social networks and blogs.
-
TSec
Type-safe general-cryptography library - https://jmcardon.github.io/tsec/
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Bitcoin-S-Core or a related project?
README
[Bitcoin-S logo](website/static/img/bitcoin-s-dark-logo.png)
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 BITCOIN_S_UID="$(id -u):$(id -g)" 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.3
, here is how you can use the dependencies in your projects:
libraryDependencies += "org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-crypto" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-chain" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-oracle" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-oracle-explorer-client" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-app-commons" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-db-commons" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-fee-provider" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-lnd-rpc" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-node" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-wallet" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit-core" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-tor" % "1.9.3"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-cli" % "1.9.3"
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](LICENSE) file.
*Note that all licence references and agreements mentioned in the Bitcoin-S-Core README section above
are relevant to that project's source code only.