Cherry-pick commits for the 2.3.1 release

.github/workflows/test.yaml

@@ -7,6 +7,23 @@ jobs:
   test:
     name: "Build library and run unit tests"
     runs-on: ubuntu-24.04
+
+    services:
+      bitcoin-regtest:
+        image: ghcr.io/thunderbiscuit/podman-regtest-infinity-pro:0.3.2
+        ports:
+          - 18443:18443
+          - 18444:18444
+          - 3002:3002
+          - 3003:3003
+          - 60401:60401
+        # The container initialization step will wait until everything is ready before allowing other steps to run
+        options: >-
+          --health-cmd "test $(bitcoin-cli -regtest -rpcuser=regtest -rpcpassword=password getblockcount) -gt 0"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 6
+
     steps:
       - name: "Check out PR branch"
         uses: actions/checkout@v4

build.gradle.kts

@@ -1,13 +1,5 @@
 plugins {
-    id("org.jetbrains.kotlin.jvm").version("2.1.10").apply(false)
-    id("org.gradle.java-library")
-    id("org.gradle.maven-publish")
-    id("org.gradle.signing")
-    id("org.jetbrains.dokka").version("2.0.0").apply(false)
-    id("org.jetbrains.dokka-javadoc").version("2.0.0").apply(false)
+    id("org.jetbrains.kotlin.jvm").version("2.2.0").apply(false)
+    id("org.jetbrains.dokka").version("2.1.0").apply(false)
+    id("com.vanniktech.maven.publish").version("0.36.0").apply(false)
 }
-
-// library version is defined in gradle.properties
-val libraryVersion: String by project
-group = "org.bitcoindevkit"
-version = libraryVersion

lib/README.md → docs/DOKKA_LANDING.md

@@ -1,7 +1,9 @@
 # Module bdk-jvm
 
-The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Kotlin on the JVM.
+The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Kotlin on the JVM.  
 
