@bosonprotocol/x402-core 0.1.0-alpha-0

package/dist/schemas/payment_payload.schema.json

@@ -0,0 +1,156 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://bosonprotocol.io/schemas/x402-core/payment_payload.schema.json",
+  "title": "x402B escrow PaymentPayload",
+  "description": "Wire-format PaymentPayload for the `escrow` scheme (carried base64-encoded in the `X-PAYMENT` header). Source: docs/boson-impl-01-escrow-scheme.md §3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["x402Version", "scheme", "network", "payload"],
+  "definitions": {
+    "address": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" },
+    "hex": { "type": "string", "pattern": "^0x[a-fA-F0-9]+$" },
+    "hexBytes": { "type": "string", "pattern": "^0x[a-fA-F0-9]*$" },
+    "hex32": { "type": "string", "pattern": "^0x[a-fA-F0-9]{64}$" },
+    "decimalUint": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" },
+    "sig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["v", "r", "s"],
+      "properties": {
+        "v": { "type": "integer" },
+        "r": { "$ref": "#/definitions/hex32" },
+        "s": { "$ref": "#/definitions/hex32" }
+      }
+    },
+    "metaTx": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["from", "nonce", "functionName", "functionSignature", "sig"],
+      "properties": {
+        "from": { "$ref": "#/definitions/address" },
+        "nonce": { "$ref": "#/definitions/decimalUint" },
+        "functionName": { "type": "string", "minLength": 1 },
+        "functionSignature": { "$ref": "#/definitions/hexBytes" },
+        "sig": { "$ref": "#/definitions/sig" }
+      }
+    },
+    "erc3009Auth": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "data"],
+      "properties": {
+        "kind": { "const": "erc3009" },
+        "data": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["from", "to", "value", "validAfter", "validBefore", "nonce", "v", "r", "s"],
+          "properties": {
+            "from": { "$ref": "#/definitions/address" },
+            "to": { "$ref": "#/definitions/address" },
+            "value": { "$ref": "#/definitions/decimalUint" },
+            "validAfter": { "type": "integer", "minimum": 0 },
+            "validBefore": { "type": "integer", "minimum": 0 },
+            "nonce": { "$ref": "#/definitions/hex32" },
+            "v": { "type": "integer" },
+            "r": { "$ref": "#/definitions/hex32" },
+            "s": { "$ref": "#/definitions/hex32" }
+          }
+        }
+      }
+    },
+    "permitAuth": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "data"],
+      "properties": {
+        "kind": { "const": "permit" },
+        "data": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["owner", "spender", "value", "deadline", "nonce", "v", "r", "s"],
+          "properties": {
+            "owner": { "$ref": "#/definitions/address" },
+            "spender": { "$ref": "#/definitions/address" },
+            "value": { "$ref": "#/definitions/decimalUint" },
+            "deadline": { "type": "integer", "minimum": 0 },
+            "nonce": { "$ref": "#/definitions/decimalUint" },
+            "v": { "type": "integer" },
+            "r": { "$ref": "#/definitions/hex32" },
+            "s": { "$ref": "#/definitions/hex32" }
+          }
+        }
+      }
+    },
+    "permit2Auth": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "data"],
+      "properties": {
+        "kind": { "const": "permit2" },
+        "data": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["permitted", "spender", "nonce", "deadline", "signature"],
+          "properties": {
+            "permitted": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["token", "amount"],
+              "properties": {
+                "token": { "$ref": "#/definitions/address" },
+                "amount": { "$ref": "#/definitions/decimalUint" }
+              }
+            },
+            "spender": { "$ref": "#/definitions/address" },
+            "nonce": { "$ref": "#/definitions/decimalUint" },
+            "deadline": { "type": "integer", "minimum": 0 },
+            "signature": { "$ref": "#/definitions/hex" }
+          }
+        }
+      }
+    }
+  },
+  "properties": {
+    "x402Version": { "type": "integer" },
+    "scheme": { "const": "escrow" },
+    "network": { "type": "string", "pattern": "^eip155:[1-9][0-9]*$" },
+    "payload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["action", "tokenAuthStrategy", "offerRef", "buyer", "metaTx"],
+      "properties": {
+        "action": { "type": "string", "minLength": 1 },
+        "tokenAuthStrategy": { "enum": ["none", "erc3009", "permit", "permit2"] },
+        "offerRef": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["fullOffer", "sellerSig"],
+          "properties": {
+            "fullOffer": { "type": "object" },
+            "sellerSig": { "$ref": "#/definitions/hex" }
+          }
+        },
+        "buyer": { "$ref": "#/definitions/address" },
+        "metaTx": { "$ref": "#/definitions/metaTx" },
+        "tokenAuth": {
+          "oneOf": [
+            { "$ref": "#/definitions/erc3009Auth" },
+            { "$ref": "#/definitions/permitAuth" },
+            { "$ref": "#/definitions/permit2Auth" }
+          ]
+        }
+      }
+    },
+    "fulfillment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["option"],
+      "properties": {
+        "option": { "type": "string", "minLength": 1 },
+        "data": {
+          "oneOf": [{ "type": "object" }, { "type": "null" }]
+        }
+      }
+    }
+  }
+}

package/dist/schemas/payment_requirements.schema.json

