Kotlin Multiplatform

We recommend integrating the Breez SDK as Gradle dependency from our Maven repository.

Add the Breez Maven repository to your settings.gradle.kts:

pluginManagement {
    repositories {
        maven("https://mvn.breez.technology/releases")
    }
}

dependencyResolutionManagement {
    repositories {
        maven("https://mvn.breez.technology/releases")
    }
}

Then add the dependency in your module's build.gradle.kts:

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("technology.breez.spark:breez-sdk-spark-kmp:{VERSION}")
        }
    }
}

Integration

iOS

Install the native binary framework via Swift Package Manager. The Gradle plugin automatically configures the framework search path from Xcode's build environment.

Add the Gradle plugin to your module's build.gradle.kts and update the iOS framework binaries to use a dynamic framework:

plugins {
    id("technology.breez.spark.kmp") version "{VERSION}"
}

kotlin {
    listOf(
        iosArm64(),
        iosSimulatorArm64(),
        iosX64(),
    ).forEach {
        it.binaries.framework {
            baseName = "shared"
            isStatic = false
        }
    }
}

macOS

Similarly to iOS:

plugins {
    id("technology.breez.spark.kmp") version "{VERSION}"
}

kotlin {
    listOf(
        macosArm64(),
        macosX64(),
    ).forEach {
        it.binaries.framework {
            baseName = "shared"
            isStatic = false
        }
    }
}

Swift Package Manager

Developer note

breez-sdk-spark-kmp Gradle dependency and the Swift package MUST have the same version. A version mismatch between the two will cause linking or runtime errors.

Installation via Swift Package Manifest

Add the following to the dependencies array of your Package.swift:

.package(url: "https://github.com/breez/breez-sdk-spark-swift.git", from: "{VERSION}"),

If the automatic framework detection doesn't work for your setup, you can override it by setting the breezSdkSparkFrameworkPath project property to the directory containing breez_sdk_sparkFFI.framework.

In gradle.properties:

breezSdkSparkFrameworkPath=/path/to/framework/dir

Or via the command line:

./gradlew build -PbreezSdkSparkFrameworkPath=/path/to/framework/dir

Example App

For a full working example app, see the Kotlin Multiplatform CLI example app.

Breez SDK - Spark