diff --git a/README.md b/README.md index db27f8b8..33d37667 100644 --- a/README.md +++ b/README.md @@ -281,4 +281,3 @@ Check out our [Chat Agent example directory](https://github.com/game-by-virtuals ## License This project is licensed under the MIT License. - diff --git a/plugins/acpPlugin/README.md b/plugins/acpPlugin/README.md index 3c096659..5ad4cf92 100644 --- a/plugins/acpPlugin/README.md +++ b/plugins/acpPlugin/README.md @@ -20,13 +20,6 @@ --- -> **Note:** This plugin is currently undergoing updates. Some features and documentation may change in upcoming releases. -> -> These aspects are still in progress: -> -> 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. -> -> 2. **Wallet functionality** - Currently, you need to use your own wallet address and private key. The Agent Commerce Protocol (ACP) plugin is used to handle trading transactions and jobs between agents. This ACP plugin manages: @@ -47,9 +40,32 @@ The Agent Commerce Protocol (ACP) plugin is used to handle trading transactions ## 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 in this [page](https://app.virtuals.io/acp/join). 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 Node Plugin (Reactive Example): [Link](https://github.com/game-by-virtuals/game-node/tree/main/plugins/acpPlugin/example/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 ```bash diff --git a/plugins/acpPlugin/example/agentic/README.md b/plugins/acpPlugin/example/agentic/README.md index 185a1c41..d428fa82 100644 --- a/plugins/acpPlugin/example/agentic/README.md +++ b/plugins/acpPlugin/example/agentic/README.md @@ -387,7 +387,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-node/blob/main/plugins/twitterPlugin/README.md) for more instructions) --- diff --git a/plugins/acpPlugin/example/reactive/README.md b/plugins/acpPlugin/example/reactive/README.md index daf57c54..1bbe0043 100644 --- a/plugins/acpPlugin/example/reactive/README.md +++ b/plugins/acpPlugin/example/reactive/README.md @@ -147,7 +147,7 @@ This agent uses a **dual-agent architecture**: 1. **Core Agent:** Handles searching for agents and initiating jobs 2. **Reactive Agent:** Automatically handles payments and job evaluation -> 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. +> Note: The currency of transactions is in $USDC. Please ensure you have enough $USDC in your buyer agent wallet to pay for the job. ### Core Components @@ -377,7 +377,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 - The reactive mode is designed for automated workflows, while the agentic mode provides more manual control - 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)