@ktmcp-cli/nowpayments 1.0.0 → 1.0.2

package/PROJECT_SUMMARY.md

@@ -1,305 +0,0 @@
-# NOWPayments CLI - Project Summary
-
-Production-ready Commander.js CLI for NOWPayments cryptocurrency payment processing API.
-
-## Project Location
-
-```
-/workspace/group/ktmcp/workspace/nowpayments/
-```
-
-## Project Structure
-
-```
-nowpayments/
-├── bin/
-│   └── nowpayments.js          # CLI entry point
-├── src/
-│   ├── commands/               # Command implementations
-│   │   ├── auth.js            # API key management
-│   │   ├── status.js          # API status check
-│   │   ├── currencies.js      # Currency operations
-│   │   ├── estimate.js        # Price estimation
-│   │   ├── payment.js         # Payment management
-│   │   ├── invoice.js         # Invoice management
-│   │   └── payout.js          # Payout/withdrawal operations
-│   └── lib/                   # Core libraries
-│       ├── api.js             # API client with error handling
-│       ├── auth.js            # Authentication utilities
-│       └── config.js          # Configuration management
-├── examples/                  # Usage examples
-│   ├── basic-payment.js       # Simple payment creation
-│   ├── monitor-payment.js     # Payment status monitoring
-│   └── invoice-flow.js        # Invoice workflow
-├── README.md                  # Main documentation
-├── AGENT.md                   # AI agent integration guide
-├── OPENCLAW.md                # OpenClaw framework integration
-├── INSTALL.md                 # Installation and setup guide
-├── package.json               # NPM package configuration
-├── openapi.json               # NOWPayments API specification
-├── .env.example               # Environment configuration template
-├── .gitignore                 # Git ignore rules
-├── LICENSE                    # MIT license
-└── test.sh                    # Test suite
-```
-
-## Features Implemented
-
-### Core Functionality
-- ✅ Full NOWPayments API coverage (payments, invoices, payouts, currencies, estimates)
-- ✅ Authentication management (API key storage and validation)
-- ✅ Rich terminal output with colors and tables
-- ✅ JSON output mode for scripting
-- ✅ Sandbox environment support
-- ✅ Global and command-specific options
-- ✅ Comprehensive error handling
-- ✅ Debug logging mode
-
-### Commands Implemented
-
-1. **auth** - API key management
-   - `auth set` - Save API key
-   - `auth show` - Display current key (masked)
-   - `auth clear` - Remove API key
-
-2. **status** - Check API availability
-
-3. **currencies** - Cryptocurrency operations
-   - `currencies list` - List all currencies
-   - `currencies info` - Get currency details
-
-4. **estimate** - Price calculations
-   - `estimate convert` - Estimate cryptocurrency amount
-   - `estimate min` - Get minimum payment amount
-
-5. **payment** - Payment management
-   - `payment create` - Create new payment
-   - `payment get` - Get payment details
-   - `payment list` - List all payments
-   - `payment update-estimate` - Update price estimate
-
-6. **invoice** - Invoice management
-   - `invoice create` - Create new invoice
-   - `invoice get` - Get invoice details
-   - `invoice list` - List all invoices
-
-7. **payout** - Withdrawal operations
-   - `payout create` - Create new payout
-   - `payout verify` - Verify payout with 2FA
-   - `payout get` - Get payout details
-   - `payout list` - List all payouts
-
-### Documentation
-
-1. **README.md** - Comprehensive user guide
-   - "Why CLI > MCP" section explaining advantages
-   - Full command reference
-   - Usage examples
-   - Payment flow documentation
-   - Error handling guide
-
-2. **AGENT.md** - AI agent integration patterns
-   - JSON output mode usage
-   - Error handling strategies
-   - Common workflows
-   - Polling patterns
-   - Security considerations
-
-3. **OPENCLAW.md** - OpenClaw framework integration
-   - Skill definition
-   - Event handling
-   - Webhook integration
-   - Multi-agent coordination
-   - Advanced patterns
-
-4. **INSTALL.md** - Installation and setup
-   - Multiple installation methods
-   - API key configuration
-   - Troubleshooting guide
-   - Integration examples
-
-### Examples
-
-1. **basic-payment.js** - Simple payment creation workflow
-2. **monitor-payment.js** - Payment status monitoring with polling
-3. **invoice-flow.js** - Complete invoice generation and management
-
-## Technical Details
-
-### Dependencies
-- **commander**: ^12.0.0 - CLI framework
-- **chalk**: ^4.1.2 - Terminal colors
-- **ora**: ^5.4.1 - Spinners
-- **dotenv**: ^16.4.1 - Environment variables
-- **node-fetch**: ^2.7.0 - HTTP requests
-- **cli-table3**: ^0.6.3 - Terminal tables
-
-### Architecture
-
-- **Modular design**: Separate command files for maintainability
-- **Library abstraction**: Core functionality in reusable libraries
-- **Error handling**: Comprehensive error catching and user-friendly messages
-- **Exit codes**: Proper POSIX exit codes (0 = success, 1 = error)
-- **Configuration layers**: API key from config file, env var, or CLI flag
-- **JSON mode**: Structured output for scripting and automation
-
-### Code Quality
-
-- ✅ JSDoc comments throughout
-- ✅ Consistent code style
-- ✅ Input validation
-- ✅ Proper error propagation
-- ✅ No hardcoded values
-- ✅ Environment-aware (sandbox/production)
-
-## API Coverage
-
-Based on NOWPayments OpenAPI spec (v1.0.0):
-
-- ✅ GET /v1/status
-- ✅ GET /v1/currencies
-- ✅ GET /v1/merchant/coins
-- ✅ GET /v1/estimate
-- ✅ GET /v1/min-amount
-- ✅ POST /v1/payment
-- ✅ GET /v1/payment
-- ✅ GET /v1/payment/{payment_id}
-- ✅ POST /v1/payment/{id}/update-merchant-estimate
-- ✅ POST /v1/invoice
-- ✅ GET /v1/invoice
-- ✅ GET /v1/invoice/{invoice_id}
-- ✅ POST /v1/payout
-- ✅ GET /v1/payout/{payout_id}
-- ✅ POST /v1/payout/{payout_id}/verify
-- ✅ GET /v1/payout
-
-## Installation Steps
-
-1. **Install dependencies**:
-   ```bash
-   cd /workspace/group/ktmcp/workspace/nowpayments
-   npm install
-   ```
-
-2. **Test the CLI**:
-   ```bash
-   ./test.sh
-   ```
-
-3. **Link for global use** (optional):
-   ```bash
-   npm link
-   ```
-
-4. **Configure API key**:
-   ```bash
-   nowpayments auth set YOUR_API_KEY
-   ```
-
-5. **Verify**:
-   ```bash
-   nowpayments status
-   ```
-
-## Usage Examples
-
-### Basic Payment
-```bash
-nowpayments payment create \
-  --price 99.99 \
-  --currency USD \
-  --pay-currency BTC
-```
-
-### JSON Output for Scripting
-```bash
-payment=$(nowpayments --json payment create --price 100 --currency USD --pay-currency BTC)
-payment_id=$(echo "$payment" | jq -r '.payment_id')
-echo "Created payment: $payment_id"
-```
-
-### List Currencies
-```bash
-nowpayments currencies list --available
-```
-
-### Monitor Payment
-```bash
-node examples/monitor-payment.js <payment_id>
-```
-
-## Testing
-
-Run the test suite:
-```bash
-cd /workspace/group/ktmcp/workspace/nowpayments
-./test.sh
-```
-
-Tests verify:
-- CLI structure and entry points
-- All commands registered
-- Required dependencies
-- Documentation completeness
-- Example files
-- File permissions
-
-## Why This Implementation is Superior
-
-### 1. CLI vs MCP
-- **Universal compatibility**: Works with any tool or AI
-- **No server overhead**: Direct execution, no daemon
-- **Battle-tested pattern**: CLI is proven, reliable
-- **Simpler debugging**: Standard stdout/stderr
-- **Better for automation**: Shell scripts, cron jobs, CI/CD
-
-### 2. Architecture Benefits
-- **Modular commands**: Each command is self-contained
-- **Shared libraries**: DRY principle with lib/
-- **Layered config**: Flexible API key sources
-- **Proper error handling**: User-friendly messages, correct exit codes
-- **Rich output**: Both human-readable and machine-parseable
-
-### 3. Production Ready
-- ✅ Input validation
-- ✅ Error recovery
-- ✅ Debug mode
-- ✅ Environment detection (sandbox/production)
-- ✅ Comprehensive documentation
-- ✅ Working examples
-- ✅ Test suite
-
-## Next Steps
-
-1. **Publish to NPM** (optional):
-   ```bash
-   npm publish
-   ```
-
-2. **Add to AI agent tools**: Use patterns from AGENT.md
-
-3. **Integrate with OpenClaw**: Follow OPENCLAW.md guide
-
-4. **Extend functionality**:
-   - Add webhook verification utility
-   - Create payment monitoring daemon
-   - Build subscription management
-   - Add bulk operations
-
-## Support
-
-- **API Docs**: https://documenter.getpostman.com/view/7907941/S1a32n38
-- **NOWPayments**: https://nowpayments.io
-- **CLI Help**: `nowpayments --help`
-
-## License
-
-MIT License - See LICENSE file
-
----
-
-**Status**: ✅ Complete and production-ready
-
-**Created**: 2024
-**Package**: @ktmcp-cli/nowpayments
-**Version**: 1.0.0

