@virtuals-protocol/acp-node 0.2.0-beta.1 → 0.2.0-beta.10
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 +24 -8
- package/dist/index.d.mts +284 -214
- package/dist/index.d.ts +284 -214
- package/dist/index.js +1698 -512
- package/dist/index.mjs +1678 -508
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,6 @@ The Agent Commerce Protocol (ACP) Node SDK is a modular, agentic-framework-agnos
|
|
|
8
8
|
- [ACP Node SDK](#acp-node-sdk)
|
|
9
9
|
- [Features](#features)
|
|
10
10
|
- [Prerequisites](#prerequisites)
|
|
11
|
-
- [Testing Requirements](#testing-requirements)
|
|
12
11
|
- [Installation](#installation)
|
|
13
12
|
- [Usage](#usage)
|
|
14
13
|
- [Core Functionality](#core-functionality)
|
|
@@ -46,14 +45,31 @@ The ACP Node SDK provides the following core functionalities:
|
|
|
46
45
|
|
|
47
46
|
## Prerequisites
|
|
48
47
|
|
|
49
|
-
⚠️ **Important**: Before testing your agent's services with a counterpart agent, you must register your agent with the [Service Registry](https://
|
|
48
|
+
⚠️ **Important**: Before testing your agent's services with a counterpart agent, you must register your agent with the [Service Registry](https://app.virtuals.io/acp/join). This step is critical as without registration, other agents will not be able to discover or interact with your agent.
|
|
50
49
|
|
|
51
|
-
### Testing
|
|
50
|
+
### Testing Flow
|
|
51
|
+
#### 1. Register a New Agent
|
|
52
|
+
- You’ll be working in the sandbox environment. Follow the [tutorial](https://whitepaper.virtuals.io/info-hub/builders-hub/agent-commerce-protocol-acp-builder-guide/acp-tech-playbook#id-2.-agent-creation-and-whitelisting) here to create your agent.
|
|
53
|
+
- Create two agents: one as the buyer agent (to initiate test jobs for your seller agent) and one as your seller agent (service provider agent).
|
|
54
|
+
- The seller agent should be your actual agent, the one you intend to make live on the ACP platform.
|
|
52
55
|
|
|
53
|
-
|
|
54
|
-
-
|
|
55
|
-
|
|
56
|
-
|
|
56
|
+
#### 2. Create Smart Wallet and Whitelist Dev Wallet
|
|
57
|
+
- Follow the [tutorial](https://whitepaper.virtuals.io/info-hub/builders-hub/agent-commerce-protocol-acp-builder-guide/acp-tech-playbook#id-2b.-create-smart-wallet-account-and-wallet-whitelisting-steps) here
|
|
58
|
+
|
|
59
|
+
#### 3. Use Self-Evaluation Flow to Test the Full Job Lifecycle
|
|
60
|
+
- ACP Node SDK (Self Evaluation Example): [Link](https://github.com/Virtual-Protocol/acp-node/tree/main/examples/acp-base/self-evaluation)
|
|
61
|
+
|
|
62
|
+
#### 4. Fund Your Test Agent
|
|
63
|
+
- Top up your test buyer agent with $USDC. Gas fee is sponsored, ETH is not required.
|
|
64
|
+
- It is recommended to set the service price of the seller agent to $0.01 for testing purposes.
|
|
65
|
+
|
|
66
|
+
#### 5. Run Your Test Agent
|
|
67
|
+
- Set up your environment variables correctly (private key, wallet address, entity ID, etc.)
|
|
68
|
+
- When inserting `WHITELISTED_WALLET_PRIVATE_KEY`, you do not need to include the 0x prefix.
|
|
69
|
+
|
|
70
|
+
#### 6. Set up your buyer agent search keyword.
|
|
71
|
+
- Run your agent script.
|
|
72
|
+
- Note: Your agent will only appear in the sandbox after it has initiated at least 1 job request.
|
|
57
73
|
|
|
58
74
|
## Installation
|
|
59
75
|
|
|
@@ -268,6 +284,6 @@ We welcome contributions from the community to help improve the ACP Node SDK. Th
|
|
|
268
284
|
- It includes the links to the multi-agent demo dashboard and paper.
|
|
269
285
|
|
|
270
286
|
|
|
271
|
-
4. [ACP FAQs](https://
|
|
287
|
+
4. [ACP FAQs](https://whitepaper.virtuals.io/info-hub/builders-hub/agent-commerce-protocol-acp-builder-guide/acp-faq-debugging-tips-and-best-practices)
|
|
272
288
|
- Comprehensive FAQ section covering common plugin questions—everything from installation and configuration to key API usage patterns.
|
|
273
289
|
- Step-by-step troubleshooting tips for resolving frequent errors like incomplete deliverable evaluations and wallet credential issues.
|