@virtuals-protocol/acp-node 0.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/README.md +207 -0
  2. package/buyer.ts +47 -0
  3. package/docs/imgs/acp-banner.jpeg +0 -0
  4. package/examples/acp_base/README.md +94 -0
  5. package/examples/acp_base/docs/imgs/agent-wallet-page.png +0 -0
  6. package/examples/acp_base/docs/imgs/session-entity-id-location.png +0 -0
  7. package/examples/acp_base/docs/imgs/whitelist-wallet-info.png +0 -0
  8. package/examples/acp_base/docs/imgs/whitelist-wallet.png +0 -0
  9. package/examples/acp_base/external_evaluation/.env.example +5 -0
  10. package/examples/acp_base/external_evaluation/buyer.ts +52 -0
  11. package/examples/acp_base/external_evaluation/env.ts +22 -0
  12. package/examples/acp_base/external_evaluation/evaluator.ts +29 -0
  13. package/examples/acp_base/external_evaluation/seller.ts +46 -0
  14. package/examples/acp_base/self_evaluation/.env.example +4 -0
  15. package/examples/acp_base/self_evaluation/buyer.ts +54 -0
  16. package/examples/acp_base/self_evaluation/env.ts +21 -0
  17. package/examples/acp_base/self_evaluation/seller.ts +46 -0
  18. package/helpers/.env.example +3 -0
  19. package/helpers/acpHelperFunctions.ts +69 -0
  20. package/interfaces.ts +24 -0
  21. package/package.json +26 -0
  22. package/seller.ts +46 -0
  23. package/src/acpAbi.ts +680 -0
  24. package/src/acpClient.ts +458 -0
  25. package/src/acpContractClient.ts +269 -0
  26. package/src/acpJob.ts +91 -0
  27. package/src/acpJobOffering.ts +43 -0
  28. package/src/acpMemo.ts +32 -0
  29. package/src/configs.ts +28 -0
  30. package/src/index.ts +18 -0
  31. package/src/interfaces.ts +55 -0
  32. package/test.ts +26 -0
  33. package/tsconfig.json +113 -0
