@breeztech/breez-sdk-spark 0.27.1 → 0.27.3-dev

package/nodejs/postgres-storage/migrations.cjs

@@ -54,20 +54,20 @@ class PostgresMigrationManager {
       const migrations = this._getMigrations(identity);
 
       if (currentVersion >= migrations.length) {
-        this._log("info", `Database is up to date (version ${currentVersion})`);
+        this._log("INFO", `Database is up to date (version ${currentVersion})`);
         await client.query("COMMIT");
         return;
       }
 
       this._log(
-        "info",
+        "INFO",
         `Migrating database from version ${currentVersion} to ${migrations.length}`
       );
 
       for (let i = currentVersion; i < migrations.length; i++) {
         const migration = migrations[i];
         const version = i + 1;
-        this._log("debug", `Running migration ${version}: ${migration.name}`);
+        this._log("DEBUG", `Running migration ${version}: ${migration.name}`);
 
         for (const sql of migration.sql) {
           await client.query(sql);
@@ -80,7 +80,7 @@ class PostgresMigrationManager {
       }
 
       await client.query("COMMIT");
-      this._log("info", "Database migration completed successfully");
+      this._log("INFO", "Database migration completed successfully");
     } catch (error) {
       await client.query("ROLLBACK").catch(() => {});
       throw new StorageError(
@@ -219,11 +219,7 @@ class PostgresMigrationManager {
   }
 
   _log(level, message) {
-    if (this.logger && typeof this.logger.log === "function") {
-      this.logger.log({ line: message, level });
-    } else if (level === "error") {
-      console.error(`[PostgresMigrationManager] ${message}`);
-    }
+    this.logger?.log({ line: message, level });
   }
 
   /**
@@ -612,6 +608,25 @@ class PostgresMigrationManager {
           )`,
         ],
       },
+      {
+        // With the sync offset at 0, the SDK re-fetches every transfer on its
+        // next sync and fills in both columns for past withdrawals.
+        name: "Add withdrawal destination address and output index",
+        sql: [
+          `ALTER TABLE brz_payments ADD COLUMN withdraw_vout BIGINT`,
+          `ALTER TABLE brz_payments ADD COLUMN withdraw_destination_address TEXT`,
+          `UPDATE brz_settings
+           SET value = jsonb_set(value::jsonb, '{offset}', '0')::text
+           WHERE key = 'sync_offset' AND value IS NOT NULL`,
+        ],
+      },
+      {
+        name: "Add lightning address to brz_lnurl_receive_metadata and force its re-sync",
+        sql: [
+          `ALTER TABLE brz_lnurl_receive_metadata ADD COLUMN lightning_address TEXT`,
+          `DELETE FROM brz_settings WHERE key = 'lnurl_metadata_updated_after'`,
+        ],
+      },
     ];
   }
 }

package/nodejs/postgres-token-store/index.cjs

@@ -383,7 +383,7 @@ class PostgresTokenStore {
           const metadata = _metadataFor(tokenOutputs.metadata, tokenIdentifier);
           if (!metadata) {
             this._log(
-              "warn",
+              "WARN",
               `Skipping outputs of token ${tokenIdentifier}: no metadata provided`
             );
             continue;
@@ -629,31 +629,26 @@ class PostgresTokenStore {
         }
 
         // 2. Insert new outputs, grouped by the token each one names.
-        for (const [tokenIdentifier, outputs] of _groupOutputsByToken(
+        const spentOutpoints = await this._spentOutpointsAmong(
+          client,
           outputsToAdd?.outputs
+        );
+        const unspentOutputs = (outputsToAdd?.outputs ?? []).filter(
+          (o) => !spentOutpoints.has(`${o.prevTxHash}:${o.prevTxVout}`)
+        );
+        for (const [tokenIdentifier, outputs] of _groupOutputsByToken(
+          unspentOutputs
         )) {
           const metadata = _metadataFor(outputsToAdd.metadata, tokenIdentifier);
           if (!metadata) {
             this._log(
-              "warn",
+              "WARN",
               `Skipping outputs of token ${tokenIdentifier}: no metadata provided`
             );
             continue;
           }
           await this._upsertMetadata(client, metadata);
 
-          // Clear spent status for outputs being (re-)added.
-          const txHashes = outputs.map((o) => o.prevTxHash);
-          const vouts = outputs.map((o) => o.prevTxVout);
-          await client.query(
-            `DELETE FROM brz_token_spent_outputs
-             WHERE user_id = $1
-               AND (prev_tx_hash, prev_tx_vout) IN (
-                 SELECT * FROM UNNEST($2::text[], $3::int[])
-               )`,
-            [this.identity, txHashes, vouts]
-          );
-
           for (const output of outputs) {
             await this._insertSingleOutput(client, tokenIdentifier, output);
           }
@@ -1010,9 +1005,7 @@ class PostgresTokenStore {
   // ===== Private Helpers =====
 
   _log(level, message) {
-    if (this.logger && typeof this.logger.log === "function") {
-      this.logger.log({ line: message, level });
-    }
+    this.logger?.log({ line: message, level });
   }
 
   /**
@@ -1205,6 +1198,27 @@ class PostgresTokenStore {
     );
   }
 
+  async _spentOutpointsAmong(client, outputs) {
+    if (!outputs || outputs.length === 0) {
+      return new Set();
+    }
+    const result = await client.query(
+      `SELECT prev_tx_hash, prev_tx_vout FROM brz_token_spent_outputs
+       WHERE user_id = $1
+         AND (prev_tx_hash, prev_tx_vout) IN (
+           SELECT * FROM UNNEST($2::text[], $3::int[])
+         )`,
+      [
+        this.identity,
+        outputs.map((o) => o.prevTxHash),
+        outputs.map((o) => o.prevTxVout),
+      ]
+    );
+    return new Set(
+      result.rows.map((r) => `${r.prev_tx_hash}:${r.prev_tx_vout}`)
+    );
+  }
+
   /**
    * Insert a single output.
    */

package/nodejs/postgres-token-store/migrations.cjs

@@ -58,20 +58,20 @@ class TokenStoreMigrationManager {
       const migrations = this._getMigrations(identity);
 
       if (currentVersion >= migrations.length) {
-        this._log("info", `Token store database is up to date (version ${currentVersion})`);
+        this._log("INFO", `Token store database is up to date (version ${currentVersion})`);
         await client.query("COMMIT");
         return;
       }
 
       this._log(
-        "info",
+        "INFO",
         `Migrating token store database from version ${currentVersion} to ${migrations.length}`
       );
 
       for (let i = currentVersion; i < migrations.length; i++) {
         const migration = migrations[i];
         const version = i + 1;
-        this._log("debug", `Running token store migration ${version}: ${migration.name}`);
+        this._log("DEBUG", `Running token store migration ${version}: ${migration.name}`);
 
         for (const sql of migration.sql) {
           await client.query(sql);
@@ -84,7 +84,7 @@ class TokenStoreMigrationManager {
       }
 
       await client.query("COMMIT");
-      this._log("info", "Token store database migration completed successfully");
+      this._log("INFO", "Token store database migration completed successfully");
     } catch (error) {
       await client.query("ROLLBACK").catch(() => {});
       throw new TokenStoreError(
@@ -187,11 +187,7 @@ class TokenStoreMigrationManager {
   }
 
   _log(level, message) {
-    if (this.logger && typeof this.logger.log === "function") {
-      this.logger.log({ line: message, level });
-    } else if (level === "error") {
-      console.error(`[TokenStoreMigrationManager] ${message}`);
-    }
+    this.logger?.log({ line: message, level });
   }
 
   /**

package/nodejs/postgres-tree-store/migrations.cjs

@@ -58,20 +58,20 @@ class TreeStoreMigrationManager {
       const migrations = this._getMigrations(identity);
 
       if (currentVersion >= migrations.length) {
-        this._log("info", `Tree store database is up to date (version ${currentVersion})`);
+        this._log("INFO", `Tree store database is up to date (version ${currentVersion})`);
         await client.query("COMMIT");
         return;
       }
 
       this._log(
-        "info",
+        "INFO",
         `Migrating tree store database from version ${currentVersion} to ${migrations.length}`
       );
 
       for (let i = currentVersion; i < migrations.length; i++) {
         const migration = migrations[i];
         const version = i + 1;
-        this._log("debug", `Running tree store migration ${version}: ${migration.name}`);
+        this._log("DEBUG", `Running tree store migration ${version}: ${migration.name}`);
 
         for (const sql of migration.sql) {
           await client.query(sql);
@@ -84,7 +84,7 @@ class TreeStoreMigrationManager {
       }
 
       await client.query("COMMIT");
-      this._log("info", "Tree store database migration completed successfully");
+      this._log("INFO", "Tree store database migration completed successfully");
     } catch (error) {
       await client.query("ROLLBACK").catch(() => {});
       throw new TreeStoreError(
@@ -179,11 +179,7 @@ class TreeStoreMigrationManager {
   }
 
   _log(level, message) {
-    if (this.logger && typeof this.logger.log === "function") {
-      this.logger.log({ line: message, level });
-    } else if (level === "error") {
-      console.error(`[TreeStoreMigrationManager] ${message}`);
-    }
+    this.logger?.log({ line: message, level });
   }
 
   /**

package/nodejs/storage/index.cjs

@@ -18,7 +18,7 @@ try {
     Database = require("better-sqlite3");
   } catch (fallbackError) {
     throw new Error(
-      `better-sqlite3 not found. Please install it in your project: npm install better-sqlite3@^9.2.2\n` +
+      `better-sqlite3 not found. Please install it in your project: npm install better-sqlite3@^12.2.0\n` +
         `Original error: ${error.message}\nFallback error: ${fallbackError.message}`
     );
   }
@@ -49,6 +49,8 @@ const SELECT_PAYMENT_SQL = `
            p.timestamp,
            p.method,
            p.withdraw_tx_id,
+           p.withdraw_vout,
+           p.withdraw_destination_address,
            pd.tx_id AS deposit_tx_id,
            pd.vout AS deposit_vout,
            p.spark,
@@ -72,6 +74,7 @@ const SELECT_PAYMENT_SQL = `
            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,
+           lrm.lightning_address AS lnurl_lightning_address,
            lrm.payment_hash AS lnurl_payment_hash,
            pm.parent_payment_id
       FROM payments p
@@ -367,13 +370,15 @@ class SqliteStorage {
           this._runPaymentUpsert(payment);
           shouldEmit = true;
         } else if (stored === next) {
-          console.debug(
+          this._log(
+            "DEBUG",
             `Skipping redundant payment event: id=${payment.id} status=${next}`
           );
           this._runPaymentUpsert(payment);
           shouldEmit = false;
         } else if (this._isFinalPaymentStatus(stored)) {
-          console.warn(
+          this._log(
+            "WARN",
             `Skipping payment update (would replace terminal status): id=${payment.id} stored=${stored} new=${next}`
           );
           shouldEmit = false;
@@ -395,8 +400,8 @@ class SqliteStorage {
 
   _runPaymentUpsert(payment) {
     const paymentInsert = this.db.prepare(
-      `INSERT INTO payments (id, payment_type, status, amount, fees, timestamp, method, withdraw_tx_id, spark)
-       VALUES (@id, @paymentType, @status, @amount, @fees, @timestamp, @method, @withdrawTxId, @spark)
+      `INSERT INTO payments (id, payment_type, status, amount, fees, timestamp, method, withdraw_tx_id, withdraw_vout, withdraw_destination_address, spark)
+       VALUES (@id, @paymentType, @status, @amount, @fees, @timestamp, @method, @withdrawTxId, @withdrawVout, @withdrawDestinationAddress, @spark)
        ON CONFLICT(id) DO UPDATE SET
          payment_type=excluded.payment_type,
          status=excluded.status,
@@ -405,6 +410,8 @@ class SqliteStorage {
          timestamp=excluded.timestamp,
          method=excluded.method,
          withdraw_tx_id=excluded.withdraw_tx_id,
+         withdraw_vout=excluded.withdraw_vout,
+         withdraw_destination_address=excluded.withdraw_destination_address,
          spark=excluded.spark`
     );
     const depositInsert = this.db.prepare(
@@ -447,6 +454,7 @@ class SqliteStorage {
           htlc_details=COALESCE(excluded.htlc_details, payment_details_spark.htlc_details)`
     );
 
+    const withdraw = payment.details?.type === "withdraw" ? payment.details : null;
     paymentInsert.run({
       id: payment.id,
       paymentType: payment.paymentType,
@@ -455,8 +463,9 @@ class SqliteStorage {
       fees: payment.fees.toString(),
       timestamp: payment.timestamp,
       method: payment.method ? toJson(payment.method) : null,
-      withdrawTxId:
-        payment.details?.type === "withdraw" ? payment.details.txId : null,
+      withdrawTxId: withdraw?.txId ?? null,
+      withdrawVout: withdraw?.vout ?? null,
+      withdrawDestinationAddress: withdraw?.destinationAddress ?? null,
       spark: payment.details?.type === "spark" ? 1 : null,
     });
 
@@ -510,6 +519,10 @@ class SqliteStorage {
     }
   }
 
+  _log(level, line) {
+    this.logger?.log({ line, level });
+  }
+
   _normalizePaymentStatus(status) {
     return typeof status === "string" ? status.toLowerCase() : status;
   }
@@ -580,7 +593,7 @@ class SqliteStorage {
   /**
    * 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
+   * @returns {Promise<Object>} Map of parentPaymentId -> array of Payment objects
    */
   getPaymentsByParentIds(parentPaymentIds) {
     try {
@@ -1015,7 +1028,7 @@ class SqliteStorage {
   setLnurlMetadata(metadata) {
     try {
       const stmt = this.db.prepare(
-        "INSERT OR REPLACE INTO lnurl_receive_metadata (payment_hash, nostr_zap_request, nostr_zap_receipt, sender_comment) VALUES (?, ?, ?, ?)"
+        "INSERT OR REPLACE INTO lnurl_receive_metadata (payment_hash, nostr_zap_request, nostr_zap_receipt, sender_comment, lightning_address) VALUES (?, ?, ?, ?, ?)"
       );
 
       const transaction = this.db.transaction(() => {
@@ -1024,7 +1037,8 @@ class SqliteStorage {
             item.paymentHash,
             item.nostrZapRequest || null,
             item.nostrZapReceipt || null,
-            item.senderComment || null
+            item.senderComment || null,
+            item.lightningAddress || null
           );
         }
       });
@@ -1088,6 +1102,7 @@ class SqliteStorage {
           nostrZapRequest: row.lnurl_nostr_zap_request || null,
           nostrZapReceipt: row.lnurl_nostr_zap_receipt || null,
           senderComment: row.lnurl_sender_comment || null,
+          lightningAddress: row.lnurl_lightning_address || null,
         };
       }
 
@@ -1102,10 +1117,16 @@ class SqliteStorage {
         }
       }
     } else if (row.withdraw_tx_id) {
-      details = {
-        type: "withdraw",
-        txId: row.withdraw_tx_id,
-      };
+      // A withdrawal stored before the SDK kept these values has no details
+      // until the next sync rewrites it.
+      if (row.withdraw_vout != null && row.withdraw_destination_address != null) {
+        details = {
+          type: "withdraw",
+          txId: row.withdraw_tx_id,
+          vout: row.withdraw_vout,
+          destinationAddress: row.withdraw_destination_address,
+        };
+      }
     } else if (row.deposit_tx_id) {
       details = {
         type: "deposit",

package/nodejs/storage/migrations.cjs

@@ -21,12 +21,12 @@ class MigrationManager {
     targetVersion = targetVersion ?? this.migrations.length;
 
     if (currentVersion >= targetVersion) {
-      this._log("info", `Database is up to date (version ${currentVersion})`);
+      this._log("INFO", `Database is up to date (version ${currentVersion})`);
       return;
     }
 
     this._log(
-      "info",
+      "INFO",
       `Migrating database from version ${currentVersion} to ${targetVersion}`
     );
 
@@ -34,7 +34,7 @@ class MigrationManager {
       const transaction = this.db.transaction(() => {
         for (let i = currentVersion; i < targetVersion; i++) {
           const migration = this.migrations[i];
-          this._log("debug", `Running migration ${i + 1}: ${migration.name}`);
+          this._log("DEBUG", `Running migration ${i + 1}: ${migration.name}`);
 
           if (Array.isArray(migration.sql)) {
             migration.sql.forEach((sql) => this.db.exec(sql));
@@ -46,7 +46,7 @@ class MigrationManager {
       });
 
       transaction();
-      this._log("info", `Database migration completed successfully`);
+      this._log("INFO", `Database migration completed successfully`);
     } catch (error) {
       throw new this.StorageError(
         `Migration failed at version ${currentVersion}: ${error.message}`,
@@ -64,7 +64,7 @@ class MigrationManager {
       return row.user_version || 0;
     } catch (error) {
       this._log(
-        "warn",
+        "WARN",
         `Failed to get database version, assuming 0: ${error.message}`
       );
       return 0;
@@ -79,16 +79,7 @@ class MigrationManager {
   }
 
   _log(level, message) {
-    if (this.logger && typeof this.logger.log === "function") {
-      this.logger.log({
-        line: message,
-        level: level,
-      });
-    } else if (level === "error") {
-      // Fallback to console.error for errors only
-      console.error(`[MigrationManager] ${message}`);
-    }
-    // For info/debug/warn levels, only log if logger is provided
+    this.logger?.log({ line: message, level });
   }
 
   /**
@@ -559,6 +550,25 @@ class MigrationManager {
           )`,
         ],
       },
+      {
+        // With the sync offset at 0, the SDK re-fetches every transfer on its
+        // next sync and fills in both columns for past withdrawals.
+        name: "Add withdrawal destination address and output index",
+        sql: [
+          `ALTER TABLE payments ADD COLUMN withdraw_vout INTEGER`,
+          `ALTER TABLE payments ADD COLUMN withdraw_destination_address TEXT`,
+          `UPDATE settings
+           SET value = json_set(value, '$.offset', 0)
+           WHERE key = 'sync_offset' AND json_valid(value)`,
+        ],
+      },
+      {
+        name: "Add lightning address to lnurl_receive_metadata and force its re-sync",
+        sql: [
+          `ALTER TABLE lnurl_receive_metadata ADD COLUMN lightning_address TEXT`,
+          `DELETE FROM settings WHERE key = 'lnurl_metadata_updated_after'`,
+        ],
+      },
     ];
   }
 }

package/nodejs/tree-store/index.cjs

@@ -49,7 +49,7 @@ try {
     Database = require("better-sqlite3");
   } catch (fallbackError) {
     throw new Error(
-      `better-sqlite3 not found. Please install it in your project: npm install better-sqlite3@^9.2.2\n` +
+      `better-sqlite3 not found. Please install it in your project: npm install better-sqlite3@^12.2.0\n` +
         `Original error: ${error.message}\nFallback error: ${fallbackError.message}`
     );
   }

package/nodejs/tree-store/migrations.cjs

@@ -26,12 +26,12 @@ class TreeStoreMigrationManager {
     targetVersion = targetVersion ?? this.migrations.length;
 
     if (currentVersion >= targetVersion) {
-      this._log("info", `Tree store is up to date (version ${currentVersion})`);
+      this._log("INFO", `Tree store is up to date (version ${currentVersion})`);
       return;
     }
 
     this._log(
-      "info",
+      "INFO",
       `Migrating tree store from version ${currentVersion} to ${targetVersion}`
     );
 
@@ -39,7 +39,7 @@ class TreeStoreMigrationManager {
       const transaction = this.db.transaction(() => {
         for (let i = currentVersion; i < targetVersion; i++) {
           const migration = this.migrations[i];
-          this._log("debug", `Running migration ${i + 1}: ${migration.name}`);
+          this._log("DEBUG", `Running migration ${i + 1}: ${migration.name}`);
 
           if (Array.isArray(migration.sql)) {
             migration.sql.forEach((sql) => this.db.exec(sql));
@@ -51,7 +51,7 @@ class TreeStoreMigrationManager {
       });
 
       transaction();
-      this._log("info", `Tree store migration completed successfully`);
+      this._log("INFO", `Tree store migration completed successfully`);
     } catch (error) {
       throw new this.TreeStoreError(
         `Migration failed at version ${currentVersion}: ${error.message}`,
@@ -83,7 +83,7 @@ class TreeStoreMigrationManager {
       return row.version || 0;
     } catch (error) {
       this._log(
-        "warn",
+        "WARN",
         `Failed to get tree store version, assuming 0: ${error.message}`
       );
       return 0;
@@ -100,14 +100,7 @@ class TreeStoreMigrationManager {
   }
 
   _log(level, message) {
-    if (this.logger && typeof this.logger.log === "function") {
-      this.logger.log({
-        line: message,
-        level: level,
-      });
-    } else if (level === "error") {
-      console.error(`[TreeStoreMigrationManager] ${message}`);
-    }
+    this.logger?.log({ line: message, level });
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@breeztech/breez-sdk-spark",
-    "version": "0.27.1",
+    "version": "0.27.3-dev",
     "description": "Breez Spark SDK",
     "repository": "https://github.com/breez/spark-sdk",
     "author": "Breez <contact@breez.technology> (https://github.com/breez)",
@@ -14,13 +14,23 @@
         "deno",
         "nodejs",
         "web",
-        "ssr",
-        "!examples"
+        "ssr"
     ],
+    "types": "./nodejs/index.d.ts",
     "exports": {
         "./bundler": "./bundler/index.js",
         "./deno": "./deno/breez_sdk_spark_wasm.js",
-        "./nodejs": "./nodejs/index.js",
+        "./nodejs": {
+            "import": {
+                "types": "./nodejs/index.d.mts",
+                "default": "./nodejs/index.mjs"
+            },
+            "require": {
+                "types": "./nodejs/index.d.ts",
+                "default": "./nodejs/index.js"
+            },
+            "default": "./nodejs/index.js"
+        },
         "./web": "./web/index.js",
         "./ssr": "./ssr/index.js",
         "./passkey-prf-provider": {
@@ -30,10 +40,21 @@
         },
         ".": {
             "node": {
-                "import": "./nodejs/index.mjs",
-                "require": "./nodejs/index.js"
+                "import": {
+                    "types": "./nodejs/index.d.mts",
+                    "default": "./nodejs/index.mjs"
+                },
+                "require": {
+                    "types": "./nodejs/index.d.ts",
+                    "default": "./nodejs/index.js"
+                },
+                "default": "./nodejs/index.js"
             },
             "deno": "./deno/breez_sdk_spark_wasm.js",
+            "require": {
+                "types": "./nodejs/index.d.ts",
+                "default": "./web/index.js"
+            },
             "default": "./web/index.js"
         }
     },

package/ssr/index.js

@@ -48,6 +48,11 @@ export function createTurnkeySigningOnlySigner(...args) {
   return _module.createTurnkeySigningOnlySigner(...args);
 }
 
+export function defaultBridgingConfig(...args) {
+  if (!_module) _notInitialized('defaultBridgingConfig');
+  return _module.defaultBridgingConfig(...args);
+}
+
 export function defaultConfig(...args) {
   if (!_module) _notInitialized('defaultConfig');
   return _module.defaultConfig(...args);
@@ -98,6 +103,11 @@ export function mysqlStorage(...args) {
   return _module.mysqlStorage(...args);
 }
 
+export function newBridgingClient(...args) {
+  if (!_module) _notInitialized('newBridgingClient');
+  return _module.newBridgingClient(...args);
+}
+
 export function newRestChainService(...args) {
   if (!_module) _notInitialized('newRestChainService');
   return _module.newRestChainService(...args);
@@ -152,6 +162,20 @@ export class BreezSdk {
   }
 }
 
+export class BridgingClient {
+  constructor(...args) {
+    if (!_module) _notInitialized('new BridgingClient');
+    return new _module.BridgingClient(...args);
+  }
+}
+
+export class ConsoleLogger {
+  constructor(...args) {
+    if (!_module) _notInitialized('new ConsoleLogger');
+    return new _module.ConsoleLogger(...args);
+  }
+}
+
 export class DefaultCpfpSigner {
   constructor(...args) {
     if (!_module) _notInitialized('new DefaultCpfpSigner');