package/examples/basic-payment.js

@@ -1,66 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Basic Payment Example
- *
- * Demonstrates creating a simple cryptocurrency payment with NOWPayments CLI.
- */
-
-const { exec } = require('child_process');
-const util = require('util');
-
-const execPromise = util.promisify(exec);
-
-async function createBasicPayment() {
-  console.log('Creating a basic payment...\n');
-
-  try {
-    // Step 1: Check API status
-    console.log('1. Checking API status...');
-    await execPromise('nowpayments status');
-    console.log('   ✓ API is online\n');
-
-    // Step 2: Get estimate
-    console.log('2. Getting price estimate...');
-    const estimateResult = await execPromise(
-      'nowpayments --json estimate convert --from USD --to BTC --amount 100'
-    );
-    const estimate = JSON.parse(estimateResult.stdout);
-    console.log(`   ✓ $100 USD ≈ ${estimate.estimated_amount} BTC\n`);
-
-    // Step 3: Create payment
-    console.log('3. Creating payment...');
-    const paymentResult = await execPromise(`
-      nowpayments --json payment create \
-        --price 100 \
-        --currency USD \
-        --pay-currency BTC \
-        --order-id "DEMO-${Date.now()}" \
-        --order-description "Basic payment example"
-    `);
-    const payment = JSON.parse(paymentResult.stdout);
-
-    console.log('   ✓ Payment created successfully!\n');
-    console.log('Payment Details:');
-    console.log(`  Payment ID: ${payment.payment_id}`);
-    console.log(`  Status: ${payment.payment_status}`);
-    console.log(`  Pay Amount: ${payment.pay_amount} ${payment.pay_currency}`);
-    console.log(`  Pay Address: ${payment.pay_address}`);
-    console.log(`  Created: ${new Date(payment.created_at).toLocaleString()}\n`);
-
-    // Step 4: Check payment status
-    console.log('4. Checking payment status...');
-    const statusResult = await execPromise(
-      `nowpayments --json payment get ${payment.payment_id}`
-    );
-    const status = JSON.parse(statusResult.stdout);
-    console.log(`   Status: ${status.payment_status}`);
-
-  } catch (error) {
-    console.error('Error:', error.message);
-    process.exit(1);
-  }
-}
-
-// Run the example
-createBasicPayment();