package/src/acpAbi.ts ADDED
@@ -0,0 +1,680 @@
1
+ const ACP_ABI = [
2
+ { inputs: [], stateMutability: "nonpayable", type: "constructor" },
3
+ { inputs: [], name: "AccessControlBadConfirmation", type: "error" },
4
+ {
5
+ inputs: [
6
+ { internalType: "address", name: "account", type: "address" },
7
+ { internalType: "bytes32", name: "neededRole", type: "bytes32" },
8
+ ],
9
+ name: "AccessControlUnauthorizedAccount",
10
+ type: "error",
11
+ },
12
+ {
13
+ inputs: [{ internalType: "address", name: "target", type: "address" }],
14
+ name: "AddressEmptyCode",
15
+ type: "error",
16
+ },
17
+ {
18
+ inputs: [{ internalType: "address", name: "account", type: "address" }],
19
+ name: "AddressInsufficientBalance",
20
+ type: "error",
21
+ },
22
+ { inputs: [], name: "FailedInnerCall", type: "error" },
23
+ { inputs: [], name: "InvalidInitialization", type: "error" },
24
+ { inputs: [], name: "NotInitializing", type: "error" },
25
+ { inputs: [], name: "ReentrancyGuardReentrantCall", type: "error" },
26
+ {
27
+ inputs: [{ internalType: "address", name: "token", type: "address" }],
28
+ name: "SafeERC20FailedOperation",
29
+ type: "error",
30
+ },
31
+ {
32
+ anonymous: false,
33
+ inputs: [
34
+ {
35
+ indexed: true,
36
+ internalType: "uint256",
37
+ name: "jobId",
38
+ type: "uint256",
39
+ },
40
+ {
41
+ indexed: false,
42
+ internalType: "uint256",
43
+ name: "newBudget",
44
+ type: "uint256",
45
+ },
46
+ ],
47
+ name: "BudgetSet",
48
+ type: "event",
49
+ },
50
+ {
51
+ anonymous: false,
52
+ inputs: [
53
+ {
54
+ indexed: false,
55
+ internalType: "uint256",
56
+ name: "jobId",
57
+ type: "uint256",
58
+ },
59
+ {
60
+ indexed: true,
61
+ internalType: "address",
62
+ name: "evaluator",
63
+ type: "address",
64
+ },
65
+ {
66
+ indexed: false,
67
+ internalType: "uint256",
68
+ name: "evaluatorFee",
69
+ type: "uint256",
70
+ },
71
+ ],
72
+ name: "ClaimedEvaluatorFee",
73
+ type: "event",
74
+ },
75
+ {
76
+ anonymous: false,
77
+ inputs: [
78
+ {
79
+ indexed: false,
80
+ internalType: "uint256",
81
+ name: "jobId",
82
+ type: "uint256",
83
+ },
84
+ {
85
+ indexed: true,
86
+ internalType: "address",
87
+ name: "provider",
88
+ type: "address",
89
+ },
90
+ {
91
+ indexed: false,
92
+ internalType: "uint256",
93
+ name: "providerFee",
94
+ type: "uint256",
95
+ },
96
+ ],
97
+ name: "ClaimedProviderFee",
98
+ type: "event",
99
+ },
100
+ {
101
+ anonymous: false,
102
+ inputs: [
103
+ {
104
+ indexed: false,
105
+ internalType: "uint64",
106
+ name: "version",
107
+ type: "uint64",
108
+ },
109
+ ],
110
+ name: "Initialized",
111
+ type: "event",
112
+ },
113
+ {
114
+ anonymous: false,
115
+ inputs: [
116
+ {
117
+ indexed: false,
118
+ internalType: "uint256",
119
+ name: "jobId",
120
+ type: "uint256",
121
+ },
122
+ {
123
+ indexed: true,
124
+ internalType: "address",
125
+ name: "client",
126
+ type: "address",
127
+ },
128
+ {
129
+ indexed: true,
130
+ internalType: "address",
131
+ name: "provider",
132
+ type: "address",
133
+ },
134
+ {
135
+ indexed: true,
136
+ internalType: "address",
137
+ name: "evaluator",
138
+ type: "address",
139
+ },
140
+ ],
141
+ name: "JobCreated",
142
+ type: "event",
143
+ },
144
+ {
145
+ anonymous: false,
146
+ inputs: [
147
+ {
148
+ indexed: true,
149
+ internalType: "uint256",
150
+ name: "jobId",
151
+ type: "uint256",
152
+ },
153
+ {
154
+ indexed: false,
155
+ internalType: "uint8",
156
+ name: "oldPhase",
157
+ type: "uint8",
158
+ },
159
+ { indexed: false, internalType: "uint8", name: "phase", type: "uint8" },
160
+ ],
161
+ name: "JobPhaseUpdated",
162
+ type: "event",
163
+ },
164
+ {
165
+ anonymous: false,
166
+ inputs: [
167
+ {
168
+ indexed: false,
169
+ internalType: "uint256",
170
+ name: "memoId",
171
+ type: "uint256",
172
+ },
173
+ {
174
+ indexed: false,
175
+ internalType: "bool",
176
+ name: "isApproved",
177
+ type: "bool",
178
+ },
179
+ {
180
+ indexed: false,
181
+ internalType: "string",
182
+ name: "reason",
183
+ type: "string",
184
+ },
185
+ ],
186
+ name: "MemoSigned",
187
+ type: "event",
188
+ },
189
+ {
190
+ anonymous: false,
191
+ inputs: [
192
+ {
193
+ indexed: true,
194
+ internalType: "uint256",
195
+ name: "jobId",
196
+ type: "uint256",
197
+ },
198
+ {
199
+ indexed: true,
200
+ internalType: "address",
201
+ name: "sender",
202
+ type: "address",
203
+ },
204
+ {
205
+ indexed: false,
206
+ internalType: "uint256",
207
+ name: "memoId",
208
+ type: "uint256",
209
+ },
210
+ ],
211
+ name: "NewMemo",
212
+ type: "event",
213
+ },
214
+ {
215
+ anonymous: false,
216
+ inputs: [
217
+ {
218
+ indexed: false,
219
+ internalType: "uint256",
220
+ name: "jobId",
221
+ type: "uint256",
222
+ },
223
+ {
224
+ indexed: true,
225
+ internalType: "address",
226
+ name: "client",
227
+ type: "address",
228
+ },
229
+ {
230
+ indexed: false,
231
+ internalType: "uint256",
232
+ name: "amount",
233
+ type: "uint256",
234
+ },
235
+ ],
236
+ name: "RefundedBudget",
237
+ type: "event",
238
+ },
239
+ {
240
+ anonymous: false,
241
+ inputs: [
242
+ { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
243
+ {
244
+ indexed: true,
245
+ internalType: "bytes32",
246
+ name: "previousAdminRole",
247
+ type: "bytes32",
248
+ },
249
+ {
250
+ indexed: true,
251
+ internalType: "bytes32",
252
+ name: "newAdminRole",
253
+ type: "bytes32",
254
+ },
255
+ ],
256
+ name: "RoleAdminChanged",
257
+ type: "event",
258
+ },
259
+ {
260
+ anonymous: false,
261
+ inputs: [
262
+ { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
263
+ {
264
+ indexed: true,
265
+ internalType: "address",
266
+ name: "account",
267
+ type: "address",
268
+ },
269
+ {
270
+ indexed: true,
271
+ internalType: "address",
272
+ name: "sender",
273
+ type: "address",
274
+ },
275
+ ],
276
+ name: "RoleGranted",
277
+ type: "event",
278
+ },
279
+ {
280
+ anonymous: false,
281
+ inputs: [
282
+ { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
283
+ {
284
+ indexed: true,
285
+ internalType: "address",
286
+ name: "account",
287
+ type: "address",
288
+ },
289
+ {
290
+ indexed: true,
291
+ internalType: "address",
292
+ name: "sender",
293
+ type: "address",
294
+ },
295
+ ],
296
+ name: "RoleRevoked",
297
+ type: "event",
298
+ },
299
+ {
300
+ inputs: [],
301
+ name: "ADMIN_ROLE",
302
+ outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
303
+ stateMutability: "view",
304
+ type: "function",
305
+ },
306
+ {
307
+ inputs: [],
308
+ name: "DEFAULT_ADMIN_ROLE",
309
+ outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
310
+ stateMutability: "view",
311
+ type: "function",
312
+ },
313
+ {
314
+ inputs: [],
315
+ name: "PHASE_COMPLETED",
316
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
317
+ stateMutability: "view",
318
+ type: "function",
319
+ },
320
+ {
321
+ inputs: [],
322
+ name: "PHASE_EVALUATION",
323
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
324
+ stateMutability: "view",
325
+ type: "function",
326
+ },
327
+ {
328
+ inputs: [],
329
+ name: "PHASE_NEGOTIATION",
330
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
331
+ stateMutability: "view",
332
+ type: "function",
333
+ },
334
+ {
335
+ inputs: [],
336
+ name: "PHASE_REJECTED",
337
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
338
+ stateMutability: "view",
339
+ type: "function",
340
+ },
341
+ {
342
+ inputs: [],
343
+ name: "PHASE_REQUEST",
344
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
345
+ stateMutability: "view",
346
+ type: "function",
347
+ },
348
+ {
349
+ inputs: [],
350
+ name: "PHASE_TRANSACTION",
351
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
352
+ stateMutability: "view",
353
+ type: "function",
354
+ },
355
+ {
356
+ inputs: [],
357
+ name: "TOTAL_PHASES",
358
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
359
+ stateMutability: "view",
360
+ type: "function",
361
+ },
362
+ {
363
+ inputs: [
364
+ { internalType: "address", name: "account", type: "address" },
365
+ { internalType: "uint256", name: "jobId", type: "uint256" },
366
+ ],
367
+ name: "canSign",
368
+ outputs: [{ internalType: "bool", name: "", type: "bool" }],
369
+ stateMutability: "view",
370
+ type: "function",
371
+ },
372
+ {
373
+ inputs: [{ internalType: "uint256", name: "id", type: "uint256" }],
374
+ name: "claimBudget",
375
+ outputs: [],
376
+ stateMutability: "nonpayable",
377
+ type: "function",
378
+ },
379
+ {
380
+ inputs: [
381
+ { internalType: "address", name: "provider", type: "address" },
382
+ { internalType: "address", name: "evaluator", type: "address" },
383
+ { internalType: "uint256", name: "expiredAt", type: "uint256" },
384
+ ],
385
+ name: "createJob",
386
+ outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
387
+ stateMutability: "nonpayable",
388
+ type: "function",
389
+ },
390
+ {
391
+ inputs: [
392
+ { internalType: "uint256", name: "jobId", type: "uint256" },
393
+ { internalType: "string", name: "content", type: "string" },
394
+ {
395
+ internalType: "enum InteractionLedger.MemoType",
396
+ name: "memoType",
397
+ type: "uint8",
398
+ },
399
+ { internalType: "bool", name: "isSecured", type: "bool" },
400
+ { internalType: "uint8", name: "nextPhase", type: "uint8" },
401
+ ],
402
+ name: "createMemo",
403
+ outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
404
+ stateMutability: "nonpayable",
405
+ type: "function",
406
+ },
407
+ {
408
+ inputs: [],
409
+ name: "evaluatorFeeBP",
410
+ outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
411
+ stateMutability: "view",
412
+ type: "function",
413
+ },
414
+ {
415
+ inputs: [
416
+ { internalType: "uint256", name: "jobId", type: "uint256" },
417
+ { internalType: "uint256", name: "offset", type: "uint256" },
418
+ { internalType: "uint256", name: "limit", type: "uint256" },
419
+ ],
420
+ name: "getAllMemos",
421
+ outputs: [
422
+ {
423
+ components: [
424
+ { internalType: "string", name: "content", type: "string" },
425
+ {
426
+ internalType: "enum InteractionLedger.MemoType",
427
+ name: "memoType",
428
+ type: "uint8",
429
+ },
430
+ { internalType: "bool", name: "isSecured", type: "bool" },
431
+ { internalType: "uint8", name: "nextPhase", type: "uint8" },
432
+ { internalType: "uint256", name: "jobId", type: "uint256" },
433
+ { internalType: "address", name: "sender", type: "address" },
434
+ ],
435
+ internalType: "struct InteractionLedger.Memo[]",
436
+ name: "",
437
+ type: "tuple[]",
438
+ },
439
+ { internalType: "uint256", name: "total", type: "uint256" },
440
+ ],
441
+ stateMutability: "view",
442
+ type: "function",
443
+ },
444
+ {
445
+ inputs: [
446
+ { internalType: "uint256", name: "jobId", type: "uint256" },
447
+ { internalType: "uint8", name: "phase", type: "uint8" },
448
+ { internalType: "uint256", name: "offset", type: "uint256" },
449
+ { internalType: "uint256", name: "limit", type: "uint256" },
450
+ ],
451
+ name: "getMemosForPhase",
452
+ outputs: [
453
+ {
454
+ components: [
455
+ { internalType: "string", name: "content", type: "string" },
456
+ {
457
+ internalType: "enum InteractionLedger.MemoType",
458
+ name: "memoType",
459
+ type: "uint8",
460
+ },
461
+ { internalType: "bool", name: "isSecured", type: "bool" },
462
+ { internalType: "uint8", name: "nextPhase", type: "uint8" },
463
+ { internalType: "uint256", name: "jobId", type: "uint256" },
464
+ { internalType: "address", name: "sender", type: "address" },
465
+ ],
466
+ internalType: "struct InteractionLedger.Memo[]",
467
+ name: "",
468
+ type: "tuple[]",
469
+ },
470
+ { internalType: "uint256", name: "total", type: "uint256" },
471
+ ],
472
+ stateMutability: "view",
473
+ type: "function",
474
+ },
475
+ {
476
+ inputs: [],
477
+ name: "getPhases",
478
+ outputs: [{ internalType: "string[6]", name: "", type: "string[6]" }],
479
+ stateMutability: "pure",
480
+ type: "function",
481
+ },
482
+ {
483
+ inputs: [{ internalType: "bytes32", name: "role", type: "bytes32" }],
484
+ name: "getRoleAdmin",
485
+ outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
486
+ stateMutability: "view",
487
+ type: "function",
488
+ },
489
+ {
490
+ inputs: [
491
+ { internalType: "bytes32", name: "role", type: "bytes32" },
492
+ { internalType: "address", name: "account", type: "address" },
493
+ ],
494
+ name: "grantRole",
495
+ outputs: [],
496
+ stateMutability: "nonpayable",
497
+ type: "function",
498
+ },
499
+ {
500
+ inputs: [
501
+ { internalType: "bytes32", name: "role", type: "bytes32" },
502
+ { internalType: "address", name: "account", type: "address" },
503
+ ],
504
+ name: "hasRole",
505
+ outputs: [{ internalType: "bool", name: "", type: "bool" }],
506
+ stateMutability: "view",
507
+ type: "function",
508
+ },
509
+ {
510
+ inputs: [
511
+ { internalType: "address", name: "paymentTokenAddress", type: "address" },
512
+ { internalType: "uint256", name: "evaluatorFeeBP_", type: "uint256" },
513
+ { internalType: "uint256", name: "platformFeeBP_", type: "uint256" },
514
+ { internalType: "address", name: "platformTreasury_", type: "address" },
515
+ ],
516
+ name: "initialize",
517
+ outputs: [],
518
+ stateMutability: "nonpayable",
519
+ type: "function",
520
+ },
521
+ {
522
+ inputs: [
523
+ { internalType: "uint256", name: "jobId", type: "uint256" },
524
+ { internalType: "address", name: "account", type: "address" },
525
+ ],
526
+ name: "isJobEvaluator",
527
+ outputs: [{ internalType: "bool", name: "", type: "bool" }],
528
+ stateMutability: "view",
529
+ type: "function",
530
+ },
531
+ {
532
+ inputs: [],
533
+ name: "jobCounter",
534
+ outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
535
+ stateMutability: "view",
536
+ type: "function",
537
+ },
538
+ {
539
+ inputs: [
540
+ { internalType: "uint256", name: "jobId", type: "uint256" },
541
+ { internalType: "uint8", name: "phase", type: "uint8" },
542
+ { internalType: "uint256", name: "", type: "uint256" },
543
+ ],
544
+ name: "jobMemoIds",
545
+ outputs: [{ internalType: "uint256", name: "memoIds", type: "uint256" }],
546
+ stateMutability: "view",
547
+ type: "function",
548
+ },
549
+ {
550
+ inputs: [{ internalType: "uint256", name: "", type: "uint256" }],
551
+ name: "jobs",
552
+ outputs: [
553
+ { internalType: "uint256", name: "id", type: "uint256" },
554
+ { internalType: "address", name: "client", type: "address" },
555
+ { internalType: "address", name: "provider", type: "address" },
556
+ { internalType: "uint256", name: "budget", type: "uint256" },
557
+ { internalType: "uint256", name: "amountClaimed", type: "uint256" },
558
+ { internalType: "uint8", name: "phase", type: "uint8" },
559
+ { internalType: "uint256", name: "memoCount", type: "uint256" },
560
+ { internalType: "uint256", name: "expiredAt", type: "uint256" },
561
+ { internalType: "address", name: "evaluator", type: "address" },
562
+ ],
563
+ stateMutability: "view",
564
+ type: "function",
565
+ },
566
+ {
567
+ inputs: [],
568
+ name: "memoCounter",
569
+ outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
570
+ stateMutability: "view",
571
+ type: "function",
572
+ },
573
+ {
574
+ inputs: [],
575
+ name: "numEvaluatorsPerJob",
576
+ outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
577
+ stateMutability: "view",
578
+ type: "function",
579
+ },
580
+ {
581
+ inputs: [],
582
+ name: "paymentToken",
583
+ outputs: [{ internalType: "contract IERC20", name: "", type: "address" }],
584
+ stateMutability: "view",
585
+ type: "function",
586
+ },
587
+ {
588
+ inputs: [],
589
+ name: "platformFeeBP",
590
+ outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
591
+ stateMutability: "view",
592
+ type: "function",
593
+ },
594
+ {
595
+ inputs: [],
596
+ name: "platformTreasury",
597
+ outputs: [{ internalType: "address", name: "", type: "address" }],
598
+ stateMutability: "view",
599
+ type: "function",
600
+ },
601
+ {
602
+ inputs: [
603
+ { internalType: "bytes32", name: "role", type: "bytes32" },
604
+ { internalType: "address", name: "callerConfirmation", type: "address" },
605
+ ],
606
+ name: "renounceRole",
607
+ outputs: [],
608
+ stateMutability: "nonpayable",
609
+ type: "function",
610
+ },
611
+ {
612
+ inputs: [
613
+ { internalType: "bytes32", name: "role", type: "bytes32" },
614
+ { internalType: "address", name: "account", type: "address" },
615
+ ],
616
+ name: "revokeRole",
617
+ outputs: [],
618
+ stateMutability: "nonpayable",
619
+ type: "function",
620
+ },
621
+ {
622
+ inputs: [
623
+ { internalType: "uint256", name: "jobId", type: "uint256" },
624
+ { internalType: "uint256", name: "amount", type: "uint256" },
625
+ ],
626
+ name: "setBudget",
627
+ outputs: [],
628
+ stateMutability: "nonpayable",
629
+ type: "function",
630
+ },
631
+ {
632
+ inputs: [
633
+ { internalType: "uint256", name: "memoId", type: "uint256" },
634
+ { internalType: "bool", name: "isApproved", type: "bool" },
635
+ { internalType: "string", name: "reason", type: "string" },
636
+ ],
637
+ name: "signMemo",
638
+ outputs: [],
639
+ stateMutability: "nonpayable",
640
+ type: "function",
641
+ },
642
+ {
643
+ inputs: [
644
+ { internalType: "uint256", name: "memoId", type: "uint256" },
645
+ { internalType: "address", name: "signer", type: "address" },
646
+ ],
647
+ name: "signatories",
648
+ outputs: [{ internalType: "uint8", name: "res", type: "uint8" }],
649
+ stateMutability: "view",
650
+ type: "function",
651
+ },
652
+ {
653
+ inputs: [{ internalType: "bytes4", name: "interfaceId", type: "bytes4" }],
654
+ name: "supportsInterface",
655
+ outputs: [{ internalType: "bool", name: "", type: "bool" }],
656
+ stateMutability: "view",
657
+ type: "function",
658
+ },
659
+ {
660
+ inputs: [
661
+ { internalType: "uint256", name: "evaluatorFeeBP_", type: "uint256" },
662
+ ],
663
+ name: "updateEvaluatorFee",
664
+ outputs: [],
665
+ stateMutability: "nonpayable",
666
+ type: "function",
667
+ },
668
+ {
669
+ inputs: [
670
+ { internalType: "uint256", name: "platformFeeBP_", type: "uint256" },
671
+ { internalType: "address", name: "platformTreasury_", type: "address" },
672
+ ],
673
+ name: "updatePlatformFee",
674
+ outputs: [],
675
+ stateMutability: "nonpayable",
676
+ type: "function",
677
+ },
678
+ ];
679
+
680
+ export default ACP_ABI;