@breeztech/breez-sdk-spark 0.7.19 → 0.8.0-dev1

package/nodejs/storage/index.cjs

@@ -27,6 +27,47 @@ try {
 const { StorageError } = require("./errors.cjs");
 const { MigrationManager } = require("./migrations.cjs");
 
+/**
+ * Base query for payment lookups.
+ * All columns are accessed by name in _rowToPayment.
+ * parent_payment_id is only used by getPaymentsByParentIds.
+ */
+const SELECT_PAYMENT_SQL = `
+    SELECT p.id,
+           p.payment_type,
+           p.status,
+           p.amount,
+           p.fees,
+           p.timestamp,
+           p.method,
+           p.withdraw_tx_id,
+           p.deposit_tx_id,
+           p.spark,
+           l.invoice AS lightning_invoice,
+           l.payment_hash AS lightning_payment_hash,
+           l.destination_pubkey AS lightning_destination_pubkey,
+           COALESCE(l.description, pm.lnurl_description) AS lightning_description,
+           l.preimage AS lightning_preimage,
+           pm.lnurl_pay_info,
+           pm.lnurl_withdraw_info,
+           pm.conversion_info,
+           t.metadata AS token_metadata,
+           t.tx_hash AS token_tx_hash,
+           t.tx_type AS token_tx_type,
+           t.invoice_details AS token_invoice_details,
+           s.invoice_details AS spark_invoice_details,
+           s.htlc_details AS spark_htlc_details,
+           lrm.nostr_zap_request AS lnurl_nostr_zap_request,
+           lrm.nostr_zap_receipt AS lnurl_nostr_zap_receipt,
+           lrm.sender_comment AS lnurl_sender_comment,
+           pm.parent_payment_id
+      FROM payments p
+      LEFT JOIN payment_details_lightning l ON p.id = l.payment_id
+      LEFT JOIN payment_details_token t ON p.id = t.payment_id
+      LEFT JOIN payment_details_spark s ON p.id = s.payment_id
+      LEFT JOIN payment_metadata pm ON p.id = pm.payment_id
+      LEFT JOIN lnurl_receive_metadata lrm ON l.payment_hash = lrm.payment_hash`;
+
 class SqliteStorage {
   constructor(dbPath, logger = null) {
     this.dbPath = dbPath;
@@ -196,6 +237,14 @@ class SqliteStorage {
             paymentDetailsClauses.push("t.tx_hash = ?");
             params.push(paymentDetailsFilter.txHash);
           }
+          // Filter by token transaction type
+          if (
+            paymentDetailsFilter.type === "token" &&
+            paymentDetailsFilter.txType !== undefined
+          ) {
+            paymentDetailsClauses.push("t.tx_type = ?");
+            params.push(paymentDetailsFilter.txType);
+          }
 
           if (paymentDetailsClauses.length > 0) {
             allPaymentDetailsClauses.push(`(${paymentDetailsClauses.join(" AND ")})`);
@@ -221,50 +270,16 @@ class SqliteStorage {
         }
       }
 
+      // Exclude child payments (those with a parent_payment_id)
+      whereClauses.push("pm.parent_payment_id IS NULL");
+
       // Build the WHERE clause
       const whereSql =
         whereClauses.length > 0 ? `WHERE ${whereClauses.join(" AND ")}` : "";
 
       // Determine sort order
       const orderDirection = request.sortAscending ? "ASC" : "DESC";
-
-      const query = `
-            SELECT p.id
-            ,       p.payment_type
-            ,       p.status
-            ,       p.amount
-            ,       p.fees
-            ,       p.timestamp
-            ,       p.method
-            ,       p.withdraw_tx_id
-            ,       p.deposit_tx_id
-            ,       p.spark
-            ,       l.invoice AS lightning_invoice
-            ,       l.payment_hash AS lightning_payment_hash
-            ,       l.destination_pubkey AS lightning_destination_pubkey
-            ,       COALESCE(l.description, pm.lnurl_description) AS lightning_description
-            ,       l.preimage AS lightning_preimage
-            ,       pm.lnurl_pay_info
-            ,       pm.lnurl_withdraw_info
-            ,       pm.conversion_info
-            ,       t.metadata AS token_metadata
-            ,       t.tx_hash AS token_tx_hash
-            ,       t.invoice_details AS token_invoice_details
-            ,       s.invoice_details AS spark_invoice_details
-            ,       s.htlc_details AS spark_htlc_details
-            ,       lrm.nostr_zap_request AS lnurl_nostr_zap_request
-            ,       lrm.nostr_zap_receipt AS lnurl_nostr_zap_receipt
-            ,       lrm.sender_comment AS lnurl_sender_comment
-             FROM payments p
-             LEFT JOIN payment_details_lightning l ON p.id = l.payment_id
-             LEFT JOIN payment_details_token t ON p.id = t.payment_id
-             LEFT JOIN payment_details_spark s ON p.id = s.payment_id
-             LEFT JOIN payment_metadata pm ON p.id = pm.payment_id
-             LEFT JOIN lnurl_receive_metadata lrm ON l.payment_hash = lrm.payment_hash
-             ${whereSql}
-             ORDER BY p.timestamp ${orderDirection}
-             LIMIT ? OFFSET ?
-             `;
+      const query = `${SELECT_PAYMENT_SQL} ${whereSql} ORDER BY p.timestamp ${orderDirection} LIMIT ? OFFSET ?`;
 
       params.push(actualLimit, actualOffset);
       const stmt = this.db.prepare(query);
@@ -318,11 +333,12 @@ class SqliteStorage {
       );
       const tokenInsert = this.db.prepare(
         `INSERT INTO payment_details_token 
-          (payment_id, metadata, tx_hash, invoice_details) 
-          VALUES (@id, @metadata, @txHash, @invoiceDetails)
+          (payment_id, metadata, tx_hash, tx_type, invoice_details) 
+          VALUES (@id, @metadata, @txHash, @txType, @invoiceDetails)
           ON CONFLICT(payment_id) DO UPDATE SET
             metadata=excluded.metadata,
             tx_hash=excluded.tx_hash,
+            tx_type=excluded.tx_type,
             invoice_details=COALESCE(excluded.invoice_details, payment_details_token.invoice_details)`
       );
       const sparkInsert = this.db.prepare(
@@ -381,6 +397,7 @@ class SqliteStorage {
             id: payment.id,
             metadata: JSON.stringify(payment.details.metadata),
             txHash: payment.details.txHash,
+            txType: payment.details.txType,
             invoiceDetails: payment.details.invoiceDetails
               ? JSON.stringify(payment.details.invoiceDetails)
               : null,
@@ -408,43 +425,9 @@ class SqliteStorage {
         );
       }
 
-      const stmt = this.db.prepare(`
-            SELECT p.id
-            ,       p.payment_type
-            ,       p.status
-            ,       p.amount
-            ,       p.fees
-            ,       p.timestamp
-            ,       p.method
-            ,       p.withdraw_tx_id
-            ,       p.deposit_tx_id
-            ,       p.spark
-            ,       l.invoice AS lightning_invoice
-            ,       l.payment_hash AS lightning_payment_hash
-            ,       l.destination_pubkey AS lightning_destination_pubkey
-            ,       COALESCE(l.description, pm.lnurl_description) AS lightning_description
-            ,       l.preimage AS lightning_preimage
-            ,       pm.lnurl_pay_info
-            ,       pm.lnurl_withdraw_info
-            ,       pm.conversion_info
-            ,       t.metadata AS token_metadata
-            ,       t.tx_hash AS token_tx_hash
-            ,       t.invoice_details AS token_invoice_details
-            ,       s.invoice_details AS spark_invoice_details
-            ,       s.htlc_details AS spark_htlc_details
-            ,       lrm.nostr_zap_request AS lnurl_nostr_zap_request
-            ,       lrm.nostr_zap_receipt AS lnurl_nostr_zap_receipt
-            ,       lrm.sender_comment AS lnurl_sender_comment
-             FROM payments p
-             LEFT JOIN payment_details_lightning l ON p.id = l.payment_id
-             LEFT JOIN payment_details_token t ON p.id = t.payment_id
-             LEFT JOIN payment_details_spark s ON p.id = s.payment_id
-             LEFT JOIN payment_metadata pm ON p.id = pm.payment_id
-             LEFT JOIN lnurl_receive_metadata lrm ON l.payment_hash = lrm.payment_hash
-             WHERE p.id = ?
-            `);
-
+      const stmt = this.db.prepare(`${SELECT_PAYMENT_SQL} WHERE p.id = ?`);
       const row = stmt.get(id);
+
       if (!row) {
         return Promise.reject(
           new StorageError(`Payment with id '${id}' not found`)
@@ -472,43 +455,9 @@ class SqliteStorage {
         );
       }
 
-      const stmt = this.db.prepare(`
-            SELECT p.id
-            ,       p.payment_type
-            ,       p.status
-            ,       p.amount
-            ,       p.fees
-            ,       p.timestamp
-            ,       p.method
-            ,       p.withdraw_tx_id
-            ,       p.deposit_tx_id
-            ,       p.spark
-            ,       l.invoice AS lightning_invoice
-            ,       l.payment_hash AS lightning_payment_hash
-            ,       l.destination_pubkey AS lightning_destination_pubkey
-            ,       COALESCE(l.description, pm.lnurl_description) AS lightning_description
-            ,       l.preimage AS lightning_preimage
-            ,       pm.lnurl_pay_info
-            ,       pm.lnurl_withdraw_info
-            ,       pm.conversion_info
-            ,       t.metadata AS token_metadata
-            ,       t.tx_hash AS token_tx_hash
-            ,       t.invoice_details AS token_invoice_details
-            ,       s.invoice_details AS spark_invoice_details
-            ,       s.htlc_details AS spark_htlc_details
-            ,       lrm.nostr_zap_request AS lnurl_nostr_zap_request
-            ,       lrm.nostr_zap_receipt AS lnurl_nostr_zap_receipt
-            ,       lrm.sender_comment AS lnurl_sender_comment
-             FROM payments p
-             LEFT JOIN payment_details_lightning l ON p.id = l.payment_id
-             LEFT JOIN payment_details_token t ON p.id = t.payment_id
-             LEFT JOIN payment_details_spark s ON p.id = s.payment_id
-             LEFT JOIN payment_metadata pm ON p.id = pm.payment_id
-             LEFT JOIN lnurl_receive_metadata lrm ON l.payment_hash = lrm.payment_hash
-             WHERE l.invoice = ?
-            `);
-
+      const stmt = this.db.prepare(`${SELECT_PAYMENT_SQL} WHERE l.invoice = ?`);
       const row = stmt.get(invoice);
+
       if (!row) {
         return Promise.resolve(null);
       }
@@ -526,11 +475,66 @@ class SqliteStorage {
     }
   }
 
-  setPaymentMetadata(paymentId, metadata) {
+  /**
+   * Gets payments that have any of the specified parent payment IDs.
+   * @param {string[]} parentPaymentIds - Array of parent payment IDs
+   * @returns {Promise<Object>} Map of parentPaymentId -> array of RelatedPayment objects
+   */
+  getPaymentsByParentIds(parentPaymentIds) {
+    try {
+      if (!parentPaymentIds || parentPaymentIds.length === 0) {
+        return Promise.resolve({});
+      }
+
+      // Early exit if no related payments exist
+      const hasRelated = this.db
+        .prepare(
+          "SELECT EXISTS(SELECT 1 FROM payment_metadata WHERE parent_payment_id IS NOT NULL LIMIT 1)"
+        )
+        .pluck()
+        .get();
+      if (!hasRelated) {
+        return Promise.resolve({});
+      }
+
+      const placeholders = parentPaymentIds.map(() => "?").join(", ");
+      const query = `${SELECT_PAYMENT_SQL} WHERE pm.parent_payment_id IN (${placeholders}) ORDER BY p.timestamp ASC`;
+
+      const stmt = this.db.prepare(query);
+      const rows = stmt.all(...parentPaymentIds);
+
+      // Group payments by parent_payment_id
+      const result = {};
+      for (const row of rows) {
+        const parentId = row.parent_payment_id;
+        if (!result[parentId]) {
+          result[parentId] = [];
+        }
+        result[parentId].push(this._rowToPayment(row));
+      }
+
+      return Promise.resolve(result);
+    } catch (error) {
+      return Promise.reject(
+        new StorageError(
+          `Failed to get payments by parent ids: ${error.message}`,
+          error
+        )
+      );
+    }
+  }
+
+  insertPaymentMetadata(paymentId, metadata) {
     try {
       const stmt = this.db.prepare(`
-                INSERT OR REPLACE INTO payment_metadata (payment_id, parent_payment_id, lnurl_pay_info, lnurl_withdraw_info, lnurl_description, conversion_info) 
+                INSERT INTO payment_metadata (payment_id, parent_payment_id, lnurl_pay_info, lnurl_withdraw_info, lnurl_description, conversion_info)
                 VALUES (?, ?, ?, ?, ?, ?)
+                ON CONFLICT(payment_id) DO UPDATE SET
+                    parent_payment_id = COALESCE(excluded.parent_payment_id, parent_payment_id),
+                    lnurl_pay_info = COALESCE(excluded.lnurl_pay_info, lnurl_pay_info),
+                    lnurl_withdraw_info = COALESCE(excluded.lnurl_withdraw_info, lnurl_withdraw_info),
+                    lnurl_description = COALESCE(excluded.lnurl_description, lnurl_description),
+                    conversion_info = COALESCE(excluded.conversion_info, conversion_info)
             `);
 
       stmt.run(
@@ -755,6 +759,7 @@ class SqliteStorage {
         type: "token",
         metadata: JSON.parse(row.token_metadata),
         txHash: row.token_tx_hash,
+        txType: row.token_tx_type,
         invoiceDetails: row.token_invoice_details
           ? JSON.parse(row.token_invoice_details)
           : null,
@@ -793,11 +798,14 @@ class SqliteStorage {
   syncAddOutgoingChange(record) {
     try {
       const transaction = this.db.transaction(() => {
-        // Get the next revision
+        // Compute next revision as max(committed, max outgoing) + 1, without updating sync_revision
         const revisionQuery = this.db.prepare(`
-          UPDATE sync_revision
-          SET revision = revision + 1
-          RETURNING CAST(revision AS TEXT) AS revision
+          SELECT CAST(
+            MAX(
+              (SELECT revision FROM sync_revision),
+              COALESCE((SELECT MAX(revision) FROM sync_outgoing), 0)
+            ) + 1
+          AS TEXT) AS revision
         `);
         const revision = BigInt(revisionQuery.get().revision);
 
@@ -836,7 +844,7 @@ class SqliteStorage {
     }
   }
 
-  syncCompleteOutgoingSync(record) {
+  syncCompleteOutgoingSync(record, localRevision) {
     try {
       const transaction = this.db.transaction(() => {
         // Delete records that have been synced
@@ -848,7 +856,7 @@ class SqliteStorage {
         deleteStmt.run(
           record.id.type,
           record.id.dataId,
-          record.revision.toString()
+          localRevision.toString()
         );
 
         // Update or insert the sync state
@@ -871,6 +879,12 @@ class SqliteStorage {
           Math.floor(Date.now() / 1000),
           JSON.stringify(record.data)
         );
+
+        // Update sync_revision to track the highest known revision
+        const updateRevisionStmt = this.db.prepare(`
+          UPDATE sync_revision SET revision = MAX(revision, CAST(? AS INTEGER))
+        `);
+        updateRevisionStmt.run(record.revision.toString());
       });
 
       transaction();
@@ -953,7 +967,7 @@ class SqliteStorage {
   syncGetLastRevision() {
     try {
       const stmt = this.db.prepare(
-        `SELECT CAST(COALESCE(MAX(revision), 0) AS TEXT) as revision FROM sync_state`
+        `SELECT CAST(revision AS TEXT) as revision FROM sync_revision`
       );
       const row = stmt.get();
 
@@ -1031,9 +1045,9 @@ class SqliteStorage {
   syncRebasePendingOutgoingRecords(revision) {
     try {
       const transaction = this.db.transaction(() => {
-        // Get current revision
+        // Get current committed revision from sync_revision table
         const getLastRevisionStmt = this.db.prepare(`
-          SELECT CAST(COALESCE(MAX(revision), 0) AS TEXT) as last_revision FROM sync_state
+          SELECT CAST(revision AS TEXT) as last_revision FROM sync_revision
         `);
         const revisionRow = getLastRevisionStmt.get();
         const lastRevision = revisionRow
@@ -1044,17 +1058,20 @@ class SqliteStorage {
         const diff =
           revision > lastRevision ? revision - lastRevision : BigInt(0);
 
-        if (diff === BigInt(0)) {
-          return; // No rebasing needed
+        if (diff > BigInt(0)) {
+          // Update all pending outgoing records
+          const updateRecordsStmt = this.db.prepare(`
+            UPDATE sync_outgoing
+            SET revision = revision + CAST(? AS INTEGER)
+          `);
+          updateRecordsStmt.run(diff.toString());
         }
 
-        // Update all pending outgoing records
-        const updateRecordsStmt = this.db.prepare(`
-          UPDATE sync_outgoing 
-          SET revision = revision + CAST(? AS INTEGER)
+        // Update sync_revision within the same transaction so retries are idempotent
+        const updateRevisionStmt = this.db.prepare(`
+          UPDATE sync_revision SET revision = MAX(revision, CAST(? AS INTEGER))
         `);
-
-        updateRecordsStmt.run(diff.toString());
+        updateRevisionStmt.run(revision.toString());
       });
 
       transaction();
@@ -1206,26 +1223,35 @@ class SqliteStorage {
 
   syncUpdateRecordFromIncoming(record) {
     try {
-      const stmt = this.db.prepare(`
-        INSERT OR REPLACE INTO sync_state (
-          record_type, 
-          data_id, 
-          revision,
-          schema_version,
-          commit_time,
-          data
-        ) VALUES (?, ?, CAST(? AS INTEGER), ?, ?, ?)
-      `);
+      const transaction = this.db.transaction(() => {
+        const stmt = this.db.prepare(`
+          INSERT OR REPLACE INTO sync_state (
+            record_type,
+            data_id,
+            revision,
+            schema_version,
+            commit_time,
+            data
+          ) VALUES (?, ?, CAST(? AS INTEGER), ?, ?, ?)
+        `);
 
-      stmt.run(
-        record.id.type,
-        record.id.dataId,
-        record.revision.toString(),
-        record.schemaVersion,
-        Math.floor(Date.now() / 1000),
-        JSON.stringify(record.data)
-      );
+        stmt.run(
+          record.id.type,
+          record.id.dataId,
+          record.revision.toString(),
+          record.schemaVersion,
+          Math.floor(Date.now() / 1000),
+          JSON.stringify(record.data)
+        );
 
+        // Update sync_revision to track the highest known revision
+        const updateRevisionStmt = this.db.prepare(`
+          UPDATE sync_revision SET revision = MAX(revision, CAST(? AS INTEGER))
+        `);
+        updateRevisionStmt.run(record.revision.toString());
+      });
+
+      transaction();
       return Promise.resolve();
     } catch (error) {
       return Promise.reject(

package/nodejs/storage/migrations.cjs

@@ -229,6 +229,8 @@ class MigrationManager {
       {
         name: "Create sync tables",
         sql: [
+          // sync_revision: tracks the last committed revision (from server-acknowledged
+          // or server-received records). Does NOT include pending outgoing revisions.
           `CREATE TABLE sync_revision (
             revision INTEGER NOT NULL DEFAULT 0
           )`,
@@ -285,13 +287,13 @@ class MigrationManager {
                 nostr_zap_request TEXT,
                 nostr_zap_receipt TEXT,
                 sender_comment TEXT
-            )`
+            )`,
       },
       {
         // Delete all unclaimed deposits to clear old claim_error JSON format.
         // Deposits will be recovered on next sync.
         name: "Clear unclaimed deposits for claim_error format change",
-        sql: `DELETE FROM unclaimed_deposits`
+        sql: `DELETE FROM unclaimed_deposits`,
       },
       {
         // Clear all sync tables due to BreezSigner signature change.
@@ -309,7 +311,7 @@ class MigrationManager {
       },
       {
         name: "Add token conversion info to payment_metadata",
-        sql: `ALTER TABLE payment_metadata ADD COLUMN token_conversion_info TEXT`
+        sql: `ALTER TABLE payment_metadata ADD COLUMN token_conversion_info TEXT`,
       },
       {
         name: "Add parent payment id to payment_metadata",
@@ -321,6 +323,28 @@ class MigrationManager {
           `ALTER TABLE payment_metadata DROP COLUMN token_conversion_info`,
           `ALTER TABLE payment_metadata ADD COLUMN conversion_info TEXT`]
       },
+      {
+        name: "Add tx_type column to payment_details_token",
+        sql: [
+          // Add tx_type column with a default value of 'transfer'.
+          // Delete sync cache to trigger token re-sync which will update all records with correct tx_type.
+          // Note: This intentionally couples to the CachedSyncInfo schema at migration time.
+          `ALTER TABLE payment_details_token ADD COLUMN tx_type TEXT NOT NULL DEFAULT 'transfer'`,
+          `UPDATE settings
+           SET value = json_set(value, '$.last_synced_final_token_payment_id', NULL)
+           WHERE key = 'sync_offset' AND json_valid(value) AND json_type(value, '$.last_synced_final_token_payment_id') IS NOT NULL`,
+        ],
+      },
+      {
+        name: "Clear sync tables to force re-sync",
+        sql: [
+          `DELETE FROM sync_outgoing`,
+          `DELETE FROM sync_incoming`,
+          `DELETE FROM sync_state`,
+          `UPDATE sync_revision SET revision = 0`,
+          `DELETE FROM settings WHERE key = 'sync_initial_complete'`
+        ]
+      },
     ];
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@breeztech/breez-sdk-spark",
-    "version": "0.7.19",
+    "version": "0.8.0-dev1",
     "description": "Breez Spark SDK",
     "repository": "https://github.com/breez/spark-sdk",
     "author": "Breez <contact@breez.technology> (https://github.com/breez)",