Merge release/core-v0.6.1 into main (#237)

* Add the uma-configuration file to the demo VASP

* adding sending / receiving vasp methods for demo

* change path for requesting invoice

* adding basic receiver vasp methods

* remove duplicate code for create invoices

* change to fetching well known configuration from sending vasp

* revert to previous endpoint

* adding sender vasp demo endpoints

* nits and such

* moving parameter to json body

* Update SendingVasp.kt

* ms -> s

* Add explicit timeouts to the Requester

* Create SECURITY.md

* Regenerating SDKs following introspection of schemas.

* Bump ci runners to macos-13. (#214)

* Expose idempotency keys for operations which allow them. (#212)

* Add the outgoing_payment_for_idempotency_key query. (#213)

* Merge release/lightspark-sdk-v0.19.0 into develop (#215)

This PR was automatically created by the release branch cut
workflow.\nSDK=lightspark-sdk\nVERSION=0.19.0

Co-authored-by: runner <runner@Mac-1739391984425.local>

* Remove an extra param for outgoing_payment_for_idempotency_key (#219)

This was accidental copy-pasta.

* Bump lightspark-sdk to version 0.19.1

* Fix non uma lnurl path (#224)

* Bump sdk version, use standard errors in UMA demo vasp (#226)

* Added paymentHash and preimageNonce params to createInvoice, createLnurlInvoice, and createUmaInvoice and their respective mutations from all 3 clients.

* Added releasePaymentPreimage functions to all 3 kotlin clients

* Update Gradle version

* Fix misnamed buckets ldev.web-dev -> lsdev.web-dev

* Rename to lightspark-dev-web.web-dev

* Switch to CENTRAL_PORTAL for maven publishing (#235)

* Bump core to version 0.6.1

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jeremy Klein <jklein24@gmail.com>
Co-authored-by: Matt Davis <mrdavis@lightspark.com>
Co-authored-by: Matt Davis <matthappens@gmail.com>
Co-authored-by: Joel Weinberger <jww@lightspark.com>
Co-authored-by: Jason Wang <jason@lightspark.com>
Co-authored-by: Jason Wang <jasoncwangai@gmail.com>
Co-authored-by: runner <runner@Mac-1739391984425.local>
Co-authored-by: runner <runner@Mac-1739478597077.local>
Co-authored-by: Shreya Vissamsetti <shreya@lightspark.com>
Co-authored-by: Aaryaman Bhute <aaryaman@lightspark.com>
Co-authored-by: Aaryaman Bhute <35084309+AaryamanBhute@users.noreply.github.com>
Co-authored-by: Alex Weil <alexweil@lightspark.com>
Co-authored-by: Alex Weil <alexjweil@users.noreply.github.com>
Co-authored-by: runner <runner@Mac-1750470216285.local>

Author: 11 people

androidwalletdemo/build.gradle.kts

@@ -2,7 +2,6 @@ import com.android.build.gradle.internal.cxx.configure.gradleLocalProperties
 import java.io.FileInputStream
 import java.util.*
 
-@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
     id(libs.plugins.androidApplication.get().pluginId)
     kotlin("android")
@@ -20,7 +19,7 @@ try {
 
 val isCI: Boolean = System.getenv("CI") == "true"
 val jwtServerUrl: String = if (isCI) "" else
-    gradleLocalProperties(rootDir).getProperty("jwtServerUrl")
+    gradleLocalProperties(rootDir, providers).getProperty("jwtServerUrl")
         ?: throw Error("You must set the jwtServerUrl property in a local.properties file")
 
 android {

build.gradle.kts

@@ -83,7 +83,7 @@ subprojects {
 
     plugins.withId("com.vanniktech.maven.publish.base") {
         configure<MavenPublishBaseExtension> {
-            publishToMavenCentral(SonatypeHost.S01, automaticRelease = true)
+            publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL, automaticRelease = true)
             signAllPublications()
             pom {
                 name.set(project.name)
@@ -147,6 +147,7 @@ subprojects {
 
     if (project.name !in DEMO_APPS) {
         apply(plugin = "org.jetbrains.kotlin.multiplatform")
+        apply(plugin = "com.android.library")
         configure<KotlinMultiplatformExtension> {
             jvmToolchain(11)
             androidTarget {

core/build.gradle.kts

@@ -1,7 +1,6 @@
 import com.codingfeline.buildkonfig.compiler.FieldSpec.Type.STRING
 import com.mgd.core.gradle.S3Upload
 
-@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
     kotlin("multiplatform")
     alias(libs.plugins.kotlinSerialization)
@@ -127,14 +126,14 @@ tasks.register<Copy>("generateSdkDocs") {
 }
 
 s3 {
-    bucket = "lsdev.web-dev"
+    bucket = "lightspark-dev-web"
     region = "us-west-2"
 }
 
 tasks.register<S3Upload>("uploadDocsToS3") {
     group = "documentation"
     dependsOn("generateSdkDocs")
-    bucket = "ldev.web-dev"
+    bucket = "lightspark-dev-web"
     keyPrefix = "docs/kotlin"
     sourceDir = "docs/html"
 }

core/gradle.properties

@@ -1,7 +1,7 @@
 GROUP=com.lightspark
 POM_ARTIFACT_ID=lightspark-core
 # Don't bump this manually. Run `scripts/versions.main.kt <new_version>` to bump the version instead.
-VERSION_NAME=0.6.0
+VERSION_NAME=0.6.1
 
 POM_DESCRIPTION=The Lightspark shared utilities library for Kotlin and Java.
 POM_INCEPTION_YEAR=2023

crypto/build.gradle.kts

@@ -1,7 +1,6 @@
 import com.codingfeline.buildkonfig.compiler.FieldSpec.Type.STRING
 import de.undercouch.gradle.tasks.download.Download
 
-@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
     kotlin("multiplatform")
     id(libs.plugins.androidLibrary.get().pluginId)

gradle/libs.versions.toml

@@ -1,7 +1,7 @@
 [versions]
 # Core SDK deps (or common):
 acinqSecp256k1 = "0.10.1"
-androidGradlePlugin = "8.1.2"
+androidGradlePlugin = "8.10.0"
 appAuth = "0.11.1"
 buildKonfig = "0.13.3"
 dataStore = "1.0.0"
@@ -12,17 +12,17 @@ gradleS3 = "1.2.1"
 jna = "5.13.0"
 kase64 = "1.0.6"
 kotest = "5.5.4"
-kotlin = "1.9.0"
+kotlin = "1.9.20"
 kotlinCompilerExtension = "1.4.0"
 kotlinCoroutines = "1.7.2"
 kotlinxDateTime = "0.4.0"
 kotlinSerializationJson = "1.4.1"
 ktlint = "11.3.1"
 ktor = "2.3.7"
-lightsparkCore = "0.6.0"
+lightsparkCore = "0.6.1"
 lightsparkCrypto = "0.6.0"
-uma = "1.3.0"
-mavenPublish = "0.25.2"
+uma = "1.5.0"
+mavenPublish = "0.32.0"
 mockitoCore = "5.5.0"
 taskTree = "2.1.1"
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Thu Feb 02 10:27:20 PST 2023
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

lightspark-sdk/build.gradle.kts

@@ -1,7 +1,6 @@
 import com.codingfeline.buildkonfig.compiler.FieldSpec.Type.STRING
 import com.mgd.core.gradle.S3Upload
 
-@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
     kotlin("multiplatform")
     alias(libs.plugins.kotlinSerialization)
@@ -137,14 +136,14 @@ tasks.register<Copy>("generateSdkDocs") {
 }
 
 s3 {
-    bucket = "lsdev.web-dev"
+    bucket = "lightspark-dev-web"
     region = "us-west-2"
 }
 
 tasks.register<S3Upload>("uploadDocsToS3") {
     group = "documentation"
     dependsOn("generateSdkDocs")
-    bucket = "ldev.web-dev"
+    bucket = "lightspark-dev-web"
     keyPrefix = "docs/kotlin"
     sourceDir = "docs/html"
 }

lightspark-sdk/src/commonJvmAndroidMain/kotlin/com/lightspark/sdk/LightsparkFuturesClient.kt

@@ -21,6 +21,7 @@ import com.lightspark.sdk.model.InvoiceType
 import com.lightspark.sdk.model.OutgoingPayment
 import com.lightspark.sdk.model.PaymentDirection
 import com.lightspark.sdk.model.RegionCode
+import com.lightspark.sdk.model.ReleasePaymentPreimageOutput
 import com.lightspark.sdk.model.RiskRating
 import com.lightspark.sdk.model.TransactionStatus
 import com.lightspark.sdk.model.UmaInvitation
@@ -116,6 +117,23 @@ class LightsparkFuturesClient(config: ClientConfig) {
     ): CompletableFuture<WalletDashboard?> =
         coroutineScope.future { coroutinesClient.getSingleNodeDashboard(nodeId, numTransactions, bitcoinNetwork) }
 
+    /**
+     * Marks a payment preimage as released. To be used when the recipient has received the payment.
+     *
+     * @param invoiceId The invoice the preimage belongs to.
+     * @param paymentPreimage The preimage to release.
+     */
+    fun releasePaymentPreimage(
+        invoiceId: String,
+        paymentPreimage: String
+    ): CompletableFuture<ReleasePaymentPreimageOutput?> =
+        coroutineScope.future {
+            coroutinesClient.releasePaymentPreimage(
+                invoiceId,
+                paymentPreimage
+            )
+        }
+
     /**
      * Creates a lightning invoice for the given node.
      *
@@ -126,6 +144,8 @@ class LightsparkFuturesClient(config: ClientConfig) {
      * @param memo Optional memo to include in the invoice.
      * @param type The type of invoice to create. Defaults to [InvoiceType.STANDARD].
      * @param expirySecs The number of seconds until the invoice expires. Defaults to 1 day.
+     * @param paymentHash Optional payment hash to include in the invoice.
+     * @param preimageNonce Optional preimage nonce to include in the invoice.
      */
     @JvmOverloads
     fun createInvoice(
@@ -134,8 +154,20 @@ class LightsparkFuturesClient(config: ClientConfig) {
         memo: String? = null,
         type: InvoiceType = InvoiceType.STANDARD,
         expirySecs: Int? = null,
+        paymentHash: String? = null,
+        preimageNonce: String? = null,
     ): CompletableFuture<Invoice> =
-        coroutineScope.future { coroutinesClient.createInvoice(nodeId, amountMsats, memo, type, expirySecs) }
+        coroutineScope.future {
+            coroutinesClient.createInvoice(
+                nodeId,
+                amountMsats,
+                memo,
+                type,
+                expirySecs,
+                paymentHash,
+                preimageNonce,
+            )
+        }
 
     /**
      * Creates a Lightning invoice for the given node. This should only be used for generating invoices for LNURLs, with
@@ -146,20 +178,26 @@ class LightsparkFuturesClient(config: ClientConfig) {
      * @param metadata The LNURL metadata payload field from the initial payreq response. This will be hashed and
      *      present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11 invoice.
      * @param expirySecs The number of seconds until the invoice expires. Defaults to 1 day.
+     * @param paymentHash Optional payment hash to include in the invoice.
+     * @param preimageNonce Optional preimage nonce to include in the invoice.
      */
     @JvmOverloads
     fun createLnurlInvoice(
         nodeId: String,
         amountMsats: Long,
         metadata: String,
         expirySecs: Int? = null,
+        paymentHash: String? = null,
+        preimageNonce: String? = null,
     ): CompletableFuture<Invoice> =
         coroutineScope.future {
             coroutinesClient.createLnurlInvoice(
                 nodeId,
                 amountMsats,
                 metadata,
                 expirySecs,
+                paymentHash,
+                preimageNonce,
             )
         }
 
@@ -175,6 +213,8 @@ class LightsparkFuturesClient(config: ClientConfig) {
      * @param signingPrivateKey The receiver's signing private key. Used to hash the receiver identifier.
      * @param receiverIdentifier Optional identifier of the receiver. If provided, this will be hashed using a
      *      monthly-rotated seed and used for anonymized analysis.
+     * @param paymentHash Optional payment hash to include in the invoice.
+     * @param preimageNonce Optional preimage nonce to include in the invoice.
      */
     @JvmOverloads
     @Throws(IllegalArgumentException::class)
@@ -185,6 +225,8 @@ class LightsparkFuturesClient(config: ClientConfig) {
         expirySecs: Int? = null,
         signingPrivateKey: ByteArray? = null,
         receiverIdentifier: String? = null,
+        paymentHash: String? = null,
+        preimageNonce: String? = null,
     ): CompletableFuture<Invoice> =
         coroutineScope.future {
             coroutinesClient.createUmaInvoice(
@@ -194,6 +236,8 @@ class LightsparkFuturesClient(config: ClientConfig) {
                 expirySecs,
                 signingPrivateKey,
                 receiverIdentifier,
+                paymentHash,
+                preimageNonce,
             )
         }
 

lightspark-sdk/src/commonMain/kotlin/com/lightspark/sdk/LightsparkCoroutinesClient.kt

@@ -172,6 +172,30 @@ class LightsparkCoroutinesClient private constructor(
         )
     }
 
+    /**
+     * Marks a payment preimage as released. To be used when the recipient has received the payment.
+     *
+     * @param invoiceId The invoice the preimage belongs to.
+     * @param paymentPreimage The preimage to release.
+     */
+    suspend fun releasePaymentPreimage(invoiceId: String, paymentPreimage: String): ReleasePaymentPreimageOutput {
+        requireValidAuth()
+
+        return executeQuery(
+            Query(
+                ReleasePaymentPreimageMutation,
+                {
+                    add("invoice_id", invoiceId)
+                    add("payment_preimage", paymentPreimage)
+                },
+            ) {
+                val releasePaymentPreimageJson =
+                    requireNotNull(it["release_payment_preimage"]) { "Invalid response for payment preimage release" }
+                serializerFormat.decodeFromJsonElement<ReleasePaymentPreimageOutput>(releasePaymentPreimageJson)
+            },
+        )
+    }
+
     /**
      * Creates a lightning invoice for the given node.
      *
@@ -182,13 +206,17 @@ class LightsparkCoroutinesClient private constructor(
      * @param memo Optional memo to include in the invoice.
      * @param type The type of invoice to create. Defaults to [InvoiceType.STANDARD].
      * @param expirySecs The number of seconds until the invoice expires. Defaults to 1 day.
+     * @param paymentHash Optional payment hash to include in the invoice.
+     * @param preimageNonce Optional preimage nonce to include in the invoice.
      */
     suspend fun createInvoice(
         nodeId: String,
         amountMsats: Long,
         memo: String? = null,
         type: InvoiceType = InvoiceType.STANDARD,
         expirySecs: Int? = null,
+        paymentHash: String? = null,
+        preimageNonce: String? = null,
     ): Invoice {
         requireValidAuth()
         return executeQuery(
@@ -200,6 +228,8 @@ class LightsparkCoroutinesClient private constructor(
                     memo?.let { add("memo", memo) }
                     add("type", serializerFormat.encodeToJsonElement(type))
                     expirySecs?.let { add("expirySecs", expirySecs) }
+                    paymentHash?.let { add("paymentHash", paymentHash) }
+                    preimageNonce?.let { add("preimageNonce", preimageNonce) }
                 },
             ) {
                 val invoiceJson =
@@ -220,12 +250,16 @@ class LightsparkCoroutinesClient private constructor(
      * @param metadata The LNURL metadata payload field from the initial payreq response. This will be hashed and
      *      present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11 invoice.
      * @param expirySecs The number of seconds until the invoice expires. Defaults to 1 day.
+     * @param paymentHash Optional payment hash to include in the invoice.
+     * @param preimageNonce Optional preimage nonce to include in the invoice.
      */
     suspend fun createLnurlInvoice(
         nodeId: String,
         amountMsats: Long,
         metadata: String,
         expirySecs: Int? = null,
+        paymentHash: String? = null,
+        preimageNonce: String? = null,
     ): Invoice {
         requireValidAuth()
 
@@ -241,6 +275,8 @@ class LightsparkCoroutinesClient private constructor(
                     add("amountMsats", amountMsats)
                     add("metadataHash", metadataHash)
                     expirySecs?.let { add("expirySecs", expirySecs) }
+                    paymentHash?.let { add("paymentHash", paymentHash) }
+                    preimageNonce?.let { add("preimageNonce", preimageNonce) }
                 },
             ) {
                 val invoiceJson =
@@ -264,6 +300,8 @@ class LightsparkCoroutinesClient private constructor(
      * @param signingPrivateKey The receiver's signing private key. Used to hash the receiver identifier.
      * @param receiverIdentifier Optional identifier of the receiver. If provided, this will be hashed using a
      *      monthly-rotated seed and used for anonymized analysis.
+     * @param paymentHash Optional payment hash to include in the invoice.
+     * @param preimageNonce Optional preimage nonce to include in the invoice.
      */
     @Throws(IllegalArgumentException::class)
     suspend fun createUmaInvoice(
@@ -273,6 +311,8 @@ class LightsparkCoroutinesClient private constructor(
         expirySecs: Int? = null,
         signingPrivateKey: ByteArray? = null,
         receiverIdentifier: String? = null,
+        paymentHash: String? = null,
+        preimageNonce: String? = null,
     ): Invoice {
         requireValidAuth()
 
@@ -296,6 +336,8 @@ class LightsparkCoroutinesClient private constructor(
                     add("metadataHash", metadataHash)
                     expirySecs?.let { add("expirySecs", expirySecs) }
                     receiverHash?.let { add("receiverHash", receiverHash) }
+                    paymentHash?.let { add("paymentHash", paymentHash) }
+                    preimageNonce?.let { add("preimageNonce", preimageNonce) }
                 },
             ) {
                 val invoiceJson =