-# Package org.bitcoindevkit
+<br>
 
 The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), [bdk_esplora](https://crates.io/crates/bdk_esplora), [bitcoin](https://crates.io/crates/bitcoin), and [miniscript](https://crates.io/crates/miniscript) crates.
+
+# Package org.bitcoindevkit

examples/build.gradle.kts

@@ -1,8 +1,8 @@
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    id("org.jetbrains.kotlin.jvm") version "2.1.10"
-    id("application")
+    id("org.jetbrains.kotlin.jvm")
 }
 
 repositories {
@@ -11,24 +11,19 @@ repositories {
 
 dependencies {
     implementation(project(":lib"))
-    testImplementation(kotlin("test"))
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1")
     implementation("org.slf4j:slf4j-api:2.0.16")
     implementation("ch.qos.logback:logback-classic:1.5.13")
 }
 
-tasks.test {
-    useJUnitPlatform()
-}
-
 java {
     sourceCompatibility = JavaVersion.VERSION_11
     targetCompatibility = JavaVersion.VERSION_11
     withSourcesJar()
     withJavadocJar()
 }
 
-tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+tasks.withType<KotlinCompile> {
     compilerOptions {
         jvmTarget.set(JvmTarget.JVM_11)
     }

gradle.properties

@@ -1,6 +1,5 @@
 org.gradle.jvmargs=-Xmx1536m
 android.enableJetifier=true
 kotlin.code.style=official
-libraryVersion=2.3.0
 org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

justfile

@@ -16,7 +16,7 @@ docs:
 [group("Repo")]
 [doc("Publish the library to your local Maven repository.")]
 publish-local:
-  ./gradlew publishToMavenLocal -P localBuild
+  ./gradlew publishToMavenLocal
 
 [group("Submodule")]
 [doc("Initialize bdk-ffi submodule to committed hash.")]
@@ -58,6 +58,8 @@ clean:
   rm -rf ./lib/build/
   rm -rf ./examples/build/
   rm -rf ./examples/data/
+  rm -rf ./lib/src/main/kotlin/org/bitcoindevkit/*
+  rm -rf ./lib/src/main/resources/*
 
 [group("Test")]
 [doc("Run all tests, unless a specific test is provided.")]

lib/build.gradle.kts

@@ -1,108 +1,107 @@
-import org.gradle.api.tasks.testing.logging.TestExceptionFormat.*
-import org.gradle.api.tasks.testing.logging.TestLogEvent.*
+import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinJvm
+import com.vanniktech.maven.publish.SourcesJar
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
-// library version is defined in gradle.properties
-val libraryVersion: String by project
-
 plugins {
     id("org.jetbrains.kotlin.jvm")
-    id("org.gradle.java-library")
-    id("org.gradle.maven-publish")
-    id("org.gradle.signing")
+    id("com.vanniktech.maven.publish")
     id("org.jetbrains.dokka")
-    id("org.jetbrains.dokka-javadoc")
 }
 
+group = "org.bitcoindevkit"
+version = "2.3.0-SNAPSHOT"
+
 java {
     sourceCompatibility = JavaVersion.VERSION_11
     targetCompatibility = JavaVersion.VERSION_11
-    withSourcesJar()
-    withJavadocJar()
 }
 
-tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
-    kotlinOptions {
-        jvmTarget = "11"
+tasks.withType<KotlinCompile> {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
     }
 }
 
-testing {
-    suites {
-        val test by getting(JvmTestSuite::class) {
-            useKotlinTest("1.9.23")
-        }
-    }
-}
+tasks.test {
+    useJUnitPlatform()
 
-tasks.withType<Test> {
     testLogging {
-        events(PASSED, SKIPPED, FAILED, STANDARD_OUT, STANDARD_ERROR)
-        exceptionFormat = FULL
+        events(TestLogEvent.PASSED, TestLogEvent.SKIPPED, TestLogEvent.FAILED, TestLogEvent.STANDARD_OUT)
+        exceptionFormat = TestExceptionFormat.FULL
         showExceptions = true
         showStackTraces = true
         showCauses = true
     }
 }
 
 dependencies {
-    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1")
+    // JNA
     implementation("net.java.dev.jna:jna:5.14.0")
+
+    // Coroutines
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1")
+
+    // Tests
+    testImplementation(kotlin("test"))
+    testImplementation("org.kotlinbitcointools:regtest-toolbox:0.1.0")
 }
 
-afterEvaluate {
-    publishing {
-        publications {
-            create<MavenPublication>("maven") {
-                groupId = "org.bitcoindevkit"
-                artifactId = "bdk-jvm"
-                version = libraryVersion
+mavenPublishing {
+    coordinates(
+        groupId = group.toString(),
+        artifactId = "bdk-jvm",
+        version = version.toString()
+    )
 
-                from(components["java"])
-                pom {
-                    name.set("bdk-jvm")
-                    description.set("Bitcoin Dev Kit Kotlin language bindings.")
-                    url.set("https://bitcoindevkit.org")
-                    licenses {
-                        license {
-                            name.set("APACHE 2.0")
-                            url.set("https://github.com/bitcoindevkit/bdk/blob/master/LICENSE-APACHE")
-                        }
-                        license {
-                            name.set("MIT")
-                            url.set("https://github.com/bitcoindevkit/bdk/blob/master/LICENSE-MIT")
-                        }
-                    }
-                    developers {
-                        developer {
-                            id.set("bdkdevelopers")
-                            name.set("Bitcoin Dev Kit Developers")
-                            email.set("dev@bitcoindevkit.org")
-                        }
-                    }
-                    scm {
-                        connection.set("scm:git:github.com/bitcoindevkit/bdk-ffi.git")
-                        developerConnection.set("scm:git:ssh://github.com/bitcoindevkit/bdk-ffi.git")
-                        url.set("https://github.com/bitcoindevkit/bdk-ffi/tree/master")
-                    }
-                }
+    pom {
+        name.set("bdk-jvm")
+        description.set("Bitcoin Dev Kit Kotlin language bindings.")
+        url.set("https://bitcoindevkit.org")
+        inceptionYear.set("2021")
+        licenses {
+            license {
+                name.set("APACHE 2.0")
+                url.set("https://github.com/bitcoindevkit/bdk/blob/master/LICENSE-APACHE")
+            }
+            license {
+                name.set("MIT")
+                url.set("https://github.com/bitcoindevkit/bdk/blob/master/LICENSE-MIT")
+            }
+        }
+        developers {
+            developer {
+                id.set("bdkdevelopers")
+                name.set("Bitcoin Dev Kit Developers")
+                email.set("dev@bitcoindevkit.org")
             }
         }
+        scm {
+            url.set("https://github.com/bitcoindevkit/bdk-ffi/")
+            connection.set("scm:git:github.com/bitcoindevkit/bdk-ffi.git")
+            developerConnection.set("scm:git:ssh://github.com/bitcoindevkit/bdk-ffi.git")
+        }
     }
-}
 
-signing {
-    if (project.hasProperty("localBuild")) {
-        isRequired = false
-    }
-    sign(publishing.publications)
+    configure(
+        KotlinJvm(
+            javadocJar = JavadocJar.Dokka("dokkaGeneratePublicationHtml"),
+            sourcesJar = SourcesJar.Sources(),
+        )
+    )
+
+    publishToMavenCentral()
+    signAllPublications()
 }
 
 dokka {
     moduleName.set("bdk-jvm")
-    moduleVersion.set(libraryVersion)
+    moduleVersion.set(version.toString())
     dokkaSourceSets.main {
-        includes.from("README.md")
+        includes.from("../docs/DOKKA_LANDING.md")
         sourceLink {
             localDirectory.set(file("src/main/kotlin"))
             remoteUrl("https://bitcoindevkit.org/")