bsv-x402 0.1.0

package/LICENSE

@@ -0,0 +1,86 @@
+Open BSV License Version 5 – granted by BSV Association, Grafenauweg 6, 6300
+Zug, Switzerland (CHE-427.008.338) ("Licensor"), to you as a user (henceforth
+"You", "User" or "Licensee").
+
+For the purposes of this license, the definitions below have the following
+meanings:
+
+"Bitcoin Protocol" means the protocol implementation, cryptographic rules,
+network protocols, and consensus mechanisms in the Bitcoin White Paper as
+described here https://protocol.bsvblockchain.org.
+
+"Bitcoin White Paper" means the paper entitled 'Bitcoin: A Peer-to-Peer
+Electronic Cash System' published by 'Satoshi Nakamoto' in October 2008.
+
+"BSV Blockchains" means:
+  (a) the Bitcoin blockchain containing block height #556767 with the hash
+      "000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
+      that contains the longest honest persistent chain of blocks which has been
+      produced in a manner which is consistent with the rules set forth in the
+      Network Access Rules; and
+  (b) the test blockchains that contain the longest honest persistent chains of
+      blocks which has been produced in a manner which is consistent with the
+      rules set forth in the Network Access Rules.
+
+"Network Access Rules" or "Rules" means the set of rules regulating the
+relationship between BSV Association and the nodes on BSV based on the Bitcoin
+Protocol rules and those set out in the Bitcoin White Paper, and available here
+https://bsvblockchain.org/network-access-rules.
+
+"Software" means the software the subject of this licence, including any/all
+intellectual property rights therein and associated documentation files.
+
+BSV Association grants permission, free of charge and on a non-exclusive and
+revocable basis, to any person obtaining a copy of the Software to deal in the
+Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to and conditioned upon the following conditions:
+
+1 - The text "© BSV Association," and this license shall be included in all
+copies or substantial portions of the Software.
+2 - The Software, and any software that is derived from the Software or parts
+thereof, must only be used on the BSV Blockchains.
+
+For the avoidance of doubt, this license is granted subject to and conditioned
+upon your compliance with these terms only. In the event of non-compliance, the
+license shall extinguish and you can be enjoined from violating BSV's
+intellectual property rights (incl. damages and similar related claims).
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES REGARDING ENTITLEMENT,
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS THEREOF BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+
+Version 0.1.1 of the Bitcoin SV software, and prior versions of software upon
+which it was based, were licensed under the MIT License, which is included below.
+
+The MIT License (MIT)
+
+Copyright (c) 2009-2010 Satoshi Nakamoto
+Copyright (c) 2009-2015 Bitcoin Developers
+Copyright (c) 2009-2017 The Bitcoin Core developers
+Copyright (c) 2017 The Bitcoin ABC developers
+Copyright (c) 2018 Bitcoin Association for BSV
+Copyright (c) 2023 BSV Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# @x402/client
+
+A JavaScript client library for the [x402 payment protocol](https://x402.merkleworks.io/). Wraps `fetch()` to handle HTTP 402 payment flows transparently.
+
+## How It Works
+
+```js
+import { x402Fetch } from '@x402/client'
+
+const response = await x402Fetch('https://api.example.com/paid-endpoint')
+```
+
+When the server responds with `402 Payment Required`, the library:
+
+1. Parses the `X402-Challenge` header
+2. Constructs a payment transaction via the browser wallet ([BRC-100](https://github.com/bitcoin-sv/BRCs/blob/master/wallet/0100.md) / `window.CWI`)
+3. Broadcasts the transaction to the BSV network
+4. Retries the original request with an `X402-Proof` header
+
+The app developer just uses `x402Fetch` in place of `fetch`. The browser wallet handles key management and signing.
+
+## Installation
+
+```bash
+npm install @x402/client
+```
+
+## Development
+
+```bash
+npm install       # Install dependencies
+npm run build     # Compile TypeScript → dist/
+npm test          # Run tests
+npm run typecheck # Type-check without emitting
+```
+
+## Status
+
+Early development. The fetch wrapper and challenge parsing are in place; the BRC-100 wallet integration (`constructProof`) is not yet implemented.

package/dist/index.cjs

@@ -0,0 +1,56 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  parseChallenge: () => parseChallenge,
+  x402Fetch: () => x402Fetch
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/challenge.ts
+function parseChallenge(header) {
+  return JSON.parse(header);
+}
+
+// src/x402-fetch.ts
+async function x402Fetch(input, init) {
+  const response = await fetch(input, init);
+  if (response.status !== 402) {
+    return response;
+  }
+  const challengeHeader = response.headers.get("X402-Challenge");
+  if (!challengeHeader) {
+    return response;
+  }
+  const challenge = parseChallenge(challengeHeader);
+  const proof = await constructProof(challenge);
+  const headers = new Headers(init?.headers);
+  headers.set("X402-Proof", JSON.stringify(proof));
+  return fetch(input, { ...init, headers });
+}
+async function constructProof(challenge) {
+  throw new Error("Not implemented \u2014 requires BRC-100 wallet (window.CWI)");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  parseChallenge,
+  x402Fetch
+});

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+declare function x402Fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+
+interface Challenge {
+    nonce: string;
+    payee: string;
+    amount: number;
+    network: string;
+}
+interface Proof {
+    txid: string;
+    rawTx: string;
+}
+
+declare function parseChallenge(header: string): Challenge;
+
+export { type Challenge, type Proof, parseChallenge, x402Fetch };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+declare function x402Fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+
+interface Challenge {
+    nonce: string;
+    payee: string;
+    amount: number;
+    network: string;
+}
+interface Proof {
+    txid: string;
+    rawTx: string;
+}
+
+declare function parseChallenge(header: string): Challenge;
+
+export { type Challenge, type Proof, parseChallenge, x402Fetch };

package/dist/index.js

@@ -0,0 +1,28 @@
+// src/challenge.ts
+function parseChallenge(header) {
+  return JSON.parse(header);
+}
+
+// src/x402-fetch.ts
+async function x402Fetch(input, init) {
+  const response = await fetch(input, init);
+  if (response.status !== 402) {
+    return response;
+  }
+  const challengeHeader = response.headers.get("X402-Challenge");
+  if (!challengeHeader) {
+    return response;
+  }
+  const challenge = parseChallenge(challengeHeader);
+  const proof = await constructProof(challenge);
+  const headers = new Headers(init?.headers);
+  headers.set("X402-Proof", JSON.stringify(proof));
+  return fetch(input, { ...init, headers });
+}
+async function constructProof(challenge) {
+  throw new Error("Not implemented \u2014 requires BRC-100 wallet (window.CWI)");
+}
+export {
+  parseChallenge,
+  x402Fetch
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "bsv-x402",
+  "version": "0.1.0",
+  "description": "x402 payment protocol client — a fetch() wrapper that handles 402 payment flows transparently",
+  "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"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  }
+}