@mixrpay/merchant-sdk 0.1.0

package/dist/types-BJNy6Hhb.d.ts

@@ -0,0 +1,166 @@
+/**
+ * MixrPay Merchant SDK - Type definitions
+ */
+interface X402Options {
+    /** Price in USD (e.g., 0.05 for 5 cents) */
+    price: number;
+    /** Your merchant wallet address to receive payments */
+    recipient?: string;
+    /** Chain ID (default: 8453 for Base) */
+    chainId?: number;
+    /** Facilitator URL for payment settlement */
+    facilitator?: string;
+    /** Description of what the payment is for */
+    description?: string;
+    /** Custom function to determine price dynamically */
+    getPrice?: (context: PriceContext) => number | Promise<number>;
+    /** Called after successful payment verification */
+    onPayment?: (payment: X402PaymentResult) => void | Promise<void>;
+    /** Skip payment for certain requests (return true to skip) */
+    skip?: (context: SkipContext) => boolean | Promise<boolean>;
+    /** Allow test payments (for development) */
+    testMode?: boolean;
+    /**
+     * Receipt mode for payment verification responses.
+     * - 'jwt': Set X-Payment-Receipt header with JWT (no webhook)
+     * - 'webhook': Send webhook only (default, backwards compatible)
+     * - 'both': Set JWT header AND send webhook
+     */
+    receiptMode?: ReceiptMode;
+    /** MixrPay API URL for fetching JWT receipts (default: production) */
+    mixrpayApiUrl?: string;
+}
+interface PriceContext {
+    /** Request path */
+    path: string;
+    /** Request method */
+    method: string;
+    /** Request headers */
+    headers: Record<string, string | string[] | undefined>;
+    /** Request body (if parsed) */
+    body?: unknown;
+}
+type SkipContext = PriceContext;
+interface X402PaymentResult {
+    /** Whether the payment is valid */
+    valid: boolean;
+    /** Error message if invalid */
+    error?: string;
+    /** Address that paid (if valid) */
+    payer?: string;
+    /** Amount in USDC (major units, e.g., 0.05) */
+    amount?: number;
+    /** Amount in USDC minor units (e.g., 50000) */
+    amountMinor?: bigint;
+    /** Settlement transaction hash */
+    txHash?: string;
+    /** When the payment was settled */
+    settledAt?: Date;
+    /** The nonce used for this payment */
+    nonce?: string;
+    /** JWT payment receipt (when receiptMode is 'jwt' or 'both') */
+    receipt?: string;
+}
+interface X402PaymentRequired {
+    /** Recipient wallet address */
+    recipient: string;
+    /** Amount in USDC minor units (6 decimals) as string */
+    amount: string;
+    /** Currency code */
+    currency: string;
+    /** Chain ID */
+    chainId: number;
+    /** Facilitator URL */
+    facilitator: string;
+    /** Unique nonce for this payment request */
+    nonce: string;
+    /** Unix timestamp when payment requirements expire */
+    expiresAt: number;
+    /** Description of the payment */
+    description?: string;
+}
+interface X402PaymentPayload {
+    x402Version: number;
+    scheme: 'exact';
+    network: 'base' | 'base-sepolia';
+    payload: {
+        signature: string;
+        authorization: {
+            from: string;
+            to: string;
+            value: string;
+            validAfter: string;
+            validBefore: string;
+            nonce: string;
+        };
+    };
+}
+interface EIP712Domain {
+    name: string;
+    version: string;
+    chainId: number;
+    verifyingContract: `0x${string}`;
+}
+interface TransferWithAuthorizationMessage {
+    from: `0x${string}`;
+    to: `0x${string}`;
+    value: bigint;
+    validAfter: bigint;
+    validBefore: bigint;
+    nonce: `0x${string}`;
+}
+interface VerifyOptions {
+    /** Expected amount in USDC minor units */
+    expectedAmount: bigint;
+    /** Expected recipient address */
+    expectedRecipient: string;
+    /** Chain ID (default: 8453 for Base) */
+    chainId?: number;
+    /** Facilitator URL */
+    facilitator?: string;
+    /** Skip on-chain settlement (for testing) */
+    skipSettlement?: boolean;
+}
+/**
+ * Verified payment receipt from MixrPay.
+ */
+interface PaymentReceipt {
+    /** Unique payment ID */
+    paymentId: string;
+    /** Amount in USDC minor units (6 decimals) as string */
+    amount: string;
+    /** Amount in USD */
+    amountUsd: number;
+    /** Payer wallet address */
+    payer: string;
+    /** Recipient wallet address */
+    recipient: string;
+    /** Blockchain chain ID */
+    chainId: number;
+    /** Settlement transaction hash */
+    txHash: string;
+    /** When the payment was settled (ISO string) */
+    settledAt: string;
+    /** When the receipt was issued */
+    issuedAt?: Date;
+    /** When the receipt expires */
+    expiresAt?: Date;
+}
+/**
+ * Options for verifying a payment receipt.
+ */
+interface VerifyReceiptOptions {
+    /** Custom JWKS URL (default: MixrPay production JWKS) */
+    jwksUrl?: string;
+    /** Expected issuer (for additional validation) */
+    issuer?: string;
+}
+/**
+ * Receipt mode for x402 middleware.
+ * - 'jwt': Only generate JWT receipt (no webhook)
+ * - 'webhook': Only send webhook (default, backwards compatible)
+ * - 'both': Generate JWT receipt AND send webhook
+ */
+type ReceiptMode = 'jwt' | 'webhook' | 'both';
+
+export type { EIP712Domain as E, PaymentReceipt as P, ReceiptMode as R, SkipContext as S, TransferWithAuthorizationMessage as T, VerifyOptions as V, X402PaymentResult as X, VerifyReceiptOptions as a, X402Options as b, X402PaymentRequired as c, X402PaymentPayload as d, PriceContext as e };

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@mixrpay/merchant-sdk",
+  "version": "0.1.0",
+  "description": "Add x402 payments to your API in minutes - middleware for Express, Next.js, and Fastify",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./express": {
+      "types": "./dist/middleware/express.d.ts",
+      "import": "./dist/middleware/express.mjs",
+      "require": "./dist/middleware/express.js"
+    },
+    "./nextjs": {
+      "types": "./dist/middleware/nextjs.d.ts",
+      "import": "./dist/middleware/nextjs.mjs",
+      "require": "./dist/middleware/nextjs.js"
+    },
+    "./fastify": {
+      "types": "./dist/middleware/fastify.d.ts",
+      "import": "./dist/middleware/fastify.mjs",
+      "require": "./dist/middleware/fastify.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "x402",
+    "payments",
+    "ai",
+    "agents",
+    "micropayments",
+    "middleware",
+    "express",
+    "nextjs",
+    "fastify",
+    "usdc",
+    "crypto"
+  ],
+  "author": "MixrPay",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mixrpay/merchant-sdk"
+  },
+  "dependencies": {
+    "jose": "^5.2.0",
+    "viem": "^2.21.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.10.0",
+    "express": "^4.18.2",
+    "fastify": "^4.26.0",
+    "next": "^14.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  },
+  "peerDependencies": {
+    "express": ">=4.0.0",
+    "fastify": ">=4.0.0",
+    "next": ">=13.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    },
+    "fastify": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
+  }
+}
+