feat: cross chain transfer service buyer example

Author: andrew-virtuals

examples/acp_base/cross_chain_transfer_service/buyer.py

@@ -0,0 +1,114 @@
+import logging
+import threading
+import os
+import sys
+
+# Add project root to Python path
+project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), "../../../"))
+sys.path.insert(0, project_root)
+
+from datetime import datetime, timedelta
+from typing import Optional
+
+from dotenv import load_dotenv
+
+from virtuals_acp.client import VirtualsACP
+from virtuals_acp.configs.configs import BASE_MAINNET_ACP_X402_CONFIG_V2, BASE_SEPOLIA_ACP_X402_CONFIG_V2
+from virtuals_acp.contract_clients.contract_client_v2 import ACPContractClientV2
+from virtuals_acp.env import EnvSettings
+from virtuals_acp.job import ACPJob
+from virtuals_acp.memo import ACPMemo
+from virtuals_acp.models import (
+    ACPAgentSort,
+    ACPJobPhase,
+    ACPGraduationStatus,
+    ACPOnlineStatus,
+    ChainConfig
+)
+
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
+)
+logger = logging.getLogger("BuyerAgent")
+
+load_dotenv(override=True)
+
+TARGET_CHAIN_ID = 97
+
+config = BASE_SEPOLIA_ACP_X402_CONFIG_V2
+config.chains = [
+    ChainConfig(
+        chain_id=TARGET_CHAIN_ID,
+        rpc_url="https://bsc-testnet-dataseed.bnbchain.org"
+    )
+]
+
+
+def buyer():
+    env = EnvSettings()
+
+    def on_new_task(job: ACPJob, memo_to_sign: Optional[ACPMemo] = None):
+        if (
+            job.phase == ACPJobPhase.NEGOTIATION
+            and memo_to_sign is not None
+            and memo_to_sign.next_phase == ACPJobPhase.TRANSACTION
+        ):
+            logger.info(f"Paying for job {job.id}")
+            job.pay_and_accept_requirement()
+            logger.info(f"Job {job.id} paid")
+
+        elif (
+            job.phase == ACPJobPhase.TRANSACTION
+            and memo_to_sign is not None
+            and memo_to_sign.next_phase == ACPJobPhase.REJECTED
+        ):
+            logger.info(f"Signing job {job.id} rejection memo, rejection reason: {memo_to_sign.content}")
+            memo_to_sign.sign(True, "Accepts job rejection")
+            logger.info(f"Job {job.id} rejection memo signed")
+
+        elif job.phase == ACPJobPhase.COMPLETED:
+            logger.info(f"Job {job.id} completed, received deliverable: {job.deliverable}")
+
+        elif job.phase == ACPJobPhase.REJECTED:
+            logger.info(f"Job {job.id} rejected by seller")
+
+    acp_client = VirtualsACP(
+        acp_contract_clients=ACPContractClientV2(
+            wallet_private_key=env.WHITELISTED_WALLET_PRIVATE_KEY,
+            agent_wallet_address=env.BUYER_AGENT_WALLET_ADDRESS,
+            entity_id=env.BUYER_ENTITY_ID,
+            config=config,  # route to x402 for payment, undefined defaulted back to direct transfer
+        ),
+        on_new_task=on_new_task
+    )
+
+    # Browse available agents based on a keyword
+    relevant_agents = acp_client.browse_agents(
+        keyword="cross chain transfer service",
+        sort_by=[ACPAgentSort.SUCCESSFUL_JOB_COUNT],
+        top_k=5,
+        graduation_status=ACPGraduationStatus.ALL,
+        online_status=ACPOnlineStatus.ALL,
+        show_hidden_offerings=True,
+    )
+    logger.info(f"Relevant agents: {relevant_agents}")
+
+    # Pick one of the agents based on your criteria (in this example we just pick the first one)
+    chosen_agent = relevant_agents[0]
+    # Pick one of the service offerings based on your criteria (in this example we just pick the first one)
+    chosen_job_offering = chosen_agent.job_offerings[1]
+
+    job_id = chosen_job_offering.initiate_job(
+        service_requirement={},
+        expired_at=datetime.now() + timedelta(minutes=5),  # job expiry duration, minimum 3 minutes
+    )
+    logger.info(f"Job {job_id} initiated")
+    logger.info("Listening for next steps...")
+
+    threading.Event().wait()
+
+
+if __name__ == "__main__":
+    buyer()

virtuals_acp/client.py

@@ -31,6 +31,7 @@
     ACPAgentSort,
     ACPJobPhase,
     ACPGraduationStatus,
+    ACPMemoState,
     ACPOnlineStatus,
     MemoType,
     IACPAgent,
@@ -160,6 +161,7 @@ def handle_new_task(self, data) -> None:
                 payable_details=memo.get("payableDetails"),
                 txn_hash=memo.get("txHash"),
                 signed_txn_hash=memo.get("signedTxHash"),
+                state=ACPMemoState(memo.get("state")),
             )
             for memo in data["memos"]
         ]
@@ -214,6 +216,7 @@ def handle_evaluate(self, data) -> None:
                 payable_details=memo.get("payableDetails"),
                 txn_hash=memo.get("txHash"),
                 signed_txn_hash=memo.get("signedTxHash"),
+                state=ACPMemoState(memo.get("state")),
             )
             for memo in data["memos"]
         ]
@@ -607,6 +610,7 @@ def _hydrate_jobs(
                         payable_details=memo.get("payableDetails"),
                         txn_hash=memo.get("txHash"),
                         signed_txn_hash=memo.get("signedTxHash"),
+                        state=ACPMemoState(memo.get("state")),
                     )
                     for memo in job.get("memos", [])
                 ]
