@fairmint/canton-node-sdk 0.0.108 → 0.0.110
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.
- package/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts +2 -8
- package/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.js +2 -8
- package/build/src/clients/ledger-json-api/LedgerJsonApiClient.generated.js.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/commands/completions.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/commands/submit-and-wait-for-transaction-tree.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/commands/submit-and-wait-for-transaction.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/commands/subscribe-to-completions.d.ts +2 -2
- package/build/src/clients/ledger-json-api/operations/v2/commands/subscribe-to-completions.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/commands/subscribe-to-completions.js +0 -4
- package/build/src/clients/ledger-json-api/operations/v2/commands/subscribe-to-completions.js.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/events/get-events-by-contract-id.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/parties/get-party-details.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/parties/get.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/parties/post.d.ts +8 -3
- package/build/src/clients/ledger-json-api/operations/v2/parties/post.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/parties/post.js +12 -5
- package/build/src/clients/ledger-json-api/operations/v2/parties/post.js.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/parties/update-party-details.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/state/get-active-contracts.d.ts +2 -2
- package/build/src/clients/ledger-json-api/operations/v2/state/get-active-contracts.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/state/get-active-contracts.js +17 -28
- package/build/src/clients/ledger-json-api/operations/v2/state/get-active-contracts.js.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/state/get-connected-synchronizers.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-transaction-by-id.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-transaction-by-offset.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-offset.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-update-by-offset.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/index.d.ts +1 -2
- package/build/src/clients/ledger-json-api/operations/v2/updates/index.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/index.js +1 -2
- package/build/src/clients/ledger-json-api/operations/v2/updates/index.js.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.d.ts +29 -0
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.d.ts.map +1 -0
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.js +127 -0
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-updates.js.map +1 -0
- package/build/src/clients/ledger-json-api/operations/v2/users/create-user.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/users/get-user.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/users/grant-user-rights.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/users/list-user-rights.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/users/list-users.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/users/revoke-user-rights.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/users/update-user.d.ts.map +1 -1
- package/build/src/clients/ledger-json-api/operations/v2/utils/event-format-builder.d.ts +35 -0
- package/build/src/clients/ledger-json-api/operations/v2/utils/event-format-builder.d.ts.map +1 -0
- package/build/src/clients/ledger-json-api/operations/v2/utils/event-format-builder.js +37 -0
- package/build/src/clients/ledger-json-api/operations/v2/utils/event-format-builder.js.map +1 -0
- package/build/src/clients/validator-api/operations/v0/ans/create-entry.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/ans/get-rules.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/ans/list-entries-proxy.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/ans/lookup-by-name.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/ans/lookup-by-party.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/lookup-featured-app-right.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/allocation-instruction/v1/get-allocation-factory.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/allocations/v1/get-allocation-cancel-context.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/allocations/v1/get-allocation-transfer-context.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/allocations/v1/get-allocation-withdraw-context.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/metadata/v1/get-instrument.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/metadata/v1/get-registry-info.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/metadata/v1/list-instruments.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/transfer-instruction/v1/get-transfer-factory.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/transfer-instruction/v1/get-transfer-instruction-accept-context.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/transfer-instruction/v1/get-transfer-instruction-reject-context.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/scan-proxy/registry/transfer-instruction/v1/get-transfer-instruction-withdraw-context.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/wallet/token-standard/transfers/create.d.ts.map +1 -1
- package/build/src/clients/validator-api/operations/v0/wallet/token-standard/transfers/list.d.ts.map +1 -1
- package/build/src/core/http/HttpClient.d.ts +5 -0
- package/build/src/core/http/HttpClient.d.ts.map +1 -1
- package/build/src/core/http/HttpClient.js +16 -2
- package/build/src/core/http/HttpClient.js.map +1 -1
- package/build/src/generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi.d.ts +1979 -622
- package/build/src/generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi.d.ts.map +1 -1
- package/build/src/generated/token-standard/splice-api-token-allocation-instruction-v1/openapi/allocation-instruction-v1.d.ts +22 -17
- package/build/src/generated/token-standard/splice-api-token-allocation-instruction-v1/openapi/allocation-instruction-v1.d.ts.map +1 -1
- package/build/src/generated/token-standard/splice-api-token-allocation-v1/openapi/allocation-v1.d.ts +22 -21
- package/build/src/generated/token-standard/splice-api-token-allocation-v1/openapi/allocation-v1.d.ts.map +1 -1
- package/build/src/generated/token-standard/splice-api-token-metadata-v1/openapi/token-metadata-v1.d.ts +6 -5
- package/build/src/generated/token-standard/splice-api-token-metadata-v1/openapi/token-metadata-v1.d.ts.map +1 -1
- package/build/src/generated/token-standard/splice-api-token-transfer-instruction-v1/openapi/transfer-instruction-v1.d.ts +29 -28
- package/build/src/generated/token-standard/splice-api-token-transfer-instruction-v1/openapi/transfer-instruction-v1.d.ts.map +1 -1
- package/package.json +10 -10
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-flats.d.ts +0 -310
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-flats.d.ts.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-flats.js +0 -61
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-flats.js.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-trees.d.ts +0 -227
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-trees.d.ts.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-trees.js +0 -61
- package/build/src/clients/ledger-json-api/operations/v2/updates/get-trees.js.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-flats.d.ts +0 -282
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-flats.d.ts.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-flats.js +0 -34
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-flats.js.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-trees.d.ts +0 -284
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-trees.d.ts.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-trees.js +0 -22
- package/build/src/clients/ledger-json-api/operations/v2/updates/subscribe-to-trees.js.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/utils/format-normalizers.d.ts +0 -7
- package/build/src/clients/ledger-json-api/operations/v2/updates/utils/format-normalizers.d.ts.map +0 -1
- package/build/src/clients/ledger-json-api/operations/v2/updates/utils/format-normalizers.js +0 -83
- package/build/src/clients/ledger-json-api/operations/v2/updates/utils/format-normalizers.js.map +0 -1
|
@@ -63,7 +63,10 @@ export interface paths {
|
|
|
63
63
|
};
|
|
64
64
|
get?: never;
|
|
65
65
|
put?: never;
|
|
66
|
-
/**
|
|
66
|
+
/**
|
|
67
|
+
* @deprecated
|
|
68
|
+
* @description Submit a batch of commands and wait for the transaction trees response. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use submit-and-wait-for-transaction instead.
|
|
69
|
+
*/
|
|
67
70
|
post: operations["postV2CommandsSubmit-and-wait-for-transaction-tree"];
|
|
68
71
|
delete?: never;
|
|
69
72
|
options?: never;
|
|
@@ -114,12 +117,14 @@ export interface paths {
|
|
|
114
117
|
};
|
|
115
118
|
get?: never;
|
|
116
119
|
put?: never;
|
|
117
|
-
/**
|
|
120
|
+
/**
|
|
121
|
+
* @description Query completions list (blocking call)
|
|
118
122
|
* Notice: This endpoint should be used for small results set.
|
|
119
123
|
* When number of results exceeded node configuration limit (`http-list-max-elements-limit`)
|
|
120
124
|
* there will be an error (`413 Content Too Large`) returned.
|
|
121
125
|
* Increasing this limit may lead to performance issues and high memory consumption.
|
|
122
|
-
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
126
|
+
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
127
|
+
*/
|
|
123
128
|
post: operations["postV2CommandsCompletions"];
|
|
124
129
|
delete?: never;
|
|
125
130
|
options?: never;
|
|
@@ -213,6 +218,24 @@ export interface paths {
|
|
|
213
218
|
patch?: never;
|
|
214
219
|
trace?: never;
|
|
215
220
|
};
|
|
221
|
+
"/v2/package-vetting": {
|
|
222
|
+
parameters: {
|
|
223
|
+
query?: never;
|
|
224
|
+
header?: never;
|
|
225
|
+
path?: never;
|
|
226
|
+
cookie?: never;
|
|
227
|
+
};
|
|
228
|
+
/** @description List vetted packages */
|
|
229
|
+
get: operations["getV2Package-vetting"];
|
|
230
|
+
put?: never;
|
|
231
|
+
/** @description Update vetted packages */
|
|
232
|
+
post: operations["postV2Package-vetting"];
|
|
233
|
+
delete?: never;
|
|
234
|
+
options?: never;
|
|
235
|
+
head?: never;
|
|
236
|
+
patch?: never;
|
|
237
|
+
trace?: never;
|
|
238
|
+
};
|
|
216
239
|
"/v2/parties": {
|
|
217
240
|
parameters: {
|
|
218
241
|
query?: never;
|
|
@@ -309,7 +332,8 @@ export interface paths {
|
|
|
309
332
|
};
|
|
310
333
|
get?: never;
|
|
311
334
|
put?: never;
|
|
312
|
-
/**
|
|
335
|
+
/**
|
|
336
|
+
* @description Query active contracts list (blocking call).
|
|
313
337
|
* Querying active contracts is an expensive operation and if possible should not be repeated often.
|
|
314
338
|
* Consider querying active contracts initially (for a given offset)
|
|
315
339
|
* and then repeatedly call one of `/v2/updates/...`endpoints to get subsequent modifications.
|
|
@@ -319,7 +343,8 @@ export interface paths {
|
|
|
319
343
|
* When number of results exceeded node configuration limit (`http-list-max-elements-limit`)
|
|
320
344
|
* there will be an error (`413 Content Too Large`) returned.
|
|
321
345
|
* Increasing this limit may lead to performance issues and high memory consumption.
|
|
322
|
-
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
346
|
+
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
347
|
+
*/
|
|
323
348
|
post: operations["postV2StateActive-contracts"];
|
|
324
349
|
delete?: never;
|
|
325
350
|
options?: never;
|
|
@@ -387,12 +412,14 @@ export interface paths {
|
|
|
387
412
|
};
|
|
388
413
|
get?: never;
|
|
389
414
|
put?: never;
|
|
390
|
-
/**
|
|
415
|
+
/**
|
|
416
|
+
* @description Query updates list (blocking call)
|
|
391
417
|
* Notice: This endpoint should be used for small results set.
|
|
392
418
|
* When number of results exceeded node configuration limit (`http-list-max-elements-limit`)
|
|
393
419
|
* there will be an error (`413 Content Too Large`) returned.
|
|
394
420
|
* Increasing this limit may lead to performance issues and high memory consumption.
|
|
395
|
-
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
421
|
+
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
422
|
+
*/
|
|
396
423
|
post: operations["postV2Updates"];
|
|
397
424
|
delete?: never;
|
|
398
425
|
options?: never;
|
|
@@ -409,12 +436,15 @@ export interface paths {
|
|
|
409
436
|
};
|
|
410
437
|
get?: never;
|
|
411
438
|
put?: never;
|
|
412
|
-
/**
|
|
439
|
+
/**
|
|
440
|
+
* @deprecated
|
|
441
|
+
* @description Query flat transactions update list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.
|
|
413
442
|
* Notice: This endpoint should be used for small results set.
|
|
414
443
|
* When number of results exceeded node configuration limit (`http-list-max-elements-limit`)
|
|
415
444
|
* there will be an error (`413 Content Too Large`) returned.
|
|
416
445
|
* Increasing this limit may lead to performance issues and high memory consumption.
|
|
417
|
-
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
446
|
+
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
447
|
+
*/
|
|
418
448
|
post: operations["postV2UpdatesFlats"];
|
|
419
449
|
delete?: never;
|
|
420
450
|
options?: never;
|
|
@@ -431,12 +461,15 @@ export interface paths {
|
|
|
431
461
|
};
|
|
432
462
|
get?: never;
|
|
433
463
|
put?: never;
|
|
434
|
-
/**
|
|
464
|
+
/**
|
|
465
|
+
* @deprecated
|
|
466
|
+
* @description Query update transactions tree list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.
|
|
435
467
|
* Notice: This endpoint should be used for small results set.
|
|
436
468
|
* When number of results exceeded node configuration limit (`http-list-max-elements-limit`)
|
|
437
469
|
* there will be an error (`413 Content Too Large`) returned.
|
|
438
470
|
* Increasing this limit may lead to performance issues and high memory consumption.
|
|
439
|
-
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
471
|
+
* Consider using websockets (asyncapi) for better efficiency with larger results.
|
|
472
|
+
*/
|
|
440
473
|
post: operations["postV2UpdatesTrees"];
|
|
441
474
|
delete?: never;
|
|
442
475
|
options?: never;
|
|
@@ -451,7 +484,10 @@ export interface paths {
|
|
|
451
484
|
path?: never;
|
|
452
485
|
cookie?: never;
|
|
453
486
|
};
|
|
454
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* @deprecated
|
|
489
|
+
* @description Get transaction tree by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.
|
|
490
|
+
*/
|
|
455
491
|
get: operations["getV2UpdatesTransaction-tree-by-offsetOffset"];
|
|
456
492
|
put?: never;
|
|
457
493
|
post?: never;
|
|
@@ -470,7 +506,10 @@ export interface paths {
|
|
|
470
506
|
};
|
|
471
507
|
get?: never;
|
|
472
508
|
put?: never;
|
|
473
|
-
/**
|
|
509
|
+
/**
|
|
510
|
+
* @deprecated
|
|
511
|
+
* @description Get transaction by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.
|
|
512
|
+
*/
|
|
474
513
|
post: operations["postV2UpdatesTransaction-by-offset"];
|
|
475
514
|
delete?: never;
|
|
476
515
|
options?: never;
|
|
@@ -504,7 +543,10 @@ export interface paths {
|
|
|
504
543
|
};
|
|
505
544
|
get?: never;
|
|
506
545
|
put?: never;
|
|
507
|
-
/**
|
|
546
|
+
/**
|
|
547
|
+
* @deprecated
|
|
548
|
+
* @description Get transaction by id. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-id instead.
|
|
549
|
+
*/
|
|
508
550
|
post: operations["postV2UpdatesTransaction-by-id"];
|
|
509
551
|
delete?: never;
|
|
510
552
|
options?: never;
|
|
@@ -536,7 +578,10 @@ export interface paths {
|
|
|
536
578
|
path?: never;
|
|
537
579
|
cookie?: never;
|
|
538
580
|
};
|
|
539
|
-
/**
|
|
581
|
+
/**
|
|
582
|
+
* @deprecated
|
|
583
|
+
* @description Get transaction tree by id. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-id instead.
|
|
584
|
+
*/
|
|
540
585
|
get: operations["getV2UpdatesTransaction-tree-by-idUpdate-id"];
|
|
541
586
|
put?: never;
|
|
542
587
|
post?: never;
|
|
@@ -583,6 +628,23 @@ export interface paths {
|
|
|
583
628
|
patch: operations["patchV2UsersUser-id"];
|
|
584
629
|
trace?: never;
|
|
585
630
|
};
|
|
631
|
+
"/v2/authenticated-user": {
|
|
632
|
+
parameters: {
|
|
633
|
+
query?: never;
|
|
634
|
+
header?: never;
|
|
635
|
+
path?: never;
|
|
636
|
+
cookie?: never;
|
|
637
|
+
};
|
|
638
|
+
/** @description Get current user details (uses user for JWT). */
|
|
639
|
+
get: operations["getV2Authenticated-user"];
|
|
640
|
+
put?: never;
|
|
641
|
+
post?: never;
|
|
642
|
+
delete?: never;
|
|
643
|
+
options?: never;
|
|
644
|
+
head?: never;
|
|
645
|
+
patch?: never;
|
|
646
|
+
trace?: never;
|
|
647
|
+
};
|
|
586
648
|
"/v2/users/{user-id}/rights": {
|
|
587
649
|
parameters: {
|
|
588
650
|
query?: never;
|
|
@@ -690,6 +752,40 @@ export interface paths {
|
|
|
690
752
|
patch?: never;
|
|
691
753
|
trace?: never;
|
|
692
754
|
};
|
|
755
|
+
"/v2/interactive-submission/executeAndWait": {
|
|
756
|
+
parameters: {
|
|
757
|
+
query?: never;
|
|
758
|
+
header?: never;
|
|
759
|
+
path?: never;
|
|
760
|
+
cookie?: never;
|
|
761
|
+
};
|
|
762
|
+
get?: never;
|
|
763
|
+
put?: never;
|
|
764
|
+
/** @description Execute a signed transaction and wait for its completion */
|
|
765
|
+
post: operations["postV2Interactive-submissionExecuteandwait"];
|
|
766
|
+
delete?: never;
|
|
767
|
+
options?: never;
|
|
768
|
+
head?: never;
|
|
769
|
+
patch?: never;
|
|
770
|
+
trace?: never;
|
|
771
|
+
};
|
|
772
|
+
"/v2/interactive-submission/executeAndWaitForTransaction": {
|
|
773
|
+
parameters: {
|
|
774
|
+
query?: never;
|
|
775
|
+
header?: never;
|
|
776
|
+
path?: never;
|
|
777
|
+
cookie?: never;
|
|
778
|
+
};
|
|
779
|
+
get?: never;
|
|
780
|
+
put?: never;
|
|
781
|
+
/** @description Execute a signed transaction and wait for the transaction response */
|
|
782
|
+
post: operations["postV2Interactive-submissionExecuteandwaitfortransaction"];
|
|
783
|
+
delete?: never;
|
|
784
|
+
options?: never;
|
|
785
|
+
head?: never;
|
|
786
|
+
patch?: never;
|
|
787
|
+
trace?: never;
|
|
788
|
+
};
|
|
693
789
|
"/v2/interactive-submission/preferred-package-version": {
|
|
694
790
|
parameters: {
|
|
695
791
|
query?: never;
|
|
@@ -733,11 +829,14 @@ export interface components {
|
|
|
733
829
|
* @description Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``
|
|
734
830
|
*/
|
|
735
831
|
AllocateExternalPartyRequest: {
|
|
736
|
-
/**
|
|
832
|
+
/**
|
|
833
|
+
* @description TODO(#27670) support synchronizer aliases
|
|
737
834
|
* Synchronizer ID on which to onboard the party
|
|
738
|
-
* Required
|
|
835
|
+
* Required
|
|
836
|
+
*/
|
|
739
837
|
synchronizer: string;
|
|
740
|
-
/**
|
|
838
|
+
/**
|
|
839
|
+
* @description TopologyTransactions to onboard the external party
|
|
741
840
|
* Can contain:
|
|
742
841
|
* - A namespace for the party.
|
|
743
842
|
* This can be either a single NamespaceDelegation,
|
|
@@ -747,14 +846,19 @@ export interface components {
|
|
|
747
846
|
* May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
|
|
748
847
|
* - A PartyToParticipant to register the hosting relationship of the party.
|
|
749
848
|
* Must be provided.
|
|
750
|
-
* Required
|
|
849
|
+
* Required
|
|
850
|
+
*/
|
|
751
851
|
onboardingTransactions?: components["schemas"]["SignedTransaction"][];
|
|
752
|
-
/**
|
|
753
|
-
*
|
|
852
|
+
/**
|
|
853
|
+
* @description Optional signatures of the combined hash of all onboarding_transactions
|
|
854
|
+
* This may be used instead of providing signatures on each individual transaction
|
|
855
|
+
*/
|
|
754
856
|
multiHashSignatures?: components["schemas"]["Signature"][];
|
|
755
|
-
/**
|
|
857
|
+
/**
|
|
858
|
+
* @description The id of the ``Identity Provider``
|
|
756
859
|
* If not set, assume the party is managed by the default identity provider.
|
|
757
|
-
* Optional
|
|
860
|
+
* Optional
|
|
861
|
+
*/
|
|
758
862
|
identityProviderId: string;
|
|
759
863
|
};
|
|
760
864
|
/** AllocateExternalPartyResponse */
|
|
@@ -766,18 +870,37 @@ export interface components {
|
|
|
766
870
|
* @description Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``
|
|
767
871
|
*/
|
|
768
872
|
AllocatePartyRequest: {
|
|
769
|
-
/**
|
|
873
|
+
/**
|
|
874
|
+
* @description A hint to the participant which party ID to allocate. It can be
|
|
770
875
|
* ignored.
|
|
771
876
|
* Must be a valid PartyIdString (as described in ``value.proto``).
|
|
772
|
-
* Optional
|
|
877
|
+
* Optional
|
|
878
|
+
*/
|
|
773
879
|
partyIdHint: string;
|
|
774
|
-
/**
|
|
880
|
+
/**
|
|
881
|
+
* @description Formerly "display_name"
|
|
775
882
|
* Participant-local metadata to be stored in the ``PartyDetails`` of this newly allocated party.
|
|
776
|
-
* Optional
|
|
883
|
+
* Optional
|
|
884
|
+
*/
|
|
777
885
|
localMetadata?: components["schemas"]["ObjectMeta"];
|
|
778
|
-
/**
|
|
779
|
-
*
|
|
886
|
+
/**
|
|
887
|
+
* @description The id of the ``Identity Provider``
|
|
888
|
+
* Optional, if not set, assume the party is managed by the default identity provider or party is not hosted by the participant.
|
|
889
|
+
*/
|
|
780
890
|
identityProviderId: string;
|
|
891
|
+
/**
|
|
892
|
+
* @description The synchronizer, on which the party should be allocated.
|
|
893
|
+
* For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer.
|
|
894
|
+
* Otherwise a synchronizer must be specified.
|
|
895
|
+
* Optional
|
|
896
|
+
*/
|
|
897
|
+
synchronizerId: string;
|
|
898
|
+
/**
|
|
899
|
+
* @description The user who will get the act_as rights to the newly allocated party.
|
|
900
|
+
* If set to an empty string (the default), no user will get rights to the party.
|
|
901
|
+
* Optional
|
|
902
|
+
*/
|
|
903
|
+
userId: string;
|
|
781
904
|
};
|
|
782
905
|
/** AllocatePartyResponse */
|
|
783
906
|
AllocatePartyResponse: {
|
|
@@ -804,34 +927,47 @@ export interface components {
|
|
|
804
927
|
* Required, must be valid node ID (non-negative integer)
|
|
805
928
|
*/
|
|
806
929
|
nodeId: number;
|
|
807
|
-
/**
|
|
930
|
+
/**
|
|
931
|
+
* @description The ID of the archived contract.
|
|
808
932
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
809
|
-
* Required
|
|
933
|
+
* Required
|
|
934
|
+
*/
|
|
810
935
|
contractId: string;
|
|
811
|
-
/**
|
|
936
|
+
/**
|
|
937
|
+
* @description Identifies the template that defines the choice that archived the contract.
|
|
938
|
+
* This template's package-id may differ from the target contract's package-id
|
|
939
|
+
* if the target contract has been upgraded or downgraded.
|
|
940
|
+
*
|
|
812
941
|
* The identifier uses the package-id reference format.
|
|
813
942
|
*
|
|
814
|
-
* Required
|
|
943
|
+
* Required
|
|
944
|
+
*/
|
|
815
945
|
templateId: string;
|
|
816
|
-
/**
|
|
946
|
+
/**
|
|
947
|
+
* @description The parties that are notified of this event. For an ``ArchivedEvent``,
|
|
817
948
|
* these are the intersection of the stakeholders of the contract in
|
|
818
949
|
* question and the parties specified in the ``TransactionFilter``. The
|
|
819
950
|
* stakeholders are the union of the signatories and the observers of
|
|
820
951
|
* the contract.
|
|
821
952
|
* Each one of its elements must be a valid PartyIdString (as described
|
|
822
953
|
* in ``value.proto``).
|
|
823
|
-
* Required
|
|
954
|
+
* Required
|
|
955
|
+
*/
|
|
824
956
|
witnessParties?: string[];
|
|
825
|
-
/**
|
|
826
|
-
*
|
|
957
|
+
/**
|
|
958
|
+
* @description The package name of the contract.
|
|
959
|
+
* Required
|
|
960
|
+
*/
|
|
827
961
|
packageName: string;
|
|
828
|
-
/**
|
|
962
|
+
/**
|
|
963
|
+
* @description The interfaces implemented by the target template that have been
|
|
829
964
|
* matched from the interface filter query.
|
|
830
965
|
* Populated only in case interface filters with include_interface_view set.
|
|
831
966
|
*
|
|
832
967
|
* If defined, the identifier uses the package-id reference format.
|
|
833
968
|
*
|
|
834
|
-
* Optional
|
|
969
|
+
* Optional
|
|
970
|
+
*/
|
|
835
971
|
implementedInterfaces?: string[];
|
|
836
972
|
};
|
|
837
973
|
/**
|
|
@@ -846,17 +982,23 @@ export interface components {
|
|
|
846
982
|
* @description Assign a contract
|
|
847
983
|
*/
|
|
848
984
|
AssignCommand1: {
|
|
849
|
-
/**
|
|
985
|
+
/**
|
|
986
|
+
* @description The ID from the unassigned event to be completed by this assignment.
|
|
850
987
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
851
|
-
* Required
|
|
852
|
-
|
|
853
|
-
|
|
988
|
+
* Required
|
|
989
|
+
*/
|
|
990
|
+
reassignmentId: string;
|
|
991
|
+
/**
|
|
992
|
+
* @description The ID of the source synchronizer
|
|
854
993
|
* Must be a valid synchronizer id
|
|
855
|
-
* Required
|
|
994
|
+
* Required
|
|
995
|
+
*/
|
|
856
996
|
source: string;
|
|
857
|
-
/**
|
|
997
|
+
/**
|
|
998
|
+
* @description The ID of the target synchronizer
|
|
858
999
|
* Must be a valid synchronizer id
|
|
859
|
-
* Required
|
|
1000
|
+
* Required
|
|
1001
|
+
*/
|
|
860
1002
|
target: string;
|
|
861
1003
|
};
|
|
862
1004
|
/** CanActAs */
|
|
@@ -931,35 +1073,48 @@ export interface components {
|
|
|
931
1073
|
* @description A completion represents the status of a submitted command on the ledger: it can be successful or failed.
|
|
932
1074
|
*/
|
|
933
1075
|
Completion1: {
|
|
934
|
-
/**
|
|
1076
|
+
/**
|
|
1077
|
+
* @description The ID of the succeeded or failed command.
|
|
935
1078
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
936
|
-
* Required
|
|
1079
|
+
* Required
|
|
1080
|
+
*/
|
|
937
1081
|
commandId: string;
|
|
938
|
-
/**
|
|
1082
|
+
/**
|
|
1083
|
+
* @description Identifies the exact type of the error.
|
|
939
1084
|
* It uses the same format of conveying error details as it is used for the RPC responses of the APIs.
|
|
940
|
-
* Optional
|
|
941
|
-
|
|
942
|
-
|
|
1085
|
+
* Optional
|
|
1086
|
+
*/
|
|
1087
|
+
status?: components["schemas"]["JsStatus"];
|
|
1088
|
+
/**
|
|
1089
|
+
* @description The update_id of the transaction or reassignment that resulted from the command with command_id.
|
|
943
1090
|
* Only set for successfully executed commands.
|
|
944
|
-
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1091
|
+
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1092
|
+
*/
|
|
945
1093
|
updateId: string;
|
|
946
|
-
/**
|
|
1094
|
+
/**
|
|
1095
|
+
* @description The user-id that was used for the submission, as described in ``commands.proto``.
|
|
947
1096
|
* Must be a valid UserIdString (as described in ``value.proto``).
|
|
948
|
-
* Optional for historic completions where this data is not available.
|
|
1097
|
+
* Optional for historic completions where this data is not available.
|
|
1098
|
+
*/
|
|
949
1099
|
userId: string;
|
|
950
|
-
/**
|
|
1100
|
+
/**
|
|
1101
|
+
* @description The set of parties on whose behalf the commands were executed.
|
|
951
1102
|
* Contains the ``act_as`` parties from ``commands.proto``
|
|
952
1103
|
* filtered to the requesting parties in CompletionStreamRequest.
|
|
953
1104
|
* The order of the parties need not be the same as in the submission.
|
|
954
1105
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
955
|
-
* Optional for historic completions where this data is not available.
|
|
1106
|
+
* Optional for historic completions where this data is not available.
|
|
1107
|
+
*/
|
|
956
1108
|
actAs?: string[];
|
|
957
|
-
/**
|
|
1109
|
+
/**
|
|
1110
|
+
* @description The submission ID this completion refers to, as described in ``commands.proto``.
|
|
958
1111
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
959
|
-
* Optional
|
|
1112
|
+
* Optional
|
|
1113
|
+
*/
|
|
960
1114
|
submissionId: string;
|
|
961
1115
|
deduplicationPeriod: components["schemas"]["DeduplicationPeriod1"];
|
|
962
|
-
/**
|
|
1116
|
+
/**
|
|
1117
|
+
* @description Optional; ledger API trace context
|
|
963
1118
|
*
|
|
964
1119
|
* The trace context transported in this message corresponds to the trace context supplied
|
|
965
1120
|
* by the client application in a HTTP2 header of the original command submission.
|
|
@@ -967,7 +1122,8 @@ export interface components {
|
|
|
967
1122
|
* body, because it is used in gRPC streams which do not support per message headers.
|
|
968
1123
|
* This field will be populated with the trace context contained in the original submission.
|
|
969
1124
|
* If that was not provided, a unique ledger-api-server generated trace context will be used
|
|
970
|
-
* instead.
|
|
1125
|
+
* instead.
|
|
1126
|
+
*/
|
|
971
1127
|
traceContext?: components["schemas"]["TraceContext"];
|
|
972
1128
|
/**
|
|
973
1129
|
* Format: int64
|
|
@@ -975,14 +1131,16 @@ export interface components {
|
|
|
975
1131
|
* Required, must be a valid absolute offset (positive integer).
|
|
976
1132
|
*/
|
|
977
1133
|
offset: number;
|
|
978
|
-
/**
|
|
1134
|
+
/**
|
|
1135
|
+
* @description The synchronizer along with its record time.
|
|
979
1136
|
* The synchronizer id provided, in case of
|
|
980
1137
|
*
|
|
981
1138
|
* - successful/failed transactions: identifies the synchronizer of the transaction
|
|
982
1139
|
* - for successful/failed unassign commands: identifies the source synchronizer
|
|
983
1140
|
* - for successful/failed assign commands: identifies the target synchronizer
|
|
984
1141
|
*
|
|
985
|
-
* Required
|
|
1142
|
+
* Required
|
|
1143
|
+
*/
|
|
986
1144
|
synchronizerTime?: components["schemas"]["SynchronizerTime"];
|
|
987
1145
|
};
|
|
988
1146
|
/** CompletionResponse */
|
|
@@ -995,15 +1153,19 @@ export interface components {
|
|
|
995
1153
|
};
|
|
996
1154
|
/** CompletionStreamRequest */
|
|
997
1155
|
CompletionStreamRequest: {
|
|
998
|
-
/**
|
|
1156
|
+
/**
|
|
1157
|
+
* @description Only completions of commands submitted with the same user_id will be visible in the stream.
|
|
999
1158
|
* Must be a valid UserIdString (as described in ``value.proto``).
|
|
1000
1159
|
* Required unless authentication is used with a user token.
|
|
1001
|
-
* In that case, the token's user-id will be used for the request's user_id.
|
|
1160
|
+
* In that case, the token's user-id will be used for the request's user_id.
|
|
1161
|
+
*/
|
|
1002
1162
|
userId: string;
|
|
1003
|
-
/**
|
|
1163
|
+
/**
|
|
1164
|
+
* @description Non-empty list of parties whose data should be included.
|
|
1004
1165
|
* The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.
|
|
1005
1166
|
* Must be a valid PartyIdString (as described in ``value.proto``).
|
|
1006
|
-
* Required
|
|
1167
|
+
* Required
|
|
1168
|
+
*/
|
|
1007
1169
|
parties?: string[];
|
|
1008
1170
|
/**
|
|
1009
1171
|
* Format: int64
|
|
@@ -1022,28 +1184,37 @@ export interface components {
|
|
|
1022
1184
|
ConnectedSynchronizer: {
|
|
1023
1185
|
synchronizerAlias: string;
|
|
1024
1186
|
synchronizerId: string;
|
|
1025
|
-
|
|
1187
|
+
/** @enum {string} */
|
|
1188
|
+
permission: "PARTICIPANT_PERMISSION_UNSPECIFIED" | "PARTICIPANT_PERMISSION_SUBMISSION" | "PARTICIPANT_PERMISSION_CONFIRMATION" | "PARTICIPANT_PERMISSION_OBSERVATION";
|
|
1026
1189
|
};
|
|
1027
1190
|
/**
|
|
1028
1191
|
* CreateAndExerciseCommand
|
|
1029
1192
|
* @description Create a contract and exercise a choice on it in the same transaction.
|
|
1030
1193
|
*/
|
|
1031
1194
|
CreateAndExerciseCommand: {
|
|
1032
|
-
/**
|
|
1195
|
+
/**
|
|
1196
|
+
* @description The template of the contract the client wants to create.
|
|
1033
1197
|
* Both package-name and package-id reference identifier formats for the template-id are supported.
|
|
1034
1198
|
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
1035
1199
|
*
|
|
1036
|
-
* Required
|
|
1200
|
+
* Required
|
|
1201
|
+
*/
|
|
1037
1202
|
templateId: string;
|
|
1038
|
-
/**
|
|
1039
|
-
*
|
|
1203
|
+
/**
|
|
1204
|
+
* @description The arguments required for creating a contract from this template.
|
|
1205
|
+
* Required
|
|
1206
|
+
*/
|
|
1040
1207
|
createArguments: unknown;
|
|
1041
|
-
/**
|
|
1208
|
+
/**
|
|
1209
|
+
* @description The name of the choice the client wants to exercise.
|
|
1042
1210
|
* Must be a valid NameString (as described in ``value.proto``).
|
|
1043
|
-
* Required
|
|
1211
|
+
* Required
|
|
1212
|
+
*/
|
|
1044
1213
|
choice: string;
|
|
1045
|
-
/**
|
|
1046
|
-
*
|
|
1214
|
+
/**
|
|
1215
|
+
* @description The argument for this choice.
|
|
1216
|
+
* Required
|
|
1217
|
+
*/
|
|
1047
1218
|
choiceArgument: unknown;
|
|
1048
1219
|
};
|
|
1049
1220
|
/**
|
|
@@ -1051,14 +1222,18 @@ export interface components {
|
|
|
1051
1222
|
* @description Create a new contract instance based on a template.
|
|
1052
1223
|
*/
|
|
1053
1224
|
CreateCommand: {
|
|
1054
|
-
/**
|
|
1225
|
+
/**
|
|
1226
|
+
* @description The template of contract the client wants to create.
|
|
1055
1227
|
* Both package-name and package-id reference identifier formats for the template-id are supported.
|
|
1056
1228
|
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
1057
1229
|
*
|
|
1058
|
-
* Required
|
|
1230
|
+
* Required
|
|
1231
|
+
*/
|
|
1059
1232
|
templateId: string;
|
|
1060
|
-
/**
|
|
1061
|
-
*
|
|
1233
|
+
/**
|
|
1234
|
+
* @description The arguments required for creating a contract from this template.
|
|
1235
|
+
* Required
|
|
1236
|
+
*/
|
|
1062
1237
|
createArguments: unknown;
|
|
1063
1238
|
};
|
|
1064
1239
|
/** CreateIdentityProviderConfigRequest */
|
|
@@ -1072,17 +1247,21 @@ export interface components {
|
|
|
1072
1247
|
};
|
|
1073
1248
|
/**
|
|
1074
1249
|
* CreateUserRequest
|
|
1075
|
-
* @description
|
|
1250
|
+
* @description RPC requests and responses
|
|
1076
1251
|
* ///////////////////////////
|
|
1077
1252
|
* Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)``
|
|
1078
1253
|
*/
|
|
1079
1254
|
CreateUserRequest: {
|
|
1080
|
-
/**
|
|
1081
|
-
*
|
|
1255
|
+
/**
|
|
1256
|
+
* @description The user to create.
|
|
1257
|
+
* Required
|
|
1258
|
+
*/
|
|
1082
1259
|
user?: components["schemas"]["User"];
|
|
1083
|
-
/**
|
|
1260
|
+
/**
|
|
1261
|
+
* @description The rights to be assigned to the user upon creation,
|
|
1084
1262
|
* which SHOULD include appropriate rights for the ``user.primary_party``.
|
|
1085
|
-
* Optional
|
|
1263
|
+
* Optional
|
|
1264
|
+
*/
|
|
1086
1265
|
rights?: components["schemas"]["Right"][];
|
|
1087
1266
|
};
|
|
1088
1267
|
/** CreateUserResponse */
|
|
@@ -1112,38 +1291,51 @@ export interface components {
|
|
|
1112
1291
|
* Required, must be valid node ID (non-negative integer)
|
|
1113
1292
|
*/
|
|
1114
1293
|
nodeId: number;
|
|
1115
|
-
/**
|
|
1294
|
+
/**
|
|
1295
|
+
* @description The ID of the created contract.
|
|
1116
1296
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1117
|
-
* Required
|
|
1297
|
+
* Required
|
|
1298
|
+
*/
|
|
1118
1299
|
contractId: string;
|
|
1119
|
-
/**
|
|
1300
|
+
/**
|
|
1301
|
+
* @description The template of the created contract.
|
|
1120
1302
|
* The identifier uses the package-id reference format.
|
|
1121
1303
|
*
|
|
1122
|
-
* Required
|
|
1304
|
+
* Required
|
|
1305
|
+
*/
|
|
1123
1306
|
templateId: string;
|
|
1124
|
-
/**
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1307
|
+
/**
|
|
1308
|
+
* @description The key of the created contract.
|
|
1309
|
+
* This will be set if and only if ``template_id`` defines a contract key.
|
|
1310
|
+
* Optional
|
|
1311
|
+
*/
|
|
1127
1312
|
contractKey?: unknown;
|
|
1128
1313
|
createArgument?: unknown;
|
|
1129
|
-
/**
|
|
1314
|
+
/**
|
|
1315
|
+
* @description Opaque representation of contract create event payload intended for forwarding
|
|
1130
1316
|
* to an API server as a contract disclosed as part of a command
|
|
1131
1317
|
* submission.
|
|
1132
|
-
* Optional
|
|
1318
|
+
* Optional
|
|
1319
|
+
*/
|
|
1133
1320
|
createdEventBlob: string;
|
|
1134
|
-
/**
|
|
1321
|
+
/**
|
|
1322
|
+
* @description Interface views specified in the transaction filter.
|
|
1135
1323
|
* Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with
|
|
1136
1324
|
*
|
|
1137
1325
|
* - its party in the ``witness_parties`` of this event,
|
|
1138
1326
|
* - and which is implemented by the template of this event,
|
|
1139
1327
|
* - and which has ``include_interface_view`` set.
|
|
1140
1328
|
*
|
|
1141
|
-
* Optional
|
|
1329
|
+
* Optional
|
|
1330
|
+
*/
|
|
1142
1331
|
interfaceViews?: components["schemas"]["JsInterfaceView"][];
|
|
1143
|
-
/**
|
|
1332
|
+
/**
|
|
1333
|
+
* @description The parties that are notified of this event. When a ``CreatedEvent``
|
|
1144
1334
|
* is returned as part of a transaction tree or ledger-effects transaction, this will include all
|
|
1145
|
-
* the parties specified in the ``TransactionFilter`` that are
|
|
1146
|
-
* of the
|
|
1335
|
+
* the parties specified in the ``TransactionFilter`` that are witnesses of the event
|
|
1336
|
+
* (the stakeholders of the contract and all informees of all the ancestors
|
|
1337
|
+
* of this create action that this participant knows about).
|
|
1338
|
+
* If served as part of a ACS delta transaction those will
|
|
1147
1339
|
* be limited to all parties specified in the ``TransactionFilter`` that
|
|
1148
1340
|
* are stakeholders of the contract (i.e. either signatories or observers).
|
|
1149
1341
|
* If the ``CreatedEvent`` is returned as part of an AssignedEvent,
|
|
@@ -1164,21 +1356,46 @@ export interface components {
|
|
|
1164
1356
|
* ``UpdateFormat``. Using these events, query the ACS as-of an offset where the
|
|
1165
1357
|
* party is hosted on the participant node, and ignore create events at offsets
|
|
1166
1358
|
* where the party is not hosted on the participant node.
|
|
1167
|
-
* Required
|
|
1359
|
+
* Required
|
|
1360
|
+
*/
|
|
1168
1361
|
witnessParties?: string[];
|
|
1169
|
-
/**
|
|
1170
|
-
*
|
|
1362
|
+
/**
|
|
1363
|
+
* @description The signatories for this contract as specified by the template.
|
|
1364
|
+
* Required
|
|
1365
|
+
*/
|
|
1171
1366
|
signatories?: string[];
|
|
1172
|
-
/**
|
|
1367
|
+
/**
|
|
1368
|
+
* @description The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
|
|
1173
1369
|
* This field never contains parties that are signatories.
|
|
1174
|
-
* Required
|
|
1370
|
+
* Required
|
|
1371
|
+
*/
|
|
1175
1372
|
observers?: string[];
|
|
1176
|
-
/**
|
|
1177
|
-
*
|
|
1373
|
+
/**
|
|
1374
|
+
* @description Ledger effective time of the transaction that created the contract.
|
|
1375
|
+
* Required
|
|
1376
|
+
*/
|
|
1178
1377
|
createdAt: string;
|
|
1179
|
-
/**
|
|
1180
|
-
*
|
|
1378
|
+
/**
|
|
1379
|
+
* @description The package name of the created contract.
|
|
1380
|
+
* Required
|
|
1381
|
+
*/
|
|
1181
1382
|
packageName: string;
|
|
1383
|
+
/**
|
|
1384
|
+
* @description A package-id present in the participant package store that typechecks the contract's argument.
|
|
1385
|
+
* This may differ from the package-id of the template used to create the contract.
|
|
1386
|
+
* For contracts created before Canton 3.4, this field matches the contract's creation package-id.
|
|
1387
|
+
*
|
|
1388
|
+
* NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice.
|
|
1389
|
+
*
|
|
1390
|
+
* Required
|
|
1391
|
+
*/
|
|
1392
|
+
representativePackageId: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* @description Whether this event would be part of respective ACS_DELTA shaped stream,
|
|
1395
|
+
* and should therefore considered when tracking contract activeness on the client-side.
|
|
1396
|
+
* Required
|
|
1397
|
+
*/
|
|
1398
|
+
acsDelta: boolean;
|
|
1182
1399
|
};
|
|
1183
1400
|
/** CreatedTreeEvent */
|
|
1184
1401
|
CreatedTreeEvent: {
|
|
@@ -1248,17 +1465,13 @@ export interface components {
|
|
|
1248
1465
|
} | {
|
|
1249
1466
|
Empty: components["schemas"]["Empty3"];
|
|
1250
1467
|
};
|
|
1251
|
-
/**
|
|
1252
|
-
* DeduplicationPeriod
|
|
1253
|
-
* @description Specifies the deduplication period for the change ID (See PrepareSubmissionRequest).
|
|
1254
|
-
* If omitted, the participant will assume the configured maximum deduplication time.
|
|
1255
|
-
*/
|
|
1468
|
+
/** DeduplicationPeriod */
|
|
1256
1469
|
DeduplicationPeriod2: {
|
|
1257
1470
|
DeduplicationDuration: components["schemas"]["DeduplicationDuration2"];
|
|
1258
1471
|
} | {
|
|
1259
1472
|
DeduplicationOffset: components["schemas"]["DeduplicationOffset2"];
|
|
1260
1473
|
} | {
|
|
1261
|
-
Empty: components["schemas"]["
|
|
1474
|
+
Empty: components["schemas"]["Empty10"];
|
|
1262
1475
|
};
|
|
1263
1476
|
/**
|
|
1264
1477
|
* DeleteIdentityProviderConfigResponse
|
|
@@ -1271,20 +1484,31 @@ export interface components {
|
|
|
1271
1484
|
* contract & contract key lookups.
|
|
1272
1485
|
*/
|
|
1273
1486
|
DisclosedContract: {
|
|
1274
|
-
/**
|
|
1487
|
+
/**
|
|
1488
|
+
* @description The template id of the contract.
|
|
1275
1489
|
* The identifier uses the package-id reference format.
|
|
1276
1490
|
*
|
|
1277
|
-
*
|
|
1491
|
+
* If provided, used to validate the template id of the contract serialized in the created_event_blob.
|
|
1492
|
+
* Optional
|
|
1493
|
+
*/
|
|
1278
1494
|
templateId?: string;
|
|
1279
|
-
/**
|
|
1280
|
-
*
|
|
1495
|
+
/**
|
|
1496
|
+
* @description The contract id
|
|
1497
|
+
*
|
|
1498
|
+
* If provided, used to validate the contract id of the contract serialized in the created_event_blob.
|
|
1499
|
+
* Optional
|
|
1500
|
+
*/
|
|
1281
1501
|
contractId: string;
|
|
1282
|
-
/**
|
|
1502
|
+
/**
|
|
1503
|
+
* @description Opaque byte string containing the complete payload required by the Daml engine
|
|
1283
1504
|
* to reconstruct a contract not known to the receiving participant.
|
|
1284
|
-
* Required
|
|
1505
|
+
* Required
|
|
1506
|
+
*/
|
|
1285
1507
|
createdEventBlob: string;
|
|
1286
|
-
/**
|
|
1287
|
-
*
|
|
1508
|
+
/**
|
|
1509
|
+
* @description The ID of the synchronizer where the contract is currently assigned
|
|
1510
|
+
* Optional
|
|
1511
|
+
*/
|
|
1288
1512
|
synchronizerId: string;
|
|
1289
1513
|
};
|
|
1290
1514
|
/** Duration */
|
|
@@ -1301,6 +1525,8 @@ export interface components {
|
|
|
1301
1525
|
/** Empty */
|
|
1302
1526
|
Empty1: Record<string, never>;
|
|
1303
1527
|
/** Empty */
|
|
1528
|
+
Empty10: Record<string, never>;
|
|
1529
|
+
/** Empty */
|
|
1304
1530
|
Empty2: Record<string, never>;
|
|
1305
1531
|
/** Empty */
|
|
1306
1532
|
Empty3: Record<string, never>;
|
|
@@ -1312,6 +1538,10 @@ export interface components {
|
|
|
1312
1538
|
Empty6: Record<string, never>;
|
|
1313
1539
|
/** Empty */
|
|
1314
1540
|
Empty7: Record<string, never>;
|
|
1541
|
+
/** Empty */
|
|
1542
|
+
Empty8: Record<string, never>;
|
|
1543
|
+
/** Empty */
|
|
1544
|
+
Empty9: Record<string, never>;
|
|
1315
1545
|
/**
|
|
1316
1546
|
* Event
|
|
1317
1547
|
* @description Events in transactions can have two primary shapes:
|
|
@@ -1341,7 +1571,8 @@ export interface components {
|
|
|
1341
1571
|
* which is expected to be specified alongside usages of `EventFormat`.
|
|
1342
1572
|
*/
|
|
1343
1573
|
EventFormat: {
|
|
1344
|
-
/**
|
|
1574
|
+
/**
|
|
1575
|
+
* @description Each key must be a valid PartyIdString (as described in ``value.proto``).
|
|
1345
1576
|
* The interpretation of the filter depends on the transaction-shape being filtered:
|
|
1346
1577
|
*
|
|
1347
1578
|
* 1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of
|
|
@@ -1349,39 +1580,67 @@ export interface components {
|
|
|
1349
1580
|
* 2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
|
|
1350
1581
|
* stakeholders include at least one of the listed parties and match the per-party filter.
|
|
1351
1582
|
*
|
|
1352
|
-
* Optional
|
|
1583
|
+
* Optional
|
|
1584
|
+
*/
|
|
1353
1585
|
filtersByParty: components["schemas"]["Map_Filters"];
|
|
1354
|
-
/**
|
|
1586
|
+
/**
|
|
1587
|
+
* @description Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
|
|
1355
1588
|
* with the per-party filter as described above.
|
|
1356
|
-
* Optional
|
|
1589
|
+
* Optional
|
|
1590
|
+
*/
|
|
1357
1591
|
filtersForAnyParty?: components["schemas"]["Filters"];
|
|
1358
|
-
/**
|
|
1592
|
+
/**
|
|
1593
|
+
* @description If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
|
|
1359
1594
|
* In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
|
|
1360
|
-
* Optional
|
|
1595
|
+
* Optional
|
|
1596
|
+
*/
|
|
1361
1597
|
verbose: boolean;
|
|
1362
1598
|
};
|
|
1363
|
-
/**
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
*
|
|
1373
|
-
*
|
|
1374
|
-
* Required
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1599
|
+
/** ExecuteSubmissionAndWaitResponse */
|
|
1600
|
+
ExecuteSubmissionAndWaitResponse: {
|
|
1601
|
+
/**
|
|
1602
|
+
* @description The id of the transaction that resulted from the submitted command.
|
|
1603
|
+
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1604
|
+
* Required
|
|
1605
|
+
*/
|
|
1606
|
+
updateId: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* Format: int64
|
|
1609
|
+
* @description The details of the offset field are described in ``community/ledger-api/README.md``.
|
|
1610
|
+
* Required
|
|
1611
|
+
*/
|
|
1612
|
+
completionOffset: number;
|
|
1613
|
+
};
|
|
1614
|
+
/** ExecuteSubmissionResponse */
|
|
1615
|
+
ExecuteSubmissionResponse: Record<string, never>;
|
|
1616
|
+
/**
|
|
1617
|
+
* ExerciseByKeyCommand
|
|
1618
|
+
* @description Exercise a choice on an existing contract specified by its key.
|
|
1619
|
+
*/
|
|
1620
|
+
ExerciseByKeyCommand: {
|
|
1621
|
+
/**
|
|
1622
|
+
* @description The template of contract the client wants to exercise.
|
|
1623
|
+
* Both package-name and package-id reference identifier formats for the template-id are supported.
|
|
1624
|
+
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
1625
|
+
*
|
|
1626
|
+
* Required
|
|
1627
|
+
*/
|
|
1628
|
+
templateId: string;
|
|
1629
|
+
/**
|
|
1630
|
+
* @description The key of the contract the client wants to exercise upon.
|
|
1631
|
+
* Required
|
|
1632
|
+
*/
|
|
1378
1633
|
contractKey: unknown;
|
|
1379
|
-
/**
|
|
1634
|
+
/**
|
|
1635
|
+
* @description The name of the choice the client wants to exercise.
|
|
1380
1636
|
* Must be a valid NameString (as described in ``value.proto``)
|
|
1381
|
-
* Required
|
|
1637
|
+
* Required
|
|
1638
|
+
*/
|
|
1382
1639
|
choice: string;
|
|
1383
|
-
/**
|
|
1384
|
-
*
|
|
1640
|
+
/**
|
|
1641
|
+
* @description The argument for this choice.
|
|
1642
|
+
* Required
|
|
1643
|
+
*/
|
|
1385
1644
|
choiceArgument: unknown;
|
|
1386
1645
|
};
|
|
1387
1646
|
/**
|
|
@@ -1389,23 +1648,31 @@ export interface components {
|
|
|
1389
1648
|
* @description Exercise a choice on an existing contract.
|
|
1390
1649
|
*/
|
|
1391
1650
|
ExerciseCommand: {
|
|
1392
|
-
/**
|
|
1651
|
+
/**
|
|
1652
|
+
* @description The template or interface of the contract the client wants to exercise.
|
|
1393
1653
|
* Both package-name and package-id reference identifier formats for the template-id are supported.
|
|
1394
1654
|
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
1395
1655
|
* To exercise a choice on an interface, specify the interface identifier in the template_id field.
|
|
1396
1656
|
*
|
|
1397
|
-
* Required
|
|
1657
|
+
* Required
|
|
1658
|
+
*/
|
|
1398
1659
|
templateId: string;
|
|
1399
|
-
/**
|
|
1660
|
+
/**
|
|
1661
|
+
* @description The ID of the contract the client wants to exercise upon.
|
|
1400
1662
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1401
|
-
* Required
|
|
1663
|
+
* Required
|
|
1664
|
+
*/
|
|
1402
1665
|
contractId: string;
|
|
1403
|
-
/**
|
|
1666
|
+
/**
|
|
1667
|
+
* @description The name of the choice the client wants to exercise.
|
|
1404
1668
|
* Must be a valid NameString (as described in ``value.proto``)
|
|
1405
|
-
* Required
|
|
1669
|
+
* Required
|
|
1670
|
+
*/
|
|
1406
1671
|
choice: string;
|
|
1407
|
-
/**
|
|
1408
|
-
*
|
|
1672
|
+
/**
|
|
1673
|
+
* @description The argument for this choice.
|
|
1674
|
+
* Required
|
|
1675
|
+
*/
|
|
1409
1676
|
choiceArgument: unknown;
|
|
1410
1677
|
};
|
|
1411
1678
|
/**
|
|
@@ -1429,46 +1696,70 @@ export interface components {
|
|
|
1429
1696
|
* Required, must be valid node ID (non-negative integer)
|
|
1430
1697
|
*/
|
|
1431
1698
|
nodeId: number;
|
|
1432
|
-
/**
|
|
1699
|
+
/**
|
|
1700
|
+
* @description The ID of the target contract.
|
|
1433
1701
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1434
|
-
* Required
|
|
1702
|
+
* Required
|
|
1703
|
+
*/
|
|
1435
1704
|
contractId: string;
|
|
1436
|
-
/**
|
|
1705
|
+
/**
|
|
1706
|
+
* @description Identifies the template that defines the executed choice.
|
|
1707
|
+
* This template's package-id may differ from the target contract's package-id
|
|
1708
|
+
* if the target contract has been upgraded or downgraded.
|
|
1709
|
+
*
|
|
1437
1710
|
* The identifier uses the package-id reference format.
|
|
1438
1711
|
*
|
|
1439
|
-
* Required
|
|
1712
|
+
* Required
|
|
1713
|
+
*/
|
|
1440
1714
|
templateId: string;
|
|
1441
|
-
/**
|
|
1715
|
+
/**
|
|
1716
|
+
* @description The interface where the choice is defined, if inherited.
|
|
1442
1717
|
* If defined, the identifier uses the package-id reference format.
|
|
1443
1718
|
*
|
|
1444
|
-
* Optional
|
|
1719
|
+
* Optional
|
|
1720
|
+
*/
|
|
1445
1721
|
interfaceId?: string;
|
|
1446
|
-
/**
|
|
1722
|
+
/**
|
|
1723
|
+
* @description The choice that was exercised on the target contract.
|
|
1447
1724
|
* Must be a valid NameString (as described in ``value.proto``).
|
|
1448
|
-
* Required
|
|
1725
|
+
* Required
|
|
1726
|
+
*/
|
|
1449
1727
|
choice: string;
|
|
1450
|
-
/**
|
|
1451
|
-
*
|
|
1728
|
+
/**
|
|
1729
|
+
* @description The argument of the exercised choice.
|
|
1730
|
+
* Required
|
|
1731
|
+
*/
|
|
1452
1732
|
choiceArgument: unknown;
|
|
1453
|
-
/**
|
|
1733
|
+
/**
|
|
1734
|
+
* @description The parties that exercised the choice.
|
|
1454
1735
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
1455
|
-
* Required
|
|
1736
|
+
* Required
|
|
1737
|
+
*/
|
|
1456
1738
|
actingParties?: string[];
|
|
1457
|
-
/**
|
|
1458
|
-
*
|
|
1739
|
+
/**
|
|
1740
|
+
* @description If true, the target contract may no longer be exercised.
|
|
1741
|
+
* Required
|
|
1742
|
+
*/
|
|
1459
1743
|
consuming: boolean;
|
|
1460
|
-
/**
|
|
1744
|
+
/**
|
|
1745
|
+
* @description The parties that are notified of this event. The witnesses of an exercise
|
|
1461
1746
|
* node will depend on whether the exercise was consuming or not.
|
|
1462
|
-
* If consuming, the witnesses are the union of the stakeholders
|
|
1463
|
-
* the actors
|
|
1464
|
-
*
|
|
1465
|
-
*
|
|
1466
|
-
* and
|
|
1747
|
+
* If consuming, the witnesses are the union of the stakeholders,
|
|
1748
|
+
* the actors and all informees of all the ancestors of this event this
|
|
1749
|
+
* participant knows about.
|
|
1750
|
+
* If not consuming, the witnesses are the union of the signatories,
|
|
1751
|
+
* the actors and all informees of all the ancestors of this event this
|
|
1752
|
+
* participant knows about.
|
|
1753
|
+
* In both cases the witnesses are limited to the querying parties, or not
|
|
1754
|
+
* limited in case anyParty filters are used.
|
|
1755
|
+
* Note that the actors might not necessarily be observers
|
|
1756
|
+
* and thus stakeholders. This is the case when the controllers of a
|
|
1467
1757
|
* choice are specified using "flexible controllers", using the
|
|
1468
1758
|
* ``choice ... controller`` syntax, and said controllers are not
|
|
1469
1759
|
* explicitly marked as observers.
|
|
1470
1760
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
1471
|
-
* Required
|
|
1761
|
+
* Required
|
|
1762
|
+
*/
|
|
1472
1763
|
witnessParties?: string[];
|
|
1473
1764
|
/**
|
|
1474
1765
|
* Format: int32
|
|
@@ -1479,20 +1770,32 @@ export interface components {
|
|
|
1479
1770
|
* Required
|
|
1480
1771
|
*/
|
|
1481
1772
|
lastDescendantNodeId: number;
|
|
1482
|
-
/**
|
|
1483
|
-
*
|
|
1773
|
+
/**
|
|
1774
|
+
* @description The result of exercising the choice.
|
|
1775
|
+
* Required
|
|
1776
|
+
*/
|
|
1484
1777
|
exerciseResult: unknown;
|
|
1485
|
-
/**
|
|
1486
|
-
*
|
|
1778
|
+
/**
|
|
1779
|
+
* @description The package name of the contract.
|
|
1780
|
+
* Required
|
|
1781
|
+
*/
|
|
1487
1782
|
packageName: string;
|
|
1488
|
-
/**
|
|
1783
|
+
/**
|
|
1784
|
+
* @description If the event is consuming, the interfaces implemented by the target template that have been
|
|
1489
1785
|
* matched from the interface filter query.
|
|
1490
1786
|
* Populated only in case interface filters with include_interface_view set.
|
|
1491
1787
|
*
|
|
1492
1788
|
* The identifier uses the package-id reference format.
|
|
1493
1789
|
*
|
|
1494
|
-
* Optional
|
|
1790
|
+
* Optional
|
|
1791
|
+
*/
|
|
1495
1792
|
implementedInterfaces?: string[];
|
|
1793
|
+
/**
|
|
1794
|
+
* @description Whether this event would be part of respective ACS_DELTA shaped stream,
|
|
1795
|
+
* and should therefore considered when tracking contract activeness on the client-side.
|
|
1796
|
+
* Required
|
|
1797
|
+
*/
|
|
1798
|
+
acsDelta: boolean;
|
|
1496
1799
|
};
|
|
1497
1800
|
/** ExercisedTreeEvent */
|
|
1498
1801
|
ExercisedTreeEvent: {
|
|
@@ -1522,21 +1825,33 @@ export interface components {
|
|
|
1522
1825
|
};
|
|
1523
1826
|
/** FeaturesDescriptor */
|
|
1524
1827
|
FeaturesDescriptor: {
|
|
1525
|
-
/**
|
|
1828
|
+
/**
|
|
1829
|
+
* @description Features under development or features that are used
|
|
1526
1830
|
* for ledger implementation testing purposes only.
|
|
1527
1831
|
*
|
|
1528
|
-
* Daml applications SHOULD not depend on these in production.
|
|
1832
|
+
* Daml applications SHOULD not depend on these in production.
|
|
1833
|
+
*/
|
|
1529
1834
|
experimental?: components["schemas"]["ExperimentalFeatures"];
|
|
1530
|
-
/**
|
|
1835
|
+
/**
|
|
1836
|
+
* @description If set, then the Ledger API server supports user management.
|
|
1531
1837
|
* It is recommended that clients query this field to gracefully adjust their behavior for
|
|
1532
|
-
* ledgers that do not support user management.
|
|
1838
|
+
* ledgers that do not support user management.
|
|
1839
|
+
*/
|
|
1533
1840
|
userManagement?: components["schemas"]["UserManagementFeature"];
|
|
1534
|
-
/**
|
|
1841
|
+
/**
|
|
1842
|
+
* @description If set, then the Ledger API server supports party management configurability.
|
|
1535
1843
|
* It is recommended that clients query this field to gracefully adjust their behavior to
|
|
1536
|
-
* maximum party page size.
|
|
1844
|
+
* maximum party page size.
|
|
1845
|
+
*/
|
|
1537
1846
|
partyManagement?: components["schemas"]["PartyManagementFeature"];
|
|
1538
1847
|
/** @description It contains the timeouts related to the periodic offset checkpoint emission */
|
|
1539
1848
|
offsetCheckpoint?: components["schemas"]["OffsetCheckpointFeature"];
|
|
1849
|
+
/**
|
|
1850
|
+
* @description If set, then the Ledger API server supports package listing
|
|
1851
|
+
* configurability. It is recommended that clients query this field to
|
|
1852
|
+
* gracefully adjust their behavior to maximum package listing page size.
|
|
1853
|
+
*/
|
|
1854
|
+
packageFeature?: components["schemas"]["PackageFeature"];
|
|
1540
1855
|
};
|
|
1541
1856
|
/** Field */
|
|
1542
1857
|
Field: {
|
|
@@ -1555,20 +1870,24 @@ export interface components {
|
|
|
1555
1870
|
* @description The union of a set of template filters, interface filters, or a wildcard.
|
|
1556
1871
|
*/
|
|
1557
1872
|
Filters: {
|
|
1558
|
-
/**
|
|
1873
|
+
/**
|
|
1874
|
+
* @description Every filter in the cumulative list expands the scope of the resulting stream. Each interface,
|
|
1559
1875
|
* template or wildcard filter means additional events that will match the query.
|
|
1560
1876
|
* The impact of include_interface_view and include_created_event_blob fields in the filters will
|
|
1561
1877
|
* also be accumulated.
|
|
1562
|
-
* At least one cumulative filter MUST be specified.
|
|
1563
1878
|
* A template or an interface SHOULD NOT appear twice in the accumulative field.
|
|
1564
1879
|
* A wildcard filter SHOULD NOT be defined more than once in the accumulative field.
|
|
1565
|
-
* Optional
|
|
1880
|
+
* Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with
|
|
1881
|
+
* include_created_event_blob unset is used.
|
|
1882
|
+
*/
|
|
1566
1883
|
cumulative?: components["schemas"]["CumulativeFilter"][];
|
|
1567
1884
|
};
|
|
1568
1885
|
/** GenerateExternalPartyTopologyRequest */
|
|
1569
1886
|
GenerateExternalPartyTopologyRequest: {
|
|
1570
|
-
/**
|
|
1571
|
-
*
|
|
1887
|
+
/**
|
|
1888
|
+
* @description TODO(#27670) support synchronizer aliases
|
|
1889
|
+
* Required: synchronizer-id for which we are building this request.
|
|
1890
|
+
*/
|
|
1572
1891
|
synchronizer: string;
|
|
1573
1892
|
/** @description Required: the actual party id will be constructed from this hint and a fingerprint of the public key */
|
|
1574
1893
|
partyHint: string;
|
|
@@ -1595,10 +1914,12 @@ export interface components {
|
|
|
1595
1914
|
partyId: string;
|
|
1596
1915
|
/** @description the fingerprint of the supplied public key */
|
|
1597
1916
|
publicKeyFingerprint: string;
|
|
1598
|
-
/**
|
|
1917
|
+
/**
|
|
1918
|
+
* @description The serialized topology transactions which need to be signed and submitted as part of the allocate party process
|
|
1599
1919
|
* Note that the serialization includes the versioning information. Therefore, the transaction here is serialized
|
|
1600
1920
|
* as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version
|
|
1601
|
-
* supported by the synchronizer.
|
|
1921
|
+
* supported by the synchronizer.
|
|
1922
|
+
*/
|
|
1602
1923
|
topologyTransactions?: string[];
|
|
1603
1924
|
/** @description the multi-hash which may be signed instead of each individual transaction */
|
|
1604
1925
|
multiHash: string;
|
|
@@ -1611,14 +1932,18 @@ export interface components {
|
|
|
1611
1932
|
* migration is not concerned with incomplete (un)assignments.
|
|
1612
1933
|
*/
|
|
1613
1934
|
GetActiveContractsRequest: {
|
|
1614
|
-
/**
|
|
1935
|
+
/**
|
|
1936
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1615
1937
|
* Templates to include in the served snapshot, per party.
|
|
1616
|
-
* Optional, if specified event_format must be unset, if not specified event_format must be set.
|
|
1938
|
+
* Optional, if specified event_format must be unset, if not specified event_format must be set.
|
|
1939
|
+
*/
|
|
1617
1940
|
filter?: components["schemas"]["TransactionFilter"];
|
|
1618
|
-
/**
|
|
1941
|
+
/**
|
|
1942
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1619
1943
|
* If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
|
|
1620
1944
|
* In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
|
|
1621
|
-
* Optional, if specified event_format must be unset.
|
|
1945
|
+
* Optional, if specified event_format must be unset.
|
|
1946
|
+
*/
|
|
1622
1947
|
verbose: boolean;
|
|
1623
1948
|
/**
|
|
1624
1949
|
* Format: int64
|
|
@@ -1629,13 +1954,15 @@ export interface components {
|
|
|
1629
1954
|
* If zero, the empty set will be returned.
|
|
1630
1955
|
*/
|
|
1631
1956
|
activeAtOffset: number;
|
|
1632
|
-
/**
|
|
1957
|
+
/**
|
|
1958
|
+
* @description Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
|
|
1633
1959
|
* TRANSACTION_SHAPE_ACS_DELTA.
|
|
1634
1960
|
* Optional for backwards compatibility, defaults to an EventFormat where:
|
|
1635
1961
|
*
|
|
1636
1962
|
* - filters_by_party is the filter.filters_by_party from this request
|
|
1637
1963
|
* - filters_for_any_party is the filter.filters_for_any_party from this request
|
|
1638
|
-
* - verbose is the verbose field from this request
|
|
1964
|
+
* - verbose is the verbose field from this request
|
|
1965
|
+
*/
|
|
1639
1966
|
eventFormat?: components["schemas"]["EventFormat"];
|
|
1640
1967
|
};
|
|
1641
1968
|
/** GetConnectedSynchronizersResponse */
|
|
@@ -1644,22 +1971,15 @@ export interface components {
|
|
|
1644
1971
|
};
|
|
1645
1972
|
/** GetEventsByContractIdRequest */
|
|
1646
1973
|
GetEventsByContractIdRequest: {
|
|
1647
|
-
/**
|
|
1648
|
-
*
|
|
1974
|
+
/**
|
|
1975
|
+
* @description The contract id being queried.
|
|
1976
|
+
* Required
|
|
1977
|
+
*/
|
|
1649
1978
|
contractId: string;
|
|
1650
|
-
/**
|
|
1651
|
-
*
|
|
1652
|
-
*
|
|
1653
|
-
|
|
1654
|
-
* https://docs.daml.com/concepts/ledger-model/ledger-privacy.html#contract-observers-and-stakeholders
|
|
1655
|
-
* Optional, if some parties specified, event_format needs to be unset. */
|
|
1656
|
-
requestingParties?: string[];
|
|
1657
|
-
/** @description Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
|
|
1658
|
-
* Optional for backwards compatibility, defaults to an EventFormat where:
|
|
1659
|
-
*
|
|
1660
|
-
* - filters_by_party is a template-wildcard filter for all requesting_parties
|
|
1661
|
-
* - filters_for_any_party is unset
|
|
1662
|
-
* - verbose is set */
|
|
1979
|
+
/**
|
|
1980
|
+
* @description Format of the events in the result, the presentation will be of TRANSACTION_SHAPE_ACS_DELTA.
|
|
1981
|
+
* Required
|
|
1982
|
+
*/
|
|
1663
1983
|
eventFormat?: components["schemas"]["EventFormat"];
|
|
1664
1984
|
};
|
|
1665
1985
|
/** GetIdentityProviderConfigResponse */
|
|
@@ -1691,7 +2011,8 @@ export interface components {
|
|
|
1691
2011
|
GetLedgerApiVersionResponse: {
|
|
1692
2012
|
/** @description The version of the ledger API. */
|
|
1693
2013
|
version: string;
|
|
1694
|
-
/**
|
|
2014
|
+
/**
|
|
2015
|
+
* @description The features supported by this Ledger API endpoint.
|
|
1695
2016
|
*
|
|
1696
2017
|
* Daml applications CAN use the feature descriptor on top of
|
|
1697
2018
|
* version constraints on the Ledger API version to determine
|
|
@@ -1699,7 +2020,8 @@ export interface components {
|
|
|
1699
2020
|
* required to run the application.
|
|
1700
2021
|
*
|
|
1701
2022
|
* See the feature descriptions themselves for the relation between
|
|
1702
|
-
* Ledger API versions and feature presence.
|
|
2023
|
+
* Ledger API versions and feature presence.
|
|
2024
|
+
*/
|
|
1703
2025
|
features?: components["schemas"]["FeaturesDescriptor"];
|
|
1704
2026
|
};
|
|
1705
2027
|
/** GetLedgerEndResponse */
|
|
@@ -1714,51 +2036,67 @@ export interface components {
|
|
|
1714
2036
|
};
|
|
1715
2037
|
/** GetPackageStatusResponse */
|
|
1716
2038
|
GetPackageStatusResponse: {
|
|
1717
|
-
/**
|
|
1718
|
-
|
|
2039
|
+
/**
|
|
2040
|
+
* @description The status of the package.
|
|
2041
|
+
* @enum {string}
|
|
2042
|
+
*/
|
|
2043
|
+
packageStatus: "PACKAGE_STATUS_UNSPECIFIED" | "PACKAGE_STATUS_REGISTERED";
|
|
1719
2044
|
};
|
|
1720
2045
|
/** GetParticipantIdResponse */
|
|
1721
2046
|
GetParticipantIdResponse: {
|
|
1722
|
-
/**
|
|
1723
|
-
*
|
|
2047
|
+
/**
|
|
2048
|
+
* @description Identifier of the participant, which SHOULD be globally unique.
|
|
2049
|
+
* Must be a valid LedgerString (as describe in ``value.proto``).
|
|
2050
|
+
*/
|
|
1724
2051
|
participantId: string;
|
|
1725
2052
|
};
|
|
1726
2053
|
/** GetPartiesResponse */
|
|
1727
2054
|
GetPartiesResponse: {
|
|
1728
|
-
/**
|
|
2055
|
+
/**
|
|
2056
|
+
* @description The details of the requested Daml parties by the participant, if known.
|
|
1729
2057
|
* The party details may not be in the same order as requested.
|
|
1730
|
-
* Required
|
|
2058
|
+
* Required
|
|
2059
|
+
*/
|
|
1731
2060
|
partyDetails?: components["schemas"]["PartyDetails"][];
|
|
1732
2061
|
};
|
|
1733
2062
|
/** GetPreferredPackageVersionResponse */
|
|
1734
2063
|
GetPreferredPackageVersionResponse: {
|
|
1735
|
-
/**
|
|
1736
|
-
*
|
|
2064
|
+
/**
|
|
2065
|
+
* @description Not populated when no preferred package is found
|
|
2066
|
+
* Optional
|
|
2067
|
+
*/
|
|
1737
2068
|
packagePreference?: components["schemas"]["PackagePreference"];
|
|
1738
2069
|
};
|
|
1739
2070
|
/** GetPreferredPackagesRequest */
|
|
1740
2071
|
GetPreferredPackagesRequest: {
|
|
1741
|
-
/**
|
|
2072
|
+
/**
|
|
2073
|
+
* @description The package-name vetting requirements for which the preferred packages should be resolved.
|
|
1742
2074
|
*
|
|
1743
2075
|
* Generally it is enough to provide the requirements for the intended command's root package-names.
|
|
1744
2076
|
* Additional package-name requirements can be provided when additional Daml transaction informees need to use
|
|
1745
2077
|
* package dependencies of the command's root packages.
|
|
1746
2078
|
*
|
|
1747
|
-
* Required
|
|
2079
|
+
* Required
|
|
2080
|
+
*/
|
|
1748
2081
|
packageVettingRequirements?: components["schemas"]["PackageVettingRequirement"][];
|
|
1749
|
-
/**
|
|
1750
|
-
*
|
|
1751
|
-
*
|
|
2082
|
+
/**
|
|
2083
|
+
* @description The synchronizer whose vetting state should be used for resolving this query.
|
|
2084
|
+
* If not specified, the vetting states of all synchronizers to which the participant is connected are used.
|
|
2085
|
+
* Optional
|
|
2086
|
+
*/
|
|
1752
2087
|
synchronizerId: string;
|
|
1753
|
-
/**
|
|
2088
|
+
/**
|
|
2089
|
+
* @description The timestamp at which the package vetting validity should be computed
|
|
1754
2090
|
* on the latest topology snapshot as seen by the participant.
|
|
1755
2091
|
* If not provided, the participant's current clock time is used.
|
|
1756
|
-
* Optional
|
|
2092
|
+
* Optional
|
|
2093
|
+
*/
|
|
1757
2094
|
vettingValidAt?: string;
|
|
1758
2095
|
};
|
|
1759
2096
|
/** GetPreferredPackagesResponse */
|
|
1760
2097
|
GetPreferredPackagesResponse: {
|
|
1761
|
-
/**
|
|
2098
|
+
/**
|
|
2099
|
+
* @description The package references of the preferred packages.
|
|
1762
2100
|
* Must contain one package reference for each requested package-name.
|
|
1763
2101
|
*
|
|
1764
2102
|
* If you build command submissions whose content depends on the returned
|
|
@@ -1766,42 +2104,49 @@ export interface components {
|
|
|
1766
2104
|
* in the ``package_id_selection_preference`` of the command submission to
|
|
1767
2105
|
* avoid race conditions with concurrent changes of the on-ledger package vetting state.
|
|
1768
2106
|
*
|
|
1769
|
-
* Required
|
|
2107
|
+
* Required
|
|
2108
|
+
*/
|
|
1770
2109
|
packageReferences?: components["schemas"]["PackageReference"][];
|
|
1771
|
-
/**
|
|
2110
|
+
/**
|
|
2111
|
+
* @description The synchronizer for which the package preferences are computed.
|
|
1772
2112
|
* If the synchronizer_id was specified in the request, then it matches the request synchronizer_id.
|
|
1773
|
-
* Required
|
|
2113
|
+
* Required
|
|
2114
|
+
*/
|
|
1774
2115
|
synchronizerId: string;
|
|
1775
2116
|
};
|
|
1776
2117
|
/**
|
|
1777
2118
|
* GetTransactionByIdRequest
|
|
1778
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
2119
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1779
2120
|
*/
|
|
1780
2121
|
GetTransactionByIdRequest: {
|
|
1781
|
-
/**
|
|
2122
|
+
/**
|
|
2123
|
+
* @description The ID of a particular transaction.
|
|
1782
2124
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1783
|
-
* Required
|
|
2125
|
+
* Required
|
|
2126
|
+
*/
|
|
1784
2127
|
updateId: string;
|
|
1785
|
-
/**
|
|
2128
|
+
/**
|
|
2129
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1786
2130
|
* The parties whose events the client expects to see.
|
|
1787
2131
|
* Events that are not visible for the parties in this collection will not be present in the response.
|
|
1788
2132
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
1789
|
-
* Must be set for GetTransactionTreeById request.
|
|
1790
2133
|
* Optional for backwards compatibility for GetTransactionById request: if defined transaction_format must be
|
|
1791
|
-
* unset (falling back to defaults).
|
|
2134
|
+
* unset (falling back to defaults).
|
|
2135
|
+
*/
|
|
1792
2136
|
requestingParties?: string[];
|
|
1793
|
-
/**
|
|
1794
|
-
*
|
|
2137
|
+
/**
|
|
2138
|
+
* @description Optional for GetTransactionById request for backwards compatibility: defaults to a transaction_format, where:
|
|
1795
2139
|
*
|
|
1796
2140
|
* - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties
|
|
1797
2141
|
* - event_format.filters_for_any_party is unset
|
|
1798
2142
|
* - event_format.verbose = true
|
|
1799
|
-
* - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
|
|
2143
|
+
* - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
|
|
2144
|
+
*/
|
|
1800
2145
|
transactionFormat?: components["schemas"]["TransactionFormat"];
|
|
1801
2146
|
};
|
|
1802
2147
|
/**
|
|
1803
2148
|
* GetTransactionByOffsetRequest
|
|
1804
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
2149
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1805
2150
|
*/
|
|
1806
2151
|
GetTransactionByOffsetRequest: {
|
|
1807
2152
|
/**
|
|
@@ -1811,31 +2156,37 @@ export interface components {
|
|
|
1811
2156
|
* Required
|
|
1812
2157
|
*/
|
|
1813
2158
|
offset: number;
|
|
1814
|
-
/**
|
|
2159
|
+
/**
|
|
2160
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1815
2161
|
* The parties whose events the client expects to see.
|
|
1816
2162
|
* Events that are not visible for the parties in this collection will not be present in the response.
|
|
1817
2163
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
1818
|
-
* Must be set for GetTransactionTreeByOffset request.
|
|
1819
2164
|
* Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction_format must be
|
|
1820
|
-
* unset (falling back to defaults).
|
|
2165
|
+
* unset (falling back to defaults).
|
|
2166
|
+
*/
|
|
1821
2167
|
requestingParties?: string[];
|
|
1822
|
-
/**
|
|
1823
|
-
*
|
|
2168
|
+
/**
|
|
2169
|
+
* @description Optional for GetTransactionByOffset request for backwards compatibility: defaults to a TransactionFormat, where:
|
|
1824
2170
|
*
|
|
1825
2171
|
* - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties
|
|
1826
2172
|
* - event_format.filters_for_any_party is unset
|
|
1827
2173
|
* - event_format.verbose = true
|
|
1828
|
-
* - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
|
|
2174
|
+
* - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
|
|
2175
|
+
*/
|
|
1829
2176
|
transactionFormat?: components["schemas"]["TransactionFormat"];
|
|
1830
2177
|
};
|
|
1831
2178
|
/** GetUpdateByIdRequest */
|
|
1832
2179
|
GetUpdateByIdRequest: {
|
|
1833
|
-
/**
|
|
2180
|
+
/**
|
|
2181
|
+
* @description The ID of a particular update.
|
|
1834
2182
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
1835
|
-
* Required
|
|
2183
|
+
* Required
|
|
2184
|
+
*/
|
|
1836
2185
|
updateId: string;
|
|
1837
|
-
/**
|
|
1838
|
-
*
|
|
2186
|
+
/**
|
|
2187
|
+
* @description The format for the update.
|
|
2188
|
+
* Required
|
|
2189
|
+
*/
|
|
1839
2190
|
updateFormat?: components["schemas"]["UpdateFormat"];
|
|
1840
2191
|
};
|
|
1841
2192
|
/** GetUpdateByOffsetRequest */
|
|
@@ -1847,8 +2198,10 @@ export interface components {
|
|
|
1847
2198
|
* Required
|
|
1848
2199
|
*/
|
|
1849
2200
|
offset: number;
|
|
1850
|
-
/**
|
|
1851
|
-
*
|
|
2201
|
+
/**
|
|
2202
|
+
* @description The format for the update.
|
|
2203
|
+
* Required
|
|
2204
|
+
*/
|
|
1852
2205
|
updateFormat?: components["schemas"]["UpdateFormat"];
|
|
1853
2206
|
};
|
|
1854
2207
|
/** GetUpdatesRequest */
|
|
@@ -1870,18 +2223,23 @@ export interface components {
|
|
|
1870
2223
|
* If specified, the stream will terminate after this absolute offset (positive integer) is reached.
|
|
1871
2224
|
*/
|
|
1872
2225
|
endInclusive?: number;
|
|
1873
|
-
/**
|
|
2226
|
+
/**
|
|
2227
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1874
2228
|
* Requesting parties with template filters.
|
|
1875
2229
|
* Template filters must be empty for GetUpdateTrees requests.
|
|
1876
|
-
* Optional for backwards compatibility, if defined update_format must be unset
|
|
2230
|
+
* Optional for backwards compatibility, if defined update_format must be unset
|
|
2231
|
+
*/
|
|
1877
2232
|
filter?: components["schemas"]["TransactionFilter"];
|
|
1878
|
-
/**
|
|
2233
|
+
/**
|
|
2234
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
1879
2235
|
* If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
|
|
1880
2236
|
* In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids
|
|
1881
2237
|
* for record fields.
|
|
1882
|
-
* Optional for backwards compatibility, if defined update_format must be unset
|
|
2238
|
+
* Optional for backwards compatibility, if defined update_format must be unset
|
|
2239
|
+
*/
|
|
1883
2240
|
verbose: boolean;
|
|
1884
|
-
/**
|
|
2241
|
+
/**
|
|
2242
|
+
* @description Must be unset for GetUpdateTrees request.
|
|
1885
2243
|
* Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:
|
|
1886
2244
|
*
|
|
1887
2245
|
* - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request
|
|
@@ -1890,7 +2248,8 @@ export interface components {
|
|
|
1890
2248
|
* - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
|
|
1891
2249
|
* - include_reassignments.filter = the same filter specified on this request
|
|
1892
2250
|
* - include_reassignments.verbose = the same flag specified on this request
|
|
1893
|
-
* - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
|
|
2251
|
+
* - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter
|
|
2252
|
+
*/
|
|
1894
2253
|
updateFormat?: components["schemas"]["UpdateFormat"];
|
|
1895
2254
|
};
|
|
1896
2255
|
/** GetUserResponse */
|
|
@@ -1905,14 +2264,20 @@ export interface components {
|
|
|
1905
2264
|
* Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``
|
|
1906
2265
|
*/
|
|
1907
2266
|
GrantUserRightsRequest: {
|
|
1908
|
-
/**
|
|
1909
|
-
*
|
|
2267
|
+
/**
|
|
2268
|
+
* @description The user to whom to grant rights.
|
|
2269
|
+
* Required
|
|
2270
|
+
*/
|
|
1910
2271
|
userId: string;
|
|
1911
|
-
/**
|
|
1912
|
-
*
|
|
2272
|
+
/**
|
|
2273
|
+
* @description The rights to grant.
|
|
2274
|
+
* Optional
|
|
2275
|
+
*/
|
|
1913
2276
|
rights?: components["schemas"]["Right"][];
|
|
1914
|
-
/**
|
|
1915
|
-
*
|
|
2277
|
+
/**
|
|
2278
|
+
* @description The id of the ``Identity Provider``
|
|
2279
|
+
* Optional, if not set, assume the user is managed by the default identity provider.
|
|
2280
|
+
*/
|
|
1916
2281
|
identityProviderId: string;
|
|
1917
2282
|
};
|
|
1918
2283
|
/** GrantUserRightsResponse */
|
|
@@ -1944,32 +2309,42 @@ export interface components {
|
|
|
1944
2309
|
IdentityProviderAdmin1: Record<string, never>;
|
|
1945
2310
|
/** IdentityProviderConfig */
|
|
1946
2311
|
IdentityProviderConfig: {
|
|
1947
|
-
/**
|
|
2312
|
+
/**
|
|
2313
|
+
* @description The identity provider identifier
|
|
1948
2314
|
* Must be a valid LedgerString (as describe in ``value.proto``).
|
|
1949
|
-
* Required
|
|
2315
|
+
* Required
|
|
2316
|
+
*/
|
|
1950
2317
|
identityProviderId: string;
|
|
1951
|
-
/**
|
|
2318
|
+
/**
|
|
2319
|
+
* @description When set, the callers using JWT tokens issued by this identity provider are denied all access
|
|
1952
2320
|
* to the Ledger API.
|
|
1953
2321
|
* Optional,
|
|
1954
|
-
* Modifiable
|
|
2322
|
+
* Modifiable
|
|
2323
|
+
*/
|
|
1955
2324
|
isDeactivated: boolean;
|
|
1956
|
-
/**
|
|
2325
|
+
/**
|
|
2326
|
+
* @description Specifies the issuer of the JWT token.
|
|
1957
2327
|
* The issuer value is a case sensitive URL using the https scheme that contains scheme, host,
|
|
1958
2328
|
* and optionally, port number and path components and no query or fragment components.
|
|
1959
2329
|
* Required
|
|
1960
|
-
* Modifiable
|
|
2330
|
+
* Modifiable
|
|
2331
|
+
*/
|
|
1961
2332
|
issuer: string;
|
|
1962
|
-
/**
|
|
2333
|
+
/**
|
|
2334
|
+
* @description The JWKS (JSON Web Key Set) URL.
|
|
1963
2335
|
* The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been
|
|
1964
2336
|
* signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported.
|
|
1965
2337
|
* Required
|
|
1966
|
-
* Modifiable
|
|
2338
|
+
* Modifiable
|
|
2339
|
+
*/
|
|
1967
2340
|
jwksUrl: string;
|
|
1968
|
-
/**
|
|
2341
|
+
/**
|
|
2342
|
+
* @description Specifies the audience of the JWT token.
|
|
1969
2343
|
* When set, the callers using JWT tokens issued by this identity provider are allowed to get an access
|
|
1970
2344
|
* only if the "aud" claim includes the string specified here
|
|
1971
2345
|
* Optional,
|
|
1972
|
-
* Modifiable
|
|
2346
|
+
* Modifiable
|
|
2347
|
+
*/
|
|
1973
2348
|
audience: string;
|
|
1974
2349
|
};
|
|
1975
2350
|
/**
|
|
@@ -1984,35 +2359,45 @@ export interface components {
|
|
|
1984
2359
|
* @description This filter matches contracts that implement a specific interface.
|
|
1985
2360
|
*/
|
|
1986
2361
|
InterfaceFilter1: {
|
|
1987
|
-
/**
|
|
2362
|
+
/**
|
|
2363
|
+
* @description The interface that a matching contract must implement.
|
|
1988
2364
|
* The ``interface_id`` needs to be valid: corresponding interface should be defined in
|
|
1989
2365
|
* one of the available packages at the time of the query.
|
|
1990
2366
|
* Both package-name and package-id reference formats for the identifier are supported.
|
|
1991
2367
|
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
1992
2368
|
*
|
|
1993
|
-
* Required
|
|
2369
|
+
* Required
|
|
2370
|
+
*/
|
|
1994
2371
|
interfaceId?: string;
|
|
1995
|
-
/**
|
|
2372
|
+
/**
|
|
2373
|
+
* @description Whether to include the interface view on the contract in the returned ``CreatedEvent``.
|
|
1996
2374
|
* Use this to access contract data in a uniform manner in your API client.
|
|
1997
|
-
* Optional
|
|
2375
|
+
* Optional
|
|
2376
|
+
*/
|
|
1998
2377
|
includeInterfaceView: boolean;
|
|
1999
|
-
/**
|
|
2378
|
+
/**
|
|
2379
|
+
* @description Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
|
|
2000
2380
|
* Use this to access the contract create event payload in your API client
|
|
2001
2381
|
* for submitting it as a disclosed contract with future commands.
|
|
2002
|
-
* Optional
|
|
2382
|
+
* Optional
|
|
2383
|
+
*/
|
|
2003
2384
|
includeCreatedEventBlob: boolean;
|
|
2004
2385
|
};
|
|
2005
2386
|
/** JsActiveContract */
|
|
2006
2387
|
JsActiveContract: {
|
|
2007
|
-
/**
|
|
2388
|
+
/**
|
|
2389
|
+
* @description Required
|
|
2008
2390
|
* The event as it appeared in the context of its last update (i.e. daml transaction or
|
|
2009
2391
|
* reassignment). In particular, the last offset, node_id pair is preserved.
|
|
2010
2392
|
* The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer.
|
|
2011
2393
|
* The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
|
|
2012
|
-
* for lookups.
|
|
2394
|
+
* for lookups.
|
|
2395
|
+
*/
|
|
2013
2396
|
createdEvent: components["schemas"]["CreatedEvent"];
|
|
2014
|
-
/**
|
|
2015
|
-
*
|
|
2397
|
+
/**
|
|
2398
|
+
* @description A valid synchronizer id
|
|
2399
|
+
* Required
|
|
2400
|
+
*/
|
|
2016
2401
|
synchronizerId: string;
|
|
2017
2402
|
/**
|
|
2018
2403
|
* Format: int64
|
|
@@ -2029,8 +2414,10 @@ export interface components {
|
|
|
2029
2414
|
JsArchived: {
|
|
2030
2415
|
/** @description Required */
|
|
2031
2416
|
archivedEvent: components["schemas"]["ArchivedEvent"];
|
|
2032
|
-
/**
|
|
2033
|
-
*
|
|
2417
|
+
/**
|
|
2418
|
+
* @description Required
|
|
2419
|
+
* The synchronizer which sequenced the archival of the contract
|
|
2420
|
+
*/
|
|
2034
2421
|
synchronizerId: string;
|
|
2035
2422
|
};
|
|
2036
2423
|
/**
|
|
@@ -2038,24 +2425,31 @@ export interface components {
|
|
|
2038
2425
|
* @description Records that a contract has been assigned, and it can be used on the target synchronizer.
|
|
2039
2426
|
*/
|
|
2040
2427
|
JsAssignedEvent: {
|
|
2041
|
-
/**
|
|
2428
|
+
/**
|
|
2429
|
+
* @description The ID of the source synchronizer.
|
|
2042
2430
|
* Must be a valid synchronizer id.
|
|
2043
|
-
* Required
|
|
2431
|
+
* Required
|
|
2432
|
+
*/
|
|
2044
2433
|
source: string;
|
|
2045
|
-
/**
|
|
2434
|
+
/**
|
|
2435
|
+
* @description The ID of the target synchronizer.
|
|
2046
2436
|
* Must be a valid synchronizer id.
|
|
2047
|
-
* Required
|
|
2437
|
+
* Required
|
|
2438
|
+
*/
|
|
2048
2439
|
target: string;
|
|
2049
|
-
/**
|
|
2440
|
+
/**
|
|
2441
|
+
* @description The ID from the unassigned event.
|
|
2050
2442
|
* For correlation capabilities.
|
|
2051
|
-
* For one contract the (unassign_id, source synchronizer) pair is unique.
|
|
2052
2443
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2053
|
-
* Required
|
|
2054
|
-
|
|
2055
|
-
|
|
2444
|
+
* Required
|
|
2445
|
+
*/
|
|
2446
|
+
reassignmentId: string;
|
|
2447
|
+
/**
|
|
2448
|
+
* @description Party on whose behalf the assign command was executed.
|
|
2056
2449
|
* Empty if the assignment happened offline via the repair service.
|
|
2057
2450
|
* Must be a valid PartyIdString (as described in ``value.proto``).
|
|
2058
|
-
* Optional
|
|
2451
|
+
* Optional
|
|
2452
|
+
*/
|
|
2059
2453
|
submitter: string;
|
|
2060
2454
|
/**
|
|
2061
2455
|
* Format: int64
|
|
@@ -2065,16 +2459,18 @@ export interface components {
|
|
|
2065
2459
|
* Required
|
|
2066
2460
|
*/
|
|
2067
2461
|
reassignmentCounter: number;
|
|
2068
|
-
/**
|
|
2462
|
+
/**
|
|
2463
|
+
* @description Required
|
|
2069
2464
|
* The offset of this event refers to the offset of the assignment,
|
|
2070
|
-
* while the node_id is the index of within the batch.
|
|
2465
|
+
* while the node_id is the index of within the batch.
|
|
2466
|
+
*/
|
|
2071
2467
|
createdEvent: components["schemas"]["CreatedEvent"];
|
|
2072
2468
|
};
|
|
2073
2469
|
/** JsAssignmentEvent */
|
|
2074
2470
|
JsAssignmentEvent: {
|
|
2075
2471
|
source: string;
|
|
2076
2472
|
target: string;
|
|
2077
|
-
|
|
2473
|
+
reassignmentId: string;
|
|
2078
2474
|
submitter: string;
|
|
2079
2475
|
/** Format: int64 */
|
|
2080
2476
|
reassignmentCounter: number;
|
|
@@ -2100,28 +2496,37 @@ export interface components {
|
|
|
2100
2496
|
* @description A composite command that groups multiple commands together.
|
|
2101
2497
|
*/
|
|
2102
2498
|
JsCommands: {
|
|
2103
|
-
/**
|
|
2104
|
-
*
|
|
2499
|
+
/**
|
|
2500
|
+
* @description Individual elements of this atomic command. Must be non-empty.
|
|
2501
|
+
* Required
|
|
2502
|
+
*/
|
|
2105
2503
|
commands?: components["schemas"]["Command"][];
|
|
2106
|
-
/**
|
|
2504
|
+
/**
|
|
2505
|
+
* @description Uniquely identifies the command.
|
|
2107
2506
|
* The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,
|
|
2108
2507
|
* where act_as is interpreted as a set of party names.
|
|
2109
2508
|
* The change ID can be used for matching the intended ledger changes with all their completions.
|
|
2110
2509
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2111
|
-
* Required
|
|
2510
|
+
* Required
|
|
2511
|
+
*/
|
|
2112
2512
|
commandId: string;
|
|
2113
|
-
/**
|
|
2513
|
+
/**
|
|
2514
|
+
* @description Set of parties on whose behalf the command should be executed.
|
|
2114
2515
|
* If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
|
|
2115
2516
|
* to act on behalf of each of the given parties.
|
|
2116
2517
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
2117
|
-
* Required, must be non-empty.
|
|
2518
|
+
* Required, must be non-empty.
|
|
2519
|
+
*/
|
|
2118
2520
|
actAs?: string[];
|
|
2119
|
-
/**
|
|
2521
|
+
/**
|
|
2522
|
+
* @description Uniquely identifies the participant user that issued the command.
|
|
2120
2523
|
* Must be a valid UserIdString (as described in ``value.proto``).
|
|
2121
2524
|
* Required unless authentication is used with a user token.
|
|
2122
|
-
* In that case, the token's user-id will be used for the request's user_id.
|
|
2525
|
+
* In that case, the token's user-id will be used for the request's user_id.
|
|
2526
|
+
*/
|
|
2123
2527
|
userId?: string;
|
|
2124
|
-
/**
|
|
2528
|
+
/**
|
|
2529
|
+
* @description Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
|
|
2125
2530
|
* This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
|
|
2126
2531
|
* Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant
|
|
2127
2532
|
* node is only visible to a subset of these parties. A command can only use contracts that are visible to at least
|
|
@@ -2129,44 +2534,67 @@ export interface components {
|
|
|
2129
2534
|
* rules for fetch operations.
|
|
2130
2535
|
* If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
|
|
2131
2536
|
* to read contract data on behalf of each of the given parties.
|
|
2132
|
-
* Optional
|
|
2537
|
+
* Optional
|
|
2538
|
+
*/
|
|
2133
2539
|
readAs?: string[];
|
|
2134
|
-
/**
|
|
2540
|
+
/**
|
|
2541
|
+
* @description Identifier of the on-ledger workflow that this command is a part of.
|
|
2135
2542
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2136
|
-
* Optional
|
|
2543
|
+
* Optional
|
|
2544
|
+
*/
|
|
2137
2545
|
workflowId?: string;
|
|
2138
2546
|
deduplicationPeriod?: components["schemas"]["DeduplicationPeriod"];
|
|
2139
|
-
/**
|
|
2547
|
+
/**
|
|
2548
|
+
* @description Lower bound for the ledger time assigned to the resulting transaction.
|
|
2140
2549
|
* Note: The ledger time of a transaction is assigned as part of command interpretation.
|
|
2141
2550
|
* Use this property if you expect that command interpretation will take a considerate amount of time, such that by
|
|
2142
2551
|
* the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore.
|
|
2143
2552
|
* Must not be set at the same time as min_ledger_time_rel.
|
|
2144
|
-
* Optional
|
|
2553
|
+
* Optional
|
|
2554
|
+
*/
|
|
2145
2555
|
minLedgerTimeAbs?: string;
|
|
2146
|
-
/**
|
|
2556
|
+
/**
|
|
2557
|
+
* @description Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server.
|
|
2147
2558
|
* Must not be set at the same time as min_ledger_time_abs.
|
|
2148
|
-
* Optional
|
|
2559
|
+
* Optional
|
|
2560
|
+
*/
|
|
2149
2561
|
minLedgerTimeRel?: components["schemas"]["Duration"];
|
|
2150
|
-
/**
|
|
2562
|
+
/**
|
|
2563
|
+
* @description A unique identifier to distinguish completions for different submissions with the same change ID.
|
|
2151
2564
|
* Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
|
|
2152
2565
|
* with the same change ID.
|
|
2153
2566
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2154
2567
|
*
|
|
2155
2568
|
* If omitted, the participant or the committer may set a value of their choice.
|
|
2156
|
-
* Optional
|
|
2569
|
+
* Optional
|
|
2570
|
+
*/
|
|
2157
2571
|
submissionId?: string;
|
|
2158
|
-
/**
|
|
2159
|
-
*
|
|
2572
|
+
/**
|
|
2573
|
+
* @description Additional contracts used to resolve contract & contract key lookups.
|
|
2574
|
+
* Optional
|
|
2575
|
+
*/
|
|
2160
2576
|
disclosedContracts?: components["schemas"]["DisclosedContract"][];
|
|
2161
|
-
/**
|
|
2162
|
-
*
|
|
2577
|
+
/**
|
|
2578
|
+
* @description Must be a valid synchronizer id
|
|
2579
|
+
* Optional
|
|
2580
|
+
*/
|
|
2163
2581
|
synchronizerId?: string;
|
|
2164
|
-
/**
|
|
2165
|
-
*
|
|
2582
|
+
/**
|
|
2583
|
+
* @description The package-id selection preference of the client for resolving
|
|
2584
|
+
* package names and interface instances in command submission and interpretation
|
|
2585
|
+
*/
|
|
2166
2586
|
packageIdSelectionPreference?: string[];
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2587
|
+
/**
|
|
2588
|
+
* @description Fetches the contract keys into the caches to speed up the command processing.
|
|
2589
|
+
* Should only contain contract keys that are expected to be resolved during interpretation of the commands.
|
|
2590
|
+
* Keys of disclosed contracts do not need prefetching.
|
|
2591
|
+
*
|
|
2592
|
+
* Optional
|
|
2593
|
+
*/
|
|
2594
|
+
prefetchContractKeys?: components["schemas"]["PrefetchContractKey"][];
|
|
2595
|
+
};
|
|
2596
|
+
/**
|
|
2597
|
+
* JsContractEntry
|
|
2170
2598
|
* @description For a contract there could be multiple contract_entry-s in the entire snapshot. These together define
|
|
2171
2599
|
* the state of one contract in the snapshot.
|
|
2172
2600
|
* A contract_entry is included in the result, if and only if there is at least one stakeholder party of the contract
|
|
@@ -2184,68 +2612,203 @@ export interface components {
|
|
|
2184
2612
|
};
|
|
2185
2613
|
/** JsCreated */
|
|
2186
2614
|
JsCreated: {
|
|
2187
|
-
/**
|
|
2615
|
+
/**
|
|
2616
|
+
* @description Required
|
|
2188
2617
|
* The event as it appeared in the context of its original update (i.e. daml transaction or
|
|
2189
2618
|
* reassignment) on this participant node. You can use its offset and node_id to find the
|
|
2190
|
-
* corresponding update and the node within it.
|
|
2619
|
+
* corresponding update and the node within it.
|
|
2620
|
+
*/
|
|
2191
2621
|
createdEvent: components["schemas"]["CreatedEvent"];
|
|
2192
|
-
/**
|
|
2193
|
-
*
|
|
2622
|
+
/**
|
|
2623
|
+
* @description The synchronizer which sequenced the creation of the contract
|
|
2624
|
+
* Required
|
|
2625
|
+
*/
|
|
2194
2626
|
synchronizerId: string;
|
|
2195
2627
|
};
|
|
2196
2628
|
/** JsEmpty */
|
|
2197
2629
|
JsEmpty: Record<string, never>;
|
|
2630
|
+
/** JsExecuteSubmissionAndWaitForTransactionRequest */
|
|
2631
|
+
JsExecuteSubmissionAndWaitForTransactionRequest: {
|
|
2632
|
+
/**
|
|
2633
|
+
* @description the prepared transaction
|
|
2634
|
+
* Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`
|
|
2635
|
+
* obtained from calling `prepareSubmission`.
|
|
2636
|
+
* Required
|
|
2637
|
+
*/
|
|
2638
|
+
preparedTransaction?: string;
|
|
2639
|
+
/**
|
|
2640
|
+
* @description The party(ies) signatures that authorize the prepared submission to be executed by this node.
|
|
2641
|
+
* Each party can provide one or more signatures..
|
|
2642
|
+
* and one or more parties can sign.
|
|
2643
|
+
* Note that currently, only single party submissions are supported.
|
|
2644
|
+
* Required
|
|
2645
|
+
*/
|
|
2646
|
+
partySignatures?: components["schemas"]["PartySignatures"];
|
|
2647
|
+
deduplicationPeriod: components["schemas"]["DeduplicationPeriod2"];
|
|
2648
|
+
/**
|
|
2649
|
+
* @description A unique identifier to distinguish completions for different submissions with the same change ID.
|
|
2650
|
+
* Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
|
|
2651
|
+
* with the same change ID.
|
|
2652
|
+
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2653
|
+
*
|
|
2654
|
+
* Required
|
|
2655
|
+
*/
|
|
2656
|
+
submissionId: string;
|
|
2657
|
+
/**
|
|
2658
|
+
* @description See [PrepareSubmissionRequest.user_id]
|
|
2659
|
+
* Optional
|
|
2660
|
+
*/
|
|
2661
|
+
userId: string;
|
|
2662
|
+
/**
|
|
2663
|
+
* @description The hashing scheme version used when building the hash
|
|
2664
|
+
* Required
|
|
2665
|
+
* @enum {string}
|
|
2666
|
+
*/
|
|
2667
|
+
hashingSchemeVersion: "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2";
|
|
2668
|
+
/**
|
|
2669
|
+
* @description If set will influence the chosen ledger effective time but will not result in a submission delay so any override
|
|
2670
|
+
* should be scheduled to executed within the window allowed by synchronizer.
|
|
2671
|
+
* Optional
|
|
2672
|
+
*/
|
|
2673
|
+
minLedgerTime?: components["schemas"]["MinLedgerTime"];
|
|
2674
|
+
/**
|
|
2675
|
+
* @description If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to
|
|
2676
|
+
* TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template
|
|
2677
|
+
* filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set.
|
|
2678
|
+
* When the ``transaction_shape`` TRANSACTION_SHAPE_ACS_DELTA shape is used (explicitly or is defaulted to as explained above),
|
|
2679
|
+
* events will only be returned if the submitting party is hosted on this node.
|
|
2680
|
+
* Optional
|
|
2681
|
+
*/
|
|
2682
|
+
transactionFormat?: components["schemas"]["TransactionFormat"];
|
|
2683
|
+
};
|
|
2684
|
+
/** JsExecuteSubmissionAndWaitForTransactionResponse */
|
|
2685
|
+
JsExecuteSubmissionAndWaitForTransactionResponse: {
|
|
2686
|
+
/**
|
|
2687
|
+
* @description The transaction that resulted from the submitted command.
|
|
2688
|
+
* The transaction might contain no events (request conditions result in filtering out all of them).
|
|
2689
|
+
* Required
|
|
2690
|
+
*/
|
|
2691
|
+
transaction: components["schemas"]["JsTransaction"];
|
|
2692
|
+
};
|
|
2693
|
+
/** JsExecuteSubmissionAndWaitRequest */
|
|
2694
|
+
JsExecuteSubmissionAndWaitRequest: {
|
|
2695
|
+
/**
|
|
2696
|
+
* @description the prepared transaction
|
|
2697
|
+
* Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`
|
|
2698
|
+
* obtained from calling `prepareSubmission`.
|
|
2699
|
+
* Required
|
|
2700
|
+
*/
|
|
2701
|
+
preparedTransaction?: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* @description The party(ies) signatures that authorize the prepared submission to be executed by this node.
|
|
2704
|
+
* Each party can provide one or more signatures..
|
|
2705
|
+
* and one or more parties can sign.
|
|
2706
|
+
* Note that currently, only single party submissions are supported.
|
|
2707
|
+
* Required
|
|
2708
|
+
*/
|
|
2709
|
+
partySignatures?: components["schemas"]["PartySignatures"];
|
|
2710
|
+
deduplicationPeriod: components["schemas"]["DeduplicationPeriod2"];
|
|
2711
|
+
/**
|
|
2712
|
+
* @description A unique identifier to distinguish completions for different submissions with the same change ID.
|
|
2713
|
+
* Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
|
|
2714
|
+
* with the same change ID.
|
|
2715
|
+
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2716
|
+
*
|
|
2717
|
+
* Required
|
|
2718
|
+
*/
|
|
2719
|
+
submissionId: string;
|
|
2720
|
+
/**
|
|
2721
|
+
* @description See [PrepareSubmissionRequest.user_id]
|
|
2722
|
+
* Optional
|
|
2723
|
+
*/
|
|
2724
|
+
userId: string;
|
|
2725
|
+
/**
|
|
2726
|
+
* @description The hashing scheme version used when building the hash
|
|
2727
|
+
* Required
|
|
2728
|
+
* @enum {string}
|
|
2729
|
+
*/
|
|
2730
|
+
hashingSchemeVersion: "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2";
|
|
2731
|
+
/**
|
|
2732
|
+
* @description If set will influence the chosen ledger effective time but will not result in a submission delay so any override
|
|
2733
|
+
* should be scheduled to executed within the window allowed by synchronizer.
|
|
2734
|
+
* Optional
|
|
2735
|
+
*/
|
|
2736
|
+
minLedgerTime?: components["schemas"]["MinLedgerTime"];
|
|
2737
|
+
};
|
|
2198
2738
|
/** JsExecuteSubmissionRequest */
|
|
2199
2739
|
JsExecuteSubmissionRequest: {
|
|
2200
|
-
/**
|
|
2740
|
+
/**
|
|
2741
|
+
* @description the prepared transaction
|
|
2201
2742
|
* Typically this is the value of the `prepared_transaction` field in `PrepareSubmissionResponse`
|
|
2202
|
-
* obtained from calling `prepareSubmission`.
|
|
2743
|
+
* obtained from calling `prepareSubmission`.
|
|
2744
|
+
* Required
|
|
2745
|
+
*/
|
|
2203
2746
|
preparedTransaction?: string;
|
|
2204
|
-
/**
|
|
2747
|
+
/**
|
|
2748
|
+
* @description The party(ies) signatures that authorize the prepared submission to be executed by this node.
|
|
2205
2749
|
* Each party can provide one or more signatures..
|
|
2206
2750
|
* and one or more parties can sign.
|
|
2207
|
-
* Note that currently, only single party submissions are supported.
|
|
2751
|
+
* Note that currently, only single party submissions are supported.
|
|
2752
|
+
* Required
|
|
2753
|
+
*/
|
|
2208
2754
|
partySignatures?: components["schemas"]["PartySignatures"];
|
|
2209
2755
|
deduplicationPeriod: components["schemas"]["DeduplicationPeriod2"];
|
|
2210
|
-
/**
|
|
2756
|
+
/**
|
|
2757
|
+
* @description A unique identifier to distinguish completions for different submissions with the same change ID.
|
|
2211
2758
|
* Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
|
|
2212
2759
|
* with the same change ID.
|
|
2213
2760
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2214
2761
|
*
|
|
2215
|
-
* Required
|
|
2762
|
+
* Required
|
|
2763
|
+
*/
|
|
2216
2764
|
submissionId: string;
|
|
2217
|
-
/**
|
|
2765
|
+
/**
|
|
2766
|
+
* @description See [PrepareSubmissionRequest.user_id]
|
|
2767
|
+
* Optional
|
|
2768
|
+
*/
|
|
2218
2769
|
userId: string;
|
|
2219
|
-
/**
|
|
2220
|
-
|
|
2221
|
-
|
|
2770
|
+
/**
|
|
2771
|
+
* @description The hashing scheme version used when building the hash
|
|
2772
|
+
* Required
|
|
2773
|
+
* @enum {string}
|
|
2774
|
+
*/
|
|
2775
|
+
hashingSchemeVersion: "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2";
|
|
2776
|
+
/**
|
|
2777
|
+
* @description If set will influence the chosen ledger effective time but will not result in a submission delay so any override
|
|
2222
2778
|
* should be scheduled to executed within the window allowed by synchronizer.
|
|
2223
|
-
* Optional
|
|
2779
|
+
* Optional
|
|
2780
|
+
*/
|
|
2224
2781
|
minLedgerTime?: components["schemas"]["MinLedgerTime"];
|
|
2225
2782
|
};
|
|
2226
2783
|
/** JsGetActiveContractsResponse */
|
|
2227
2784
|
JsGetActiveContractsResponse: {
|
|
2228
|
-
/**
|
|
2785
|
+
/**
|
|
2786
|
+
* @description The workflow ID used in command submission which corresponds to the contract_entry. Only set if
|
|
2229
2787
|
* the ``workflow_id`` for the command was set.
|
|
2230
2788
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2231
|
-
* Optional
|
|
2789
|
+
* Optional
|
|
2790
|
+
*/
|
|
2232
2791
|
workflowId: string;
|
|
2233
2792
|
contractEntry: components["schemas"]["JsContractEntry"];
|
|
2234
2793
|
};
|
|
2235
2794
|
/** JsGetEventsByContractIdResponse */
|
|
2236
2795
|
JsGetEventsByContractIdResponse: {
|
|
2237
|
-
/**
|
|
2796
|
+
/**
|
|
2797
|
+
* @description The create event for the contract with the ``contract_id`` given in the request
|
|
2238
2798
|
* provided it exists and has not yet been pruned.
|
|
2239
|
-
* Optional
|
|
2799
|
+
* Optional
|
|
2800
|
+
*/
|
|
2240
2801
|
created?: components["schemas"]["JsCreated"];
|
|
2241
|
-
/**
|
|
2802
|
+
/**
|
|
2803
|
+
* @description The archive event for the contract with the ``contract_id`` given in the request
|
|
2242
2804
|
* provided such an archive event exists and it has not yet been pruned.
|
|
2243
|
-
* Optional
|
|
2805
|
+
* Optional
|
|
2806
|
+
*/
|
|
2244
2807
|
archived?: components["schemas"]["JsArchived"];
|
|
2245
2808
|
};
|
|
2246
2809
|
/**
|
|
2247
2810
|
* JsGetTransactionResponse
|
|
2248
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
2811
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
2249
2812
|
*/
|
|
2250
2813
|
JsGetTransactionResponse: {
|
|
2251
2814
|
/** @description Required */
|
|
@@ -2253,7 +2816,7 @@ export interface components {
|
|
|
2253
2816
|
};
|
|
2254
2817
|
/**
|
|
2255
2818
|
* JsGetTransactionTreeResponse
|
|
2256
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
2819
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
2257
2820
|
*/
|
|
2258
2821
|
JsGetTransactionTreeResponse: {
|
|
2259
2822
|
/** @description Required */
|
|
@@ -2265,7 +2828,7 @@ export interface components {
|
|
|
2265
2828
|
};
|
|
2266
2829
|
/**
|
|
2267
2830
|
* JsGetUpdateTreesResponse
|
|
2268
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
2831
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
2269
2832
|
*/
|
|
2270
2833
|
JsGetUpdateTreesResponse: {
|
|
2271
2834
|
update: components["schemas"]["Update1"];
|
|
@@ -2281,13 +2844,15 @@ export interface components {
|
|
|
2281
2844
|
};
|
|
2282
2845
|
/** JsIncompleteUnassigned */
|
|
2283
2846
|
JsIncompleteUnassigned: {
|
|
2284
|
-
/**
|
|
2847
|
+
/**
|
|
2848
|
+
* @description Required
|
|
2285
2849
|
* The event as it appeared in the context of its last activation update (i.e. daml transaction or
|
|
2286
2850
|
* reassignment). In particular, the last activation offset, node_id pair is preserved.
|
|
2287
2851
|
* The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before
|
|
2288
2852
|
* the unassigned_event.
|
|
2289
2853
|
* The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
|
|
2290
|
-
* for lookups.
|
|
2854
|
+
* for lookups.
|
|
2855
|
+
*/
|
|
2291
2856
|
createdEvent: components["schemas"]["CreatedEvent"];
|
|
2292
2857
|
/** @description Required */
|
|
2293
2858
|
unassignedEvent: components["schemas"]["UnassignedEvent"];
|
|
@@ -2297,78 +2862,118 @@ export interface components {
|
|
|
2297
2862
|
* @description View of a create event matched by an interface filter.
|
|
2298
2863
|
*/
|
|
2299
2864
|
JsInterfaceView: {
|
|
2300
|
-
/**
|
|
2865
|
+
/**
|
|
2866
|
+
* @description The interface implemented by the matched event.
|
|
2301
2867
|
* The identifier uses the package-id reference format.
|
|
2302
2868
|
*
|
|
2303
|
-
* Required
|
|
2869
|
+
* Required
|
|
2870
|
+
*/
|
|
2304
2871
|
interfaceId: string;
|
|
2305
|
-
/**
|
|
2872
|
+
/**
|
|
2873
|
+
* @description Whether the view was successfully computed, and if not,
|
|
2306
2874
|
* the reason for the error. The error is reported using the same rules
|
|
2307
2875
|
* for error codes and messages as the errors returned for API requests.
|
|
2308
|
-
* Required
|
|
2876
|
+
* Required
|
|
2877
|
+
*/
|
|
2309
2878
|
viewStatus: components["schemas"]["JsStatus"];
|
|
2310
|
-
/**
|
|
2879
|
+
/**
|
|
2880
|
+
* @description The value of the interface's view method on this event.
|
|
2311
2881
|
* Set if it was requested in the ``InterfaceFilter`` and it could be
|
|
2312
|
-
*
|
|
2313
|
-
* Optional
|
|
2882
|
+
* successfully computed.
|
|
2883
|
+
* Optional
|
|
2884
|
+
*/
|
|
2314
2885
|
viewValue?: unknown;
|
|
2315
2886
|
};
|
|
2316
2887
|
/** JsPrepareSubmissionRequest */
|
|
2317
2888
|
JsPrepareSubmissionRequest: {
|
|
2318
|
-
/**
|
|
2889
|
+
/**
|
|
2890
|
+
* @description Uniquely identifies the participant user that prepares the transaction.
|
|
2319
2891
|
* Must be a valid UserIdString (as described in ``value.proto``).
|
|
2320
2892
|
* Required unless authentication is used with a user token.
|
|
2321
|
-
* In that case, the token's user-id will be used for the request's user_id.
|
|
2893
|
+
* In that case, the token's user-id will be used for the request's user_id.
|
|
2894
|
+
* Optional
|
|
2895
|
+
*/
|
|
2322
2896
|
userId: string;
|
|
2323
|
-
/**
|
|
2897
|
+
/**
|
|
2898
|
+
* @description Uniquely identifies the command.
|
|
2324
2899
|
* The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change,
|
|
2325
2900
|
* where act_as is interpreted as a set of party names.
|
|
2326
2901
|
* The change ID can be used for matching the intended ledger changes with all their completions.
|
|
2327
2902
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2328
|
-
* Required
|
|
2903
|
+
* Required
|
|
2904
|
+
*/
|
|
2329
2905
|
commandId: string;
|
|
2330
|
-
/**
|
|
2331
|
-
*
|
|
2906
|
+
/**
|
|
2907
|
+
* @description Individual elements of this atomic command. Must be non-empty.
|
|
2908
|
+
* Limitation: Only single command transaction are currently supported by the API.
|
|
2909
|
+
* The field is marked as repeated in preparation for future support of multiple commands.
|
|
2910
|
+
* Required
|
|
2911
|
+
*/
|
|
2332
2912
|
commands?: components["schemas"]["Command"][];
|
|
2333
2913
|
/** @description Optional */
|
|
2334
2914
|
minLedgerTime?: components["schemas"]["MinLedgerTime"];
|
|
2335
|
-
/**
|
|
2915
|
+
/**
|
|
2916
|
+
* @description Set of parties on whose behalf the command should be executed, if submitted.
|
|
2336
2917
|
* If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
|
|
2337
2918
|
* to **read** (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction
|
|
2338
2919
|
* and does not execute it. Therefore read authorization is sufficient even for actAs parties.
|
|
2339
2920
|
* Note: This may change, and more specific authorization scope may be introduced in the future.
|
|
2340
2921
|
* Each element must be a valid PartyIdString (as described in ``value.proto``).
|
|
2341
|
-
* Required, must be non-empty.
|
|
2922
|
+
* Required, must be non-empty.
|
|
2923
|
+
*/
|
|
2342
2924
|
actAs?: string[];
|
|
2343
|
-
/**
|
|
2925
|
+
/**
|
|
2926
|
+
* @description Set of parties on whose behalf (in addition to all parties listed in ``act_as``) contracts can be retrieved.
|
|
2344
2927
|
* This affects Daml operations such as ``fetch``, ``fetchByKey``, ``lookupByKey``, ``exercise``, and ``exerciseByKey``.
|
|
2345
2928
|
* Note: A command can only use contracts that are visible to at least
|
|
2346
2929
|
* one of the parties in ``act_as`` or ``read_as``. This visibility check is independent from the Daml authorization
|
|
2347
2930
|
* rules for fetch operations.
|
|
2348
2931
|
* If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
|
|
2349
2932
|
* to read contract data on behalf of each of the given parties.
|
|
2350
|
-
* Optional
|
|
2933
|
+
* Optional
|
|
2934
|
+
*/
|
|
2351
2935
|
readAs?: string[];
|
|
2352
|
-
/**
|
|
2353
|
-
*
|
|
2936
|
+
/**
|
|
2937
|
+
* @description Additional contracts used to resolve contract & contract key lookups.
|
|
2938
|
+
* Optional
|
|
2939
|
+
*/
|
|
2354
2940
|
disclosedContracts?: components["schemas"]["DisclosedContract"][];
|
|
2355
|
-
/**
|
|
2356
|
-
*
|
|
2941
|
+
/**
|
|
2942
|
+
* @description Must be a valid synchronizer id
|
|
2943
|
+
* If not set, a suitable synchronizer that this node is connected to will be chosen
|
|
2944
|
+
* Optional
|
|
2945
|
+
*/
|
|
2357
2946
|
synchronizerId: string;
|
|
2358
|
-
/**
|
|
2359
|
-
*
|
|
2947
|
+
/**
|
|
2948
|
+
* @description The package-id selection preference of the client for resolving
|
|
2949
|
+
* package names and interface instances in command submission and interpretation
|
|
2950
|
+
* Optional
|
|
2951
|
+
*/
|
|
2360
2952
|
packageIdSelectionPreference?: string[];
|
|
2361
|
-
/**
|
|
2362
|
-
*
|
|
2953
|
+
/**
|
|
2954
|
+
* @description When true, the response will contain additional details on how the transaction was encoded and hashed
|
|
2955
|
+
* This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
|
|
2956
|
+
* Optional, default to false
|
|
2957
|
+
*/
|
|
2363
2958
|
verboseHashing: boolean;
|
|
2364
|
-
/**
|
|
2959
|
+
/**
|
|
2960
|
+
* @description Fetches the contract keys into the caches to speed up the command processing.
|
|
2961
|
+
* Should only contain contract keys that are expected to be resolved during interpretation of the commands.
|
|
2962
|
+
* Keys of disclosed contracts do not need prefetching.
|
|
2963
|
+
*
|
|
2964
|
+
* Optional
|
|
2965
|
+
*/
|
|
2966
|
+
prefetchContractKeys?: components["schemas"]["PrefetchContractKey"][];
|
|
2967
|
+
/**
|
|
2968
|
+
* @description Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.
|
|
2365
2969
|
* If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again
|
|
2366
2970
|
* with a new valid max_record_time.
|
|
2367
2971
|
* Use this to limit the time-to-life of a prepared transaction,
|
|
2368
2972
|
* which is useful to know when it can definitely not be accepted
|
|
2369
2973
|
* anymore and resorting to preparing another transaction for the same
|
|
2370
2974
|
* intent is safe again.
|
|
2371
|
-
* Optional
|
|
2975
|
+
* Optional
|
|
2976
|
+
*/
|
|
2372
2977
|
maxRecordTime?: string;
|
|
2373
2978
|
};
|
|
2374
2979
|
/**
|
|
@@ -2376,18 +2981,27 @@ export interface components {
|
|
|
2376
2981
|
* @description [docs-entry-end: HashingSchemeVersion]
|
|
2377
2982
|
*/
|
|
2378
2983
|
JsPrepareSubmissionResponse: {
|
|
2379
|
-
/**
|
|
2380
|
-
*
|
|
2984
|
+
/**
|
|
2985
|
+
* @description The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request.
|
|
2986
|
+
* Clients MUST display the content of the transaction to the user for them to validate before signing the hash if the preparing participant is not trusted.
|
|
2987
|
+
*/
|
|
2381
2988
|
preparedTransaction?: string;
|
|
2382
|
-
/**
|
|
2989
|
+
/**
|
|
2990
|
+
* @description Hash of the transaction, this is what needs to be signed by the party to authorize the transaction.
|
|
2383
2991
|
* Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted.
|
|
2384
|
-
* May be removed in future versions
|
|
2992
|
+
* May be removed in future versions
|
|
2993
|
+
*/
|
|
2385
2994
|
preparedTransactionHash: string;
|
|
2386
|
-
/**
|
|
2387
|
-
|
|
2388
|
-
|
|
2995
|
+
/**
|
|
2996
|
+
* @description The hashing scheme version used when building the hash
|
|
2997
|
+
* @enum {string}
|
|
2998
|
+
*/
|
|
2999
|
+
hashingSchemeVersion: "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2";
|
|
3000
|
+
/**
|
|
3001
|
+
* @description Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request
|
|
2389
3002
|
* Note that there are no guarantees on the stability of the format or content of this field.
|
|
2390
|
-
* Its content should NOT be parsed and should only be used for troubleshooting purposes.
|
|
3003
|
+
* Its content should NOT be parsed and should only be used for troubleshooting purposes.
|
|
3004
|
+
*/
|
|
2391
3005
|
hashingDetails?: string;
|
|
2392
3006
|
};
|
|
2393
3007
|
/**
|
|
@@ -2395,17 +3009,23 @@ export interface components {
|
|
|
2395
3009
|
* @description Complete view of an on-ledger reassignment.
|
|
2396
3010
|
*/
|
|
2397
3011
|
JsReassignment: {
|
|
2398
|
-
/**
|
|
3012
|
+
/**
|
|
3013
|
+
* @description Assigned by the server. Useful for correlating logs.
|
|
2399
3014
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2400
|
-
* Required
|
|
3015
|
+
* Required
|
|
3016
|
+
*/
|
|
2401
3017
|
updateId: string;
|
|
2402
|
-
/**
|
|
3018
|
+
/**
|
|
3019
|
+
* @description The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant.
|
|
2403
3020
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2404
|
-
* Optional
|
|
3021
|
+
* Optional
|
|
3022
|
+
*/
|
|
2405
3023
|
commandId: string;
|
|
2406
|
-
/**
|
|
3024
|
+
/**
|
|
3025
|
+
* @description The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set.
|
|
2407
3026
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2408
|
-
* Optional
|
|
3027
|
+
* Optional
|
|
3028
|
+
*/
|
|
2409
3029
|
workflowId: string;
|
|
2410
3030
|
/**
|
|
2411
3031
|
* Format: int64
|
|
@@ -2415,7 +3035,8 @@ export interface components {
|
|
|
2415
3035
|
offset: number;
|
|
2416
3036
|
/** @description The collection of reassignment events. Required. */
|
|
2417
3037
|
events?: components["schemas"]["JsReassignmentEvent"][];
|
|
2418
|
-
/**
|
|
3038
|
+
/**
|
|
3039
|
+
* @description Optional; ledger API trace context
|
|
2419
3040
|
*
|
|
2420
3041
|
* The trace context transported in this message corresponds to the trace context supplied
|
|
2421
3042
|
* by the client application in a HTTP2 header of the original command submission.
|
|
@@ -2423,12 +3044,21 @@ export interface components {
|
|
|
2423
3044
|
* body, because it is used in gRPC streams which do not support per message headers.
|
|
2424
3045
|
* This field will be populated with the trace context contained in the original submission.
|
|
2425
3046
|
* If that was not provided, a unique ledger-api-server generated trace context will be used
|
|
2426
|
-
* instead.
|
|
3047
|
+
* instead.
|
|
3048
|
+
*/
|
|
2427
3049
|
traceContext?: components["schemas"]["TraceContext"];
|
|
2428
|
-
/**
|
|
3050
|
+
/**
|
|
3051
|
+
* @description The time at which the reassignment was recorded. The record time refers to the source/target
|
|
2429
3052
|
* synchronizer for an unassign/assign event respectively.
|
|
2430
|
-
* Required
|
|
3053
|
+
* Required
|
|
3054
|
+
*/
|
|
2431
3055
|
recordTime: string;
|
|
3056
|
+
/**
|
|
3057
|
+
* @description A valid synchronizer id.
|
|
3058
|
+
* Identifies the synchronizer that synchronized this Reassignment.
|
|
3059
|
+
* Required
|
|
3060
|
+
*/
|
|
3061
|
+
synchronizerId: string;
|
|
2432
3062
|
};
|
|
2433
3063
|
/** JsReassignmentEvent */
|
|
2434
3064
|
JsReassignmentEvent: {
|
|
@@ -2445,9 +3075,11 @@ export interface components {
|
|
|
2445
3075
|
};
|
|
2446
3076
|
/** JsSubmitAndWaitForReassignmentResponse */
|
|
2447
3077
|
JsSubmitAndWaitForReassignmentResponse: {
|
|
2448
|
-
/**
|
|
3078
|
+
/**
|
|
3079
|
+
* @description The reassignment that resulted from the submitted reassignment command.
|
|
2449
3080
|
* The reassignment might contain no events (request conditions result in filtering out all of them).
|
|
2450
|
-
* Required
|
|
3081
|
+
* Required
|
|
3082
|
+
*/
|
|
2451
3083
|
reassignment: components["schemas"]["JsReassignment"];
|
|
2452
3084
|
};
|
|
2453
3085
|
/**
|
|
@@ -2455,49 +3087,69 @@ export interface components {
|
|
|
2455
3087
|
* @description These commands are executed as a single atomic transaction.
|
|
2456
3088
|
*/
|
|
2457
3089
|
JsSubmitAndWaitForTransactionRequest: {
|
|
2458
|
-
/**
|
|
2459
|
-
*
|
|
3090
|
+
/**
|
|
3091
|
+
* @description The commands to be submitted.
|
|
3092
|
+
* Required
|
|
3093
|
+
*/
|
|
2460
3094
|
commands: components["schemas"]["JsCommands"];
|
|
2461
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* @description If no ``transaction_format`` is provided, a default will be used where ``transaction_shape`` is set to
|
|
2462
3097
|
* TRANSACTION_SHAPE_ACS_DELTA, ``event_format`` is defined with ``filters_by_party`` containing wildcard-template
|
|
2463
3098
|
* filter for all original ``act_as`` and ``read_as`` parties and the ``verbose`` flag is set.
|
|
2464
|
-
* Optional
|
|
3099
|
+
* Optional
|
|
3100
|
+
*/
|
|
2465
3101
|
transactionFormat?: components["schemas"]["TransactionFormat"];
|
|
2466
3102
|
};
|
|
2467
3103
|
/** JsSubmitAndWaitForTransactionResponse */
|
|
2468
3104
|
JsSubmitAndWaitForTransactionResponse: {
|
|
2469
|
-
/**
|
|
3105
|
+
/**
|
|
3106
|
+
* @description The transaction that resulted from the submitted command.
|
|
2470
3107
|
* The transaction might contain no events (request conditions result in filtering out all of them).
|
|
2471
|
-
* Required
|
|
3108
|
+
* Required
|
|
3109
|
+
*/
|
|
2472
3110
|
transaction: components["schemas"]["JsTransaction"];
|
|
2473
3111
|
};
|
|
2474
3112
|
/**
|
|
2475
3113
|
* JsSubmitAndWaitForTransactionTreeResponse
|
|
2476
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
3114
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
2477
3115
|
*/
|
|
2478
3116
|
JsSubmitAndWaitForTransactionTreeResponse: {
|
|
2479
3117
|
transactionTree: components["schemas"]["JsTransactionTree"];
|
|
2480
3118
|
};
|
|
2481
3119
|
/** JsTopologyTransaction */
|
|
2482
3120
|
JsTopologyTransaction: {
|
|
2483
|
-
/**
|
|
3121
|
+
/**
|
|
3122
|
+
* @description Assigned by the server. Useful for correlating logs.
|
|
2484
3123
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2485
|
-
* Required
|
|
3124
|
+
* Required
|
|
3125
|
+
*/
|
|
2486
3126
|
updateId: string;
|
|
2487
|
-
/** @description A non-empty list of topology events.
|
|
2488
|
-
* Required */
|
|
2489
|
-
events?: components["schemas"]["TopologyEvent"][];
|
|
2490
3127
|
/**
|
|
2491
3128
|
* Format: int64
|
|
2492
3129
|
* @description The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.
|
|
2493
3130
|
* Required, it is a valid absolute offset (positive integer).
|
|
2494
3131
|
*/
|
|
2495
3132
|
offset: number;
|
|
2496
|
-
/**
|
|
3133
|
+
/**
|
|
3134
|
+
* @description A valid synchronizer id.
|
|
2497
3135
|
* Identifies the synchronizer that synchronized the topology transaction.
|
|
2498
|
-
* Required
|
|
3136
|
+
* Required
|
|
3137
|
+
*/
|
|
2499
3138
|
synchronizerId: string;
|
|
2500
|
-
/**
|
|
3139
|
+
/**
|
|
3140
|
+
* @description The time at which the changes in the topology transaction become effective. There is a small delay between a
|
|
3141
|
+
* topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear
|
|
3142
|
+
* in order relative to a synchronizer based on their effective time rather than their sequencing time.
|
|
3143
|
+
* Required
|
|
3144
|
+
*/
|
|
3145
|
+
recordTime?: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* @description A non-empty list of topology events.
|
|
3148
|
+
* Required
|
|
3149
|
+
*/
|
|
3150
|
+
events?: components["schemas"]["TopologyEvent"][];
|
|
3151
|
+
/**
|
|
3152
|
+
* @description Optional; ledger API trace context
|
|
2501
3153
|
*
|
|
2502
3154
|
* The trace context transported in this message corresponds to the trace context supplied
|
|
2503
3155
|
* by the client application in a HTTP2 header of the original command submission.
|
|
@@ -2505,41 +3157,47 @@ export interface components {
|
|
|
2505
3157
|
* body, because it is used in gRPC streams which do not support per message headers.
|
|
2506
3158
|
* This field will be populated with the trace context contained in the original submission.
|
|
2507
3159
|
* If that was not provided, a unique ledger-api-server generated trace context will be used
|
|
2508
|
-
* instead.
|
|
3160
|
+
* instead.
|
|
3161
|
+
*/
|
|
2509
3162
|
traceContext?: components["schemas"]["TraceContext"];
|
|
2510
|
-
/** @description The time at which the changes in the topology transaction become effective. There is a small delay between a
|
|
2511
|
-
* topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear
|
|
2512
|
-
* in order relative to a synchronizer based on their effective time rather than their sequencing time.
|
|
2513
|
-
* Required */
|
|
2514
|
-
recordTime: string;
|
|
2515
3163
|
};
|
|
2516
3164
|
/**
|
|
2517
3165
|
* JsTransaction
|
|
2518
3166
|
* @description Filtered view of an on-ledger transaction's create and archive events.
|
|
2519
3167
|
*/
|
|
2520
3168
|
JsTransaction: {
|
|
2521
|
-
/**
|
|
3169
|
+
/**
|
|
3170
|
+
* @description Assigned by the server. Useful for correlating logs.
|
|
2522
3171
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2523
|
-
* Required
|
|
3172
|
+
* Required
|
|
3173
|
+
*/
|
|
2524
3174
|
updateId: string;
|
|
2525
|
-
/**
|
|
3175
|
+
/**
|
|
3176
|
+
* @description The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
|
|
2526
3177
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2527
|
-
* Optional
|
|
3178
|
+
* Optional
|
|
3179
|
+
*/
|
|
2528
3180
|
commandId: string;
|
|
2529
|
-
/**
|
|
3181
|
+
/**
|
|
3182
|
+
* @description The workflow ID used in command submission.
|
|
2530
3183
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2531
|
-
* Optional
|
|
3184
|
+
* Optional
|
|
3185
|
+
*/
|
|
2532
3186
|
workflowId: string;
|
|
2533
|
-
/**
|
|
2534
|
-
*
|
|
3187
|
+
/**
|
|
3188
|
+
* @description Ledger effective time.
|
|
3189
|
+
* Required
|
|
3190
|
+
*/
|
|
2535
3191
|
effectiveAt: string;
|
|
2536
|
-
/**
|
|
3192
|
+
/**
|
|
3193
|
+
* @description The collection of events.
|
|
2537
3194
|
* Contains:
|
|
2538
3195
|
*
|
|
2539
3196
|
* - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape
|
|
2540
3197
|
* - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape
|
|
2541
3198
|
*
|
|
2542
|
-
* Required
|
|
3199
|
+
* Required
|
|
3200
|
+
*/
|
|
2543
3201
|
events?: components["schemas"]["Event"][];
|
|
2544
3202
|
/**
|
|
2545
3203
|
* Format: int64
|
|
@@ -2547,11 +3205,14 @@ export interface components {
|
|
|
2547
3205
|
* Required, it is a valid absolute offset (positive integer).
|
|
2548
3206
|
*/
|
|
2549
3207
|
offset: number;
|
|
2550
|
-
/**
|
|
3208
|
+
/**
|
|
3209
|
+
* @description A valid synchronizer id.
|
|
2551
3210
|
* Identifies the synchronizer that synchronized the transaction.
|
|
2552
|
-
* Required
|
|
3211
|
+
* Required
|
|
3212
|
+
*/
|
|
2553
3213
|
synchronizerId: string;
|
|
2554
|
-
/**
|
|
3214
|
+
/**
|
|
3215
|
+
* @description Optional; ledger API trace context
|
|
2555
3216
|
*
|
|
2556
3217
|
* The trace context transported in this message corresponds to the trace context supplied
|
|
2557
3218
|
* by the client application in a HTTP2 header of the original command submission.
|
|
@@ -2559,33 +3220,50 @@ export interface components {
|
|
|
2559
3220
|
* body, because it is used in gRPC streams which do not support per message headers.
|
|
2560
3221
|
* This field will be populated with the trace context contained in the original submission.
|
|
2561
3222
|
* If that was not provided, a unique ledger-api-server generated trace context will be used
|
|
2562
|
-
* instead.
|
|
3223
|
+
* instead.
|
|
3224
|
+
*/
|
|
2563
3225
|
traceContext?: components["schemas"]["TraceContext"];
|
|
2564
|
-
/**
|
|
3226
|
+
/**
|
|
3227
|
+
* @description The time at which the transaction was recorded. The record time refers to the synchronizer
|
|
2565
3228
|
* which synchronized the transaction.
|
|
2566
|
-
* Required
|
|
3229
|
+
* Required
|
|
3230
|
+
*/
|
|
2567
3231
|
recordTime: string;
|
|
3232
|
+
/**
|
|
3233
|
+
* @description For transaction externally signed, contains the external transaction hash
|
|
3234
|
+
* signed by the external party. Can be used to correlate an external submission with a committed transaction.
|
|
3235
|
+
* Optional
|
|
3236
|
+
*/
|
|
3237
|
+
externalTransactionHash?: string;
|
|
2568
3238
|
};
|
|
2569
3239
|
/**
|
|
2570
3240
|
* JsTransactionTree
|
|
2571
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
3241
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
2572
3242
|
* Complete view of an on-ledger transaction.
|
|
2573
3243
|
*/
|
|
2574
3244
|
JsTransactionTree: {
|
|
2575
|
-
/**
|
|
3245
|
+
/**
|
|
3246
|
+
* @description Assigned by the server. Useful for correlating logs.
|
|
2576
3247
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2577
|
-
* Required
|
|
3248
|
+
* Required
|
|
3249
|
+
*/
|
|
2578
3250
|
updateId: string;
|
|
2579
|
-
/**
|
|
3251
|
+
/**
|
|
3252
|
+
* @description The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.
|
|
2580
3253
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2581
|
-
* Optional
|
|
3254
|
+
* Optional
|
|
3255
|
+
*/
|
|
2582
3256
|
commandId: string;
|
|
2583
|
-
/**
|
|
3257
|
+
/**
|
|
3258
|
+
* @description The workflow ID used in command submission. Only set if the ``workflow_id`` for the command was set.
|
|
2584
3259
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2585
|
-
* Optional
|
|
3260
|
+
* Optional
|
|
3261
|
+
*/
|
|
2586
3262
|
workflowId: string;
|
|
2587
|
-
/**
|
|
2588
|
-
*
|
|
3263
|
+
/**
|
|
3264
|
+
* @description Ledger effective time.
|
|
3265
|
+
* Required
|
|
3266
|
+
*/
|
|
2589
3267
|
effectiveAt?: string;
|
|
2590
3268
|
/**
|
|
2591
3269
|
* Format: int64
|
|
@@ -2593,15 +3271,20 @@ export interface components {
|
|
|
2593
3271
|
* Required, it is a valid absolute offset (positive integer).
|
|
2594
3272
|
*/
|
|
2595
3273
|
offset: number;
|
|
2596
|
-
/**
|
|
3274
|
+
/**
|
|
3275
|
+
* @description Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.
|
|
2597
3276
|
* Each key must be a valid node ID (non-negative integer).
|
|
2598
|
-
* Required
|
|
3277
|
+
* Required
|
|
3278
|
+
*/
|
|
2599
3279
|
eventsById: components["schemas"]["Map_Int_TreeEvent"];
|
|
2600
|
-
/**
|
|
3280
|
+
/**
|
|
3281
|
+
* @description A valid synchronizer id.
|
|
2601
3282
|
* Identifies the synchronizer that synchronized the transaction.
|
|
2602
|
-
* Required
|
|
3283
|
+
* Required
|
|
3284
|
+
*/
|
|
2603
3285
|
synchronizerId: string;
|
|
2604
|
-
/**
|
|
3286
|
+
/**
|
|
3287
|
+
* @description Optional; ledger API trace context
|
|
2605
3288
|
*
|
|
2606
3289
|
* The trace context transported in this message corresponds to the trace context supplied
|
|
2607
3290
|
* by the client application in a HTTP2 header of the original command submission.
|
|
@@ -2609,11 +3292,14 @@ export interface components {
|
|
|
2609
3292
|
* body, because it is used in gRPC streams which do not support per message headers.
|
|
2610
3293
|
* This field will be populated with the trace context contained in the original submission.
|
|
2611
3294
|
* If that was not provided, a unique ledger-api-server generated trace context will be used
|
|
2612
|
-
* instead.
|
|
3295
|
+
* instead.
|
|
3296
|
+
*/
|
|
2613
3297
|
traceContext?: components["schemas"]["TraceContext"];
|
|
2614
|
-
/**
|
|
3298
|
+
/**
|
|
3299
|
+
* @description The time at which the transaction was recorded. The record time refers to the synchronizer
|
|
2615
3300
|
* which synchronized the transaction.
|
|
2616
|
-
* Required
|
|
3301
|
+
* Required
|
|
3302
|
+
*/
|
|
2617
3303
|
recordTime: string;
|
|
2618
3304
|
};
|
|
2619
3305
|
/**
|
|
@@ -2638,7 +3324,7 @@ export interface components {
|
|
|
2638
3324
|
} | {
|
|
2639
3325
|
CanReadAsAnyParty: components["schemas"]["CanReadAsAnyParty"];
|
|
2640
3326
|
} | {
|
|
2641
|
-
Empty: components["schemas"]["
|
|
3327
|
+
Empty: components["schemas"]["Empty8"];
|
|
2642
3328
|
} | {
|
|
2643
3329
|
IdentityProviderAdmin: components["schemas"]["IdentityProviderAdmin"];
|
|
2644
3330
|
} | {
|
|
@@ -2650,18 +3336,24 @@ export interface components {
|
|
|
2650
3336
|
};
|
|
2651
3337
|
/** ListKnownPartiesResponse */
|
|
2652
3338
|
ListKnownPartiesResponse: {
|
|
2653
|
-
/**
|
|
2654
|
-
*
|
|
3339
|
+
/**
|
|
3340
|
+
* @description The details of all Daml parties known by the participant.
|
|
3341
|
+
* Required
|
|
3342
|
+
*/
|
|
2655
3343
|
partyDetails?: components["schemas"]["PartyDetails"][];
|
|
2656
|
-
/**
|
|
2657
|
-
*
|
|
3344
|
+
/**
|
|
3345
|
+
* @description Pagination token to retrieve the next page.
|
|
3346
|
+
* Empty, if there are no further results.
|
|
3347
|
+
*/
|
|
2658
3348
|
nextPageToken: string;
|
|
2659
3349
|
};
|
|
2660
3350
|
/** ListPackagesResponse */
|
|
2661
3351
|
ListPackagesResponse: {
|
|
2662
|
-
/**
|
|
3352
|
+
/**
|
|
3353
|
+
* @description The IDs of all Daml-LF packages supported by the server.
|
|
2663
3354
|
* Each element must be a valid PackageIdString (as described in ``value.proto``).
|
|
2664
|
-
* Required
|
|
3355
|
+
* Required
|
|
3356
|
+
*/
|
|
2665
3357
|
packageIds?: string[];
|
|
2666
3358
|
};
|
|
2667
3359
|
/** ListUserRightsResponse */
|
|
@@ -2669,12 +3361,73 @@ export interface components {
|
|
|
2669
3361
|
/** @description All rights of the user. */
|
|
2670
3362
|
rights?: components["schemas"]["Right"][];
|
|
2671
3363
|
};
|
|
2672
|
-
/** ListUsersResponse */
|
|
2673
|
-
ListUsersResponse: {
|
|
2674
|
-
/** @description A subset of users of the participant node that fit into this page. */
|
|
2675
|
-
users?: components["schemas"]["User"][];
|
|
2676
|
-
/**
|
|
2677
|
-
*
|
|
3364
|
+
/** ListUsersResponse */
|
|
3365
|
+
ListUsersResponse: {
|
|
3366
|
+
/** @description A subset of users of the participant node that fit into this page. */
|
|
3367
|
+
users?: components["schemas"]["User"][];
|
|
3368
|
+
/**
|
|
3369
|
+
* @description Pagination token to retrieve the next page.
|
|
3370
|
+
* Empty, if there are no further results.
|
|
3371
|
+
*/
|
|
3372
|
+
nextPageToken: string;
|
|
3373
|
+
};
|
|
3374
|
+
/** ListVettedPackagesRequest */
|
|
3375
|
+
ListVettedPackagesRequest: {
|
|
3376
|
+
/**
|
|
3377
|
+
* @description The package metadata filter the returned vetted packages set must satisfy.
|
|
3378
|
+
* Optional
|
|
3379
|
+
*/
|
|
3380
|
+
packageMetadataFilter?: components["schemas"]["PackageMetadataFilter"];
|
|
3381
|
+
/**
|
|
3382
|
+
* @description The topology filter the returned vetted packages set must satisfy.
|
|
3383
|
+
* Optional
|
|
3384
|
+
*/
|
|
3385
|
+
topologyStateFilter?: components["schemas"]["TopologyStateFilter"];
|
|
3386
|
+
/**
|
|
3387
|
+
* @description Pagination token to determine the specific page to fetch. Using the token
|
|
3388
|
+
* guarantees that ``VettedPackages`` on a subsequent page are all greater
|
|
3389
|
+
* (``VettedPackages`` are sorted by synchronizer ID then participant ID) than
|
|
3390
|
+
* the last ``VettedPackages`` on a previous page.
|
|
3391
|
+
*
|
|
3392
|
+
* The server does not store intermediate results between calls chained by a
|
|
3393
|
+
* series of page tokens. As a consequence, if new vetted packages are being
|
|
3394
|
+
* added and a page is requested twice using the same token, more packages can
|
|
3395
|
+
* be returned on the second call.
|
|
3396
|
+
*
|
|
3397
|
+
* Leave unspecified (i.e. as empty string) to fetch the first page.
|
|
3398
|
+
*
|
|
3399
|
+
* Optional
|
|
3400
|
+
*/
|
|
3401
|
+
pageToken: string;
|
|
3402
|
+
/**
|
|
3403
|
+
* Format: int32
|
|
3404
|
+
* @description Maximum number of ``VettedPackages`` results to return in a single page.
|
|
3405
|
+
*
|
|
3406
|
+
* If the page_size is unspecified (i.e. left as 0), the server will decide
|
|
3407
|
+
* the number of results to be returned.
|
|
3408
|
+
*
|
|
3409
|
+
* If the page_size exceeds the maximum supported by the server, an
|
|
3410
|
+
* error will be returned.
|
|
3411
|
+
*
|
|
3412
|
+
* To obtain the server's maximum consult the PackageService descriptor
|
|
3413
|
+
* available in the VersionService.
|
|
3414
|
+
*
|
|
3415
|
+
* Optional
|
|
3416
|
+
*/
|
|
3417
|
+
pageSize: number;
|
|
3418
|
+
};
|
|
3419
|
+
/** ListVettedPackagesResponse */
|
|
3420
|
+
ListVettedPackagesResponse: {
|
|
3421
|
+
/**
|
|
3422
|
+
* @description All ``VettedPackages`` that contain at least one ``VettedPackage`` matching
|
|
3423
|
+
* both a ``PackageMetadataFilter`` and a ``TopologyStateFilter``.
|
|
3424
|
+
* Sorted by synchronizer_id then participant_id.
|
|
3425
|
+
*/
|
|
3426
|
+
vettedPackages?: components["schemas"]["VettedPackages"][];
|
|
3427
|
+
/**
|
|
3428
|
+
* @description Pagination token to retrieve the next page.
|
|
3429
|
+
* Empty string if there are no further results.
|
|
3430
|
+
*/
|
|
2678
3431
|
nextPageToken: string;
|
|
2679
3432
|
};
|
|
2680
3433
|
/** Map_Filters */
|
|
@@ -2705,6 +3458,8 @@ export interface components {
|
|
|
2705
3458
|
MinLedgerTimeRel: {
|
|
2706
3459
|
value: components["schemas"]["Duration"];
|
|
2707
3460
|
};
|
|
3461
|
+
/** NoPrior */
|
|
3462
|
+
NoPrior: Record<string, never>;
|
|
2708
3463
|
/**
|
|
2709
3464
|
* ObjectMeta
|
|
2710
3465
|
* @description Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party).
|
|
@@ -2713,7 +3468,8 @@ export interface components {
|
|
|
2713
3468
|
* See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640
|
|
2714
3469
|
*/
|
|
2715
3470
|
ObjectMeta: {
|
|
2716
|
-
/**
|
|
3471
|
+
/**
|
|
3472
|
+
* @description An opaque, non-empty value, populated by a participant server which represents the internal version of the resource
|
|
2717
3473
|
* this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated.
|
|
2718
3474
|
* You must not rely on the format of resource version. The participant server might change it without notice.
|
|
2719
3475
|
* You can obtain the newest resource version value by issuing a read request.
|
|
@@ -2725,9 +3481,11 @@ export interface components {
|
|
|
2725
3481
|
* Concurrent change control is optional. It will be applied only if you include a resource version in an update request.
|
|
2726
3482
|
* When creating a new instance of a resource you must leave the resource version empty.
|
|
2727
3483
|
* Its value will be populated by the participant server upon successful resource creation.
|
|
2728
|
-
* Optional
|
|
3484
|
+
* Optional
|
|
3485
|
+
*/
|
|
2729
3486
|
resourceVersion: string;
|
|
2730
|
-
/**
|
|
3487
|
+
/**
|
|
3488
|
+
* @description A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
|
|
2731
3489
|
* Constraints:
|
|
2732
3490
|
*
|
|
2733
3491
|
* 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
|
|
@@ -2748,7 +3506,8 @@ export interface components {
|
|
|
2748
3506
|
* In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
|
|
2749
3507
|
* In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
|
|
2750
3508
|
* Optional
|
|
2751
|
-
* Modifiable
|
|
3509
|
+
* Modifiable
|
|
3510
|
+
*/
|
|
2752
3511
|
annotations: components["schemas"]["Map_String"];
|
|
2753
3512
|
};
|
|
2754
3513
|
/**
|
|
@@ -2802,14 +3561,57 @@ export interface components {
|
|
|
2802
3561
|
/** @description The maximum delay to emmit a new OffsetCheckpoint if it exists */
|
|
2803
3562
|
maxOffsetCheckpointEmissionDelay?: components["schemas"]["Duration"];
|
|
2804
3563
|
};
|
|
3564
|
+
/** Operation */
|
|
3565
|
+
Operation: {
|
|
3566
|
+
Empty: components["schemas"]["Empty6"];
|
|
3567
|
+
} | {
|
|
3568
|
+
Unvet: components["schemas"]["Unvet"];
|
|
3569
|
+
} | {
|
|
3570
|
+
Vet: components["schemas"]["Vet"];
|
|
3571
|
+
};
|
|
3572
|
+
/** PackageFeature */
|
|
3573
|
+
PackageFeature: {
|
|
3574
|
+
/**
|
|
3575
|
+
* Format: int32
|
|
3576
|
+
* @description The maximum number of vetted packages the server can return in a single
|
|
3577
|
+
* response (page) when listing them.
|
|
3578
|
+
*/
|
|
3579
|
+
maxVettedPackagesPageSize: number;
|
|
3580
|
+
};
|
|
3581
|
+
/**
|
|
3582
|
+
* PackageMetadataFilter
|
|
3583
|
+
* @description Filter the VettedPackages by package metadata.
|
|
3584
|
+
*
|
|
3585
|
+
* A PackageMetadataFilter without package_ids and without package_name_prefixes
|
|
3586
|
+
* matches any vetted package.
|
|
3587
|
+
*
|
|
3588
|
+
* Non-empty fields specify candidate values of which at least one must match.
|
|
3589
|
+
* If both fields are set, then a candidate is returned if it matches one of the fields.
|
|
3590
|
+
*/
|
|
3591
|
+
PackageMetadataFilter: {
|
|
3592
|
+
/**
|
|
3593
|
+
* @description If this list is non-empty, any vetted package with a package ID in this
|
|
3594
|
+
* list will match the filter.
|
|
3595
|
+
*/
|
|
3596
|
+
packageIds?: string[];
|
|
3597
|
+
/**
|
|
3598
|
+
* @description If this list is non-empty, any vetted package with a name matching at least
|
|
3599
|
+
* one prefix in this list will match the filter.
|
|
3600
|
+
*/
|
|
3601
|
+
packageNamePrefixes?: string[];
|
|
3602
|
+
};
|
|
2805
3603
|
/** PackagePreference */
|
|
2806
3604
|
PackagePreference: {
|
|
2807
|
-
/**
|
|
2808
|
-
*
|
|
3605
|
+
/**
|
|
3606
|
+
* @description The package reference of the preferred package.
|
|
3607
|
+
* Required
|
|
3608
|
+
*/
|
|
2809
3609
|
packageReference?: components["schemas"]["PackageReference"];
|
|
2810
|
-
/**
|
|
3610
|
+
/**
|
|
3611
|
+
* @description The synchronizer for which the preferred package was computed.
|
|
2811
3612
|
* If the synchronizer_id was specified in the request, then it matches the request synchronizer_id.
|
|
2812
|
-
* Required
|
|
3613
|
+
* Required
|
|
3614
|
+
*/
|
|
2813
3615
|
synchronizerId: string;
|
|
2814
3616
|
};
|
|
2815
3617
|
/** PackageReference */
|
|
@@ -2826,11 +3628,15 @@ export interface components {
|
|
|
2826
3628
|
* @description Defines a package-name for which the commonly vetted package with the highest version must be found.
|
|
2827
3629
|
*/
|
|
2828
3630
|
PackageVettingRequirement: {
|
|
2829
|
-
/**
|
|
2830
|
-
*
|
|
3631
|
+
/**
|
|
3632
|
+
* @description The parties whose participants' vetting state should be considered when resolving the preferred package.
|
|
3633
|
+
* Required
|
|
3634
|
+
*/
|
|
2831
3635
|
parties?: string[];
|
|
2832
|
-
/**
|
|
2833
|
-
*
|
|
3636
|
+
/**
|
|
3637
|
+
* @description The package-name for which the preferred package should be resolved.
|
|
3638
|
+
* Required
|
|
3639
|
+
*/
|
|
2834
3640
|
packageName: string;
|
|
2835
3641
|
};
|
|
2836
3642
|
/** ParticipantAdmin */
|
|
@@ -2841,30 +3647,42 @@ export interface components {
|
|
|
2841
3647
|
ParticipantAdmin1: Record<string, never>;
|
|
2842
3648
|
/** ParticipantAuthorizationAdded */
|
|
2843
3649
|
ParticipantAuthorizationAdded: {
|
|
3650
|
+
value: components["schemas"]["ParticipantAuthorizationAdded1"];
|
|
3651
|
+
};
|
|
3652
|
+
/** ParticipantAuthorizationAdded */
|
|
3653
|
+
ParticipantAuthorizationAdded1: {
|
|
2844
3654
|
/** @description Required */
|
|
2845
3655
|
partyId: string;
|
|
2846
3656
|
/** @description Required */
|
|
2847
3657
|
participantId: string;
|
|
2848
3658
|
/**
|
|
2849
|
-
* Format: int32
|
|
2850
3659
|
* @description Required
|
|
3660
|
+
* @enum {string}
|
|
2851
3661
|
*/
|
|
2852
|
-
participantPermission:
|
|
3662
|
+
participantPermission: "PARTICIPANT_PERMISSION_UNSPECIFIED" | "PARTICIPANT_PERMISSION_SUBMISSION" | "PARTICIPANT_PERMISSION_CONFIRMATION" | "PARTICIPANT_PERMISSION_OBSERVATION";
|
|
2853
3663
|
};
|
|
2854
3664
|
/** ParticipantAuthorizationChanged */
|
|
2855
3665
|
ParticipantAuthorizationChanged: {
|
|
3666
|
+
value: components["schemas"]["ParticipantAuthorizationChanged1"];
|
|
3667
|
+
};
|
|
3668
|
+
/** ParticipantAuthorizationChanged */
|
|
3669
|
+
ParticipantAuthorizationChanged1: {
|
|
2856
3670
|
/** @description Required */
|
|
2857
3671
|
partyId: string;
|
|
2858
3672
|
/** @description Required */
|
|
2859
3673
|
participantId: string;
|
|
2860
3674
|
/**
|
|
2861
|
-
* Format: int32
|
|
2862
3675
|
* @description Required
|
|
3676
|
+
* @enum {string}
|
|
2863
3677
|
*/
|
|
2864
|
-
participantPermission:
|
|
3678
|
+
participantPermission: "PARTICIPANT_PERMISSION_UNSPECIFIED" | "PARTICIPANT_PERMISSION_SUBMISSION" | "PARTICIPANT_PERMISSION_CONFIRMATION" | "PARTICIPANT_PERMISSION_OBSERVATION";
|
|
2865
3679
|
};
|
|
2866
3680
|
/** ParticipantAuthorizationRevoked */
|
|
2867
3681
|
ParticipantAuthorizationRevoked: {
|
|
3682
|
+
value: components["schemas"]["ParticipantAuthorizationRevoked1"];
|
|
3683
|
+
};
|
|
3684
|
+
/** ParticipantAuthorizationRevoked */
|
|
3685
|
+
ParticipantAuthorizationRevoked1: {
|
|
2868
3686
|
/** @description Required */
|
|
2869
3687
|
partyId: string;
|
|
2870
3688
|
/** @description Required */
|
|
@@ -2875,29 +3693,39 @@ export interface components {
|
|
|
2875
3693
|
* @description A format specifying which participant authorization topology transactions to include and how to render them.
|
|
2876
3694
|
*/
|
|
2877
3695
|
ParticipantAuthorizationTopologyFormat: {
|
|
2878
|
-
/**
|
|
2879
|
-
*
|
|
3696
|
+
/**
|
|
3697
|
+
* @description List of parties for which the topology transactions should be sent.
|
|
3698
|
+
* Empty means: for all parties.
|
|
3699
|
+
*/
|
|
2880
3700
|
parties?: string[];
|
|
2881
3701
|
};
|
|
2882
3702
|
/** PartyDetails */
|
|
2883
3703
|
PartyDetails: {
|
|
2884
|
-
/**
|
|
3704
|
+
/**
|
|
3705
|
+
* @description The stable unique identifier of a Daml party.
|
|
2885
3706
|
* Must be a valid PartyIdString (as described in ``value.proto``).
|
|
2886
|
-
* Required
|
|
3707
|
+
* Required
|
|
3708
|
+
*/
|
|
2887
3709
|
party: string;
|
|
2888
|
-
/**
|
|
2889
|
-
*
|
|
3710
|
+
/**
|
|
3711
|
+
* @description true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request.
|
|
3712
|
+
* Optional
|
|
3713
|
+
*/
|
|
2890
3714
|
isLocal: boolean;
|
|
2891
|
-
/**
|
|
3715
|
+
/**
|
|
3716
|
+
* @description Participant-local metadata of this party.
|
|
2892
3717
|
* Optional,
|
|
2893
|
-
* Modifiable
|
|
3718
|
+
* Modifiable
|
|
3719
|
+
*/
|
|
2894
3720
|
localMetadata?: components["schemas"]["ObjectMeta"];
|
|
2895
|
-
/**
|
|
3721
|
+
/**
|
|
3722
|
+
* @description The id of the ``Identity Provider``
|
|
2896
3723
|
* Optional, if not set, there could be 3 options:
|
|
2897
3724
|
*
|
|
2898
3725
|
* 1. the party is managed by the default identity provider.
|
|
2899
3726
|
* 2. party is not hosted by the participant.
|
|
2900
|
-
* 3. party is hosted by the participant, but is outside of the user's identity provider.
|
|
3727
|
+
* 3. party is hosted by the participant, but is outside of the user's identity provider.
|
|
3728
|
+
*/
|
|
2901
3729
|
identityProviderId: string;
|
|
2902
3730
|
};
|
|
2903
3731
|
/** PartyManagementFeature */
|
|
@@ -2913,9 +3741,44 @@ export interface components {
|
|
|
2913
3741
|
* @description Additional signatures provided by the submitting parties
|
|
2914
3742
|
*/
|
|
2915
3743
|
PartySignatures: {
|
|
2916
|
-
/**
|
|
3744
|
+
/**
|
|
3745
|
+
* @description Additional signatures provided by all individual parties
|
|
3746
|
+
* Required
|
|
3747
|
+
*/
|
|
2917
3748
|
signatures?: components["schemas"]["SinglePartySignatures"][];
|
|
2918
3749
|
};
|
|
3750
|
+
/**
|
|
3751
|
+
* PrefetchContractKey
|
|
3752
|
+
* @description Preload contracts
|
|
3753
|
+
*/
|
|
3754
|
+
PrefetchContractKey: {
|
|
3755
|
+
/**
|
|
3756
|
+
* @description The template of contract the client wants to prefetch.
|
|
3757
|
+
* Both package-name and package-id reference identifier formats for the template-id are supported.
|
|
3758
|
+
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
3759
|
+
*
|
|
3760
|
+
* Required
|
|
3761
|
+
*/
|
|
3762
|
+
templateId?: string;
|
|
3763
|
+
/**
|
|
3764
|
+
* @description The key of the contract the client wants to prefetch.
|
|
3765
|
+
* Required
|
|
3766
|
+
*/
|
|
3767
|
+
contractKey: unknown;
|
|
3768
|
+
};
|
|
3769
|
+
/** Prior */
|
|
3770
|
+
Prior: {
|
|
3771
|
+
/** Format: int32 */
|
|
3772
|
+
value: number;
|
|
3773
|
+
};
|
|
3774
|
+
/**
|
|
3775
|
+
* PriorTopologySerial
|
|
3776
|
+
* @description The serial of last ``VettedPackages`` topology transaction on a given
|
|
3777
|
+
* participant and synchronizer.
|
|
3778
|
+
*/
|
|
3779
|
+
PriorTopologySerial: {
|
|
3780
|
+
serial: components["schemas"]["Serial"];
|
|
3781
|
+
};
|
|
2919
3782
|
/** ProtoAny */
|
|
2920
3783
|
ProtoAny: {
|
|
2921
3784
|
typeUrl: string;
|
|
@@ -2942,34 +3805,44 @@ export interface components {
|
|
|
2942
3805
|
};
|
|
2943
3806
|
/** ReassignmentCommands */
|
|
2944
3807
|
ReassignmentCommands: {
|
|
2945
|
-
/**
|
|
3808
|
+
/**
|
|
3809
|
+
* @description Identifier of the on-ledger workflow that this command is a part of.
|
|
2946
3810
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2947
|
-
* Optional
|
|
3811
|
+
* Optional
|
|
3812
|
+
*/
|
|
2948
3813
|
workflowId: string;
|
|
2949
|
-
/**
|
|
3814
|
+
/**
|
|
3815
|
+
* @description Uniquely identifies the participant user that issued the command.
|
|
2950
3816
|
* Must be a valid UserIdString (as described in ``value.proto``).
|
|
2951
3817
|
* Required unless authentication is used with a user token.
|
|
2952
|
-
* In that case, the token's user-id will be used for the request's user_id.
|
|
3818
|
+
* In that case, the token's user-id will be used for the request's user_id.
|
|
3819
|
+
*/
|
|
2953
3820
|
userId: string;
|
|
2954
|
-
/**
|
|
3821
|
+
/**
|
|
3822
|
+
* @description Uniquely identifies the command.
|
|
2955
3823
|
* The triple (user_id, submitter, command_id) constitutes the change ID for the intended ledger change.
|
|
2956
3824
|
* The change ID can be used for matching the intended ledger changes with all their completions.
|
|
2957
3825
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2958
|
-
* Required
|
|
3826
|
+
* Required
|
|
3827
|
+
*/
|
|
2959
3828
|
commandId: string;
|
|
2960
|
-
/**
|
|
3829
|
+
/**
|
|
3830
|
+
* @description Party on whose behalf the command should be executed.
|
|
2961
3831
|
* If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request
|
|
2962
3832
|
* to act on behalf of the given party.
|
|
2963
3833
|
* Must be a valid PartyIdString (as described in ``value.proto``).
|
|
2964
|
-
* Required
|
|
3834
|
+
* Required
|
|
3835
|
+
*/
|
|
2965
3836
|
submitter: string;
|
|
2966
|
-
/**
|
|
3837
|
+
/**
|
|
3838
|
+
* @description A unique identifier to distinguish completions for different submissions with the same change ID.
|
|
2967
3839
|
* Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission
|
|
2968
3840
|
* with the same change ID.
|
|
2969
3841
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
2970
3842
|
*
|
|
2971
3843
|
* If omitted, the participant or the committer may set a value of their choice.
|
|
2972
|
-
* Optional
|
|
3844
|
+
* Optional
|
|
3845
|
+
*/
|
|
2973
3846
|
submissionId: string;
|
|
2974
3847
|
/** @description Individual elements of this reassignment. Must be non-empty. */
|
|
2975
3848
|
commands?: components["schemas"]["ReassignmentCommand"][];
|
|
@@ -2981,14 +3854,20 @@ export interface components {
|
|
|
2981
3854
|
* Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``
|
|
2982
3855
|
*/
|
|
2983
3856
|
RevokeUserRightsRequest: {
|
|
2984
|
-
/**
|
|
2985
|
-
*
|
|
3857
|
+
/**
|
|
3858
|
+
* @description The user from whom to revoke rights.
|
|
3859
|
+
* Required
|
|
3860
|
+
*/
|
|
2986
3861
|
userId: string;
|
|
2987
|
-
/**
|
|
2988
|
-
*
|
|
3862
|
+
/**
|
|
3863
|
+
* @description The rights to revoke.
|
|
3864
|
+
* Optional
|
|
3865
|
+
*/
|
|
2989
3866
|
rights?: components["schemas"]["Right"][];
|
|
2990
|
-
/**
|
|
2991
|
-
*
|
|
3867
|
+
/**
|
|
3868
|
+
* @description The id of the ``Identity Provider``
|
|
3869
|
+
* Optional, if not set, assume the user is managed by the default identity provider.
|
|
3870
|
+
*/
|
|
2992
3871
|
identityProviderId: string;
|
|
2993
3872
|
};
|
|
2994
3873
|
/** RevokeUserRightsResponse */
|
|
@@ -3003,6 +3882,14 @@ export interface components {
|
|
|
3003
3882
|
Right: {
|
|
3004
3883
|
kind: components["schemas"]["Kind"];
|
|
3005
3884
|
};
|
|
3885
|
+
/** Serial */
|
|
3886
|
+
Serial: {
|
|
3887
|
+
Empty: components["schemas"]["Empty5"];
|
|
3888
|
+
} | {
|
|
3889
|
+
NoPrior: components["schemas"]["NoPrior"];
|
|
3890
|
+
} | {
|
|
3891
|
+
Prior: components["schemas"]["Prior"];
|
|
3892
|
+
};
|
|
3006
3893
|
/** Signature */
|
|
3007
3894
|
Signature: {
|
|
3008
3895
|
format: string;
|
|
@@ -3037,37 +3924,41 @@ export interface components {
|
|
|
3037
3924
|
* @description Signatures provided by a single party
|
|
3038
3925
|
*/
|
|
3039
3926
|
SinglePartySignatures: {
|
|
3040
|
-
/**
|
|
3927
|
+
/**
|
|
3928
|
+
* @description Submitting party
|
|
3929
|
+
* Required
|
|
3930
|
+
*/
|
|
3041
3931
|
party: string;
|
|
3042
|
-
/**
|
|
3932
|
+
/**
|
|
3933
|
+
* @description Signatures
|
|
3934
|
+
* Required
|
|
3935
|
+
*/
|
|
3043
3936
|
signatures?: components["schemas"]["Signature"][];
|
|
3044
3937
|
};
|
|
3045
|
-
/** Status */
|
|
3046
|
-
Status: {
|
|
3047
|
-
/** Format: int32 */
|
|
3048
|
-
code: number;
|
|
3049
|
-
message: string;
|
|
3050
|
-
details?: components["schemas"]["ProtoAny"][];
|
|
3051
|
-
unknownFields: components["schemas"]["UnknownFieldSet"];
|
|
3052
|
-
};
|
|
3053
3938
|
/**
|
|
3054
3939
|
* SubmitAndWaitForReassignmentRequest
|
|
3055
3940
|
* @description This reassignment is executed as a single atomic update.
|
|
3056
3941
|
*/
|
|
3057
3942
|
SubmitAndWaitForReassignmentRequest: {
|
|
3058
|
-
/**
|
|
3059
|
-
*
|
|
3943
|
+
/**
|
|
3944
|
+
* @description The reassignment commands to be submitted.
|
|
3945
|
+
* Required
|
|
3946
|
+
*/
|
|
3060
3947
|
reassignmentCommands?: components["schemas"]["ReassignmentCommands"];
|
|
3061
|
-
/**
|
|
3948
|
+
/**
|
|
3949
|
+
* @description Optional
|
|
3062
3950
|
* If no event_format provided, the result will contain no events.
|
|
3063
|
-
* The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA.
|
|
3951
|
+
* The events in the result, will take shape TRANSACTION_SHAPE_ACS_DELTA.
|
|
3952
|
+
*/
|
|
3064
3953
|
eventFormat?: components["schemas"]["EventFormat"];
|
|
3065
3954
|
};
|
|
3066
3955
|
/** SubmitAndWaitResponse */
|
|
3067
3956
|
SubmitAndWaitResponse: {
|
|
3068
|
-
/**
|
|
3957
|
+
/**
|
|
3958
|
+
* @description The id of the transaction that resulted from the submitted command.
|
|
3069
3959
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
3070
|
-
* Required
|
|
3960
|
+
* Required
|
|
3961
|
+
*/
|
|
3071
3962
|
updateId: string;
|
|
3072
3963
|
/**
|
|
3073
3964
|
* Format: int64
|
|
@@ -3078,8 +3969,10 @@ export interface components {
|
|
|
3078
3969
|
};
|
|
3079
3970
|
/** SubmitReassignmentRequest */
|
|
3080
3971
|
SubmitReassignmentRequest: {
|
|
3081
|
-
/**
|
|
3082
|
-
*
|
|
3972
|
+
/**
|
|
3973
|
+
* @description The reassignment command to be submitted.
|
|
3974
|
+
* Required
|
|
3975
|
+
*/
|
|
3083
3976
|
reassignmentCommands?: components["schemas"]["ReassignmentCommands"];
|
|
3084
3977
|
};
|
|
3085
3978
|
/** SubmitReassignmentResponse */
|
|
@@ -3088,11 +3981,15 @@ export interface components {
|
|
|
3088
3981
|
SubmitResponse: Record<string, never>;
|
|
3089
3982
|
/** SynchronizerTime */
|
|
3090
3983
|
SynchronizerTime: {
|
|
3091
|
-
/**
|
|
3092
|
-
*
|
|
3984
|
+
/**
|
|
3985
|
+
* @description The id of the synchronizer.
|
|
3986
|
+
* Required
|
|
3987
|
+
*/
|
|
3093
3988
|
synchronizerId: string;
|
|
3094
|
-
/**
|
|
3095
|
-
*
|
|
3989
|
+
/**
|
|
3990
|
+
* @description All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.
|
|
3991
|
+
* Required
|
|
3992
|
+
*/
|
|
3096
3993
|
recordTime?: string;
|
|
3097
3994
|
};
|
|
3098
3995
|
/**
|
|
@@ -3107,23 +4004,27 @@ export interface components {
|
|
|
3107
4004
|
* @description This filter matches contracts of a specific template.
|
|
3108
4005
|
*/
|
|
3109
4006
|
TemplateFilter1: {
|
|
3110
|
-
/**
|
|
4007
|
+
/**
|
|
4008
|
+
* @description A template for which the payload should be included in the response.
|
|
3111
4009
|
* The ``template_id`` needs to be valid: corresponding template should be defined in
|
|
3112
4010
|
* one of the available packages at the time of the query.
|
|
3113
4011
|
* Both package-name and package-id reference formats for the identifier are supported.
|
|
3114
4012
|
* Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.
|
|
3115
4013
|
*
|
|
3116
|
-
* Required
|
|
4014
|
+
* Required
|
|
4015
|
+
*/
|
|
3117
4016
|
templateId?: string;
|
|
3118
|
-
/**
|
|
4017
|
+
/**
|
|
4018
|
+
* @description Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
|
|
3119
4019
|
* Use this to access the contract event payload in your API client
|
|
3120
4020
|
* for submitting it as a disclosed contract with future commands.
|
|
3121
|
-
* Optional
|
|
4021
|
+
* Optional
|
|
4022
|
+
*/
|
|
3122
4023
|
includeCreatedEventBlob: boolean;
|
|
3123
4024
|
};
|
|
3124
4025
|
/** Time */
|
|
3125
4026
|
Time: {
|
|
3126
|
-
Empty: components["schemas"]["
|
|
4027
|
+
Empty: components["schemas"]["Empty9"];
|
|
3127
4028
|
} | {
|
|
3128
4029
|
MinLedgerTimeAbs: components["schemas"]["MinLedgerTimeAbs"];
|
|
3129
4030
|
} | {
|
|
@@ -3131,6 +4032,12 @@ export interface components {
|
|
|
3131
4032
|
};
|
|
3132
4033
|
/** TopologyEvent */
|
|
3133
4034
|
TopologyEvent: {
|
|
4035
|
+
event: components["schemas"]["TopologyEventEvent"];
|
|
4036
|
+
};
|
|
4037
|
+
/** TopologyEventEvent */
|
|
4038
|
+
TopologyEventEvent: {
|
|
4039
|
+
Empty: components["schemas"]["Empty7"];
|
|
4040
|
+
} | {
|
|
3134
4041
|
ParticipantAuthorizationAdded: components["schemas"]["ParticipantAuthorizationAdded"];
|
|
3135
4042
|
} | {
|
|
3136
4043
|
ParticipantAuthorizationChanged: components["schemas"]["ParticipantAuthorizationChanged"];
|
|
@@ -3142,10 +4049,39 @@ export interface components {
|
|
|
3142
4049
|
* @description A format specifying which topology transactions to include and how to render them.
|
|
3143
4050
|
*/
|
|
3144
4051
|
TopologyFormat: {
|
|
3145
|
-
/**
|
|
3146
|
-
*
|
|
4052
|
+
/**
|
|
4053
|
+
* @description Include participant authorization topology events in streams.
|
|
4054
|
+
* Optional, if unset no participant authorization topology events are emitted in the stream.
|
|
4055
|
+
*/
|
|
3147
4056
|
includeParticipantAuthorizationEvents?: components["schemas"]["ParticipantAuthorizationTopologyFormat"];
|
|
3148
4057
|
};
|
|
4058
|
+
/**
|
|
4059
|
+
* TopologyStateFilter
|
|
4060
|
+
* @description Filter the vetted packages by the participant and synchronizer that they are
|
|
4061
|
+
* hosted on.
|
|
4062
|
+
*
|
|
4063
|
+
* Empty fields are ignored, such that a ``TopologyStateFilter`` without
|
|
4064
|
+
* participant_ids and without synchronizer_ids matches a vetted package hosted
|
|
4065
|
+
* on any participant and synchronizer.
|
|
4066
|
+
*
|
|
4067
|
+
* Non-empty fields specify candidate values of which at least one must match.
|
|
4068
|
+
* If both fields are set then at least one candidate value must match from each
|
|
4069
|
+
* field.
|
|
4070
|
+
*/
|
|
4071
|
+
TopologyStateFilter: {
|
|
4072
|
+
/**
|
|
4073
|
+
* @description If this list is non-empty, only vetted packages hosted on participants
|
|
4074
|
+
* listed in this field match the filter.
|
|
4075
|
+
* Query the current Ledger API's participant's ID via the public
|
|
4076
|
+
* ``GetParticipantId`` command in ``PartyManagementService``.
|
|
4077
|
+
*/
|
|
4078
|
+
participantIds?: string[];
|
|
4079
|
+
/**
|
|
4080
|
+
* @description If this list is non-empty, only vetted packages from the topology state of
|
|
4081
|
+
* the synchronizers in this list match the filter.
|
|
4082
|
+
*/
|
|
4083
|
+
synchronizerIds?: string[];
|
|
4084
|
+
};
|
|
3149
4085
|
/** TopologyTransaction */
|
|
3150
4086
|
TopologyTransaction: {
|
|
3151
4087
|
value: components["schemas"]["JsTopologyTransaction"];
|
|
@@ -3165,11 +4101,12 @@ export interface components {
|
|
|
3165
4101
|
};
|
|
3166
4102
|
/**
|
|
3167
4103
|
* TransactionFilter
|
|
3168
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
4104
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
3169
4105
|
* Used both for filtering create and archive events as well as for filtering transaction trees.
|
|
3170
4106
|
*/
|
|
3171
4107
|
TransactionFilter: {
|
|
3172
|
-
/**
|
|
4108
|
+
/**
|
|
4109
|
+
* @description Each key must be a valid PartyIdString (as described in ``value.proto``).
|
|
3173
4110
|
* The interpretation of the filter depends on the transaction-shape being filtered:
|
|
3174
4111
|
*
|
|
3175
4112
|
* 1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as
|
|
@@ -3180,11 +4117,12 @@ export interface components {
|
|
|
3180
4117
|
* the listed parties and match the per-party filter.
|
|
3181
4118
|
* 3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose
|
|
3182
4119
|
* stakeholders include at least one of the listed parties and match the per-party filter.
|
|
3183
|
-
|
|
3184
|
-
* Required */
|
|
4120
|
+
*/
|
|
3185
4121
|
filtersByParty: components["schemas"]["Map_Filters"];
|
|
3186
|
-
/**
|
|
3187
|
-
*
|
|
4122
|
+
/**
|
|
4123
|
+
* @description Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same
|
|
4124
|
+
* with the per-party filter as described above.
|
|
4125
|
+
*/
|
|
3188
4126
|
filtersForAnyParty?: components["schemas"]["Filters"];
|
|
3189
4127
|
};
|
|
3190
4128
|
/**
|
|
@@ -3195,13 +4133,16 @@ export interface components {
|
|
|
3195
4133
|
TransactionFormat: {
|
|
3196
4134
|
/** @description Required */
|
|
3197
4135
|
eventFormat?: components["schemas"]["EventFormat"];
|
|
3198
|
-
/**
|
|
3199
|
-
*
|
|
3200
|
-
|
|
4136
|
+
/**
|
|
4137
|
+
* @description What transaction shape to use for interpreting the filters of the event format.
|
|
4138
|
+
* Required
|
|
4139
|
+
* @enum {string}
|
|
4140
|
+
*/
|
|
4141
|
+
transactionShape: "TRANSACTION_SHAPE_UNSPECIFIED" | "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS";
|
|
3201
4142
|
};
|
|
3202
4143
|
/**
|
|
3203
4144
|
* TransactionTree
|
|
3204
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
4145
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
3205
4146
|
* Complete view of an on-ledger transaction.
|
|
3206
4147
|
*/
|
|
3207
4148
|
TransactionTree: {
|
|
@@ -3209,7 +4150,7 @@ export interface components {
|
|
|
3209
4150
|
};
|
|
3210
4151
|
/**
|
|
3211
4152
|
* TreeEvent
|
|
3212
|
-
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.
|
|
4153
|
+
* @description Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.
|
|
3213
4154
|
* Each tree event message type below contains a ``witness_parties`` field which
|
|
3214
4155
|
* indicates the subset of the requested parties that can see the event
|
|
3215
4156
|
* in question.
|
|
@@ -3237,17 +4178,23 @@ export interface components {
|
|
|
3237
4178
|
* @description Unassign a contract
|
|
3238
4179
|
*/
|
|
3239
4180
|
UnassignCommand1: {
|
|
3240
|
-
/**
|
|
4181
|
+
/**
|
|
4182
|
+
* @description The ID of the contract the client wants to unassign.
|
|
3241
4183
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
3242
|
-
* Required
|
|
4184
|
+
* Required
|
|
4185
|
+
*/
|
|
3243
4186
|
contractId: string;
|
|
3244
|
-
/**
|
|
4187
|
+
/**
|
|
4188
|
+
* @description The ID of the source synchronizer
|
|
3245
4189
|
* Must be a valid synchronizer id
|
|
3246
|
-
* Required
|
|
4190
|
+
* Required
|
|
4191
|
+
*/
|
|
3247
4192
|
source: string;
|
|
3248
|
-
/**
|
|
4193
|
+
/**
|
|
4194
|
+
* @description The ID of the target synchronizer
|
|
3249
4195
|
* Must be a valid synchronizer id
|
|
3250
|
-
* Required
|
|
4196
|
+
* Required
|
|
4197
|
+
*/
|
|
3251
4198
|
target: string;
|
|
3252
4199
|
};
|
|
3253
4200
|
/**
|
|
@@ -3255,32 +4202,43 @@ export interface components {
|
|
|
3255
4202
|
* @description Records that a contract has been unassigned, and it becomes unusable on the source synchronizer
|
|
3256
4203
|
*/
|
|
3257
4204
|
UnassignedEvent: {
|
|
3258
|
-
/**
|
|
3259
|
-
*
|
|
4205
|
+
/**
|
|
4206
|
+
* @description The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand.
|
|
3260
4207
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
3261
|
-
* Required
|
|
3262
|
-
|
|
3263
|
-
|
|
4208
|
+
* Required
|
|
4209
|
+
*/
|
|
4210
|
+
reassignmentId: string;
|
|
4211
|
+
/**
|
|
4212
|
+
* @description The ID of the reassigned contract.
|
|
3264
4213
|
* Must be a valid LedgerString (as described in ``value.proto``).
|
|
3265
|
-
* Required
|
|
4214
|
+
* Required
|
|
4215
|
+
*/
|
|
3266
4216
|
contractId: string;
|
|
3267
|
-
/**
|
|
4217
|
+
/**
|
|
4218
|
+
* @description The template of the reassigned contract.
|
|
3268
4219
|
* The identifier uses the package-id reference format.
|
|
3269
4220
|
*
|
|
3270
|
-
* Required
|
|
4221
|
+
* Required
|
|
4222
|
+
*/
|
|
3271
4223
|
templateId?: string;
|
|
3272
|
-
/**
|
|
4224
|
+
/**
|
|
4225
|
+
* @description The ID of the source synchronizer
|
|
3273
4226
|
* Must be a valid synchronizer id
|
|
3274
|
-
* Required
|
|
4227
|
+
* Required
|
|
4228
|
+
*/
|
|
3275
4229
|
source: string;
|
|
3276
|
-
/**
|
|
4230
|
+
/**
|
|
4231
|
+
* @description The ID of the target synchronizer
|
|
3277
4232
|
* Must be a valid synchronizer id
|
|
3278
|
-
* Required
|
|
4233
|
+
* Required
|
|
4234
|
+
*/
|
|
3279
4235
|
target: string;
|
|
3280
|
-
/**
|
|
4236
|
+
/**
|
|
4237
|
+
* @description Party on whose behalf the unassign command was executed.
|
|
3281
4238
|
* Empty if the unassignment happened offline via the repair service.
|
|
3282
4239
|
* Must be a valid PartyIdString (as described in ``value.proto``).
|
|
3283
|
-
* Optional
|
|
4240
|
+
* Optional
|
|
4241
|
+
*/
|
|
3284
4242
|
submitter: string;
|
|
3285
4243
|
/**
|
|
3286
4244
|
* Format: int64
|
|
@@ -3290,16 +4248,22 @@ export interface components {
|
|
|
3290
4248
|
* Required
|
|
3291
4249
|
*/
|
|
3292
4250
|
reassignmentCounter: number;
|
|
3293
|
-
/**
|
|
4251
|
+
/**
|
|
4252
|
+
* @description Assignment exclusivity
|
|
3294
4253
|
* Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment
|
|
3295
4254
|
* Defined for reassigning participants.
|
|
3296
|
-
* Optional
|
|
4255
|
+
* Optional
|
|
4256
|
+
*/
|
|
3297
4257
|
assignmentExclusivity?: string;
|
|
3298
|
-
/**
|
|
3299
|
-
*
|
|
4258
|
+
/**
|
|
4259
|
+
* @description The parties that are notified of this event.
|
|
4260
|
+
* Required
|
|
4261
|
+
*/
|
|
3300
4262
|
witnessParties?: string[];
|
|
3301
|
-
/**
|
|
3302
|
-
*
|
|
4263
|
+
/**
|
|
4264
|
+
* @description The package name of the contract.
|
|
4265
|
+
* Required
|
|
4266
|
+
*/
|
|
3303
4267
|
packageName: string;
|
|
3304
4268
|
/**
|
|
3305
4269
|
* Format: int64
|
|
@@ -3322,6 +4286,14 @@ export interface components {
|
|
|
3322
4286
|
UnknownFieldSet: {
|
|
3323
4287
|
fields: components["schemas"]["Map_Int_Field"];
|
|
3324
4288
|
};
|
|
4289
|
+
/** Unvet */
|
|
4290
|
+
Unvet: {
|
|
4291
|
+
value: components["schemas"]["Unvet1"];
|
|
4292
|
+
};
|
|
4293
|
+
/** Unvet */
|
|
4294
|
+
Unvet1: {
|
|
4295
|
+
packages?: components["schemas"]["VettedPackagesRef"][];
|
|
4296
|
+
};
|
|
3325
4297
|
/** Update */
|
|
3326
4298
|
Update: {
|
|
3327
4299
|
OffsetCheckpoint: components["schemas"]["OffsetCheckpoint2"];
|
|
@@ -3332,10 +4304,7 @@ export interface components {
|
|
|
3332
4304
|
} | {
|
|
3333
4305
|
Transaction: components["schemas"]["Transaction"];
|
|
3334
4306
|
};
|
|
3335
|
-
/**
|
|
3336
|
-
* Update
|
|
3337
|
-
* @description The update that matches the filter in the request.
|
|
3338
|
-
*/
|
|
4307
|
+
/** Update */
|
|
3339
4308
|
Update1: {
|
|
3340
4309
|
OffsetCheckpoint: components["schemas"]["OffsetCheckpoint3"];
|
|
3341
4310
|
} | {
|
|
@@ -3348,24 +4317,33 @@ export interface components {
|
|
|
3348
4317
|
* @description A format specifying what updates to include and how to render them.
|
|
3349
4318
|
*/
|
|
3350
4319
|
UpdateFormat: {
|
|
3351
|
-
/**
|
|
3352
|
-
*
|
|
4320
|
+
/**
|
|
4321
|
+
* @description Include Daml transactions in streams.
|
|
4322
|
+
* Optional, if unset, no transactions are emitted in the stream.
|
|
4323
|
+
*/
|
|
3353
4324
|
includeTransactions?: components["schemas"]["TransactionFormat"];
|
|
3354
|
-
/**
|
|
4325
|
+
/**
|
|
4326
|
+
* @description Include (un)assignments in the stream.
|
|
3355
4327
|
* The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA.
|
|
3356
|
-
* Optional, if unset, no (un)assignments are emitted in the stream.
|
|
4328
|
+
* Optional, if unset, no (un)assignments are emitted in the stream.
|
|
4329
|
+
*/
|
|
3357
4330
|
includeReassignments?: components["schemas"]["EventFormat"];
|
|
3358
|
-
/**
|
|
3359
|
-
*
|
|
4331
|
+
/**
|
|
4332
|
+
* @description Include topology events in streams.
|
|
4333
|
+
* Optional, if unset no topology events are emitted in the stream.
|
|
4334
|
+
*/
|
|
3360
4335
|
includeTopologyEvents?: components["schemas"]["TopologyFormat"];
|
|
3361
4336
|
};
|
|
3362
4337
|
/** UpdateIdentityProviderConfigRequest */
|
|
3363
4338
|
UpdateIdentityProviderConfigRequest: {
|
|
3364
|
-
/**
|
|
4339
|
+
/**
|
|
4340
|
+
* @description The identity provider config to update.
|
|
3365
4341
|
* Required,
|
|
3366
|
-
* Modifiable
|
|
4342
|
+
* Modifiable
|
|
4343
|
+
*/
|
|
3367
4344
|
identityProviderConfig?: components["schemas"]["IdentityProviderConfig"];
|
|
3368
|
-
/**
|
|
4345
|
+
/**
|
|
4346
|
+
* @description An update mask specifies how and which properties of the ``IdentityProviderConfig`` message are to be updated.
|
|
3369
4347
|
* An update mask consists of a set of update paths.
|
|
3370
4348
|
* A valid update path points to a field or a subfield relative to the ``IdentityProviderConfig`` message.
|
|
3371
4349
|
* A valid update mask must:
|
|
@@ -3375,7 +4353,8 @@ export interface components {
|
|
|
3375
4353
|
*
|
|
3376
4354
|
* Fields that can be updated are marked as ``Modifiable``.
|
|
3377
4355
|
* For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
|
|
3378
|
-
* Required
|
|
4356
|
+
* Required
|
|
4357
|
+
*/
|
|
3379
4358
|
updateMask?: components["schemas"]["FieldMask"];
|
|
3380
4359
|
};
|
|
3381
4360
|
/** UpdateIdentityProviderConfigResponse */
|
|
@@ -3388,11 +4367,14 @@ export interface components {
|
|
|
3388
4367
|
* @description Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(party_details.identity_provider_id)``
|
|
3389
4368
|
*/
|
|
3390
4369
|
UpdatePartyDetailsRequest: {
|
|
3391
|
-
/**
|
|
4370
|
+
/**
|
|
4371
|
+
* @description Party to be updated
|
|
3392
4372
|
* Required,
|
|
3393
|
-
* Modifiable
|
|
4373
|
+
* Modifiable
|
|
4374
|
+
*/
|
|
3394
4375
|
partyDetails?: components["schemas"]["PartyDetails"];
|
|
3395
|
-
/**
|
|
4376
|
+
/**
|
|
4377
|
+
* @description An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated.
|
|
3396
4378
|
* An update mask consists of a set of update paths.
|
|
3397
4379
|
* A valid update path points to a field or a subfield relative to the ``PartyDetails`` message.
|
|
3398
4380
|
* A valid update mask must:
|
|
@@ -3412,7 +4394,8 @@ export interface components {
|
|
|
3412
4394
|
* Examples of update paths: 'local_metadata.annotations', 'local_metadata'.
|
|
3413
4395
|
* For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
|
|
3414
4396
|
* For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``.
|
|
3415
|
-
* Required
|
|
4397
|
+
* Required
|
|
4398
|
+
*/
|
|
3416
4399
|
updateMask?: components["schemas"]["FieldMask"];
|
|
3417
4400
|
};
|
|
3418
4401
|
/** UpdatePartyDetailsResponse */
|
|
@@ -3439,11 +4422,14 @@ export interface components {
|
|
|
3439
4422
|
* @description Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)``
|
|
3440
4423
|
*/
|
|
3441
4424
|
UpdateUserRequest: {
|
|
3442
|
-
/**
|
|
4425
|
+
/**
|
|
4426
|
+
* @description The user to update.
|
|
3443
4427
|
* Required,
|
|
3444
|
-
* Modifiable
|
|
4428
|
+
* Modifiable
|
|
4429
|
+
*/
|
|
3445
4430
|
user?: components["schemas"]["User"];
|
|
3446
|
-
/**
|
|
4431
|
+
/**
|
|
4432
|
+
* @description An update mask specifies how and which properties of the ``User`` message are to be updated.
|
|
3447
4433
|
* An update mask consists of a set of update paths.
|
|
3448
4434
|
* A valid update path points to a field or a subfield relative to the ``User`` message.
|
|
3449
4435
|
* A valid update mask must:
|
|
@@ -3461,7 +4447,8 @@ export interface components {
|
|
|
3461
4447
|
* Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
|
|
3462
4448
|
* For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
|
|
3463
4449
|
* For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest``.
|
|
3464
|
-
* Required
|
|
4450
|
+
* Required
|
|
4451
|
+
*/
|
|
3465
4452
|
updateMask?: components["schemas"]["FieldMask"];
|
|
3466
4453
|
};
|
|
3467
4454
|
/** UpdateUserResponse */
|
|
@@ -3469,6 +4456,57 @@ export interface components {
|
|
|
3469
4456
|
/** @description Updated user */
|
|
3470
4457
|
user?: components["schemas"]["User"];
|
|
3471
4458
|
};
|
|
4459
|
+
/** UpdateVettedPackagesRequest */
|
|
4460
|
+
UpdateVettedPackagesRequest: {
|
|
4461
|
+
/**
|
|
4462
|
+
* @description Changes to apply to the current vetting state of the participant on the
|
|
4463
|
+
* specified synchronizer. The changes are applied in order.
|
|
4464
|
+
* Any package not changed will keep their previous vetting state.
|
|
4465
|
+
*/
|
|
4466
|
+
changes?: components["schemas"]["VettedPackagesChange"][];
|
|
4467
|
+
/**
|
|
4468
|
+
* @description If dry_run is true, then the changes are only prepared, but not applied. If
|
|
4469
|
+
* a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED),
|
|
4470
|
+
* it will also trigger an error when dry_run.
|
|
4471
|
+
*
|
|
4472
|
+
* Use this flag to preview a change before applying it.
|
|
4473
|
+
*/
|
|
4474
|
+
dryRun: boolean;
|
|
4475
|
+
/**
|
|
4476
|
+
* @description If set, the requested changes will take place on the specified
|
|
4477
|
+
* synchronizer. If synchronizer_id is unset and the participant is only
|
|
4478
|
+
* connected to a single synchronizer, that synchronizer will be used by
|
|
4479
|
+
* default. If synchronizer_id is unset and the participant is connected to
|
|
4480
|
+
* multiple synchronizers, the request will error out with
|
|
4481
|
+
* PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.
|
|
4482
|
+
*
|
|
4483
|
+
* Optional
|
|
4484
|
+
*/
|
|
4485
|
+
synchronizerId: string;
|
|
4486
|
+
/**
|
|
4487
|
+
* @description The serial of the last ``VettedPackages`` topology transaction of this
|
|
4488
|
+
* participant and on this synchronizer.
|
|
4489
|
+
*
|
|
4490
|
+
* Execution of the request fails if this is not correct. Use this to guard
|
|
4491
|
+
* against concurrent changes.
|
|
4492
|
+
*
|
|
4493
|
+
* If left unspecified, no validation is done against the last transaction's
|
|
4494
|
+
* serial.
|
|
4495
|
+
*
|
|
4496
|
+
* Optional
|
|
4497
|
+
*/
|
|
4498
|
+
expectedTopologySerial?: components["schemas"]["PriorTopologySerial"];
|
|
4499
|
+
};
|
|
4500
|
+
/** UpdateVettedPackagesResponse */
|
|
4501
|
+
UpdateVettedPackagesResponse: {
|
|
4502
|
+
/**
|
|
4503
|
+
* @description All vetted packages on this participant and synchronizer, before the
|
|
4504
|
+
* specified changes. Empty if no vetting state existed beforehand.
|
|
4505
|
+
*/
|
|
4506
|
+
pastVettedPackages?: components["schemas"]["VettedPackages"];
|
|
4507
|
+
/** @description All vetted packages on this participant and synchronizer, after the specified changes. */
|
|
4508
|
+
newVettedPackages?: components["schemas"]["VettedPackages"];
|
|
4509
|
+
};
|
|
3472
4510
|
/**
|
|
3473
4511
|
* UploadDarFileResponse
|
|
3474
4512
|
* @description A message that is received when the upload operation succeeded.
|
|
@@ -3476,37 +4514,47 @@ export interface components {
|
|
|
3476
4514
|
UploadDarFileResponse: Record<string, never>;
|
|
3477
4515
|
/**
|
|
3478
4516
|
* User
|
|
3479
|
-
* @description
|
|
4517
|
+
* @description Users and rights
|
|
3480
4518
|
* /////////////////
|
|
3481
4519
|
* Users are used to dynamically manage the rights given to Daml applications.
|
|
3482
4520
|
* They are stored and managed per participant node.
|
|
3483
4521
|
*/
|
|
3484
4522
|
User: {
|
|
3485
|
-
/**
|
|
4523
|
+
/**
|
|
4524
|
+
* @description The user identifier, which must be a non-empty string of at most 128
|
|
3486
4525
|
* characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
|
|
3487
|
-
* Required
|
|
4526
|
+
* Required
|
|
4527
|
+
*/
|
|
3488
4528
|
id: string;
|
|
3489
|
-
/**
|
|
4529
|
+
/**
|
|
4530
|
+
* @description The primary party as which this user reads and acts by default on the ledger
|
|
3490
4531
|
* *provided* it has the corresponding ``CanReadAs(primary_party)`` or
|
|
3491
4532
|
* ``CanActAs(primary_party)`` rights.
|
|
3492
4533
|
* Ledger API clients SHOULD set this field to a non-empty value for all users to
|
|
3493
4534
|
* enable the users to act on the ledger using their own Daml party.
|
|
3494
4535
|
* Users for participant administrators MAY have an associated primary party.
|
|
3495
4536
|
* Optional,
|
|
3496
|
-
* Modifiable
|
|
4537
|
+
* Modifiable
|
|
4538
|
+
*/
|
|
3497
4539
|
primaryParty: string;
|
|
3498
|
-
/**
|
|
4540
|
+
/**
|
|
4541
|
+
* @description When set, then the user is denied all access to the Ledger API.
|
|
3499
4542
|
* Otherwise, the user has access to the Ledger API as per the user's rights.
|
|
3500
4543
|
* Optional,
|
|
3501
|
-
* Modifiable
|
|
4544
|
+
* Modifiable
|
|
4545
|
+
*/
|
|
3502
4546
|
isDeactivated: boolean;
|
|
3503
|
-
/**
|
|
4547
|
+
/**
|
|
4548
|
+
* @description The metadata of this user.
|
|
3504
4549
|
* Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
|
|
3505
4550
|
* Optional,
|
|
3506
|
-
* Modifiable
|
|
4551
|
+
* Modifiable
|
|
4552
|
+
*/
|
|
3507
4553
|
metadata?: components["schemas"]["ObjectMeta"];
|
|
3508
|
-
/**
|
|
3509
|
-
*
|
|
4554
|
+
/**
|
|
4555
|
+
* @description The ID of the identity provider configured by ``Identity Provider Config``
|
|
4556
|
+
* Optional, if not set, assume the user is managed by the default identity provider.
|
|
4557
|
+
*/
|
|
3510
4558
|
identityProviderId: string;
|
|
3511
4559
|
};
|
|
3512
4560
|
/** UserManagementFeature */
|
|
@@ -3528,6 +4576,109 @@ export interface components {
|
|
|
3528
4576
|
*/
|
|
3529
4577
|
maxUsersPageSize: number;
|
|
3530
4578
|
};
|
|
4579
|
+
/** Vet */
|
|
4580
|
+
Vet: {
|
|
4581
|
+
value: components["schemas"]["Vet1"];
|
|
4582
|
+
};
|
|
4583
|
+
/** Vet */
|
|
4584
|
+
Vet1: {
|
|
4585
|
+
packages?: components["schemas"]["VettedPackagesRef"][];
|
|
4586
|
+
newValidFromInclusive?: string;
|
|
4587
|
+
newValidUntilExclusive?: string;
|
|
4588
|
+
};
|
|
4589
|
+
/**
|
|
4590
|
+
* VettedPackage
|
|
4591
|
+
* @description A package that is vetting on a given participant and synchronizer,
|
|
4592
|
+
* modelled after ``VettedPackage`` in `topology.proto <https://github.com/digital-asset/canton/blob/main/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L206>`_,
|
|
4593
|
+
* enriched with the package name and version.
|
|
4594
|
+
*/
|
|
4595
|
+
VettedPackage: {
|
|
4596
|
+
/** @description Package ID of this package. Always present. */
|
|
4597
|
+
packageId: string;
|
|
4598
|
+
/**
|
|
4599
|
+
* @description The time from which this package is vetted. Empty if vetting time has no
|
|
4600
|
+
* lower bound.
|
|
4601
|
+
*/
|
|
4602
|
+
validFromInclusive?: string;
|
|
4603
|
+
/**
|
|
4604
|
+
* @description The time until which this package is vetted. Empty if vetting time has no
|
|
4605
|
+
* upper bound.
|
|
4606
|
+
*/
|
|
4607
|
+
validUntilExclusive?: string;
|
|
4608
|
+
/**
|
|
4609
|
+
* @description Name of this package.
|
|
4610
|
+
* Only available if the package has been uploaded to the current participant.
|
|
4611
|
+
* If unavailable, is empty string.
|
|
4612
|
+
*/
|
|
4613
|
+
packageName: string;
|
|
4614
|
+
/**
|
|
4615
|
+
* @description Version of this package.
|
|
4616
|
+
* Only available if the package has been uploaded to the current participant.
|
|
4617
|
+
* If unavailable, is empty string.
|
|
4618
|
+
*/
|
|
4619
|
+
packageVersion: string;
|
|
4620
|
+
};
|
|
4621
|
+
/**
|
|
4622
|
+
* VettedPackages
|
|
4623
|
+
* @description The list of packages vetted on a given participant and synchronizer, modelled
|
|
4624
|
+
* after ``VettedPackages`` in `topology.proto <https://github.com/digital-asset/canton/blob/main/community/base/src/main/protobuf/com/digitalasset/canton/protocol/v30/topology.proto#L206>`_.
|
|
4625
|
+
* The list only contains packages that matched a filter in the query that
|
|
4626
|
+
* originated it.
|
|
4627
|
+
*/
|
|
4628
|
+
VettedPackages: {
|
|
4629
|
+
/**
|
|
4630
|
+
* @description Sorted by package_name and package_version where known, and package_id as a
|
|
4631
|
+
* last resort.
|
|
4632
|
+
*/
|
|
4633
|
+
packages?: components["schemas"]["VettedPackage"][];
|
|
4634
|
+
/** @description Participant on which these packages are vetted. Always present. */
|
|
4635
|
+
participantId: string;
|
|
4636
|
+
/** @description Synchronizer on which these packages are vetted. Always present. */
|
|
4637
|
+
synchronizerId: string;
|
|
4638
|
+
/**
|
|
4639
|
+
* @description Serial of last ``VettedPackages`` topology transaction of this participant
|
|
4640
|
+
* and on this synchronizer. Always present.
|
|
4641
|
+
*/
|
|
4642
|
+
topologySerial?: components["schemas"]["PriorTopologySerial"];
|
|
4643
|
+
};
|
|
4644
|
+
/**
|
|
4645
|
+
* VettedPackagesChange
|
|
4646
|
+
* @description A change to the set of vetted packages.
|
|
4647
|
+
*/
|
|
4648
|
+
VettedPackagesChange: {
|
|
4649
|
+
operation: components["schemas"]["Operation"];
|
|
4650
|
+
};
|
|
4651
|
+
/**
|
|
4652
|
+
* VettedPackagesRef
|
|
4653
|
+
* @description A reference to identify one or more packages.
|
|
4654
|
+
*
|
|
4655
|
+
* A reference matches a package if its ``package_id`` matches the package's ID,
|
|
4656
|
+
* its ``package_name`` matches the package's name, and its ``package_version``
|
|
4657
|
+
* matches the package's version. If an attribute in the reference is left
|
|
4658
|
+
* unspecified (i.e. as an empty string), that attribute is treated as a
|
|
4659
|
+
* wildcard. At a minimum, ``package_id`` or the ``package_name`` must be
|
|
4660
|
+
* specified.
|
|
4661
|
+
*
|
|
4662
|
+
* If a reference does not match any package, the reference is considered
|
|
4663
|
+
* unresolved and the entire update request is rejected.
|
|
4664
|
+
*/
|
|
4665
|
+
VettedPackagesRef: {
|
|
4666
|
+
/**
|
|
4667
|
+
* @description Package's package id must be the same as this field.
|
|
4668
|
+
* Optional
|
|
4669
|
+
*/
|
|
4670
|
+
packageId: string;
|
|
4671
|
+
/**
|
|
4672
|
+
* @description Package's name must be the same as this field.
|
|
4673
|
+
* Optional
|
|
4674
|
+
*/
|
|
4675
|
+
packageName: string;
|
|
4676
|
+
/**
|
|
4677
|
+
* @description Package's version must be the same as this field.
|
|
4678
|
+
* Optional
|
|
4679
|
+
*/
|
|
4680
|
+
packageVersion: string;
|
|
4681
|
+
};
|
|
3531
4682
|
/**
|
|
3532
4683
|
* WildcardFilter
|
|
3533
4684
|
* @description This filter matches all templates.
|
|
@@ -3540,10 +4691,12 @@ export interface components {
|
|
|
3540
4691
|
* @description This filter matches all templates.
|
|
3541
4692
|
*/
|
|
3542
4693
|
WildcardFilter1: {
|
|
3543
|
-
/**
|
|
4694
|
+
/**
|
|
4695
|
+
* @description Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.
|
|
3544
4696
|
* Use this to access the contract create event payload in your API client
|
|
3545
4697
|
* for submitting it as a disclosed contract with future commands.
|
|
3546
|
-
* Optional
|
|
4698
|
+
* Optional
|
|
4699
|
+
*/
|
|
3547
4700
|
includeCreatedEventBlob: boolean;
|
|
3548
4701
|
};
|
|
3549
4702
|
};
|
|
@@ -3954,7 +5107,10 @@ export interface operations {
|
|
|
3954
5107
|
};
|
|
3955
5108
|
postV2Packages: {
|
|
3956
5109
|
parameters: {
|
|
3957
|
-
query?:
|
|
5110
|
+
query?: {
|
|
5111
|
+
vetAllPackages?: boolean;
|
|
5112
|
+
synchronizerId?: string;
|
|
5113
|
+
};
|
|
3958
5114
|
header?: never;
|
|
3959
5115
|
path?: never;
|
|
3960
5116
|
cookie?: never;
|
|
@@ -3973,7 +5129,7 @@ export interface operations {
|
|
|
3973
5129
|
"application/json": components["schemas"]["UploadDarFileResponse"];
|
|
3974
5130
|
};
|
|
3975
5131
|
};
|
|
3976
|
-
/** @description Invalid value for: body, Invalid value for: headers */
|
|
5132
|
+
/** @description Invalid value for: body, Invalid value for: query parameter vetAllPackages, Invalid value for: query parameter synchronizerId, Invalid value for: headers */
|
|
3977
5133
|
400: {
|
|
3978
5134
|
headers: {
|
|
3979
5135
|
[name: string]: unknown;
|
|
@@ -4069,6 +5225,86 @@ export interface operations {
|
|
|
4069
5225
|
};
|
|
4070
5226
|
};
|
|
4071
5227
|
};
|
|
5228
|
+
"getV2Package-vetting": {
|
|
5229
|
+
parameters: {
|
|
5230
|
+
query?: never;
|
|
5231
|
+
header?: never;
|
|
5232
|
+
path?: never;
|
|
5233
|
+
cookie?: never;
|
|
5234
|
+
};
|
|
5235
|
+
requestBody: {
|
|
5236
|
+
content: {
|
|
5237
|
+
"application/json": components["schemas"]["ListVettedPackagesRequest"];
|
|
5238
|
+
};
|
|
5239
|
+
};
|
|
5240
|
+
responses: {
|
|
5241
|
+
200: {
|
|
5242
|
+
headers: {
|
|
5243
|
+
[name: string]: unknown;
|
|
5244
|
+
};
|
|
5245
|
+
content: {
|
|
5246
|
+
"application/json": components["schemas"]["ListVettedPackagesResponse"];
|
|
5247
|
+
};
|
|
5248
|
+
};
|
|
5249
|
+
/** @description Invalid value for: body, Invalid value for: headers */
|
|
5250
|
+
400: {
|
|
5251
|
+
headers: {
|
|
5252
|
+
[name: string]: unknown;
|
|
5253
|
+
};
|
|
5254
|
+
content: {
|
|
5255
|
+
"text/plain": string;
|
|
5256
|
+
};
|
|
5257
|
+
};
|
|
5258
|
+
default: {
|
|
5259
|
+
headers: {
|
|
5260
|
+
[name: string]: unknown;
|
|
5261
|
+
};
|
|
5262
|
+
content: {
|
|
5263
|
+
"application/json": components["schemas"]["JsCantonError"];
|
|
5264
|
+
};
|
|
5265
|
+
};
|
|
5266
|
+
};
|
|
5267
|
+
};
|
|
5268
|
+
"postV2Package-vetting": {
|
|
5269
|
+
parameters: {
|
|
5270
|
+
query?: never;
|
|
5271
|
+
header?: never;
|
|
5272
|
+
path?: never;
|
|
5273
|
+
cookie?: never;
|
|
5274
|
+
};
|
|
5275
|
+
requestBody: {
|
|
5276
|
+
content: {
|
|
5277
|
+
"application/json": components["schemas"]["UpdateVettedPackagesRequest"];
|
|
5278
|
+
};
|
|
5279
|
+
};
|
|
5280
|
+
responses: {
|
|
5281
|
+
200: {
|
|
5282
|
+
headers: {
|
|
5283
|
+
[name: string]: unknown;
|
|
5284
|
+
};
|
|
5285
|
+
content: {
|
|
5286
|
+
"application/json": components["schemas"]["UpdateVettedPackagesResponse"];
|
|
5287
|
+
};
|
|
5288
|
+
};
|
|
5289
|
+
/** @description Invalid value for: body, Invalid value for: headers */
|
|
5290
|
+
400: {
|
|
5291
|
+
headers: {
|
|
5292
|
+
[name: string]: unknown;
|
|
5293
|
+
};
|
|
5294
|
+
content: {
|
|
5295
|
+
"text/plain": string;
|
|
5296
|
+
};
|
|
5297
|
+
};
|
|
5298
|
+
default: {
|
|
5299
|
+
headers: {
|
|
5300
|
+
[name: string]: unknown;
|
|
5301
|
+
};
|
|
5302
|
+
content: {
|
|
5303
|
+
"application/json": components["schemas"]["JsCantonError"];
|
|
5304
|
+
};
|
|
5305
|
+
};
|
|
5306
|
+
};
|
|
5307
|
+
};
|
|
4072
5308
|
getV2Parties: {
|
|
4073
5309
|
parameters: {
|
|
4074
5310
|
query?: {
|
|
@@ -4399,6 +5635,7 @@ export interface operations {
|
|
|
4399
5635
|
query?: {
|
|
4400
5636
|
party?: string;
|
|
4401
5637
|
participantId?: string;
|
|
5638
|
+
identityProviderId?: string;
|
|
4402
5639
|
};
|
|
4403
5640
|
header?: never;
|
|
4404
5641
|
path?: never;
|
|
@@ -4414,7 +5651,7 @@ export interface operations {
|
|
|
4414
5651
|
"application/json": components["schemas"]["GetConnectedSynchronizersResponse"];
|
|
4415
5652
|
};
|
|
4416
5653
|
};
|
|
4417
|
-
/** @description Invalid value for: query parameter party, Invalid value for: query parameter participantId, Invalid value for: headers */
|
|
5654
|
+
/** @description Invalid value for: query parameter party, Invalid value for: query parameter participantId, Invalid value for: query parameter identityProviderId, Invalid value for: headers */
|
|
4418
5655
|
400: {
|
|
4419
5656
|
headers: {
|
|
4420
5657
|
[name: string]: unknown;
|
|
@@ -4963,7 +6200,9 @@ export interface operations {
|
|
|
4963
6200
|
};
|
|
4964
6201
|
"getV2UsersUser-id": {
|
|
4965
6202
|
parameters: {
|
|
4966
|
-
query?:
|
|
6203
|
+
query?: {
|
|
6204
|
+
"identity-provider-id"?: string;
|
|
6205
|
+
};
|
|
4967
6206
|
header?: never;
|
|
4968
6207
|
path: {
|
|
4969
6208
|
"user-id": string;
|
|
@@ -4980,7 +6219,7 @@ export interface operations {
|
|
|
4980
6219
|
"application/json": components["schemas"]["GetUserResponse"];
|
|
4981
6220
|
};
|
|
4982
6221
|
};
|
|
4983
|
-
/** @description Invalid value for: headers */
|
|
6222
|
+
/** @description Invalid value for: query parameter identity-provider-id, Invalid value for: headers */
|
|
4984
6223
|
400: {
|
|
4985
6224
|
headers: {
|
|
4986
6225
|
[name: string]: unknown;
|
|
@@ -5079,6 +6318,44 @@ export interface operations {
|
|
|
5079
6318
|
};
|
|
5080
6319
|
};
|
|
5081
6320
|
};
|
|
6321
|
+
"getV2Authenticated-user": {
|
|
6322
|
+
parameters: {
|
|
6323
|
+
query?: {
|
|
6324
|
+
"identity-provider-id"?: string;
|
|
6325
|
+
};
|
|
6326
|
+
header?: never;
|
|
6327
|
+
path?: never;
|
|
6328
|
+
cookie?: never;
|
|
6329
|
+
};
|
|
6330
|
+
requestBody?: never;
|
|
6331
|
+
responses: {
|
|
6332
|
+
200: {
|
|
6333
|
+
headers: {
|
|
6334
|
+
[name: string]: unknown;
|
|
6335
|
+
};
|
|
6336
|
+
content: {
|
|
6337
|
+
"application/json": components["schemas"]["GetUserResponse"];
|
|
6338
|
+
};
|
|
6339
|
+
};
|
|
6340
|
+
/** @description Invalid value for: query parameter identity-provider-id, Invalid value for: headers */
|
|
6341
|
+
400: {
|
|
6342
|
+
headers: {
|
|
6343
|
+
[name: string]: unknown;
|
|
6344
|
+
};
|
|
6345
|
+
content: {
|
|
6346
|
+
"text/plain": string;
|
|
6347
|
+
};
|
|
6348
|
+
};
|
|
6349
|
+
default: {
|
|
6350
|
+
headers: {
|
|
6351
|
+
[name: string]: unknown;
|
|
6352
|
+
};
|
|
6353
|
+
content: {
|
|
6354
|
+
"application/json": components["schemas"]["JsCantonError"];
|
|
6355
|
+
};
|
|
6356
|
+
};
|
|
6357
|
+
};
|
|
6358
|
+
};
|
|
5082
6359
|
"getV2UsersUser-idRights": {
|
|
5083
6360
|
parameters: {
|
|
5084
6361
|
query?: never;
|
|
@@ -5517,6 +6794,86 @@ export interface operations {
|
|
|
5517
6794
|
};
|
|
5518
6795
|
};
|
|
5519
6796
|
};
|
|
6797
|
+
"postV2Interactive-submissionExecuteandwait": {
|
|
6798
|
+
parameters: {
|
|
6799
|
+
query?: never;
|
|
6800
|
+
header?: never;
|
|
6801
|
+
path?: never;
|
|
6802
|
+
cookie?: never;
|
|
6803
|
+
};
|
|
6804
|
+
requestBody: {
|
|
6805
|
+
content: {
|
|
6806
|
+
"application/json": components["schemas"]["JsExecuteSubmissionAndWaitRequest"];
|
|
6807
|
+
};
|
|
6808
|
+
};
|
|
6809
|
+
responses: {
|
|
6810
|
+
200: {
|
|
6811
|
+
headers: {
|
|
6812
|
+
[name: string]: unknown;
|
|
6813
|
+
};
|
|
6814
|
+
content: {
|
|
6815
|
+
"application/json": components["schemas"]["ExecuteSubmissionAndWaitResponse"];
|
|
6816
|
+
};
|
|
6817
|
+
};
|
|
6818
|
+
/** @description Invalid value for: body, Invalid value for: headers */
|
|
6819
|
+
400: {
|
|
6820
|
+
headers: {
|
|
6821
|
+
[name: string]: unknown;
|
|
6822
|
+
};
|
|
6823
|
+
content: {
|
|
6824
|
+
"text/plain": string;
|
|
6825
|
+
};
|
|
6826
|
+
};
|
|
6827
|
+
default: {
|
|
6828
|
+
headers: {
|
|
6829
|
+
[name: string]: unknown;
|
|
6830
|
+
};
|
|
6831
|
+
content: {
|
|
6832
|
+
"application/json": components["schemas"]["JsCantonError"];
|
|
6833
|
+
};
|
|
6834
|
+
};
|
|
6835
|
+
};
|
|
6836
|
+
};
|
|
6837
|
+
"postV2Interactive-submissionExecuteandwaitfortransaction": {
|
|
6838
|
+
parameters: {
|
|
6839
|
+
query?: never;
|
|
6840
|
+
header?: never;
|
|
6841
|
+
path?: never;
|
|
6842
|
+
cookie?: never;
|
|
6843
|
+
};
|
|
6844
|
+
requestBody: {
|
|
6845
|
+
content: {
|
|
6846
|
+
"application/json": components["schemas"]["JsExecuteSubmissionAndWaitForTransactionRequest"];
|
|
6847
|
+
};
|
|
6848
|
+
};
|
|
6849
|
+
responses: {
|
|
6850
|
+
200: {
|
|
6851
|
+
headers: {
|
|
6852
|
+
[name: string]: unknown;
|
|
6853
|
+
};
|
|
6854
|
+
content: {
|
|
6855
|
+
"application/json": components["schemas"]["JsExecuteSubmissionAndWaitForTransactionResponse"];
|
|
6856
|
+
};
|
|
6857
|
+
};
|
|
6858
|
+
/** @description Invalid value for: body, Invalid value for: headers */
|
|
6859
|
+
400: {
|
|
6860
|
+
headers: {
|
|
6861
|
+
[name: string]: unknown;
|
|
6862
|
+
};
|
|
6863
|
+
content: {
|
|
6864
|
+
"text/plain": string;
|
|
6865
|
+
};
|
|
6866
|
+
};
|
|
6867
|
+
default: {
|
|
6868
|
+
headers: {
|
|
6869
|
+
[name: string]: unknown;
|
|
6870
|
+
};
|
|
6871
|
+
content: {
|
|
6872
|
+
"application/json": components["schemas"]["JsCantonError"];
|
|
6873
|
+
};
|
|
6874
|
+
};
|
|
6875
|
+
};
|
|
6876
|
+
};
|
|
5520
6877
|
"getV2Interactive-submissionPreferred-package-version": {
|
|
5521
6878
|
parameters: {
|
|
5522
6879
|
query: {
|