@cryptonly/x402 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Cryptonly
+
+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

@@ -1,3 +1,44 @@
-# Temporary Holding Version
+<img src="https://raw.githubusercontent.com/cryptonly-net/.github/main/profile/assets/header-banner.svg" alt="Cryptonly" width="100%" />
 
-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.
+<div align="center">
+
+# Cryptonly — x402 facilitator
+
+Facilitator client for x402 payments.
+
+[Website](https://cryptonly.net) · [Documentation](https://cryptonly.gitbook.io/docs) · [Contact](https://cryptonly.net/contact/)
+
+</div>
+
+---
+
+Pass it to `x402ResourceServer` from `@x402/express`, `@x402/hono`, or `@x402/next`.
+
+```bash
+npm install @cryptonly/x402
+```
+
+`@x402/core` ^2 is a peer dependency. Also install the framework package you use, such as `@x402/express` or `@x402/evm`.
+
+```ts
+import { CryptonlyFacilitatorClient } from '@cryptonly/x402';
+import { ExactEvmScheme } from '@x402/evm/exact/server';
+import { x402ResourceServer } from '@x402/express';
+
+const facilitator = new CryptonlyFacilitatorClient({
+  apiKey: process.env.CRYPTONLY_API_KEY!,
+});
+
+const server = new x402ResourceServer(facilitator).register(
+  'eip155:8453',
+  new ExactEvmScheme(),
+);
+```
+
+`apiKey` is your Cryptonly API key. It is sent as `x-tenant-api-key` on verify and settle.
+
+```ts
+const facilitator = new CryptonlyFacilitatorClient({
+  apiKey: process.env.CRYPTONLY_API_KEY!,
+});
+```

package/dist/client.d.ts

@@ -0,0 +1,33 @@
+import { HTTPFacilitatorClient } from '@x402/core/server';
+/** Configuration for {@link CryptonlyFacilitatorClient}. */
+export type CryptonlyFacilitatorConfig = {
+    /**
+     * Cryptonly API key.
+     */
+    apiKey: string;
+    /**
+     * When `true`, uses the sandbox facilitator. Defaults to production.
+     */
+    sandbox?: boolean;
+};
+/**
+ * Cryptonly facilitator client for the x402 protocol.
+ *
+ * Extends `HTTPFacilitatorClient` from `@x402/core/server`.
+ *
+ * @example
+ * ```ts
+ * const facilitator = new CryptonlyFacilitatorClient({
+ *   apiKey: process.env.CRYPTONLY_API_KEY!,
+ *   sandbox: true,
+ * });
+ * const server = new x402ResourceServer(facilitator).register(
+ *   'eip155:84532',
+ *   new ExactEvmScheme(),
+ * );
+ * ```
+ */
+export declare class CryptonlyFacilitatorClient extends HTTPFacilitatorClient {
+    constructor(config: CryptonlyFacilitatorConfig);
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAO1D,4DAA4D;AAC5D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AASF;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;gBACvD,MAAM,EAAE,0BAA0B;CAc/C"}

package/dist/client.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CryptonlyFacilitatorClient = void 0;
+const server_1 = require("@x402/core/server");
+const constants_js_1 = require("./constants.js");
+function resolveFacilitatorUrl(config) {
+    const origin = config.sandbox
+        ? constants_js_1.SANDBOX_MERCHANT_API_BASE_URL
+        : constants_js_1.MERCHANT_API_BASE_URL;
+    return `${origin}/x402`;
+}
+/**
+ * Cryptonly facilitator client for the x402 protocol.
+ *
+ * Extends `HTTPFacilitatorClient` from `@x402/core/server`.
+ *
+ * @example
+ * ```ts
+ * const facilitator = new CryptonlyFacilitatorClient({
+ *   apiKey: process.env.CRYPTONLY_API_KEY!,
+ *   sandbox: true,
+ * });
+ * const server = new x402ResourceServer(facilitator).register(
+ *   'eip155:84532',
+ *   new ExactEvmScheme(),
+ * );
+ * ```
+ */
+class CryptonlyFacilitatorClient extends server_1.HTTPFacilitatorClient {
+    constructor(config) {
+        if (!config?.apiKey) {
+            throw new TypeError('CryptonlyFacilitatorClient: `apiKey` is required');
+        }
+        const headers = { [constants_js_1.MERCHANT_API_KEY_HEADER]: config.apiKey };
+        super({
+            url: resolveFacilitatorUrl(config),
+            createAuthHeaders: async () => ({
+                verify: headers,
+                settle: headers,
+                supported: headers,
+            }),
+        });
+    }
+}
+exports.CryptonlyFacilitatorClient = CryptonlyFacilitatorClient;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,8CAA0D;AAC1D,iDAIwB;AAcxB,SAAS,qBAAqB,CAAC,MAAkC;IAC/D,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO;QAC3B,CAAC,CAAC,4CAA6B;QAC/B,CAAC,CAAC,oCAAqB,CAAC;IAC1B,OAAO,GAAG,MAAM,OAAO,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,0BAA2B,SAAQ,8BAAqB;IACnE,YAAY,MAAkC;QAC5C,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC,sCAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;QAC7D,KAAK,CAAC;YACJ,GAAG,EAAE,qBAAqB,CAAC,MAAM,CAAC;YAClC,iBAAiB,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;gBAC9B,MAAM,EAAE,OAAO;gBACf,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE,OAAO;aACnB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAfD,gEAeC"}

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+/** Default origin for the merchant API (no path; no trailing slash). */
+export declare const MERCHANT_API_BASE_URL: "https://api-merchant.cryptonly.net";
+/** Origin for the sandbox merchant API. */
+export declare const SANDBOX_MERCHANT_API_BASE_URL: "https://sandbox-api-merchant.cryptonly.net";
+/** Header that carries the merchant (tenant) API key. */
+export declare const MERCHANT_API_KEY_HEADER: "x-tenant-api-key";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,eAAO,MAAM,qBAAqB,EAAG,oCAA6C,CAAC;AAEnF,2CAA2C;AAC3C,eAAO,MAAM,6BAA6B,EACxC,4CAAqD,CAAC;AAExD,yDAAyD;AACzD,eAAO,MAAM,uBAAuB,EAAG,kBAA2B,CAAC"}

package/dist/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MERCHANT_API_KEY_HEADER = exports.SANDBOX_MERCHANT_API_BASE_URL = exports.MERCHANT_API_BASE_URL = void 0;
+/** Default origin for the merchant API (no path; no trailing slash). */
+exports.MERCHANT_API_BASE_URL = 'https://api-merchant.cryptonly.net';
+/** Origin for the sandbox merchant API. */
+exports.SANDBOX_MERCHANT_API_BASE_URL = 'https://sandbox-api-merchant.cryptonly.net';
+/** Header that carries the merchant (tenant) API key. */
+exports.MERCHANT_API_KEY_HEADER = 'x-tenant-api-key';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AAC3D,QAAA,qBAAqB,GAAG,oCAA6C,CAAC;AAEnF,2CAA2C;AAC9B,QAAA,6BAA6B,GACxC,4CAAqD,CAAC;AAExD,yDAAyD;AAC5C,QAAA,uBAAuB,GAAG,kBAA2B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { CryptonlyFacilitatorClient } from './client.js';
+export type { CryptonlyFacilitatorConfig } from './client.js';
+export { MERCHANT_API_BASE_URL, MERCHANT_API_KEY_HEADER, SANDBOX_MERCHANT_API_BASE_URL, } from './constants.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACzD,YAAY,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SANDBOX_MERCHANT_API_BASE_URL = exports.MERCHANT_API_KEY_HEADER = exports.MERCHANT_API_BASE_URL = exports.CryptonlyFacilitatorClient = void 0;
+var client_js_1 = require("./client.js");
+Object.defineProperty(exports, "CryptonlyFacilitatorClient", { enumerable: true, get: function () { return client_js_1.CryptonlyFacilitatorClient; } });
+var constants_js_1 = require("./constants.js");
+Object.defineProperty(exports, "MERCHANT_API_BASE_URL", { enumerable: true, get: function () { return constants_js_1.MERCHANT_API_BASE_URL; } });
+Object.defineProperty(exports, "MERCHANT_API_KEY_HEADER", { enumerable: true, get: function () { return constants_js_1.MERCHANT_API_KEY_HEADER; } });
+Object.defineProperty(exports, "SANDBOX_MERCHANT_API_BASE_URL", { enumerable: true, get: function () { return constants_js_1.SANDBOX_MERCHANT_API_BASE_URL; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAAyD;AAAhD,uHAAA,0BAA0B,OAAA;AAEnC,+CAIwB;AAHtB,qHAAA,qBAAqB,OAAA;AACrB,uHAAA,uBAAuB,OAAA;AACvB,6HAAA,6BAA6B,OAAA"}

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@cryptonly/x402",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Cryptonly facilitator client for the x402 payment protocol.",
+  "license": "MIT",
+  "private": false,
+  "type": "commonjs",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cryptonly-net/x402.git"
+  },
+  "homepage": "https://github.com/cryptonly-net/x402#readme",
+  "bugs": {
+    "url": "https://github.com/cryptonly-net/x402/issues"
+  },
+  "keywords": [
+    "cryptonly",
+    "x402",
+    "facilitator",
+    "payments",
+    "client",
+    "typescript"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rm -rf dist",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build",
+    "test": "jest"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@x402/core": "^2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@x402/core": "^2.28.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.0",
+    "typescript": "^5.9.3"
+  }
+}