io.github.theborakompanioni:bitcoin-fee-estimate-bitcoin-jsonrpc

bitcoin-fee

A generalized and extensible interface of multiple Bitcoin Fee Recommendation APIs. The following providers are available out of the box:

• Bitcoin Core JSON-RPC Api (estimatestmartfee)
• bitcoiner.live API
• Bitgo API
• Bitcore API
• Blockchain.info API (deprecated - will be removed as it is not compatible with "block target" recommendations)
• Blockchair API
• BlockCypher API
• Blockstream.info API
• mempool.space API

Table of Contents

• Install
• Example
• Development
• Contributing
• Resources
• License

Install

Download from Maven Central.

Gradle

repositories {
    mavenCentral()
}

implementation "io.github.theborakompanioni:bitcoin-fee-starter:${bitcoinFeeVersion}"

Maven

<dependency>
    <groupId>io.github.theborakompanioni</groupId>
    <artifactId>bitcoin-fee-starter</artifactId>
    <version>${bitcoinFeeVersion}</version>
</dependency>

Example

Start the example application with

./gradlew -p bitcoin-fee/bitcoin-fee-example-application bootRun --args="--spring.profiles.active=development --debug"

Then visit http://localhost:8080 in your browser.

Development

Requirements

• java >=21

Build

./gradlew build -x test

Test

./gradlew test integrationTest e2eTest --rerun-tasks

Dependency Verification

Gradle is used for checksum and signature verification of dependencies.

# write metadata for dependency verification
./gradlew --write-verification-metadata pgp,sha256 --export-keys
# update buildscript dependency locks
./gradlew dependencies --write-locks

See Gradle Userguides Verifying dependencies and Locking dependency versions for more information.

Checkstyle

Checkstyle with adapted google_checks is used for checking Java source code for adherence to a Code Standard.

# check for code standard violations with checkstyle
./gradlew checkstyleMain --rerun-tasks

SpotBugs

SpotBugs is used for static code analysis.

# invoke static code analysis with spotbugs
./gradlew spotbugsMain --rerun-tasks

Contributing

All contributions and ideas are always welcome. For any question, bug or feature request, please create an issue. Before you start, please read the contributing guidelines.

Resources

• Bitcoin: https://bitcoin.org/en/getting-started
• Spring Boot (GitHub): https://github.com/spring-projects/spring-boot
• Protocol Buffers: https://developers.google.com/protocol-buffers

License

The project is licensed under the Apache License. See LICENSE for details.