Files
amethyst/quartz/build.gradle.kts
T
davotoula e8e2f8d6d5 ci: keep the iOS jobs under their timeout by fixing what made them slow
test-quartz-ios hit its 45-minute limit on every run that had to rebuild
:quartz; the green runs before were Gradle build-cache hits on an unchanged
:quartz (2.5 min instead of 19). Measured on the failing run and locally:

- :quartz linked its iOS test binary optimized (LTO release link, native
  dependency cache off): 12 min on the 3-core macOS runner, 155 s on an M5
  Pro, 105 s of that in LLVM. The -opt only exists for Secp256k1NativeBenchmark,
  so the benchmark moves from nativeTest to linuxTest and only linuxX64 keeps
  the optimized test binary. The unoptimized iOS link takes 36 s and the suite
  runs in ~90 s instead of ~25 s: a net win everywhere.
- gradle.properties asks for a 6 GB daemon heap on a 7 GB runner. The JVM
  compile and link tasks ran 4-5x slower on CI than locally while the test
  binaries themselves ran 1.4x slower, which points at swapping. The heaviest
  task (:commonsUI:compileKotlinIosSimulatorArm64) fails under 3 GB and runs
  at full speed with 4 GB, so both iOS jobs cap the daemon at 4 GB with the
  same -D override the Android jobs use.
- ~/.konan was never cached on macOS, so each run re-downloaded the compiler
  and LLVM and rebuilt every per-library native cache. Same actions/cache step
  as the Linux native job, keyed per job.
- :commonsUI disabled the native cache for its test binaries to dodge a
  UIViewLayoutRegion link error under Xcode 16.4. CI and dev machines are on
  Xcode 26.6 now, where the cached object links fine; with the cache on and
  ~/.konan warm the link drops from 88 s to 60 s locally.
- The job is split in two (quartz / commons+commonsUI) so the halves run in
  parallel, and each gets a JUnit report step like the other test jobs.

Verified locally with the exact CI commands under -Xmx4g: quartz step 153 s
(5870 tests, 0 failures, benchmark gone), commons step 267 s (2212 + 87
tests, 0 failures), spotlessCheck clean, actionlint clean.
2026-10-13 17:02:18 +01:00

