{"id":13650883,"url":"https://github.com/theborakompanioni/bitcoin-spring-boot-starter","last_synced_at":"2025-10-06T07:26:30.376Z","repository":{"id":41536439,"uuid":"303107075","full_name":"theborakompanioni/bitcoin-spring-boot-starter","owner":"theborakompanioni","description":"Write enterprise Bitcoin applications with Spring Boot. Starter projects with multiple Bitcoin related modules that you can include in your application.","archived":false,"fork":false,"pushed_at":"2025-01-23T12:36:00.000Z","size":12225,"stargazers_count":72,"open_issues_count":4,"forks_count":16,"subscribers_count":6,"default_branch":"devel","last_synced_at":"2025-01-24T09:11:20.746Z","etag":null,"topics":["bitcoin","cln","java","lightning","lnd","spring","spring-boot"],"latest_commit_sha":null,"homepage":"https://theborakompanioni.github.io/bitcoin-spring-boot-starter","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theborakompanioni.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-11T11:39:00.000Z","updated_at":"2025-01-23T12:36:04.000Z","dependencies_parsed_at":"2024-04-25T12:25:19.149Z","dependency_job_id":"779e18a3-da46-41dd-8781-e04867c3eedc","html_url":"https://github.com/theborakompanioni/bitcoin-spring-boot-starter","commit_stats":null,"previous_names":["theborakompanioni/spring-boot-bitcoin-starter"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theborakompanioni%2Fbitcoin-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theborakompanioni%2Fbitcoin-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theborakompanioni%2Fbitcoin-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theborakompanioni%2Fbitcoin-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theborakompanioni","download_url":"https://codeload.github.com/theborakompanioni/bitcoin-spring-boot-starter/tar.gz/refs/heads/devel","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318744,"owners_count":20919484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","cln","java","lightning","lnd","spring","spring-boot"],"created_at":"2024-08-02T02:00:42.010Z","updated_at":"2025-10-06T07:26:30.371Z","avatar_url":"https://github.com/theborakompanioni.png","language":"Java","funding_links":[],"categories":["Java Libraries"],"sub_categories":[],"readme":"[![Build](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/actions/workflows/build.yml/badge.svg)](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/actions/workflows/build.yml)\n[![GitHub Release](https://img.shields.io/github/release/theborakompanioni/bitcoin-spring-boot-starter.svg?maxAge=3600)](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/releases/latest)\n[![Maven Central](https://img.shields.io/maven-central/v/io.github.theborakompanioni/bitcoin-jsonrpc-client-core.svg?maxAge=3600)](https://search.maven.org/#search|g%3A%22io.github.theborakompanioni%22)\n[![License](https://img.shields.io/github/license/theborakompanioni/bitcoin-spring-boot-starter.svg?maxAge=2592000)](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/blob/master/LICENSE)\n\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/theborakompanioni/bitcoin-spring-boot-starter/blob/master/docs/assets/images/logo.png\" alt=\"Logo\" width=\"255\" /\u003e\n\u003c/p\u003e\n\n\nbitcoin-spring-boot-starter\n===\n\n**Write enterprise Bitcoin applications with Spring Boot.**\n\nSpring boot starter projects with convenient dependency descriptors for multiple Bitcoin related modules that you can \ninclude in your application. Strong focus on integration and regression testing your own application or module.\nIncluded are features for representing, transporting, and performing comprehensive calculations and tests with \nBitcoin in financial applications and computations.\n\n**Hint**: Of course you can make use of the libraries even if you are not working with Spring!\n \n**Note**: Most code is still experimental - **use with caution**.\nThis project is under active development. Pull requests and issues are welcome.\n[Look at the changelog](changelog.md) to track notable changes.\n\u003ca id=\"fun\"\u003e\u003c/a\u003eAlso, [developing this project is fun](docs/FALSEHOODS.md).\n\n\n## Table of Contents\n\n- [Install](#install)\n- [Modules](#modules)\n- [Examples](#examples)\n- [Development](#development)\n- [Contributing](#contributing)\n- [Resources](#resources)\n- [License](#license)\n\n\n## Install\n\n[Download](https://search.maven.org/#search|g%3A%22io.github.theborakompanioni%22) from Maven Central.\n\n### Gradle\n```groovy\nrepositories {\n    mavenCentral()\n    maven {\n        // needed for netlayer packages\n        url \"https://jitpack.io\"\n    }\n    maven {\n        // needed for consensusj\n        url \"https://gitlab.com/api/v4/projects/8482916/packages/maven\"\n    }\n}\n```\n\n```groovy\nimplementation \"io.github.theborakompanioni:bitcoin-jsonrpc-client-starter:${bitcoinSpringBootStarterVersion}\"\n```\n\n### Maven\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.theborakompanioni\u003c/groupId\u003e\n    \u003cartifactId\u003ebitcoin-jsonrpc-client-starter\u003c/artifactId\u003e\n    \u003cversion\u003e${bitcoinSpringBootStarter.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nThe example above imports module `bitcoin-jsonrpc-client-starter` - you can import any module by its name.\n\n\n## Modules\n\n[This project contains various modules](readme.md) that can be integrated into your project depending on your requirements.\n\nYou can find a small selection in the following table. But there is much more to discover.\n\n\n\u003c!-- there are external links on the anchor #spring-lnurl - so please do not remove it --\u003e\n| Module                                                          | Description                                                                                                                                  |\n|-----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| [bitcoin-jsonrpc-client](modules.md#bitcoin-jsonrpc-client)     | Connect to Bitcoin Core via [ConsensusJ](https://github.com/ConsensusJ/consensusj) Bitcoin Core JSON-RPC API client.                         |\n| [bitcoin-zeromq-client](modules.md#bitcoin-zeromq-client)       | Connect to Bitcoin Core via zmq.                                                                                                             |\n| [bitcoin-regtest](modules.md#bitcoin-regtest)                   | Integration and regression testing your own application.                                                                                     |\n| [cln-grpc-client](modules.md#cln-grpc-client)                   | Connect to cln via gRPC.                                                                                                                     |\n| [lnd-grpc-client](modules.md#lnd-grpc-client)                   | Connect to lnd via gRPC using [LightningJ](https://www.lightningj.org/).                                                                     |\n| [xchange-jsr354](modules.md#xchange-jsr354)                     | Exchange rates from Bitcoin exchanges for your application.                                                                                  |\n| [spring-xchange](modules.md#spring-xchange)                     | Automatically create and configure [XChange](https://github.com/knowm/XChange) beans. \u003cbr /\u003eRemember to **get your coins off of exchanges**! |\n| [spring-tor](modules.md#spring-tor)                             | Automatically expose your application as [Tor Hidden Service](https://www.torproject.org/).                                                  |\n| \u003ca id=\"spring-lnurl\"\u003e\u003c/a\u003e[spring-lnurl](incubator/spring-lnurl) | Spring Security configurations for authentication with [lnurl-auth](https://github.com/fiatjaf/lnurl-rfc).                                   |\n\n[See modules.md for general information](modules.md) about specific modules.\n\n\n## Examples\nBesides, that most starter modules also have their own example applications, there are also stand-alone \nexample applications showing basic usage of the functionality provided by these modules.\n\n- [x] bitcoin-autodca: [Stacking Sats on Kraken: Auto DCA example application](examples/bitcoin-autodca-example-application)\n- [x] bitcoin-exchange-rate: [Currency Conversion API example application](examples/bitcoin-exchange-rate-example-application)\n- [x] ln-playground: [Lightning Network Playground example application](examples/ln-playground-example-application)\n- [x] lnurl-auth: [Spring Security Authentication with `lnurl-auth` example application](incubator/spring-lnurl/spring-lnurl-auth-example-application)\n\nExample apps can be started with a single command, e.g.:\n```shell script\n./gradlew -p incubator/spring-lnurl/spring-lnurl-auth-example-application bootRun --args=\"--spring.profiles.active=development --debug\"\n```\n\n\n## Development\n\n### Requirements\n- Java \u003e= 21\n- docker\n\nA Bitcoin Core Testcontainer running in regtest mode is started for most examples. \nHaving access to a Bitcoin Core node running on mainnet is quite useful if you want to try everything.\nOptional: A node should publish `rawtx` and `rawblock` messages via zmq for some features to work.\n\n### Build\n```shell script\n./gradlew build -x test\n```\n \n### Test\n```shell script\n./gradlew test integrationTest --rerun-tasks\n```\n\nTests in example application modules or modules that start a lot of docker containers \n(modules named \"*-example-application\" or \"spring-testcontainer-*\") are excluded from the\ndefault test phase and must be manually enabled if you want to run them.\nTo run all tests also run `e2eTest`, `exampleTest` and `testcontainerTest`:\n```shell script\n./gradlew test integrationTest e2eTest exampleTest testcontainerTest\n```\nBe aware this might take several minutes to complete (\u003e= 10 minutes).\n\n### Dependency Verification\nGradle is used for checksum and signature verification of dependencies.\n\n```shell script\n# write metadata for dependency verification\n./gradlew --write-verification-metadata pgp,sha256 --export-keys\n# update buildscript dependency locks\n./gradlew dependencies --write-locks\n```\n\nSee Gradle Userguides [Verifying dependencies](https://docs.gradle.org/current/userguide/dependency_verification.html)\nand [Locking dependency versions](https://docs.gradle.org/current/userguide/dependency_locking.html)\nfor more information.\n\n### Checkstyle\n[Checkstyle](https://github.com/checkstyle/checkstyle) with adapted [google_checks](https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml)\nis used for checking Java source code for adherence to a Code Standard.\n\n```shell script\n# check for code standard violations with checkstyle\n./gradlew checkstyleMain --rerun-tasks\n```\n\n### SpotBugs\n[SpotBugs](https://spotbugs.github.io/) is used for static code analysis.\n\n```shell script\n# invoke static code analysis with spotbugs\n./gradlew spotbugsMain --rerun-tasks\n```\n\n\n## Contributing\nAll contributions and ideas are always welcome. For any question, bug or feature request, \nplease create an [issue](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/issues). \nBefore you start, please read the [contributing guidelines](contributing.md).\n\n\n## Resources\n\n- Bitcoin: https://bitcoin.org/en/getting-started\n- Lightning Network: https://lightning.network\n- JSR354 (GitHub): https://github.com/JavaMoney/jsr354-api\n- Spring Boot (GitHub): https://github.com/spring-projects/spring-boot\n- Testcontainers (GitHub): https://github.com/testcontainers/testcontainers-java\n- Tor: https://www.torproject.org\n---\n- Bitcoin Core (GitHub): https://github.com/bitcoin/bitcoin ([Docker](https://hub.docker.com/r/polarlightning/bitcoind))\n- bitcoin-kmp (GitHub): https://github.com/ACINQ/bitcoin-kmp\n- bitcoinj (GitHub): https://github.com/bitcoinj/bitcoinj\n- cln (GitHub): https://github.com/ElementsProject/lightning ([Docker](https://hub.docker.com/r/polarlightning/clightning))\n- lnd (GitHub): https://github.com/LightningNetwork/lnd ([Docker](https://hub.docker.com/r/lightninglabs/lnd))\n- lnurl (GitHub): https://github.com/fiatjaf/lnurl-rfc\n- LightningJ (GitHub): https://github.com/lightningj-org/lightningj\n- cln gRPC client (GitHub): https://github.com/theborakompanioni/cln-grpc-client\n- lightning-kmp (GitHub): https://github.com/ACINQ/lightning-kmp\n- ElectrumX Server (GitHub): https://github.com/spesmilo/electrumx ([Docker](https://hub.docker.com/r/lukechilds/electrumx))\n- Electrum Personal Server (GitHub): https://github.com/chris-belcher/electrum-personal-server ([Docker](https://hub.docker.com/r/btcpayserver/eps))\n- Electrum Client (GitHub): https://github.com/spesmilo/electrum ([Docker](https://github.com/theborakompanioni/docker-electrum-daemon/pkgs/container/electrum-daemon))\n- ConsensusJ (GitHub): https://github.com/ConsensusJ/consensusj\n- JeroMq (GitHub): https://github.com/zeromq/jeromq\n- jMolecules (GitHub): https://github.com/xmolecules/jmolecules\n- springdoc-openapi (GitHub): https://github.com/springdoc/springdoc-openapi\n- sqlite (GitHub): https://github.com/xerial/sqlite-jdbc\n- Project Reactor (GitHub): https://github.com/reactor/reactor-core\n- Protocol Buffers: https://developers.google.com/protocol-buffers\n- XChange (GitHub): https://github.com/knowm/XChange\n\n\n## License\n\nThe project is licensed under the Apache License. See [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheborakompanioni%2Fbitcoin-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheborakompanioni%2Fbitcoin-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheborakompanioni%2Fbitcoin-spring-boot-starter/lists"}