arcpaykit 0.1.0

package/README.md

@@ -0,0 +1,188 @@
+# arcpaykit
+
+Official ArcPay JavaScript SDK for accepting stablecoin payments.
+
+## Installation
+
+```bash
+npm install arcpaykit
+```
+
+## Quick Start
+
+```typescript
+import { ArcPay } from "arcpaykit";
+
+const arcpay = new ArcPay("your-api-key");
+
+// Create a payment
+const payment = await arcpay.payments.create({
+  amount: "100.00",
+  currency: "USDC",
+  merchantWallet: "0x...",
+  description: "Payment for order #123"
+});
+
+console.log(payment.checkout_url); // Send this URL to your customer
+
+// Retrieve a payment
+const retrieved = await arcpay.payments.retrieve(payment.id);
+```
+
+## API Reference
+
+### ArcPay
+
+Main SDK class.
+
+#### Constructor
+
+```typescript
+new ArcPay(apiKey: string, baseUrl?: string)
+```
+
+- `apiKey`: Your ArcPay API key
+- `baseUrl`: Optional base URL (defaults to `https://pay.arcpaykit.com`)
+
+### Payments
+
+#### `create(data: CreatePaymentRequest): Promise<CreatePaymentResponse>`
+
+Create a new payment.
+
+**Request:**
+```typescript
+{
+  amount: string;                    // Required: Payment amount
+  currency?: string;                 // Optional: Payment currency (default: "USDC")
+  settlementCurrency?: "USDC" | "EURC"; // Optional: Settlement currency (default: "USDC")
+  paymentAsset?: string;              // Optional: Specific asset identifier
+  paymentChainId?: number;           // Optional: Chain ID for payment
+  conversionPath?: string;            // Optional: Conversion path JSON
+  estimatedFees?: string;            // Optional: Estimated fees
+  description?: string;              // Optional: Payment description
+  customerEmail?: string;            // Optional: Customer email
+  merchantWallet: string;             // Required: Merchant wallet address
+  expiresInMinutes?: number;         // Optional: Expiration time in minutes
+  isTest?: boolean;                  // Optional: Test mode flag
+  gasSponsored?: boolean;            // Optional: Gas sponsorship preference
+}
+```
+
+**Response:**
+```typescript
+{
+  id: string;
+  status: string;
+  checkout_url: string;
+  amount: number;
+  currency: string;
+  merchantWallet: string;
+  expiresAt: string;
+  createdAt: string;
+}
+```
+
+#### `retrieve(id: string): Promise<Payment>`
+
+Retrieve a payment by ID.
+
+#### `submitTx(data: ConfirmPaymentRequest): Promise<ConfirmPaymentResponse>`
+
+Submit a transaction hash for a payment.
+
+**Request:**
+```typescript
+{
+  paymentId: string;        // Required
+  txHash: string;           // Required: Transaction hash
+  payerWallet: string;      // Required: Payer wallet address
+  customerEmail?: string;   // Optional
+  customerName?: string;    // Optional
+  gasSponsored?: boolean;  // Optional
+}
+```
+
+#### `confirm(data: ConfirmPaymentRequest): Promise<ConfirmPaymentResponse>`
+
+Confirm a payment (legacy endpoint).
+
+#### `fail(data: FailPaymentRequest): Promise<FailPaymentResponse>`
+
+Mark a payment as failed.
+
+**Request:**
+```typescript
+{
+  paymentId: string;  // Required
+  reason?: string;    // Optional failure reason
+}
+```
+
+#### `expire(data: ExpirePaymentRequest): Promise<ExpirePaymentResponse>`
+
+Expire a payment.
+
+**Request:**
+```typescript
+{
+  paymentId: string;  // Required
+}
+```
+
+## Examples
+
+### Create and Track a Payment
+
+```typescript
+import { ArcPay } from "arcpaykit";
+
+const arcpay = new ArcPay(process.env.ARCPAY_API_KEY!);
+
+// Create payment
+const payment = await arcpay.payments.create({
+  amount: "50.00",
+  currency: "USDC",
+  merchantWallet: "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
+  description: "Monthly subscription",
+  customerEmail: "customer@example.com",
+  expiresInMinutes: 30
+});
+
+console.log(`Payment created: ${payment.id}`);
+console.log(`Checkout URL: ${payment.checkout_url}`);
+
+// Later, check payment status
+const status = await arcpay.payments.retrieve(payment.id);
+console.log(`Payment status: ${status.status}`);
+```
+
+### Using Custom Base URL
+
+```typescript
+const arcpay = new ArcPay(
+  "your-api-key",
+  "https://staging.arcpaykit.com"
+);
+```
+
+## Error Handling
+
+The SDK throws errors for failed requests:
+
+```typescript
+try {
+  const payment = await arcpay.payments.create({...});
+} catch (error) {
+  console.error("Payment creation failed:", error.message);
+}
+```
+
+## REST API
+
+The SDK is a thin wrapper around the ArcPay REST API. You can also use the REST API directly if needed. See the [ArcPay API documentation](https://docs.arcpaykit.com) for more details.
+
+## License
+
+MIT
+

package/dist/client.d.ts

@@ -0,0 +1,6 @@
+export declare class ArcPayClient {
+    private apiKey;
+    private baseUrl;
+    constructor(apiKey: string, baseUrl?: string);
+    request<T = any>(path: string, options?: RequestInit): Promise<T>;
+}

package/dist/client.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcPayClient = void 0;
+class ArcPayClient {
+    constructor(apiKey, baseUrl = "https://pay.arcpaykit.com") {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+    }
+    async request(path, options = {}) {
+        const res = await fetch(`${this.baseUrl}${path}`, {
+            ...options,
+            headers: {
+                "Content-Type": "application/json",
+                "Authorization": `Bearer ${this.apiKey}`,
+                ...(options.headers || {})
+            }
+        });
+        if (!res.ok) {
+            const errorText = await res.text();
+            throw new Error(errorText || `HTTP ${res.status}: ${res.statusText}`);
+        }
+        return res.json();
+    }
+}
+exports.ArcPayClient = ArcPayClient;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { Payments } from "./payments";
+export declare class ArcPay {
+    payments: Payments;
+    constructor(apiKey: string, baseUrl?: string);
+}
+export type { CreatePaymentRequest, CreatePaymentResponse, Payment, ConfirmPaymentRequest, ConfirmPaymentResponse, FailPaymentRequest, FailPaymentResponse, ExpirePaymentRequest, ExpirePaymentResponse, } from "./payments";
+export default ArcPay;

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcPay = void 0;
+const client_1 = require("./client");
+const payments_1 = require("./payments");
+class ArcPay {
+    constructor(apiKey, baseUrl) {
+        const client = new client_1.ArcPayClient(apiKey, baseUrl);
+        this.payments = new payments_1.Payments(client);
+    }
+}
+exports.ArcPay = ArcPay;
+// Default export
+exports.default = ArcPay;

package/dist/payments.d.ts

@@ -0,0 +1,106 @@
+import { ArcPayClient } from "./client";
+export interface CreatePaymentRequest {
+    amount: string;
+    currency?: string;
+    settlementCurrency?: "USDC" | "EURC";
+    paymentAsset?: string;
+    paymentChainId?: number;
+    conversionPath?: string;
+    estimatedFees?: string;
+    description?: string;
+    customerEmail?: string;
+    merchantWallet: string;
+    expiresInMinutes?: number;
+    isTest?: boolean;
+    gasSponsored?: boolean;
+}
+export interface CreatePaymentResponse {
+    id: string;
+    status: string;
+    checkout_url: string;
+    amount: number;
+    currency: string;
+    merchantWallet: string;
+    expiresAt: string;
+    createdAt: string;
+}
+export interface Payment {
+    id: string;
+    merchantId: string;
+    amount: string;
+    currency: string;
+    settlementCurrency: string;
+    paymentAsset?: string;
+    paymentChainId?: number;
+    conversionPath?: string;
+    estimatedFees?: string;
+    status: "created" | "pending" | "confirmed" | "failed" | "refunded" | "expired";
+    description?: string;
+    customerEmail?: string;
+    payerWallet?: string;
+    merchantWallet: string;
+    txHash?: string;
+    settlementTime?: number;
+    metadata?: string;
+    isDemo: boolean;
+    isTest: boolean;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    explorerLink?: string;
+}
+export interface ConfirmPaymentRequest {
+    paymentId: string;
+    txHash: string;
+    payerWallet: string;
+    customerEmail?: string;
+    customerName?: string;
+    gasSponsored?: boolean;
+}
+export interface ConfirmPaymentResponse {
+    success: boolean;
+    payment: Payment | null;
+}
+export interface FailPaymentRequest {
+    paymentId: string;
+    reason?: string;
+}
+export interface FailPaymentResponse {
+    success: boolean;
+    payment: Payment;
+}
+export interface ExpirePaymentRequest {
+    paymentId: string;
+}
+export interface ExpirePaymentResponse {
+    success: boolean;
+    payment: Payment;
+}
+export declare class Payments {
+    private client;
+    constructor(client: ArcPayClient);
+    /**
+     * Create a new payment
+     */
+    create(data: CreatePaymentRequest): Promise<CreatePaymentResponse>;
+    /**
+     * Retrieve a payment by ID
+     */
+    retrieve(id: string): Promise<Payment>;
+    /**
+     * Submit a transaction hash for a payment
+     */
+    submitTx(data: ConfirmPaymentRequest): Promise<ConfirmPaymentResponse>;
+    /**
+     * Confirm a payment (legacy endpoint)
+     */
+    confirm(data: ConfirmPaymentRequest): Promise<ConfirmPaymentResponse>;
+    /**
+     * Mark a payment as failed
+     */
+    fail(data: FailPaymentRequest): Promise<FailPaymentResponse>;
+    /**
+     * Expire a payment
+     */
+    expire(data: ExpirePaymentRequest): Promise<ExpirePaymentResponse>;
+}

package/dist/payments.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payments = void 0;
+class Payments {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a new payment
+     */
+    create(data) {
+        return this.client.request("/api/payments/create", {
+            method: "POST",
+            body: JSON.stringify(data)
+        });
+    }
+    /**
+     * Retrieve a payment by ID
+     */
+    retrieve(id) {
+        return this.client.request(`/api/payments/${id}`);
+    }
+    /**
+     * Submit a transaction hash for a payment
+     */
+    submitTx(data) {
+        return this.client.request("/api/payments/submit-tx", {
+            method: "POST",
+            body: JSON.stringify(data)
+        });
+    }
+    /**
+     * Confirm a payment (legacy endpoint)
+     */
+    confirm(data) {
+        return this.client.request("/api/payments/confirm", {
+            method: "POST",
+            body: JSON.stringify(data)
+        });
+    }
+    /**
+     * Mark a payment as failed
+     */
+    fail(data) {
+        return this.client.request("/api/payments/fail", {
+            method: "POST",
+            body: JSON.stringify(data)
+        });
+    }
+    /**
+     * Expire a payment
+     */
+    expire(data) {
+        return this.client.request("/api/payments/expire", {
+            method: "POST",
+            body: JSON.stringify(data)
+        });
+    }
+}
+exports.Payments = Payments;

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "arcpaykit",
+  "version": "0.1.0",
+  "description": "Official ArcPay JavaScript SDK",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "license": "MIT",
+  "keywords": ["payments", "web3", "stablecoin", "arcpay"],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arcpay/gateway.git"
+  }
+}
+