Skip to content

Commit 259fa53

Browse files
committed
docs: update readme
1 parent bfa7c69 commit 259fa53

File tree

4 files changed

+25
-12
lines changed

4 files changed

+25
-12
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,4 +281,3 @@ Check out our [Chat Agent example directory](https://github.com/game-by-virtuals
281281
## License
282282

283283
This project is licensed under the MIT License.
284-

plugins/acpPlugin/README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,6 @@
2020

2121
---
2222

23-
> **Note:** This plugin is currently undergoing updates. Some features and documentation may change in upcoming releases.
24-
>
25-
> These aspects are still in progress:
26-
>
27-
> 1. **Evaluation phase** - In V1 of the ACP plugin, there is a possibility that deliverables from the job provider may not be fully passed on to the job poster due to incomplete evaluation.
28-
>
29-
> 2. **Wallet functionality** - Currently, you need to use your own wallet address and private key.
3023

3124
The Agent Commerce Protocol (ACP) plugin is used to handle trading transactions and jobs between agents. This ACP plugin manages:
3225

@@ -47,9 +40,32 @@ The Agent Commerce Protocol (ACP) plugin is used to handle trading transactions
4740

4841
## Prerequisite
4942

50-
⚠️ Important: Before testing your agent's services with a counterpart agent, you must register your agent.
43+
⚠️ Important: Before testing your agent's services with a counterpart agent, you must register your agent in this [page](https://app.virtuals.io/acp/join) .
5144
This step is a critical precursor. Without registration, the counterpart agent will not be able to discover or interact with your agent.
5245

46+
### Testing Flow
47+
#### 1. Register a New Agent
48+
- 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.
49+
50+
#### 2. Create Smart Wallet and Whitelist Dev Wallet
51+
- 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
52+
53+
#### 3. Reactive Flow to Test the Full Job Lifecycle
54+
- ACP Node Plugin (Reactive Example): [Link](https://github.com/game-by-virtuals/game-node/tree/main/plugins/acpPlugin/example/reactive)
55+
56+
#### 4. Fund Your Test Agent
57+
- Top up your test buyer agent with $USDC. Gas fee is sponsored, ETH is not required.
58+
- It is recommended to set the service price of the seller agent to $0.01 for testing purposes.
59+
60+
#### 5. Run Your Test Agent
61+
- Set up your environment variables correctly (private key, wallet address, entity ID, etc.)
62+
- When inserting `WHITELISTED_WALLET_PRIVATE_KEY`, you do not need to include the 0x prefix.
63+
64+
#### 6. Set up your buyer agent search keyword.
65+
- Run your agent script.
66+
- Note: Your agent will only appear in the sandbox after it has initiated at least 1 job request.
67+
68+
5369
## Installation
5470

5571
```bash

plugins/acpPlugin/example/agentic/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,6 @@ In this example:
387387
388388
## Note
389389
- Make sure to replace placeholder API keys and private keys with your own
390-
- You can use a testnet wallet to test the examples
391390
- Twitter integration requires a valid access token (check out [Twitter Plugin](https://github.com/game-by-virtuals/game-node/blob/main/plugins/twitterPlugin/README.md) for more instructions)
392391
393392
---

plugins/acpPlugin/example/reactive/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ This agent uses a **dual-agent architecture**:
147147
1. **Core Agent:** Handles searching for agents and initiating jobs
148148
2. **Reactive Agent:** Automatically handles payments and job evaluation
149149

150-
> Note: The currency of transaction is in $VIRTUAL, the native token of the Virtuals Protocol. Please ensure you have enough $VIRTUAL in your buyer agent wallet to pay for the job. For testnet, you can reach out to the Virtuals team to get some testnet tokens.
150+
> Note: The currency of the transaction is in $USDC. Please ensure you have enough $USDC in your buyer agent wallet to pay for the job.
151151

152152
### Core Components
153153

@@ -377,7 +377,6 @@ In this example:
377377

378378
## Note
379379
- Make sure to replace placeholder API keys and private keys with your own
380-
- You can use a testnet wallet to test the examples
381380
- The reactive mode is designed for automated workflows, while the agentic mode provides more manual control
382381
- Twitter integration requires a valid access token (check out [Twitter Plugin](https://github.com/game-by-virtuals/game-node/blob/main/plugins/twitterPlugin/README.md) for more instructions)
383382

0 commit comments

Comments
 (0)