@breeztech/breez-sdk-spark 0.13.10-dev → 0.13.12-dev1

package/bundler/breez_sdk_spark_wasm.d.ts

@@ -142,6 +142,28 @@ export interface Wallet {
     label: string;
 }
 
+/**
+ * Configuration for MySQL storage connection pool. Targets MySQL 8.0+.
+ */
+export interface MysqlStorageConfig {
+    /**
+     * MySQL connection URL (e.g. `mysql://user:pass@host:3306/dbname`).
+     */
+    connectionString: string;
+    /**
+     * Maximum number of connections in the pool.
+     */
+    maxPoolSize: number;
+    /**
+     * Timeout in seconds for establishing a new connection (0 = no timeout).
+     */
+    createTimeoutSecs: number;
+    /**
+     * Timeout in seconds before recycling an idle connection.
+     */
+    recycleTimeoutSecs: number;
+}
+
 /**
  * Configuration for PostgreSQL storage connection pool.
  */
@@ -1046,6 +1068,16 @@ export interface SendPaymentResponse {
     payment: Payment;
 }
 
+export interface Session {
+    token: string;
+    expiration: number;
+}
+
+export interface SessionManager {
+    getSession: (serviceIdentityKey: string) => Promise<Session>;
+    setSession: (serviceIdentityKey: string, session: Session) => Promise<void>;
+}
+
 export interface SetLnurlMetadataItem {
     paymentHash: string;
     senderComment?: string;
@@ -1339,6 +1371,8 @@ export type SendPaymentOptions = { type: "bitcoinAddress"; confirmationSpeed: On
 
 export type ServiceStatus = "operational" | "degraded" | "partial" | "unknown" | "major";
 
+export type SessionManagerError = { type: "notFound" } | ({ type: "generic" } & string);
+
 export type SparkHtlcStatus = "waitingForPreimage" | "preimageShared" | "returned";
 
 export type StableBalanceActiveLabel = { type: "set"; label: string } | { type: "unset" };
@@ -1356,6 +1390,25 @@ export type UpdateDepositPayload = { type: "claimError"; error: DepositClaimErro
 export type WebhookEventType = { type: "lightningReceiveFinished" } | { type: "lightningSendFinished" } | { type: "coopExitFinished" } | { type: "staticDepositFinished" } | ({ type: "unknown" } & string);
 
 
+/**
+ * Rust-built implementation of the JS `BitcoinChainService` interface.
+ *
+ * Returned by factories like [`new_rest_chain_service`]; users see it as a
+ * `BitcoinChainService` and pass it to `withChainService`. Pass the same
+ * instance to multiple `SdkBuilder`s to share a single underlying HTTP
+ * client (and its connection pool) across SDK instances.
+ */
+export class BitcoinChainServiceHandle {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    broadcastTransaction(tx: string): Promise<void>;
+    getAddressUtxos(address: string): Promise<any>;
+    getTransactionHex(txid: string): Promise<any>;
+    getTransactionStatus(txid: string): Promise<any>;
+    recommendedFees(): Promise<any>;
+}
+
 export class BreezSdk {
     private constructor();
     free(): void;
@@ -1464,6 +1517,16 @@ export class IntoUnderlyingSource {
     pull(controller: ReadableStreamDefaultController): Promise<any>;
 }
 
+/**
+ * A shareable MySQL connection pool. See [`PostgresConnectionPool`](super::postgres_pool::PostgresConnectionPool)
+ * for sharing semantics and lifecycle.
+ */
+export class MysqlConnectionPool {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
 /**
  * Passkey-based wallet operations using WebAuthn PRF extension.
  *
@@ -1507,6 +1570,22 @@ export class Passkey {
     storeLabel(label: string): Promise<void>;
 }
 
+/**
+ * A shareable Postgres connection pool.
+ *
+ * Construct via [`create_postgres_connection_pool`] and pass the same handle to multiple
+ * `SdkBuilder`s via `withPostgresConnectionPool` to share connections across SDKs.
+ * Per-tenant scoping is derived from each SDK's seed.
+ *
+ * The pool's lifecycle is controlled by the integrator: it stays alive as
+ * long as any reference is held. `disconnect()` does **not** close the pool.
+ */
+export class PostgresConnectionPool {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
 export class SdkBuilder {
     private constructor();
     free(): void;
@@ -1519,12 +1598,57 @@ export class SdkBuilder {
     withFiatService(fiat_service: FiatService): SdkBuilder;
     withKeySet(config: KeySetConfig): SdkBuilder;
     withLnurlClient(lnurl_client: RestClient): SdkBuilder;
+    /**
+     * **Deprecated.** Call `withMysqlConnectionPool(config)` and `withMysqlConnectionPool(pool)` instead.
+     */
+    withMysqlBackend(config: MysqlStorageConfig): SdkBuilder;
+    /**
+     * Sets a shared `MySQL` connection pool as the backend for all stores.
+     * Construct via `createMysqlConnectionPool` and pass the same handle to multiple
+     * `SdkBuilder`s to share connections across SDKs.
+     */
+    withMysqlConnectionPool(pool: MysqlConnectionPool): SdkBuilder;
     withPaymentObserver(payment_observer: PaymentObserver): SdkBuilder;
+    /**
+     * **Deprecated.** Call `withPostgresConnectionPool(config)` and `withPostgresConnectionPool(pool)` instead.
+     */
     withPostgresBackend(config: PostgresStorageConfig): SdkBuilder;
+    /**
+     * Sets a shared `PostgreSQL` connection pool as the backend for all
+     * stores. Construct via `createPostgresConnectionPool` and pass the same handle
+     * to multiple `SdkBuilder`s to share connections across SDKs.
+     */
+    withPostgresConnectionPool(pool: PostgresConnectionPool): SdkBuilder;
     withRestChainService(url: string, api_type: ChainApiType, credentials?: Credentials | null): SdkBuilder;
+    /**
+     * Sets a custom session manager used to persist authentication sessions.
+     *
+     * Provide a shared, persistent implementation (e.g. backed by `PostgreSQL`
+     * or Redis) to let multiple SDK instances share authentication state and
+     * bootstrap quickly. If not set, an in-memory session manager is used.
+     */
+    withSessionManager(session_manager: SessionManager): SdkBuilder;
+    /**
+     * Reuses a shared SSP connection across SDK instances. Pass the same
+     * manager to every `SdkBuilder` whose SSP traffic should share an
+     * underlying HTTP client.
+     */
+    withSspConnectionManager(manager: SspConnectionManager): SdkBuilder;
     withStorage(storage: Storage): SdkBuilder;
 }
 
+/**
+ * Shared transport for SSP GraphQL traffic across SDK instances.
+ *
+ * All SDK instances built with the same `SspConnectionManager` share a single
+ * underlying HTTP client (and its h2 connection pool) for SSP requests.
+ */
+export class SspConnectionManager {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
 export class TokenIssuer {
     private constructor();
     free(): void;
@@ -1542,10 +1666,30 @@ export function connect(request: ConnectRequest): Promise<BreezSdk>;
 
 export function connectWithSigner(config: Config, signer: ExternalSigner, storage_dir: string): Promise<BreezSdk>;
 
+/**
+ * Creates a shareable MySQL connection pool from the given config.
+ */
+export function createMysqlConnectionPool(config: MysqlStorageConfig): MysqlConnectionPool;
+
+/**
+ * Creates a shareable Postgres connection pool from the given config.
+ */
+export function createPostgresConnectionPool(config: PostgresStorageConfig): PostgresConnectionPool;
+
 export function defaultConfig(network: Network): Config;
 
 export function defaultExternalSigner(mnemonic: string, passphrase: string | null | undefined, network: Network, key_set_config?: KeySetConfig | null): DefaultSigner;
 
+/**
+ * Creates a default MySQL storage configuration with sensible defaults.
+ *
+ * Default values:
+ * - `maxPoolSize`: 10
+ * - `createTimeoutSecs`: 0 (no timeout)
+ * - `recycleTimeoutSecs`: 10
+ */
+export function defaultMysqlStorageConfig(connection_string: string): MysqlStorageConfig;
+
 /**
  * Creates a default PostgreSQL storage configuration with sensible defaults.
  *
@@ -1565,6 +1709,19 @@ export function getSparkStatus(): Promise<SparkStatus>;
 
 export function initLogging(logger: Logger, filter?: string | null): Promise<void>;
 
+/**
+ * Constructs a shareable REST-based Bitcoin chain service.
+ *
+ * Pass the returned chain service to multiple `SdkBuilder`s via
+ * `withChainService` to reuse one HTTP client across SDK instances. All
+ * SDKs sharing the chain service must use the same `network`.
+ *
+ * For one-off, non-shared use, prefer `withRestChainService`.
+ */
+export function newRestChainService(url: string, network: Network, api_type: ChainApiType, credentials?: Credentials | null): BitcoinChainService;
+
+export function newSspConnectionManager(user_agent?: string | null): SspConnectionManager;
+
 /**
  * Entry point invoked by JavaScript in a worker.
  */

package/bundler/breez_sdk_spark_wasm.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./breez_sdk_spark_wasm_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
 export {
-    BreezSdk, DefaultSigner, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, Passkey, SdkBuilder, TokenIssuer, connect, connectWithSigner, defaultConfig, defaultExternalSigner, defaultPostgresStorageConfig, getSparkStatus, initLogging, task_worker_entry_point
+    BitcoinChainServiceHandle, BreezSdk, DefaultSigner, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, MysqlConnectionPool, Passkey, PostgresConnectionPool, SdkBuilder, SspConnectionManager, TokenIssuer, connect, connectWithSigner, createMysqlConnectionPool, createPostgresConnectionPool, defaultConfig, defaultExternalSigner, defaultMysqlStorageConfig, defaultPostgresStorageConfig, getSparkStatus, initLogging, newRestChainService, newSspConnectionManager, task_worker_entry_point
 } from "./breez_sdk_spark_wasm_bg.js";