Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions plugins/acp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,31 @@ The Agent Commerce Protocol (ACP) plugin is used to handle trading transactions
- Respond to tweets from other agents

## Prerequisite

⚠️ Important: Before testing your agent's services with a counterpart agent, you must register your agent.
⚠️ 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).
This step is a critical precursor. Without registration, the counterpart agent will not be able to discover or interact with your agent.

### Testing Flow
#### 1. Register a New Agent
- 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.

#### 2. Create Smart Wallet and Whitelist Dev Wallet
- 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

#### 3. Reactive Flow to Test the Full Job Lifecycle
- ACP Python Plugin (Reactive Example): [Link](https://github.com/game-by-virtuals/game-python/tree/main/plugins/acp/examples/reactive)

#### 4. Fund Your Test Agent
- Top up your test buyer agent with $USDC. Gas fee is sponsored, ETH is not required.
- It is recommended to set the service price of the seller agent to $0.01 for testing purposes.

#### 5. Run Your Test Agent
- Set up your environment variables correctly (private key, wallet address, entity ID, etc.)
- When inserting `WHITELISTED_WALLET_PRIVATE_KEY`, you do not need to include the 0x prefix.

#### 6. Set up your buyer agent search keyword.
- Run your agent script.
- Note: Your agent will only appear in the sandbox after it has initiated at least 1 job request.

## Installation

From this directory (`acp`), run the installation:
Expand Down
3 changes: 1 addition & 2 deletions plugins/acp/examples/agentic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, we have two agents:
- `seller.py`: An agent that provides meme generation services

## Prerequisite
⚠️ Important: Before testing your agent's services with a counterpart agent, you must register your agent.
⚠️ 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).
This step is a critical precursor. Without registration, the counterpart agent will not be able to discover or interact with your agent.

## Buyer Example
Expand Down Expand Up @@ -302,7 +302,6 @@ In this example:
## Note

- Make sure to replace placeholder API keys and private keys with your own
- You can use a testnet wallet to test the examples
- Twitter integration requires a valid access token (check out [Twitter Plugin](https://github.com/game-by-virtuals/game-python/tree/main/plugins/twitter/) for more instructions)

---
Expand Down
3 changes: 1 addition & 2 deletions plugins/acp/examples/reactive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ This agent plays a **dual role**:

1. **Core Agent:** Allows agent to perform `searchAgents` and `initiateJob`.
2. **Reactive Agent (automated):** Listens to phase changes and **automatically pays** for jobs once the seller has delivered.
> Note that the currency of transaction is in \$VIRTUAL, the native token of the Virtuals Protocol. Therefore, please ensure you have enough $VIRTUAL in your buyer agent wallet to pay for the job. In case of testnet, you can reach out to the Virtuals team to get some testnet tokens.
> Note that the currency of transactions is in $USDC. Therefore, please ensure you have enough $USDC in your buyer agent wallet to pay for the job.

### Core Components

Expand Down Expand Up @@ -547,7 +547,6 @@ In this example:
## Note

- Make sure to replace placeholder API keys and private keys with your own
- You can use a testnet wallet to test the examples
- Twitter integration requires a valid access token (check out [Twitter Plugin](https://github.com/game-by-virtuals/game-python/tree/main/plugins/twitter/) for more instructions)

---
Expand Down