@@ -0,0 +1,135 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://bosonprotocol.io/schemas/x402-core/payment_requirements.schema.json",
+  "title": "x402B escrow PaymentRequirements",
+  "description": "Wire-format PaymentRequirements for the `escrow` scheme. Source: docs/boson-impl-01-escrow-scheme.md §2.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "scheme",
+    "network",
+    "asset",
+    "amount",
+    "escrowAddress",
+    "recipientId",
+    "maxTimeoutSeconds",
+    "offer",
+    "tokenAuthStrategies",
+    "actions"
+  ],
+  "properties": {
+    "scheme": { "const": "escrow" },
+    "network": { "type": "string", "pattern": "^eip155:[1-9][0-9]*$" },
+    "asset": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" },
+    "amount": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" },
+    "escrowAddress": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" },
+    "recipientId": { "type": "string", "minLength": 1 },
+    "maxTimeoutSeconds": { "type": "integer", "minimum": 1 },
+    "offer": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["fullOffer", "sellerSig", "creator"],
+      "properties": {
+        "fullOffer": { "type": "object" },
+        "sellerSig": { "type": "string", "pattern": "^0x[a-fA-F0-9]+$" },
+        "creator": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }
+      }
+    },
+    "tokenAuthStrategies": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": { "enum": ["none", "erc3009", "permit", "permit2"] }
+    },
+    "fulfillment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["required", "options"],
+      "properties": {
+        "required": { "type": "boolean" },
+        "options": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["id", "schema"],
+            "properties": {
+              "id": { "type": "string", "minLength": 1 },
+              "schema": {
+                "oneOf": [{ "type": "object" }, { "type": "null" }]
+              },
+              "metadata": {}
+            }
+          }
+        }
+      }
+    },
+    "actions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["next"],
+      "properties": {
+        "next": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["id", "channels"],
+            "properties": {
+              "id": { "type": "string", "minLength": 1 },
+              "channels": {
+                "type": "array",
+                "minItems": 1,
+                "uniqueItems": true,
+                "items": {
+                  "enum": ["server", "facilitator", "onchain", "mcp", "xmtp"]
+                }
+              },
+              "endpoints": {
+                "type": "object",
+                "additionalProperties": { "type": "string" }
+              },
+              "deadline": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        },
+        "fallback": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "xmtp": { "type": "string" },
+            "mcp": { "type": "string" },
+            "onchainHints": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["escrow", "metaTxFacet", "metaTxEntrypoints", "actionFacets"],
+              "properties": {
+                "escrow": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" },
+                "metaTxFacet": { "type": "string", "minLength": 1 },
+                "metaTxEntrypoints": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": ["none", "erc3009", "permit", "permit2"],
+                  "properties": {
+                    "none": { "type": "string", "minLength": 1 },
+                    "erc3009": { "type": "string", "minLength": 1 },
+                    "permit": { "type": "string", "minLength": 1 },
+                    "permit2": { "type": "string", "minLength": 1 }
+                  }
+                },
+                "actionFacets": {
+                  "type": "object",
+                  "additionalProperties": { "type": "string" }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@bosonprotocol/x402-core",
+  "version": "0.1.0-alpha-0",
+  "license": "Apache-2.0",
+  "description": "Boson Protocol escrow scheme for x402 — JSON schemas, TypeScript types, EIP-712 builders, and exchange state machine.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bosonprotocol/x402B.git",
+    "directory": "typescript/packages/core"
+  },
+  "homepage": "https://github.com/bosonprotocol/x402B/tree/main/typescript/packages/core",
+  "bugs": {
+    "url": "https://github.com/bosonprotocol/x402B/issues"
+  },
+  "keywords": [
+    "x402",
+    "boson-protocol",
+    "escrow",
+    "eip-712",
+    "web3",
+    "payments"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/cjs/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./eip712": {
+      "types": "./dist/cjs/eip712/index.d.ts",
+      "import": "./dist/esm/eip712/index.js",
+      "require": "./dist/cjs/eip712/index.js"
+    },
+    "./eip712/token-auth": {
+      "types": "./dist/cjs/eip712/token-auth/index.d.ts",
+      "import": "./dist/esm/eip712/token-auth/index.js",
+      "require": "./dist/cjs/eip712/token-auth/index.js"
+    },
+    "./schemes/escrow": {
+      "types": "./dist/cjs/schemes/escrow/index.d.ts",
+      "import": "./dist/esm/schemes/escrow/index.js",
+      "require": "./dist/cjs/schemes/escrow/index.js"
+    },
+    "./schemas/*": "./dist/schemas/*",
+    "./state-machine": {
+      "types": "./dist/cjs/state-machine/index.d.ts",
+      "import": "./dist/esm/state-machine/index.js",
+      "require": "./dist/cjs/state-machine/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bosonprotocol/common": "1.33.0-alpha.7",
+    "@bosonprotocol/core-sdk": "1.48.0-alpha.6",
+    "@x402/evm": "^2.11.0",
+    "lodash": "^4.18.1",
+    "viem": "^2.39.3",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.10",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "build": "tsup && node scripts/postbuild.mjs",
+    "test": "vitest run",
+    "lint": "eslint src test --max-warnings 0",
+    "clean": "rm -rf dist .turbo"
+  }
+}