package/examples/invoice-flow.js

@@ -1,78 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Invoice Flow Example
- *
- * Demonstrates creating and managing payment invoices.
- */
-
-const { exec } = require('child_process');
-const util = require('util');
-
-const execPromise = util.promisify(exec);
-
-async function createInvoiceFlow() {
-  console.log('Creating payment invoice...\n');
-
-  try {
-    // Step 1: Create invoice
-    console.log('1. Creating invoice...');
-    const invoiceResult = await execPromise(`
-      nowpayments --json invoice create \
-        --price 49.99 \
-        --currency USD \
-        --order-id "INV-${Date.now()}" \
-        --order-description "Premium subscription" \
-        --success-url "https://example.com/success" \
-        --cancel-url "https://example.com/cancel"
-    `);
-    const invoice = JSON.parse(invoiceResult.stdout);
-
-    console.log('   ✓ Invoice created!\n');
-    console.log('Invoice Details:');
-    console.log(`  Invoice ID: ${invoice.id}`);
-    console.log(`  Status: ${invoice.invoice_status}`);
-    console.log(`  Amount: $${invoice.price_amount} ${invoice.price_currency}`);
-    console.log(`  Invoice URL: ${invoice.invoice_url}`);
-    console.log(`  Created: ${new Date(invoice.created_at).toLocaleString()}\n`);
-
-    console.log('Share this URL with your customer:');
-    console.log(`  ${invoice.invoice_url}\n`);
-
-    // Step 2: Check invoice status
-    console.log('2. Checking invoice status...');
-    const statusResult = await execPromise(
-      `nowpayments --json invoice get ${invoice.id}`
-    );
-    const status = JSON.parse(statusResult.stdout);
-
-    console.log(`   Status: ${status.invoice_status}`);
-
-    if (status.payment_id) {
-      console.log(`   Payment ID: ${status.payment_id}`);
-    }
-
-    // Step 3: List recent invoices
-    console.log('\n3. Listing recent invoices...');
-    const listResult = await execPromise(
-      'nowpayments --json invoice list --limit 5'
-    );
-    const list = JSON.parse(listResult.stdout);
-
-    console.log(`   Found ${list.data.length} invoices:\n`);
-    list.data.forEach((inv, i) => {
-      console.log(`   ${i + 1}. ${inv.id}`);
-      console.log(`      Status: ${inv.invoice_status}`);
-      console.log(`      Amount: $${inv.price_amount}`);
-      console.log(`      Created: ${new Date(inv.created_at).toLocaleString()}`);
-      console.log('');
-    });
-
-  } catch (error) {
-    console.error('Error:', error.message);
-    process.exit(1);
-  }
-}
-
-// Run the example
-createInvoiceFlow();

