https://github.com/bitcoindevkit/bdk-jvm
https://github.com/bitcoindevkit/bdk-jvm
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitcoindevkit/bdk-jvm
- Owner: bitcoindevkit
- Created: 2025-07-25T15:01:34.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-08-28T17:56:51.000Z (10 months ago)
- Last Synced: 2025-08-28T23:37:56.655Z (10 months ago)
- Language: Kotlin
- Size: 104 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# bdk-jvm
This project builds a .jar package for the JVM platform that provides Kotlin language bindings for the [BDK] libraries. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository.
## How to Use
To use the Kotlin language bindings for BDK in your JVM project add the following to your gradle dependencies:
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("org.bitcoindevkit:bdk-jvm:")
}
```
### Snapshot releases
To use a snapshot release, specify the snapshot repository url in the `repositories` block and use the snapshot version in the `dependencies` block:
```kotlin
repositories {
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
dependencies {
implementation("org.bitcoindevkit:bdk-jvm:")
}
```
## Example Projects
- [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine)
- [Godzilla Wallet](https://github.com/thunderbiscuit/godzilla-wallet)
## How to build
_Note that Kotlin version `1.9.23` or later is required to build the library._
1. Install JDK 17. For example, with SDKMAN!:
```shell
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"
sdk install java 17.0.2-tem
```
2. Build kotlin bindings
```sh
bash ./scripts/build-.sh
```
## Run example files
The `examples` module show different samples of how some of the APIs can be used. You can run the examples after building as stated above. The gradle task to run is by convention the file name of the example file.
```shell
./gradlew MultisigTransaction
```
You can also list the application tasks. (All examples grouped under application)
```shell
./gradlew tasks --group application
```
## How to publish to your local Maven repo
```shell
./gradlew publishToMavenLocal -P localBuild
```
Note that the commands assume you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so:
```properties
signing.gnupg.keyName=
signing.gnupg.passphrase=
```
and use the `publishToMavenLocal` task without the `localBuild` flag:
```shell
./gradlew publishToMavenLocal
```
## Known issues
## JNA dependency
Depending on the JVM version you use, you might not have the JNA dependency on your classpath. The exception thrown will be
```shell
class file for com.sun.jna.Pointer not found
```
The solution is to add JNA as a dependency like so:
```kotlin
dependencies {
// ...
implementation("net.java.dev.jna:jna:5.12.1")
}
```
[BDK]: https://github.com/bitcoindevkit/
[`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi