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

Add documentation on how to use snapshot versions of libraries

Browse Source
This commit is contained in:
thunderbiscuit 2022-11-30 12:20:48 -05:00
parent 2645f69853
commit 5dd5828e88
No known key found for this signature in database
GPG Key ID: 88253696EB836462
3 changed files with 42 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -73,6 +73,8 @@ dependencies {
} }
``` ```
_Note:_ We also publish snapshot versions of bdk-jvm and bdk-android. See the specific readmes for instructions on how to use those.
### bdk-python ### bdk-python
```shell ```shell
pip3 install bdkpython pip3 install bdkpython

25
bdk-android/README.md
View File

@ -1,9 +1,9 @@
# bdk-android # bdk-android
This project builds an .aar package for the `android` 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 an .aar package for the Android 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
To use the Kotlin language bindings for [`bdk`] in your `android` project add the following to your gradle dependencies: To use the Kotlin language bindings for [`bdk`] in your Android project add the following to your gradle dependencies:
```groovy ```kotlin
repositories { repositories {
mavenCentral() mavenCentral()
} }
@ -32,6 +32,18 @@ val wallet = Wallet(externalDescriptor, internalDescriptor, Network.TESTNET, dat
val newAddress = wallet.getNewAddress() val newAddress = wallet.getNewAddress()
``` ```
### 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-android:<version-SNAPSHOT>")
}
```
### Example Projects ### Example Projects
* [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet) * [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet)
* [Padawan Wallet](https://github.com/thunderbiscuit/padawan-wallet) * [Padawan Wallet](https://github.com/thunderbiscuit/padawan-wallet)
@ -67,10 +79,8 @@ git clone https://github.com/bitcoindevkit/bdk-ffi
./gradlew connectedAndroidTest ./gradlew connectedAndroidTest
``` ```
## How to publish ## How to publish to your local Maven repo
### Publish to your local maven repo
```shell ```shell
# bdk-android
cd bdk-android cd bdk-android
./gradlew publishToMavenLocal --exclude-task signMavenPublication ./gradlew publishToMavenLocal --exclude-task signMavenPublication
``` ```
@ -85,3 +95,6 @@ and use the `publishToMavenLocal` task without excluding the signing task:
```shell ```shell
./gradlew publishToMavenLocal ./gradlew publishToMavenLocal
``` ```
[`bdk`]: https://github.com/bitcoindevkit/bdk
[`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi

28
bdk-jvm/README.md
View File

@ -1,8 +1,8 @@
# bdk-android # bdk-android
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
To use the Kotlin language bindings for [`bdk`] in your `jvm` project add the following to your gradle dependencies: To use the Kotlin language bindings for [`bdk`] in your JVM project add the following to your gradle dependencies:
```kotlin ```kotlin
repositories { repositories {
mavenCentral() mavenCentral()
@ -32,10 +32,23 @@ val wallet = Wallet(externalDescriptor, internalDescriptor, Network.TESTNET, dat
val newAddress = wallet.getNewAddress() val newAddress = wallet.getNewAddress()
``` ```
### Example Projects ### 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:<version-SNAPSHOT>")
}
```
## 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. Clone this repository. 1. Clone this repository.
@ -53,10 +66,8 @@ rustup target add x86_64-apple-darwin aarch64-apple-darwin
./gradlew buildJvmLib ./gradlew buildJvmLib
``` ```
## How to publish ## How to publish to your local Maven repo
### Publish to your local maven repo
```shell ```shell
# bdk-jvm
cd bdk-jvm cd bdk-jvm
./gradlew publishToMavenLocal --exclude-task signMavenPublication ./gradlew publishToMavenLocal --exclude-task signMavenPublication
``` ```
@ -71,3 +82,6 @@ and use the `publishToMavenLocal` task without excluding the signing task:
```shell ```shell
./gradlew publishToMavenLocal ./gradlew publishToMavenLocal
``` ```
[`bdk`]: https://github.com/bitcoindevkit/bdk
[`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi