@paychainly/cli 1.1.0 → 1.1.2

package/README.md

@@ -0,0 +1,149 @@
+# @paychainly/cli
+
+> Relay live Paychainly webhooks to your local server during development — no public URL needed.
+
+[![npm version](https://img.shields.io/npm/v/@paychainly/cli)](https://www.npmjs.com/package/@paychainly/cli)
+[![license](https://img.shields.io/npm/l/@paychainly/cli)](LICENSE)
+
+---
+
+## Installation
+
+```bash
+npm install -g @paychainly/cli
+```
+
+---
+
+## Quick Start
+
+```bash
+paychainly listen --api-key pk_live_... --forward-to http://localhost:3000/webhook
+```
+
+Webhooks fired on [api.paychainly.com](https://api.paychainly.com) are forwarded in real time to your local server.
+
+---
+
+## Commands
+
+### `listen` — relay live webhooks
+
+```bash
+paychainly listen [options]
+```
+
+| Option | Description | Default |
+|---|---|---|
+| `--api-key` | Your Paychainly API key (`pk_live_...` or `pk_test_...`) | `PAYCHAINLY_API_KEY` env |
+| `--forward-to` | Full local URL to POST webhooks to | `http://localhost:3000/webhook` |
+| `--port` | Shorthand for `--forward-to http://localhost:<port>/webhook` | `3000` |
+| `--host` | Paychainly server URL | `https://api.paychainly.com` |
+| `--secret` | Webhook secret — enables HMAC-SHA256 signature verification | — |
+| `--verbose` | Pretty-print the full webhook payload (JSON) | off |
+| `--filter` | Only relay events matching this name (e.g. `deposit_detected`) | all events |
+| `--log` | Append every received event to a JSONL file for later replay | — |
+
+**Examples**
+
+```bash
+# Basic
+paychainly listen --api-key pk_live_... --port 3000
+
+# Show full payload for every event
+paychainly listen --api-key pk_live_... --verbose
+
+# Only relay deposit events and save them to disk
+paychainly listen --api-key pk_live_... \
+  --filter deposit_detected \
+  --log deposits.jsonl
+
+# Verify webhook signatures
+paychainly listen --api-key pk_live_... --secret whsec_...
+```
+
+---
+
+### `status` — check API key & connectivity
+
+```bash
+paychainly status --api-key pk_live_...
+```
+
+Connects to the server, validates the key, and prints the user ID and account mode. Useful for confirming your key is correct before starting a session.
+
+---
+
+### `replay` — resend saved events to your local server
+
+```bash
+paychainly replay --log events.jsonl [options]
+```
+
+| Option | Description | Default |
+|---|---|---|
+| `--log` | JSONL file produced by `listen --log` **(required)** | — |
+| `--forward-to` | Local URL to POST events to | `http://localhost:3000/webhook` |
+| `--port` | Shorthand for `--forward-to http://localhost:<port>/webhook` | `3000` |
+| `--filter` | Only replay events matching this name | all events |
+| `--delay` | Milliseconds between replayed events | `500` |
+| `--verbose` | Pretty-print each payload before sending | off |
+
+**Examples**
+
+```bash
+# Replay everything
+paychainly replay --log events.jsonl
+
+# Replay only deposit events with a 1-second gap, show payloads
+paychainly replay --log events.jsonl \
+  --filter deposit_detected \
+  --delay 1000 \
+  --verbose
+```
+
+---
+
+## Typical Developer Workflow
+
+```bash
+# 1. Start listening and capture events to a file
+paychainly listen --api-key pk_live_... --log events.jsonl --verbose
+
+# 2. Trigger a test payment on your dashboard
+# 3. Inspect your webhook handler logs
+
+# 4. Fix a bug in your handler, restart your server
+
+# 5. Replay the captured events — no real payment needed
+paychainly replay --log events.jsonl --filter deposit_detected
+```
+
+---
+
+## Environment Variables
+
+You can set these instead of passing flags every time:
+
+```bash
+export PAYCHAINLY_API_KEY=pk_live_...
+export PAYCHAINLY_HOST=https://api.paychainly.com     # optional override
+export PAYCHAINLY_WEBHOOK_SECRET=whsec_...            # optional
+```
+
+---
+
+## Webhook Events
+
+| Event | Description |
+|---|---|
+| `deposit_detected` | A USDT transfer to a monitored deposit address was confirmed |
+| `sweep_completed` | Funds swept from deposit address to master wallet |
+| `address_expired` | A deposit address session expired without a payment |
+| `withdrawal_completed` | A user-initiated withdrawal was processed |
+
+---
+
+## License
+
+MIT © [Paychainly](https://paychainly.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paychainly/cli",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Paychainly CLI — relay webhooks to your localhost during development",
   "keywords": [
     "paychainly",

package/src/listen.js

@@ -141,9 +141,10 @@ ${c.bold}${c.cyan}  ╔═══════════════════
       reconnectionAttempts: Infinity,
     });
 
-    socket.on('relay_connected', ({ userId, mode }) => {
+    socket.on('relay_connected', ({ userId, email, mode }) => {
       connected = true;
-      console.log(`  ${c.green}✓ Connected${c.reset} ${c.gray}(userId: ${userId}, mode: ${mode})${c.reset}`);
+      const identity = email || `userId: ${userId}`;
+      console.log(`  ${c.green}✓ Connected${c.reset} ${c.gray}(${identity}, mode: ${mode})${c.reset}`);
       console.log(`  ${c.gray}Waiting for webhooks... (Ctrl+C to stop)${c.reset}\n`);
     });
 

package/src/status.js

@@ -41,9 +41,10 @@ module.exports = function status(argv) {
     timeout: 10000,
   });
 
-  socket.on('relay_connected', ({ userId, mode }) => {
+  socket.on('relay_connected', ({ userId, email, mode }) => {
     process.stdout.write(' '.repeat(40) + '\r');
     console.log(`  ${c.green}✓ API key valid${c.reset}`);
+    if (email) console.log(`  ${c.gray}Email   :${c.reset} ${email}`);
     console.log(`  ${c.gray}User ID :${c.reset} ${userId}`);
     console.log(`  ${c.gray}Mode    :${c.reset} ${mode}\n`);
     socket.disconnect();