Bitcoin Implementation in Scala
Go to file
2022-07-20 16:36:06 -05:00
.github Bump to jdk18 (#4471) 2022-07-08 14:56:03 -05:00
app 2022 07 18 node callback stream manager (#4520) 2022-07-20 06:28:55 -05:00
app-commons Fee rate WS notification (#4518) 2022-07-19 16:41:06 -05:00
app-commons-test/src/test/scala/org/bitcoins/commons 2022 07 12 server startup cleanup (#4501) 2022-07-13 14:22:19 -05:00
async-utils/src/main/scala/org/bitcoins/asyncutil Improve bitcoind connection retry logic (#4386) 2022-06-14 08:40:04 -05:00
async-utils-test/src/test/scala/org/bitcoins/asyncutil Add FutureUtil tests (#3126) 2021-06-28 14:44:08 -05:00
bench Update scalafmt (#2619) 2021-02-03 16:37:12 -06:00
bitcoin-s-docs Remove previous stable version usage for windows builds as for some reason it doesn't work when setting up dev envs for the first time (#3292) 2021-06-18 09:18:54 -05:00
bitcoind-rpc Add sync JSON field to the getinfo endpoint output (#4452) 2022-07-12 14:41:43 -05:00
bitcoind-rpc-test Add static test vectors for Taproot (#3769) 2022-07-07 14:53:28 -05:00
chain Add abillity to clear callbacks (#4512) 2022-07-17 09:10:57 -05:00
chain-test Add abillity to clear callbacks (#4512) 2022-07-17 09:10:57 -05:00
clightning-rpc Add clightning sendcustommsg (#3883) 2021-12-08 10:13:20 -06:00
clightning-rpc-test Automatically download binaries if they are used in test suite (#4005) 2022-01-23 17:43:30 -06:00
core Refactor coin selection to be not be bitcoin-s specific (#4496) 2022-07-20 08:40:11 -05:00
core-test Refactor coin selection to be not be bitcoin-s specific (#4496) 2022-07-20 08:40:11 -05:00
crypto Represent and handle SIGHASH_DEFAULT correctly in TaprootKeyPath (#4488) 2022-07-11 07:22:08 -05:00
crypto-test Represent and handle SIGHASH_DEFAULT correctly in TaprootKeyPath (#4488) 2022-07-11 07:22:08 -05:00
db-commons Fee rate WS notification (#4518) 2022-07-19 16:41:06 -05:00
db-commons-test/src/test Add sync JSON field to the getinfo endpoint output (#4452) 2022-07-12 14:41:43 -05:00
dlc-node DLC <-> contact mapping (#4346) 2022-06-14 08:14:28 -05:00
dlc-node-test DLC <-> contact mapping (#4346) 2022-06-14 08:14:28 -05:00
dlc-oracle/src/main Make CRUD.run and CRUD.runVec transactional (#4059) 2022-02-07 17:42:48 -06:00
dlc-oracle-test/src/test/scala/org/bitcoins/dlc/oracle Store oracle name in the database (#3748) 2021-10-14 09:35:11 -05:00
dlc-test/src/test/scala/org/bitcoins/dlc Add TLVs defined in BOLT 4 (#4380) 2022-06-13 11:58:11 -05:00
dlc-wallet/src/main Make KeyManagerAppConfig.walletName return String rather than Option[String] (#4507) 2022-07-16 09:33:10 -05:00
dlc-wallet-test Allow creation of TaprootTxSigComponent (#4445) 2022-07-04 08:46:10 -05:00
docs 2022 07 12 server startup cleanup (#4501) 2022-07-13 14:22:19 -05:00
eclair-rpc Upgrade Eclair to v0.7.0 (#4308) 2022-05-02 09:04:56 -05:00
eclair-rpc-test Upgrade Eclair to v0.7.0 (#4308) 2022-05-02 09:04:56 -05:00
esplora/src/main/scala/org/bitcoins/esplora Add basic esplora client (#4018) 2022-01-28 15:48:44 -06:00
esplora-test/src/test/scala/org/bitcoins/esplora Add basic esplora client (#4018) 2022-01-28 15:48:44 -06:00
fee-provider/src/main/scala/org/bitcoins/feeprovider 2022 02 26 dynamic fee gui (#4135) 2022-02-27 07:14:52 -06:00
fee-provider-test/src/test/scala/org/bitcoins/feeprovider Create FallbackFeeRateApi (#3974) 2022-01-13 05:43:05 -06:00
key-manager Make KeyManagerAppConfig.walletName return String rather than Option[String] (#4507) 2022-07-16 09:33:10 -05:00
key-manager-test/src/test/scala/org/bitcoins/keymanager Make KeyManagerAppConfig.walletName return String rather than Option[String] (#4507) 2022-07-16 09:33:10 -05:00
lnd-rpc Fix lnd OutputDetails for outputs that dont have an address (#4438) 2022-06-30 08:57:01 -05:00
lnd-rpc-test Fix lnd OutputDetails for outputs that dont have an address (#4438) 2022-06-30 08:57:01 -05:00
lnurl/src/main/scala/org/bitcoins/lnurl LnURL Module (#4295) 2022-05-14 16:11:35 -05:00
lnurl-test/src/test/scala/org/bitcoins/lnurl LnURL Module (#4295) 2022-05-14 16:11:35 -05:00
node Add guard for calling NodeCallbackStreamManager.stop() (#4523) 2022-07-20 10:16:26 -05:00
node-test Change tests to use disconnectnode rpc instead of restarting bitcoind (#4468) 2022-07-08 18:53:37 -05:00
oracle-explorer-client/src Tor endpoints for the oracle explorer client (#4314) 2022-05-06 07:21:33 -05:00
project sbt 1.7.1 (#4497) 2022-07-12 07:49:26 -05:00
release-notes Add some summaries (#4399) 2022-06-16 14:26:37 -05:00
secp256k1-zkp@9dd53912dc Update secp256k1-zkp (#3856) 2021-12-03 09:49:07 -06:00
secp256k1jni Update secp256k1-zkp (#3856) 2021-12-03 09:49:07 -06:00
testkit 2022 07 18 node callback stream manager (#4520) 2022-07-20 06:28:55 -05:00
testkit-core Represent and handle SIGHASH_DEFAULT correctly in TaprootKeyPath (#4488) 2022-07-11 07:22:08 -05:00
tor Add abillity to clear callbacks (#4512) 2022-07-17 09:10:57 -05:00
tor-test/src/test/scala/org/bitcoins/tor Use random ports for pre-packaged Tor daemon (#3604) 2021-08-26 13:02:49 -05:00
wallet Refactor coin selection to be not be bitcoin-s specific (#4496) 2022-07-20 08:40:11 -05:00
wallet-test Refactor coin selection to be not be bitcoin-s specific (#4496) 2022-07-20 08:40:11 -05:00
website Musig2 Implementation (#4418) 2022-07-06 12:59:13 -05:00
zmq CI fixes (#3597) 2021-08-25 15:07:27 -05:00
.dockerignore WIP: Docusaurus website (#465) 2019-05-14 18:05:14 -05:00
.gitignore Support for Tor Docker (#4223) 2022-03-29 08:10:34 -05:00
.gitmodules Update .gitmodules (#3390) 2021-07-11 08:46:54 -05:00
.scalafmt.conf Update scalafmt (#2619) 2021-02-03 16:37:12 -06:00
build.sbt Make appServerTest run in parallel to speed up test suite (#4515) 2022-07-17 18:08:39 -05:00
CONTRIBUTING.md WIP: Docusaurus website (#465) 2019-05-14 18:05:14 -05:00
docker-compose.yml Fix peer configuration for docker-compose (#4225) 2022-03-29 14:28:57 -05:00
Dockerfile WIP: Docusaurus website (#465) 2019-05-14 18:05:14 -05:00
inThisBuild.sbt Upgrade to Scala 2.13.8 (#3789) 2022-01-13 10:17:11 -06:00
LICENSE Update license to latest year (#4525) 2022-07-20 16:36:06 -05:00
README.md Remove extra stuff from README so its easier to find important stuff (#4433) 2022-06-27 17:24:22 -05:00
try-bitcoin-s.sh Update try-bitcoin-s.sh (#1165) 2020-02-26 07:50:17 -06:00

Bitcoin-S logo Build Status Coverage Status ![Maven Central](https://img.shields.io/badge/Maven%20Central-1.9.2 -brightgreen.svg) Gitter chat

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

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 run the binaries natively, here are the instructions.

Web frontend

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.2 , here is how you can use the dependencies in your projects:

libraryDependencies += "org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-crypto" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-chain" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-oracle" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-oracle-explorer-client" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-app-commons" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-db-commons" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-fee-provider" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-lnd-rpc" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-node" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-wallet" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit-core" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-tor" % "1.9.2
"

libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-cli" % "1.9.2
"

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

bitcoin-s docker hub repo

oracle-server docker hub repo

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.