arcpaykit 0.1.0 → 0.3.0

package/README.md

@@ -1,6 +1,9 @@
 # arcpaykit
 
-Official ArcPay JavaScript SDK for accepting stablecoin payments.
+Official ArcPay JavaScript/TypeScript SDK for accepting stablecoin payments.
+
+[![npm version](https://badge.fury.io/js/arcpaykit.svg)](https://www.npmjs.com/package/arcpaykit)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Installation
 
@@ -10,25 +13,43 @@ npm install arcpaykit
 
 ## Quick Start
 
+Get started in 5 minutes:
+
 ```typescript
 import { ArcPay } from "arcpaykit";
 
 const arcpay = new ArcPay("your-api-key");
 
-// Create a payment
+// Verify API connectivity
+const ping = await arcpay.ping();
+console.log(ping.status); // "ok"
+
+// Create a payment (happy path - recommended)
 const payment = await arcpay.payments.create({
   amount: "100.00",
   currency: "USDC",
-  merchantWallet: "0x...",
-  description: "Payment for order #123"
+  description: "Payment for order #123",
+  customerEmail: "customer@example.com"
 });
 
-console.log(payment.checkout_url); // Send this URL to your customer
+// Redirect customer to checkout
+console.log(payment.checkout_url); // https://arcpay.systems/checkout/pay_...
 
-// Retrieve a payment
-const retrieved = await arcpay.payments.retrieve(payment.id);
+// That's it! ArcPay handles:
+// - Merchant wallet (uses your default)
+// - Test/live mode (inferred from API key)
+// - Payment chain (inferred automatically)
+// - Settlement currency (defaults to USDC)
 ```
 
+**No need to configure:**
+- ❌ Merchant wallet (uses your default)
+- ❌ Test/live mode (inferred from API key: `sk_arc_test_` vs `sk_arc_live_`)
+- ❌ Payment chain ID (inferred automatically)
+- ❌ Settlement currency (defaults to USDC)
+
+For advanced use cases, see `payments.createAdvanced()` below.
+
 ## API Reference
 
 ### ArcPay
@@ -42,18 +63,56 @@ new ArcPay(apiKey: string, baseUrl?: string)
 ```
 
 - `apiKey`: Your ArcPay API key
-- `baseUrl`: Optional base URL (defaults to `https://pay.arcpaykit.com`)
+- `baseUrl`: Optional base URL (defaults to `https://arcpay.systems`)
+
+### ping()
+
+Verify API connectivity.
+
+```typescript
+const result = await arcpay.ping();
+// { status: "ok", timestamp: "2024-01-02T10:00:00.000Z" }
+```
 
 ### Payments
 
-#### `create(data: CreatePaymentRequest): Promise<CreatePaymentResponse>`
+#### `create(data: SimpleCreatePaymentRequest): Promise<CreatePaymentResponse>`
+
+Create a new payment (happy path - recommended for most users).
+
+**Most users should use this method.** It only requires essential fields. All advanced fields are inferred automatically.
+
+**Request:**
+```typescript
+{
+  amount: string;              // Required: Payment amount (e.g., "100.00")
+  currency?: string;          // Optional: Payment currency (default: "USDC")
+  description?: string;       // Optional: Payment description
+  customerEmail?: string;     // Optional: Customer email
+}
+```
+
+**Example:**
+```typescript
+const payment = await arcpay.payments.create({
+  amount: "100.00",
+  currency: "USDC",
+  description: "Order #123",
+  customerEmail: "customer@example.com"
+});
+```
+
+#### `createAdvanced(data: CreatePaymentRequest): Promise<CreatePaymentResponse>`
 
-Create a new payment.
+Create a new payment with full control (advanced users only).
+
+**Most users should use `payments.create()` instead.** This method allows full control over all payment parameters.
 
 **Request:**
 ```typescript
 {
   amount: string;                    // Required: Payment amount
+  merchantWallet?: string;            // Optional: Merchant wallet (uses default if not provided)
   currency?: string;                 // Optional: Payment currency (default: "USDC")
   settlementCurrency?: "USDC" | "EURC"; // Optional: Settlement currency (default: "USDC")
   paymentAsset?: string;              // Optional: Specific asset identifier
@@ -62,9 +121,8 @@ Create a new payment.
   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
+  isTest?: boolean;                  // Optional: Test mode flag (inferred from API key if not provided)
   gasSponsored?: boolean;            // Optional: Gas sponsorship preference
 }
 ```
@@ -139,30 +197,57 @@ import { ArcPay } from "arcpaykit";
 
 const arcpay = new ArcPay(process.env.ARCPAY_API_KEY!);
 
-// Create payment
+// Verify connectivity first
+const ping = await arcpay.ping();
+if (ping.status !== "ok") {
+  throw new Error("Cannot connect to ArcPay API");
+}
+
+// Create payment (simple - recommended)
 const payment = await arcpay.payments.create({
   amount: "50.00",
   currency: "USDC",
-  merchantWallet: "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
   description: "Monthly subscription",
-  customerEmail: "customer@example.com",
-  expiresInMinutes: 30
+  customerEmail: "customer@example.com"
 });
 
 console.log(`Payment created: ${payment.id}`);
 console.log(`Checkout URL: ${payment.checkout_url}`);
 
+// Redirect customer
+window.location.href = payment.checkout_url;
+
 // Later, check payment status
 const status = await arcpay.payments.retrieve(payment.id);
 console.log(`Payment status: ${status.status}`);
 ```
 
+### Advanced Payment Creation
+
+For full control over payment parameters:
+
+```typescript
+const payment = await arcpay.payments.createAdvanced({
+  amount: "50.00",
+  merchantWallet: "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
+  currency: "USDC",
+  settlementCurrency: "EURC",
+  paymentAsset: "USDC_BASE",
+  paymentChainId: 8453,
+  description: "Monthly subscription",
+  customerEmail: "customer@example.com",
+  expiresInMinutes: 30,
+  isTest: false,
+  gasSponsored: true
+});
+```
+
 ### Using Custom Base URL
 
 ```typescript
 const arcpay = new ArcPay(
   "your-api-key",
-  "https://staging.arcpaykit.com"
+  "https://staging.arcpay.systems"
 );
 ```
 
@@ -180,9 +265,14 @@ try {
 
 ## 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.
+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://arcpay.systems/docs) for more details.
+
+## Support
+
+- 📚 [Documentation](https://arcpay.systems/docs)
+- 💬 [Discord Community](https://discord.gg/arcpay)
+- 🐛 [Report Issues](https://github.com/ArcPayKit/gateway/issues)
 
 ## License
 
 MIT
-

package/dist/client.d.ts

@@ -1,6 +1,16 @@
+export interface PingResponse {
+    status: string;
+    timestamp: string;
+    version?: string;
+}
 export declare class ArcPayClient {
     private apiKey;
     private baseUrl;
     constructor(apiKey: string, baseUrl?: string);
     request<T = any>(path: string, options?: RequestInit): Promise<T>;
+    /**
+     * Ping the ArcPay API to verify connectivity
+     * @returns Promise with status and timestamp
+     */
+    ping(): Promise<PingResponse>;
 }

package/dist/client.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArcPayClient = void 0;
 class ArcPayClient {
-    constructor(apiKey, baseUrl = "https://pay.arcpaykit.com") {
+    constructor(apiKey, baseUrl = "https://arcpay.systems") {
         this.apiKey = apiKey;
         this.baseUrl = baseUrl;
     }
@@ -21,5 +21,37 @@ class ArcPayClient {
         }
         return res.json();
     }
+    /**
+     * Ping the ArcPay API to verify connectivity
+     * @returns Promise with status and timestamp
+     */
+    async ping() {
+        const start = Date.now();
+        try {
+            const res = await fetch(`${this.baseUrl}/api/health`, {
+                method: "GET",
+                headers: {
+                    "Authorization": `Bearer ${this.apiKey}`,
+                }
+            });
+            if (res.ok) {
+                return {
+                    status: "ok",
+                    timestamp: new Date().toISOString(),
+                    version: "1.0.0"
+                };
+            }
+            return {
+                status: "error",
+                timestamp: new Date().toISOString()
+            };
+        }
+        catch (error) {
+            return {
+                status: "error",
+                timestamp: new Date().toISOString()
+            };
+        }
+    }
 }
 exports.ArcPayClient = ArcPayClient;

package/dist/index.d.ts

@@ -1,7 +1,20 @@
+import { PingResponse } from "./client";
 import { Payments } from "./payments";
 export declare class ArcPay {
     payments: Payments;
+    private client;
     constructor(apiKey: string, baseUrl?: string);
+    /**
+     * Ping the ArcPay API to verify connectivity
+     *
+     * @example
+     * ```typescript
+     * const result = await arcpay.ping();
+     * console.log(result.status); // "ok"
+     * ```
+     */
+    ping(): Promise<PingResponse>;
 }
-export type { CreatePaymentRequest, CreatePaymentResponse, Payment, ConfirmPaymentRequest, ConfirmPaymentResponse, FailPaymentRequest, FailPaymentResponse, ExpirePaymentRequest, ExpirePaymentResponse, } from "./payments";
+export type { CreatePaymentRequest, SimpleCreatePaymentRequest, CreatePaymentResponse, Payment, ConfirmPaymentRequest, ConfirmPaymentResponse, FailPaymentRequest, FailPaymentResponse, ExpirePaymentRequest, ExpirePaymentResponse, } from "./payments";
+export type { PingResponse } from "./client";
 export default ArcPay;

package/dist/index.js

@@ -5,8 +5,20 @@ 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);
+        this.client = new client_1.ArcPayClient(apiKey, baseUrl);
+        this.payments = new payments_1.Payments(this.client);
+    }
+    /**
+     * Ping the ArcPay API to verify connectivity
+     *
+     * @example
+     * ```typescript
+     * const result = await arcpay.ping();
+     * console.log(result.status); // "ok"
+     * ```
+     */
+    ping() {
+        return this.client.ping();
     }
 }
 exports.ArcPay = ArcPay;

package/dist/payments.d.ts

@@ -9,11 +9,21 @@ export interface CreatePaymentRequest {
     estimatedFees?: string;
     description?: string;
     customerEmail?: string;
-    merchantWallet: string;
+    merchantWallet?: string;
     expiresInMinutes?: number;
     isTest?: boolean;
     gasSponsored?: boolean;
 }
+/**
+ * Simple payment creation request (happy path)
+ * Only requires essential fields - all others are inferred
+ */
+export interface SimpleCreatePaymentRequest {
+    amount: string;
+    currency?: string;
+    description?: string;
+    customerEmail?: string;
+}
 export interface CreatePaymentResponse {
     id: string;
     status: string;
@@ -80,9 +90,33 @@ export declare class Payments {
     private client;
     constructor(client: ArcPayClient);
     /**
-     * Create a new payment
+     * Create a new payment (happy path - recommended for most users)
+     *
+     * This method only requires essential fields. All advanced fields are inferred:
+     * - merchantWallet: Uses merchant's default wallet from profile
+     * - isTest: Inferred from API key prefix (sk_arc_test_ / sk_arc_live_)
+     * - paymentAsset: Defaults to ARC USDC
+     * - settlementCurrency: Defaults to USDC
+     * - paymentChainId: Inferred automatically
+     *
+     * @example
+     * ```typescript
+     * const payment = await arcpay.payments.create({
+     *   amount: "100.00",
+     *   currency: "USDC",
+     *   description: "Payment for order #123",
+     *   customerEmail: "customer@example.com"
+     * });
+     * ```
+     */
+    create(data: SimpleCreatePaymentRequest): Promise<CreatePaymentResponse>;
+    /**
+     * Create a new payment with full control (advanced users only)
+     *
+     * Most users should use payments.create() instead.
+     * This method allows full control over all payment parameters.
      */
-    create(data: CreatePaymentRequest): Promise<CreatePaymentResponse>;
+    createAdvanced(data: CreatePaymentRequest): Promise<CreatePaymentResponse>;
     /**
      * Retrieve a payment by ID
      */

package/dist/payments.js

@@ -6,9 +6,44 @@ class Payments {
         this.client = client;
     }
     /**
-     * Create a new payment
+     * Create a new payment (happy path - recommended for most users)
+     *
+     * This method only requires essential fields. All advanced fields are inferred:
+     * - merchantWallet: Uses merchant's default wallet from profile
+     * - isTest: Inferred from API key prefix (sk_arc_test_ / sk_arc_live_)
+     * - paymentAsset: Defaults to ARC USDC
+     * - settlementCurrency: Defaults to USDC
+     * - paymentChainId: Inferred automatically
+     *
+     * @example
+     * ```typescript
+     * const payment = await arcpay.payments.create({
+     *   amount: "100.00",
+     *   currency: "USDC",
+     *   description: "Payment for order #123",
+     *   customerEmail: "customer@example.com"
+     * });
+     * ```
      */
     create(data) {
+        return this.client.request("/api/payments/create", {
+            method: "POST",
+            body: JSON.stringify({
+                amount: data.amount,
+                currency: data.currency || "USDC",
+                description: data.description,
+                customerEmail: data.customerEmail,
+                // All other fields are inferred server-side
+            })
+        });
+    }
+    /**
+     * Create a new payment with full control (advanced users only)
+     *
+     * Most users should use payments.create() instead.
+     * This method allows full control over all payment parameters.
+     */
+    createAdvanced(data) {
         return this.client.request("/api/payments/create", {
             method: "POST",
             body: JSON.stringify(data)

package/package.json

@@ -1,12 +1,27 @@
 {
   "name": "arcpaykit",
-  "version": "0.1.0",
-  "description": "Official ArcPay JavaScript SDK",
+  "version": "0.3.0",
+  "description": "Official ArcPay JavaScript SDK for accepting stablecoin payments",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "license": "MIT",
-  "keywords": ["payments", "web3", "stablecoin", "arcpay"],
+  "keywords": [
+    "payments",
+    "web3",
+    "stablecoin",
+    "arcpay",
+    "crypto",
+    "usdc",
+    "eurc",
+    "blockchain"
+  ],
+  "homepage": "https://arcpay.systems",
+  "bugs": {
+    "url": "https://github.com/ArcPayKit/gateway/issues"
+  },
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build"
@@ -16,7 +31,9 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/arcpay/gateway.git"
+    "url": "https://github.com/ArcPayKit/gateway.git"
+  },
+  "engines": {
+    "node": ">=16.0.0"
   }
-}
-
+}