* An initial (not yet working) implementation with test * Added custom (non-bip-340) verification for now * Made KeySet a case class * Got MuSig2 working with BIP340 verification passing * Responds to Ben's review * Fixed hash tags and added parital signature verification * Added point multiplication that allows infinity and did some refactoring * Refactored type defs into case classes * Added tests for more signers and fixed single-party bug * Added key aggregation test vectors from BIP * Added nonce generation test vectors from BIP * Added nonce aggregation test vectors from BIP * Made nonce aggregation test vectors pass by having MultiNoncePub wrap SecpPoints * Added remaining static test vectors from BIP * Implements tweaking support and adds tests, including all of the remaining BIP tests * Added factory objects for nonce types * Refactored things into multiple files with renaming and restructuring * Some minor renaming * Introduced ParityMultiplier ADT to remove unneccesary computations * Added scaladocs * Added messages to invariants * Fixed a typo * Nonce generation now takes a SchnorrPublicKey instead of raw bytes * Made point multiplication more robust * Responded to Ben nits * Added musig.md |
||
---|---|---|
.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 | ||
lnurl/src/main/scala/org/bitcoins/lnurl | ||
lnurl-test/src/test/scala/org/bitcoins/lnurl | ||
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
- 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 run the binaries natively, here are the instructions.
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
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.