feat: add wallet setup example for JVM binding

Author: ItoroD

.github/workflows/test-jvm.yaml

@@ -41,3 +41,4 @@ jobs:
           cd bdk-jvm
           bash ./scripts/build-linux-x86_64.sh
           ./gradlew test -P excludeConnectedTests
+          ./gradlew :examples:build

bdk-jvm/examples/build.gradle.kts

@@ -0,0 +1,34 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    kotlin("jvm") version "2.1.10"
+}
+
+group = "org.bitcoindevkit"
+version = "2.0.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(project(":lib"))
+    testImplementation(kotlin("test"))
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+    withSourcesJar()
+    withJavadocJar()
+}
+
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
+    }
+}

bdk-jvm/examples/src/main/kotlin/WalletSetupBip32.kt

@@ -0,0 +1,79 @@
+package org.bitcoindevkit
+import java.io.File
+import java.nio.file.Paths
+
+fun main(){
+    val (descriptor, changeDescriptor) = createDescriptorsFromBip32RootKey(
+        ActiveWalletScriptType.P2WPKH,
+        Network.REGTEST
+    )
+    println("Descriptor: $descriptor")
+    println("Change descriptor: $changeDescriptor")
+
+    val persistenceFilePath = getPersistenceFilePath()
+    println("Persistence file path: $persistenceFilePath")
+
+    val connection: Persister = Persister.newSqlite(persistenceFilePath)
+    val wallet = Wallet(descriptor, changeDescriptor, Network.REGTEST, connection)
+    val changeAddress = wallet.revealNextAddress(KeychainKind.INTERNAL).address
+    val address = wallet.revealNextAddress(KeychainKind.EXTERNAL).address
+
+    println("Change address: $changeAddress")
+    println("Address: $address")
+}
+
+fun createDescriptorsFromBip32RootKey (
+    activeWalletScriptType: ActiveWalletScriptType,
+    network: Network) : Array<Descriptor>{
+    val mnemonic = Mnemonic(WordCount.WORDS12)
+    val bip32ExtendedRootKey = DescriptorSecretKey(network, mnemonic, null)
+    println("Bip32 root key: $bip32ExtendedRootKey")
+    
+    val descriptor: Descriptor = createScriptAppropriateDescriptor(
+        activeWalletScriptType,
+        bip32ExtendedRootKey,
+        network,
+        KeychainKind.EXTERNAL,
+    )
+    val changeDescriptor: Descriptor = createScriptAppropriateDescriptor(
+        activeWalletScriptType,
+        bip32ExtendedRootKey,
+        network,
+        KeychainKind.INTERNAL,
+    )
+    return arrayOf(descriptor, changeDescriptor)
+}
+
+
+fun createScriptAppropriateDescriptor(
+    scriptType: ActiveWalletScriptType,
+    bip32ExtendedRootKey: DescriptorSecretKey,
+    network: Network,
+    keychain: KeychainKind,
+): Descriptor {
+    return when (scriptType) {
+        ActiveWalletScriptType.P2WPKH -> Descriptor.newBip84(
+            bip32ExtendedRootKey,
+            keychain,
+            network
+        )
+        ActiveWalletScriptType.P2TR -> Descriptor.newBip86(
+            bip32ExtendedRootKey,
+            keychain,
+            network
+        )
+    }
+}
+
+fun getPersistenceFilePath(): String {
+    val currentDirectory = Paths.get("").toAbsolutePath().toString() + "/bdk-jvm/examples/src/main/kotlin/bdk_persistence.sqlite"
+    File(currentDirectory).apply {
+        if (exists()) delete()
+    }
+    return currentDirectory
+}
+
+enum class ActiveWalletScriptType {
+    P2WPKH,
+    P2TR,
+}

bdk-jvm/settings.gradle.kts

@@ -1,6 +1,7 @@
 rootProject.name = "bdk-jvm"
 
 include(":lib")
+include(":examples")
 
 pluginManagement {
     repositories {