mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2025-02-23 22:56:52 +01:00
Bitcoin Implementation in Scala
0fa3be37dd
* Add DescriptorType, OutputDescriptor * Get unit test passing for a descriptor with a xpub and bip32 path * WIP: Implement checksum algo * WIP: Implement polyMod * Get checksum unit test case passing * Get basic serialization test case passing * Revert Bech32.scala * WIP: Implement KeyExpression * WIP: KeyOriginExpression * Get basic KeyExpression test case passing * Get basic unit tests workign for parsing Private/Public key descriptor expressions * Add examples * Get all key expression unit tests passing * Get negative test vectors passing * WIP: Get P2WPKHDescriptor tests working * Get all serizliation tests passing for non-derivation path BIP382 descrioptors * Get BIP382 derivation test cases passing * Implement BIP382 failure test cases * Get BIP381 test vectors passing * Split key expressions into SingleKeyExpression,MultisigKeyExpression * WIP: Multisig descriptors * Remove custom building of scripts now that we have #5502 * Get BIP383 test vectors passing * Get BIP384 test vectors passing * Fix bug in runFailTest() * Add RawSPKScriptExpression, use it with P2WSHExpression to ensure underlying spk is a RawScriptPubKey * Get all negative test vectors working after fixing bug in runFailTest() * Implement BIP385 raw() test vectors, skip addr() descriptor * Get everything working up to dealing with taproot pubkey types * Begin working on type hierarchy for different pubkeys * Get things to the point of needing a custom pubkey type * Get things compiling w/ PubKeyTypeExpression * Get tr(WIF) example working * WIP: Key reworking type hierachy to be PublicKey type specific * WIP: Taproot helpers * Get taproot descriptor working with both keypath and single level scriptpath * Get recursive tapscript tree test vector working * Implement negative test vectors for BIP386 * Add BIP386 derivation test * Get extkey tr() descriptor test working * Rename InternalPublicKeyExpression -> RawPublicXOnlyPublicKeyExpression * Fix keyOrigin for tr() descriptors * Cleanup comments * Add comments * Move leafVersion TapscriptControlBlock -> TapLeaf |
||
|---|---|---|
| .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-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 | ||
| 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 | ||
| flyway.conf | ||
| 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 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.8, here is how you can use the dependencies in your projects:
libraryDependencies += "org.bitcoin-s" % "bitcoin-s-secp256k1jni" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-core" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-crypto" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-chain" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-oracle" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-oracle-explorer-client" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-app-commons" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-db-commons" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-fee-provider" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-bitcoind-rpc" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-eclair-rpc" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-lnd-rpc" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-key-manager" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-node" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-node" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-wallet" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-dlc-wallet" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit-core" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-tor" % "1.9.8"
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-cli" % "1.9.8"
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.