@@ -692,6 +696,7 @@ def get_job_by_onchain_id(self, onchain_job_id: int) -> "ACPJob":
                         payable_details=memo.get("payableDetails"),
                         txn_hash=memo.get("txHash"),
                         signed_txn_hash=memo.get("signedTxHash"),
+                        state=ACPMemoState(memo.get("state")),
                     )
                 )
 
@@ -750,6 +755,7 @@ def get_memo_by_id(self, onchain_job_id: int, memo_id: int) -> "ACPMemo":
                 payable_details=memo.get("payableDetails"),
                 txn_hash=memo.get("txHash"),
                 signed_txn_hash=memo.get("signedTxHash"),
+                state=ACPMemoState(memo.get("state")),
             )
 
         except Exception as e:

virtuals_acp/job.py

@@ -8,13 +8,15 @@
 from virtuals_acp.exceptions import ACPError
 from virtuals_acp.memo import ACPMemo
 from virtuals_acp.models import (
+    ACPMemoState,
     PriceType,
     OperationPayload,
     X402PayableRequest,
     X402PayableRequirements,
     RequestPayload,
 )
 from virtuals_acp.utils import (
+    get_destination_chain_id,
     get_destination_endpoint_id,
     try_parse_json_model,
     prepare_payload,
@@ -28,7 +30,7 @@
     FeeType,
 )
 from virtuals_acp.fare import Fare, FareAmountBase, FareAmount
-from virtuals_acp.web3 import getERC20Allowance, getERC20Balance, getERC20Symbol
+from virtuals_acp.web3 import getERC20Allowance, getERC20Balance, getERC20Decimals, getERC20Symbol
 
 if TYPE_CHECKING:
     from virtuals_acp.client import VirtualsACP
@@ -254,6 +256,57 @@ def pay_and_accept_requirement(self, reason: Optional[str] = "") -> str | None:
         if not memo:
             raise Exception("No negotiation memo found")
 
+        if memo.type == MemoType.PAYABLE_REQUEST and memo.state != ACPMemoState.PENDING and memo.payable_details is not None and memo.payable_details['lzDstEid'] is not None:
+            print(f"Memo not ready to be signed, state: {memo.state}, payable_details: {memo.payable_details}")
+            return
+
+        if memo.payable_details:
+            if "lzDstEid" in memo.payable_details:
+                destination_chain_id = get_destination_chain_id(memo.payable_details["lzDstEid"])
+            else:
+                destination_chain_id = self.acp_contract_client.config.chain_id
+
+            if(destination_chain_id != self.acp_contract_client.config.chain_id):
+                token_balance = getERC20Balance(
+                    self.acp_contract_client.public_clients[destination_chain_id],
+                    memo.payable_details["token"],
+                    self.client_address,
+                )
+
+                if token_balance < memo.payable_details["amount"]:
+                    token_decimals = getERC20Decimals(
+                        self.acp_contract_client.public_clients[destination_chain_id],
+                        memo.payable_details["token"],
+                    )
+
+                    token_symbol = getERC20Symbol(
+                        self.acp_contract_client.public_clients[destination_chain_id],
+                        memo.payable_details["token"],
+                    )
+
+                    raise ACPError(f"You do not have enough funds to pay for the job which costs {memo.payable_details['amount'] / 10 ** token_decimals} {token_symbol} on chainId {destination_chain_id}")
+                else:
+                    asset_manager_address = self.acp_contract_client.get_asset_manager_address()
+
+                    allowance = getERC20Allowance(
+                        self.acp_contract_client.public_clients[destination_chain_id],
+                        memo.payable_details["token"],
+                        self.client_address,
+                        asset_manager_address,
+                    )
+
+                    destination_chain_operations: List[OperationPayload] = []
+
+                    destination_chain_operations.append(
+                        self.acp_contract_client.approve_allowance(
+                            memo.payable_details["amount"] + allowance,
+                            memo.payable_details["token"],
+                            asset_manager_address,
+                        )
+                    )
+
+                    self.acp_contract_client.handle_operation(destination_chain_operations, destination_chain_id)
+
         operations: List[OperationPayload] = []
         base_fare_amount = FareAmount(self.price, self.base_fare)
 

virtuals_acp/utils.py

@@ -75,4 +75,21 @@ def get_destination_endpoint_id(chain_id: int) -> int:
     }
     if chain_id in id_to_eid:
         return id_to_eid[chain_id]
-    raise ValueError(f"Unsupported chain ID: {chain_id}")
+    raise ValueError(f"Unsupported chain ID: {chain_id}")
+    
+def get_destination_chain_id(endpoint_id: int) -> int:
+    eid_to_id = {
+        40245: 84532,     # baseSepolia.id
+        40161: 11155111,  # sepolia.id
+        40267: 80002,     # polygonAmoy.id
+        40231: 421614,    # arbitrumSepolia.id
+        40102: 97,        # bscTestnet.id
+        30184: 8453,      # base.id
+        30101: 1,         # mainnet.id
+        30109: 137,       # polygon.id
+        30110: 42161,     # arbitrum.id
+        30102: 56,        # bsc.id
+    }
+    if endpoint_id in eid_to_id:
+        return eid_to_id[endpoint_id]
+    raise ValueError(f"Unsupported endpoint ID: {endpoint_id}")

virtuals_acp/web3.py

@@ -41,4 +41,16 @@ def getERC20Symbol(
 
     symbol = erc20_contract_instance.functions.symbol().call()
 
-    return symbol
+    return symbol
+
+def getERC20Decimals(
+    public_client: Web3,
+    contract_address: str,
+) -> int:
+    erc20_contract_instance = public_client.eth.contract(
+        address=contract_address, abi=ERC20_ABI
+    )
+    
+    decimals = erc20_contract_instance.functions.decimals().call()
+    
+    return decimals