453 lines
16 KiB
Kotlin
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import com.vanniktech.maven.publish.KotlinMultiplatform
import com.vanniktech.maven.publish.SourcesJar
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest
plugins {
alias(libs.plugins.kotlinMultiplatform)
alias(libs.plugins.androidKotlinMultiplatformLibrary)
alias(libs.plugins.serialization)
alias(libs.plugins.vanniktech.mavenPublish)
}
kotlin {
compilerOptions {
freeCompilerArgs.add("-Xexpect-actual-classes")
}
jvm {
compilerOptions {
jvmTarget.set(JvmTarget.JVM_17)
}
}
android {
namespace = "com.vitorpamplona.quartz"
compileSdk =
libs.versions.android.compileSdk
.get()
.toInt()
minSdk =
libs.versions.android.minSdk
.get()
.toInt()
compilerOptions {
jvmTarget.set(JvmTarget.JVM_17)
}
optimization {
consumerKeepRules.apply {
publish = true
file("consumer-rules.pro")
}
}
withHostTest {}
withDeviceTest {
instrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
}
}
// For iOS targets, this is also where you should
// configure native binary output. For more information, see:
// https://kotlinlang.org/docs/multiplatform-build-native-binaries.html#build-xcframeworks
// A step-by-step guide on how to include this library in an XCode
// project can be found here:
// https://developer.android.com/kotlin/multiplatform/migrate
val xcfName = "quartz-kmpKit"
iosArm64 {
binaries.framework {
baseName = xcfName
isStatic = true
binaryOption("bundleId", "com.vitorpamplona.quartz")
}
}
iosSimulatorArm64 {
binaries.framework {
baseName = xcfName
isStatic = true
binaryOption("bundleId", "com.vitorpamplona.quartz")
}
}
linuxX64()
macosArm64()
// This makes sure that the resource file directory is visible for iOS tests.
val rootDir = "${rootProject.rootDir.path}/quartz/src/commonTest/resources"
tasks.withType<Test>().configureEach {
maxHeapSize = "4g"
environment("TEST_RESOURCES_ROOT", rootDir)
// Opt-in gate for ProductionReceiverBenchmark (opens sockets to live
// relays). `-PprodRelayBench=1` reaches the daemon even when an env
// var would not survive daemon reuse.
(project.findProperty("prodRelayBench") as? String)?.let {
environment("PROD_RELAY_BENCH", it)
}
// Forward the negentropy-benchmark corpus size to the test JVM.
System.getProperty("negBenchN")?.let { systemProperty("negBenchN", it) }
System.getProperty("followBenchScale")?.let { systemProperty("followBenchScale", it) }
System.getProperty("tagBenchScale")?.let { systemProperty("tagBenchScale", it) }
System.getProperty("fsBenchScale")?.let { systemProperty("fsBenchScale", it) }
// Opt-in JFR profiling of a benchmark run (-PnegProfile=/tmp/neg.jfr).
(project.findProperty("negProfile") as? String)?.let {
jvmArgs("-XX:+FlightRecorder", "-XX:StartFlightRecording=filename=$it,settings=profile,dumponexit=true")
}
}
tasks.withType<KotlinNativeTest>().configureEach {
environment("TEST_RESOURCES_ROOT", rootDir)
// This is necessary to have the variable propagated on iOS
environment("SIMCTL_CHILD_TEST_RESOURCES_ROOT", rootDir)
}
// Enable LLVM optimizations for the linuxX64 test binary only: that is where
// Secp256k1NativeBenchmark (src/linuxTest) runs, and a benchmark on an
// unoptimized binary measures nothing (~20× slower code). Use the binary-level
// API instead of the -opt freeCompilerArg to avoid the "Unsupported combination
// of flags: -opt and -g" conflict in Kotlin/Native 2.1+.
//
// The Apple test binaries stay unoptimized on purpose. An optimized link is a
// release-style LTO build with the Kotlin/Native dependency cache disabled: on
// the 3-core GitHub macOS runner it took 12 minutes for the iOS simulator test
// binary (2.5 min here), while the unoptimized link takes 45 s here and the
// test suite minus the benchmark runs in ~90 s instead of ~25 s. Net win on
// every machine, and it is what made the test-quartz-ios job hit its timeout.
targets
.withType<org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget>()
.matching { it.konanTarget.family == org.jetbrains.kotlin.konan.target.Family.LINUX }
.configureEach {
binaries.withType<org.jetbrains.kotlin.gradle.plugin.mpp.TestExecutable>().configureEach {
optimized = true
debuggable = false
}
}
// Source set declarations.
// Declaring a target automatically creates a source set with the same name. By default, the
// Kotlin Gradle Plugin creates additional source sets that depend on each other, since it is
// common to share sources between related targets.
// See: https://kotlinlang.org/docs/multiplatform-hierarchy.html
sourceSets {
commonMain {
dependencies {
implementation(libs.kotlin.stdlib)
implementation(libs.kotlinx.coroutines.core)
// For LruCache
implementation(libs.androidx.collection)
// @Immutable and @Stable
implementation(libs.androidx.compose.runtime.annotation)
// Bitcoin secp256k1 bindings
api(libs.secp256k1.kmp.common)
// Kotlin serialization for the times where we need the Json tree and performance is not that important.
implementation(libs.kotlinx.serialization.json)
// CBOR serialization for the NUT-00 v4 (cashuB) token wire format.
implementation(libs.kotlinx.serialization.cbor)
// immutable collections to avoid recomposition
implementation(libs.kotlinx.collections.immutable)
// SQLite KMP driver for event store
api(libs.androidx.sqlite)
implementation(libs.androidx.sqlite.bundled)
// Negentropy set reconciliation (NIP-77)
api(libs.negentropy.kmp)
implementation("io.github.andreypfau:kotlinx-crypto-hmac:0.0.4")
implementation("io.github.andreypfau:kotlinx-crypto-sha2:0.0.4")
}
}
commonTest {
dependencies {
implementation(libs.kotlin.test)
implementation(libs.kotlinx.coroutines.test)
// SQLite bundled driver for tests
api(libs.androidx.sqlite)
implementation(libs.androidx.sqlite.bundled)
}
}
// Must be defined before androidMain and jvmMain
val jvmAndroid =
create("jvmAndroid") {
dependsOn(commonMain.get())
dependencies {
// Performant Parser of JSONs into Events.
//
// jackson-databind, NOT jackson-module-kotlin: the module exists to bind
// Kotlin classes reflectively off their constructor parameter names, and
// nothing in the app does that any more — every wire format goes through a
// hand-written serializer or kotlinx. Dropping it takes kotlin-reflect with
// it, which is ~1,000 classes of DEX the app never called. `cli` still
// declares the module itself: it genuinely binds its config files
// reflectively, and is never minified.
api(libs.jackson.databind)
// Websockets API
implementation(libs.okhttp)
implementation(libs.okhttpCoroutines)
// Chess engine for move validation and legal move generation
// NOTE: 1.0.4+ uses Java 21's removeLast() which crashes on Android API < 34
// TODO: Test if 1.0.0 works, or fork library to fix
implementation(libs.kchesslib)
}
}
// Must be defined before androidMain and jvmMain
val jvmAndroidTest =
create("jvmAndroidTest") {
dependsOn(commonTest.get())
dependencies {
implementation(libs.kotlin.test)
implementation(libs.kotlinx.coroutines.test)
// In-process Nostr relay (geode) so JVM/Android host
// tests don't need network access or a Rust toolchain.
// testFixtures (RelayClientTest base, fixtures,
// collectUntilEose) are wired below at the top-level
// `dependencies` block — the KMP source-set DSL
// doesn't expose the `testFixtures(...)` consumer.
implementation(project(":geode"))
}
}
jvmMain {
dependsOn(jvmAndroid)
dependencies {
// Bitcoin secp256k1 bindings
implementation(libs.secp256k1.kmp.jni.jvm)
}
}
jvmTest {
dependsOn(jvmAndroidTest)
dependencies {
// Bitcoin secp256k1 bindings
implementation(libs.secp256k1.kmp.jni.jvm)
// Custom C secp256k1 (libschnorr256k1) for cross-validation + 3-way benchmark
implementation(libs.schnorr256k1.kmp)
// SQLite bundled driver for JVM tests
implementation(libs.androidx.sqlite.bundled.jvm)
}
}
androidMain {
dependsOn(jvmAndroid)
dependencies {
implementation(libs.androidx.core.ktx)
// Bitcoin secp256k1 bindings to Android
api(libs.secp256k1.kmp.jni.android)
}
}
getByName("androidHostTest") {
dependencies {
implementation(libs.kotlin.test)
implementation(libs.kotlinx.coroutines.test)
// Bitcoin secp256k1 bindings
implementation(libs.secp256k1.kmp.jni.jvm)
// SQLite bundled driver for Host tests
implementation(libs.androidx.sqlite.bundled.jvm)
}
}
getByName("androidDeviceTest") {
dependencies {
implementation(libs.androidx.runner)
implementation(libs.androidx.core)
implementation(libs.androidx.junit)
implementation(libs.androidx.espresso.core)
implementation(libs.kotlin.test)
implementation(libs.kotlinx.coroutines.test)
// Bitcoin secp256k1 bindings to Android
api(libs.secp256k1.kmp.jni.android)
// Custom C secp256k1 (libschnorr256k1) for cross-validation + 3-way benchmark
implementation(libs.schnorr256k1.kmp)
}
}
// Must be defined before appleMain, linuxMain, etc.
val nativeMain =
create("nativeMain") {
dependsOn(commonMain.get())
dependencies {
// cryptography-kotlin: the AES ciphers and digests of every native target.
implementation(libs.dev.whyoleg.cryptography.provider.optimal)
}
}
val nativeTest =
create("nativeTest") {
dependsOn(commonTest.get())
}
// Must be defined before iosMain and macosMain
val appleMain =
create("appleMain") {
dependsOn(nativeMain)
}
val appleTest =
create("appleTest") {
dependsOn(nativeTest)
}
iosMain {
dependsOn(appleMain)
}
getByName("iosArm64Main") {
dependsOn(iosMain.get())
}
getByName("iosSimulatorArm64Main") {
dependsOn(iosMain.get())
}
iosTest {
dependsOn(appleTest)
}
getByName("iosArm64Test") {
dependsOn(iosTest.get())
}
getByName("iosSimulatorArm64Test") {
dependsOn(iosTest.get())
}
val macosMain =
create("macosMain") {
dependsOn(appleMain)
}
val macosTest =
create("macosTest") {
dependsOn(appleTest)
}
getByName("macosArm64Main") {
dependsOn(macosMain)
}
getByName("macosArm64Test") {
dependsOn(macosTest)
}
val linuxMain =
create("linuxMain") {
dependsOn(nativeMain)
}
val linuxTest =
create("linuxTest") {
dependsOn(nativeTest)
}
getByName("linuxX64Main") {
dependsOn(linuxMain)
}
getByName("linuxX64Test") {
dependsOn(linuxTest)
}
}
}
// testFixtures(...) consumer lives outside the KMP source-set DSL —
// the KMP source-set `dependencies { }` block uses
// `KotlinDependencyHandler`, which does not expose the
// `testFixtures(...)` projection. The standard Gradle dependency
// configuration name (`jvmAndroidTestImplementation`) does work here.
dependencies {
"jvmAndroidTestImplementation"(testFixtures(project(":geode")))
}
// iOS purity gate. Jackson and OkHttp are JVM-only and must never appear
// in source sets that compile for iOS / native / common targets. The KMP
// build would eventually fail with an "unresolved reference" if these
// leaked in, but that requires a macOS runner. This task is a fast Linux
// linter that fails with a clear message before iOS CI ever spins up.
//
// Scope: source sets whose code is compiled for at least one non-JVM
// target. Excludes jvmAndroid, jvmMain, androidMain (and their tests),
// where Jackson and OkHttp are legitimately used.
//
// The task itself is shared with :commons and :commonsUI — see
// gradle/kmp-purity.gradle.kts for the pattern table and checked dirs.
apply(from = rootProject.file("gradle/kmp-purity.gradle.kts"))
mavenPublishing {
// sources publishing is always enabled by the Kotlin Multiplatform plugin
configure(
KotlinMultiplatform(
// whether to publish a sources jar
sourcesJar = SourcesJar.Sources(),
),
)
coordinates(
groupId = "com.vitorpamplona.quartz",
artifactId = "quartz",
// Library version tracks the app version in gradle/libs.versions.toml,
// bumped in lockstep with each release.
version = libs.versions.app.get(),
)
// Configure publishing to Maven Central
publishToMavenCentral(automaticRelease = true)
// Enable GPG signing for all publications
signAllPublications()
pom {
name = "Quartz: Nostr Library for Kotlin Multiplatform"
description = "Nostr library ported to Kotlin/Multiplatform for JVM, Android, iOS & Linux"
inceptionYear = "2025"
url = "https://github.com/vitorpamplona/amethyst/"
licenses {
license {
name = "MIT License"
url = "https://github.com/vitorpamplona/amethyst/blob/main/LICENSE"
}
}
developers {
developer {
id = "vitorpamplona"
name = "Vitor Pamplona"
url = "http://vitorpamplona.com"
email = "vitor@vitorpamplona.com"
}
}
scm {
url = "https://github.com/vitorpamplona/amethyst/"
connection = "https://github.com/vitorpamplona/amethyst/.git"
}
}
}