@virtuals-protocol/acp-node 0.2.0-beta.5 → 0.2.0-beta.7

package/README.md

@@ -50,15 +50,17 @@ The ACP Node SDK provides the following core functionalities:
 ### 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.
+- Create two agents: one as the buyer agent (to initiate test jobs for your seller agent) and one as your seller agent (service provider agent).
+- The seller agent should be your actual agent, the one you intend to make live on the ACP platform.
 
 #### 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. Use Self-Evaluation Flow to Test the Full Job Lifecycle
-- Node SDK (Self Evaluation Example): [Link](https://github.com/Virtual-Protocol/acp-node/tree/main/examples/acp-base/self-evaluation)
+- ACP Node SDK (Self Evaluation Example): [Link](https://github.com/Virtual-Protocol/acp-node/tree/main/examples/acp-base/self-evaluation)
 
 #### 4. Fund Your Test Agent
-- Top up your test buyer agent with $VIRTUAL. Gas fee is sponsored, ETH are not required.
+- 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
@@ -282,6 +284,6 @@ We welcome contributions from the community to help improve the ACP Node SDK. Th
    - It includes the links to the multi-agent demo dashboard and paper.
 
 
-4. [ACP FAQs](https://virtualsprotocol.notion.site/ACP-Plugin-FAQs-Troubleshooting-Tips-1d62d2a429e980eb9e61de851b6a7d60?pvs=4)
+4. [ACP FAQs](https://whitepaper.virtuals.io/info-hub/builders-hub/agent-commerce-protocol-acp-builder-guide/acp-faq-debugging-tips-and-best-practices)
    - Comprehensive FAQ section covering common plugin questions—everything from installation and configuration to key API usage patterns.
    - Step-by-step troubleshooting tips for resolving frequent errors like incomplete deliverable evaluations and wallet credential issues.

package/dist/index.d.mts

@@ -95,7 +95,8 @@ declare const ACP_ABI: ({
 type AcpContractConfig = {
     chain: typeof baseSepolia | typeof base;
     contractAddress: Address;
-    virtualsTokenAddress: Address;
+    paymentTokenAddress: Address;
+    paymentTokenDecimals: number;
     acpUrl: string;
     alchemyRpcUrl: string;
     priorityFeeMultiplier: number;
@@ -140,7 +141,7 @@ declare class AcpContractClient {
     private _sessionKeyClient;
     private chain;
     private contractAddress;
-    private virtualsTokenAddress;
+    private paymentTokenAddress;
     private customRpcClient;
     constructor(walletPrivateKey: Address, sessionEntityKeyId: number, agentWalletAddress: Address, config?: AcpContractConfig, customRpcUrl?: string | undefined);
     static build(walletPrivateKey: Address, sessionEntityKeyId: number, agentWalletAddress: Address, customRpcUrl?: string, config?: AcpContractConfig): Promise<AcpContractClient>;
@@ -415,11 +416,11 @@ declare class AcpContractClient {
             [x: `bool[${string}]`]: undefined;
             [x: `bytes4[${string}]`]: undefined;
             [x: `bytes[${string}]`]: undefined;
+            [x: `bytes6[${string}]`]: undefined;
             [x: `bytes2[${string}]`]: undefined;
             [x: `bytes1[${string}]`]: undefined;
             [x: `bytes3[${string}]`]: undefined;
             [x: `bytes5[${string}]`]: undefined;
-            [x: `bytes6[${string}]`]: undefined;
             [x: `bytes7[${string}]`]: undefined;
             [x: `bytes8[${string}]`]: undefined;
             [x: `bytes9[${string}]`]: undefined;
@@ -517,11 +518,11 @@ declare class AcpContractClient {
             bool?: undefined;
             bytes4?: undefined;
             bytes?: undefined;
+            bytes6?: undefined;
             bytes2?: undefined;
             bytes1?: undefined;
             bytes3?: undefined;
             bytes5?: undefined;
-            bytes6?: undefined;
             bytes7?: undefined;
             bytes8?: undefined;
             bytes9?: undefined;
@@ -7725,11 +7726,11 @@ declare class AcpContractClient {
                 [x: `bool[${string}]`]: undefined;
                 [x: `bytes4[${string}]`]: undefined;
                 [x: `bytes[${string}]`]: undefined;
+                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes2[${string}]`]: undefined;
                 [x: `bytes1[${string}]`]: undefined;
                 [x: `bytes3[${string}]`]: undefined;
                 [x: `bytes5[${string}]`]: undefined;
-                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes7[${string}]`]: undefined;
                 [x: `bytes8[${string}]`]: undefined;
                 [x: `bytes9[${string}]`]: undefined;
@@ -7827,11 +7828,11 @@ declare class AcpContractClient {
                 bool?: undefined;
                 bytes4?: undefined;
                 bytes?: undefined;
+                bytes6?: undefined;
                 bytes2?: undefined;
                 bytes1?: undefined;
                 bytes3?: undefined;
                 bytes5?: undefined;
-                bytes6?: undefined;
                 bytes7?: undefined;
                 bytes8?: undefined;
                 bytes9?: undefined;
@@ -8176,11 +8177,11 @@ declare class AcpContractClient {
                 [x: `bool[${string}]`]: undefined;
                 [x: `bytes4[${string}]`]: undefined;
                 [x: `bytes[${string}]`]: undefined;
+                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes2[${string}]`]: undefined;
                 [x: `bytes1[${string}]`]: undefined;
                 [x: `bytes3[${string}]`]: undefined;
                 [x: `bytes5[${string}]`]: undefined;
-                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes7[${string}]`]: undefined;
                 [x: `bytes8[${string}]`]: undefined;
                 [x: `bytes9[${string}]`]: undefined;
@@ -8278,11 +8279,11 @@ declare class AcpContractClient {
                 bool?: undefined;
                 bytes4?: undefined;
                 bytes?: undefined;
+                bytes6?: undefined;
                 bytes2?: undefined;
                 bytes1?: undefined;
                 bytes3?: undefined;
                 bytes5?: undefined;
-                bytes6?: undefined;
                 bytes7?: undefined;
                 bytes8?: undefined;
                 bytes9?: undefined;
@@ -8380,16 +8381,18 @@ declare class AcpContractClient {
     private calculateGasFees;
     private handleSendUserOperation;
     private getJobId;
+    private formatAmount;
     createJob(providerAddress: string, evaluatorAddress: string, expireAt: Date): Promise<{
         txHash: string;
         jobId: number;
     }>;
-    approveAllowance(priceInWei: bigint): Promise<`0x${string}`>;
-    createPayableMemo(jobId: number, content: string, amount: bigint, recipient: Address, feeAmount: bigint, feeType: FeeType, nextPhase: AcpJobPhases, type: MemoType.PAYABLE_REQUEST | MemoType.PAYABLE_TRANSFER_ESCROW, expiredAt: Date, token?: Address): Promise<`0x${string}`>;
+    approveAllowance(amount: number, paymentTokenAddress?: Address): Promise<`0x${string}`>;
+    createPayableMemo(jobId: number, content: string, amount: number, recipient: Address, feeAmount: number, feeType: FeeType, nextPhase: AcpJobPhases, type: MemoType.PAYABLE_REQUEST | MemoType.PAYABLE_TRANSFER_ESCROW, expiredAt: Date, token?: Address): Promise<`0x${string}`>;
     createMemo(jobId: number, content: string, type: MemoType, isSecured: boolean, nextPhase: AcpJobPhases): Promise<Address>;
     getMemoId(hash: Address): Promise<number>;
     signMemo(memoId: number, isApproved: boolean, reason?: string): Promise<`0x${string}`>;
-    setBudget(jobId: number, budget: bigint): Promise<`0x${string}`>;
+    setBudget(jobId: number, budget: number): Promise<`0x${string}`>;
+    setBudgetWithPaymentToken(jobId: number, budget: number, paymentTokenAddress?: Address): Promise<`0x${string}`>;
 }
 
 declare class AcpMemo {
@@ -8401,8 +8404,9 @@ declare class AcpMemo {
     status: AcpMemoStatus;
     signedReason?: string | undefined;
     expiry?: Date | undefined;
+    payableDetails?: PayableDetails | undefined;
     structuredContent: GenericPayload | undefined;
-    constructor(acpClient: AcpClient, id: number, type: MemoType, content: string, nextPhase: AcpJobPhases, status: AcpMemoStatus, signedReason?: string | undefined, expiry?: Date | undefined);
+    constructor(acpClient: AcpClient, id: number, type: MemoType, content: string, nextPhase: AcpJobPhases, status: AcpMemoStatus, signedReason?: string | undefined, expiry?: Date | undefined, payableDetails?: PayableDetails | undefined);
     get payloadType(): PayloadType | undefined;
     getStructuredContent<T>(): GenericPayload<T> | undefined;
     create(jobId: number, isSecured?: boolean): Promise<`0x${string}`>;
@@ -8418,6 +8422,12 @@ declare enum AcpMemoStatus {
     APPROVED = "APPROVED",
     REJECTED = "REJECTED"
 }
+interface PayableDetails {
+    amount: string;
+    token: Address$1;
+    recipient: Address$1;
+    feeAmount: string;
+}
 declare enum AcpAgentSort {
     SUCCESSFUL_JOB_COUNT = "successfulJobCount",
     SUCCESS_RATE = "successRate",
@@ -8456,6 +8466,7 @@ type AcpAgent = {
     offerings: {
         name: string;
         price: number;
+        priceUsd: number;
         requirementSchema?: Object;
         deliverableSchema?: Object;
     }[];
@@ -8531,11 +8542,13 @@ declare class AcpJob {
     providerAddress: Address$1;
     evaluatorAddress: Address$1;
     price: number;
+    priceTokenAddress: Address$1;
     memos: AcpMemo[];
     phase: AcpJobPhases;
     context: Record<string, any>;
-    constructor(acpClient: AcpClient, id: number, clientAddress: Address$1, providerAddress: Address$1, evaluatorAddress: Address$1, price: number, memos: AcpMemo[], phase: AcpJobPhases, context: Record<string, any>);
-    get serviceRequirement(): string | undefined;
+    constructor(acpClient: AcpClient, id: number, clientAddress: Address$1, providerAddress: Address$1, evaluatorAddress: Address$1, price: number, priceTokenAddress: Address$1, memos: AcpMemo[], phase: AcpJobPhases, context: Record<string, any>);
+    get serviceRequirement(): Record<string, any> | string | undefined;
+    get serviceName(): string | undefined;
     get deliverable(): string | undefined;
     get providerAgent(): Promise<AcpAgent | undefined>;
     get clientAgent(): Promise<AcpAgent | undefined>;

package/dist/index.d.ts

@@ -95,7 +95,8 @@ declare const ACP_ABI: ({
 type AcpContractConfig = {
     chain: typeof baseSepolia | typeof base;
     contractAddress: Address;
-    virtualsTokenAddress: Address;
+    paymentTokenAddress: Address;
+    paymentTokenDecimals: number;
     acpUrl: string;
     alchemyRpcUrl: string;
     priorityFeeMultiplier: number;
@@ -140,7 +141,7 @@ declare class AcpContractClient {
     private _sessionKeyClient;
     private chain;
     private contractAddress;
-    private virtualsTokenAddress;
+    private paymentTokenAddress;
     private customRpcClient;
     constructor(walletPrivateKey: Address, sessionEntityKeyId: number, agentWalletAddress: Address, config?: AcpContractConfig, customRpcUrl?: string | undefined);
     static build(walletPrivateKey: Address, sessionEntityKeyId: number, agentWalletAddress: Address, customRpcUrl?: string, config?: AcpContractConfig): Promise<AcpContractClient>;
@@ -415,11 +416,11 @@ declare class AcpContractClient {
             [x: `bool[${string}]`]: undefined;
             [x: `bytes4[${string}]`]: undefined;
             [x: `bytes[${string}]`]: undefined;
+            [x: `bytes6[${string}]`]: undefined;
             [x: `bytes2[${string}]`]: undefined;
             [x: `bytes1[${string}]`]: undefined;
             [x: `bytes3[${string}]`]: undefined;
             [x: `bytes5[${string}]`]: undefined;
-            [x: `bytes6[${string}]`]: undefined;
             [x: `bytes7[${string}]`]: undefined;
             [x: `bytes8[${string}]`]: undefined;
             [x: `bytes9[${string}]`]: undefined;
@@ -517,11 +518,11 @@ declare class AcpContractClient {
             bool?: undefined;
             bytes4?: undefined;
             bytes?: undefined;
+            bytes6?: undefined;
             bytes2?: undefined;
             bytes1?: undefined;
             bytes3?: undefined;
             bytes5?: undefined;
-            bytes6?: undefined;
             bytes7?: undefined;
             bytes8?: undefined;
             bytes9?: undefined;
@@ -7725,11 +7726,11 @@ declare class AcpContractClient {
                 [x: `bool[${string}]`]: undefined;
                 [x: `bytes4[${string}]`]: undefined;
                 [x: `bytes[${string}]`]: undefined;
+                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes2[${string}]`]: undefined;
                 [x: `bytes1[${string}]`]: undefined;
                 [x: `bytes3[${string}]`]: undefined;
                 [x: `bytes5[${string}]`]: undefined;
-                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes7[${string}]`]: undefined;
                 [x: `bytes8[${string}]`]: undefined;
                 [x: `bytes9[${string}]`]: undefined;
@@ -7827,11 +7828,11 @@ declare class AcpContractClient {
                 bool?: undefined;
                 bytes4?: undefined;
                 bytes?: undefined;
+                bytes6?: undefined;
                 bytes2?: undefined;
                 bytes1?: undefined;
                 bytes3?: undefined;
                 bytes5?: undefined;
-                bytes6?: undefined;
                 bytes7?: undefined;
                 bytes8?: undefined;
                 bytes9?: undefined;
@@ -8176,11 +8177,11 @@ declare class AcpContractClient {
                 [x: `bool[${string}]`]: undefined;
                 [x: `bytes4[${string}]`]: undefined;
                 [x: `bytes[${string}]`]: undefined;
+                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes2[${string}]`]: undefined;
                 [x: `bytes1[${string}]`]: undefined;
                 [x: `bytes3[${string}]`]: undefined;
                 [x: `bytes5[${string}]`]: undefined;
-                [x: `bytes6[${string}]`]: undefined;
                 [x: `bytes7[${string}]`]: undefined;
                 [x: `bytes8[${string}]`]: undefined;
                 [x: `bytes9[${string}]`]: undefined;
@@ -8278,11 +8279,11 @@ declare class AcpContractClient {
                 bool?: undefined;
                 bytes4?: undefined;
                 bytes?: undefined;
+                bytes6?: undefined;
                 bytes2?: undefined;
                 bytes1?: undefined;
                 bytes3?: undefined;
                 bytes5?: undefined;
-                bytes6?: undefined;
                 bytes7?: undefined;
                 bytes8?: undefined;
                 bytes9?: undefined;
@@ -8380,16 +8381,18 @@ declare class AcpContractClient {
     private calculateGasFees;
     private handleSendUserOperation;
     private getJobId;
+    private formatAmount;
     createJob(providerAddress: string, evaluatorAddress: string, expireAt: Date): Promise<{
         txHash: string;
         jobId: number;
     }>;
-    approveAllowance(priceInWei: bigint): Promise<`0x${string}`>;
-    createPayableMemo(jobId: number, content: string, amount: bigint, recipient: Address, feeAmount: bigint, feeType: FeeType, nextPhase: AcpJobPhases, type: MemoType.PAYABLE_REQUEST | MemoType.PAYABLE_TRANSFER_ESCROW, expiredAt: Date, token?: Address): Promise<`0x${string}`>;
+    approveAllowance(amount: number, paymentTokenAddress?: Address): Promise<`0x${string}`>;
+    createPayableMemo(jobId: number, content: string, amount: number, recipient: Address, feeAmount: number, feeType: FeeType, nextPhase: AcpJobPhases, type: MemoType.PAYABLE_REQUEST | MemoType.PAYABLE_TRANSFER_ESCROW, expiredAt: Date, token?: Address): Promise<`0x${string}`>;
     createMemo(jobId: number, content: string, type: MemoType, isSecured: boolean, nextPhase: AcpJobPhases): Promise<Address>;
     getMemoId(hash: Address): Promise<number>;
     signMemo(memoId: number, isApproved: boolean, reason?: string): Promise<`0x${string}`>;
-    setBudget(jobId: number, budget: bigint): Promise<`0x${string}`>;
+    setBudget(jobId: number, budget: number): Promise<`0x${string}`>;
+    setBudgetWithPaymentToken(jobId: number, budget: number, paymentTokenAddress?: Address): Promise<`0x${string}`>;
 }
 
 declare class AcpMemo {
@@ -8401,8 +8404,9 @@ declare class AcpMemo {
     status: AcpMemoStatus;
     signedReason?: string | undefined;
     expiry?: Date | undefined;
+    payableDetails?: PayableDetails | undefined;
     structuredContent: GenericPayload | undefined;
-    constructor(acpClient: AcpClient, id: number, type: MemoType, content: string, nextPhase: AcpJobPhases, status: AcpMemoStatus, signedReason?: string | undefined, expiry?: Date | undefined);
+    constructor(acpClient: AcpClient, id: number, type: MemoType, content: string, nextPhase: AcpJobPhases, status: AcpMemoStatus, signedReason?: string | undefined, expiry?: Date | undefined, payableDetails?: PayableDetails | undefined);
     get payloadType(): PayloadType | undefined;
     getStructuredContent<T>(): GenericPayload<T> | undefined;
     create(jobId: number, isSecured?: boolean): Promise<`0x${string}`>;
@@ -8418,6 +8422,12 @@ declare enum AcpMemoStatus {
     APPROVED = "APPROVED",
     REJECTED = "REJECTED"
 }
+interface PayableDetails {
+    amount: string;
+    token: Address$1;
+    recipient: Address$1;
+    feeAmount: string;
+}
 declare enum AcpAgentSort {
     SUCCESSFUL_JOB_COUNT = "successfulJobCount",
     SUCCESS_RATE = "successRate",
@@ -8456,6 +8466,7 @@ type AcpAgent = {
     offerings: {
         name: string;
         price: number;
+        priceUsd: number;
         requirementSchema?: Object;
         deliverableSchema?: Object;
     }[];
@@ -8531,11 +8542,13 @@ declare class AcpJob {
     providerAddress: Address$1;
     evaluatorAddress: Address$1;
     price: number;
+    priceTokenAddress: Address$1;
     memos: AcpMemo[];
     phase: AcpJobPhases;
     context: Record<string, any>;
-    constructor(acpClient: AcpClient, id: number, clientAddress: Address$1, providerAddress: Address$1, evaluatorAddress: Address$1, price: number, memos: AcpMemo[], phase: AcpJobPhases, context: Record<string, any>);
-    get serviceRequirement(): string | undefined;
+    constructor(acpClient: AcpClient, id: number, clientAddress: Address$1, providerAddress: Address$1, evaluatorAddress: Address$1, price: number, priceTokenAddress: Address$1, memos: AcpMemo[], phase: AcpJobPhases, context: Record<string, any>);
+    get serviceRequirement(): Record<string, any> | string | undefined;
+    get serviceName(): string | undefined;
     get deliverable(): string | undefined;
     get providerAgent(): Promise<AcpAgent | undefined>;
     get clientAgent(): Promise<AcpAgent | undefined>;