@kaleidorg/wallet-engine 1.0.0-beta.33 → 1.0.0-beta.34

package/dist/adapters/SparkAdapter.d.ts

@@ -1,48 +1,125 @@
 /**
  * Spark Protocol Adapter
- * Implements IProtocolAdapter using @buildonspark/spark-sdk.
- * Ported from rate-extension for React Native.
+ * Implements IProtocolAdapter using @buildonspark/spark-sdk (native Spark SDK).
+ *
+ * Native SDK API reference:
+ *  - SparkWallet.initialize({ mnemonicOrSeed, options: { network } })
+ *  - wallet.getBalance()               → { balance: bigint }
+ *  - wallet.getSparkAddress()          → SparkAddressFormat (string)
+ *  - wallet.getSingleUseDepositAddress() → string (BTC on-chain)
+ *  - wallet.createLightningInvoice({ amountSats, memo? }) → { invoice: { encodedInvoice } }
+ *  - wallet.payLightningInvoice({ invoice, maxFeeSats }) → LightningSendRequest | WalletTransfer
+ *  - wallet.transfer({ receiverSparkAddress, amountSats }) → WalletTransfer
+ *  - wallet.withdraw({ onchainAddress, amountSats, exitSpeed }) → withdrawal result
+ *  - wallet.getTransfers(limit?, offset?, createdAfter?, createdBefore?) → { transfers: WalletTransfer[], offset: number }
+ *  - wallet.getTransfer(id)            → WalletTransfer | undefined
+ *  - wallet.cleanupConnections()       → void
+ *
+ * Amounts in the SDK are in SATS. Balance is returned as bigint.
+ */
+import { IProtocolAdapter, type ProtocolConfig } from "./IProtocolAdapter.js";
+import { SparkTransfer } from "../types/spark.js";
+import { ProtocolType, Layer, NodeInfo, UnifiedAsset, UnifiedTransaction, InvoiceRequest, Invoice, DecodedInvoice, PaymentRequest, PaymentResult, PaymentStatus, Address, ConnectionInfo, TransactionFilter, QuoteRequest, Quote, SwapResult } from "../types/base.js";
+import { invalidateSparkBalanceCache } from "../lib/spark-balance-cache.js";
+export { isEmptyBalance } from "../lib/spark-helpers.js";
+export { invalidateSparkBalanceCache };
+/**
+ * Spark Protocol Adapter Implementation
  */
-import { IProtocolAdapter, BaseProtocolConfig } from './IProtocolAdapter.js';
-import { ProtocolType, Layer, UnifiedAsset, UnifiedTransaction, InvoiceRequest, Invoice, DecodedInvoice, PaymentRequest, PaymentResult, PaymentStatus, Address, ConnectionInfo, TransactionFilter } from '../types/base.js';
 export declare class SparkAdapter implements IProtocolAdapter {
     readonly protocolName: ProtocolType;
-    readonly capabilities: readonly import("..").ProtocolCapability[];
     readonly supportedLayers: Layer[];
     readonly version = "1.0.0";
+    readonly capabilities: readonly import("..").ProtocolCapability[];
     private config;
-    connect(config: BaseProtocolConfig): Promise<void>;
+    /** Maps Lightning invoice string → LightningReceiveRequest ID for status polling. */
+    private invoiceRequestIds;
+    connect(config: ProtocolConfig): Promise<void>;
     disconnect(): Promise<void>;
     isConnected(): boolean;
     getConnectionInfo(): Promise<ConnectionInfo>;
     listAssets(): Promise<UnifiedAsset[]>;
     getAsset(assetId: string): Promise<UnifiedAsset>;
-    getAssetBalance(assetId: string): Promise<UnifiedAsset['balance']>;
+    getAssetBalance(assetId: string): Promise<UnifiedAsset["balance"]>;
     refreshBalances(): Promise<void>;
     listTransactions(filter?: TransactionFilter): Promise<UnifiedTransaction[]>;
     getTransaction(txId: string): Promise<UnifiedTransaction>;
     createInvoice(request: InvoiceRequest): Promise<Invoice>;
-    decodeInvoice(invoice: string): Promise<DecodedInvoice>;
+    createSparkInvoice(request: InvoiceRequest): Promise<Invoice>;
+    decodeInvoice(input: string): Promise<DecodedInvoice>;
     sendPayment(request: PaymentRequest): Promise<PaymentResult>;
-    getPaymentStatus(paymentHash: string): Promise<PaymentStatus>;
+    getPaymentStatus(paymentId: string): Promise<PaymentStatus>;
     getReceiveAddress(assetId?: string): Promise<Address>;
-    getNodeInfo(): Promise<any>;
+    claimSparkL1Deposit(params: {
+        address: string;
+    }): Promise<{
+        status: "awaiting" | "claimed" | "error";
+        txids?: string[];
+        error?: string;
+    }>;
+    /**
+     * Sweep every previously-generated single-use deposit address that is still
+     * unclaimed and credit any confirmed UTXOs paid to them. Each call to
+     * `getSingleUseDepositAddress()` returns a *new* address, so a deposit sent
+     * to an address from a previous session would otherwise stay stranded:
+     * the deposit-screen poller only watches the address currently on screen.
+     * Run this on unlock (after SPARK connects) and when the user opens the
+     * deposit screen so stuck deposits surface as soon as possible.
+     */
+    sweepSparkL1Deposits(): Promise<{
+        addressesChecked: number;
+        claimedTxids: string[];
+        errors: string[];
+    }>;
+    getNodeInfo(): Promise<NodeInfo>;
     getBtcBalance(): Promise<{
         confirmed: number;
         unconfirmed: number;
         total: number;
     }>;
     listChannels(): Promise<[]>;
-    listPayments(): Promise<any>;
+    listPayments(): Promise<{
+        transfers?: SparkTransfer[];
+    }>;
     listTransfers(_options?: {
         asset_id?: string;
-    }): Promise<any>;
-    supportsSwaps(): boolean;
+    }): Promise<{
+        transfers: [];
+    }>;
     sendBtcOnchain(params: {
         address: string;
         amount: number;
-    }): Promise<any>;
-    private convertTransfer;
-    private formatAmount;
+        feeRate?: number;
+    }): Promise<Record<string, unknown>>;
+    signPsbt(psbtHex: string): Promise<{
+        psbt: string;
+        unchanged: boolean;
+    }>;
+    signMessage(message: string): Promise<string>;
+    verifyMessage(message: string, signature: string): Promise<string>;
+    createRgbInvoice(_params: unknown): Promise<never>;
+    decodeRgbInvoice(_params: unknown): Promise<never>;
+    getInvoiceStatus(params: {
+        invoice: string;
+    }): Promise<{
+        status: string;
+    }>;
+    sendAsset(params: {
+        assetId: string;
+        amount: number;
+        recipientId: string;
+        assignment?: {
+            type: string;
+            value: number;
+        } | null;
+        transportEndpoints?: string[];
+        feeRate?: number;
+        donation?: boolean;
+        witness_data?: unknown;
+    }): Promise<Record<string, unknown>>;
+    supportsSwaps(): boolean;
+    getSwapQuote(_request: QuoteRequest): Promise<Quote>;
+    executeSwap(_quote: Quote): Promise<SwapResult>;
+    getSwapStatus(_swapId: string): Promise<SwapResult>;
 }
 //# sourceMappingURL=SparkAdapter.d.ts.map

