agentic-payments 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +924 -0
- package/bin/cli.js +18 -0
- package/bin/mcp.js +10 -0
- package/completions/agentic-payments.bash +21 -0
- package/completions/agentic-payments.fish +9 -0
- package/completions/agentic-payments.zsh +17 -0
- package/completions/bash.sh +182 -0
- package/completions/fish.fish +110 -0
- package/completions/zsh.sh +175 -0
- package/dist/active-mandate/i18n.d.ts +27 -0
- package/dist/active-mandate/i18n.d.ts.map +1 -0
- package/dist/active-mandate/i18n.js +35 -0
- package/dist/active-mandate/i18n.js.map +1 -0
- package/dist/active-mandate/index.d.ts +26 -0
- package/dist/active-mandate/index.d.ts.map +1 -0
- package/dist/active-mandate/index.js +51 -0
- package/dist/active-mandate/index.js.map +1 -0
- package/dist/active-mandate/revocation.d.ts +11 -0
- package/dist/active-mandate/revocation.d.ts.map +1 -0
- package/dist/active-mandate/revocation.js +27 -0
- package/dist/active-mandate/revocation.js.map +1 -0
- package/dist/active-mandate/schema.d.ts +85 -0
- package/dist/active-mandate/schema.d.ts.map +1 -0
- package/dist/active-mandate/schema.js +36 -0
- package/dist/active-mandate/schema.js.map +1 -0
- package/dist/active-mandate/signing.d.ts +8 -0
- package/dist/active-mandate/signing.d.ts.map +1 -0
- package/dist/active-mandate/signing.js +64 -0
- package/dist/active-mandate/signing.js.map +1 -0
- package/dist/active-mandate/types.d.ts +59 -0
- package/dist/active-mandate/types.d.ts.map +1 -0
- package/dist/active-mandate/types.js +6 -0
- package/dist/active-mandate/types.js.map +1 -0
- package/dist/cli/commands/active-mandate.d.ts +4 -0
- package/dist/cli/commands/active-mandate.d.ts.map +1 -0
- package/dist/cli/commands/active-mandate.js +218 -0
- package/dist/cli/commands/active-mandate.js.map +1 -0
- package/dist/cli/commands/generate.d.ts +3 -0
- package/dist/cli/commands/generate.d.ts.map +1 -0
- package/dist/cli/commands/generate.js +59 -0
- package/dist/cli/commands/generate.js.map +1 -0
- package/dist/cli/commands/mandate.d.ts +4 -0
- package/dist/cli/commands/mandate.d.ts.map +1 -0
- package/dist/cli/commands/mandate.js +223 -0
- package/dist/cli/commands/mandate.js.map +1 -0
- package/dist/cli/commands/system.d.ts +4 -0
- package/dist/cli/commands/system.d.ts.map +1 -0
- package/dist/cli/commands/system.js +101 -0
- package/dist/cli/commands/system.js.map +1 -0
- package/dist/cli/commands/verify.d.ts +3 -0
- package/dist/cli/commands/verify.d.ts.map +1 -0
- package/dist/cli/commands/verify.js +104 -0
- package/dist/cli/commands/verify.js.map +1 -0
- package/dist/cli/completion.d.ts +3 -0
- package/dist/cli/completion.d.ts.map +1 -0
- package/dist/cli/completion.js +245 -0
- package/dist/cli/completion.js.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +79 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/errors.d.ts +58 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +100 -0
- package/dist/errors.js.map +1 -0
- package/dist/identity.d.ts +78 -0
- package/dist/identity.d.ts.map +1 -0
- package/dist/identity.js +204 -0
- package/dist/identity.js.map +1 -0
- package/dist/index.d.ts +68 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +79 -0
- package/dist/index.js.map +1 -0
- package/dist/mandate.d.ts +134 -0
- package/dist/mandate.d.ts.map +1 -0
- package/dist/mandate.js +342 -0
- package/dist/mandate.js.map +1 -0
- package/dist/mcp/index.d.ts +7 -0
- package/dist/mcp/index.d.ts.map +1 -0
- package/dist/mcp/index.js +102 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/server.d.ts +38 -0
- package/dist/mcp/server.d.ts.map +1 -0
- package/dist/mcp/server.js +126 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tools/agent.d.ts +9 -0
- package/dist/mcp/tools/agent.d.ts.map +1 -0
- package/dist/mcp/tools/agent.js +34 -0
- package/dist/mcp/tools/agent.js.map +1 -0
- package/dist/mcp/tools/consensus.d.ts +9 -0
- package/dist/mcp/tools/consensus.d.ts.map +1 -0
- package/dist/mcp/tools/consensus.js +38 -0
- package/dist/mcp/tools/consensus.js.map +1 -0
- package/dist/mcp/tools/index.d.ts +45 -0
- package/dist/mcp/tools/index.d.ts.map +1 -0
- package/dist/mcp/tools/index.js +282 -0
- package/dist/mcp/tools/index.js.map +1 -0
- package/dist/mcp/tools/mandate.d.ts +31 -0
- package/dist/mcp/tools/mandate.d.ts.map +1 -0
- package/dist/mcp/tools/mandate.js +165 -0
- package/dist/mcp/tools/mandate.js.map +1 -0
- package/dist/mcp/tools/payment.d.ts +13 -0
- package/dist/mcp/tools/payment.d.ts.map +1 -0
- package/dist/mcp/tools/payment.js +66 -0
- package/dist/mcp/tools/payment.js.map +1 -0
- package/dist/mcp/tools/types.d.ts +63 -0
- package/dist/mcp/tools/types.d.ts.map +1 -0
- package/dist/mcp/tools/types.js +5 -0
- package/dist/mcp/tools/types.js.map +1 -0
- package/dist/mcp/transports/http.d.ts +52 -0
- package/dist/mcp/transports/http.d.ts.map +1 -0
- package/dist/mcp/transports/http.js +234 -0
- package/dist/mcp/transports/http.js.map +1 -0
- package/dist/types.d.ts +238 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +7 -0
- package/dist/types.js.map +1 -0
- package/dist/verification.d.ts +140 -0
- package/dist/verification.d.ts.map +1 -0
- package/dist/verification.js +285 -0
- package/dist/verification.js.map +1 -0
- package/package.json +175 -0
package/README.md
ADDED
|
@@ -0,0 +1,924 @@
|
|
|
1
|
+
# agentic-payments
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/agentic-payments)
|
|
4
|
+
[](https://www.npmjs.com/package/agentic-payments)
|
|
5
|
+
[](https://www.typescriptlang.org/)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
8
|
+
> **Multi-agent payment authorization system for autonomous AI commerce**
|
|
9
|
+
|
|
10
|
+
## Introduction
|
|
11
|
+
|
|
12
|
+
`agentic-payments` enables AI agents to make autonomous purchases, execute trades, process invoices, and coordinate multi-agent transactions with cryptographic authorization. From shopping assistants that compare prices across merchants, to robo-advisors executing investment strategies, to swarms of specialized agents collaborating on enterprise procurement—this library provides the payment infrastructure for the agentic economy.
|
|
13
|
+
|
|
14
|
+
**Real-World Applications:**
|
|
15
|
+
- **E-Commerce**: AI shopping agents with weekly budgets and merchant restrictions
|
|
16
|
+
- **Finance**: Robo-advisors executing trades within risk-managed portfolios
|
|
17
|
+
- **Enterprise**: Multi-agent swarms requiring consensus for high-value purchases
|
|
18
|
+
- **Accounting**: Automated AP/AR with policy-based approval workflows
|
|
19
|
+
- **Subscriptions**: Autonomous renewal management with spending caps
|
|
20
|
+
|
|
21
|
+
**Model Context Protocol (MCP) Integration**: Connect AI assistants like Claude, ChatGPT, and Cline directly to payment authorization through natural language. No code required—AI assistants can create mandates, sign transactions, verify consensus, and manage payment workflows conversationally.
|
|
22
|
+
|
|
23
|
+
**Three Complementary Protocols:**
|
|
24
|
+
- **MCP (Model Context Protocol)**: Stdio and HTTP interfaces for AI assistant integration
|
|
25
|
+
- **AP2 (Agent Payments Protocol)**: Cryptographic payment mandates with Ed25519 signatures
|
|
26
|
+
- **ACP (Agentic Commerce Protocol)**: REST API integration with Stripe-compatible checkout
|
|
27
|
+
- **Active Mandate**: Autonomous payment capsules with spend caps, time windows, and instant revocation
|
|
28
|
+
|
|
29
|
+
**Key Innovation**: Multi-agent Byzantine consensus allows fleets of specialized AI agents (purchasing, finance, compliance, audit) to collaboratively authorize transactions, ensuring no single compromised agent can approve fraudulent payments.
|
|
30
|
+
|
|
31
|
+
Built with TypeScript for Node.js, Deno, Bun, and browsers. Production-ready with comprehensive error handling and <200KB bundle size.
|
|
32
|
+
|
|
33
|
+
## 🎯 Features
|
|
34
|
+
|
|
35
|
+
- ✅ **Active Mandates**: Spend caps, time windows, merchant rules, and instant revocation
|
|
36
|
+
- ✅ **Ed25519 Cryptography**: Fast, secure signature verification (<1ms)
|
|
37
|
+
- ✅ **Multi-Agent Consensus**: Byzantine fault-tolerant verification with configurable thresholds
|
|
38
|
+
- ✅ **Intent Mandates**: Authorize AI agents for specific purchase intentions
|
|
39
|
+
- ✅ **Cart Mandates**: Pre-approve shopping carts with line-item verification
|
|
40
|
+
- ✅ **Payment Tracking**: Monitor payment status from authorization to capture
|
|
41
|
+
- ✅ **MCP Protocol**: Stdio and HTTP transports for AI assistant integration (Claude, Cline, etc.)
|
|
42
|
+
- ✅ **Production Ready**: 100% TypeScript, comprehensive error handling, <200KB
|
|
43
|
+
- ✅ **CLI Tools**: Command-line interface for mandate management and testing
|
|
44
|
+
|
|
45
|
+
## 📦 Installation
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Install the library
|
|
49
|
+
npm install agentic-payments
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### MCP Server (AI Assistant Integration)
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
# Run stdio transport (local - for Claude Desktop, Cline)
|
|
56
|
+
npx agentic-payments-mcp
|
|
57
|
+
|
|
58
|
+
# Run HTTP transport (remote - for web integrations)
|
|
59
|
+
npx agentic-payments-mcp --transport http --port 3000
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## 🚀 Quick Start
|
|
63
|
+
|
|
64
|
+
The library provides three interfaces: CLI commands for terminal use, MCP server for AI assistants, and programmatic API for JavaScript/TypeScript applications.
|
|
65
|
+
|
|
66
|
+
### CLI: Active Mandate Management
|
|
67
|
+
|
|
68
|
+
Create and manage payment mandates directly from your terminal:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# Create a new Active Mandate
|
|
72
|
+
npx agentic-payments active-mandate create \
|
|
73
|
+
--agent "shopping-bot@agentics" \
|
|
74
|
+
--holder "user@example.com" \
|
|
75
|
+
--amount 50000 \
|
|
76
|
+
--currency USD \
|
|
77
|
+
--period daily \
|
|
78
|
+
--kind intent \
|
|
79
|
+
--output mandate.json
|
|
80
|
+
|
|
81
|
+
# Sign the mandate with Ed25519
|
|
82
|
+
npx agentic-payments active-mandate sign \
|
|
83
|
+
--file mandate.json \
|
|
84
|
+
--key <your-private-key-hex> \
|
|
85
|
+
--output signed-mandate.json
|
|
86
|
+
|
|
87
|
+
# Verify mandate signature and validity
|
|
88
|
+
npx agentic-payments active-mandate verify \
|
|
89
|
+
--file signed-mandate.json \
|
|
90
|
+
--verbose
|
|
91
|
+
|
|
92
|
+
# Revoke a mandate
|
|
93
|
+
npx agentic-payments active-mandate revoke \
|
|
94
|
+
--id mandate_abc123 \
|
|
95
|
+
--reason "User request"
|
|
96
|
+
|
|
97
|
+
# List all revoked mandates
|
|
98
|
+
npx agentic-payments active-mandate revocations
|
|
99
|
+
```
|
|
100
|
+
## 🔌 MCP Integration Tutorial
|
|
101
|
+
|
|
102
|
+
The Model Context Protocol (MCP) allows AI assistants like Claude, Cline, and ChatGPT to interact with payment authorization systems through natural language. This tutorial walks you through setting up and using the MCP server for agentic payments.
|
|
103
|
+
|
|
104
|
+
### Part 1: Starting the MCP Server
|
|
105
|
+
|
|
106
|
+
The `agentic-payments` MCP server supports two transport modes:
|
|
107
|
+
|
|
108
|
+
**Stdio Transport** (recommended for local development):
|
|
109
|
+
```bash
|
|
110
|
+
# Start the server in stdio mode (default)
|
|
111
|
+
npx agentic-payments-mcp
|
|
112
|
+
|
|
113
|
+
# The server is now listening on stdin/stdout
|
|
114
|
+
# Perfect for Claude Desktop, Cline, and other local integrations
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
**HTTP/SSE Transport** (for remote or web-based integrations):
|
|
118
|
+
```bash
|
|
119
|
+
# Start the HTTP server on port 3000
|
|
120
|
+
npx agentic-payments-mcp --transport http --port 3000
|
|
121
|
+
|
|
122
|
+
# Server endpoints:
|
|
123
|
+
# - http://localhost:3000/health (health check)
|
|
124
|
+
# - http://localhost:3000/sse (SSE stream for MCP)
|
|
125
|
+
# - http://localhost:3000/message (JSON-RPC messages)
|
|
126
|
+
# - http://localhost:3000/sessions (active sessions)
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**Verify the HTTP server is running**:
|
|
130
|
+
```bash
|
|
131
|
+
# Check health endpoint
|
|
132
|
+
curl http://localhost:3000/health
|
|
133
|
+
|
|
134
|
+
# Response:
|
|
135
|
+
# {
|
|
136
|
+
# "status": "healthy",
|
|
137
|
+
# "version": "0.1.0",
|
|
138
|
+
# "server": "agentic-payments-mcp",
|
|
139
|
+
# "transport": "http/sse",
|
|
140
|
+
# "activeSessions": 0
|
|
141
|
+
# }
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Part 2: Connecting AI Assistants
|
|
145
|
+
|
|
146
|
+
**Claude Desktop** (local integration via stdio):
|
|
147
|
+
|
|
148
|
+
1. Edit your Claude Desktop config file:
|
|
149
|
+
- **macOS**: `~/.config/claude/claude_desktop_config.json`
|
|
150
|
+
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
151
|
+
|
|
152
|
+
2. Add the MCP server:
|
|
153
|
+
```json
|
|
154
|
+
{
|
|
155
|
+
"mcpServers": {
|
|
156
|
+
"agentic-payments": {
|
|
157
|
+
"command": "npx",
|
|
158
|
+
"args": ["agentic-payments-mcp"]
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
3. Restart Claude Desktop and verify the server appears in the MCP menu
|
|
165
|
+
|
|
166
|
+
**Claude Code** (local integration via stdio):
|
|
167
|
+
```bash
|
|
168
|
+
# Add the MCP server to Claude Code
|
|
169
|
+
claude mcp add agentic-payments npx agentic-payments-mcp
|
|
170
|
+
|
|
171
|
+
# Verify it's connected
|
|
172
|
+
claude mcp list
|
|
173
|
+
|
|
174
|
+
# You should see agentic-payments with status "Connected"
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**Cline Extension** (VS Code integration via stdio):
|
|
178
|
+
|
|
179
|
+
1. Open VS Code settings for Cline
|
|
180
|
+
2. Add to MCP servers configuration:
|
|
181
|
+
```json
|
|
182
|
+
{
|
|
183
|
+
"agentic-payments": {
|
|
184
|
+
"command": "npx",
|
|
185
|
+
"args": ["agentic-payments-mcp"]
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
**HTTP/SSE Integration** (remote or web applications):
|
|
191
|
+
|
|
192
|
+
```typescript
|
|
193
|
+
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
|
|
194
|
+
import { SSEClientTransport } from '@modelcontextprotocol/sdk/client/sse.js';
|
|
195
|
+
|
|
196
|
+
// Connect to remote MCP server
|
|
197
|
+
const transport = new SSEClientTransport(
|
|
198
|
+
new URL('http://localhost:3000/sse')
|
|
199
|
+
);
|
|
200
|
+
|
|
201
|
+
const client = new Client({
|
|
202
|
+
name: 'payment-client',
|
|
203
|
+
version: '1.0.0'
|
|
204
|
+
}, {
|
|
205
|
+
capabilities: {}
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
// Establish connection
|
|
209
|
+
await client.connect(transport);
|
|
210
|
+
|
|
211
|
+
// List available tools
|
|
212
|
+
const tools = await client.listTools();
|
|
213
|
+
console.log('Available tools:', tools.tools.map(t => t.name));
|
|
214
|
+
|
|
215
|
+
// Call a tool
|
|
216
|
+
const result = await client.callTool({
|
|
217
|
+
name: 'create_active_mandate',
|
|
218
|
+
arguments: {
|
|
219
|
+
agent: 'shopping-bot@example.com',
|
|
220
|
+
holder: 'user@example.com',
|
|
221
|
+
amount: 50000,
|
|
222
|
+
currency: 'USD',
|
|
223
|
+
period: 'weekly',
|
|
224
|
+
kind: 'intent',
|
|
225
|
+
expires_at: '2025-12-31T23:59:59Z'
|
|
226
|
+
}
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
console.log('Mandate created:', result);
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Part 3: Available MCP Tools
|
|
233
|
+
|
|
234
|
+
The MCP server exposes 10 tools for AI assistants:
|
|
235
|
+
|
|
236
|
+
| Tool | Purpose | Key Parameters |
|
|
237
|
+
|------|---------|---------------|
|
|
238
|
+
| `create_active_mandate` | Create payment mandates with spend caps | `agent`, `holder`, `amount`, `period` |
|
|
239
|
+
| `sign_mandate` | Ed25519 cryptographic signing | `mandate`, `private_key` |
|
|
240
|
+
| `verify_mandate` | Signature verification + guard checks | `signed_mandate` |
|
|
241
|
+
| `revoke_mandate` | Instant mandate revocation | `mandate_id`, `reason` |
|
|
242
|
+
| `list_revocations` | Query all revoked mandates | None |
|
|
243
|
+
| `generate_agent_identity` | Create Ed25519 keypairs | `include_private_key` |
|
|
244
|
+
| `create_intent_mandate` | High-level purchase authorization | `merchant_id`, `intent`, `max_amount` |
|
|
245
|
+
| `create_cart_mandate` | Shopping cart approval | `merchant_id`, `items` |
|
|
246
|
+
| `verify_consensus` | Multi-agent Byzantine verification | `agent_public_keys`, `consensus_threshold` |
|
|
247
|
+
| `get_mandate_info` | Retrieve mandate details | `mandate_id` |
|
|
248
|
+
|
|
249
|
+
### Part 4: Tutorial - Creating Your First AI Payment Agent
|
|
250
|
+
|
|
251
|
+
Let's walk through a complete example of authorizing an AI shopping agent:
|
|
252
|
+
|
|
253
|
+
**Step 1: Generate an agent identity**
|
|
254
|
+
```
|
|
255
|
+
User: "Generate a new agent identity for my shopping bot"
|
|
256
|
+
|
|
257
|
+
AI: I'll create a new Ed25519 keypair for your agent.
|
|
258
|
+
[Calls: generate_agent_identity]
|
|
259
|
+
|
|
260
|
+
Result:
|
|
261
|
+
- Public key: d837326487bbc4ad027eeb20f3f7e059...
|
|
262
|
+
- Agent can now sign payment mandates
|
|
263
|
+
- Store the private key securely (shown once)
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
**Step 2: Create a payment mandate**
|
|
267
|
+
```
|
|
268
|
+
User: "Create a weekly $500 mandate for grocery shopping"
|
|
269
|
+
|
|
270
|
+
AI: I'll create an Active Mandate with:
|
|
271
|
+
- Weekly spending cap: $500
|
|
272
|
+
- Purpose: Grocery shopping
|
|
273
|
+
- Valid until: end of year
|
|
274
|
+
[Calls: create_active_mandate]
|
|
275
|
+
|
|
276
|
+
Result:
|
|
277
|
+
- Mandate ID: mandate_c06a6e57-80a7-4c44-84b8-d6a5dd2d0686
|
|
278
|
+
- Status: Unsigned (needs signing)
|
|
279
|
+
- Cap: $500.00 weekly
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
**Step 3: Sign the mandate**
|
|
283
|
+
```
|
|
284
|
+
User: "Sign this mandate with the agent's private key"
|
|
285
|
+
|
|
286
|
+
AI: Signing the mandate with Ed25519...
|
|
287
|
+
[Calls: sign_mandate]
|
|
288
|
+
|
|
289
|
+
Result:
|
|
290
|
+
- Mandate now cryptographically signed
|
|
291
|
+
- Signature: 64-byte Ed25519 signature
|
|
292
|
+
- Ready for payment authorization
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
**Step 4: Create a shopping cart**
|
|
296
|
+
```
|
|
297
|
+
User: "Create a grocery cart: 2 laptops at $999 each, 2 mice at $29.99 each"
|
|
298
|
+
|
|
299
|
+
AI: Building shopping cart mandate...
|
|
300
|
+
[Calls: create_cart_mandate]
|
|
301
|
+
|
|
302
|
+
Result:
|
|
303
|
+
- Items: 2
|
|
304
|
+
- Total: $1058.98
|
|
305
|
+
- Merchant: amazon.com
|
|
306
|
+
- Status: Approved (within weekly cap)
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
**Step 5: Verify before purchase**
|
|
310
|
+
```
|
|
311
|
+
User: "Verify this mandate is still valid before processing payment"
|
|
312
|
+
|
|
313
|
+
AI: Running full verification...
|
|
314
|
+
[Calls: verify_mandate]
|
|
315
|
+
|
|
316
|
+
Result:
|
|
317
|
+
✓ Signature valid
|
|
318
|
+
✓ Not expired
|
|
319
|
+
✓ Not revoked
|
|
320
|
+
✓ Within spending cap
|
|
321
|
+
→ Payment authorized
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
**Step 6: Revoke if needed**
|
|
325
|
+
```
|
|
326
|
+
User: "Cancel the shopping mandate"
|
|
327
|
+
|
|
328
|
+
AI: Revoking mandate immediately...
|
|
329
|
+
[Calls: revoke_mandate]
|
|
330
|
+
|
|
331
|
+
Result:
|
|
332
|
+
- Mandate revoked at: 2025-09-30 15:38:14 UTC
|
|
333
|
+
- Reason: User cancellation
|
|
334
|
+
- All future payments blocked
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### Part 5: Multi-Agent Consensus Example
|
|
338
|
+
|
|
339
|
+
For high-value transactions, use multi-agent verification:
|
|
340
|
+
|
|
341
|
+
```
|
|
342
|
+
User: "Verify this $10,000 transaction with 3 agents requiring 67% consensus"
|
|
343
|
+
|
|
344
|
+
AI: Setting up Byzantine fault-tolerant verification...
|
|
345
|
+
[Calls: verify_consensus with 3 agent public keys]
|
|
346
|
+
|
|
347
|
+
Process:
|
|
348
|
+
1. Agent 1: ✓ Verified
|
|
349
|
+
2. Agent 2: ✓ Verified
|
|
350
|
+
3. Agent 3: ✓ Verified
|
|
351
|
+
|
|
352
|
+
Result:
|
|
353
|
+
- Consensus: YES (100% agreement)
|
|
354
|
+
- Byzantine tolerance: Can handle 1 compromised agent
|
|
355
|
+
- Transaction authorized
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Part 6: Testing Your Integration
|
|
359
|
+
|
|
360
|
+
**Test stdio integration**:
|
|
361
|
+
```bash
|
|
362
|
+
# Test that AI can access the tools
|
|
363
|
+
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | npx agentic-payments-mcp
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
**Test HTTP integration**:
|
|
367
|
+
```bash
|
|
368
|
+
# Run the test suite
|
|
369
|
+
node tests/mcp/http-simple-test.js
|
|
370
|
+
|
|
371
|
+
# Or manually test endpoints
|
|
372
|
+
curl http://localhost:3000/health
|
|
373
|
+
curl http://localhost:3000/sessions
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
**Expected output from test suite**:
|
|
377
|
+
```
|
|
378
|
+
🧪 Testing MCP HTTP/SSE Integration (Simple)
|
|
379
|
+
|
|
380
|
+
1️⃣ Creating MCP client...
|
|
381
|
+
2️⃣ Connecting to server...
|
|
382
|
+
✓ Connected successfully
|
|
383
|
+
|
|
384
|
+
3️⃣ Listing available tools...
|
|
385
|
+
✓ Found 10 tools
|
|
386
|
+
|
|
387
|
+
4️⃣ Testing create_active_mandate...
|
|
388
|
+
✓ Mandate created: mandate_c06a6e57-80a7-4c44-84b8-d6a5dd2d0686
|
|
389
|
+
✓ Amount: $1000.00 monthly
|
|
390
|
+
|
|
391
|
+
✅ All HTTP/SSE integration tests passed!
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### Part 7: Troubleshooting
|
|
395
|
+
|
|
396
|
+
**Server won't start**:
|
|
397
|
+
```bash
|
|
398
|
+
# Check if port is already in use
|
|
399
|
+
lsof -i :3000
|
|
400
|
+
|
|
401
|
+
# Kill existing process
|
|
402
|
+
pkill -f "agentic-payments-mcp"
|
|
403
|
+
|
|
404
|
+
# Try again
|
|
405
|
+
npx agentic-payments-mcp --transport http --port 3000
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
**AI can't see the tools**:
|
|
409
|
+
- Verify the server is running: `curl http://localhost:3000/health`
|
|
410
|
+
- Check Claude Desktop config syntax is valid JSON
|
|
411
|
+
- Restart your AI assistant after config changes
|
|
412
|
+
- Check logs: MCP servers log to stderr
|
|
413
|
+
|
|
414
|
+
**Session not found errors**:
|
|
415
|
+
- The HTTP transport automatically manages session IDs
|
|
416
|
+
- Each SSE connection creates a new session
|
|
417
|
+
- Sessions auto-cleanup after 30 seconds of inactivity
|
|
418
|
+
- Check `/sessions` endpoint to see active sessions
|
|
419
|
+
|
|
420
|
+
### Further Reading
|
|
421
|
+
|
|
422
|
+
For comprehensive details on implementation, security, and deployment:
|
|
423
|
+
- [Full MCP Implementation Guide](docs/mcp.md)
|
|
424
|
+
- [Active Mandate Specification](docs/active-mandate-spec.md)
|
|
425
|
+
- [Security Best Practices](docs/security.md)
|
|
426
|
+
|
|
427
|
+
## 🧪 CLI Commands
|
|
428
|
+
|
|
429
|
+
Full command reference for terminal-based mandate management, identity generation, and system operations.
|
|
430
|
+
|
|
431
|
+
### Active Mandate Commands
|
|
432
|
+
|
|
433
|
+
```bash
|
|
434
|
+
# Create mandate
|
|
435
|
+
npx agentic-payments active-mandate create [options]
|
|
436
|
+
-a, --agent <name> Agent identifier
|
|
437
|
+
-h, --holder <name> Holder/user identifier
|
|
438
|
+
--amount <number> Spend cap (minor units, e.g., 12000 = $120.00)
|
|
439
|
+
--currency <code> Currency code (default: USD)
|
|
440
|
+
--period <type> Spend period: single|daily|weekly|monthly
|
|
441
|
+
-k, --kind <type> Mandate kind: intent|cart
|
|
442
|
+
--merchant-allow <hosts> Comma-separated allowed merchants
|
|
443
|
+
--merchant-block <hosts> Comma-separated blocked merchants
|
|
444
|
+
--expires <iso> Expiration date (ISO8601)
|
|
445
|
+
-o, --output <file> Save to file
|
|
446
|
+
|
|
447
|
+
# Sign mandate
|
|
448
|
+
npx agentic-payments active-mandate sign [options]
|
|
449
|
+
-f, --file <path> Mandate file to sign
|
|
450
|
+
-k, --key <hex> Private key (64-byte hex)
|
|
451
|
+
-o, --output <file> Save signed mandate
|
|
452
|
+
|
|
453
|
+
# Verify mandate
|
|
454
|
+
npx agentic-payments active-mandate verify [options]
|
|
455
|
+
-f, --file <path> Signed mandate file
|
|
456
|
+
-v, --verbose Show detailed validation
|
|
457
|
+
|
|
458
|
+
# Revoke mandate
|
|
459
|
+
npx agentic-payments active-mandate revoke [options]
|
|
460
|
+
-i, --id <mandate_id> Mandate ID to revoke
|
|
461
|
+
-r, --reason <text> Revocation reason
|
|
462
|
+
|
|
463
|
+
# List revocations
|
|
464
|
+
npx agentic-payments active-mandate revocations
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### Generate Agent Identity
|
|
468
|
+
|
|
469
|
+
```bash
|
|
470
|
+
npx agentic-payments generate --format json
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
### Verify Payment
|
|
474
|
+
|
|
475
|
+
```bash
|
|
476
|
+
npx agentic-payments verify --amount 100 --agents 5
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
### System Status
|
|
480
|
+
|
|
481
|
+
```bash
|
|
482
|
+
npx agentic-payments system status
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
### API: Multi-Agent Consensus
|
|
487
|
+
|
|
488
|
+
Byzantine fault-tolerant payment verification using multiple AI agents to prevent fraud and ensure agreement:
|
|
489
|
+
|
|
490
|
+
```typescript
|
|
491
|
+
import { AgentIdentity, IntentMandate, VerificationSystemBuilder } from 'agentic-payments';
|
|
492
|
+
|
|
493
|
+
// 1. Create verification agents
|
|
494
|
+
const agent1 = await AgentIdentity.generate();
|
|
495
|
+
const agent2 = await AgentIdentity.generate();
|
|
496
|
+
const agent3 = await AgentIdentity.generate();
|
|
497
|
+
|
|
498
|
+
// 2. Build consensus system (requires 67% agreement)
|
|
499
|
+
const system = new VerificationSystemBuilder()
|
|
500
|
+
.consensusThreshold(0.67)
|
|
501
|
+
.minAgents(2)
|
|
502
|
+
.addAgent(agent1)
|
|
503
|
+
.addAgent(agent2)
|
|
504
|
+
.addAgent(agent3)
|
|
505
|
+
.build();
|
|
506
|
+
|
|
507
|
+
// 3. Create and sign payment mandate
|
|
508
|
+
const mandate = new IntentMandate({
|
|
509
|
+
merchantId: 'shop_12345',
|
|
510
|
+
customerId: 'user_67890',
|
|
511
|
+
intent: 'Monthly premium subscription',
|
|
512
|
+
maxAmount: 29.99,
|
|
513
|
+
currency: 'USD',
|
|
514
|
+
expiresAt: Date.now() + 86400000 // 24 hours
|
|
515
|
+
});
|
|
516
|
+
|
|
517
|
+
await mandate.sign(agent1);
|
|
518
|
+
|
|
519
|
+
// 4. Verify with Byzantine fault tolerance
|
|
520
|
+
const message = new TextEncoder().encode(JSON.stringify(mandate.toJSON()));
|
|
521
|
+
const signature = mandate.getSignature();
|
|
522
|
+
const result = await system.verifyWithConsensus(signature, message, agent1.publicKey());
|
|
523
|
+
|
|
524
|
+
console.log(`✅ Verified: ${result.isValid}`);
|
|
525
|
+
console.log(`Consensus: ${(result.consensusReached ? 'YES' : 'NO')}`);
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
## 💡 Usage Examples
|
|
529
|
+
|
|
530
|
+
Real-world scenarios showing how AI agents use cryptographic mandates for autonomous commerce.
|
|
531
|
+
|
|
532
|
+
### E-Commerce: AI Shopping Agent
|
|
533
|
+
|
|
534
|
+
Authorize AI shopping assistants with spending limits, merchant restrictions, and time-bound budgets:
|
|
535
|
+
|
|
536
|
+
```typescript
|
|
537
|
+
import { AgentIdentity, CartMandate, validateAndVerify } from 'agentic-payments';
|
|
538
|
+
|
|
539
|
+
// User authorizes shopping agent with Active Mandate
|
|
540
|
+
const mandate = {
|
|
541
|
+
mandate_id: 'mandate_grocery_001',
|
|
542
|
+
kind: 'cart',
|
|
543
|
+
agent: 'grocery-bot@shop.ai',
|
|
544
|
+
holder: 'alice@example.com',
|
|
545
|
+
cap: {
|
|
546
|
+
amount: 20000, // $200.00 weekly grocery budget
|
|
547
|
+
currency: 'USD',
|
|
548
|
+
period: 'weekly'
|
|
549
|
+
},
|
|
550
|
+
merchant_allow: ['wholefoodsmarket.com', 'instacart.com'],
|
|
551
|
+
expires_at: '2025-12-31T23:59:59Z'
|
|
552
|
+
};
|
|
553
|
+
|
|
554
|
+
// AI agent builds shopping cart
|
|
555
|
+
const cart = new CartMandate({
|
|
556
|
+
merchantId: 'wholefoodsmarket.com',
|
|
557
|
+
customerId: 'alice@example.com',
|
|
558
|
+
items: [
|
|
559
|
+
{ id: 'sku_001', name: 'Organic Bananas', quantity: 2, unitPrice: 399 },
|
|
560
|
+
{ id: 'sku_002', name: 'Almond Milk', quantity: 1, unitPrice: 549 },
|
|
561
|
+
{ id: 'sku_003', name: 'Sourdough Bread', quantity: 1, unitPrice: 649 }
|
|
562
|
+
],
|
|
563
|
+
currency: 'USD'
|
|
564
|
+
});
|
|
565
|
+
|
|
566
|
+
const agent = await AgentIdentity.generate();
|
|
567
|
+
await cart.sign(agent);
|
|
568
|
+
|
|
569
|
+
// Verify and process
|
|
570
|
+
const totalAmount = cart.getTotalAmount();
|
|
571
|
+
console.log(`Cart total: $${(totalAmount / 100).toFixed(2)}`);
|
|
572
|
+
console.log(`Within budget: ${totalAmount <= mandate.cap.amount}`);
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
**Use case**: AI shopping assistants that compare prices, build optimized carts, and complete purchases autonomously while respecting user-defined spending limits.
|
|
576
|
+
|
|
577
|
+
### Finance: Investment Agent
|
|
578
|
+
|
|
579
|
+
AI robo-advisors execute trades autonomously within pre-approved limits and time windows:
|
|
580
|
+
|
|
581
|
+
```typescript
|
|
582
|
+
import { IntentMandate, AgentIdentity } from 'agentic-payments';
|
|
583
|
+
|
|
584
|
+
// User authorizes trading agent
|
|
585
|
+
const tradingMandate = new IntentMandate({
|
|
586
|
+
merchantId: 'exchange.trading.com',
|
|
587
|
+
customerId: 'investor_123',
|
|
588
|
+
intent: 'Purchase index fund ETF',
|
|
589
|
+
maxAmount: 5000.00,
|
|
590
|
+
currency: 'USD',
|
|
591
|
+
expiresAt: Date.now() + 3600000 // 1 hour execution window
|
|
592
|
+
});
|
|
593
|
+
|
|
594
|
+
const tradingAgent = await AgentIdentity.generate();
|
|
595
|
+
await tradingMandate.sign(tradingAgent);
|
|
596
|
+
|
|
597
|
+
console.log('✅ Trading agent authorized for ETF purchase');
|
|
598
|
+
console.log(`Max investment: $${tradingMandate.getData().maxAmount}`);
|
|
599
|
+
console.log(`Expires: ${new Date(tradingMandate.getData().expiresAt).toLocaleString()}`);
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
**Use case**: Robo-advisors and AI trading systems that rebalance portfolios, execute DCA strategies, or respond to market conditions with pre-authorized transaction limits.
|
|
603
|
+
|
|
604
|
+
### Accounting: Expense Management
|
|
605
|
+
|
|
606
|
+
Automate accounts payable with AI agents that approve, categorize, and process vendor payments:
|
|
607
|
+
|
|
608
|
+
```typescript
|
|
609
|
+
import { PaymentMandate, AgentIdentity } from 'agentic-payments';
|
|
610
|
+
|
|
611
|
+
// Finance agent approves recurring vendor payment
|
|
612
|
+
const expenseAgent = await AgentIdentity.generate();
|
|
613
|
+
|
|
614
|
+
const vendorPayment = new PaymentMandate({
|
|
615
|
+
sourceId: 'expense_recurring_001',
|
|
616
|
+
type: 'intent',
|
|
617
|
+
amount: 299.99,
|
|
618
|
+
currency: 'USD',
|
|
619
|
+
paymentMethod: 'ach_vendor_account'
|
|
620
|
+
});
|
|
621
|
+
|
|
622
|
+
await vendorPayment.sign(expenseAgent);
|
|
623
|
+
vendorPayment.updateStatus('authorized');
|
|
624
|
+
|
|
625
|
+
console.log(`Payment status: ${vendorPayment.getStatus()}`);
|
|
626
|
+
console.log(`Authorized: ${vendorPayment.isComplete()}`);
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
**Use case**: Automated accounts payable, expense report processing, and vendor management where AI agents categorize, approve, and execute payments based on policy rules.
|
|
630
|
+
|
|
631
|
+
### Agent Fleet Management
|
|
632
|
+
|
|
633
|
+
Deploy multiple specialized AI agents with consensus-based approval for high-value transactions:
|
|
634
|
+
|
|
635
|
+
```typescript
|
|
636
|
+
import { VerificationSystemBuilder, AgentIdentity } from 'agentic-payments';
|
|
637
|
+
|
|
638
|
+
// Create specialized agent fleet
|
|
639
|
+
const purchasingAgent = await AgentIdentity.generate();
|
|
640
|
+
const financeAgent = await AgentIdentity.generate();
|
|
641
|
+
const complianceAgent = await AgentIdentity.generate();
|
|
642
|
+
const auditAgent = await AgentIdentity.generate();
|
|
643
|
+
|
|
644
|
+
// Require 75% consensus for payment approval
|
|
645
|
+
const fleetSystem = new VerificationSystemBuilder()
|
|
646
|
+
.consensusThreshold(0.75)
|
|
647
|
+
.minAgents(3)
|
|
648
|
+
.addAgent(purchasingAgent)
|
|
649
|
+
.addAgent(financeAgent)
|
|
650
|
+
.addAgent(complianceAgent)
|
|
651
|
+
.addAgent(auditAgent)
|
|
652
|
+
.build();
|
|
653
|
+
|
|
654
|
+
console.log('✅ Multi-agent payment authorization system active');
|
|
655
|
+
console.log(`Agents: ${fleetSystem.metrics().totalVerifications}`);
|
|
656
|
+
console.log(`Consensus: 75% required (3 of 4 agents)`);
|
|
657
|
+
```
|
|
658
|
+
|
|
659
|
+
**Use case**: Enterprise workflows where purchases require multi-party approval, segregation of duties, or Byzantine fault tolerance against compromised agents.
|
|
660
|
+
|
|
661
|
+
## 📖 API Reference
|
|
662
|
+
|
|
663
|
+
Complete TypeScript/JavaScript API for programmatic integration into applications.
|
|
664
|
+
|
|
665
|
+
### Active Mandate API
|
|
666
|
+
|
|
667
|
+
Core functions for mandate validation, signature verification, and execution guards:
|
|
668
|
+
|
|
669
|
+
```typescript
|
|
670
|
+
import {
|
|
671
|
+
validateAndVerify,
|
|
672
|
+
guardExecution,
|
|
673
|
+
revoke,
|
|
674
|
+
isRevoked,
|
|
675
|
+
getAllRevocations
|
|
676
|
+
} from 'agentic-payments';
|
|
677
|
+
|
|
678
|
+
// Validate schema and verify Ed25519 signature
|
|
679
|
+
const result = validateAndVerify(signedMandate);
|
|
680
|
+
if (result.valid && result.parsed) {
|
|
681
|
+
console.log('✓ Valid mandate');
|
|
682
|
+
}
|
|
683
|
+
|
|
684
|
+
// Check execution guards (time windows, revocation)
|
|
685
|
+
const guard = guardExecution(result.parsed);
|
|
686
|
+
if (guard.allowed) {
|
|
687
|
+
// Execute payment
|
|
688
|
+
} else {
|
|
689
|
+
console.log(`Blocked: ${guard.reason}`);
|
|
690
|
+
}
|
|
691
|
+
|
|
692
|
+
// Revoke mandate
|
|
693
|
+
const revocation = revoke('mandate_123', 'User cancelled');
|
|
694
|
+
|
|
695
|
+
// Check revocation status
|
|
696
|
+
if (isRevoked('mandate_123')) {
|
|
697
|
+
console.log('Mandate has been revoked');
|
|
698
|
+
}
|
|
699
|
+
|
|
700
|
+
// List all revocations
|
|
701
|
+
const revocations = getAllRevocations();
|
|
702
|
+
console.log(`Total revoked: ${revocations.length}`);
|
|
703
|
+
```
|
|
704
|
+
|
|
705
|
+
### Agent Identity
|
|
706
|
+
|
|
707
|
+
Generate Ed25519 keypairs for AI agents, sign messages, and verify cryptographic signatures:
|
|
708
|
+
|
|
709
|
+
```typescript
|
|
710
|
+
import { AgentIdentity } from 'agentic-payments';
|
|
711
|
+
|
|
712
|
+
// Generate new Ed25519 keypair
|
|
713
|
+
const agent = await AgentIdentity.generate();
|
|
714
|
+
console.log(`Agent ID: ${agent.id}`);
|
|
715
|
+
console.log(`Public Key: ${Buffer.from(agent.publicKey()).toString('hex')}`);
|
|
716
|
+
|
|
717
|
+
// Sign message
|
|
718
|
+
const message = new TextEncoder().encode('payment authorization');
|
|
719
|
+
const signature = await agent.sign(message);
|
|
720
|
+
|
|
721
|
+
// Verify signature
|
|
722
|
+
const isValid = AgentIdentity.verify(
|
|
723
|
+
agent.publicKey(),
|
|
724
|
+
message,
|
|
725
|
+
signature.bytes
|
|
726
|
+
);
|
|
727
|
+
console.log(`Valid signature: ${isValid}`);
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
### Verification System
|
|
731
|
+
|
|
732
|
+
Build multi-agent consensus systems with configurable thresholds and Byzantine fault tolerance:
|
|
733
|
+
|
|
734
|
+
```typescript
|
|
735
|
+
import { VerificationSystemBuilder } from 'agentic-payments';
|
|
736
|
+
|
|
737
|
+
const system = new VerificationSystemBuilder()
|
|
738
|
+
.consensusThreshold(0.67) // 67% agreement required
|
|
739
|
+
.minAgents(2)
|
|
740
|
+
.maxAgents(10)
|
|
741
|
+
.timeout(5000) // 5 second timeout
|
|
742
|
+
.parallel(true) // Parallel verification
|
|
743
|
+
.addAgent(agent1)
|
|
744
|
+
.addAgent(agent2)
|
|
745
|
+
.addAgent(agent3)
|
|
746
|
+
.build();
|
|
747
|
+
|
|
748
|
+
// Verify with consensus
|
|
749
|
+
const result = await system.verifyWithConsensus(signature, message, publicKey);
|
|
750
|
+
|
|
751
|
+
console.log(`Verified: ${result.isValid}`);
|
|
752
|
+
console.log(`Consensus: ${result.consensusReached}`);
|
|
753
|
+
console.log(`Agents: ${result.agentResults.length}`);
|
|
754
|
+
|
|
755
|
+
// Get metrics
|
|
756
|
+
const metrics = system.metrics();
|
|
757
|
+
console.log(`Total verifications: ${metrics.totalVerifications}`);
|
|
758
|
+
console.log(`Success rate: ${metrics.successfulVerifications / metrics.totalVerifications}`);
|
|
759
|
+
|
|
760
|
+
// Cleanup
|
|
761
|
+
system.shutdown();
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
### Intent Mandates
|
|
765
|
+
|
|
766
|
+
High-level purchase authorizations with maximum amounts and expiration times:
|
|
767
|
+
|
|
768
|
+
```typescript
|
|
769
|
+
import { IntentMandate } from 'agentic-payments';
|
|
770
|
+
|
|
771
|
+
const mandate = new IntentMandate({
|
|
772
|
+
merchantId: 'merchant_123',
|
|
773
|
+
customerId: 'customer_456',
|
|
774
|
+
intent: 'Purchase premium subscription',
|
|
775
|
+
maxAmount: 99.99,
|
|
776
|
+
currency: 'USD',
|
|
777
|
+
expiresAt: Date.now() + 86400000
|
|
778
|
+
});
|
|
779
|
+
|
|
780
|
+
await mandate.sign(agent);
|
|
781
|
+
|
|
782
|
+
// Validate before use
|
|
783
|
+
const validation = mandate.validate();
|
|
784
|
+
if (!validation.valid) {
|
|
785
|
+
console.error('Errors:', validation.errors);
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
const json = mandate.toJSON();
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
### Cart Mandates
|
|
792
|
+
|
|
793
|
+
Shopping cart approvals with line-item details and automatic total calculation:
|
|
794
|
+
|
|
795
|
+
```typescript
|
|
796
|
+
import { CartMandate } from 'agentic-payments';
|
|
797
|
+
|
|
798
|
+
const cart = new CartMandate({
|
|
799
|
+
merchantId: 'shop_123',
|
|
800
|
+
customerId: 'user_456',
|
|
801
|
+
items: [
|
|
802
|
+
{ id: 'item1', name: 'Product A', quantity: 2, unitPrice: 1999 },
|
|
803
|
+
{ id: 'item2', name: 'Product B', quantity: 1, unitPrice: 2999 }
|
|
804
|
+
],
|
|
805
|
+
currency: 'USD',
|
|
806
|
+
expiresAt: Date.now() + 3600000
|
|
807
|
+
});
|
|
808
|
+
|
|
809
|
+
await cart.sign(agent);
|
|
810
|
+
|
|
811
|
+
const items = cart.getItems();
|
|
812
|
+
const total = cart.getTotalAmount();
|
|
813
|
+
console.log(`Total: $${(total / 100).toFixed(2)}`);
|
|
814
|
+
```
|
|
815
|
+
|
|
816
|
+
### Payment Mandates
|
|
817
|
+
|
|
818
|
+
Track payment lifecycle from authorization through capture with status management:
|
|
819
|
+
|
|
820
|
+
```typescript
|
|
821
|
+
import { PaymentMandate } from 'agentic-payments';
|
|
822
|
+
|
|
823
|
+
const payment = new PaymentMandate({
|
|
824
|
+
sourceId: 'intent_123',
|
|
825
|
+
type: 'intent',
|
|
826
|
+
amount: 99.99,
|
|
827
|
+
currency: 'USD',
|
|
828
|
+
paymentMethod: 'card_1234'
|
|
829
|
+
});
|
|
830
|
+
|
|
831
|
+
await payment.sign(agent);
|
|
832
|
+
payment.updateStatus('authorized');
|
|
833
|
+
payment.updateStatus('captured');
|
|
834
|
+
|
|
835
|
+
console.log(`Status: ${payment.getStatus()}`);
|
|
836
|
+
console.log(`Complete: ${payment.isComplete()}`);
|
|
837
|
+
```
|
|
838
|
+
|
|
839
|
+
### Error Handling
|
|
840
|
+
|
|
841
|
+
Typed error handling with recovery detection and formatted error messages:
|
|
842
|
+
|
|
843
|
+
```typescript
|
|
844
|
+
import { PaymentError, isRecoverable, formatError } from 'agentic-payments';
|
|
845
|
+
|
|
846
|
+
try {
|
|
847
|
+
const result = await system.verifyWithConsensus(sig, msg, pubkey);
|
|
848
|
+
} catch (error) {
|
|
849
|
+
if (error instanceof PaymentError) {
|
|
850
|
+
console.error(`Error: ${error.code}`);
|
|
851
|
+
console.error(`Recoverable: ${error.recoverable}`);
|
|
852
|
+
|
|
853
|
+
if (isRecoverable(error)) {
|
|
854
|
+
// Retry logic
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
console.error(formatError(error));
|
|
858
|
+
}
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
## 🏗️ Architecture
|
|
863
|
+
|
|
864
|
+
Modular architecture with clear separation between protocols, cryptography, and interfaces:
|
|
865
|
+
|
|
866
|
+
```
|
|
867
|
+
agentic-payments/
|
|
868
|
+
├── src/
|
|
869
|
+
│ ├── index.ts # Main exports
|
|
870
|
+
│ ├── identity.ts # Ed25519 agent identities
|
|
871
|
+
│ ├── verification.ts # Multi-agent consensus
|
|
872
|
+
│ ├── mandate.ts # Payment mandates
|
|
873
|
+
│ ├── errors.ts # Error handling
|
|
874
|
+
│ ├── active-mandate/ # Active Mandate implementation
|
|
875
|
+
│ │ ├── types.ts # TypeScript types
|
|
876
|
+
│ │ ├── schema.ts # Zod validation
|
|
877
|
+
│ │ ├── signing.ts # Ed25519 signing
|
|
878
|
+
│ │ ├── revocation.ts # Revocation store
|
|
879
|
+
│ │ └── i18n.ts # Internationalization
|
|
880
|
+
│ ├── cli/ # Command-line interface
|
|
881
|
+
│ │ ├── index.ts # CLI entry point
|
|
882
|
+
│ │ └── commands/ # CLI commands
|
|
883
|
+
│ ├── ap2/ # Agent Payments Protocol
|
|
884
|
+
│ └── acp/ # Agentic Commerce Protocol
|
|
885
|
+
└── dist/ # Compiled output
|
|
886
|
+
```
|
|
887
|
+
|
|
888
|
+
## 📊 Performance
|
|
889
|
+
|
|
890
|
+
Optimized for low-latency payment authorization with minimal bundle impact:
|
|
891
|
+
|
|
892
|
+
| Operation | Time | Notes |
|
|
893
|
+
|-----------|------|-------|
|
|
894
|
+
| Ed25519 Sign | ~2ms | Single signature |
|
|
895
|
+
| Ed25519 Verify | ~3ms | Single verification |
|
|
896
|
+
| Consensus (3 agents) | ~10ms | Byzantine fault tolerance |
|
|
897
|
+
| Mandate Validation | <1ms | Schema + business rules |
|
|
898
|
+
| Bundle Size | <200KB | Gzipped, tree-shakeable |
|
|
899
|
+
|
|
900
|
+
## 📄 License
|
|
901
|
+
|
|
902
|
+
Licensed under either of:
|
|
903
|
+
- **MIT License** ([LICENSE-MIT](LICENSE-MIT))
|
|
904
|
+
- **Apache License 2.0** ([LICENSE-APACHE](LICENSE-APACHE))
|
|
905
|
+
|
|
906
|
+
## 🌟 Credits
|
|
907
|
+
|
|
908
|
+
- **Author**: [rUv](https://github.com/ruvnet)
|
|
909
|
+
- **Cryptography**: Ed25519 via `@noble/ed25519` and `tweetnacl`
|
|
910
|
+
- **Validation**: Zod schemas
|
|
911
|
+
|
|
912
|
+
## 🔗 Links
|
|
913
|
+
|
|
914
|
+
- [GitHub Repository](https://github.com/agentic-catalog/agentic-payments)
|
|
915
|
+
- [npm Package](https://www.npmjs.com/package/agentic-payments)
|
|
916
|
+
- [Issue Tracker](https://github.com/agentic-catalog/agentic-payments/issues)
|
|
917
|
+
|
|
918
|
+
---
|
|
919
|
+
|
|
920
|
+
**Build the future of autonomous AI commerce** 🚀
|
|
921
|
+
|
|
922
|
+
```bash
|
|
923
|
+
npm install agentic-payments
|
|
924
|
+
```
|