Merge pull request #164 from Virtual-Protocol/feat/yang-add-required-funds-to-job-offering

feat: add required funds to job offering

Author: Ang-dot

examples/acp-base/skip-evaluation/buyer.ts

@@ -11,7 +11,7 @@ import AcpClient, {
 import {
   BUYER_AGENT_WALLET_ADDRESS,
   WHITELISTED_WALLET_PRIVATE_KEY,
-  BUYER_ENTITY_ID, SELLER_AGENT_WALLET_ADDRESS
+  BUYER_ENTITY_ID,
 } from "./env";
 
 async function buyer() {

src/acpClient.ts

@@ -8,7 +8,7 @@ import BaseAcpContractClient, {
 } from "./contractClients/baseAcpContractClient";
 import AcpJob from "./acpJob";
 import AcpMemo from "./acpMemo";
-import AcpJobOffering from "./acpJobOffering";
+import AcpJobOffering, { PriceType } from "./acpJobOffering";
 import {
   IAcpAgent,
   AcpAgentSort,
@@ -418,15 +418,30 @@ class AcpClient {
       id: agent.id,
       name: agent.name,
       description: agent.description,
-      jobOfferings: agent.jobs.map((jobs) => {
+      jobOfferings: agent.jobs
+      .filter((offering) =>
+        offering.priceV2?.value != null ||
+        offering.price != null
+      )      
+      .map((offering) => {
+        const price =
+          offering.priceV2?.value ??
+          offering.price!;
+    
+        const priceType =
+          offering.priceV2?.type ??
+          PriceType.FIXED;
+    
         return new AcpJobOffering(
           this,
           acpContractClient,
           agent.walletAddress,
-          jobs.name,
-          jobs.priceV2.value,
-          jobs.priceV2.type,
-          jobs.requirement,
+          offering.name,
+          price,
+          priceType,
+          offering.requiredFunds,
+          offering.requirement,
+          offering.deliverable
         );
       }),
       contractAddress: agent.contractAddress,

src/acpJobOffering.ts

@@ -29,8 +29,10 @@ class AcpJobOffering {
     public providerAddress: Address,
     public name: string,
     public price: number,
-    public priceType: PriceType = PriceType.FIXED,
-    public requirement?: Object | string
+    public priceType: PriceType,
+    public requiredFunds: boolean,
+    public requirement?: Object | string,
+    public deliverable?: Object | string
   ) {
     this.ajv = new Ajv({ allErrors: true });
   }

src/interfaces.ts

@@ -126,10 +126,12 @@ export interface IAcpAgent {
   twitterHandle: string;
   jobs: {
     name: string;
+    price: number;
     priceV2: {
       type: PriceType;
       value: number;
     };
+    requiredFunds: boolean;
     requirement?: Object | string;
     deliverable?: Object | string;
   }[];

test/unit/acpJobOffering.test.ts

@@ -65,27 +65,33 @@ describe("AcpJobOffering Unit Testing", () => {
         "MockJob",
         100,
         PriceType.FIXED,
+        true,
       );
 
       expect(offering).toBeInstanceOf(AcpJobOffering);
       expect(offering.providerAddress).toBe("0xProvider");
       expect(offering.name).toBe("MockJob");
       expect(offering.price).toBe(100);
       expect(offering.priceType).toBe(PriceType.FIXED);
+      expect(offering.requiredFunds).toBe(true);
       expect(offering.requirement).toBe(undefined);
+      expect(offering.deliverable).toBe(undefined);
     });
 
-    it("should use default priceType of FIXED", () => {
+    it("should use priceType FIXED and requiredFunds", () => {
       const offering = new AcpJobOffering(
         mockAcpClient,
         mockContractClient,
         "0xProvider" as Address,
         "MockJob",
         100,
+        PriceType.FIXED,
+        false,
       );
 
       expect(offering).toBeInstanceOf(AcpJobOffering);
       expect(offering.priceType).toBe(PriceType.FIXED);
+      expect(offering.requiredFunds).toBe(false);
     });
 
     it("should accept custom priceType", () => {
@@ -96,6 +102,7 @@ describe("AcpJobOffering Unit Testing", () => {
         "MockJob",
         100,
         PriceType.PERCENTAGE,
+        true,
       );
 
       expect(offering.priceType).toBe(PriceType.PERCENTAGE);
@@ -108,7 +115,8 @@ describe("AcpJobOffering Unit Testing", () => {
         "0xProvider" as Address,
         "MockJob",
         100,
-        undefined,
+        PriceType.FIXED,
+        true,
         "custom requirement",
       );
 
@@ -128,13 +136,50 @@ describe("AcpJobOffering Unit Testing", () => {
         "0xProvider" as Address,
         "MockJob",
         100,
-        undefined,
+        PriceType.FIXED,
+        true,
         requirementObject,
       );
 
       expect(offering).toBeInstanceOf(AcpJobOffering);
       expect(offering.requirement).toBe(requirementObject);
     });
+
+    it("should accept deliverable as string", () => {
+      const offering = new AcpJobOffering(
+        mockAcpClient,
+        mockContractClient,
+        "0xProvider" as Address,
+        "MockJob",
+        100,
+        PriceType.FIXED,
+        true,
+        undefined,
+        "custom deliverable",
+      );
+
+      expect(offering).toBeInstanceOf(AcpJobOffering);
+      expect(offering.deliverable).toBe("custom deliverable");
+    });
+
+    it("should accept deliverable as object", () => {
+      const deliverableObject = { type: "image", format: "png" };
+
+      const offering = new AcpJobOffering(
+        mockAcpClient,
+        mockContractClient,
+        "0xProvider" as Address,
+        "MockJob",
+        100,
+        PriceType.FIXED,
+        false,
+        undefined,
+        deliverableObject,
+      );
+
+      expect(offering).toBeInstanceOf(AcpJobOffering);
+      expect(offering.deliverable).toEqual(deliverableObject);
+    });
   });
 
   describe("initiateJob", () => {
@@ -161,7 +206,8 @@ describe("AcpJobOffering Unit Testing", () => {
         "0xProvider" as Address,
         "Generate Image",
         100,
-        undefined,
+        PriceType.FIXED,
+        true,
       );
 
       const result = await offering.initiateJob(
@@ -218,6 +264,7 @@ describe("AcpJobOffering Unit Testing", () => {
         "Generate Image",
         100,
         PriceType.FIXED,
+        true,
         requirementSchema,
       );
 
@@ -249,6 +296,7 @@ describe("AcpJobOffering Unit Testing", () => {
         "Generate Image",
         100,
         PriceType.FIXED,
+        true,
         requirementSchema,
       );
 
@@ -286,6 +334,7 @@ describe("AcpJobOffering Unit Testing", () => {
         "Generate Image",
         100,
         PriceType.PERCENTAGE,
+        true,
       );
 
       const result = await offering.initiateJob(
@@ -324,6 +373,8 @@ describe("AcpJobOffering Unit Testing", () => {
         "0xProvider" as Address,
         "Generate Image",
         100,
+        PriceType.FIXED,
+        true,
       );
 
       const result = await offering.initiateJob(
@@ -374,6 +425,8 @@ describe("AcpJobOffering Unit Testing", () => {
         "0xProvider" as Address,
         "Generate Image",
         100,
+        PriceType.FIXED,
+        true,
       );
 
       const result = await offering.initiateJob(