frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update JVM readme with specific Rust version

Browse Source
This commit is contained in:
thunderbiscuit 2023-06-15 11:10:28 -04:00
parent fe7e4e21c0
commit 039b64de5c
No known key found for this signature in database
GPG Key ID: 88253696EB836462
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
bdk-jvm/README.md
View File

@ -1,4 +1,4 @@
# bdk-android # bdk-jvm
This project builds a .jar package for the JVM platform that provide Kotlin language bindings for the [`bdk`] library. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository. This project builds a .jar package for the JVM platform that provide Kotlin language bindings for the [`bdk`] library. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository.
## How to Use ## How to Use
@ -43,21 +43,21 @@ dependencies {
} }
``` ```
## Example Projects ## Example Projects
* [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine) * [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine)
## How to build ## How to build
_Note that Kotlin version `1.6.10` or later is required to build the library._ _Note that Kotlin version `1.6.10` or later is required to build the library._
1. Install JDK 11. It must be JDK 11 (not 17), otherwise it won't build. For example, with SDKMAN!: 1. Install JDK 11. It must be version 11 (not 17), otherwise it won't build. For example, with SDKMAN!:
```shell ```shell
curl -s "https://get.sdkman.io" | bash curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh" source "$HOME/.sdkman/bin/sdkman-init.sh"
sdk install java 11.0.19-tem sdk install java 11.0.19-tem
``` ```
2. Install rust: 2. Install Rust (note that we are currently building using Rust 1.67.0):
```shell ```shell
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default 1.67.0
``` ```
3. Clone this repository. 3. Clone this repository.
```shell ```shell
@ -68,10 +68,9 @@ git clone https://github.com/bitcoindevkit/bdk-ffi
rustup target add x86_64-apple-darwin aarch64-apple-darwin rustup target add x86_64-apple-darwin aarch64-apple-darwin
``` ```
5. Build kotlin bindings 5. Build kotlin bindings
```sh ```sh
# build JVM library ./gradlew buildJvmLib
./gradlew buildJvmLib ```
```
## How to publish to your local Maven repo ## How to publish to your local Maven repo
```shell ```shell