package/dist/adapters/SparkAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SparkAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/SparkAdapter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAGzE,OAAO,EACL,YAAY,EACZ,KAAK,EACL,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,OAAO,EACP,cAAc,EACd,cAAc,EACd,aAAa,EACb,aAAa,EACb,OAAO,EACP,cAAc,EACd,iBAAiB,EAOlB,MAAM,eAAe,CAAA;AAKtB,qBAAa,YAAa,YAAW,gBAAgB;IACnD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAU;IAC7C,QAAQ,CAAC,YAAY,6CAA4B;IACjD,QAAQ,CAAC,eAAe,EAAE,KAAK,EAAE,CAA4B;IAC7D,QAAQ,CAAC,OAAO,WAAU;IAE1B,OAAO,CAAC,MAAM,CAA2B;IAMnC,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBlD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAMjC,WAAW,IAAI,OAAO;IAIhB,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAwB5C,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IA4ErC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAShD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAKlE,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAQhC,gBAAgB,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAe3E,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA0BzD,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAyBxD,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IASvD,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAwC5D,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAW7D,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBrD,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAsB3B,aAAa,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAYnF,YAAY,IAAI,OAAO,CAAC,EAAE,CAAC;IAI3B,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;IAK5B,aAAa,CAAC,QAAQ,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAQnE,aAAa,IAAI,OAAO;IAIlB,cAAc,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB/E,OAAO,CAAC,eAAe;IAgDvB,OAAO,CAAC,YAAY;CAGrB"}
+{"version":3,"file":"SparkAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/SparkAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAUH,OAAO,EAAE,gBAAgB,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAS3E,OAAO,EAAe,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,EACL,YAAY,EACZ,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,OAAO,EACP,cAAc,EACd,cAAc,EACd,aAAa,EACb,aAAa,EACb,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,KAAK,EACL,UAAU,EAGX,MAAM,eAAe,CAAC;AAuBvB,OAAO,EAEL,2BAA2B,EAE5B,MAAM,4BAA4B,CAAC;AAMpC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,CAAC;AAEvC;;GAEG;AACH,qBAAa,YAAa,YAAW,gBAAgB;IACnD,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAW;IAC9C,QAAQ,CAAC,eAAe,EAAE,KAAK,EAAE,CAA6B;IAC9D,QAAQ,CAAC,OAAO,WAAW;IAC3B,QAAQ,CAAC,YAAY,6CAA6B;IAElD,OAAO,CAAC,MAAM,CAA4B;IAE1C,qFAAqF;IACrF,OAAO,CAAC,iBAAiB,CAA6B;IAMhD,OAAO,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAMjC,WAAW,IAAI,OAAO;IAIhB,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IA8B5C,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IA8ErC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAWhD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAKlE,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAWhC,gBAAgB,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAyP3E,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAwBzD,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAkDxD,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAiC7D,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAqBrD,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAyI5D,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAuC3D,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAyCrD,mBAAmB,CAAC,MAAM,EAAE;QAChC,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAqC3F;;;;;;;;OAQG;IACG,oBAAoB,IAAI,OAAO,CAAC;QACpC,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,MAAM,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IA8CI,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAwBhC,aAAa,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBnF,YAAY,IAAI,OAAO,CAAC,EAAE,CAAC;IAK3B,YAAY,IAAI,OAAO,CAAC;QAAE,SAAS,CAAC,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;IAuBxD,aAAa,CAAC,QAAQ,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,EAAE,CAAA;KAAE,CAAC;IAK3E,cAAc,CAAC,MAAM,EAAE;QAC3B,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA6C9B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,CAAC;IAaxE,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB7C,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQlE,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;IAIlD,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;IAQlD,gBAAgB,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAiD1E,SAAS,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QACpD,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA6GpC,aAAa,IAAI,OAAO;IAIlB,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;IAIpD,WAAW,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAI/C,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAW1D"}