mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2024-11-19 01:40:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Bitcoin Implementation in Scala
4,653 Commits 94 Branches 24 Tags 2.4 GiB
Scala 98.8%
Java 0.7%
JavaScript 0.4%
04b9e6e75f
Go to file
Elias Rad 04b9e6e75f
Docs fix spelling issues (#5723) 
* Update cli.md

* Update server.md

* Update chain.md
2024-10-19 15:13:22 -05:00
.github Pull over simple syntax changes for scala3 libraries (#5719) 2024-10-17 13:00:33 -05:00
app Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
app-commons Pull over simple syntax changes for scala3 libraries (#5719) 2024-10-17 13:00:33 -05:00
app-commons-test/src/test/scala/org/bitcoins/commons Pull over simple syntax changes for scala3 libraries (#5719) 2024-10-17 13:00:33 -05:00
async-utils/src/main/scala/org/bitcoins/asyncutil Update scalafmt-core to 3.8.1 (#5501) 2024-04-20 19:55:49 -05:00
async-utils-test/src/test/scala/org/bitcoins/asyncutil Add -Xsource:3 to docs/ (#5581) 2024-05-10 12:37:02 -05:00
bench Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
bitcoin-s-docs rework bitcoind-rpc to take a walletName parameter that is a String (#5545) 2024-04-26 08:09:28 -05:00
bitcoind-rpc Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -05:00
bitcoind-rpc-test Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -05:00
chain Remove test case specific fixture setup in chainTest, revert to just using test suite specific fixtures (#5712) 2024-10-15 14:07:30 -05:00
chain-test Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -05:00
clightning-rpc Rework NativeProcessFactory.cmd to be Vector[String] (#5623) 2024-07-18 08:15:40 -05:00
clightning-rpc-test Upgrade clightning to 24.02.2 (#5558) 2024-05-01 13:28:12 -05:00
core 2024 10 19 rm generic btree (#5725) 2024-10-19 15:13:01 -05:00
core-test 2024 10 19 rm generic btree (#5725) 2024-10-19 15:13:01 -05:00
crypto 2024 05 08 scala3 core (#5580) 2024-05-10 11:10:45 -05:00
crypto-test Pull over simple syntax changes for scala3 libraries (#5719) 2024-10-17 13:00:33 -05:00
db-commons Remove TableAutoInc[T] type parameter, its unnecessary and causes issues (#5711) 2024-10-15 07:31:26 -05:00
db-commons-test/src/test Add -Xsource:3 to db-commons/ (#5585) 2024-05-11 07:24:00 -05:00
dlc-node Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
dlc-node-test 2024 09 30 dlcwallet has a wallet (#5692) 2024-10-01 13:29:58 -05:00
dlc-oracle/src/main Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
dlc-oracle-test/src/test/scala/org/bitcoins/dlc/oracle Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
dlc-wallet/src/main Remove TableAutoInc[T] type parameter, its unnecessary and causes issues (#5711) 2024-10-15 07:31:26 -05:00
dlc-wallet-test Add error field toImportDescriptorResult, move BitcoindException to app-commons (#5705) 2024-10-12 09:49:42 -05:00
docs Docs fix spelling issues (#5723) 2024-10-19 15:13:22 -05:00
eclair-rpc Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
eclair-rpc-test 2024 04 30 upgrade eclair v0.10.0 (#5557) 2024-04-30 14:25:50 -05:00
esplora/src/main/scala/org/bitcoins/esplora Update scalafmt-core to 3.8.1 (#5501) 2024-04-20 19:55:49 -05:00
esplora-test/src/test/scala/org/bitcoins/esplora Update scalafmt-core to 3.8.1 (#5501) 2024-04-20 19:55:49 -05:00
fee-provider/src/main/scala/org/bitcoins/feeprovider 2024 09 24 simplify wallet (#5685) 2024-09-27 13:40:29 -05:00
fee-provider-test/src/test/scala/org/bitcoins/feeprovider Re-enable mempool api tests (#5560) 2024-05-01 15:26:41 -05:00
key-manager Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -05:00
key-manager-test/src/test/scala/org/bitcoins/keymanager Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -05:00
lnd-rpc Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
lnd-rpc-test Pull over simple syntax changes for {cli,oracleServer,bench,dlcNode,dlcOracle,dlcOracleTest,eclairRpc,lndRpc,lndRpcTest} from #5713 (#5721) 2024-10-17 15:41:43 -05:00
lnurl/src/main/scala/org/bitcoins/lnurl Update scalafmt-core to 3.8.1 (#5501) 2024-04-20 19:55:49 -05:00
lnurl-test/src/test/scala/org/bitcoins/lnurl Update scalafmt-core to 3.8.1 (#5501) 2024-04-20 19:55:49 -05:00
node Fix potential deadlock when offering to queue in managePeerAfterInitialization() (#5667) 2024-09-14 13:23:10 -05:00
node-test Add error field toImportDescriptorResult, move BitcoindException to app-commons (#5705) 2024-10-12 09:49:42 -05:00
project 2024 10 19 rm generic btree (#5725) 2024-10-19 15:13:01 -05:00
release-notes Create 1.9.9 release notes (#5596) 2024-05-15 14:23:27 -05:00
secp256k1-zkp@9dd53912dc Update secp256k1-zkp (#3856) 2021-12-03 09:49:07 -06:00
secp256k1jni Drop support for scalac 2.12.x (#4704) 2022-09-03 10:16:22 -05:00
testkit Remove test case specific fixture setup in chainTest, revert to just using test suite specific fixtures (#5712) 2024-10-15 14:07:30 -05:00
testkit-core Pull over simple syntax changes for scala3 libraries (#5719) 2024-10-17 13:00:33 -05:00
tor Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -05:00
tor-test/src/test/scala/org/bitcoins/tor Update scalafmt-core to 3.8.1 (#5501) 2024-04-20 19:55:49 -05:00
wallet Remove TableAutoInc[T] type parameter, its unnecessary and causes issues (#5711) 2024-10-15 07:31:26 -05:00
wallet-test Add error field toImportDescriptorResult, move BitcoindException to app-commons (#5705) 2024-10-12 09:49:42 -05:00
website Bump versions to 1.9.9 (#5598) 2024-05-16 06:25:25 -05:00
zmq Pull over simple syntax changes for scala3 pt2 (#5720) 2024-10-17 14:14:32 -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 dialect to scala213source3 (#5536) 2024-04-21 11:53:25 -05:00
build.sbt 2024 09 24 simplify wallet (#5685) 2024-09-27 13:40:29 -05:00
CONTRIBUTING.md WIP: Docusaurus website (#465) 2019-05-14 18:05:14 -05:00
docker-compose.yml Remove neutrino.suredbits.com:8333 from docker-compose.yml (#5492) 2024-03-24 11:03:39 -05:00
Dockerfile WIP: Docusaurus website (#465) 2019-05-14 18:05:14 -05:00
flyway.conf Upgrade dependencies (#4705) 2022-09-05 07:11:23 -05:00
inThisBuild.sbt Update scala-library to 2.13.14 (#5567) 2024-05-05 08:13:58 -05:00
LICENSE Update license to latest year (#4525) 2022-07-20 16:36:06 -05:00
README.md Bump versions to 1.9.9 (#5598) 2024-05-16 06:25:25 -05:00
try-bitcoin-s.sh Update try-bitcoin-s.sh (#1165) 2020-02-26 07:50:17 -06:00

README.md

Bitcoin-S logo Build Status Coverage Status Maven Central 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 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.9, here is how you can use the dependencies in your projects:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.