Skip to content

clightning4j/lite-bitcoin-rpc

Repository files navigation

⚡ Lite Bitcoin RPC Wrapper ⚡

⚡ A (another) Lite RPC wrapper for Bitcoin Core RPC 1.0, that permitted to have flexibility into making the request with different versions of Bitcoin Core without lost compatibility during the update. ⚡

GitHub Workflow Status GitHub Workflow Status GitHub Workflow Status GitHub Workflow Status

Table of Content

  • Introduction
  • How Use it
  • Used by
  • Code Style
  • Support
  • License

Introduction

Why you developed another RPC wrapper for Bitcoin Core?

All the java implementations for Bitcoin core are old and not longer updated, and also are written with a specific version of Bitcoin core. This means that there are java implementations well tested that support the last version of Bitcoin as well as an old version of Bitcoin Core.

How Use it

  • btcli4j: A c-lightning plugin that give the possibility to run c-lightning with bitcoin pruning mode.

Maven Repository

TODO

Used by

TODO

Code Style

We live in a world where robots can drive a car, so we shouldn't just write code, we should write elegant code.

This repository use google-java-format to maintains the code of the repository elegant, so before submitting the code check the Java format with the following command on the root of the directory

./gradlew verifyGoogleJavaFormat

If any error are reported please run the following command to try to fix it

./gradlew googleJavaFormat

p.s: The gradle plugin works with all the JDK versions >= 9 (or better with java byte code version compatible with the version 55.0)

For more details about the JDK support see this issue and to know more about the Google Java code Style see this reference

Support

P.S: Lightning donation is coming ;-)

License

A (another) Lite RPC wrapper for Bitcoin Core RPC 1.0, that permitted to have flexibility into making the request with different versions of Bitcoin Core without lost compatibility during the update.

Copyright (C) 2021 Vincenzo Palazzo [email protected]

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.