feat: merged with main as of 21 may 2025

Author: JoeLim13

README.md

@@ -121,10 +121,10 @@ const completedJobs = await acpClient.getCompletedJobs(page, pageSize);
 const cancelledJobs = await acpClient.getCancelledJobs(page, pageSize);
 
 // Get specific job
-const job = await acpClient.getJobByOnChainJobId(onChainJobId);
+const job = await acpClient.getJobById(jobId);
 
 // Get memo by ID
-const memo = await acpClient.getMemoById(onChainJobId, memoId);
+const memo = await acpClient.getMemoById(jobId, memoId);
 ```
 
 ### Agent Discovery

examples/acp_base/external_evaluation/buyer.ts

@@ -34,6 +34,9 @@ async function buyer() {
         },
     });
 
+    const relevantAgents = await acpClient.browseAgent("Meme generator");
+    console.log("Relevant seller agents: ", relevantAgents);
+
     const jobId = await acpClient.initiateJob(
         SELLER_WALLET_ADDRESS,
         "Meme generator",

examples/acp_base/self_evaluation/buyer.ts

@@ -38,6 +38,9 @@ async function buyer() {
         },
     });
 
+    const relevantAgents = await acpClient.browseAgent("Meme generator");
+    console.log("Relevant seller agents: ", relevantAgents);
+
     const jobId = await acpClient.initiateJob(
         SELLER_WALLET_ADDRESS,
         "Meme generator",

interfaces.ts

@@ -1,4 +1,3 @@
-import { JSONSchemaType } from "ajv";
 import { Address } from "viem";
 
 export type AcpAgent = {
@@ -18,6 +17,7 @@ export type AcpAgent = {
     name: string;
     price: number;
     requirementSchema?: Object;
+    deliverableSchema?: Object;
   }[];
   symbol: string | null;
   virtualAgentId: string | null;

src/acpClient.ts

@@ -10,62 +10,18 @@ import AcpJob from "./acpJob";
 import AcpMemo from "./acpMemo";
 import AcpJobOffering from "./acpJobOffering";
 import AcpMessage from "./acpMessage";
+import {
+  IAcpClientOptions,
+  IAcpJob,
+  IAcpJobResponse,
+  IAcpMemo,
+} from "./interfaces";
 
 export interface IDeliverable {
   type: string;
   value: string;
 }
 
-interface IAcpMemoData {
-  onChainJobId?: number;
-  type: string;
-  content: string;
-  createdAt: string;
-  memoId: number;
-  memoType: MemoType;
-  nextPhase: AcpJobPhases;
-}
-interface IAcpMemo {
-  data: IAcpMemoData;
-  error?: Error;
-}
-
-interface IAcpJob {
-  data: {
-    onChainJobId: number;
-    phase: AcpJobPhases;
-    negoStatus: AcpNegoStatus;
-    description: string;
-    buyerAddress: `0x${string}`;
-    sellerAddress: `0x${string}`;
-    evaluatorAddress: `0x${string}`;
-    price: number;
-    deliverable: IDeliverable | null;
-    memos: IAcpMemoData[];
-    createdAt: string;
-  };
-  error?: Error;
-}
-interface IAcpJobResponse {
-  data: IAcpJob["data"][];
-  meta?: {
-    pagination: {
-      page: number;
-      pageSize: number;
-      pageCount: number;
-      total: number;
-    };
-  };
-  error?: Error;
-}
-
-interface IAcpClientOptions {
-  acpContractClient: AcpContractClient;
-  onNewTask?: (job: AcpJob) => void;
-  onEvaluate?: (job: AcpJob) => void;
-  onNewMsg?: (msg: AcpMessage, job: AcpJob) => void;
-}
-
 export enum SocketEvents {
   ROOM_JOINED = "roomJoined",
   ON_EVALUATE = "onEvaluate",
@@ -128,12 +84,14 @@ class AcpClient {
         if (this.onEvaluate) {
           const job = new AcpJob(
             this,
-            data.onChainJobId,
-            data.sellerAddress,
+            data.id,
+            data.clientAddress,
+            data.providerAddress,
+            data.evaluatorAddress,
             data.memos.map((memo) => {
               return new AcpMemo(
                 this,
-                memo.memoId,
+                memo.id,
                 memo.memoType,
                 memo.content,
                 memo.nextPhase
@@ -158,12 +116,14 @@ class AcpClient {
         if (this.onNewTask) {
           const job = new AcpJob(
             this,
-            data.onChainJobId,
-            data.sellerAddress,
+            data.id,
+            data.clientAddress,
+            data.providerAddress,
+            data.evaluatorAddress,
             data.memos.map((memo) => {
               return new AcpMemo(
                 this,
-                memo.memoId,
+                memo.id,
                 memo.memoType,
                 memo.content,
                 memo.nextPhase
@@ -327,7 +287,27 @@ class AcpClient {
       if (data.error) {
         throw new Error(data.error.message);
       }
-      return data;
+
+      return data.data.map((job) => {
+        return new AcpJob(
+          this,
+          job.id,
+          job.clientAddress,
+          job.providerAddress,
+          job.evaluatorAddress,
+          job.memos.map((memo) => {
+            return new AcpMemo(
+              this,
+              memo.id,
+              memo.memoType,
+              memo.content,
+              memo.nextPhase
+            );
+          }),
+          job.phase,
+          job.negoStatus
+        );
+      });
     } catch (error) {
       throw error;
     }
@@ -348,7 +328,27 @@ class AcpClient {
       if (data.error) {
         throw new Error(data.error.message);
       }
-      return data;
+
+      return data.data.map((job) => {
+        return new AcpJob(
+          this,
+          job.id,
+          job.clientAddress,
+          job.providerAddress,
+          job.evaluatorAddress,
+          job.memos.map((memo) => {
+            return new AcpMemo(
+              this,
+              memo.id,
+              memo.memoType,
+              memo.content,
+              memo.nextPhase
+            );
+          }),
+          job.phase,
+          job.negoStatus
+        );
+      });
     } catch (error) {
       throw error;
     }
@@ -369,14 +369,33 @@ class AcpClient {
       if (data.error) {
         throw new Error(data.error.message);
       }
-      return data;
+      return data.data.map((job) => {
+        return new AcpJob(
+          this,
+          job.id,
+          job.clientAddress,
+          job.providerAddress,
+          job.evaluatorAddress,
+          job.memos.map((memo) => {
+            return new AcpMemo(
+              this,
+              memo.id,
+              memo.memoType,
+              memo.content,
+              memo.nextPhase
+            );
+          }),
+          job.phase,
+          job.negoStatus
+        );
+      });
     } catch (error) {
       throw error;
     }
   }
 
-  async getJobByOnChainJobId(onChainJobId: number) {
-    let url = `${this.acpUrl}/api/jobs/${onChainJobId}`;
+  async getJobById(jobId: number) {
+    let url = `${this.acpUrl}/api/jobs/${jobId}`;
 
     try {
       const response = await fetch(url, {
@@ -390,14 +409,37 @@ class AcpClient {
       if (data.error) {
         throw new Error(data.error.message);
       }
-      return data;
+
+      const job = data.data;
+      if (!job) {
+        return;
+      }
+
+      return new AcpJob(
+        this,
+        job.id,
+        job.clientAddress,
+        job.providerAddress,
+        job.evaluatorAddress,
+        job.memos.map((memo) => {
+          return new AcpMemo(
+            this,
+            memo.id,
+            memo.memoType,
+            memo.content,
+            memo.nextPhase
+          );
+        }),
+        job.phase,
+        job.negoStatus
+      );
     } catch (error) {
       throw error;
     }
   }
 
-  async getMemoById(onChainJobId: number, memoId: number) {
-    let url = `${this.acpUrl}/api/jobs/${onChainJobId}/memos/${memoId}`;
+  async getMemoById(jobId: number, memoId: number) {
+    let url = `${this.acpUrl}/api/jobs/${jobId}/memos/${memoId}`;
 
     try {
       const response = await fetch(url, {
@@ -411,11 +453,40 @@ class AcpClient {
       if (data.error) {
         throw new Error(data.error.message);
       }
-      return data;
+
+      const memo = data.data;
+      if (!memo) {
+        return;
+      }
+
+      return new AcpMemo(
+        this,
+        memo.id,
+        memo.memoType,
+        memo.content,
+        memo.nextPhase
+      );
     } catch (error) {
       throw error;
     }
   }
+
+  async getAgent(walletAddress: Address) {
+    const url = `${this.acpUrl}/api/agents?filters[walletAddress]=${walletAddress}`;
+
+    const response = await fetch(url);
+    const data: {
+      data: AcpAgent[];
+    } = await response.json();
+
+    const agents = data.data || [];
+
+    if (agents.length === 0) {
+      return;
+    }
+
+    return agents[0];
+  }
 }
 
 export default AcpClient;

src/acpJob.ts

@@ -1,3 +1,4 @@
+import { Address } from "viem";
 import AcpClient from "./acpClient";
 import { AcpJobPhases, AcpNegoStatus } from "./acpContractClient";
 import AcpMemo from "./acpMemo";
@@ -6,12 +7,36 @@ class AcpJob {
   constructor(
     private acpClient: AcpClient,
     public id: number,
-    public providerAddress: string,
+    public clientAddress: Address,
+    public providerAddress: Address,
+    public evaluatorAddress: Address,
     public memos: AcpMemo[],
     public phase: AcpJobPhases,
-    public negoStatus: AcpNegoStatus
+    public negoStatus?: AcpNegoStatus
   ) {}
 
+  public get serviceRequirement() {
+    return this.memos.find((m) => m.nextPhase === AcpJobPhases.NEGOTIATION)
+      ?.content;
+  }
+
+  public get deliverable() {
+    return this.memos.find((m) => m.nextPhase === AcpJobPhases.COMPLETED)
+      ?.content;
+  }
+
+  public get providerAgent() {
+    return this.acpClient.getAgent(this.providerAddress);
+  }
+
+  public get clientAgent() {
+    return this.acpClient.getAgent(this.clientAddress);
+  }
+
+  public get evaluatorAgent() {
+    return this.acpClient.getAgent(this.evaluatorAddress);
+  }
+
   async pay(amount: number, reason?: string) {
     const memo = this.memos.find(
       (m) => m.nextPhase === AcpJobPhases.TRANSACTION

src/acpJobOffering.ts

@@ -17,6 +17,7 @@ class AcpJobOffering {
 
   async initiateJob(
     serviceRequirement: Object | string,
+    evaluatorAddress?: Address,
     expiredAt: Date = new Date(Date.now() + 1000 * 60 * 60 * 24) // default: 1 day
   ) {
     if (this.requirementSchema) {
@@ -31,7 +32,8 @@ class AcpJobOffering {
     return await this.acpClient.initiateJob(
       this.providerAddress,
       serviceRequirement,
-      expiredAt
+      expiredAt,
+      evaluatorAddress
     );
   }
 }