package/examples/monitor-payment.js

@@ -1,94 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Payment Monitoring Example
- *
- * Demonstrates monitoring a payment until completion or timeout.
- */
-
-const { exec } = require('child_process');
-const util = require('util');
-
-const execPromise = util.promisify(exec);
-
-// Configuration
-const CHECK_INTERVAL = 30000; // 30 seconds
-const MAX_DURATION = 30 * 60 * 1000; // 30 minutes
-
-async function monitorPayment(paymentId) {
-  const startTime = Date.now();
-
-  console.log(`Monitoring payment: ${paymentId}`);
-  console.log(`Check interval: ${CHECK_INTERVAL / 1000}s`);
-  console.log(`Max duration: ${MAX_DURATION / 60000} minutes\n`);
-
-  while (Date.now() - startTime < MAX_DURATION) {
-    try {
-      // Check payment status
-      const result = await execPromise(
-        `nowpayments --json payment get ${paymentId}`
-      );
-      const payment = JSON.parse(result.stdout);
-
-      const elapsed = Math.round((Date.now() - startTime) / 1000);
-      console.log(`[${elapsed}s] Status: ${payment.payment_status}`);
-
-      // Check for terminal states
-      switch (payment.payment_status) {
-        case 'finished':
-          console.log('\n✓ Payment completed successfully!');
-          console.log(`  Amount paid: ${payment.actually_paid} ${payment.pay_currency}`);
-          console.log(`  Outcome: ${payment.outcome_amount} ${payment.outcome_currency}`);
-          return { success: true, payment };
-
-        case 'failed':
-          console.log('\n✗ Payment failed');
-          return { success: false, reason: 'failed', payment };
-
-        case 'expired':
-          console.log('\n✗ Payment expired');
-          return { success: false, reason: 'expired', payment };
-
-        case 'partially_paid':
-          console.log(`\n⚠ Partially paid: ${payment.actually_paid}/${payment.pay_amount} ${payment.pay_currency}`);
-          // Continue monitoring
-          break;
-
-        case 'waiting':
-        case 'confirming':
-        case 'confirmed':
-        case 'sending':
-          // Still processing, continue monitoring
-          break;
-      }
-
-      // Wait before next check
-      await new Promise(resolve => setTimeout(resolve, CHECK_INTERVAL));
-
-    } catch (error) {
-      console.error(`Error checking payment: ${error.message}`);
-      await new Promise(resolve => setTimeout(resolve, CHECK_INTERVAL));
-    }
-  }
-
-  console.log('\n⏱ Monitoring timeout reached');
-  return { success: false, reason: 'timeout' };
-}
-
-// Get payment ID from command line
-const paymentId = process.argv[2];
-
-if (!paymentId) {
-  console.error('Usage: node monitor-payment.js <payment_id>');
-  process.exit(1);
-}
-
-// Run monitoring
-monitorPayment(paymentId)
-  .then(result => {
-    process.exit(result.success ? 0 : 1);
-  })
-  .catch(error => {
-    console.error('Fatal error:', error);
-    process.exit(1);
-  });