Git Product home page Git Product logo

bitcoin-s's Introduction

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.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

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.

bitcoin-s's People

Contributors

ariskk avatar benthecarman avatar christewart avatar cwaldron97 avatar dan-smith-suredbits avatar dependabot[bot] avatar dwhjames avatar fiatjaf avatar giamme avatar greymccarthy avatar kaibr avatar mattfaltyn avatar mecampbellsoup avatar nkohen avatar philbertw4 avatar piu130 avatar rorp avatar saguywalker avatar sambradbury avatar scala-steward avatar shruthii625 avatar solo1g avatar tannerr1776 avatar tkawachi avatar tommccabe avatar tompro avatar torkelrogstad avatar user411 avatar wildfunctions avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.