@qntx/spark 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+qntx/spark
+Copyright 2026 QuantX
+
+This product includes software derived from Spark (https://github.com/buildonspark/spark),
+Copyright Lightspark Group, Inc., licensed under the Apache License, Version 2.0.
+Modified files carry a notice stating the upstream path, commit and changes.

package/README.md

@@ -1,3 +1,60 @@
-# Temporary Holding Version
+# @qntx/spark
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Platform-neutral TypeScript implementation of the [Spark](https://github.com/buildonspark/spark)
+Bitcoin L2 protocol. Cryptographic backends (`@qntx/spark-wasm`, `@qntx/spark-native`) plug into
+the `SparkCrypto` interface exported from `@qntx/spark/crypto`.
+
+Status: **pre-release**. See the [repository](https://github.com/qntx/spark) and
+[CHANGELOG](https://github.com/qntx/spark/blob/main/CHANGELOG.md).
+
+## Security
+
+Trust model: a leaf is spendable only with the signing-operator threshold plus the wallet's key —
+no single operator can move funds. The wallet verifies locally every transaction it signs
+(refunds and exit transactions), that every stored exit chain's refunds pay the wallet's own
+leaf key, that a deposit address's proof of possession is valid, and that every operator reports
+a leaf identically — and token outputs and committed transfers likewise count only when
+every operator reports them identically, so a single operator cannot inflate a balance or
+forge a spend. Lightning sends and receives, leaves swaps, cooperative exits and
+static-deposit claims go through the SSP; the client validates the SSP responses it acts on
+(invoice and transfer-id echoes, payment-hash↔preimage proofs, connector and payout
+transactions, fee bounds).
+
+Leaf quarantine: a leaf the operators report differently, or whose served exit chain fails
+verification, is excluded from balance and spending; a previously stored (verified) exit chain
+is kept, and `withdrawals.unilateralExit` on that leaf reports the precise failure.
+
+Key custody: private keys never leave the `SparkSigner` — the client only ever sees protocol
+values (public keys, signatures, ciphertexts).
+
+Idempotent retries: `transfers.send`/`sendMany`, `lightning.pay` and
+`withdrawals.cooperativeExit` accept a `transferId` — reuse the same id to retry a call whose
+response may have committed; the same id with different terms fails rather than paying twice.
+`tokens.transfer`/`tokens.consolidate` throw `SparkTokenBroadcastError` when the broadcast
+outcome is uncertain — retry with `inputOutputIds: error.inputOutputIds` and the same receiver
+and amount; that retry either returns the committed transaction's hash or broadcasts exactly
+those inputs once. Retrying without it would select different outputs and pay twice.
+
+Offline receive: once a transfer commits, the sender cannot cancel it and its expiry does not
+return it — `transfers.claim`/`claimPending` can pick it up at any later time.
+
+Unilateral exit: each pre-signed transaction carries a hard deadline — once its parent confirms
+and its relative timelock passes, it must confirm within 50 blocks; otherwise the operators'
+watchtower may publish a self-fee variant instead. For intermediate nodes this strands
+descendants as WATCHTOWER_EXITED (recover with `recoverWatchtowerExit` while the SO is online);
+for refunds the watchtower publishes `direct_from_cpfp_refund_tx`, which pays the leaf key
+(sweep with `sweepRefund`). Keep each exit package confirming promptly. Exit chains persist in
+the `SparkStore` passed to `createSparkClient` (required — `createMemorySparkStore()` for
+ephemeral wallets); a chain is deleted only when every operator endorses it as no longer
+exitable by this wallet, so a withheld or fabricated coordinator response cannot erase the
+offline exit path.
+
+LNURL server (`apps/lnurl-server`): put per-IP rate limiting in front of the endpoints —
+invoice creation is unauthenticated. Zap receipt relays are payer-controlled URLs that can
+resolve to internal addresses (DNS rebinding): run the service where outbound connections to
+internal ranges are denied at the network layer.
+
+Status: multiple internal review rounds plus two external audit rounds scoped by
+[AUDIT.md](https://github.com/qntx/spark/blob/main/AUDIT.md); not yet run on mainnet.
+
+Licensed under the Apache License, Version 2.0; see LICENSE and NOTICE.

package/dist/bolt11-DsNTTS_O.d.mts

@@ -0,0 +1,52 @@
+//#region src/core/bolt11.d.ts
+type Bolt11Network = "mainnet" | "regtest" | "testnet" | "signet";
+type Bolt11RouteHintHop = {
+  /** 33-byte compressed public key of the node starting the channel. */
+  readonly publicKey: Uint8Array;
+  /** 8-byte short channel id. */
+  readonly shortChannelId: Uint8Array;
+  readonly feeBaseMsat: number;
+  readonly feeProportionalMillionths: number;
+  readonly cltvExpiryDelta: number;
+};
+/**
+ * Raw `f` field. Versions 0–16 are segwit witness programs, 17 is P2PKH, 18 is P2SH, 19–30 are
+ * unassigned, and the upstream Spark SDK uses 31 for an embedded Spark invoice
+ * (`parseSparkFallbackAddress`).
+ */
+type Bolt11FallbackAddress = {
+  readonly version: number;
+  readonly program: Uint8Array;
+};
+type Bolt11Invoice = {
+  readonly network: Bolt11Network;
+  /** Amount in millisatoshis; absent for "any amount" invoices. */
+  readonly amountMsat?: bigint | undefined;
+  /** Seconds since the unix epoch. */
+  readonly timestamp: number;
+  readonly paymentHash: Uint8Array;
+  readonly paymentSecret: Uint8Array;
+  readonly description?: string | undefined;
+  readonly descriptionHash?: Uint8Array | undefined;
+  readonly expirySeconds: number;
+  readonly minFinalCltvExpiry: number;
+  /** 33-byte payee public key: verified `n` field, or recovered from the signature. */
+  readonly payee: Uint8Array;
+  /** Raw big-endian feature bitfield of the `9` field. */
+  readonly features?: Uint8Array | undefined;
+  /** One entry per `r` field; each is an ordered list of private-route hops. */
+  readonly routeHints: ReadonlyArray<ReadonlyArray<Bolt11RouteHintHop>>;
+  readonly fallbackAddresses: ReadonlyArray<Bolt11FallbackAddress>;
+  /** Raw `m` field. */
+  readonly metadata?: Uint8Array | undefined;
+};
+/**
+ * Decodes a BOLT-11 payment request. Throws {@link SparkInputError} on malformed input: bad bech32,
+ * unknown prefix, bad amount, missing required fields, unknown even feature bits, or a signature
+ * that fails verification/recovery.
+ */
+declare function decodeBolt11(invoice: string): Bolt11Invoice;
+/** True once `timestamp + expirySeconds` has passed at `nowMs` (unix milliseconds). */
+declare function isExpired(invoice: Bolt11Invoice, nowMs: number): boolean;
+//#endregion
+export { isExpired as i, Bolt11Network as n, decodeBolt11 as r, Bolt11Invoice as t };

package/dist/crypto.d.mts

@@ -0,0 +1,3 @@
+import { n as SparkError, t as SparkCryptoError } from "./index-D1fBaHTa.mjs";
+import { n as SparkCrypto, t as SPARK_ABI_VERSION } from "./index-DUSx3L3J.mjs";
+export { SPARK_ABI_VERSION, SparkCrypto, SparkCryptoError, SparkError };

package/dist/crypto.mjs

@@ -0,0 +1,9 @@
+import { n as SparkError, t as SparkCryptoError } from "./errors-5xLkExNL.mjs";
+//#region src/crypto/index.ts
+/**
+* C ABI version implemented by a {@link SparkCrypto} backend. Bumped only when `qntx_spark.h`
+* changes incompatibly; the signer verifies it at construction.
+*/
+const SPARK_ABI_VERSION = 1;
+//#endregion
+export { SPARK_ABI_VERSION, SparkCryptoError, SparkError };

package/dist/errors-5xLkExNL.mjs

@@ -0,0 +1,67 @@
+//#region src/errors/index.ts
+/** Base class of every error raised by this package. */
+var SparkError = class extends Error {
+	constructor(message, options) {
+		super(message, options);
+		this.name = "SparkError";
+	}
+};
+/**
+* A failure reported by a {@link SparkCrypto} backend. `code` is the C ABI error code (see
+* `qntx_spark.h`); the message never carries input bytes.
+*/
+var SparkCryptoError = class extends SparkError {
+	code;
+	constructor(code, options) {
+		super(`spark crypto backend failed (code ${code})`, options);
+		this.name = "SparkCryptoError";
+		this.code = code;
+	}
+};
+/**
+* Malformed caller- or peer-supplied data: a Spark address, a BOLT-11 invoice, an encoding. The
+* message names the offending field and rule; it never echoes the input, so no secret or invoice
+* content leaks into logs through error messages.
+*/
+var SparkInputError = class extends SparkError {
+	constructor(message, options) {
+		super(message, options);
+		this.name = "SparkInputError";
+	}
+};
+/**
+* A request to a signing operator or the SSP failed. `code` uses one vocabulary: the gRPC canonical
+* snake_case names for operator errors ("unauthenticated", "unavailable", "invalid_argument",
+* "deadline_exceeded", … — Connect's PascalCase enum names are mapped down), `http_<status>` for
+* SSP HTTP failures, `unexpected_response` for malformed SSP responses, and the SSP's GraphQL
+* `extensions.code` lowercased. `operator` is the FROST identifier of the operator that failed,
+* when the failure came from an operator. The message carries the server's own message — never
+* request bodies.
+*/
+var SparkRequestError = class extends SparkError {
+	code;
+	operator;
+	constructor(message, options) {
+		super(message, options);
+		this.name = "SparkRequestError";
+		this.code = options?.code;
+		this.operator = options?.operator;
+	}
+};
+/**
+* A token broadcast's outcome is uncertain: the transaction may have committed server-side.
+* `inputOutputIds` names the spent outputs — the caller passes it back to `tokens.transfer` or
+* `tokens.consolidate` with the same receiver and amount, and that retry either returns the
+* committed transaction's hash or broadcasts exactly those inputs once. Retrying without it would
+* select different outputs and pay twice.
+*/
+var SparkTokenBroadcastError = class extends SparkRequestError {
+	inputOutputIds;
+	constructor(message, options) {
+		super(message, options);
+		this.name = "SparkTokenBroadcastError";
+		this.inputOutputIds = options.inputOutputIds;
+	}
+};
+//#endregion
+export { SparkTokenBroadcastError as a, SparkRequestError as i, SparkError as n, SparkInputError as r, SparkCryptoError as t };