@vauban-pay/substrate 0.1.0

package/LICENSE

@@ -0,0 +1,179 @@
+                                 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 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 transformations
+      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 its Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the 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 tracking such
+      submissions, but excluding communication that is conspicuously marked
+      or designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been submitted to the Licensor.
+
+   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 contributions
+      Licensable by such Contributor that are necessarily infringed by their
+      Contributor contribution(s) alone or by the 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, You must include a readable copy of the attribution
+          notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and may
+      provide additional grant of rights to use, reproduce, modify, and
+      distribute those modifications as a Derivative Work, either on the terms
+      of this License or with separate terms and conditions covering those
+      modifications.
+
+   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 reproducing 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
+      exemplary 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 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 offer such conditions 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
+
+   Copyright 2026 Vauban Research <research@vauban.tech>
+
+   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/README.md

@@ -0,0 +1,52 @@
+# @vauban-pay/substrate
+
+TypeScript reference runner for JCS (RFC 8785) preimage discipline in the
+x402 STARK Receipt Format Extension
+([draft-vauban-x402-stark-receipts](https://datatracker.ietf.org/doc/draft-vauban-x402-stark-receipts/)).
+
+Sister implementations:
+
+- Rust: [`vauban-x402-jcs-conformance`](https://crates.io/crates/vauban-x402-jcs-conformance) v0.1.0 (live on crates.io)
+- Python: [`vauban-x402-stark-receipt`](https://pypi.org/project/vauban-x402-stark-receipt/)
+
+## Install
+
+```sh
+pnpm add @vauban-pay/substrate
+```
+
+## API
+
+```ts
+import { jcsCanonicalBytes, jcsSha256, jcsHash, validatePairInvariant } from "@vauban-pay/substrate";
+
+// Canonical UTF-8 bytes (RFC 8785 key sort, no whitespace)
+const bytes: Uint8Array = jcsCanonicalBytes({ amount: 100, currency: "STRK" });
+
+// SHA-256 over canonical bytes, prefixed "sha256:<hex64>"
+const digest: string = jcsSha256({ amount: 100, currency: "STRK" });
+// => "sha256:a3f9..."
+
+// Both in one call (camelCase TS; Rust struct uses snake_case)
+const { base64Canonical, sha256 } = jcsHash({ amount: 100, currency: "STRK" });
+
+// Pair invariant: key order is irrelevant, array order is significant
+const ok: boolean = validatePairInvariant({ a: 1, b: 2 }, { b: 2, a: 1 }); // true
+```
+
+**Rust/TS name mapping** (snake_case Rust; camelCase TS):
+`jcs_canonical_bytes` ; `jcsCanonicalBytes` |
+`jcs_sha256` ; `jcsSha256` |
+`jcs_hash` ; `jcsHash` |
+`validate_pair_invariant` ; `validatePairInvariant`
+
+Errors surface as `CanonicalisationError` (subclass of `Error`).
+
+## Spec reference
+
+IETF I-D: [draft-vauban-x402-stark-receipts-00](https://datatracker.ietf.org/doc/draft-vauban-x402-stark-receipts/)
+RFC 8785 (JCS): https://www.rfc-editor.org/rfc/rfc8785
+
+## License
+
+Apache-2.0 - Vauban Research <research@vauban.tech> - https://pay.vauban.tech

package/dist/index.cjs

@@ -0,0 +1,93 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  CanonicalisationError: () => CanonicalisationError,
+  jcsCanonicalBytes: () => jcsCanonicalBytes,
+  jcsHash: () => jcsHash,
+  jcsSha256: () => jcsSha256,
+  validatePairInvariant: () => validatePairInvariant
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/jcs.ts
+var import_node_crypto = require("crypto");
+var import_canonicalize = __toESM(require("canonicalize"), 1);
+var CanonicalisationError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "CanonicalisationError";
+  }
+};
+function jcsCanonicalBytes(body) {
+  const serialised = (0, import_canonicalize.default)(body);
+  if (serialised === void 0) {
+    throw new CanonicalisationError(
+      "canonicalize returned undefined; value may contain undefined, Infinity, NaN, or a function"
+    );
+  }
+  return new TextEncoder().encode(serialised);
+}
+function jcsSha256(body) {
+  const bytes = jcsCanonicalBytes(body);
+  const digest = (0, import_node_crypto.createHash)("sha256").update(bytes).digest("hex");
+  return `sha256:${digest}`;
+}
+function jcsHash(body) {
+  const bytes = jcsCanonicalBytes(body);
+  const base64Canonical = Buffer.from(bytes).toString("base64");
+  const digest = (0, import_node_crypto.createHash)("sha256").update(bytes).digest("hex");
+  return {
+    base64Canonical,
+    sha256: `sha256:${digest}`
+  };
+}
+function validatePairInvariant(left, right) {
+  try {
+    const leftBytes = jcsCanonicalBytes(left);
+    const rightBytes = jcsCanonicalBytes(right);
+    if (leftBytes.length !== rightBytes.length) return false;
+    for (let i = 0; i < leftBytes.length; i++) {
+      if (leftBytes[i] !== rightBytes[i]) return false;
+    }
+    return true;
+  } catch {
+    return false;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CanonicalisationError,
+  jcsCanonicalBytes,
+  jcsHash,
+  jcsSha256,
+  validatePairInvariant
+});

package/dist/index.d.cts

@@ -0,0 +1,51 @@
+/**
+ * Thrown when canonicalize returns undefined (e.g., undefined input, or
+ * a value that RFC 8785 cannot represent such as a bare function).
+ */
+declare class CanonicalisationError extends Error {
+    constructor(message: string);
+}
+/**
+ * Produce the JCS (RFC 8785) canonical UTF-8 byte representation of `body`.
+ *
+ * Mirrors Rust: `jcs_canonical_bytes(value: &impl Serialize) -> Vec<u8>`
+ *
+ * Throws `CanonicalisationError` if the value cannot be serialised
+ * (e.g., `undefined`, `Infinity`, `NaN`, or bare functions).
+ */
+declare function jcsCanonicalBytes(body: unknown): Uint8Array;
+/**
+ * Compute SHA-256 over the JCS canonical bytes of `body`.
+ * Returns the digest in hex, prefixed with "sha256:".
+ *
+ * Mirrors Rust: `jcs_sha256(value: &impl Serialize) -> String`
+ * The "sha256:<hex>" convention is the canonical Vauban preimage tag.
+ */
+declare function jcsSha256(body: unknown): string;
+/**
+ * Compute JCS canonical bytes + SHA-256 digest in a single pass.
+ * Returns both the base64-encoded canonical JSON and the "sha256:<hex>" tag.
+ *
+ * Mirrors Rust: `jcs_hash(value: &impl Serialize) -> JcsHash`
+ * where JcsHash { base64_canonical, sha256 }.
+ *
+ * TypeScript field names are camelCase per TS convention;
+ * Rust struct uses snake_case (base64_canonical / sha256).
+ */
+declare function jcsHash(body: unknown): {
+    base64Canonical: string;
+    sha256: string;
+};
+/**
+ * Verify that two independently-serialised values produce identical JCS canonical bytes.
+ * Used to validate the pair invariant: canonical(A) == canonical(B) iff A and B are
+ * semantically equivalent under RFC 8785 (same keys, same values, key order irrelevant).
+ *
+ * Mirrors Rust: `validate_pair_invariant(left: &impl Serialize, right: &impl Serialize) -> bool`
+ *
+ * Returns `false` (rather than throwing) when either value cannot be canonicalised,
+ * matching the Rust `Result::is_ok()` -> bool semantic.
+ */
+declare function validatePairInvariant(left: unknown, right: unknown): boolean;
+
+export { CanonicalisationError, jcsCanonicalBytes, jcsHash, jcsSha256, validatePairInvariant };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Thrown when canonicalize returns undefined (e.g., undefined input, or
+ * a value that RFC 8785 cannot represent such as a bare function).
+ */
+declare class CanonicalisationError extends Error {
+    constructor(message: string);
+}
+/**
+ * Produce the JCS (RFC 8785) canonical UTF-8 byte representation of `body`.
+ *
+ * Mirrors Rust: `jcs_canonical_bytes(value: &impl Serialize) -> Vec<u8>`
+ *
+ * Throws `CanonicalisationError` if the value cannot be serialised
+ * (e.g., `undefined`, `Infinity`, `NaN`, or bare functions).
+ */
+declare function jcsCanonicalBytes(body: unknown): Uint8Array;
+/**
+ * Compute SHA-256 over the JCS canonical bytes of `body`.
+ * Returns the digest in hex, prefixed with "sha256:".
+ *
+ * Mirrors Rust: `jcs_sha256(value: &impl Serialize) -> String`
+ * The "sha256:<hex>" convention is the canonical Vauban preimage tag.
+ */
+declare function jcsSha256(body: unknown): string;
+/**
+ * Compute JCS canonical bytes + SHA-256 digest in a single pass.
+ * Returns both the base64-encoded canonical JSON and the "sha256:<hex>" tag.
+ *
+ * Mirrors Rust: `jcs_hash(value: &impl Serialize) -> JcsHash`
+ * where JcsHash { base64_canonical, sha256 }.
+ *
+ * TypeScript field names are camelCase per TS convention;
+ * Rust struct uses snake_case (base64_canonical / sha256).
+ */
+declare function jcsHash(body: unknown): {
+    base64Canonical: string;
+    sha256: string;
+};
+/**
+ * Verify that two independently-serialised values produce identical JCS canonical bytes.
+ * Used to validate the pair invariant: canonical(A) == canonical(B) iff A and B are
+ * semantically equivalent under RFC 8785 (same keys, same values, key order irrelevant).
+ *
+ * Mirrors Rust: `validate_pair_invariant(left: &impl Serialize, right: &impl Serialize) -> bool`
+ *
+ * Returns `false` (rather than throwing) when either value cannot be canonicalised,
+ * matching the Rust `Result::is_ok()` -> bool semantic.
+ */
+declare function validatePairInvariant(left: unknown, right: unknown): boolean;
+
+export { CanonicalisationError, jcsCanonicalBytes, jcsHash, jcsSha256, validatePairInvariant };

package/dist/index.js

@@ -0,0 +1,52 @@
+// src/jcs.ts
+import { createHash } from "crypto";
+import canonicalize from "canonicalize";
+var CanonicalisationError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "CanonicalisationError";
+  }
+};
+function jcsCanonicalBytes(body) {
+  const serialised = canonicalize(body);
+  if (serialised === void 0) {
+    throw new CanonicalisationError(
+      "canonicalize returned undefined; value may contain undefined, Infinity, NaN, or a function"
+    );
+  }
+  return new TextEncoder().encode(serialised);
+}
+function jcsSha256(body) {
+  const bytes = jcsCanonicalBytes(body);
+  const digest = createHash("sha256").update(bytes).digest("hex");
+  return `sha256:${digest}`;
+}
+function jcsHash(body) {
+  const bytes = jcsCanonicalBytes(body);
+  const base64Canonical = Buffer.from(bytes).toString("base64");
+  const digest = createHash("sha256").update(bytes).digest("hex");
+  return {
+    base64Canonical,
+    sha256: `sha256:${digest}`
+  };
+}
+function validatePairInvariant(left, right) {
+  try {
+    const leftBytes = jcsCanonicalBytes(left);
+    const rightBytes = jcsCanonicalBytes(right);
+    if (leftBytes.length !== rightBytes.length) return false;
+    for (let i = 0; i < leftBytes.length; i++) {
+      if (leftBytes[i] !== rightBytes[i]) return false;
+    }
+    return true;
+  } catch {
+    return false;
+  }
+}
+export {
+  CanonicalisationError,
+  jcsCanonicalBytes,
+  jcsHash,
+  jcsSha256,
+  validatePairInvariant
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@vauban-pay/substrate",
+  "version": "0.1.0",
+  "description": "TypeScript reference runner for JCS (RFC 8785) preimage discipline in x402 STARK Receipt Format Extension (draft-vauban-x402-stark-receipts).",
+  "license": "Apache-2.0",
+  "author": "Vauban Research <research@vauban.tech>",
+  "homepage": "https://pay.vauban.tech",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vauban-org/vauban-zkpay"
+  },
+  "bugs": {
+    "url": "https://github.com/vauban-org/vauban-zkpay/issues"
+  },
+  "keywords": [
+    "x402",
+    "jcs",
+    "stark",
+    "receipt",
+    "canonical",
+    "preimage",
+    "ietf"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "canonicalize": "^3.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "tsup": "^8.0.0",
+    "vitest": "^1.0.0",
+    "eslint": "^9.0.0",
+    "@types/node": "^20.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=8.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "test": "vitest run",
+    "lint": "eslint src --max-warnings 0"
+  }
+}