https://github.com/demining/bitcoin-spring-boot-starter-google-colab
Write enterprise Bitcoin applications with Spring Boot. Starter projects with multiple Bitcoin related modules that you can include in your application Google Colab
https://github.com/demining/bitcoin-spring-boot-starter-google-colab
bitcoin bitcoin-api bitcoin-core bitcoin-payment bitcoin-transaction bitcoin-wallet colab colab-notebook colab-notebooks colab-tutorial colaboratory google-colab google-colab-notebook google-colab-notebooks google-colab-tutorial google-colaboratory google-colaboratory-notebooks
Last synced: 3 months ago
JSON representation
Write enterprise Bitcoin applications with Spring Boot. Starter projects with multiple Bitcoin related modules that you can include in your application Google Colab
- Host: GitHub
- URL: https://github.com/demining/bitcoin-spring-boot-starter-google-colab
- Owner: demining
- License: apache-2.0
- Created: 2022-02-17T16:18:46.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-02T01:19:03.000Z (almost 3 years ago)
- Last Synced: 2025-02-01T18:11:42.010Z (4 months ago)
- Topics: bitcoin, bitcoin-api, bitcoin-core, bitcoin-payment, bitcoin-transaction, bitcoin-wallet, colab, colab-notebook, colab-notebooks, colab-tutorial, colaboratory, google-colab, google-colab-notebook, google-colab-notebooks, google-colab-tutorial, google-colaboratory, google-colaboratory-notebooks
- Language: Java
- Homepage:
- Size: 14 MB
- Stars: 5
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/actions/workflows/build.yml)
[](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/releases/latest)
[](https://search.maven.org/#search|g%3A%22io.github.theborakompanioni%22)
[](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/blob/master/LICENSE)
-------------------------
### Run bitcoin-spring-boot-starter-Google-Colab
https://colab.research.google.com/drive/1OShIMVcFZ_khsUIBOIV1lzrqAGo1gfm_?usp=sharing
-------------------------
**Write enterprise Bitcoin applications with Spring Boot.**
Spring boot starter projects with convenient dependency descriptors for multiple Bitcoin related modules that you can
include in your application. Strong focus on integration and regression testing your own application or module.
Included are features for representing, transporting, and performing comprehensive calculations and tests with
Bitcoin in financial applications and computations.
**Note**: Most code is still experimental - **do not use in production**.
This project is under active development. Pull requests and issues are welcome.
[Look at the changelog](changelog.md) to track notable changes.
Also, [developing this project is fun](docs/FALSEHOODS.md).
## Table of Contents
- [Install](#install)
- [Modules](#modules)
- [Examples](#examples)
- [Development](#development)
- [Contributing](#contributing)
- [Resources](#resources)
- [License](#license)
## Install
[Download](https://search.maven.org/#search|g%3A%22io.github.theborakompanioni%22) from Maven Central.
### Gradle
```groovy
implementation "io.github.theborakompanioni:spring-tor-starter:${bitcoinSpringBootStarterVersion}"
```
### Maven
```xml
io.github.theborakompanioni
spring-tor-starter
${bitcoinSpringBootStarter.version}
```
The example above imports module `spring-tor-starter` - you can import any module by its name.
## Modules
[This project contains various modules](readme.md) that can be integrated into your project depending on your requirements.
You can find a small selection in the following table. But there is much more to discover.
| Module | Description|
--- | --- |
|[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.|
|[bitcoin-zeromq-client](modules.md#bitcoin-zeromq-client)|Connect to Bitcoin Core via ZeroMq API client.|
|[bitcoin-regtest](modules.md#bitcoin-regtest)|Integration and regression testing your own application.|
|[lnd-grpc-client](modules.md#lnd-grpc-client)|Connect to lnd node via [LightningJ](https://www.lightningj.org/) gRPC API client.|
|[xchange-jsr354](modules.md#xchange-jsr354)|Exchange rates from popular Bitcoin exchanges for your application.|
|[spring-xchange](modules.md#spring-xchange)|Automatically create and configure [XChange]( https://github.com/knowm/XChange) beans.|
|[spring-tor](modules.md#spring-tor)|Automatically expose your application as [Tor Hidden Service](https://www.torproject.org/).|
|[spring-lnurl](incubator/spring-lnurl)|Spring Security configurations for authentication with [lnurl-auth](https://github.com/fiatjaf/lnurl-rfc).|
[See modules.md for general information](modules.md) about specific modules.
## Examples
Besides, that most starter modules also have their own example applications, there are also stand-alone
example applications showing basic usage of the functionality provided by these modules.
- [x] bitcoin-autodca: [Stacking Sats on Kraken: Auto DCA example application](examples/bitcoin-autodca-example-application)
- [x] bitcoin-exchange-rate: [Currency Conversion API example application](examples/bitcoin-exchange-rate-example-application)
- [x] lnd-playground: [Lightning Network Playground example application](examples/lnd-playground-example-application) (using lnd)
- [x] lnurl-auth: [Spring Security Authentication with `lnurl-auth` example application](incubator/spring-lnurl/spring-lnurl-auth-example-application)
Example apps can be started with a single command, e.g.:
```shell script
./gradlew -p incubator/spring-lnurl/spring-lnurl-auth-example-application bootRun
```
## Development
### Requirements
- java >=11
- docker
A Bitcoin Core Testcontainer running in regtest mode is started for most examples.
Having access to a Bitcoin Core node running on mainnet is quite useful if you want to try everything.
Optional: A node should publish `rawtx` and `rawblock` messages via zmq for some features to work.
### Build
```shell script
./gradlew build -x test
```
### Test
```shell script
./gradlew test integrationTest
```
Tests in example application modules or modules that start a lot of docker containers
(modules named "*-example-application" or "spring-testcontainer-*") are excluded from the
default test phase and must be manually enabled if you want to run them.
To run all tests pass arguments `-PexampleTest` and `-PtestcontainerTest`:
```shell script
./gradlew test integrationTest -PtestcontainerTest -PexampleTest
```
Be aware this might take several minutes to complete (>= 10 minutes).
### Dependency Verification
Gradle is used for checksum and signature verification of dependencies.
```shell script
# write metadata for dependency verification
./gradlew --write-verification-metadata pgp,sha256 --export-keys
```
See [Gradle Userguide: Verifying dependencies](https://docs.gradle.org/current/userguide/dependency_verification.html)
for more information.
### Checkstyle
[Checkstyle](https://github.com/checkstyle/checkstyle) with adapted [google_checks](https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml)
is used for checking Java source code for adherence to a Code Standard.
```shell script
# check for code standard violations with checkstyle
./gradlew checkstyleMain
```
### SpotBugs
[SpotBugs](https://spotbugs.github.io/) is used for static code analysis.
```shell script
# invoke static code analysis with spotbugs
./gradlew spotbugsMain
```
## Contributing
All contributions and ideas are always welcome. For any question, bug or feature request,
please create an [issue](https://github.com/theborakompanioni/bitcoin-spring-boot-starter/issues).
Before you start, please read the [contributing guidelines](contributing.md).
## Resources
- Bitcoin: https://bitcoin.org/en/getting-started
- Lightning Network: https://lightning.network/
- JSR354 (GitHub): https://github.com/JavaMoney/jsr354-api
- Spring Boot (GitHub): https://github.com/spring-projects/spring-boot
---
- Bitcoin Core (GitHub): https://github.com/bitcoin/bitcoin
- lnd (GitHub): https://github.com/LightningNetwork/lnd
- lnurl (GitHub): https://github.com/fiatjaf/lnurl-rfc
- ElectrumX Server (GitHub): https://github.com/spesmilo/electrumx
- Electrum Personal Server (GitHub): https://github.com/chris-belcher/electrum-personal-server
- Electrum Client (GitHub): https://github.com/spesmilo/electrum
- XChange (GitHub): https://github.com/knowm/XChange
- bitcoin-kmp (GitHub): https://github.com/ACINQ/bitcoin-kmp
- bitcoinj (GitHub): https://github.com/bitcoinj/bitcoinj
- LightningJ (GitHub): https://github.com/lightningj-org/lightningj
- ConsensusJ (GitHub): https://github.com/ConsensusJ/consensusj
- JeroMq (GitHub): https://github.com/zeromq/jeromq
- Project Reactor (GitHub): https://github.com/reactor/reactor-core
- jMolecules (GitHub): https://github.com/xmolecules/jmolecules
- Testcontainers (GitHub): https://github.com/testcontainers/testcontainers-java/
- Tor: https://www.torproject.org/
- Protocol Buffers: https://developers.google.com/protocol-buffers
----
| | Donation Address |
| --- | --- |
| ♥ __BTC__ | 1Lw2kh9WzCActXSGHxyypGLkqQZfxDpw8v |
| ♥ __ETH__ | 0xaBd66CF90898517573f19184b3297d651f7b90bf |