Use lightning address for receiving

Author: ekzyis

prisma/migrations/20250923052230_spark/migration.sql

@@ -4,14 +4,11 @@ ALTER TYPE "WalletName" ADD VALUE 'SPARK'; COMMIT;
 -- AlterEnum
 ALTER TYPE "WalletProtocolName" ADD VALUE 'SPARK'; COMMIT;
 
--- AlterEnum
-ALTER TYPE "WalletRecvProtocolName" ADD VALUE 'SPARK'; COMMIT;
-
 -- AlterEnum
 ALTER TYPE "WalletSendProtocolName" ADD VALUE 'SPARK'; COMMIT;
 
 INSERT INTO "WalletTemplate" ("name", "sendProtocols", "recvProtocols")
-VALUES ('SPARK', '{SPARK}', '{SPARK}');
+VALUES ('SPARK', '{SPARK}', '{LN_ADDR}');
 
 -- CreateTable
 CREATE TABLE "WalletSendSpark" (
@@ -24,35 +21,18 @@ CREATE TABLE "WalletSendSpark" (
     CONSTRAINT "WalletSendSpark_pkey" PRIMARY KEY ("id")
 );
 
--- CreateTable
-CREATE TABLE "WalletRecvSpark" (
-    "id" SERIAL NOT NULL,
-    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    "protocolId" INTEGER NOT NULL,
-    "address" TEXT NOT NULL,
-
-    CONSTRAINT "WalletRecvSpark_pkey" PRIMARY KEY ("id")
-);
-
 -- CreateIndex
 CREATE UNIQUE INDEX "WalletSendSpark_protocolId_key" ON "WalletSendSpark"("protocolId");
 
 -- CreateIndex
 CREATE UNIQUE INDEX "WalletSendSpark_mnemonicVaultId_key" ON "WalletSendSpark"("mnemonicVaultId");
 
--- CreateIndex
-CREATE UNIQUE INDEX "WalletRecvSpark_protocolId_key" ON "WalletRecvSpark"("protocolId");
-
 -- AddForeignKey
 ALTER TABLE "WalletSendSpark" ADD CONSTRAINT "WalletSendSpark_protocolId_fkey" FOREIGN KEY ("protocolId") REFERENCES "WalletProtocol"("id") ON DELETE CASCADE ON UPDATE CASCADE;
 
 -- AddForeignKey
 ALTER TABLE "WalletSendSpark" ADD CONSTRAINT "WalletSendSpark_mnemonicVaultId_fkey" FOREIGN KEY ("mnemonicVaultId") REFERENCES "Vault"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
 
--- AddForeignKey
-ALTER TABLE "WalletRecvSpark" ADD CONSTRAINT "WalletRecvSpark_protocolId_fkey" FOREIGN KEY ("protocolId") REFERENCES "WalletProtocol"("id") ON DELETE CASCADE ON UPDATE CASCADE;
-
 CREATE TRIGGER wallet_to_jsonb
     AFTER INSERT OR UPDATE ON "WalletSendSpark"
     FOR EACH ROW

prisma/schema.prisma

@@ -1241,7 +1241,6 @@ enum WalletRecvProtocolName {
   CLN_REST
   LND_GRPC
   CLINK
-  SPARK
 }
 
 enum WalletProtocolStatus {
@@ -1346,7 +1345,6 @@ model WalletProtocol {
   walletRecvCLNRest          WalletRecvCLNRest?
   walletRecvLNDGRPC          WalletRecvLNDGRPC?
   walletRecvClink            WalletRecvClink?
-  walletRecvSpark            WalletRecvSpark?
 
   @@unique(name: "WalletProtocol_walletId_send_name_key", [walletId, send, name])
   @@index([walletId])
@@ -1530,12 +1528,3 @@ model WalletRecvClink {
   protocol   WalletProtocol @relation(fields: [protocolId], references: [id], onDelete: Cascade)
   noffer     String
 }
-
-model WalletRecvSpark {
-  id         Int            @id @default(autoincrement())
-  createdAt  DateTime       @default(now()) @map("created_at")
-  updatedAt  DateTime       @default(now()) @updatedAt @map("updated_at")
-  protocolId Int            @unique
-  protocol   WalletProtocol @relation(fields: [protocolId], references: [id], onDelete: Cascade)
-  address    String
-}

wallets/client/components/form/hooks.js

@@ -84,8 +84,11 @@ function useProtocolFormState (protocol) {
 
 export function useProtocolForm (protocol) {
   const [formState, setFormState] = useProtocolFormState(protocol)
+
   const [complementaryFormState] = useProtocolFormState({ name: protocol.name, send: !protocol.send })
   const [nwcSendFormState] = useProtocolFormState({ name: 'NWC', send: true })
+  const [sparkSendFormState] = useProtocolFormState({ name: 'SPARK', send: true })
+
   const wallet = useWallet()
   const lud16Domain = walletLud16Domain(wallet.name)
   const fields = protocolFields(protocol)
@@ -103,10 +106,13 @@ export function useProtocolForm (protocol) {
     }
 
     if (protocol.name === 'LN_ADDR' && field.name === 'address' && lud16Domain) {
-      // automatically set lightning addresses from NWC urls if lud16 parameter is present
       if (nwcSendFormState?.config?.url) {
+        // automatically set lightning addresses from NWC urls if lud16 parameter is present ...
         const { lud16 } = parseNwcUrl(nwcSendFormState.config.url)
         if (lud16?.split('@')[1] === lud16Domain) value = lud16
+      } else if (sparkSendFormState?.config?.username) {
+        // ... or from spark usernames
+        value = `${sparkSendFormState.config.username}@${lud16Domain}`
       }
       // remove domain part since we will append it automatically if lud16Domain is set
       if (lud16Domain && value) {

wallets/client/protocols/spark.js

@@ -1,4 +1,6 @@
 import init, { defaultConfig, connect } from '@breeztech/breez-sdk-spark'
+import { WalletValidationError } from '@/wallets/client/errors'
+import { getUsername } from '@/wallets/lib/protocols/spark'
 
 export const name = 'SPARK'
 
@@ -23,5 +25,22 @@ export async function testSendPayment ({ mnemonic }, { signal }) {
 
   await sdk.getInfo({})
 
+  const { paymentRequest: sparkAddress } = await sdk.receivePayment({
+    // this will always return the same spark address for the same seed
+    paymentMethod: { type: 'sparkAddress' }
+  })
+
+  // check and register lightning address here so we can test it in the next step
+  // https://sdk-doc-spark.breez.technology/guide/receive_lnurl_pay.html
+  const username = getUsername(sparkAddress)
+  const available = await sdk.checkLightningAddressAvailable({ username })
+  if (!available) {
+    // TODO: better error message for user? but this should never happen with randomly generated mnemonics, right?
+    throw new WalletValidationError('lightning address unavailable')
+  }
+  await sdk.registerLightningAddress({ username, description: 'Running Spark SDK' })
+
   sdk.disconnect()
+
+  return { username }
 }

wallets/lib/protocols/index.js

@@ -8,7 +8,7 @@ import phoenixdSuite from './phoenixd'
 import blinkSuite from './blink'
 import webln from './webln'
 import clinkSuite from './clink'
-import sparkSuite from './spark'
+import spark from './spark'
 
 /**
  * Protocol names as used in the database
@@ -51,5 +51,5 @@ export default [
   ...blinkSuite,
   webln,
   ...clinkSuite,
-  ...sparkSuite
+  spark
 ]

wallets/lib/protocols/spark.js

@@ -1,43 +1,43 @@
-import { bip39Validator, externalLightningAddressValidator } from '@/wallets/lib/validate'
+import { bip39Validator } from '@/wallets/lib/validate'
 import { generateRandomPassphrase } from '@/wallets/lib/crypto'
+import { bech32m } from 'bech32'
 
 // Spark
 // https://github.com/breez/spark-sdk
 // https://sdk-doc-spark.breez.technology/
 // https://breez.github.io/spark-sdk/breez_sdk_spark/
 
-export default [
-  {
-    name: 'SPARK',
-    send: true,
-    displayName: 'Spark',
-    fields: [
-      {
-        name: 'mnemonic',
-        label: 'mnemonic',
-        type: 'password',
-        required: true,
-        validate: bip39Validator(),
-        encrypt: true,
-        initial: generateRandomPassphrase,
-        disabled: true
-      }
-    ],
-    relationName: 'walletSendSpark'
-  },
-  {
-    name: 'SPARK',
-    send: false,
-    displayName: 'Spark',
-    fields: [
-      {
-        name: 'address',
-        label: 'address',
-        type: 'text',
-        required: true,
-        validate: externalLightningAddressValidator
-      }
-    ],
-    relationName: 'walletRecvSpark'
-  }
-]
+export default {
+  name: 'SPARK',
+  send: true,
+  displayName: 'Spark',
+  fields: [
+    {
+      name: 'mnemonic',
+      label: 'mnemonic',
+      type: 'password',
+      required: true,
+      validate: bip39Validator(),
+      encrypt: true,
+      initial: generateRandomPassphrase,
+      disabled: true
+    },
+    {
+      name: 'username'
+    }
+  ],
+  relationName: 'walletSendSpark'
+}
+
+function getIdentityPublicKey (sparkAddress) {
+  const decoded = bech32m.decode(sparkAddress)
+  const pubkey = Buffer.from(bech32m.fromWords(decoded.words)).toString('hex').slice(4)
+  return pubkey
+}
+
+export function getUsername (sparkAddress) {
+  const identityPublicKey = getIdentityPublicKey(sparkAddress)
+  // max lnurl username length is 64 characters
+  // https://github.com/breez/spark-sdk/blob/71b8cb097d2bc846be427599b1bf44eae897786f/crates/breez-sdk/lnurl/src/routes.rs#L326
+  return identityPublicKey.slice(0, 64)
+}

wallets/lib/wallets.json

@@ -171,6 +171,9 @@
     },
     {
         "name": "SPARK",
-        "displayName": "Spark"
+        "displayName": "Spark",
+        "url": {
+            "lud16Domain": "breez.tips"
+        }
     }
 ]