agent-commerce-client 0.1.0__tar.gz
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.
- agent_commerce_client-0.1.0/.gitignore +15 -0
- agent_commerce_client-0.1.0/LICENSE +202 -0
- agent_commerce_client-0.1.0/PKG-INFO +168 -0
- agent_commerce_client-0.1.0/README.md +153 -0
- agent_commerce_client-0.1.0/pyproject.toml +24 -0
- agent_commerce_client-0.1.0/src/agent_commerce_client/__init__.py +19 -0
- agent_commerce_client-0.1.0/src/agent_commerce_client/client.py +433 -0
- agent_commerce_client-0.1.0/src/agent_commerce_client/py.typed +0 -0
- agent_commerce_client-0.1.0/tests/helpers.py +73 -0
- agent_commerce_client-0.1.0/tests/test_client.py +723 -0
- agent_commerce_client-0.1.0/tests/test_conformance.py +147 -0
|
@@ -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.
|
|
@@ -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,153 @@
|
|
|
1
|
+
# agent-commerce-client
|
|
2
|
+
|
|
3
|
+
Python buyer client for a self-hosted [Agent Commerce Gateway](https://acg.devlab.group) (ACG). It discovers gateway
|
|
4
|
+
resources and pays for them with x402, within spending limits you set in code.
|
|
5
|
+
|
|
6
|
+
The framework packages build on this client and add no payment logic of their own:
|
|
7
|
+
[`langchain-agent-commerce`](../langchain-agent-commerce) and
|
|
8
|
+
[`agent-framework-agent-commerce`](../agent-framework-agent-commerce) (Microsoft Agent Framework). The full behavior
|
|
9
|
+
contract, shared with the TypeScript client, is in
|
|
10
|
+
[docs/buyer-core.md](https://github.com/devlab-group/agent-commerce-clients/blob/main/docs/buyer-core.md).
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pip install agent-commerce-client
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Python 3.10 or newer. Payments use the official [`x402`](https://pypi.org/project/x402/) package (`exact` scheme on EVM
|
|
19
|
+
networks).
|
|
20
|
+
|
|
21
|
+
## Quick start
|
|
22
|
+
|
|
23
|
+
```python
|
|
24
|
+
import os
|
|
25
|
+
|
|
26
|
+
from agent_commerce_client import AgentCommerceClient, AgentCommerceError
|
|
27
|
+
from eth_account import Account
|
|
28
|
+
|
|
29
|
+
client = AgentCommerceClient(
|
|
30
|
+
gateway_url="https://merchant.example.com",
|
|
31
|
+
signer=Account.from_key(os.environ["BUYER_PRIVATE_KEY"]),
|
|
32
|
+
networks=["eip155:84532"], # Base Sepolia
|
|
33
|
+
max_per_call="0.05", # USDC
|
|
34
|
+
max_per_day="1.00", # USDC per UTC day
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
for tool in client.list_tools():
|
|
38
|
+
print(tool.name, "-", tool.description)
|
|
39
|
+
|
|
40
|
+
try:
|
|
41
|
+
result = client.invoke("report", {"topic": "x"})
|
|
42
|
+
print(result.status, result.body, result.payment) # payment: network, transaction hash, payer
|
|
43
|
+
except AgentCommerceError as error:
|
|
44
|
+
print(error.code, error.message, error.status)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Use `await client.alist_tools()` and `await client.ainvoke(...)` for async calls. The sync methods call the same
|
|
48
|
+
implementation and can also run while an event loop is active.
|
|
49
|
+
|
|
50
|
+
## Configuration
|
|
51
|
+
|
|
52
|
+
| Argument | Required | Meaning |
|
|
53
|
+
| --------------- | -------- | -------------------------------------------------------------------------------- |
|
|
54
|
+
| `gateway_url` | Yes | Gateway base URL, `http` or `https` |
|
|
55
|
+
| `signer` | Yes | Wallet object, for example an `eth_account` account. A raw key string is refused |
|
|
56
|
+
| `networks` | Yes | Allowed networks from the table below, for example `["eip155:84532"]` |
|
|
57
|
+
| `max_per_call` | Yes | Limit per invocation in USDC, a decimal string with up to 6 decimals |
|
|
58
|
+
| `max_per_day` | Yes | Limit per UTC day in USDC |
|
|
59
|
+
| `resources` | No | Allowlist of resource ids; every eligible resource when omitted |
|
|
60
|
+
| `allow_mainnet` | No | Must be `True` before any mainnet network is accepted |
|
|
61
|
+
| `approval` | No | `"paid"` (default), `"always"` or `"never"`: which tools carry `needs_approval` |
|
|
62
|
+
| `spend_store` | No | Daily spending counter; process memory by default |
|
|
63
|
+
| `transport` | No | HTTP transport override for tests; closed after each call |
|
|
64
|
+
|
|
65
|
+
Invalid configuration raises `ValueError` or `TypeError` during client construction. `resources=[]` excludes every
|
|
66
|
+
resource; leave it as `None` to include all eligible resources.
|
|
67
|
+
|
|
68
|
+
`networks` accepts the EVM networks below. Payments use each network's USDC, with any asset allowed on local Anvil:
|
|
69
|
+
|
|
70
|
+
| Network | Id | Kind | USDC |
|
|
71
|
+
| ----------------- | --------------- | ------- | -------------------------------------------- |
|
|
72
|
+
| Local Anvil | `eip155:31337` | testnet | any asset (local development chain) |
|
|
73
|
+
| Base Sepolia | `eip155:84532` | testnet | `0x036CbD53842c5426634e7929541eC2318f3dCF7e` |
|
|
74
|
+
| Arbitrum Sepolia | `eip155:421614` | testnet | `0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d` |
|
|
75
|
+
| Base | `eip155:8453` | mainnet | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
|
|
76
|
+
| Ethereum | `eip155:1` | mainnet | `0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48` |
|
|
77
|
+
| Polygon | `eip155:137` | mainnet | `0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359` |
|
|
78
|
+
| Arbitrum One | `eip155:42161` | mainnet | `0xaf88d065e77c8cC2239327C5EDb3A432268e5831` |
|
|
79
|
+
| Avalanche C-Chain | `eip155:43114` | mainnet | `0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E` |
|
|
80
|
+
|
|
81
|
+
Mainnet networks require `allow_mainnet=True`. Unknown network ids raise `ValueError` even with that setting.
|
|
82
|
+
|
|
83
|
+
## Spending limits
|
|
84
|
+
|
|
85
|
+
The client enforces limits before signing a payment. When the gateway answers `402`, an offer is acceptable only with
|
|
86
|
+
the `exact` scheme, a network in `networks`, that network's USDC and an EIP-3009 transfer (`extra.assetTransferMethod`
|
|
87
|
+
absent or `eip3009`; `permit2` needs an on-chain approval first, and ACG answers 412 without it). Unacceptable offers
|
|
88
|
+
are removed before the x402 client selects one, so an earlier non-USDC offer cannot displace an acceptable USDC offer.
|
|
89
|
+
If none remains, the call fails with `NETWORK_NOT_ALLOWED`. The x402 before-payment hook then checks the selected offer
|
|
90
|
+
again, and the amount (USDC base units, 6 decimals) must not exceed `max_per_call`; it is reserved in the spend store
|
|
91
|
+
against `max_per_day`. A refusal raises `AgentCommerceError` before a signature exists. The model calling a tool cannot
|
|
92
|
+
change any limit.
|
|
93
|
+
|
|
94
|
+
Each invocation sends at most one request with `PAYMENT-SIGNATURE` and does not retry it. After signing, the reserved
|
|
95
|
+
amount remains in the daily total even if the gateway rejects the payment, because the client cannot always tell whether
|
|
96
|
+
funds moved.
|
|
97
|
+
|
|
98
|
+
To share the daily counter between processes, pass a `spend_store` with an atomic `add` method:
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
class SpendStore:
|
|
102
|
+
def add(self, day: str, amount: int) -> int:
|
|
103
|
+
"""Add `amount` micro-USDC (negative to roll back) to `day` (UTC, YYYY-MM-DD); return the new total."""
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Resources and tools
|
|
107
|
+
|
|
108
|
+
`list_tools()` keeps a resource when it is exposed over `http`, is free or accepts x402, and is in the `resources`
|
|
109
|
+
allowlist (if given). Each resource excluded by these filters produces one warning on the `agent_commerce_client`
|
|
110
|
+
logger. A tool is a `ResourceTool` with `name` (the resource id), `description` (ends with `Costs 0.01 USDC per call.`,
|
|
111
|
+
`Free.` or `Paid.`), `input_schema`, `paid` and `needs_approval`. Framework wrappers use `needs_approval` to configure
|
|
112
|
+
human approval.
|
|
113
|
+
|
|
114
|
+
Tool names and descriptions come from the gateway and reach the model. Use `resources=[...]` to expose only resources
|
|
115
|
+
you trust.
|
|
116
|
+
|
|
117
|
+
## Errors
|
|
118
|
+
|
|
119
|
+
`AgentCommerceError` has `code`, `message` and `status`. The message starts with the code, for example
|
|
120
|
+
`LIMIT_EXCEEDED: Price 0.01 USDC exceeds the per-call limit of 0.005 USDC`, because frameworks often show a model only
|
|
121
|
+
the message. Client-generated messages omit keys, headers and backend bodies. They may include a gateway error code such
|
|
122
|
+
as `INPUT_INVALID`, an x402 reason such as `invalid_payload`, or a valid transaction hash for an unconfirmed settlement.
|
|
123
|
+
|
|
124
|
+
| Code | When |
|
|
125
|
+
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
126
|
+
| `LIMIT_EXCEEDED` | The price is above the per-call limit or the remaining daily allowance |
|
|
127
|
+
| `NETWORK_NOT_ALLOWED` | The gateway offered no `exact` USDC payment on an allowed network |
|
|
128
|
+
| `PAYMENT_FAILED` | The gateway refused the signed payment, or could not confirm settlement; the message then says the payment may still complete on chain |
|
|
129
|
+
| `BACKEND_ERROR` | Any other non-2xx answer, redirects included; `status` holds the status |
|
|
130
|
+
| `GATEWAY_UNREACHABLE` | The gateway could not be reached (60 second request timeout) |
|
|
131
|
+
|
|
132
|
+
## Not supported
|
|
133
|
+
|
|
134
|
+
MPP, Solana and NEAR rails, the MCP transport, resources that need an AP2 mandate or other authorization, wallet key
|
|
135
|
+
storage and proxy environment variables. Requests do not follow redirects.
|
|
136
|
+
|
|
137
|
+
## x402 library defaults
|
|
138
|
+
|
|
139
|
+
The Python `x402` package defaults to a $1 payment cap and an allowlist of known tokens, checked before policies and
|
|
140
|
+
hooks. This client disables those controls with `set_spend_controls(False)` and applies its network, USDC and spending
|
|
141
|
+
checks instead. That allows a `max_per_call` above 1 USDC and the custom token used on local Anvil.
|
|
142
|
+
|
|
143
|
+
## Tests
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
uv run pytest agent-commerce-client # from the python/ directory of the repository
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
The suite runs every scenario of the shared conformance suite in `conformance/` on both the sync and async paths.
|
|
150
|
+
|
|
151
|
+
## License
|
|
152
|
+
|
|
153
|
+
Apache-2.0
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "agent-commerce-client"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Python buyer client for a self-hosted Agent Commerce Gateway: discovers resources and pays for them with x402 within set spending limits."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
|
+
keywords = ["x402", "agents", "payments", "api"]
|
|
13
|
+
dependencies = [
|
|
14
|
+
"httpx>=0.28.1",
|
|
15
|
+
"x402[evm,httpx]>=2.28.0,<3",
|
|
16
|
+
]
|
|
17
|
+
|
|
18
|
+
[project.urls]
|
|
19
|
+
Homepage = "https://acg.devlab.group"
|
|
20
|
+
Repository = "https://github.com/devlab-group/agent-commerce-clients"
|
|
21
|
+
Issues = "https://github.com/devlab-group/agent-commerce-clients/issues"
|
|
22
|
+
|
|
23
|
+
[tool.hatch.build.targets.wheel]
|
|
24
|
+
packages = ["src/agent_commerce_client"]
|
|
@@ -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
|
+
]
|