agent-commerce-client 0.1.0__py3-none-any.whl

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.
@@ -0,0 +1,19 @@
1
+ """Buyer core for Agent Commerce Gateway (ACG)."""
2
+
3
+ from .client import (
4
+ AgentCommerceClient,
5
+ AgentCommerceError,
6
+ InvokeResult,
7
+ MemorySpendStore,
8
+ ResourceTool,
9
+ SpendStore,
10
+ )
11
+
12
+ __all__ = [
13
+ "AgentCommerceClient",
14
+ "AgentCommerceError",
15
+ "InvokeResult",
16
+ "MemorySpendStore",
17
+ "ResourceTool",
18
+ "SpendStore",
19
+ ]
@@ -0,0 +1,433 @@
1
+ """Discover gateway resources and pay with x402 within spending limits"""
2
+
3
+ from __future__ import annotations
4
+
5
+ import asyncio
6
+ import base64
7
+ import json
8
+ import logging
9
+ import re
10
+ import threading
11
+ from collections.abc import Sequence
12
+ from concurrent.futures import ThreadPoolExecutor
13
+ from dataclasses import dataclass
14
+ from datetime import datetime, timezone
15
+ from decimal import Decimal
16
+ from typing import Any, Protocol
17
+ from urllib.parse import quote, urlsplit
18
+
19
+ import httpx
20
+ from x402 import x402Client
21
+ from x402.http.clients.httpx import PaymentError, x402_httpx_transport
22
+ from x402.http.utils import ResponseBodyTooLargeError
23
+ from x402.mechanisms.evm.exact import ExactEvmScheme
24
+ from x402.schemas import AbortResult, NoMatchingRequirementsError
25
+
26
+ _LOG = logging.getLogger("agent_commerce_client")
27
+
28
+ # Supported EVM networks and their USDC contracts; None allows any asset on local Anvil
29
+ _USDC: dict[str, str | None] = {
30
+ "eip155:31337": None, # local Anvil
31
+ "eip155:84532": "0x036CbD53842c5426634e7929541eC2318f3dCF7e", # Base Sepolia
32
+ "eip155:421614": "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d", # Arbitrum Sepolia
33
+ "eip155:8453": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", # Base
34
+ "eip155:1": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", # Ethereum
35
+ "eip155:137": "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359", # Polygon
36
+ "eip155:42161": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", # Arbitrum One
37
+ "eip155:43114": "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E", # Avalanche C-Chain
38
+ }
39
+ _TESTNETS = frozenset({"eip155:31337", "eip155:84532", "eip155:421614"})
40
+ _LIMIT = re.compile(r"[0-9]+(?:\.[0-9]{1,6})?")
41
+ _ATOMIC = re.compile(r"[0-9]+")
42
+ _GATEWAY_CODE = re.compile(r"[A-Z_]{1,64}")
43
+ _REASON = re.compile(r"[a-z0-9_]{1,64}")
44
+ _TX = re.compile(r"0x[0-9a-fA-F]{64}")
45
+ _UNITS = 1_000_000 # USDC has 6 decimals
46
+ _TIMEOUT = 60.0
47
+ _APPROVALS = ("paid", "always", "never")
48
+ _NO_OFFER = "The gateway offered no exact USDC payment on an allowed network"
49
+
50
+
51
+ class AgentCommerceError(Exception):
52
+ """Client runtime failure with a short message for the model.
53
+
54
+ The client uses LIMIT_EXCEEDED, NETWORK_NOT_ALLOWED, PAYMENT_FAILED,
55
+ BACKEND_ERROR (with `status`) and GATEWAY_UNREACHABLE. Its error messages
56
+ omit secrets and start with the code so frameworks can show the message alone.
57
+ """
58
+
59
+ def __init__(self, code: str, message: str, status: int | None = None) -> None:
60
+ if not message.startswith(f"{code}: "):
61
+ message = f"{code}: {message}"
62
+ super().__init__(message)
63
+ self.code = code
64
+ self.message = message
65
+ self.status = status
66
+
67
+
68
+ @dataclass(frozen=True)
69
+ class ResourceTool:
70
+ """Gateway resource metadata for a framework tool"""
71
+
72
+ name: str
73
+ description: str
74
+ input_schema: dict[str, Any]
75
+ paid: bool
76
+ needs_approval: bool
77
+
78
+
79
+ @dataclass(frozen=True)
80
+ class InvokeResult:
81
+ """HTTP status, response body and decoded PAYMENT-RESPONSE, or None without a valid header"""
82
+
83
+ status: int
84
+ body: Any
85
+ payment: dict[str, Any] | None
86
+
87
+
88
+ class SpendStore(Protocol):
89
+ """Daily spending counter in micro-USDC; `add` must be atomic"""
90
+
91
+ def add(self, day: str, amount: int) -> int:
92
+ """Add `amount` to the UTC day `day` (YYYY-MM-DD) and return the new total.
93
+
94
+ A negative amount rolls back a reservation.
95
+ """
96
+ ...
97
+
98
+
99
+ class MemorySpendStore:
100
+ """Spend store held in process memory"""
101
+
102
+ def __init__(self) -> None:
103
+ self._totals: dict[str, int] = {}
104
+ self._lock = threading.Lock()
105
+
106
+ def add(self, day: str, amount: int) -> int:
107
+ with self._lock:
108
+ total = self._totals[day] = self._totals.get(day, 0) + amount
109
+ return total
110
+
111
+
112
+ def _today() -> str:
113
+ return datetime.now(timezone.utc).strftime("%Y-%m-%d")
114
+
115
+
116
+ def _limit(name: str, value: Any) -> int:
117
+ if not isinstance(value, str):
118
+ raise TypeError(f"{name} must be a decimal string such as '0.05'")
119
+ if not _LIMIT.fullmatch(value):
120
+ raise ValueError(f"{name} must be a non-negative decimal with at most 6 decimal places")
121
+ return int(Decimal(value) * _UNITS)
122
+
123
+
124
+ def _usdc(units: int) -> str:
125
+ return format(Decimal(units) / _UNITS, "f")
126
+
127
+
128
+ def _text(value: Any) -> str:
129
+ return value.strip() if isinstance(value, str) else ""
130
+
131
+
132
+ def _has(raw: dict[str, Any], key: str, item: str) -> bool:
133
+ value = raw.get(key)
134
+ return isinstance(value, list) and item in value
135
+
136
+
137
+ def _header(response: httpx.Response, name: str) -> dict[str, Any] | None:
138
+ # x402 headers carry base64-encoded JSON
139
+ try:
140
+ value = json.loads(base64.b64decode(response.headers[name], validate=True))
141
+ except (KeyError, ValueError):
142
+ return None
143
+ return value if isinstance(value, dict) else None
144
+
145
+
146
+ def _gateway_code(response: httpx.Response) -> str | None:
147
+ try:
148
+ code = response.json().get("code")
149
+ except (ValueError, AttributeError):
150
+ return None
151
+ return code if isinstance(code, str) and _GATEWAY_CODE.fullmatch(code) else None
152
+
153
+
154
+ def _run(method: Any, *args: Any) -> Any:
155
+ """Run an async method from sync code, including when an event loop is active"""
156
+ try:
157
+ asyncio.get_running_loop()
158
+ except RuntimeError:
159
+ return asyncio.run(method(*args))
160
+ with ThreadPoolExecutor(max_workers=1) as pool:
161
+ return pool.submit(asyncio.run, method(*args)).result()
162
+
163
+
164
+ class _Payment:
165
+ """Track one invocation's x402 client, payment attempts and signing state"""
166
+
167
+ def __init__(self, owner: AgentCommerceClient) -> None:
168
+ self._owner = owner
169
+ self._attempts = 0
170
+ self.signed = False
171
+ self.error: AgentCommerceError | None = None
172
+ client = x402Client()
173
+ for network in owner._networks:
174
+ client.register(network, owner._scheme)
175
+ # Use the checks in `before` instead of x402's $1 cap and token allowlist
176
+ # so higher max_per_call values and the local Anvil token remain usable
177
+ client.set_spend_controls(False)
178
+ # Filter before selection so an unacceptable offer cannot displace a USDC offer
179
+ client.register_policy(lambda version, offers: [offer for offer in offers if owner._acceptable(offer)])
180
+ client.on_before_payment_creation(self.before)
181
+ client.on_after_payment_creation(self.after)
182
+ self.client = client
183
+
184
+ def _abort(self, code: str, message: str) -> AbortResult:
185
+ self.error = AgentCommerceError(code, message)
186
+ return AbortResult(reason=code)
187
+
188
+ def before(self, ctx: Any) -> AbortResult | None:
189
+ owner = self._owner
190
+ offer = ctx.selected_requirements
191
+ # Reject a second payment attempt within this invocation
192
+ self._attempts += 1
193
+ if self._attempts > 1:
194
+ return self._abort("PAYMENT_FAILED", "A second payment is not allowed for one invocation")
195
+ if not owner._acceptable(offer):
196
+ return self._abort("NETWORK_NOT_ALLOWED", _NO_OFFER)
197
+ raw = offer.get_amount()
198
+ if not _ATOMIC.fullmatch(raw):
199
+ raise ValueError("invalid payment amount")
200
+ amount = int(raw)
201
+ price = _usdc(amount)
202
+ if amount > owner._max_per_call:
203
+ return self._abort(
204
+ "LIMIT_EXCEEDED",
205
+ f"Price {price} USDC exceeds the per-call limit of {_usdc(owner._max_per_call)} USDC",
206
+ )
207
+ day = _today()
208
+ if owner._store.add(day, amount) > owner._max_per_day:
209
+ owner._store.add(day, -amount)
210
+ return self._abort("LIMIT_EXCEEDED", f"Price {price} USDC exceeds the remaining daily allowance")
211
+ return None
212
+
213
+ def after(self, ctx: Any) -> None:
214
+ # Keep the reservation after signing because funds may move
215
+ self.signed = True
216
+
217
+ def failure(self, cause: BaseException) -> AgentCommerceError:
218
+ if self.error is not None:
219
+ return self.error
220
+ if isinstance(cause, NoMatchingRequirementsError):
221
+ return AgentCommerceError("NETWORK_NOT_ALLOWED", _NO_OFFER)
222
+ if isinstance(cause, httpx.HTTPError):
223
+ return _unreachable(self.signed)
224
+ return AgentCommerceError("PAYMENT_FAILED", "Payment could not be completed")
225
+
226
+
227
+ def _unreachable(signed: bool) -> AgentCommerceError:
228
+ suffix = "; a payment may have been sent" if signed else ""
229
+ return AgentCommerceError("GATEWAY_UNREACHABLE", f"Gateway could not be reached{suffix}")
230
+
231
+
232
+ class AgentCommerceClient:
233
+ """Discover and invoke ACG resources, paying with x402 within spending limits.
234
+
235
+ `list_tools`/`alist_tools` and `invoke`/`ainvoke` provide sync and async forms
236
+ of the same operations. Invalid configuration raises ValueError or TypeError
237
+ during construction; client runtime failures raise AgentCommerceError.
238
+
239
+ Use `transport` to replace the HTTP transport in tests, for example with
240
+ `httpx.MockTransport`. Each call closes the transport. Proxy environment
241
+ variables are ignored.
242
+ """
243
+
244
+ def __init__(
245
+ self,
246
+ *,
247
+ gateway_url: str,
248
+ signer: Any,
249
+ networks: Sequence[str],
250
+ max_per_call: str,
251
+ max_per_day: str,
252
+ resources: Sequence[str] | None = None,
253
+ allow_mainnet: bool = False,
254
+ approval: str = "paid",
255
+ spend_store: SpendStore | None = None,
256
+ transport: httpx.AsyncBaseTransport | None = None,
257
+ ) -> None:
258
+ if not isinstance(gateway_url, str):
259
+ raise TypeError("gateway_url must be a string")
260
+ parts = urlsplit(gateway_url)
261
+ if parts.scheme not in ("http", "https") or not parts.netloc:
262
+ raise ValueError("gateway_url must be an http or https URL")
263
+ if signer is None or isinstance(signer, (str, bytes, bytearray)):
264
+ raise TypeError("signer must be a wallet object such as an eth_account account, not a raw private key")
265
+ if not (hasattr(signer, "address") and hasattr(signer, "sign_typed_data")):
266
+ raise TypeError("signer must expose `address` and `sign_typed_data`")
267
+ if isinstance(networks, str) or not isinstance(networks, Sequence):
268
+ raise TypeError("networks must be a list of CAIP-2 network ids")
269
+ if not networks:
270
+ raise ValueError("networks must not be empty")
271
+ if not isinstance(allow_mainnet, bool):
272
+ raise TypeError("allow_mainnet must be a bool")
273
+ for network in networks:
274
+ if network not in _USDC:
275
+ raise ValueError(f"networks may only hold: {', '.join(_USDC)}")
276
+ if network not in _TESTNETS and not allow_mainnet:
277
+ raise ValueError(f"{network} is a mainnet; pass allow_mainnet=True to allow it")
278
+ if resources is not None and (isinstance(resources, str) or not isinstance(resources, Sequence)):
279
+ raise TypeError("resources must be a list of resource ids")
280
+ if approval not in _APPROVALS:
281
+ raise ValueError("approval must be 'paid', 'always' or 'never'")
282
+ if spend_store is not None and not callable(getattr(spend_store, "add", None)):
283
+ raise TypeError("spend_store must provide add(day, amount)")
284
+
285
+ self._base = gateway_url.rstrip("/")
286
+ self._networks = frozenset(networks)
287
+ self._max_per_call = _limit("max_per_call", max_per_call)
288
+ self._max_per_day = _limit("max_per_day", max_per_day)
289
+ self._resources = None if resources is None else frozenset(resources)
290
+ self._approval = approval
291
+ self._store: SpendStore = spend_store if spend_store is not None else MemorySpendStore()
292
+ self._transport = transport
293
+ self._scheme = ExactEvmScheme(signer)
294
+
295
+ def _acceptable(self, offer: Any) -> bool:
296
+ # Accept exact EIP-3009 offers on configured networks, using their USDC asset
297
+ # Permit2 requires a prior on-chain approval; ACG returns 412 without it
298
+ if offer.scheme != "exact" or offer.network not in self._networks:
299
+ return False
300
+ if (offer.extra or {}).get("assetTransferMethod") not in (None, "eip3009"):
301
+ return False
302
+ usdc = _USDC[offer.network]
303
+ return usdc is None or offer.asset.lower() == usdc.lower()
304
+
305
+ # Discovery
306
+
307
+ def list_tools(self) -> list[ResourceTool]:
308
+ """Return eligible gateway resources as tool descriptions"""
309
+ return _run(self.alist_tools)
310
+
311
+ async def alist_tools(self) -> list[ResourceTool]:
312
+ """Async form of `list_tools`"""
313
+ response = await self._send("GET", "/api/resources")
314
+ if not 200 <= response.status_code < 300:
315
+ raise _backend_error(response)
316
+ try:
317
+ items = response.json()["resources"]
318
+ except (ValueError, KeyError, TypeError):
319
+ items = None
320
+ if not isinstance(items, list):
321
+ raise AgentCommerceError(
322
+ "BACKEND_ERROR", "Gateway returned an unexpected resource list", response.status_code
323
+ )
324
+ tools = []
325
+ for raw in items:
326
+ if not isinstance(raw, dict) or not isinstance(raw.get("id"), str):
327
+ _LOG.warning("Skipping a resource without a string id")
328
+ continue
329
+ reason = self._skip_reason(raw)
330
+ if reason:
331
+ _LOG.warning("Skipping resource %s: %s", json.dumps(raw["id"]), reason)
332
+ continue
333
+ tools.append(self._describe(raw))
334
+ return tools
335
+
336
+ def _skip_reason(self, raw: dict[str, Any]) -> str | None:
337
+ if not _has(raw, "exposedVia", "http"):
338
+ return "not exposed over http"
339
+ if _pricing(raw).get("type") != "free" and not _has(raw, "paymentMethods", "x402"):
340
+ return "not payable with x402"
341
+ if self._resources is not None and raw["id"] not in self._resources:
342
+ return "not in the resources allowlist"
343
+ return None
344
+
345
+ def _describe(self, raw: dict[str, Any]) -> ResourceTool:
346
+ pricing = _pricing(raw)
347
+ paid = pricing.get("type") != "free"
348
+ summary = _text(raw.get("description")) or _text(raw.get("name")) or raw["id"]
349
+ if not summary.endswith((".", "!", "?")):
350
+ summary += "."
351
+ if not paid:
352
+ price = "Free."
353
+ elif (
354
+ pricing.get("type") == "fixed"
355
+ and isinstance(pricing.get("amount"), str)
356
+ and isinstance(pricing.get("currency"), str)
357
+ ):
358
+ price = f"Costs {pricing['amount']} {pricing['currency']} per call."
359
+ else:
360
+ price = "Paid."
361
+ schema = raw.get("inputSchema")
362
+ return ResourceTool(
363
+ name=raw["id"],
364
+ description=f"{summary} {price}",
365
+ input_schema=schema if isinstance(schema, dict) else {"type": "object", "properties": {}},
366
+ paid=paid,
367
+ needs_approval=(paid if self._approval == "paid" else self._approval == "always"),
368
+ )
369
+
370
+ # Invocation
371
+
372
+ def invoke(self, resource: str, input: dict[str, Any] | None = None) -> InvokeResult:
373
+ """Invoke a resource and pay with x402 if the gateway requires payment"""
374
+ return _run(self.ainvoke, resource, input)
375
+
376
+ async def ainvoke(self, resource: str, input: dict[str, Any] | None = None) -> InvokeResult:
377
+ """Async form of `invoke`"""
378
+ payment = _Payment(self)
379
+ path = f"/api/resources/{quote(resource, safe='')}/invoke"
380
+ response = await self._send("POST", path, {} if input is None else input, payment)
381
+ status = response.status_code
382
+ settled = _header(response, "PAYMENT-RESPONSE") or {}
383
+ if status == 402 or settled.get("success") is False:
384
+ # The x402 transport handles the initial challenge; a final 402 rejects the payment.
385
+ # Failed settlement on another status (ACG uses 502) may still complete on chain.
386
+ required = _header(response, "PAYMENT-REQUIRED") or {}
387
+ reason = settled.get("errorReason") or required.get("error")
388
+ reason = reason if isinstance(reason, str) and _REASON.fullmatch(reason) else None
389
+ if status == 402:
390
+ code = _gateway_code(response)
391
+ detail = (f": {code}" if code else "") + (f" ({reason})" if reason else "")
392
+ raise AgentCommerceError("PAYMENT_FAILED", f"The gateway refused the payment{detail}")
393
+ transaction = settled.get("transaction")
394
+ tx = f"tx {transaction}" if isinstance(transaction, str) and _TX.fullmatch(transaction) else None
395
+ notes = ", ".join(note for note in (reason, tx) if note)
396
+ detail = f" ({notes})" if notes else ""
397
+ raise AgentCommerceError(
398
+ "PAYMENT_FAILED", f"Settlement not confirmed{detail}; the payment may still complete on chain"
399
+ )
400
+ if 200 <= status < 300:
401
+ body: Any = response.text
402
+ if "json" in response.headers.get("content-type", ""):
403
+ try:
404
+ body = response.json()
405
+ except ValueError:
406
+ pass
407
+ return InvokeResult(status, body, _header(response, "PAYMENT-RESPONSE"))
408
+ raise _backend_error(response)
409
+
410
+ async def _send(self, method: str, path: str, body: Any = None, payment: _Payment | None = None) -> httpx.Response:
411
+ # Disable connection retries in the default transport to avoid replaying payments
412
+ inner = self._transport or httpx.AsyncHTTPTransport(retries=0)
413
+ transport = inner if payment is None else x402_httpx_transport(payment.client, inner)
414
+ try:
415
+ async with httpx.AsyncClient(transport=transport, timeout=_TIMEOUT) as http:
416
+ return await http.request(method, self._base + path, json=body)
417
+ except (PaymentError, ResponseBodyTooLargeError, httpx.HTTPError) as exc:
418
+ # Unwrap PaymentError to classify transport and offer-selection failures
419
+ cause = exc.__cause__ if isinstance(exc, PaymentError) and exc.__cause__ else exc
420
+ raise (payment.failure(cause) if payment else _unreachable(False)) from None
421
+
422
+
423
+ def _pricing(raw: dict[str, Any]) -> dict[str, Any]:
424
+ pricing = raw.get("pricing")
425
+ return pricing if isinstance(pricing, dict) else {}
426
+
427
+
428
+ def _backend_error(response: httpx.Response) -> AgentCommerceError:
429
+ code = _gateway_code(response)
430
+ suffix = f" ({code})" if code else ""
431
+ return AgentCommerceError(
432
+ "BACKEND_ERROR", f"Gateway returned HTTP {response.status_code}{suffix}", response.status_code
433
+ )
File without changes
@@ -0,0 +1,168 @@
1
+ Metadata-Version: 2.5
2
+ Name: agent-commerce-client
3
+ Version: 0.1.0
4
+ Summary: Python buyer client for a self-hosted Agent Commerce Gateway: discovers resources and pays for them with x402 within set spending limits.
5
+ Project-URL: Homepage, https://acg.devlab.group
6
+ Project-URL: Repository, https://github.com/devlab-group/agent-commerce-clients
7
+ Project-URL: Issues, https://github.com/devlab-group/agent-commerce-clients/issues
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ Keywords: agents,api,payments,x402
11
+ Requires-Python: >=3.10
12
+ Requires-Dist: httpx>=0.28.1
13
+ Requires-Dist: x402[evm,httpx]<3,>=2.28.0
14
+ Description-Content-Type: text/markdown
15
+
16
+ # agent-commerce-client
17
+
18
+ Python buyer client for a self-hosted [Agent Commerce Gateway](https://acg.devlab.group) (ACG). It discovers gateway
19
+ resources and pays for them with x402, within spending limits you set in code.
20
+
21
+ The framework packages build on this client and add no payment logic of their own:
22
+ [`langchain-agent-commerce`](../langchain-agent-commerce) and
23
+ [`agent-framework-agent-commerce`](../agent-framework-agent-commerce) (Microsoft Agent Framework). The full behavior
24
+ contract, shared with the TypeScript client, is in
25
+ [docs/buyer-core.md](https://github.com/devlab-group/agent-commerce-clients/blob/main/docs/buyer-core.md).
26
+
27
+ ## Install
28
+
29
+ ```bash
30
+ pip install agent-commerce-client
31
+ ```
32
+
33
+ Python 3.10 or newer. Payments use the official [`x402`](https://pypi.org/project/x402/) package (`exact` scheme on EVM
34
+ networks).
35
+
36
+ ## Quick start
37
+
38
+ ```python
39
+ import os
40
+
41
+ from agent_commerce_client import AgentCommerceClient, AgentCommerceError
42
+ from eth_account import Account
43
+
44
+ client = AgentCommerceClient(
45
+ gateway_url="https://merchant.example.com",
46
+ signer=Account.from_key(os.environ["BUYER_PRIVATE_KEY"]),
47
+ networks=["eip155:84532"], # Base Sepolia
48
+ max_per_call="0.05", # USDC
49
+ max_per_day="1.00", # USDC per UTC day
50
+ )
51
+
52
+ for tool in client.list_tools():
53
+ print(tool.name, "-", tool.description)
54
+
55
+ try:
56
+ result = client.invoke("report", {"topic": "x"})
57
+ print(result.status, result.body, result.payment) # payment: network, transaction hash, payer
58
+ except AgentCommerceError as error:
59
+ print(error.code, error.message, error.status)
60
+ ```
61
+
62
+ Use `await client.alist_tools()` and `await client.ainvoke(...)` for async calls. The sync methods call the same
63
+ implementation and can also run while an event loop is active.
64
+
65
+ ## Configuration
66
+
67
+ | Argument | Required | Meaning |
68
+ | --------------- | -------- | -------------------------------------------------------------------------------- |
69
+ | `gateway_url` | Yes | Gateway base URL, `http` or `https` |
70
+ | `signer` | Yes | Wallet object, for example an `eth_account` account. A raw key string is refused |
71
+ | `networks` | Yes | Allowed networks from the table below, for example `["eip155:84532"]` |
72
+ | `max_per_call` | Yes | Limit per invocation in USDC, a decimal string with up to 6 decimals |
73
+ | `max_per_day` | Yes | Limit per UTC day in USDC |
74
+ | `resources` | No | Allowlist of resource ids; every eligible resource when omitted |
75
+ | `allow_mainnet` | No | Must be `True` before any mainnet network is accepted |
76
+ | `approval` | No | `"paid"` (default), `"always"` or `"never"`: which tools carry `needs_approval` |
77
+ | `spend_store` | No | Daily spending counter; process memory by default |
78
+ | `transport` | No | HTTP transport override for tests; closed after each call |
79
+
80
+ Invalid configuration raises `ValueError` or `TypeError` during client construction. `resources=[]` excludes every
81
+ resource; leave it as `None` to include all eligible resources.
82
+
83
+ `networks` accepts the EVM networks below. Payments use each network's USDC, with any asset allowed on local Anvil:
84
+
85
+ | Network | Id | Kind | USDC |
86
+ | ----------------- | --------------- | ------- | -------------------------------------------- |
87
+ | Local Anvil | `eip155:31337` | testnet | any asset (local development chain) |
88
+ | Base Sepolia | `eip155:84532` | testnet | `0x036CbD53842c5426634e7929541eC2318f3dCF7e` |
89
+ | Arbitrum Sepolia | `eip155:421614` | testnet | `0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d` |
90
+ | Base | `eip155:8453` | mainnet | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
91
+ | Ethereum | `eip155:1` | mainnet | `0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48` |
92
+ | Polygon | `eip155:137` | mainnet | `0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359` |
93
+ | Arbitrum One | `eip155:42161` | mainnet | `0xaf88d065e77c8cC2239327C5EDb3A432268e5831` |
94
+ | Avalanche C-Chain | `eip155:43114` | mainnet | `0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E` |
95
+
96
+ Mainnet networks require `allow_mainnet=True`. Unknown network ids raise `ValueError` even with that setting.
97
+
98
+ ## Spending limits
99
+
100
+ The client enforces limits before signing a payment. When the gateway answers `402`, an offer is acceptable only with
101
+ the `exact` scheme, a network in `networks`, that network's USDC and an EIP-3009 transfer (`extra.assetTransferMethod`
102
+ absent or `eip3009`; `permit2` needs an on-chain approval first, and ACG answers 412 without it). Unacceptable offers
103
+ are removed before the x402 client selects one, so an earlier non-USDC offer cannot displace an acceptable USDC offer.
104
+ If none remains, the call fails with `NETWORK_NOT_ALLOWED`. The x402 before-payment hook then checks the selected offer
105
+ again, and the amount (USDC base units, 6 decimals) must not exceed `max_per_call`; it is reserved in the spend store
106
+ against `max_per_day`. A refusal raises `AgentCommerceError` before a signature exists. The model calling a tool cannot
107
+ change any limit.
108
+
109
+ Each invocation sends at most one request with `PAYMENT-SIGNATURE` and does not retry it. After signing, the reserved
110
+ amount remains in the daily total even if the gateway rejects the payment, because the client cannot always tell whether
111
+ funds moved.
112
+
113
+ To share the daily counter between processes, pass a `spend_store` with an atomic `add` method:
114
+
115
+ ```python
116
+ class SpendStore:
117
+ def add(self, day: str, amount: int) -> int:
118
+ """Add `amount` micro-USDC (negative to roll back) to `day` (UTC, YYYY-MM-DD); return the new total."""
119
+ ```
120
+
121
+ ## Resources and tools
122
+
123
+ `list_tools()` keeps a resource when it is exposed over `http`, is free or accepts x402, and is in the `resources`
124
+ allowlist (if given). Each resource excluded by these filters produces one warning on the `agent_commerce_client`
125
+ logger. A tool is a `ResourceTool` with `name` (the resource id), `description` (ends with `Costs 0.01 USDC per call.`,
126
+ `Free.` or `Paid.`), `input_schema`, `paid` and `needs_approval`. Framework wrappers use `needs_approval` to configure
127
+ human approval.
128
+
129
+ Tool names and descriptions come from the gateway and reach the model. Use `resources=[...]` to expose only resources
130
+ you trust.
131
+
132
+ ## Errors
133
+
134
+ `AgentCommerceError` has `code`, `message` and `status`. The message starts with the code, for example
135
+ `LIMIT_EXCEEDED: Price 0.01 USDC exceeds the per-call limit of 0.005 USDC`, because frameworks often show a model only
136
+ the message. Client-generated messages omit keys, headers and backend bodies. They may include a gateway error code such
137
+ as `INPUT_INVALID`, an x402 reason such as `invalid_payload`, or a valid transaction hash for an unconfirmed settlement.
138
+
139
+ | Code | When |
140
+ | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
141
+ | `LIMIT_EXCEEDED` | The price is above the per-call limit or the remaining daily allowance |
142
+ | `NETWORK_NOT_ALLOWED` | The gateway offered no `exact` USDC payment on an allowed network |
143
+ | `PAYMENT_FAILED` | The gateway refused the signed payment, or could not confirm settlement; the message then says the payment may still complete on chain |
144
+ | `BACKEND_ERROR` | Any other non-2xx answer, redirects included; `status` holds the status |
145
+ | `GATEWAY_UNREACHABLE` | The gateway could not be reached (60 second request timeout) |
146
+
147
+ ## Not supported
148
+
149
+ MPP, Solana and NEAR rails, the MCP transport, resources that need an AP2 mandate or other authorization, wallet key
150
+ storage and proxy environment variables. Requests do not follow redirects.
151
+
152
+ ## x402 library defaults
153
+
154
+ The Python `x402` package defaults to a $1 payment cap and an allowlist of known tokens, checked before policies and
155
+ hooks. This client disables those controls with `set_spend_controls(False)` and applies its network, USDC and spending
156
+ checks instead. That allows a `max_per_call` above 1 USDC and the custom token used on local Anvil.
157
+
158
+ ## Tests
159
+
160
+ ```bash
161
+ uv run pytest agent-commerce-client # from the python/ directory of the repository
162
+ ```
163
+
164
+ The suite runs every scenario of the shared conformance suite in `conformance/` on both the sync and async paths.
165
+
166
+ ## License
167
+
168
+ Apache-2.0
@@ -0,0 +1,7 @@
1
+ agent_commerce_client/__init__.py,sha256=dDlXkgI_lBgl2q84i3bNbI03zSpD-2zbAf32J_aU-PA,349
2
+ agent_commerce_client/client.py,sha256=igp4RCYVUf-cF8nY35msuUcDP8qGytM_WBK-uJmvOYM,18435
3
+ agent_commerce_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
+ agent_commerce_client-0.1.0.dist-info/METADATA,sha256=VUWdFR24-WhaLU9tzFVK-xGuJVMZAd5TxHk3SP1OJyQ,9654
5
+ agent_commerce_client-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
6
+ agent_commerce_client-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
7
+ agent_commerce_client-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.33.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.