@c7-digital/scan 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,4826 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Scan API
4
+ version: 0.0.1
5
+ tags:
6
+ - name: external
7
+ description: |
8
+ These endpoints are intended for public usage and will remain backward-compatible.
9
+ - name: internal
10
+ description: |
11
+ For internal usage only, not guaranteed to be stable or backward-compatible.
12
+ - name: deprecated
13
+ description: |
14
+ These endpoints are deprecated and will be removed in a future release.
15
+ - name: scan
16
+ description: |
17
+ The internal and external endpoints.
18
+ servers:
19
+ - url: https://example.com/api/scan
20
+ paths:
21
+ /readyz:
22
+ get:
23
+ tags:
24
+ - common
25
+ x-jvm-package: external.common_admin
26
+ operationId: isReady
27
+ responses:
28
+ "200":
29
+ description: ok
30
+ "503":
31
+ description: service_unavailable
32
+ /livez:
33
+ get:
34
+ tags:
35
+ - common
36
+ x-jvm-package: external.common_admin
37
+ operationId: isLive
38
+ responses:
39
+ "200":
40
+ description: ok
41
+ "503":
42
+ description: service_unavailable
43
+ /status:
44
+ get:
45
+ tags:
46
+ - common
47
+ x-jvm-package: external.common_admin
48
+ operationId: getHealthStatus
49
+ responses:
50
+ "200":
51
+ description: ok
52
+ content:
53
+ application/json:
54
+ schema:
55
+ $ref: "#/components/schemas/NodeStatus"
56
+ /version:
57
+ get:
58
+ tags:
59
+ - common
60
+ x-jvm-package: external.common_admin
61
+ operationId: getVersion
62
+ responses:
63
+ "200":
64
+ description: ok
65
+ content:
66
+ application/json:
67
+ schema:
68
+ $ref: "#/components/schemas/Version"
69
+ /v0/dso:
70
+ get:
71
+ tags:
72
+ - external
73
+ - scan
74
+ x-jvm-package: scan
75
+ operationId: getDsoInfo
76
+ responses:
77
+ "200":
78
+ description: ok
79
+ content:
80
+ application/json:
81
+ schema:
82
+ type: object
83
+ required:
84
+ - sv_user
85
+ - sv_party_id
86
+ - dso_party_id
87
+ - voting_threshold
88
+ - latest_mining_round
89
+ - amulet_rules
90
+ - dso_rules
91
+ - sv_node_states
92
+ properties:
93
+ sv_user:
94
+ description: User ID representing the SV
95
+ type: string
96
+ sv_party_id:
97
+ description: Party representing the SV
98
+ type: string
99
+ dso_party_id:
100
+ description: |
101
+ Party representing the whole DSO; for Scan only, also returned by
102
+ `/v0/dso-party-id`
103
+ type: string
104
+ voting_threshold:
105
+ description: |
106
+ Threshold required to pass vote requests; also known as the
107
+ "governance threshold", it is always derived from the number of
108
+ `svs` in `dso_rules`
109
+ type: integer
110
+ latest_mining_round:
111
+ description: |
112
+ Contract of the Daml template `Splice.Round.OpenMiningRound`, the
113
+ one with the highest round number on the ledger that has been signed
114
+ by `dso_party_id`. The round may not be usable as it may not be
115
+ opened yet, in accordance with its `opensAt` template field
116
+ $ref: "#/components/schemas/ContractWithState"
117
+ amulet_rules:
118
+ description: |
119
+ Contract of the Daml template `Splice.AmuletRules.AmuletRules`,
120
+ including the full schedule of `AmuletConfig` changes approved by
121
+ the DSO. Callers should not assume that `initialValue` is up-to-date,
122
+ and should instead search `futureValues` for the latest configuration
123
+ valid as of now
124
+ $ref: "#/components/schemas/ContractWithState"
125
+ dso_rules:
126
+ description: |
127
+ Contract of the Daml template `Splice.DsoRules.DsoRules`, listing
128
+ the governance rules approved by the DSO governing this Splice network.
129
+ $ref: "#/components/schemas/ContractWithState"
130
+ sv_node_states:
131
+ description: |
132
+ For every one of `svs` listed in `dso_rules`, a contract of the Daml
133
+ template `Splice.DSO.SvState.SvNodeState`. This does not include
134
+ states for offboarded SVs, though they may still have an on-ledger
135
+ state contract
136
+ type: array
137
+ items:
138
+ $ref: "#/components/schemas/ContractWithState"
139
+ initial_round:
140
+ description: |
141
+ Initial round from which the network bootstraps
142
+ type: string
143
+ /v0/validators/validator-faucets:
144
+ get:
145
+ tags:
146
+ - external
147
+ - scan
148
+ x-jvm-package: scan
149
+ operationId: getValidatorFaucetsByValidator
150
+ description: |
151
+ For every argument that is a valid onboarded validator, return
152
+ statistics on its liveness activity, according to on-ledger state at the
153
+ time of the request.
154
+ parameters:
155
+ - name: validator_ids
156
+ in: query
157
+ required: true
158
+ description: |
159
+ A list of validator party IDs, one per specification of the parameter.
160
+ Any party IDs not matching onboarded validators will be ignored
161
+ schema:
162
+ type: array
163
+ items:
164
+ type: string
165
+ responses:
166
+ "200":
167
+ description: ok
168
+ content:
169
+ application/json:
170
+ schema:
171
+ $ref: "#/components/schemas/GetValidatorFaucetsByValidatorResponse"
172
+ "400":
173
+ description: bad request
174
+ content:
175
+ application/json:
176
+ schema: &a2
177
+ $ref: "#/components/schemas/ErrorResponse"
178
+ "404":
179
+ description: not found
180
+ content:
181
+ application/json:
182
+ schema: &a1
183
+ $ref: "#/components/schemas/ErrorResponse"
184
+ /v0/scans:
185
+ get:
186
+ tags:
187
+ - external
188
+ - scan
189
+ x-jvm-package: scan
190
+ operationId: listDsoScans
191
+ description: |
192
+ Retrieve Canton scan configuration for all SVs, grouped by
193
+ connected synchronizer ID
194
+ responses:
195
+ "200":
196
+ description: ok
197
+ content:
198
+ application/json:
199
+ schema:
200
+ $ref: "#/components/schemas/ListDsoScansResponse"
201
+ /v0/admin/validator/licenses:
202
+ get:
203
+ tags:
204
+ - external
205
+ - scan
206
+ x-jvm-package: scan
207
+ operationId: listValidatorLicenses
208
+ description: |
209
+ List all validators currently approved by members of the DSO, paginated,
210
+ sorted newest-first.
211
+ parameters:
212
+ - name: after
213
+ description: |
214
+ A `next_page_token` from a prior response; if absent, return the first page.
215
+ in: query
216
+ required: false
217
+ schema:
218
+ type: integer
219
+ format: int64
220
+ - name: limit
221
+ description: Maximum number of elements to return, 1000 by default.
222
+ in: query
223
+ required: false
224
+ schema:
225
+ type: integer
226
+ format: int32
227
+ responses:
228
+ "200":
229
+ description: ok
230
+ content:
231
+ application/json:
232
+ schema:
233
+ type: object
234
+ required:
235
+ - validator_licenses
236
+ properties:
237
+ validator_licenses:
238
+ description: Contracts of Daml template `Splice.ValidatorLicense:ValidatorLicense`.
239
+ type: array
240
+ items:
241
+ type: object
242
+ properties:
243
+ template_id:
244
+ type: string
245
+ contract_id:
246
+ type: string
247
+ payload:
248
+ type: object
249
+ created_event_blob:
250
+ type: string
251
+ created_at:
252
+ type: string
253
+ required:
254
+ - template_id
255
+ - contract_id
256
+ - payload
257
+ - created_event_blob
258
+ - created_at
259
+ next_page_token:
260
+ type: integer
261
+ format: int64
262
+ description: |
263
+ When requesting the next page of results, pass this as URL query parameter `after`.
264
+ If absent or `null`, there are no more pages.
265
+ /v0/dso-sequencers:
266
+ get:
267
+ tags:
268
+ - external
269
+ - scan
270
+ x-jvm-package: scan
271
+ operationId: listDsoSequencers
272
+ description: |
273
+ Retrieve Canton sequencer configuration for all SVs, grouped by
274
+ connected synchronizer ID
275
+ responses:
276
+ "200":
277
+ description: ok
278
+ content:
279
+ application/json:
280
+ schema:
281
+ $ref: "#/components/schemas/ListDsoSequencersResponse"
282
+ /v0/sv-bft-sequencers:
283
+ get:
284
+ tags:
285
+ - internal
286
+ - scan
287
+ x-jvm-package: scan
288
+ operationId: listSvBftSequencers
289
+ description: |
290
+ Retrieve Canton BFT sequencer configuration for this SV, for each configured Synchronizer
291
+ responses:
292
+ "200":
293
+ description: ok
294
+ content:
295
+ application/json:
296
+ schema:
297
+ $ref: "#/components/schemas/ListSvBftSequencersResponse"
298
+ /v0/domains/{domain_id}/parties/{party_id}/participant-id:
299
+ get:
300
+ tags:
301
+ - external
302
+ - scan
303
+ x-jvm-package: scan
304
+ operationId: getPartyToParticipant
305
+ description: |
306
+ Get the ID of the participant hosting a given party. This will fail if
307
+ there are multiple party-to-participant mappings for the given
308
+ synchronizer and party, which is not currently supported.
309
+ parameters:
310
+ - name: domain_id
311
+ description: |
312
+ The synchronizer ID to look up a mapping for.
313
+ in: path
314
+ required: true
315
+ schema:
316
+ type: string
317
+ - name: party_id
318
+ description: |
319
+ The party ID to lookup a participant ID for.
320
+ in: path
321
+ required: true
322
+ schema:
323
+ type: string
324
+ responses:
325
+ "200":
326
+ description: ok
327
+ content:
328
+ application/json:
329
+ schema:
330
+ $ref: "#/components/schemas/GetPartyToParticipantResponse"
331
+ "404":
332
+ description: not found
333
+ content:
334
+ application/json:
335
+ schema: *a1
336
+ "500":
337
+ description: internal server error
338
+ content:
339
+ application/json:
340
+ schema: &a3
341
+ $ref: "#/components/schemas/ErrorResponse"
342
+ /v0/domains/{domain_id}/members/{member_id}/traffic-status:
343
+ get:
344
+ tags:
345
+ - external
346
+ - scan
347
+ x-jvm-package: scan
348
+ operationId: getMemberTrafficStatus
349
+ description: |
350
+ Get a member's traffic status as reported by the sequencer, according to
351
+ ledger state at the time of the request.
352
+ parameters:
353
+ - name: domain_id
354
+ description: |
355
+ The synchronizer ID to look up traffic for.
356
+ in: path
357
+ required: true
358
+ schema:
359
+ type: string
360
+ - name: member_id
361
+ description: |
362
+ The participant or mediator whose traffic to look up, in the format
363
+ `code::id::fingerprint` where `code` is `PAR` or `MED`.
364
+ in: path
365
+ required: true
366
+ schema:
367
+ type: string
368
+ responses:
369
+ "200":
370
+ description: ok
371
+ content:
372
+ application/json:
373
+ schema:
374
+ $ref: "#/components/schemas/GetMemberTrafficStatusResponse"
375
+ "400":
376
+ description: bad request
377
+ content:
378
+ application/json:
379
+ schema: *a2
380
+ "404":
381
+ description: not found
382
+ content:
383
+ application/json:
384
+ schema: *a1
385
+ "500":
386
+ description: internal server error
387
+ content:
388
+ application/json:
389
+ schema: *a3
390
+ /v0/closed-rounds:
391
+ get:
392
+ tags:
393
+ - external
394
+ - scan
395
+ x-jvm-package: scan
396
+ operationId: getClosedRounds
397
+ description: |
398
+ Every closed mining round on the ledger still in post-close process for
399
+ the connected Splice network, in round number order, earliest-first.
400
+ responses:
401
+ "200":
402
+ description: ok
403
+ content:
404
+ application/json:
405
+ schema:
406
+ $ref: "#/components/schemas/GetClosedRoundsResponse"
407
+ /v0/open-and-issuing-mining-rounds:
408
+ post:
409
+ tags:
410
+ - external
411
+ - scan
412
+ x-jvm-package: scan
413
+ operationId: getOpenAndIssuingMiningRounds
414
+ description: |
415
+ All current open and issuing mining rounds, if the request is empty;
416
+ passing contract IDs in the request can reduce the response data for
417
+ polling/client-cache-update efficiency.
418
+ requestBody:
419
+ required: true
420
+ content:
421
+ application/json:
422
+ schema:
423
+ $ref: "#/components/schemas/GetOpenAndIssuingMiningRoundsRequest"
424
+ responses:
425
+ "200":
426
+ description: ok
427
+ content:
428
+ application/json:
429
+ schema:
430
+ $ref: "#/components/schemas/GetOpenAndIssuingMiningRoundsResponse"
431
+ /v2/updates:
432
+ post:
433
+ tags:
434
+ - external
435
+ - scan
436
+ x-jvm-package: scan
437
+ operationId: getUpdateHistoryV2
438
+ description: |
439
+ Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
440
+ Compared to `/v1/updates`, the `/v2/updates` removes the `offset` field in responses,
441
+ which was hardcoded to 1 in `/v1/updates` for compatibility, and is now removed.
442
+ `/v2/updates` sorts events lexicographically in `events_by_id` by `ID` for convenience, which should not be confused with the
443
+ order of events in the transaction, for this you should rely on the order of `root_event_ids` and `child_event_ids`.
444
+ Updates are ordered lexicographically by `(migration id, record time)`.
445
+ For a given migration id, each update has a unique record time.
446
+ The record time ranges of different migrations may overlap, i.e.,
447
+ it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
448
+ and there may be two updates with the same record time but different migration ids.
449
+ requestBody:
450
+ required: true
451
+ content:
452
+ application/json:
453
+ schema:
454
+ $ref: "#/components/schemas/UpdateHistoryRequestV2"
455
+ responses:
456
+ "200":
457
+ description: ok
458
+ content:
459
+ application/json:
460
+ schema:
461
+ $ref: "#/components/schemas/UpdateHistoryResponseV2"
462
+ "400":
463
+ description: bad request
464
+ content:
465
+ application/json:
466
+ schema: *a2
467
+ "500":
468
+ description: internal server error
469
+ content:
470
+ application/json:
471
+ schema: *a3
472
+ /v2/updates/{update_id}:
473
+ get:
474
+ tags:
475
+ - external
476
+ - scan
477
+ x-jvm-package: scan
478
+ operationId: getUpdateByIdV2
479
+ description: |
480
+ Returns the update with the given update_id.
481
+ Compared to `/v1/updates/{update_id}`, the `/v2/updates/{update_id}` removes the `offset` field in responses,
482
+ which was hardcoded to 1 in `/v1/updates/{update_id}` for compatibility, and is now removed.
483
+ `/v2/updates/{update_id}` sorts events lexicographically in `events_by_id` by `ID` for convenience, which should not be confused with the
484
+ order of events in the transaction, for this you should rely on the order of `root_event_ids` and `child_event_ids`.
485
+ parameters:
486
+ - name: update_id
487
+ in: path
488
+ required: true
489
+ schema:
490
+ type: string
491
+ - name: daml_value_encoding
492
+ in: query
493
+ schema:
494
+ $ref: "#/components/schemas/DamlValueEncoding"
495
+ responses:
496
+ "200":
497
+ description: ok
498
+ content:
499
+ application/json:
500
+ schema:
501
+ $ref: "#/components/schemas/UpdateHistoryItemV2"
502
+ "400":
503
+ description: bad request
504
+ content:
505
+ application/json:
506
+ schema: *a2
507
+ "404":
508
+ description: not found
509
+ content:
510
+ application/json:
511
+ schema: *a1
512
+ "500":
513
+ description: internal server error
514
+ content:
515
+ application/json:
516
+ schema: *a3
517
+ /v1/updates:
518
+ post:
519
+ deprecated: true
520
+ tags:
521
+ - deprecated
522
+ x-jvm-package: scan
523
+ operationId: getUpdateHistoryV1
524
+ description: |
525
+ Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
526
+ Unlike /v0/updates, this endpoint returns responses that are consistent across different
527
+ scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates.
528
+
529
+ Updates are ordered lexicographically by `(migration id, record time)`.
530
+ For a given migration id, each update has a unique record time.
531
+ The record time ranges of different migrations may overlap, i.e.,
532
+ it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
533
+ and there may be two updates with the same record time but different migration ids.
534
+ The order of items in events_by_id is not defined.
535
+ requestBody:
536
+ required: true
537
+ content:
538
+ application/json:
539
+ schema:
540
+ $ref: "#/components/schemas/UpdateHistoryRequestV1"
541
+ responses:
542
+ "200":
543
+ description: ok
544
+ content:
545
+ application/json:
546
+ schema:
547
+ $ref: "#/components/schemas/UpdateHistoryResponse"
548
+ "400":
549
+ description: bad request
550
+ content:
551
+ application/json:
552
+ schema: *a2
553
+ "500":
554
+ description: internal server error
555
+ content:
556
+ application/json:
557
+ schema: *a3
558
+ /v1/updates/{update_id}:
559
+ get:
560
+ deprecated: true
561
+ tags:
562
+ - deprecated
563
+ x-jvm-package: scan
564
+ operationId: getUpdateByIdV1
565
+ description: |
566
+ Returns the update with the given update_id.
567
+ Unlike /v0/updates/{update_id}, this endpoint returns responses that are consistent across different
568
+ scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates.
569
+ The order of items in events_by_id is not defined.
570
+ parameters:
571
+ - name: update_id
572
+ in: path
573
+ required: true
574
+ schema:
575
+ type: string
576
+ - name: daml_value_encoding
577
+ in: query
578
+ schema:
579
+ $ref: "#/components/schemas/DamlValueEncoding"
580
+ responses:
581
+ "200":
582
+ description: ok
583
+ content:
584
+ application/json:
585
+ schema:
586
+ $ref: "#/components/schemas/UpdateHistoryItem"
587
+ "400":
588
+ description: bad request
589
+ content:
590
+ application/json:
591
+ schema: *a2
592
+ "404":
593
+ description: not found
594
+ content:
595
+ application/json:
596
+ schema: *a1
597
+ "500":
598
+ description: internal server error
599
+ content:
600
+ application/json:
601
+ schema: *a3
602
+ /v0/state/acs/snapshot-timestamp:
603
+ get:
604
+ tags:
605
+ - external
606
+ - scan
607
+ x-jvm-package: scan
608
+ operationId: getDateOfMostRecentSnapshotBefore
609
+ description: |
610
+ Returns the timestamp of the most recent snapshot before the given date, for the given migration_id.
611
+ This corresponds to the record time of the last transaction in the snapshot.
612
+ parameters:
613
+ - name: before
614
+ in: query
615
+ required: true
616
+ schema:
617
+ type: string
618
+ format: date-time
619
+ description: |
620
+ The endpoint will return the record time of the most recent snapshot before this parameter.
621
+ - name: migration_id
622
+ in: query
623
+ required: true
624
+ schema:
625
+ type: integer
626
+ format: int64
627
+ description: |
628
+ The endpoint will return the record time of the most recent snapshot for this migration id.
629
+ responses:
630
+ "200":
631
+ description: ok
632
+ content:
633
+ application/json:
634
+ schema:
635
+ $ref: "#/components/schemas/AcsSnapshotTimestampResponse"
636
+ "400":
637
+ description: bad request
638
+ content:
639
+ application/json:
640
+ schema: *a2
641
+ "404":
642
+ description: not found
643
+ content:
644
+ application/json:
645
+ schema: *a1
646
+ "500":
647
+ description: internal server error
648
+ content:
649
+ application/json:
650
+ schema: *a3
651
+ /v0/state/acs/snapshot-timestamp-after:
652
+ get:
653
+ tags:
654
+ - external
655
+ - scan
656
+ x-jvm-package: scan
657
+ operationId: getDateOfFirstSnapshotAfter
658
+ description: |
659
+ Returns the timestamp of the first snapshot after the given date, for the given migration_id or larger.
660
+ parameters:
661
+ - name: after
662
+ in: query
663
+ required: true
664
+ schema:
665
+ type: string
666
+ format: date-time
667
+ description: |
668
+ The endpoint will return the record time of the first snapshot after this parameter.
669
+ - name: migration_id
670
+ in: query
671
+ required: true
672
+ schema:
673
+ type: integer
674
+ format: int64
675
+ description: |
676
+ The endpoint will return the record time of the first snapshot for this migration id or larger.
677
+ responses:
678
+ "200":
679
+ description: ok
680
+ content:
681
+ application/json:
682
+ schema:
683
+ $ref: "#/components/schemas/AcsSnapshotTimestampResponse"
684
+ "400":
685
+ description: bad request
686
+ content:
687
+ application/json:
688
+ schema: *a2
689
+ "404":
690
+ description: not found
691
+ content:
692
+ application/json:
693
+ schema: *a1
694
+ "500":
695
+ description: internal server error
696
+ content:
697
+ application/json:
698
+ schema: *a3
699
+ /v0/state/acs:
700
+ post:
701
+ tags:
702
+ - external
703
+ - scan
704
+ x-jvm-package: scan
705
+ operationId: getAcsSnapshotAt
706
+ description: |
707
+ Returns the ACS in creation date ascending order, paged, for a given migration id and record time.
708
+ requestBody:
709
+ required: true
710
+ content:
711
+ application/json:
712
+ schema:
713
+ $ref: "#/components/schemas/AcsRequest"
714
+ responses:
715
+ "200":
716
+ description: ok
717
+ content:
718
+ application/json:
719
+ schema:
720
+ $ref: "#/components/schemas/AcsResponse"
721
+ "400":
722
+ description: bad request
723
+ content:
724
+ application/json:
725
+ schema: *a2
726
+ "404":
727
+ description: not found
728
+ content:
729
+ application/json:
730
+ schema: *a1
731
+ "500":
732
+ description: internal server error
733
+ content:
734
+ application/json:
735
+ schema: *a3
736
+ /v0/state/acs/force:
737
+ post:
738
+ tags:
739
+ - external
740
+ - scan
741
+ x-jvm-package: scan
742
+ operationId: forceAcsSnapshotNow
743
+ description: |
744
+ Takes a snapshot of the ACS at the current time.
745
+ The responses can be used as parameters to `/v0/state/acs` to retrieve the snapshot.
746
+ Disabled in production environments due to its persistent alteration of
747
+ the behavior of future invocations of `/v0/state/acs`, as it causes an
748
+ immediate internal snapshot and delay in the next automatic snapshot.
749
+ responses:
750
+ "200":
751
+ description: ok
752
+ content:
753
+ application/json:
754
+ schema:
755
+ $ref: "#/components/schemas/ForceAcsSnapshotResponse"
756
+ "400":
757
+ description: bad request
758
+ content:
759
+ application/json:
760
+ schema: *a2
761
+ "500":
762
+ description: internal server error
763
+ content:
764
+ application/json:
765
+ schema: *a3
766
+ /v0/holdings/state:
767
+ post:
768
+ tags:
769
+ - external
770
+ - scan
771
+ x-jvm-package: scan
772
+ operationId: getHoldingsStateAt
773
+ description: |
774
+ Returns the active amulet contracts for a given migration id and record time, in creation date ascending order, paged.
775
+ requestBody:
776
+ required: true
777
+ content:
778
+ application/json:
779
+ schema:
780
+ $ref: "#/components/schemas/HoldingsStateRequest"
781
+ responses:
782
+ "200":
783
+ description: ok
784
+ content:
785
+ application/json:
786
+ schema:
787
+ $ref: "#/components/schemas/AcsResponse"
788
+ "400":
789
+ description: bad request
790
+ content:
791
+ application/json:
792
+ schema: *a2
793
+ "404":
794
+ description: not found
795
+ content:
796
+ application/json:
797
+ schema: *a1
798
+ "500":
799
+ description: internal server error
800
+ content:
801
+ application/json:
802
+ schema: *a3
803
+ /v0/holdings/summary:
804
+ post:
805
+ tags:
806
+ - external
807
+ - scan
808
+ x-jvm-package: scan
809
+ operationId: getHoldingsSummaryAt
810
+ description: |
811
+ Returns the summary of active amulet contracts for a given migration id and record time, for the given parties.
812
+ This is an aggregate of `/v0/holdings/state` by owner party ID with better performance than client-side computation.
813
+ requestBody:
814
+ required: true
815
+ content:
816
+ application/json:
817
+ schema:
818
+ $ref: "#/components/schemas/HoldingsSummaryRequest"
819
+ responses:
820
+ "200":
821
+ description: ok
822
+ content:
823
+ application/json:
824
+ schema:
825
+ $ref: "#/components/schemas/HoldingsSummaryResponse"
826
+ "400":
827
+ description: bad request
828
+ content:
829
+ application/json:
830
+ schema: *a2
831
+ "404":
832
+ description: not found
833
+ content:
834
+ application/json:
835
+ schema: *a1
836
+ "500":
837
+ description: internal server error
838
+ content:
839
+ application/json:
840
+ schema: *a3
841
+ /v0/ans-entries:
842
+ get:
843
+ tags:
844
+ - external
845
+ - scan
846
+ x-jvm-package: scan
847
+ operationId: listAnsEntries
848
+ description: |
849
+ Lists all non-expired ANS entries whose names are prefixed with the
850
+ `name_prefix`, up to `page_size` entries.
851
+ parameters:
852
+ - name: name_prefix
853
+ description: |
854
+ Every result's name will start with this substring; if empty or absent,
855
+ all entries will be listed.
856
+ Does not have to be a whole word or segment; any substring will be accepted.
857
+ in: query
858
+ schema:
859
+ type: string
860
+ - name: page_size
861
+ description: |
862
+ The maximum number of results returned.
863
+ Older (but still non-expired) results are listed first.
864
+ in: query
865
+ required: true
866
+ schema:
867
+ type: integer
868
+ format: int32
869
+ responses:
870
+ "200":
871
+ description: ok
872
+ content:
873
+ application/json:
874
+ schema:
875
+ $ref: "#/components/schemas/ListEntriesResponse"
876
+ /v0/ans-entries/by-party/{party}:
877
+ get:
878
+ tags:
879
+ - external
880
+ - scan
881
+ x-jvm-package: scan
882
+ operationId: lookupAnsEntryByParty
883
+ description: |
884
+ If present, the first ANS entry for user `party` according to
885
+ `name` lexicographic order.
886
+ parameters:
887
+ - name: party
888
+ description: The user party ID that holds the ANS entry.
889
+ in: path
890
+ required: true
891
+ schema:
892
+ type: string
893
+ responses:
894
+ "200":
895
+ description: ok
896
+ content:
897
+ application/json:
898
+ schema:
899
+ $ref: "#/components/schemas/LookupEntryByPartyResponse"
900
+ "404":
901
+ description: not found
902
+ content:
903
+ application/json:
904
+ schema: *a1
905
+ /v0/ans-entries/by-name/{name}:
906
+ get:
907
+ tags:
908
+ - external
909
+ - scan
910
+ x-jvm-package: scan
911
+ operationId: lookupAnsEntryByName
912
+ description: If present, the ANS entry named exactly `name`.
913
+ parameters:
914
+ - name: name
915
+ in: path
916
+ required: true
917
+ schema:
918
+ type: string
919
+ responses:
920
+ "200":
921
+ description: ok
922
+ content:
923
+ application/json:
924
+ schema:
925
+ $ref: "#/components/schemas/LookupEntryByNameResponse"
926
+ "404":
927
+ description: not found
928
+ content:
929
+ application/json:
930
+ schema: *a1
931
+ /v0/dso-party-id:
932
+ get:
933
+ tags:
934
+ - external
935
+ - scan
936
+ x-jvm-package: scan
937
+ operationId: getDsoPartyId
938
+ description: |
939
+ The party ID of the DSO for the Splice network connected by this Scan app.
940
+ responses:
941
+ "200":
942
+ description: ok
943
+ content:
944
+ application/json:
945
+ schema:
946
+ $ref: "#/components/schemas/GetDsoPartyIdResponse"
947
+ /v0/amulet-rules:
948
+ post:
949
+ tags:
950
+ - internal
951
+ - scan
952
+ x-jvm-package: scan
953
+ operationId: getAmuletRules
954
+ requestBody:
955
+ required: true
956
+ content:
957
+ application/json:
958
+ schema:
959
+ $ref: "#/components/schemas/GetAmuletRulesRequest"
960
+ responses:
961
+ "200":
962
+ description: ok
963
+ content:
964
+ application/json:
965
+ schema:
966
+ $ref: "#/components/schemas/GetAmuletRulesResponse"
967
+ /v0/external-party-amulet-rules:
968
+ post:
969
+ tags:
970
+ - internal
971
+ - scan
972
+ x-jvm-package: scan
973
+ operationId: getExternalPartyAmuletRules
974
+ requestBody:
975
+ required: true
976
+ content:
977
+ application/json:
978
+ schema:
979
+ $ref: "#/components/schemas/GetExternalPartyAmuletRulesRequest"
980
+ responses:
981
+ "200":
982
+ description: ok
983
+ content:
984
+ application/json:
985
+ schema:
986
+ $ref: "#/components/schemas/GetExternalPartyAmuletRulesResponse"
987
+ /v0/ans-rules:
988
+ post:
989
+ tags:
990
+ - internal
991
+ - scan
992
+ x-jvm-package: scan
993
+ operationId: getAnsRules
994
+ requestBody:
995
+ required: true
996
+ content:
997
+ application/json:
998
+ schema:
999
+ $ref: "#/components/schemas/GetAnsRulesRequest"
1000
+ responses:
1001
+ "200":
1002
+ description: ok
1003
+ content:
1004
+ application/json:
1005
+ schema:
1006
+ $ref: "#/components/schemas/GetAnsRulesResponse"
1007
+ /v0/featured-apps:
1008
+ get:
1009
+ tags:
1010
+ - internal
1011
+ - scan
1012
+ x-jvm-package: scan
1013
+ operationId: listFeaturedAppRights
1014
+ description: |
1015
+ List every `FeaturedAppRight` registered with the DSO on the ledger.
1016
+ responses:
1017
+ "200":
1018
+ description: ok
1019
+ content:
1020
+ application/json:
1021
+ schema:
1022
+ $ref: "#/components/schemas/ListFeaturedAppRightsResponse"
1023
+ /v0/featured-apps/{provider_party_id}:
1024
+ get:
1025
+ tags:
1026
+ - internal
1027
+ - scan
1028
+ x-jvm-package: scan
1029
+ operationId: lookupFeaturedAppRight
1030
+ description: |
1031
+ If `provider_party_id` has a `FeaturedAppRight` registered with the DSO,
1032
+ return it; `featured_app_right` will be empty otherwise.
1033
+ parameters:
1034
+ - name: provider_party_id
1035
+ in: path
1036
+ required: true
1037
+ schema:
1038
+ type: string
1039
+ responses:
1040
+ "200":
1041
+ description: ok
1042
+ content:
1043
+ application/json:
1044
+ schema:
1045
+ $ref: "#/components/schemas/LookupFeaturedAppRightResponse"
1046
+ /v0/top-validators-by-validator-faucets:
1047
+ get:
1048
+ tags:
1049
+ - internal
1050
+ - scan
1051
+ x-jvm-package: scan
1052
+ operationId: getTopValidatorsByValidatorFaucets
1053
+ description: |
1054
+ Get a list of top validators by number of rounds in which they collected
1055
+ faucets, and basis statistics on their round collection history
1056
+ parameters:
1057
+ - in: query
1058
+ name: limit
1059
+ description: |
1060
+ Maximum number of validator records that may be returned in the
1061
+ response
1062
+ required: true
1063
+ schema:
1064
+ type: integer
1065
+ format: int32
1066
+ responses:
1067
+ "200":
1068
+ description: ok
1069
+ content:
1070
+ application/json:
1071
+ schema:
1072
+ $ref: "#/components/schemas/GetTopValidatorsByValidatorFaucetsResponse"
1073
+ "400":
1074
+ description: bad request
1075
+ content:
1076
+ application/json:
1077
+ schema: *a2
1078
+ "404":
1079
+ description: not found
1080
+ content:
1081
+ application/json:
1082
+ schema: *a1
1083
+ /v0/transfer-preapprovals/by-party/{party}:
1084
+ get:
1085
+ tags:
1086
+ - internal
1087
+ - scan
1088
+ x-jvm-package: scan
1089
+ operationId: lookupTransferPreapprovalByParty
1090
+ description: Lookup a TransferPreapproval by the receiver party.
1091
+ parameters:
1092
+ - name: party
1093
+ in: path
1094
+ required: true
1095
+ schema:
1096
+ type: string
1097
+ responses:
1098
+ "200":
1099
+ description: ok
1100
+ content:
1101
+ application/json:
1102
+ schema:
1103
+ $ref: "#/components/schemas/LookupTransferPreapprovalByPartyResponse"
1104
+ "404":
1105
+ description: not found
1106
+ content:
1107
+ application/json:
1108
+ schema: *a1
1109
+ /v0/transfer-command-counter/{party}:
1110
+ get:
1111
+ tags:
1112
+ - internal
1113
+ - scan
1114
+ x-jvm-package: scan
1115
+ operationId: lookupTransferCommandCounterByParty
1116
+ description: Lookup a TransferCommandCounter by the receiver party.
1117
+ parameters:
1118
+ - name: party
1119
+ in: path
1120
+ required: true
1121
+ schema:
1122
+ type: string
1123
+ responses:
1124
+ "200":
1125
+ description: ok
1126
+ content:
1127
+ application/json:
1128
+ schema:
1129
+ $ref: "#/components/schemas/LookupTransferCommandCounterByPartyResponse"
1130
+ "404":
1131
+ description: not found
1132
+ content:
1133
+ application/json:
1134
+ schema: *a1
1135
+ /v0/transfer-command/status:
1136
+ get:
1137
+ description: Retrieve the status of all transfer commands (up to a limit of 100) of the given sender for the specified nonce.
1138
+ tags:
1139
+ - internal
1140
+ - scan
1141
+ x-jvm-package: scan
1142
+ operationId: lookupTransferCommandStatus
1143
+ parameters:
1144
+ - name: sender
1145
+ in: query
1146
+ required: true
1147
+ schema:
1148
+ type: string
1149
+ - name: nonce
1150
+ in: query
1151
+ required: true
1152
+ schema:
1153
+ type: integer
1154
+ format: int64
1155
+ responses:
1156
+ "200":
1157
+ description: ok
1158
+ content:
1159
+ application/json:
1160
+ schema:
1161
+ $ref: "#/components/schemas/LookupTransferCommandStatusResponse"
1162
+ "404":
1163
+ description: not found
1164
+ content:
1165
+ application/json:
1166
+ schema: *a1
1167
+ /v0/migrations/schedule:
1168
+ get:
1169
+ tags:
1170
+ - internal
1171
+ - scan
1172
+ x-jvm-package: scan
1173
+ operationId: getMigrationSchedule
1174
+ description: |
1175
+ If the DSO has scheduled a synchronizer upgrade, return its planned time
1176
+ and the new migration ID.
1177
+ responses:
1178
+ "200":
1179
+ description: ok
1180
+ content:
1181
+ application/json:
1182
+ schema:
1183
+ $ref: "#/components/schemas/MigrationSchedule"
1184
+ "404":
1185
+ description: No migration scheduled
1186
+ /v0/synchronizer-identities/{domain_id_prefix}:
1187
+ get:
1188
+ tags:
1189
+ - internal
1190
+ - scan
1191
+ x-jvm-package: scan_soft_domain_migration_poc
1192
+ operationId: getSynchronizerIdentities
1193
+ parameters:
1194
+ - name: domain_id_prefix
1195
+ in: path
1196
+ required: true
1197
+ schema:
1198
+ type: string
1199
+ responses:
1200
+ "200":
1201
+ description: ok
1202
+ content:
1203
+ application/json:
1204
+ schema:
1205
+ $ref: "#/components/schemas/SynchronizerIdentities"
1206
+ "404":
1207
+ description: not found
1208
+ content:
1209
+ application/json:
1210
+ schema: *a1
1211
+ /v0/synchronizer-bootstrapping-transactions/{domain_id_prefix}:
1212
+ get:
1213
+ tags:
1214
+ - internal
1215
+ - scan
1216
+ x-jvm-package: scan_soft_domain_migration_poc
1217
+ operationId: getSynchronizerBootstrappingTransactions
1218
+ parameters:
1219
+ - name: domain_id_prefix
1220
+ in: path
1221
+ required: true
1222
+ schema:
1223
+ type: string
1224
+ responses:
1225
+ "200":
1226
+ description: ok
1227
+ content:
1228
+ application/json:
1229
+ schema:
1230
+ $ref: "#/components/schemas/SynchronizerBootstrappingTransactions"
1231
+ "404":
1232
+ description: not found
1233
+ content:
1234
+ application/json:
1235
+ schema: *a1
1236
+ /v0/splice-instance-names:
1237
+ get:
1238
+ tags:
1239
+ - internal
1240
+ - scan
1241
+ x-jvm-package: scan
1242
+ operationId: getSpliceInstanceNames
1243
+ description: Retrieve the UI names of various elements of this Splice network.
1244
+ responses:
1245
+ "200":
1246
+ description: ok
1247
+ content:
1248
+ application/json:
1249
+ schema:
1250
+ $ref: "#/components/schemas/GetSpliceInstanceNamesResponse"
1251
+ "404":
1252
+ description: not found
1253
+ content:
1254
+ application/json:
1255
+ schema: *a1
1256
+ /v0/amulet-price/votes:
1257
+ get:
1258
+ tags:
1259
+ - scan
1260
+ - internal
1261
+ x-jvm-package: scan
1262
+ operationId: listAmuletPriceVotes
1263
+ description: Retrieve a list of the latest amulet price votes
1264
+ responses:
1265
+ "200":
1266
+ description: ok
1267
+ content:
1268
+ application/json:
1269
+ schema:
1270
+ description: Contracts of Daml template `Splice.DSO:AmuletPrice:AmuletPriceVote`.
1271
+ type: object
1272
+ required:
1273
+ - amulet_price_votes
1274
+ properties:
1275
+ amulet_price_votes:
1276
+ type: array
1277
+ items:
1278
+ type: object
1279
+ properties:
1280
+ template_id:
1281
+ type: string
1282
+ contract_id:
1283
+ type: string
1284
+ payload:
1285
+ type: object
1286
+ created_event_blob:
1287
+ type: string
1288
+ created_at:
1289
+ type: string
1290
+ required:
1291
+ - template_id
1292
+ - contract_id
1293
+ - payload
1294
+ - created_event_blob
1295
+ - created_at
1296
+ /v0/voterequest:
1297
+ post:
1298
+ tags:
1299
+ - internal
1300
+ - scan
1301
+ x-jvm-package: scan
1302
+ operationId: listVoteRequestsByTrackingCid
1303
+ description: Look up several `VoteRequest`\ s at once by their contract IDs.
1304
+ requestBody:
1305
+ required: true
1306
+ content:
1307
+ application/json:
1308
+ schema:
1309
+ type: object
1310
+ required:
1311
+ - vote_request_contract_ids
1312
+ properties:
1313
+ vote_request_contract_ids:
1314
+ description: Contract IDs of Daml template `Splice.DsoRules:VoteRequest`.
1315
+ type: array
1316
+ items:
1317
+ type: string
1318
+ responses:
1319
+ "200":
1320
+ description: ok
1321
+ content:
1322
+ application/json:
1323
+ schema:
1324
+ type: object
1325
+ required:
1326
+ - vote_requests
1327
+ properties:
1328
+ vote_requests:
1329
+ description: |
1330
+ Contracts of Daml template `Splice.DsoRules:VoteRequest` that match
1331
+ `vote_request_contract_ids` in the request.
1332
+ type: array
1333
+ items:
1334
+ type: object
1335
+ properties:
1336
+ template_id:
1337
+ type: string
1338
+ contract_id:
1339
+ type: string
1340
+ payload:
1341
+ type: object
1342
+ created_event_blob:
1343
+ type: string
1344
+ created_at:
1345
+ type: string
1346
+ required:
1347
+ - template_id
1348
+ - contract_id
1349
+ - payload
1350
+ - created_event_blob
1351
+ - created_at
1352
+ /v0/voterequests/{vote_request_contract_id}:
1353
+ get:
1354
+ tags:
1355
+ - internal
1356
+ - scan
1357
+ x-jvm-package: scan
1358
+ operationId: lookupDsoRulesVoteRequest
1359
+ description: Look up a `VoteRequest` by contract ID.
1360
+ parameters:
1361
+ - name: vote_request_contract_id
1362
+ in: path
1363
+ required: true
1364
+ schema:
1365
+ type: string
1366
+ responses:
1367
+ "200":
1368
+ description: ok
1369
+ content:
1370
+ application/json:
1371
+ schema:
1372
+ description: A contract of Daml template `Splice.DsoRules:VoteRequest`.
1373
+ type: object
1374
+ required:
1375
+ - dso_rules_vote_request
1376
+ properties:
1377
+ dso_rules_vote_request:
1378
+ type: object
1379
+ properties:
1380
+ template_id:
1381
+ type: string
1382
+ contract_id:
1383
+ type: string
1384
+ payload:
1385
+ type: object
1386
+ created_event_blob:
1387
+ type: string
1388
+ created_at:
1389
+ type: string
1390
+ required:
1391
+ - template_id
1392
+ - contract_id
1393
+ - payload
1394
+ - created_event_blob
1395
+ - created_at
1396
+ "404":
1397
+ description: VoteRequest contract not found.
1398
+ content:
1399
+ application/json:
1400
+ schema:
1401
+ type: object
1402
+ required:
1403
+ - error
1404
+ properties:
1405
+ error:
1406
+ type: string
1407
+ /v0/admin/sv/voterequests:
1408
+ get:
1409
+ tags:
1410
+ - internal
1411
+ - scan
1412
+ x-jvm-package: scan
1413
+ operationId: listDsoRulesVoteRequests
1414
+ description: List all active `VoteRequest`\ s.
1415
+ responses:
1416
+ "200":
1417
+ description: ok
1418
+ content:
1419
+ application/json:
1420
+ schema:
1421
+ description: Contracts of Daml template `Splice.DsoRules:VoteRequest`.
1422
+ type: object
1423
+ required:
1424
+ - dso_rules_vote_requests
1425
+ properties:
1426
+ dso_rules_vote_requests:
1427
+ type: array
1428
+ items:
1429
+ type: object
1430
+ properties:
1431
+ template_id:
1432
+ type: string
1433
+ contract_id:
1434
+ type: string
1435
+ payload:
1436
+ type: object
1437
+ created_event_blob:
1438
+ type: string
1439
+ created_at:
1440
+ type: string
1441
+ required:
1442
+ - template_id
1443
+ - contract_id
1444
+ - payload
1445
+ - created_event_blob
1446
+ - created_at
1447
+ /v0/admin/sv/voteresults:
1448
+ post:
1449
+ tags:
1450
+ - internal
1451
+ - scan
1452
+ x-jvm-package: scan
1453
+ operationId: listVoteRequestResults
1454
+ requestBody:
1455
+ required: true
1456
+ content:
1457
+ application/json:
1458
+ schema:
1459
+ type: object
1460
+ required:
1461
+ - limit
1462
+ properties:
1463
+ actionName:
1464
+ type: string
1465
+ accepted:
1466
+ type: boolean
1467
+ requester:
1468
+ type: string
1469
+ effectiveFrom:
1470
+ type: string
1471
+ effectiveTo:
1472
+ type: string
1473
+ limit:
1474
+ type: integer
1475
+ responses:
1476
+ "200":
1477
+ description: ok
1478
+ content:
1479
+ application/json:
1480
+ schema:
1481
+ type: object
1482
+ required:
1483
+ - dso_rules_vote_results
1484
+ properties:
1485
+ dso_rules_vote_results:
1486
+ type: array
1487
+ items:
1488
+ type: object
1489
+ /v0/backfilling/migration-info:
1490
+ post:
1491
+ tags:
1492
+ - internal
1493
+ - scan
1494
+ x-jvm-package: scan
1495
+ operationId: getMigrationInfo
1496
+ description: |
1497
+ List all previous synchronizer migrations in this Splice network's history.
1498
+ requestBody:
1499
+ required: true
1500
+ content:
1501
+ application/json:
1502
+ schema:
1503
+ $ref: "#/components/schemas/GetMigrationInfoRequest"
1504
+ responses:
1505
+ "200":
1506
+ description: ok
1507
+ content:
1508
+ application/json:
1509
+ schema:
1510
+ $ref: "#/components/schemas/GetMigrationInfoResponse"
1511
+ "404":
1512
+ description: not found
1513
+ content:
1514
+ application/json:
1515
+ schema: *a1
1516
+ /v0/backfilling/updates-before:
1517
+ post:
1518
+ tags:
1519
+ - internal
1520
+ - scan
1521
+ x-jvm-package: scan
1522
+ operationId: getUpdatesBefore
1523
+ description: |
1524
+ Retrieve transactions and synchronizer reassignments prior to the
1525
+ request's specification.
1526
+ requestBody:
1527
+ required: true
1528
+ content:
1529
+ application/json:
1530
+ schema:
1531
+ $ref: "#/components/schemas/GetUpdatesBeforeRequest"
1532
+ responses:
1533
+ "200":
1534
+ description: ok
1535
+ content:
1536
+ application/json:
1537
+ schema:
1538
+ $ref: "#/components/schemas/GetUpdatesBeforeResponse"
1539
+ "404":
1540
+ description: not found
1541
+ content:
1542
+ application/json:
1543
+ schema: *a1
1544
+ /v0/backfilling/status:
1545
+ get:
1546
+ tags:
1547
+ - internal
1548
+ - scan
1549
+ x-jvm-package: scan
1550
+ operationId: getBackfillingStatus
1551
+ description: |
1552
+ Retrieve the status of the backfilling process.
1553
+ responses:
1554
+ "200":
1555
+ description: ok
1556
+ content:
1557
+ application/json:
1558
+ schema:
1559
+ $ref: "#/components/schemas/GetBackfillingStatusResponse"
1560
+ /v0/acs/{party}:
1561
+ get:
1562
+ deprecated: true
1563
+ tags:
1564
+ - deprecated
1565
+ x-jvm-package: scan
1566
+ operationId: getAcsSnapshot
1567
+ description: "**Deprecated**. Fetch the current SV participant ACS snapshot for the DSO and `party`."
1568
+ parameters:
1569
+ - name: party
1570
+ in: path
1571
+ required: true
1572
+ schema:
1573
+ type: string
1574
+ - name: record_time
1575
+ in: query
1576
+ required: false
1577
+ schema:
1578
+ type: string
1579
+ responses:
1580
+ "200":
1581
+ description: ok
1582
+ content:
1583
+ application/json:
1584
+ schema:
1585
+ $ref: "#/components/schemas/GetAcsSnapshotResponse"
1586
+ /v0/aggregated-rounds:
1587
+ get:
1588
+ deprecated: true
1589
+ tags:
1590
+ - deprecated
1591
+ x-jvm-package: scan
1592
+ operationId: getAggregatedRounds
1593
+ description: "**Deprecated**. Retrieve the current earliest and latest rounds aggregated for this Scan."
1594
+ responses:
1595
+ "200":
1596
+ description: ok
1597
+ content:
1598
+ application/json:
1599
+ schema:
1600
+ $ref: "#/components/schemas/GetAggregatedRoundsResponse"
1601
+ "404":
1602
+ description: not found
1603
+ content:
1604
+ application/json:
1605
+ schema: *a1
1606
+ /v0/round-totals:
1607
+ post:
1608
+ deprecated: true
1609
+ tags:
1610
+ - deprecated
1611
+ x-jvm-package: scan
1612
+ operationId: listRoundTotals
1613
+ description: "**Deprecated**. List Amulet statistics for up to 200 closed rounds."
1614
+ requestBody:
1615
+ required: true
1616
+ content:
1617
+ application/json:
1618
+ schema:
1619
+ $ref: "#/components/schemas/ListRoundTotalsRequest"
1620
+ responses:
1621
+ "200":
1622
+ description: ok
1623
+ content:
1624
+ application/json:
1625
+ schema:
1626
+ $ref: "#/components/schemas/ListRoundTotalsResponse"
1627
+ "400":
1628
+ description: bad request
1629
+ content:
1630
+ application/json:
1631
+ schema: *a2
1632
+ "404":
1633
+ description: not found
1634
+ content:
1635
+ application/json:
1636
+ schema: *a1
1637
+ "500":
1638
+ description: internal server error
1639
+ content:
1640
+ application/json:
1641
+ schema: *a3
1642
+ /v0/round-party-totals:
1643
+ post:
1644
+ deprecated: true
1645
+ tags:
1646
+ - deprecated
1647
+ x-jvm-package: scan
1648
+ operationId: listRoundPartyTotals
1649
+ description: "**Deprecated**. Retrieve per-party Amulet statistics for up to 50 closed rounds."
1650
+ requestBody:
1651
+ required: true
1652
+ content:
1653
+ application/json:
1654
+ schema:
1655
+ $ref: "#/components/schemas/ListRoundPartyTotalsRequest"
1656
+ responses:
1657
+ "200":
1658
+ description: ok
1659
+ content:
1660
+ application/json:
1661
+ schema:
1662
+ $ref: "#/components/schemas/ListRoundPartyTotalsResponse"
1663
+ "400":
1664
+ description: bad request
1665
+ content:
1666
+ application/json:
1667
+ schema: *a2
1668
+ "404":
1669
+ description: not found
1670
+ content:
1671
+ application/json:
1672
+ schema: *a1
1673
+ "500":
1674
+ description: internal server error
1675
+ content:
1676
+ application/json:
1677
+ schema: *a3
1678
+ /v0/amulet-config-for-round:
1679
+ get:
1680
+ deprecated: true
1681
+ tags:
1682
+ - deprecated
1683
+ x-jvm-package: scan
1684
+ operationId: getAmuletConfigForRound
1685
+ description: |
1686
+ **Deprecated**. Retrieve some information from the `AmuletRules` selected for the given round
1687
+ parameters:
1688
+ - in: query
1689
+ name: round
1690
+ required: true
1691
+ schema:
1692
+ type: integer
1693
+ format: int64
1694
+ responses:
1695
+ "200":
1696
+ description: ok
1697
+ content:
1698
+ application/json:
1699
+ schema:
1700
+ $ref: "#/components/schemas/GetAmuletConfigForRoundResponse"
1701
+ "404":
1702
+ description: not found
1703
+ content:
1704
+ application/json:
1705
+ schema: *a1
1706
+ /v0/round-of-latest-data:
1707
+ get:
1708
+ deprecated: true
1709
+ tags:
1710
+ - deprecated
1711
+ - scan
1712
+ x-jvm-package: scan
1713
+ operationId: getRoundOfLatestData
1714
+ description: |
1715
+ **Deprecated**. Get the latest round number for which aggregated data is available and
1716
+ the ledger effective time at which the round was closed.
1717
+ responses:
1718
+ "200":
1719
+ description: ok
1720
+ content:
1721
+ application/json:
1722
+ schema:
1723
+ $ref: "#/components/schemas/GetRoundOfLatestDataResponse"
1724
+ "404":
1725
+ description: not found
1726
+ content:
1727
+ application/json:
1728
+ schema: *a1
1729
+ /v0/rewards-collected:
1730
+ get:
1731
+ deprecated: true
1732
+ tags:
1733
+ - deprecated
1734
+ - scan
1735
+ x-jvm-package: scan
1736
+ operationId: getRewardsCollected
1737
+ description: "**Deprecated**. Get the total rewards collected ever"
1738
+ parameters:
1739
+ - in: query
1740
+ name: round
1741
+ required: false
1742
+ schema:
1743
+ type: integer
1744
+ format: int64
1745
+ responses:
1746
+ "200":
1747
+ description: ok
1748
+ content:
1749
+ application/json:
1750
+ schema:
1751
+ $ref: "#/components/schemas/GetRewardsCollectedResponse"
1752
+ "404":
1753
+ description: not found
1754
+ content:
1755
+ application/json:
1756
+ schema: *a1
1757
+ /v0/top-providers-by-app-rewards:
1758
+ get:
1759
+ deprecated: true
1760
+ tags:
1761
+ - deprecated
1762
+ - scan
1763
+ x-jvm-package: scan
1764
+ operationId: getTopProvidersByAppRewards
1765
+ description: |
1766
+ **Deprecated**. Get a list of top-earning app providers, and the total earned app
1767
+ rewards for each
1768
+ parameters:
1769
+ - in: query
1770
+ name: round
1771
+ required: true
1772
+ schema:
1773
+ type: integer
1774
+ format: int64
1775
+ - in: query
1776
+ name: limit
1777
+ required: true
1778
+ schema:
1779
+ type: integer
1780
+ format: int32
1781
+ responses:
1782
+ "200":
1783
+ description: ok
1784
+ content:
1785
+ application/json:
1786
+ schema:
1787
+ $ref: "#/components/schemas/GetTopProvidersByAppRewardsResponse"
1788
+ "400":
1789
+ description: bad request
1790
+ content:
1791
+ application/json:
1792
+ schema: *a2
1793
+ "404":
1794
+ description: not found
1795
+ content:
1796
+ application/json:
1797
+ schema: *a1
1798
+ /v0/top-validators-by-validator-rewards:
1799
+ get:
1800
+ deprecated: true
1801
+ tags:
1802
+ - deprecated
1803
+ - scan
1804
+ x-jvm-package: scan
1805
+ operationId: getTopValidatorsByValidatorRewards
1806
+ description: |
1807
+ **Deprecated**. Get a list of top-earning validators, and the total earned validator
1808
+ rewards for each
1809
+ parameters:
1810
+ - in: query
1811
+ name: round
1812
+ required: true
1813
+ schema:
1814
+ type: integer
1815
+ format: int64
1816
+ - in: query
1817
+ name: limit
1818
+ required: true
1819
+ schema:
1820
+ type: integer
1821
+ format: int32
1822
+ responses:
1823
+ "200":
1824
+ description: ok
1825
+ content:
1826
+ application/json:
1827
+ schema:
1828
+ $ref: "#/components/schemas/GetTopValidatorsByValidatorRewardsResponse"
1829
+ "400":
1830
+ description: bad request
1831
+ content:
1832
+ application/json:
1833
+ schema: *a2
1834
+ "404":
1835
+ description: not found
1836
+ content:
1837
+ application/json:
1838
+ schema: *a1
1839
+ /v0/top-validators-by-purchased-traffic:
1840
+ get:
1841
+ deprecated: true
1842
+ tags:
1843
+ - deprecated
1844
+ - scan
1845
+ x-jvm-package: scan
1846
+ operationId: getTopValidatorsByPurchasedTraffic
1847
+ description: |
1848
+ **Deprecated**. Get a list of validators and their domain fees spends, sorted by the
1849
+ amount of extra traffic purchased
1850
+ parameters:
1851
+ - in: query
1852
+ name: round
1853
+ required: true
1854
+ schema:
1855
+ type: integer
1856
+ format: int64
1857
+ - in: query
1858
+ name: limit
1859
+ required: true
1860
+ schema:
1861
+ type: integer
1862
+ format: int32
1863
+ responses:
1864
+ "200":
1865
+ description: ok
1866
+ content:
1867
+ application/json:
1868
+ schema:
1869
+ $ref: "#/components/schemas/GetTopValidatorsByPurchasedTrafficResponse"
1870
+ "400":
1871
+ description: bad request
1872
+ content:
1873
+ application/json:
1874
+ schema: *a2
1875
+ "404":
1876
+ description: not found
1877
+ content:
1878
+ application/json:
1879
+ schema: *a1
1880
+ /v0/activities:
1881
+ post:
1882
+ deprecated: true
1883
+ tags:
1884
+ - deprecated
1885
+ - scan
1886
+ x-jvm-package: scan
1887
+ operationId: listActivity
1888
+ description: |
1889
+ **Deprecated**. Lists activities in descending order, paged, optionally starting after a provided event id.
1890
+ requestBody:
1891
+ required: true
1892
+ content:
1893
+ application/json:
1894
+ schema:
1895
+ $ref: "#/components/schemas/ListActivityRequest"
1896
+ responses:
1897
+ "200":
1898
+ description: ok
1899
+ content:
1900
+ application/json:
1901
+ schema:
1902
+ $ref: "#/components/schemas/ListActivityResponse"
1903
+ "404":
1904
+ description: not found
1905
+ content:
1906
+ application/json:
1907
+ schema: *a1
1908
+ "500":
1909
+ description: internal server error
1910
+ content:
1911
+ application/json:
1912
+ schema: *a3
1913
+ /v0/transactions:
1914
+ post:
1915
+ deprecated: true
1916
+ tags:
1917
+ - deprecated
1918
+ x-jvm-package: scan
1919
+ operationId: listTransactionHistory
1920
+ description: |
1921
+ **Deprecated with known bugs that will not be fixed, use /v2/updates instead**.
1922
+
1923
+ Lists transactions, by default in ascending order, paged, from ledger begin or optionally starting after a provided event id.
1924
+ requestBody:
1925
+ required: true
1926
+ content:
1927
+ application/json:
1928
+ schema:
1929
+ $ref: "#/components/schemas/TransactionHistoryRequest"
1930
+ responses:
1931
+ "200":
1932
+ description: ok
1933
+ content:
1934
+ application/json:
1935
+ schema:
1936
+ $ref: "#/components/schemas/TransactionHistoryResponse"
1937
+ "400":
1938
+ description: bad request
1939
+ content:
1940
+ application/json:
1941
+ schema: *a2
1942
+ "404":
1943
+ description: not found
1944
+ content:
1945
+ application/json:
1946
+ schema: *a1
1947
+ "500":
1948
+ description: internal server error
1949
+ content:
1950
+ application/json:
1951
+ schema: *a3
1952
+ /v0/updates:
1953
+ post:
1954
+ deprecated: true
1955
+ tags:
1956
+ - deprecated
1957
+ x-jvm-package: scan
1958
+ operationId: getUpdateHistory
1959
+ description: |
1960
+ **Deprecated**, use /v2/updates instead.
1961
+ Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
1962
+ requestBody:
1963
+ required: true
1964
+ content:
1965
+ application/json:
1966
+ schema:
1967
+ $ref: "#/components/schemas/UpdateHistoryRequest"
1968
+ responses:
1969
+ "200":
1970
+ description: ok
1971
+ content:
1972
+ application/json:
1973
+ schema:
1974
+ $ref: "#/components/schemas/UpdateHistoryResponse"
1975
+ "400":
1976
+ description: bad request
1977
+ content:
1978
+ application/json:
1979
+ schema: *a2
1980
+ "500":
1981
+ description: internal server error
1982
+ content:
1983
+ application/json:
1984
+ schema: *a3
1985
+ /v0/updates/{update_id}:
1986
+ get:
1987
+ deprecated: true
1988
+ tags:
1989
+ - deprecated
1990
+ x-jvm-package: scan
1991
+ operationId: getUpdateById
1992
+ description: |
1993
+ **Deprecated**, use /v2/updates/{update_id} instead.
1994
+ parameters:
1995
+ - name: update_id
1996
+ in: path
1997
+ required: true
1998
+ schema:
1999
+ type: string
2000
+ - name: lossless
2001
+ in: query
2002
+ description: |
2003
+ Whether contract payload should be encoded into json using a lossless, but much harder to process, encoding.
2004
+ This is mostly used for backend calls, and is not recommended for external users.
2005
+ Optional and defaults to false.
2006
+ schema:
2007
+ type: boolean
2008
+ responses:
2009
+ "200":
2010
+ description: ok
2011
+ content:
2012
+ application/json:
2013
+ schema:
2014
+ $ref: "#/components/schemas/UpdateHistoryItem"
2015
+ "400":
2016
+ description: bad request
2017
+ content:
2018
+ application/json:
2019
+ schema: *a2
2020
+ "404":
2021
+ description: not found
2022
+ content:
2023
+ application/json:
2024
+ schema: *a1
2025
+ "500":
2026
+ description: internal server error
2027
+ content:
2028
+ application/json:
2029
+ schema: *a3
2030
+ /v0/feature-support:
2031
+ get:
2032
+ tags:
2033
+ - internal
2034
+ - scan
2035
+ x-jvm-package: scan
2036
+ operationId: featureSupport
2037
+ responses:
2038
+ "200":
2039
+ description: ok
2040
+ content:
2041
+ application/json:
2042
+ schema:
2043
+ type: object
2044
+ required:
2045
+ - no_holding_fees_on_transfers
2046
+ properties:
2047
+ no_holding_fees_on_transfers:
2048
+ type: boolean
2049
+ "500":
2050
+ description: internal server error
2051
+ content:
2052
+ application/json:
2053
+ schema: *a3
2054
+ /v0/backfilling/import-updates:
2055
+ post:
2056
+ tags:
2057
+ - scan
2058
+ x-jvm-package: scan
2059
+ operationId: getImportUpdates
2060
+ requestBody:
2061
+ required: true
2062
+ content:
2063
+ application/json:
2064
+ schema:
2065
+ $ref: "#/components/schemas/GetImportUpdatesRequest"
2066
+ responses:
2067
+ "200":
2068
+ description: ok
2069
+ content:
2070
+ application/json:
2071
+ schema:
2072
+ $ref: "#/components/schemas/GetImportUpdatesResponse"
2073
+ "404":
2074
+ description: not found
2075
+ content:
2076
+ application/json:
2077
+ schema: *a1
2078
+ /v0/events:
2079
+ post:
2080
+ tags:
2081
+ - external
2082
+ - scan
2083
+ x-jvm-package: scan
2084
+ operationId: getEventHistory
2085
+ description: |
2086
+ Returns the event history in ascending order, paged, from ledger begin or optionally starting after a record time.
2087
+ An event bears some combination of a transaction, a contract reassignment, and a verdict.
2088
+ Events are ordered lexicographically by `(migration id, record time)`.
2089
+ For a given migration id, each event has a unique record time.
2090
+ The record time ranges of different migrations may overlap, i.e.,
2091
+ it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
2092
+ and there may be two updates with the same record time but different migration ids.
2093
+ requestBody:
2094
+ required: true
2095
+ content:
2096
+ application/json:
2097
+ schema:
2098
+ $ref: "#/components/schemas/EventHistoryRequest"
2099
+ responses:
2100
+ "200":
2101
+ description: ok
2102
+ content:
2103
+ application/json:
2104
+ schema:
2105
+ $ref: "#/components/schemas/EventHistoryResponse"
2106
+ "400":
2107
+ description: bad request
2108
+ content:
2109
+ application/json:
2110
+ schema: *a2
2111
+ "500":
2112
+ description: internal server error
2113
+ content:
2114
+ application/json:
2115
+ schema: *a3
2116
+ /v0/events/{update_id}:
2117
+ get:
2118
+ tags:
2119
+ - external
2120
+ - scan
2121
+ x-jvm-package: scan
2122
+ operationId: getEventById
2123
+ description: |
2124
+ Returns the event with the given update_id.
2125
+ An event bears some combination of a transaction, a contract reassignment, and a verdict.
2126
+ parameters:
2127
+ - name: update_id
2128
+ in: path
2129
+ required: true
2130
+ schema:
2131
+ type: string
2132
+ - name: daml_value_encoding
2133
+ in: query
2134
+ schema:
2135
+ $ref: "#/components/schemas/DamlValueEncoding"
2136
+ responses:
2137
+ "200":
2138
+ description: ok
2139
+ content:
2140
+ application/json:
2141
+ schema:
2142
+ $ref: "#/components/schemas/EventHistoryItem"
2143
+ "400":
2144
+ description: bad request
2145
+ content:
2146
+ application/json:
2147
+ schema: *a2
2148
+ "404":
2149
+ description: not found
2150
+ content:
2151
+ application/json:
2152
+ schema: *a1
2153
+ "500":
2154
+ description: internal server error
2155
+ content:
2156
+ application/json:
2157
+ schema: *a3
2158
+ /v0/unclaimed-development-fund-coupons:
2159
+ get:
2160
+ tags:
2161
+ - external
2162
+ - scan
2163
+ x-jvm-package: scan
2164
+ operationId: listUnclaimedDevelopmentFundCoupons
2165
+ description: |
2166
+ List all unclaimed development fund coupons.
2167
+ responses:
2168
+ "200":
2169
+ description: ok
2170
+ content:
2171
+ application/json:
2172
+ schema:
2173
+ $ref: "#/components/schemas/ListUnclaimedDevelopmentFundCouponsResponse"
2174
+ "500":
2175
+ description: internal server error
2176
+ content:
2177
+ application/json:
2178
+ schema: *a3
2179
+ components:
2180
+ schemas:
2181
+ GetSpliceInstanceNamesResponse:
2182
+ type: object
2183
+ required:
2184
+ - network_name
2185
+ - network_favicon_url
2186
+ - amulet_name
2187
+ - amulet_name_acronym
2188
+ - name_service_name
2189
+ - name_service_name_acronym
2190
+ properties:
2191
+ network_name:
2192
+ description: What to call this Splice network.
2193
+ type: string
2194
+ network_favicon_url:
2195
+ description: URL of an HTML favicon for this Splice network.
2196
+ type: string
2197
+ amulet_name:
2198
+ description: What this Splice network calls Amulet.
2199
+ type: string
2200
+ amulet_name_acronym:
2201
+ description: The three-letter acronym for Amulet.
2202
+ type: string
2203
+ name_service_name:
2204
+ description: What this Splice network calls the Amulet Name Service.
2205
+ type: string
2206
+ name_service_name_acronym:
2207
+ description: The acronym for `name_service_name`.
2208
+ type: string
2209
+ GetDsoPartyIdResponse:
2210
+ type: object
2211
+ required:
2212
+ - dso_party_id
2213
+ properties:
2214
+ dso_party_id:
2215
+ type: string
2216
+ GetClosedRoundsResponse:
2217
+ type: object
2218
+ required:
2219
+ - rounds
2220
+ properties:
2221
+ rounds:
2222
+ description: |
2223
+ Contracts of the Daml template `Splice.Round:ClosedMiningRound`, one
2224
+ for every closed round that is still in process, i.e. it either has
2225
+ unprocessed rewards or a missing `Splice.DsoRules:Confirmation`.
2226
+ type: array
2227
+ items:
2228
+ type: object
2229
+ properties:
2230
+ template_id:
2231
+ type: string
2232
+ contract_id:
2233
+ type: string
2234
+ payload:
2235
+ type: object
2236
+ created_event_blob:
2237
+ type: string
2238
+ created_at:
2239
+ type: string
2240
+ required:
2241
+ - template_id
2242
+ - contract_id
2243
+ - payload
2244
+ - created_event_blob
2245
+ - created_at
2246
+ GetOpenAndIssuingMiningRoundsRequest:
2247
+ type: object
2248
+ required:
2249
+ - cached_open_mining_round_contract_ids
2250
+ - cached_issuing_round_contract_ids
2251
+ properties:
2252
+ cached_open_mining_round_contract_ids:
2253
+ description: |
2254
+ The contract IDs for `open_mining_rounds` in the response the caller
2255
+ knows about. If unsure, an empty array is fine; only a performance
2256
+ penalty is incurred.
2257
+ type: array
2258
+ items:
2259
+ type: string
2260
+ cached_issuing_round_contract_ids:
2261
+ description: |
2262
+ The contract IDs for `issuing_mining_rounds` in the response the
2263
+ caller knows about. If unsure, an empty array is fine; only a
2264
+ performance penalty is incurred.
2265
+ type: array
2266
+ items:
2267
+ type: string
2268
+ GetOpenAndIssuingMiningRoundsResponse:
2269
+ description: |
2270
+ Daml contracts of the templates `Splice.Round.OpenMiningRound` and
2271
+ `Splice.Round.IssuingMiningRound` representing rounds for which rewards
2272
+ can be registered or are currently being computed, respectively.
2273
+ Contract IDs in the input serve as input sets for the two
2274
+ `MaybeCachedContractWithStateMap`s as described for that structure for
2275
+ `open_mining_rounds` and `issuing_mining_rounds`.
2276
+ type: object
2277
+ required:
2278
+ - open_mining_rounds
2279
+ - issuing_mining_rounds
2280
+ - time_to_live_in_microseconds
2281
+ properties:
2282
+ time_to_live_in_microseconds:
2283
+ description: |
2284
+ Suggested cache TTL for the response; this should expire before the
2285
+ `opensAt` of any open rounds that may not be in this response yet.
2286
+ type: integer
2287
+ open_mining_rounds:
2288
+ description: |
2289
+ Always created with respect to an input set of contract IDs. If an input
2290
+ contract ID is absent from the keys of this map, that contract should be
2291
+ considered removed by the caller; if present, `contract` may be empty,
2292
+ reflecting that the caller should already have the full contract data
2293
+ for that contract ID. Contracts not present in the input set will have
2294
+ full contract data. `domain_id` is always up-to-date; if undefined the
2295
+ contract is currently unassigned to a synchronizer, i.e. "in-flight".
2296
+ type: object
2297
+ additionalProperties: &a4
2298
+ $ref: "#/components/schemas/MaybeCachedContractWithState"
2299
+ issuing_mining_rounds:
2300
+ description: |
2301
+ Always created with respect to an input set of contract IDs. If an input
2302
+ contract ID is absent from the keys of this map, that contract should be
2303
+ considered removed by the caller; if present, `contract` may be empty,
2304
+ reflecting that the caller should already have the full contract data
2305
+ for that contract ID. Contracts not present in the input set will have
2306
+ full contract data. `domain_id` is always up-to-date; if undefined the
2307
+ contract is currently unassigned to a synchronizer, i.e. "in-flight".
2308
+ type: object
2309
+ additionalProperties: *a4
2310
+ GetAmuletRulesRequest:
2311
+ type: object
2312
+ properties:
2313
+ cached_amulet_rules_contract_id:
2314
+ type: string
2315
+ cached_amulet_rules_domain_id:
2316
+ type: string
2317
+ GetAmuletRulesResponse:
2318
+ description: |
2319
+ Contract of the Daml template `Splice.AmuletRules.AmuletRules`,
2320
+ including the full schedule of `AmuletConfig` changes approved by
2321
+ the DSO. Callers should not assume that `initialValue` is up-to-date,
2322
+ and should instead search `futureValues` for the latest configuration
2323
+ valid as of now. `contract` will be absent if its ID matches the input
2324
+ `cached_amulet_rules_contract_id`.
2325
+ type: object
2326
+ properties:
2327
+ amulet_rules_update:
2328
+ type: object
2329
+ properties:
2330
+ contract:
2331
+ type: object
2332
+ properties:
2333
+ template_id:
2334
+ type: string
2335
+ contract_id:
2336
+ type: string
2337
+ payload:
2338
+ type: object
2339
+ created_event_blob:
2340
+ type: string
2341
+ created_at:
2342
+ type: string
2343
+ required:
2344
+ - template_id
2345
+ - contract_id
2346
+ - payload
2347
+ - created_event_blob
2348
+ - created_at
2349
+ domain_id:
2350
+ type: string
2351
+ required:
2352
+ - amulet_rules_update
2353
+ GetExternalPartyAmuletRulesRequest:
2354
+ type: object
2355
+ properties:
2356
+ cached_external_party_amulet_rules_contract_id:
2357
+ type: string
2358
+ cached_external_party_amulet_rules_domain_id:
2359
+ type: string
2360
+ GetExternalPartyAmuletRulesResponse:
2361
+ description: |
2362
+ A contract state update of Daml template
2363
+ `Splice.ExternalPartyAmuletRules.ExternalPartyAmuletRules`
2364
+ type: object
2365
+ properties:
2366
+ external_party_amulet_rules_update:
2367
+ type: object
2368
+ properties:
2369
+ contract:
2370
+ type: object
2371
+ properties:
2372
+ template_id:
2373
+ type: string
2374
+ contract_id:
2375
+ type: string
2376
+ payload:
2377
+ type: object
2378
+ created_event_blob:
2379
+ type: string
2380
+ created_at:
2381
+ type: string
2382
+ required:
2383
+ - template_id
2384
+ - contract_id
2385
+ - payload
2386
+ - created_event_blob
2387
+ - created_at
2388
+ domain_id:
2389
+ type: string
2390
+ required:
2391
+ - external_party_amulet_rules_update
2392
+ GetAnsRulesRequest:
2393
+ type: object
2394
+ properties:
2395
+ cached_ans_rules_contract_id:
2396
+ type: string
2397
+ cached_ans_rules_domain_id:
2398
+ type: string
2399
+ GetAnsRulesResponse:
2400
+ description: |
2401
+ A contract state update of Daml template `Splice.Ans.AnsRules`.
2402
+ type: object
2403
+ properties:
2404
+ ans_rules_update:
2405
+ type: object
2406
+ properties:
2407
+ contract:
2408
+ type: object
2409
+ properties:
2410
+ template_id:
2411
+ type: string
2412
+ contract_id:
2413
+ type: string
2414
+ payload:
2415
+ type: object
2416
+ created_event_blob:
2417
+ type: string
2418
+ created_at:
2419
+ type: string
2420
+ required:
2421
+ - template_id
2422
+ - contract_id
2423
+ - payload
2424
+ - created_event_blob
2425
+ - created_at
2426
+ domain_id:
2427
+ type: string
2428
+ required:
2429
+ - ans_rules_update
2430
+ ListFeaturedAppRightsResponse:
2431
+ description: |
2432
+ Contracts of Daml template `Splice.Amulet.FeaturedAppRight`.
2433
+ type: object
2434
+ required:
2435
+ - featured_apps
2436
+ properties:
2437
+ featured_apps:
2438
+ type: array
2439
+ items:
2440
+ type: object
2441
+ properties:
2442
+ template_id:
2443
+ type: string
2444
+ contract_id:
2445
+ type: string
2446
+ payload:
2447
+ type: object
2448
+ created_event_blob:
2449
+ type: string
2450
+ created_at:
2451
+ type: string
2452
+ required:
2453
+ - template_id
2454
+ - contract_id
2455
+ - payload
2456
+ - created_event_blob
2457
+ - created_at
2458
+ LookupFeaturedAppRightResponse:
2459
+ description: |
2460
+ If defined, a contract of Daml template `Splice.Amulet.FeaturedAppRight`.
2461
+ type: object
2462
+ properties:
2463
+ featured_app_right:
2464
+ type: object
2465
+ properties:
2466
+ template_id:
2467
+ type: string
2468
+ contract_id:
2469
+ type: string
2470
+ payload:
2471
+ type: object
2472
+ created_event_blob:
2473
+ type: string
2474
+ created_at:
2475
+ type: string
2476
+ required:
2477
+ - template_id
2478
+ - contract_id
2479
+ - payload
2480
+ - created_event_blob
2481
+ - created_at
2482
+ GetAmuletConfigForRoundResponse:
2483
+ type: object
2484
+ required:
2485
+ - amulet_create_fee
2486
+ - holding_fee
2487
+ - lock_holder_fee
2488
+ - transfer_fee
2489
+ properties:
2490
+ amulet_create_fee:
2491
+ type: string
2492
+ holding_fee:
2493
+ type: string
2494
+ lock_holder_fee:
2495
+ type: string
2496
+ transfer_fee:
2497
+ $ref: "#/components/schemas/SteppedRate"
2498
+ SteppedRate:
2499
+ type: object
2500
+ required:
2501
+ - initial
2502
+ - steps
2503
+ properties:
2504
+ initial:
2505
+ type: string
2506
+ steps:
2507
+ type: array
2508
+ items:
2509
+ $ref: "#/components/schemas/RateStep"
2510
+ RateStep:
2511
+ type: object
2512
+ required:
2513
+ - amount
2514
+ - rate
2515
+ properties:
2516
+ amount:
2517
+ type: string
2518
+ rate:
2519
+ type: string
2520
+ GetRoundOfLatestDataResponse:
2521
+ type: object
2522
+ required:
2523
+ - round
2524
+ - effectiveAt
2525
+ properties:
2526
+ round:
2527
+ type: integer
2528
+ format: int64
2529
+ effectiveAt:
2530
+ type: string
2531
+ format: date-time
2532
+ GetRewardsCollectedResponse:
2533
+ type: object
2534
+ required:
2535
+ - amount
2536
+ properties:
2537
+ amount:
2538
+ type: string
2539
+ GetValidatorTrafficBalanceResponse:
2540
+ type: object
2541
+ required:
2542
+ - remainingBalance
2543
+ - totalPurchased
2544
+ properties:
2545
+ remainingBalance:
2546
+ type: number
2547
+ format: double
2548
+ totalPurchased:
2549
+ type: number
2550
+ format: double
2551
+ CheckAndUpdateValidatorTrafficBalanceResponse:
2552
+ type: object
2553
+ required:
2554
+ - approved
2555
+ properties:
2556
+ approved:
2557
+ type: boolean
2558
+ GetTopProvidersByAppRewardsResponse:
2559
+ type: object
2560
+ required:
2561
+ - providersAndRewards
2562
+ properties:
2563
+ providersAndRewards:
2564
+ type: array
2565
+ items:
2566
+ $ref: "#/components/schemas/PartyAndRewards"
2567
+ GetTopValidatorsByValidatorRewardsResponse:
2568
+ type: object
2569
+ required:
2570
+ - validatorsAndRewards
2571
+ properties:
2572
+ validatorsAndRewards:
2573
+ type: array
2574
+ items:
2575
+ $ref: "#/components/schemas/PartyAndRewards"
2576
+ PartyAndRewards:
2577
+ type: object
2578
+ required:
2579
+ - provider
2580
+ - rewards
2581
+ properties:
2582
+ provider:
2583
+ type: string
2584
+ rewards:
2585
+ type: string
2586
+ GetTopValidatorsByValidatorFaucetsResponse:
2587
+ type: object
2588
+ required:
2589
+ - validatorsByReceivedFaucets
2590
+ properties:
2591
+ validatorsByReceivedFaucets:
2592
+ description: |
2593
+ Up to `limit` validators, sorted greatest number of rounds
2594
+ collected first
2595
+ type: array
2596
+ items:
2597
+ $ref: "#/components/schemas/ValidatorReceivedFaucets"
2598
+ GetTopValidatorsByPurchasedTrafficResponse:
2599
+ type: object
2600
+ required:
2601
+ - validatorsByPurchasedTraffic
2602
+ properties:
2603
+ validatorsByPurchasedTraffic:
2604
+ type: array
2605
+ items:
2606
+ $ref: "#/components/schemas/ValidatorPurchasedTraffic"
2607
+ ValidatorPurchasedTraffic:
2608
+ type: object
2609
+ required:
2610
+ - validator
2611
+ - numPurchases
2612
+ - totalTrafficPurchased
2613
+ - totalCcSpent
2614
+ - lastPurchasedInRound
2615
+ properties:
2616
+ validator:
2617
+ type: string
2618
+ numPurchases:
2619
+ type: integer
2620
+ format: int64
2621
+ totalTrafficPurchased:
2622
+ type: integer
2623
+ format: int64
2624
+ totalCcSpent:
2625
+ type: string
2626
+ lastPurchasedInRound:
2627
+ type: integer
2628
+ format: int64
2629
+ ListSvBftSequencersResponse:
2630
+ type: object
2631
+ required:
2632
+ - bftSequencers
2633
+ properties:
2634
+ bftSequencers:
2635
+ type: array
2636
+ items:
2637
+ $ref: "#/components/schemas/SynchronizerBftSequencer"
2638
+ SynchronizerBftSequencer:
2639
+ type: object
2640
+ required:
2641
+ - migrationId
2642
+ - id
2643
+ - p2pUrl
2644
+ properties:
2645
+ migrationId:
2646
+ description: |
2647
+ The synchronizer migration id corresponding to this sequencer.
2648
+ type: integer
2649
+ format: int64
2650
+ id:
2651
+ description: The id of the sequencer.
2652
+ type: string
2653
+ p2pUrl:
2654
+ description: The public accessible P2P url of the sequencer, use for inter sequencer communication.
2655
+ type: string
2656
+ ListDsoSequencersResponse:
2657
+ type: object
2658
+ required:
2659
+ - domainSequencers
2660
+ properties:
2661
+ domainSequencers:
2662
+ type: array
2663
+ items:
2664
+ $ref: "#/components/schemas/DomainSequencers"
2665
+ DomainSequencers:
2666
+ type: object
2667
+ required:
2668
+ - domainId
2669
+ - sequencers
2670
+ properties:
2671
+ domainId:
2672
+ description: the synchronizer ID for the associated sequencers
2673
+ type: string
2674
+ sequencers:
2675
+ description: the sequencers associated with the synchronizer
2676
+ type: array
2677
+ items:
2678
+ $ref: "#/components/schemas/DsoSequencer"
2679
+ DsoSequencer:
2680
+ type: object
2681
+ required:
2682
+ - migrationId
2683
+ - id
2684
+ - url
2685
+ - svName
2686
+ - availableAfter
2687
+ properties:
2688
+ migrationId:
2689
+ description: |
2690
+ The synchronizer migration id corresponding to this sequencer.
2691
+ type: integer
2692
+ format: int64
2693
+ id:
2694
+ description: The id of the sequencer.
2695
+ type: string
2696
+ url:
2697
+ description: The public accessible url of the sequencer.
2698
+ type: string
2699
+ svName:
2700
+ description: The sequencer's operating SV name.
2701
+ type: string
2702
+ availableAfter:
2703
+ description: |
2704
+ Any participant should subscribe to this sequencer after this time.
2705
+ type: string
2706
+ format: date-time
2707
+ ListDsoScansResponse:
2708
+ type: object
2709
+ required:
2710
+ - scans
2711
+ properties:
2712
+ scans:
2713
+ type: array
2714
+ items:
2715
+ $ref: "#/components/schemas/DomainScans"
2716
+ DomainScans:
2717
+ type: object
2718
+ required:
2719
+ - domainId
2720
+ - scans
2721
+ properties:
2722
+ domainId:
2723
+ type: string
2724
+ scans:
2725
+ description: |
2726
+ SV scans for the associated synchronizer ID; there is at most one
2727
+ scan per SV for each synchronizer ID.
2728
+ type: array
2729
+ items:
2730
+ $ref: "#/components/schemas/ScanInfo"
2731
+ ScanInfo:
2732
+ type: object
2733
+ required:
2734
+ - publicUrl
2735
+ - svName
2736
+ properties:
2737
+ publicUrl:
2738
+ description: The public accessible url of the scan.
2739
+ type: string
2740
+ svName:
2741
+ description: The sequencer's operating SV name.
2742
+ type: string
2743
+ TransactionHistoryRequest:
2744
+ type: object
2745
+ required:
2746
+ - page_size
2747
+ properties:
2748
+ page_end_event_id:
2749
+ type: string
2750
+ description: |
2751
+ Note that all transactions carry some monotonically-increasing event_id.
2752
+ Omit this page_end_event_id to start reading the first page, from the beginning or the end of the ledger, depending on the sort_order column.
2753
+ A subsequent request can fill the page_end_event_id with the last event_id of the TransactionHistoryResponse to continue reading in the same sort_order.
2754
+ The transaction with event_id == page_end_event_id will be skipped in the next response, making it possible to continuously read pages in the same sort_order.
2755
+ sort_order:
2756
+ description: |
2757
+ Sort order for the transactions. For ascending order, from beginning to the end of the ledger, use "asc".
2758
+ For descending order, from end to beginning of the ledger, use "desc".
2759
+ "asc" is used if the sort_order is omitted.
2760
+ type: string
2761
+ enum:
2762
+ - asc
2763
+ - desc
2764
+ page_size:
2765
+ description: |
2766
+ The maximum number of transactions returned for this request.
2767
+ type: integer
2768
+ format: int64
2769
+ TransactionHistoryResponse:
2770
+ type: object
2771
+ required:
2772
+ - transactions
2773
+ properties:
2774
+ transactions:
2775
+ type: array
2776
+ items:
2777
+ $ref: "#/components/schemas/TransactionHistoryResponseItem"
2778
+ TransactionHistoryResponseItem:
2779
+ type: object
2780
+ required:
2781
+ - transaction_type
2782
+ - event_id
2783
+ - date
2784
+ - domain_id
2785
+ properties:
2786
+ transaction_type:
2787
+ description: |
2788
+ Describes the type of activity that occurred.
2789
+ Determines if the data for the transaction should be read
2790
+ from the `transfer`, `mint`, or `tap` property.
2791
+ type: string
2792
+ enum:
2793
+ - transfer
2794
+ - mint
2795
+ - devnet_tap
2796
+ - abort_transfer_instruction
2797
+ event_id:
2798
+ description: |
2799
+ The event id.
2800
+ type: string
2801
+ offset:
2802
+ description: |
2803
+ The ledger offset of the event.
2804
+ Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
2805
+ type: string
2806
+ date:
2807
+ description: |
2808
+ The effective date of the event.
2809
+ type: string
2810
+ format: date-time
2811
+ domain_id:
2812
+ description: |
2813
+ The id of the domain through which this transaction was sequenced.
2814
+ type: string
2815
+ round:
2816
+ description: |
2817
+ The round for which this transaction was registered.
2818
+ type: integer
2819
+ format: int64
2820
+ amulet_price:
2821
+ description: |
2822
+ The amulet price for the round at which this transfer was executed.
2823
+ type: string
2824
+ transfer:
2825
+ description: |
2826
+ A (batch) transfer from sender to receivers.
2827
+ $ref: "#/components/schemas/Transfer"
2828
+ mint:
2829
+ description: |
2830
+ The DSO mints amulet for the cases where the DSO rules allow for that.
2831
+ $ref: "#/components/schemas/AmuletAmount"
2832
+ tap:
2833
+ description: |
2834
+ A tap creates a Amulet, only used for development purposes, and enabled only on DevNet.
2835
+ $ref: "#/components/schemas/AmuletAmount"
2836
+ abort_transfer_instruction:
2837
+ $ref: "#/components/schemas/AbortTransferInstruction"
2838
+ UpdateHistoryRequestAfter:
2839
+ type: object
2840
+ required:
2841
+ - after_migration_id
2842
+ - after_record_time
2843
+ properties:
2844
+ after_migration_id:
2845
+ type: integer
2846
+ format: int64
2847
+ description: |
2848
+ The migration id from which to start returning transactions. This is inclusive.
2849
+ after_record_time:
2850
+ type: string
2851
+ description: |
2852
+ The record time to start returning transactions from. This only affects
2853
+ transactions with the same migration id as after_migration_id. Higher migration ids
2854
+ are always considered to be later.
2855
+ UpdateHistoryRequest:
2856
+ type: object
2857
+ required:
2858
+ - page_size
2859
+ properties:
2860
+ after:
2861
+ $ref: "#/components/schemas/UpdateHistoryRequestAfter"
2862
+ description: |
2863
+ The transactions returned will either have a higher migration id or
2864
+ the same migration id and a record_time greater than the migration id and record time
2865
+ specified.
2866
+ page_size:
2867
+ description: |
2868
+ The maximum number of transactions returned for this request.
2869
+ type: integer
2870
+ format: int32
2871
+ lossless:
2872
+ description: |
2873
+ Whether contract payload should be encoded into json using a lossless, but much harder to process, encoding.
2874
+ This is mostly used for backend calls, and is not recommended for external users.
2875
+ Optional and defaults to false.
2876
+ type: boolean
2877
+ UpdateHistoryRequestV1:
2878
+ type: object
2879
+ required:
2880
+ - page_size
2881
+ properties:
2882
+ after:
2883
+ $ref: "#/components/schemas/UpdateHistoryRequestAfter"
2884
+ description: |
2885
+ The transactions returned will either have a higher migration id or
2886
+ the same migration id and a record_time greater than the migration id and record time
2887
+ specified.
2888
+ page_size:
2889
+ description: |
2890
+ The maximum number of transactions returned for this request.
2891
+ type: integer
2892
+ format: int32
2893
+ daml_value_encoding:
2894
+ $ref: "#/components/schemas/DamlValueEncoding"
2895
+ UpdateHistoryRequestV2:
2896
+ type: object
2897
+ required:
2898
+ - page_size
2899
+ properties:
2900
+ after:
2901
+ $ref: "#/components/schemas/UpdateHistoryRequestAfter"
2902
+ description: |
2903
+ The transactions returned will either have a higher migration id or
2904
+ the same migration id and a record_time greater than the migration id and record time
2905
+ specified.
2906
+ page_size:
2907
+ description: |
2908
+ The maximum number of transactions returned for this request.
2909
+ type: integer
2910
+ format: int32
2911
+ daml_value_encoding:
2912
+ $ref: "#/components/schemas/DamlValueEncoding"
2913
+ UpdateHistoryResponseV2:
2914
+ type: object
2915
+ required:
2916
+ - transactions
2917
+ properties:
2918
+ transactions:
2919
+ type: array
2920
+ items:
2921
+ $ref: "#/components/schemas/UpdateHistoryItemV2"
2922
+ UpdateHistoryResponse:
2923
+ type: object
2924
+ required:
2925
+ - transactions
2926
+ properties:
2927
+ transactions:
2928
+ type: array
2929
+ items:
2930
+ $ref: "#/components/schemas/UpdateHistoryItem"
2931
+ UpdateHistoryItemV2:
2932
+ type: object
2933
+ description: |
2934
+ An individual item in the update history. May be a transaction or a contract reassignment.
2935
+ oneOf:
2936
+ - $ref: "#/components/schemas/UpdateHistoryTransactionV2"
2937
+ - $ref: "#/components/schemas/UpdateHistoryReassignment"
2938
+ UpdateHistoryItem:
2939
+ type: object
2940
+ description: |
2941
+ An individual item in the update history. May be a transaction or a contract reassignment.
2942
+ oneOf:
2943
+ - $ref: "#/components/schemas/UpdateHistoryTransaction"
2944
+ - $ref: "#/components/schemas/UpdateHistoryReassignment"
2945
+ UpdateHistoryReassignment:
2946
+ type: object
2947
+ description: A contract reassignment between synchronizer. May be an assignment or unassignment.
2948
+ required:
2949
+ - update_id
2950
+ - offset
2951
+ - record_time
2952
+ - event
2953
+ properties:
2954
+ update_id:
2955
+ description: |
2956
+ The id of the update.
2957
+ type: string
2958
+ offset:
2959
+ description: |
2960
+ The absolute offset.
2961
+ Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
2962
+ type: string
2963
+ record_time:
2964
+ description: |
2965
+ The time at which the transaction was sequenced.
2966
+ type: string
2967
+ event:
2968
+ description: |
2969
+ The reassignment event. May be an assignment or unassignment.
2970
+ type: object
2971
+ oneOf:
2972
+ - $ref: "#/components/schemas/UpdateHistoryAssignment"
2973
+ - $ref: "#/components/schemas/UpdateHistoryUnassignment"
2974
+ UpdateHistoryAssignment:
2975
+ type: object
2976
+ required:
2977
+ - submitter
2978
+ - source_synchronizer
2979
+ - target_synchronizer
2980
+ - migration_id
2981
+ - unassign_id
2982
+ - created_event
2983
+ - reassignment_counter
2984
+ properties:
2985
+ submitter:
2986
+ description: |
2987
+ The party ID who submitted this reassignment
2988
+ type: string
2989
+ source_synchronizer:
2990
+ description: |
2991
+ The id of the synchronizer from which the contract was reassigned
2992
+ type: string
2993
+ target_synchronizer:
2994
+ description: |
2995
+ The id of the synchronizer to which the contract was reassigned
2996
+ type: string
2997
+ migration_id:
2998
+ description: |
2999
+ The migration id of the target synchronizer
3000
+ type: integer
3001
+ format: int64
3002
+ unassign_id:
3003
+ description: |
3004
+ The id of the corresponding unassign event; this assignment will
3005
+ usually, but not always, occur after the so-identified unassignment
3006
+ event.
3007
+ type: string
3008
+ created_event:
3009
+ description: |
3010
+ The corresponding contract create event
3011
+ $ref: "#/components/schemas/CreatedEvent"
3012
+ reassignment_counter:
3013
+ description: Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter 0.
3014
+ type: integer
3015
+ format: int64
3016
+ UpdateHistoryUnassignment:
3017
+ type: object
3018
+ required:
3019
+ - submitter
3020
+ - source_synchronizer
3021
+ - migration_id
3022
+ - target_synchronizer
3023
+ - unassign_id
3024
+ - reassignment_counter
3025
+ - contract_id
3026
+ properties:
3027
+ submitter:
3028
+ description: |
3029
+ The party who submitted this reassignment
3030
+ type: string
3031
+ source_synchronizer:
3032
+ description: |
3033
+ The id of the synchronizer from which the contract was reassigned
3034
+ type: string
3035
+ migration_id:
3036
+ description: |
3037
+ The migration id of the synchronizer from which the contract was reassigned
3038
+ type: integer
3039
+ format: int64
3040
+ target_synchronizer:
3041
+ description: |
3042
+ The id of the synchronizer to which the contract was reassigned
3043
+ type: string
3044
+ unassign_id:
3045
+ description: |
3046
+ The id of the unassign event, to later be correlated to an assign event
3047
+ type: string
3048
+ reassignment_counter:
3049
+ description: Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter 0.
3050
+ type: integer
3051
+ format: int64
3052
+ contract_id:
3053
+ description: |
3054
+ The id of the unassigned contract
3055
+ type: string
3056
+ UpdateHistoryTransaction:
3057
+ type: object
3058
+ required:
3059
+ - update_id
3060
+ - migration_id
3061
+ - workflow_id
3062
+ - record_time
3063
+ - synchronizer_id
3064
+ - effective_at
3065
+ - offset
3066
+ - root_event_ids
3067
+ - events_by_id
3068
+ properties:
3069
+ update_id:
3070
+ description: |
3071
+ The id of the update.
3072
+ type: string
3073
+ migration_id:
3074
+ description: |
3075
+ The migration id of the synchronizer.
3076
+ type: integer
3077
+ format: int64
3078
+ workflow_id:
3079
+ description: |
3080
+ This transaction's Daml workflow ID; a workflow ID can be associated
3081
+ with multiple transactions. If empty, no workflow ID was set.
3082
+ type: string
3083
+ record_time:
3084
+ description: |
3085
+ The time at which the transaction was sequenced, with microsecond
3086
+ resolution, using ISO-8601 representation.
3087
+ type: string
3088
+ synchronizer_id:
3089
+ description: |
3090
+ The id of the synchronizer through which this transaction was sequenced.
3091
+ type: string
3092
+ effective_at:
3093
+ description: |
3094
+ Ledger effective time, using ISO-8601 representation. This is the time
3095
+ returned by `getTime` for all Daml executed as part of this transaction,
3096
+ both by the submitting participant and all confirming participants.
3097
+ type: string
3098
+ offset:
3099
+ description: |
3100
+ The absolute offset.
3101
+ Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
3102
+ However, within a single SV's scan, it is monotonically, lexicographically increasing.
3103
+ type: string
3104
+ root_event_ids:
3105
+ description: |
3106
+ Roots of the transaction tree. These are guaranteed to occur as keys
3107
+ of the `events_by_id` object.
3108
+ type: array
3109
+ items:
3110
+ type: string
3111
+ events_by_id:
3112
+ description: |
3113
+ Changes to the ledger that were caused by this transaction, keyed by ID.
3114
+ Values are nodes of the transaction tree.
3115
+ Within a transaction, IDs may be referenced by `root_event_ids` or
3116
+ `child_event_ids` in `ExercisedEvent` herein.
3117
+ type: object
3118
+ additionalProperties:
3119
+ $ref: "#/components/schemas/TreeEvent"
3120
+ UpdateHistoryTransactionV2:
3121
+ type: object
3122
+ required:
3123
+ - update_id
3124
+ - migration_id
3125
+ - workflow_id
3126
+ - record_time
3127
+ - synchronizer_id
3128
+ - effective_at
3129
+ - root_event_ids
3130
+ - events_by_id
3131
+ properties:
3132
+ update_id:
3133
+ description: |
3134
+ The id of the update.
3135
+ type: string
3136
+ migration_id:
3137
+ description: |
3138
+ The migration id of the synchronizer.
3139
+ type: integer
3140
+ format: int64
3141
+ workflow_id:
3142
+ description: |
3143
+ This transaction's Daml workflow ID; a workflow ID can be associated
3144
+ with multiple transactions. If empty, no workflow ID was set.
3145
+ type: string
3146
+ record_time:
3147
+ description: |
3148
+ The time at which the transaction was sequenced, with microsecond
3149
+ resolution, using ISO-8601 representation.
3150
+ type: string
3151
+ synchronizer_id:
3152
+ description: |
3153
+ The id of the synchronizer through which this transaction was sequenced.
3154
+ type: string
3155
+ effective_at:
3156
+ description: |
3157
+ Ledger effective time, using ISO-8601 representation. This is the time
3158
+ returned by `getTime` for all Daml executed as part of this transaction,
3159
+ both by the submitting participant and all confirming participants.
3160
+ type: string
3161
+ root_event_ids:
3162
+ description: |
3163
+ Roots of the transaction tree. These are guaranteed to occur as keys
3164
+ of the `events_by_id` object.
3165
+ type: array
3166
+ items:
3167
+ type: string
3168
+ events_by_id:
3169
+ x-scala-map-type: scala.collection.immutable.SortedMap
3170
+ description: |
3171
+ Changes to the ledger that were caused by this transaction, keyed by ID and sorted lexicographically by ID for display consistency.
3172
+ Values are nodes of the transaction tree.
3173
+ Within a transaction, IDs may be referenced by `root_event_ids` or
3174
+ `child_event_ids` in `ExercisedEvent` herein, which are sorted in the order as they occurred in the transaction.
3175
+ type: object
3176
+ additionalProperties:
3177
+ $ref: "#/components/schemas/TreeEvent"
3178
+ TreeEvent:
3179
+ type: object
3180
+ description: |
3181
+ Either a creation or an exercise of a contract.
3182
+ oneOf:
3183
+ - $ref: "#/components/schemas/CreatedEvent"
3184
+ - $ref: "#/components/schemas/ExercisedEvent"
3185
+ discriminator:
3186
+ propertyName: event_type
3187
+ mapping:
3188
+ created_event: "#/components/schemas/CreatedEvent"
3189
+ exercised_event: "#/components/schemas/ExercisedEvent"
3190
+ CreatedEvent:
3191
+ type: object
3192
+ required:
3193
+ - event_type
3194
+ - event_id
3195
+ - contract_id
3196
+ - template_id
3197
+ - package_name
3198
+ - create_arguments
3199
+ - created_at
3200
+ - signatories
3201
+ - observers
3202
+ properties:
3203
+ event_type:
3204
+ type: string
3205
+ event_id:
3206
+ description: |
3207
+ The ID of this particular event. Equal to the key of this element of
3208
+ the containing `events_by_id` if this is part of a `TreeEvent`.
3209
+ type: string
3210
+ contract_id:
3211
+ description: |
3212
+ The ID of the created contract.
3213
+ type: string
3214
+ template_id:
3215
+ description: |
3216
+ The template of the created contract.
3217
+ type: string
3218
+ package_name:
3219
+ description: |
3220
+ The package name of the created contract.
3221
+ type: string
3222
+ create_arguments:
3223
+ description: |
3224
+ The arguments that have been used to create the contract, in the
3225
+ form of JSON representation of a Daml record.
3226
+ type: object
3227
+ created_at:
3228
+ description: |
3229
+ Ledger effective time of the transaction that created the contract.
3230
+ type: string
3231
+ format: date-time
3232
+ signatories:
3233
+ description: |
3234
+ Signatories to the contract, in the form of party IDs.
3235
+ type: array
3236
+ items:
3237
+ type: string
3238
+ observers:
3239
+ description: |
3240
+ Observers to the contract, in the form of party IDs.
3241
+ type: array
3242
+ items:
3243
+ type: string
3244
+ ExercisedEvent:
3245
+ type: object
3246
+ required:
3247
+ - event_type
3248
+ - event_id
3249
+ - contract_id
3250
+ - template_id
3251
+ - package_name
3252
+ - choice
3253
+ - choice_argument
3254
+ - child_event_ids
3255
+ - exercise_result
3256
+ - consuming
3257
+ - acting_parties
3258
+ properties:
3259
+ event_type:
3260
+ type: string
3261
+ event_id:
3262
+ description: |
3263
+ The ID of this particular event. Equal to the key of this element of
3264
+ the containing `events_by_id` if this is part of a `TreeEvent`.
3265
+ type: string
3266
+ contract_id:
3267
+ description: |
3268
+ The ID of the created contract.
3269
+ type: string
3270
+ template_id:
3271
+ description: |
3272
+ The template of the created contract.
3273
+ type: string
3274
+ package_name:
3275
+ description: |
3276
+ The package name of the created contract.
3277
+ type: string
3278
+ choice:
3279
+ description: |
3280
+ The choice that was exercised on the target contract, as an unqualified
3281
+ choice name, i.e. with no package or module name qualifiers.
3282
+ type: string
3283
+ choice_argument:
3284
+ description: |
3285
+ The argument of the exercised choice, in the form of JSON
3286
+ representation of a Daml value. This is usually a record with field
3287
+ names being the argument names, even in the case of a single apparent
3288
+ choice argument, which is represented as a single-element Daml record.
3289
+ type: object
3290
+ child_event_ids:
3291
+ description: |
3292
+ References to further events in the same transaction that appeared as a result of this ExercisedEvent.
3293
+ It contains only the immediate children of this event, not all members of the subtree rooted at this node.
3294
+ The order of the children is the same as the event order in the transaction.
3295
+ type: array
3296
+ items:
3297
+ type: string
3298
+ exercise_result:
3299
+ description: |
3300
+ The result of exercising the choice, as the JSON representation of a
3301
+ Daml value.
3302
+ type: object
3303
+ consuming:
3304
+ description: |
3305
+ If true, the target contract may no longer be exercised.
3306
+ type: boolean
3307
+ acting_parties:
3308
+ description: |
3309
+ The parties that exercised the choice, in the form of party IDs.
3310
+ type: array
3311
+ items:
3312
+ type: string
3313
+ interface_id:
3314
+ description: |
3315
+ The interface where the choice is defined, if inherited.
3316
+ type: string
3317
+ AcsSnapshotTimestampResponse:
3318
+ type: object
3319
+ required:
3320
+ - record_time
3321
+ properties:
3322
+ record_time:
3323
+ type: string
3324
+ format: date-time
3325
+ description: |
3326
+ The record time of the last transaction in the snapshot.
3327
+ AcsRequest:
3328
+ type: object
3329
+ required:
3330
+ - migration_id
3331
+ - record_time
3332
+ - page_size
3333
+ properties:
3334
+ migration_id:
3335
+ type: integer
3336
+ format: int64
3337
+ description: |
3338
+ The migration id for which to return the ACS.
3339
+ record_time:
3340
+ type: string
3341
+ format: date-time
3342
+ description: |
3343
+ The timestamp at which the contract set was active.
3344
+ This needs to be an exact timestamp, i.e.,
3345
+ needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp` if `record_time_match` is set to `exact` (which is the default).
3346
+ If `record_time_match` is set to `at_or_before`, this can be any timestamp, and the most recent snapshot at or before the given `record_time` will be returned.
3347
+ record_time_match:
3348
+ type: string
3349
+ description: |
3350
+ How to match the record_time. "exact" requires the record_time to match exactly.
3351
+ "at_or_before" finds the most recent snapshot at or before the given record_time.
3352
+ enum:
3353
+ - exact
3354
+ - at_or_before
3355
+ default: exact
3356
+ after:
3357
+ type: integer
3358
+ format: int64
3359
+ description: |
3360
+ Pagination token for the next page of results. For this to be valid,
3361
+ this must be the `next_page_token` from a prior request with identical
3362
+ parameters aside from `after` and `page_size`; the response may be
3363
+ invalid otherwise.
3364
+ page_size:
3365
+ description: |
3366
+ The maximum number of created events returned for this request.
3367
+ type: integer
3368
+ format: int32
3369
+ party_ids:
3370
+ type: array
3371
+ items:
3372
+ type: string
3373
+ description: |
3374
+ Filters the ACS by contracts in which these party IDs are stakeholders.
3375
+ templates:
3376
+ type: array
3377
+ items:
3378
+ type: string
3379
+ description: |
3380
+ Filters the ACS by contracts with these template IDs, specified as "PACKAGE_NAME:MODULE_NAME:ENTITY_NAME".
3381
+ HoldingsStateRequest:
3382
+ type: object
3383
+ required:
3384
+ - migration_id
3385
+ - record_time
3386
+ - page_size
3387
+ - owner_party_ids
3388
+ properties:
3389
+ migration_id:
3390
+ type: integer
3391
+ format: int64
3392
+ description: |
3393
+ The migration id for which to return the ACS.
3394
+ record_time:
3395
+ type: string
3396
+ format: date-time
3397
+ description: |
3398
+ The timestamp at which the contract set was active.
3399
+ This needs to be an exact timestamp, i.e.,
3400
+ needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp` if `record_time_match` is set to `exact` (which is the default).
3401
+ If `record_time_match` is set to `at_or_before`, this can be any timestamp, and the most recent snapshot at or before the given `record_time` will be returned.
3402
+ record_time_match:
3403
+ type: string
3404
+ description: |
3405
+ How to match the record_time. "exact" requires the record_time to match exactly.
3406
+ "at_or_before" finds the most recent snapshot at or before the given record_time.
3407
+ enum:
3408
+ - exact
3409
+ - at_or_before
3410
+ default: exact
3411
+ after:
3412
+ type: integer
3413
+ format: int64
3414
+ description: |
3415
+ Pagination token for the next page of results.
3416
+ page_size:
3417
+ description: |
3418
+ The maximum number of created events returned for this request.
3419
+ type: integer
3420
+ format: int32
3421
+ owner_party_ids:
3422
+ type: array
3423
+ items:
3424
+ type: string
3425
+ minItems: 1
3426
+ description: |
3427
+ Filters by contracts in which these party_ids are the owners of the amulets.
3428
+ HoldingsSummaryRequest:
3429
+ type: object
3430
+ required:
3431
+ - migration_id
3432
+ - record_time
3433
+ - owner_party_ids
3434
+ properties:
3435
+ migration_id:
3436
+ type: integer
3437
+ format: int64
3438
+ description: |
3439
+ The migration id for which to return the summary.
3440
+ record_time:
3441
+ type: string
3442
+ format: date-time
3443
+ description: |
3444
+ The timestamp at which the contract set was active.
3445
+ This needs to be an exact timestamp, i.e.,
3446
+ needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp` if `record_time_match` is set to `exact` (which is the default).
3447
+ If `record_time_match` is set to `at_or_before`, this can be any timestamp, and the most recent snapshot at or before the given `record_time` will be returned.
3448
+ record_time_match:
3449
+ type: string
3450
+ description: |
3451
+ How to match the record_time. "exact" requires the record_time to match exactly.
3452
+ "at_or_before" finds the most recent snapshot at or before the given record_time.
3453
+ enum:
3454
+ - exact
3455
+ - at_or_before
3456
+ default: exact
3457
+ owner_party_ids:
3458
+ type: array
3459
+ items:
3460
+ type: string
3461
+ minItems: 1
3462
+ description: |
3463
+ The owners for which to compute the summary.
3464
+ as_of_round:
3465
+ type: integer
3466
+ format: int64
3467
+ description: |
3468
+ Compute holding fees as of this round. Defaults to the earliest open mining round.
3469
+ ForceAcsSnapshotResponse:
3470
+ type: object
3471
+ required:
3472
+ - record_time
3473
+ - migration_id
3474
+ properties:
3475
+ record_time:
3476
+ description: |
3477
+ The [recent] time for which this ACS snapshot was persisted.
3478
+ type: string
3479
+ format: date-time
3480
+ migration_id:
3481
+ description: The current migration ID of the Scan.
3482
+ type: integer
3483
+ format: int64
3484
+ AcsResponse:
3485
+ type: object
3486
+ required:
3487
+ - record_time
3488
+ - migration_id
3489
+ - created_events
3490
+ properties:
3491
+ record_time:
3492
+ description: The same `record_time` as in the request.
3493
+ type: string
3494
+ format: date-time
3495
+ migration_id:
3496
+ description: The same `migration_id` as in the request.
3497
+ type: integer
3498
+ format: int64
3499
+ created_events:
3500
+ description: |
3501
+ Up to `page_size` contracts in the ACS.
3502
+ `create_arguments` are always encoded as `compact_json`.
3503
+ type: array
3504
+ items:
3505
+ $ref: "#/components/schemas/CreatedEvent"
3506
+ next_page_token:
3507
+ type: integer
3508
+ format: int64
3509
+ description: |
3510
+ When requesting the next page of results, pass this as `after`
3511
+ to the `AcsRequest` or `HoldingsStateRequest`.
3512
+ Will be absent when there are no more pages.
3513
+ HoldingsSummaryResponse:
3514
+ type: object
3515
+ required:
3516
+ - record_time
3517
+ - migration_id
3518
+ - computed_as_of_round
3519
+ - summaries
3520
+ properties:
3521
+ record_time:
3522
+ description: The same `record_time` as in the request.
3523
+ type: string
3524
+ format: date-time
3525
+ migration_id:
3526
+ description: The same `migration_id` as in the request.
3527
+ type: integer
3528
+ format: int64
3529
+ computed_as_of_round:
3530
+ description: The same `as_of_round` as in the request, with the same default.
3531
+ type: integer
3532
+ format: int64
3533
+ summaries:
3534
+ type: array
3535
+ items:
3536
+ $ref: "#/components/schemas/HoldingsSummary"
3537
+ HoldingsSummary:
3538
+ description: Aggregate Amulet totals for a particular owner party ID.
3539
+ type: object
3540
+ required:
3541
+ - party_id
3542
+ - total_unlocked_coin
3543
+ - total_locked_coin
3544
+ - total_coin_holdings
3545
+ - accumulated_holding_fees_unlocked
3546
+ - accumulated_holding_fees_locked
3547
+ - accumulated_holding_fees_total
3548
+ - total_available_coin
3549
+ properties:
3550
+ party_id:
3551
+ description: |
3552
+ Owner party ID of the amulet. Guaranteed to be unique among `summaries`.
3553
+ type: string
3554
+ total_unlocked_coin:
3555
+ description: |
3556
+ Sum of unlocked amulet at time of reception, not counting holding
3557
+ fees deducted since.
3558
+ type: string
3559
+ total_locked_coin:
3560
+ description: |
3561
+ Sum of locked amulet at time of original amulet reception, not
3562
+ counting holding fees deducted since.
3563
+ type: string
3564
+ total_coin_holdings:
3565
+ description: |
3566
+ `total_unlocked_coin` + `total_locked_coin`.
3567
+ type: string
3568
+ accumulated_holding_fees_unlocked:
3569
+ description: |
3570
+ Sum of holding fees as of `computed_as_of_round` that apply to
3571
+ unlocked amulet.
3572
+ type: string
3573
+ accumulated_holding_fees_locked:
3574
+ description: |
3575
+ Sum of holding fees as of `computed_as_of_round` that apply to
3576
+ locked amulet, including fees applied since the amulet's creation
3577
+ round.
3578
+ type: string
3579
+ accumulated_holding_fees_total:
3580
+ description: |
3581
+ Same as `accumulated_holding_fees_unlocked` + `accumulated_holding_fees_locked`.
3582
+ type: string
3583
+ total_available_coin:
3584
+ description: Same as `total_unlocked_coin` - `accumulated_holding_fees_unlocked`.
3585
+ type: string
3586
+ ListActivityRequest:
3587
+ type: object
3588
+ required:
3589
+ - page_size
3590
+ properties:
3591
+ begin_after_id:
3592
+ type: string
3593
+ description: |
3594
+ Minimal event_id for returned activities.
3595
+ Note that all activities carry some monotonically-increasing event_id. begin_after_id sets the minimum value for event_id's for the query.
3596
+ page_size:
3597
+ description: |
3598
+ The maximum number of activity items returned for this request.
3599
+ type: integer
3600
+ format: int64
3601
+ ListActivityResponse:
3602
+ type: object
3603
+ required:
3604
+ - activities
3605
+ properties:
3606
+ activities:
3607
+ type: array
3608
+ items:
3609
+ $ref: "#/components/schemas/ListActivityResponseItem"
3610
+ ListActivityResponseItem:
3611
+ type: object
3612
+ required:
3613
+ - activity_type
3614
+ - event_id
3615
+ - date
3616
+ - domain_id
3617
+ properties:
3618
+ activity_type:
3619
+ description: |
3620
+ Describes the type of activity that occurred.
3621
+ Determines if the data for the activity should be read
3622
+ from the `transfer`, `mint`, or `tap` property.
3623
+ type: string
3624
+ enum:
3625
+ - transfer
3626
+ - mint
3627
+ - devnet_tap
3628
+ - abort_transfer_instruction
3629
+ event_id:
3630
+ description: |
3631
+ The event id.
3632
+ type: string
3633
+ offset:
3634
+ description: |
3635
+ The ledger offset of the event.
3636
+ Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
3637
+ type: string
3638
+ date:
3639
+ description: |
3640
+ The effective date of the event.
3641
+ type: string
3642
+ format: date-time
3643
+ domain_id:
3644
+ description: |
3645
+ The id of the domain through which this transaction was sequenced.
3646
+ type: string
3647
+ round:
3648
+ description: |
3649
+ The round for which this transaction was registered.
3650
+ type: integer
3651
+ format: int64
3652
+ amulet_price:
3653
+ description: |
3654
+ The amulet price for the round at which this transfer was executed.
3655
+ type: string
3656
+ transfer:
3657
+ description: |
3658
+ A (batch) transfer from sender to receivers.
3659
+ $ref: "#/components/schemas/Transfer"
3660
+ mint:
3661
+ description: |
3662
+ The DSO mints amulet for the cases where the DSO rules allow for that.
3663
+ $ref: "#/components/schemas/AmuletAmount"
3664
+ tap:
3665
+ description: |
3666
+ A tap creates a Amulet, only used for development purposes, and enabled only on DevNet.
3667
+ $ref: "#/components/schemas/AmuletAmount"
3668
+ abort_transfer_instruction:
3669
+ $ref: "#/components/schemas/AbortTransferInstruction"
3670
+ Transfer:
3671
+ description: |
3672
+ A transfer between one sender and possibly many receivers
3673
+ type: object
3674
+ required:
3675
+ - sender
3676
+ - receivers
3677
+ - balance_changes
3678
+ properties:
3679
+ sender:
3680
+ description: |
3681
+ The sender amounts and fees.
3682
+ $ref: "#/components/schemas/SenderAmount"
3683
+ receivers:
3684
+ description: |
3685
+ The amounts and fees per receiver.
3686
+ type: array
3687
+ items:
3688
+ $ref: "#/components/schemas/ReceiverAmount"
3689
+ balance_changes:
3690
+ description: |
3691
+ Normalized balance changes per party caused by this transfer.
3692
+ type: array
3693
+ items:
3694
+ $ref: "#/components/schemas/BalanceChange"
3695
+ description:
3696
+ type: string
3697
+ transferInstructionReceiver:
3698
+ type: string
3699
+ transferInstructionAmount:
3700
+ type: string
3701
+ transferInstructionCid:
3702
+ type: string
3703
+ transfer_kind:
3704
+ type: string
3705
+ enum:
3706
+ - create_transfer_instruction
3707
+ - transfer_instruction_accept
3708
+ - preapproval_send
3709
+ AbortTransferInstruction:
3710
+ type: object
3711
+ required:
3712
+ - abort_kind
3713
+ - transfer_instruction_cid
3714
+ properties:
3715
+ abort_kind:
3716
+ type: string
3717
+ enum:
3718
+ - withdraw
3719
+ - reject
3720
+ transfer_instruction_cid:
3721
+ type: string
3722
+ BalanceChange:
3723
+ type: object
3724
+ required:
3725
+ - party
3726
+ - change_to_initial_amount_as_of_round_zero
3727
+ - change_to_holding_fees_rate
3728
+ properties:
3729
+ party:
3730
+ description: |
3731
+ The party for which the balance changes.
3732
+ type: string
3733
+ change_to_initial_amount_as_of_round_zero:
3734
+ description: |
3735
+ The change to the total balance introduced by this balance change, normalized to round zero, i.e.,
3736
+ a amulet created in round 3 is treated as a amulet created in round 0 with a higher initial amount.
3737
+ type: string
3738
+ change_to_holding_fees_rate:
3739
+ description: |
3740
+ The change of total holding fees introduced by this balance change.
3741
+ type: string
3742
+ AmuletAmount:
3743
+ type: object
3744
+ required:
3745
+ - amulet_owner
3746
+ - amulet_amount
3747
+ properties:
3748
+ amulet_owner:
3749
+ description: |
3750
+ The party that owns the amulet.
3751
+ type: string
3752
+ amulet_amount:
3753
+ description: |
3754
+ The amulet amount.
3755
+ type: string
3756
+ SenderAmount:
3757
+ type: object
3758
+ required:
3759
+ - party
3760
+ - sender_change_fee
3761
+ - sender_change_amount
3762
+ - sender_fee
3763
+ - holding_fees
3764
+ properties:
3765
+ party:
3766
+ description: |
3767
+ The sender who has transferred amulet.
3768
+ type: string
3769
+ input_amulet_amount:
3770
+ description: |
3771
+ Total amount of amulet input into this transfer, before deducting holding fees.
3772
+ type: string
3773
+ input_app_reward_amount:
3774
+ description: |
3775
+ Total amount of app rewards input into this transfer.
3776
+ type: string
3777
+ input_validator_reward_amount:
3778
+ description: |
3779
+ Total amount of validator rewards input into this transfer.
3780
+ type: string
3781
+ input_sv_reward_amount:
3782
+ description: |
3783
+ Total amount of sv rewards input into this transfer.
3784
+ type: string
3785
+ input_validator_faucet_amount:
3786
+ description: |
3787
+ Total amount of validator faucet coupon issuance input into this transfer.
3788
+ type: string
3789
+ sender_change_fee:
3790
+ description: |
3791
+ Fee charged for returning change to the sender,
3792
+ which is the smaller of the left-over balance after paying for all outputs
3793
+ or one amulet create fee.
3794
+ type: string
3795
+ sender_change_amount:
3796
+ description: |
3797
+ The final amount of amulet returned to the sender after paying for all outputs and fees.
3798
+ type: string
3799
+ sender_fee:
3800
+ description: |
3801
+ Total fees paid by the sender, based on receiver's receiver_fee_ratio on outputs
3802
+ type: string
3803
+ holding_fees:
3804
+ description: |
3805
+ Holding fees paid by the sender on their input amulets.
3806
+ type: string
3807
+ ReceiverAmount:
3808
+ type: object
3809
+ required:
3810
+ - party
3811
+ - amount
3812
+ - receiver_fee
3813
+ properties:
3814
+ party:
3815
+ description: |
3816
+ The receiver who will own the created output amulet.
3817
+ type: string
3818
+ amount:
3819
+ description: |
3820
+ The amount of amulet to receive, before deducting receiver's part of the fees.
3821
+ type: string
3822
+ receiver_fee:
3823
+ description: |
3824
+ Total fees paid by the receiver, based on receiver_fee_ratio on outputs
3825
+ type: string
3826
+ ListEntriesResponse:
3827
+ type: object
3828
+ required:
3829
+ - entries
3830
+ properties:
3831
+ entries:
3832
+ type: array
3833
+ items:
3834
+ $ref: "#/components/schemas/AnsEntry"
3835
+ LookupEntryByPartyResponse:
3836
+ type: object
3837
+ required:
3838
+ - entry
3839
+ properties:
3840
+ entry:
3841
+ $ref: "#/components/schemas/AnsEntry"
3842
+ LookupEntryByNameResponse:
3843
+ type: object
3844
+ required:
3845
+ - entry
3846
+ properties:
3847
+ entry:
3848
+ $ref: "#/components/schemas/AnsEntry"
3849
+ LookupTransferPreapprovalByPartyResponse:
3850
+ description: A Daml contract of template `Splice.AmuletRules:TransferPreapproval`.
3851
+ type: object
3852
+ required:
3853
+ - transfer_preapproval
3854
+ properties:
3855
+ transfer_preapproval:
3856
+ type: object
3857
+ properties:
3858
+ contract:
3859
+ type: object
3860
+ properties:
3861
+ template_id:
3862
+ type: string
3863
+ contract_id:
3864
+ type: string
3865
+ payload:
3866
+ type: object
3867
+ created_event_blob:
3868
+ type: string
3869
+ created_at:
3870
+ type: string
3871
+ required:
3872
+ - template_id
3873
+ - contract_id
3874
+ - payload
3875
+ - created_event_blob
3876
+ - created_at
3877
+ domain_id:
3878
+ type: string
3879
+ required:
3880
+ - contract
3881
+ LookupTransferCommandCounterByPartyResponse:
3882
+ description: A Daml contract of template `Splice.ExternalPartyAmuletRules:TransferCommandCounter`.
3883
+ type: object
3884
+ required:
3885
+ - transfer_command_counter
3886
+ properties:
3887
+ transfer_command_counter:
3888
+ type: object
3889
+ properties:
3890
+ contract:
3891
+ type: object
3892
+ properties:
3893
+ template_id:
3894
+ type: string
3895
+ contract_id:
3896
+ type: string
3897
+ payload:
3898
+ type: object
3899
+ created_event_blob:
3900
+ type: string
3901
+ created_at:
3902
+ type: string
3903
+ required:
3904
+ - template_id
3905
+ - contract_id
3906
+ - payload
3907
+ - created_event_blob
3908
+ - created_at
3909
+ domain_id:
3910
+ type: string
3911
+ required:
3912
+ - contract
3913
+ LookupTransferCommandStatusResponse:
3914
+ type: object
3915
+ required:
3916
+ - transfer_commands_by_contract_id
3917
+ properties:
3918
+ transfer_commands_by_contract_id:
3919
+ $ref: "#/components/schemas/TransferCommandMap"
3920
+ TransferCommandMap:
3921
+ type: object
3922
+ additionalProperties:
3923
+ $ref: "#/components/schemas/TransferCommandContractWithStatus"
3924
+ TransferCommandContractWithStatus:
3925
+ description: |
3926
+ A contract of Daml template `Splice.ExternalPartyAmuletRules:TransferCommand`,
3927
+ and its status determined by the latest transactions.
3928
+ type: object
3929
+ required:
3930
+ - contract
3931
+ - status
3932
+ properties:
3933
+ contract:
3934
+ type: object
3935
+ properties:
3936
+ template_id:
3937
+ type: string
3938
+ contract_id:
3939
+ type: string
3940
+ payload:
3941
+ type: object
3942
+ created_event_blob:
3943
+ type: string
3944
+ created_at:
3945
+ type: string
3946
+ required:
3947
+ - template_id
3948
+ - contract_id
3949
+ - payload
3950
+ - created_event_blob
3951
+ - created_at
3952
+ status:
3953
+ $ref: "#/components/schemas/TransferCommandContractStatus"
3954
+ TransferCommandContractStatus:
3955
+ type: object
3956
+ oneOf:
3957
+ - $ref: "#/components/schemas/TransferCommandCreatedResponse"
3958
+ - $ref: "#/components/schemas/TransferCommandSentResponse"
3959
+ - $ref: "#/components/schemas/TransferCommandFailedResponse"
3960
+ discriminator:
3961
+ propertyName: status
3962
+ mapping:
3963
+ created: "#/components/schemas/TransferCommandCreatedResponse"
3964
+ sent: "#/components/schemas/TransferCommandSentResponse"
3965
+ failed: "#/components/schemas/TransferCommandFailedResponse"
3966
+ BaseLookupTransferCommandStatusResponse:
3967
+ type: object
3968
+ required:
3969
+ - status
3970
+ properties:
3971
+ status:
3972
+ type: string
3973
+ description: |
3974
+ The status of the transfer command.
3975
+ created:
3976
+ The transfer command has been created and is waiting for automation to complete it.
3977
+ sent:
3978
+ The transfer command has been completed and the transfer to the receiver has finished.
3979
+ failed:
3980
+ The transfer command has failed permanently and nothing has been transferred. Refer to
3981
+ failure_reason for details. A new transfer command can be created.
3982
+ TransferCommandCreatedResponse:
3983
+ type: object
3984
+ allOf:
3985
+ - $ref: "#/components/schemas/BaseLookupTransferCommandStatusResponse"
3986
+ TransferCommandSentResponse:
3987
+ type: object
3988
+ allOf:
3989
+ - $ref: "#/components/schemas/BaseLookupTransferCommandStatusResponse"
3990
+ TransferCommandFailedResponse:
3991
+ type: object
3992
+ allOf:
3993
+ - $ref: "#/components/schemas/BaseLookupTransferCommandStatusResponse"
3994
+ - type: object
3995
+ required:
3996
+ - failure_kind
3997
+ - reason
3998
+ properties:
3999
+ failure_kind:
4000
+ type: string
4001
+ description: |
4002
+ The reason for the failure of the TransferCommand.
4003
+ failed:
4004
+ Completing the transfer failed, check the reason for details.
4005
+ withdrawn:
4006
+ The sender has withdrawn the TransferCommand before it could be completed.
4007
+ expired:
4008
+ The expiry time on the TransferCommand was reached before it could be completed.
4009
+ enum:
4010
+ - failed
4011
+ - expired
4012
+ - withdrawn
4013
+ reason:
4014
+ type: string
4015
+ description: |
4016
+ Human readable description of the failure
4017
+ GetAcsSnapshotResponse:
4018
+ type: object
4019
+ required:
4020
+ - acs_snapshot
4021
+ properties:
4022
+ acs_snapshot:
4023
+ description: base64-encoded ACS snapshot for the intersection of the DSO party and the requested party’s ACS
4024
+ type: string
4025
+ AnsEntry:
4026
+ type: object
4027
+ required:
4028
+ - user
4029
+ - name
4030
+ - url
4031
+ - description
4032
+ properties:
4033
+ contract_id:
4034
+ description: |
4035
+ If present, Daml contract ID of template `Splice.Ans:AnsEntry`.
4036
+ If absent, this is a DSO-provided entry for either the DSO or an SV.
4037
+ type: string
4038
+ user:
4039
+ description: Owner party ID of this ANS entry.
4040
+ type: string
4041
+ name:
4042
+ description: The ANS entry name.
4043
+ type: string
4044
+ url:
4045
+ description: Either empty, or an http/https URL supplied by the `user`.
4046
+ type: string
4047
+ description:
4048
+ description: Arbitrary description text supplied by `user`; may be empty.
4049
+ type: string
4050
+ expires_at:
4051
+ description: |
4052
+ Time after which this ANS entry expires; if renewed, it will have a
4053
+ new `contract_id` and `expires_at`.
4054
+ If `null` or absent, does not expire; this is the case only for
4055
+ special entries provided by the DSO.
4056
+ type: string
4057
+ format: date-time
4058
+ GetAggregatedRoundsResponse:
4059
+ type: object
4060
+ required:
4061
+ - start
4062
+ - end
4063
+ properties:
4064
+ start:
4065
+ type: integer
4066
+ format: int64
4067
+ end:
4068
+ type: integer
4069
+ format: int64
4070
+ ListRoundTotalsRequest:
4071
+ type: object
4072
+ required:
4073
+ - start_round
4074
+ - end_round
4075
+ properties:
4076
+ start_round:
4077
+ type: integer
4078
+ format: int64
4079
+ end_round:
4080
+ type: integer
4081
+ format: int64
4082
+ ListRoundPartyTotalsRequest:
4083
+ type: object
4084
+ required:
4085
+ - start_round
4086
+ - end_round
4087
+ properties:
4088
+ start_round:
4089
+ type: integer
4090
+ format: int64
4091
+ end_round:
4092
+ type: integer
4093
+ format: int64
4094
+ ListRoundTotalsResponse:
4095
+ type: object
4096
+ required:
4097
+ - entries
4098
+ properties:
4099
+ entries:
4100
+ type: array
4101
+ items:
4102
+ $ref: "#/components/schemas/RoundTotals"
4103
+ ListRoundPartyTotalsResponse:
4104
+ type: object
4105
+ required:
4106
+ - entries
4107
+ properties:
4108
+ entries:
4109
+ type: array
4110
+ items:
4111
+ $ref: "#/components/schemas/RoundPartyTotals"
4112
+ RoundPartyTotals:
4113
+ type: object
4114
+ required:
4115
+ - closed_round
4116
+ - party
4117
+ - app_rewards
4118
+ - validator_rewards
4119
+ - traffic_purchased
4120
+ - traffic_purchased_cc_spent
4121
+ - traffic_num_purchases
4122
+ - cumulative_app_rewards
4123
+ - cumulative_validator_rewards
4124
+ - cumulative_change_to_initial_amount_as_of_round_zero
4125
+ - cumulative_change_to_holding_fees_rate
4126
+ - cumulative_traffic_purchased
4127
+ - cumulative_traffic_purchased_cc_spent
4128
+ - cumulative_traffic_num_purchases
4129
+ properties:
4130
+ closed_round:
4131
+ type: integer
4132
+ format: int64
4133
+ party:
4134
+ type: string
4135
+ app_rewards:
4136
+ type: string
4137
+ validator_rewards:
4138
+ type: string
4139
+ traffic_purchased:
4140
+ type: integer
4141
+ format: int64
4142
+ traffic_purchased_cc_spent:
4143
+ type: string
4144
+ traffic_num_purchases:
4145
+ type: integer
4146
+ format: int64
4147
+ cumulative_app_rewards:
4148
+ type: string
4149
+ cumulative_validator_rewards:
4150
+ type: string
4151
+ cumulative_change_to_initial_amount_as_of_round_zero:
4152
+ type: string
4153
+ cumulative_change_to_holding_fees_rate:
4154
+ type: string
4155
+ cumulative_traffic_purchased:
4156
+ type: integer
4157
+ format: int64
4158
+ cumulative_traffic_purchased_cc_spent:
4159
+ type: string
4160
+ cumulative_traffic_num_purchases:
4161
+ type: integer
4162
+ format: int64
4163
+ RoundTotals:
4164
+ type: object
4165
+ required:
4166
+ - closed_round
4167
+ - closed_round_effective_at
4168
+ - app_rewards
4169
+ - validator_rewards
4170
+ - change_to_initial_amount_as_of_round_zero
4171
+ - change_to_holding_fees_rate
4172
+ - cumulative_app_rewards
4173
+ - cumulative_validator_rewards
4174
+ - cumulative_change_to_initial_amount_as_of_round_zero
4175
+ - cumulative_change_to_holding_fees_rate
4176
+ - total_amulet_balance
4177
+ properties:
4178
+ closed_round:
4179
+ type: integer
4180
+ format: int64
4181
+ closed_round_effective_at:
4182
+ type: string
4183
+ format: date-time
4184
+ app_rewards:
4185
+ type: string
4186
+ validator_rewards:
4187
+ type: string
4188
+ change_to_initial_amount_as_of_round_zero:
4189
+ type: string
4190
+ change_to_holding_fees_rate:
4191
+ type: string
4192
+ cumulative_app_rewards:
4193
+ type: string
4194
+ cumulative_validator_rewards:
4195
+ type: string
4196
+ cumulative_change_to_initial_amount_as_of_round_zero:
4197
+ type: string
4198
+ cumulative_change_to_holding_fees_rate:
4199
+ type: string
4200
+ total_amulet_balance:
4201
+ type: string
4202
+ MigrationSchedule:
4203
+ type: object
4204
+ required:
4205
+ - time
4206
+ - migration_id
4207
+ properties:
4208
+ time:
4209
+ type: string
4210
+ format: date-time
4211
+ migration_id:
4212
+ type: integer
4213
+ format: int64
4214
+ SynchronizerIdentities:
4215
+ type: object
4216
+ required:
4217
+ - sequencer_id
4218
+ - sequencer_identity_transactions
4219
+ - mediator_id
4220
+ - mediator_identity_transactions
4221
+ properties:
4222
+ sequencer_id:
4223
+ type: string
4224
+ sequencer_identity_transactions:
4225
+ type: array
4226
+ items:
4227
+ type: string
4228
+ mediator_id:
4229
+ type: string
4230
+ mediator_identity_transactions:
4231
+ type: array
4232
+ items:
4233
+ type: string
4234
+ SynchronizerBootstrappingTransactions:
4235
+ type: object
4236
+ required:
4237
+ - domain_parameters
4238
+ - sequencer_domain_state
4239
+ - mediator_domain_state
4240
+ properties:
4241
+ domain_parameters:
4242
+ type: string
4243
+ sequencer_domain_state:
4244
+ type: string
4245
+ mediator_domain_state:
4246
+ type: string
4247
+ GetMigrationInfoRequest:
4248
+ type: object
4249
+ required:
4250
+ - migration_id
4251
+ properties:
4252
+ migration_id:
4253
+ type: integer
4254
+ format: int64
4255
+ GetMigrationInfoResponse:
4256
+ type: object
4257
+ required:
4258
+ - record_time_range
4259
+ - complete
4260
+ properties:
4261
+ previous_migration_id:
4262
+ description: |
4263
+ The migration id that was active before the given migration id, if any.
4264
+ type: integer
4265
+ format: int64
4266
+ record_time_range:
4267
+ description: |
4268
+ All domains for which there are updates in the given migration id,
4269
+ along with the record time of the newest and oldest update associated with each domain
4270
+ type: array
4271
+ items:
4272
+ $ref: "#/components/schemas/RecordTimeRange"
4273
+ last_import_update_id:
4274
+ description: |
4275
+ The update id of the last import update (where import updates are sorted by update id, ascending)
4276
+ for the given migration id, if any
4277
+ type: string
4278
+ complete:
4279
+ description: |
4280
+ True if this scan has all non-import updates for given migration id
4281
+ type: boolean
4282
+ import_updates_complete:
4283
+ description: |
4284
+ True if this scan has all import updates for the given migration id
4285
+ type: boolean
4286
+ RecordTimeRange:
4287
+ type: object
4288
+ required:
4289
+ - synchronizer_id
4290
+ - min
4291
+ - max
4292
+ properties:
4293
+ synchronizer_id:
4294
+ type: string
4295
+ min:
4296
+ type: string
4297
+ format: date-time
4298
+ max:
4299
+ type: string
4300
+ format: date-time
4301
+ GetUpdatesBeforeRequest:
4302
+ type: object
4303
+ required:
4304
+ - migration_id
4305
+ - synchronizer_id
4306
+ - before
4307
+ - count
4308
+ properties:
4309
+ migration_id:
4310
+ type: integer
4311
+ format: int64
4312
+ synchronizer_id:
4313
+ type: string
4314
+ before:
4315
+ description: |
4316
+ Only return updates with a record time strictly smaller than this time.
4317
+ type: string
4318
+ format: date-time
4319
+ at_or_after:
4320
+ description: |
4321
+ Only return updates with a record time equal to or greater than this time.
4322
+ type: string
4323
+ format: date-time
4324
+ count:
4325
+ description: |
4326
+ Return at most this many updates. The actual number of updates returned may be smaller.
4327
+ type: integer
4328
+ format: int32
4329
+ GetUpdatesBeforeResponse:
4330
+ type: object
4331
+ required:
4332
+ - transactions
4333
+ properties:
4334
+ transactions:
4335
+ type: array
4336
+ items:
4337
+ $ref: "#/components/schemas/UpdateHistoryItem"
4338
+ GetImportUpdatesRequest:
4339
+ type: object
4340
+ required:
4341
+ - migration_id
4342
+ - after_update_id
4343
+ - limit
4344
+ properties:
4345
+ migration_id:
4346
+ type: integer
4347
+ format: int64
4348
+ after_update_id:
4349
+ description: |
4350
+ Only return updates with an update id strictly greater than this.
4351
+ type: string
4352
+ limit:
4353
+ description: |
4354
+ Return at most this many updates. The actual number of updates returned may be smaller.
4355
+ type: integer
4356
+ format: int32
4357
+ GetImportUpdatesResponse:
4358
+ type: object
4359
+ required:
4360
+ - transactions
4361
+ properties:
4362
+ transactions:
4363
+ type: array
4364
+ items:
4365
+ $ref: "#/components/schemas/UpdateHistoryItem"
4366
+ DamlValueEncoding:
4367
+ type: string
4368
+ description: |
4369
+ How daml values should be encoded in the response.
4370
+ "compact_json" is a compact, human-readable JSON encoding. It is the same encoding
4371
+ as the one used in the HTTP JSON API or the JavaScript codegen.
4372
+ "protobuf_json" is a verbose JSON encoding that is more difficult to parse,
4373
+ but contains type information, i.e., the values can be parsed losslessly
4374
+ without having access to the Daml source code.
4375
+ Optional and defaults to "compact_json".
4376
+ enum:
4377
+ - compact_json
4378
+ - protobuf_json
4379
+ GetMemberTrafficStatusResponse:
4380
+ type: object
4381
+ required:
4382
+ - traffic_status
4383
+ properties:
4384
+ traffic_status:
4385
+ description: |
4386
+ The current traffic state for the member on the synchronizer under
4387
+ `actual`, and the total purchased traffic under `target`. The purchased
4388
+ traffic may exceed the `actual` limit as purchases take time to be
4389
+ incorporated into the limit.
4390
+ $ref: "#/components/schemas/MemberTrafficStatus"
4391
+ MemberTrafficStatus:
4392
+ type: object
4393
+ required:
4394
+ - actual
4395
+ - target
4396
+ properties:
4397
+ actual:
4398
+ description: The current traffic state for the member on the synchronizer
4399
+ $ref: "#/components/schemas/ActualMemberTrafficState"
4400
+ target:
4401
+ description: Total purchased traffic; may exceed limit in `actual`
4402
+ $ref: "#/components/schemas/TargetMemberTrafficState"
4403
+ ActualMemberTrafficState:
4404
+ type: object
4405
+ required:
4406
+ - total_consumed
4407
+ - total_limit
4408
+ properties:
4409
+ total_consumed:
4410
+ description: |
4411
+ Total extra traffic consumed by the member on the given synchronizer
4412
+ type: integer
4413
+ format: int64
4414
+ total_limit:
4415
+ description: |
4416
+ Current extra traffic limit set for the member on the given synchronizer.
4417
+ An extra traffic top-up is complete once total_limit matches total_purchased.
4418
+ type: integer
4419
+ format: int64
4420
+ TargetMemberTrafficState:
4421
+ type: object
4422
+ required:
4423
+ - total_purchased
4424
+ properties:
4425
+ total_purchased:
4426
+ description: |
4427
+ Total extra traffic purchased for the member on the given
4428
+ synchronizer in bytes.
4429
+ type: integer
4430
+ format: int64
4431
+ GetPartyToParticipantResponse:
4432
+ type: object
4433
+ required:
4434
+ - participant_id
4435
+ properties:
4436
+ participant_id:
4437
+ description: |
4438
+ ID of the participant hosting the provided party, in the form
4439
+ `PAR::id::fingerprint`
4440
+ type: string
4441
+ GetValidatorFaucetsByValidatorResponse:
4442
+ type: object
4443
+ required:
4444
+ - validatorsReceivedFaucets
4445
+ properties:
4446
+ validatorsReceivedFaucets:
4447
+ description: |
4448
+ Statistics for any party ID arguments found to have valid onboarding
4449
+ licenses; the order in the response is unrelated to argument order.
4450
+ type: array
4451
+ items:
4452
+ $ref: "#/components/schemas/ValidatorReceivedFaucets"
4453
+ ValidatorReceivedFaucets:
4454
+ type: object
4455
+ required:
4456
+ - validator
4457
+ - numRoundsCollected
4458
+ - numRoundsMissed
4459
+ - firstCollectedInRound
4460
+ - lastCollectedInRound
4461
+ properties:
4462
+ validator:
4463
+ description: The party ID of the onboarded validator
4464
+ type: string
4465
+ numRoundsCollected:
4466
+ description: |
4467
+ how many rounds the validator has received a faucet for; guaranteed
4468
+ that collected + missed = last - first + 1
4469
+ type: integer
4470
+ format: int64
4471
+ numRoundsMissed:
4472
+ description: |
4473
+ how many rounds between firstCollected and lastCollected in which
4474
+ the validator failed to collect (i.e. was not active or available);
4475
+ can at most be max(0, lastCollected - firstCollected - 1).
4476
+ type: integer
4477
+ format: int64
4478
+ firstCollectedInRound:
4479
+ description: |
4480
+ the round number when this validator started collecting faucets;
4481
+ the validator definitely recorded liveness in this round
4482
+ type: integer
4483
+ format: int64
4484
+ lastCollectedInRound:
4485
+ description: |
4486
+ The most recent round number in which the validator collected a faucet;
4487
+ the validator definitely recorded liveness in this round. Will equal
4488
+ `firstCollected` if the validator has collected in only one round
4489
+ type: integer
4490
+ format: int64
4491
+ GetBackfillingStatusResponse:
4492
+ type: object
4493
+ required:
4494
+ - complete
4495
+ properties:
4496
+ complete:
4497
+ description: |
4498
+ True if ALL backfilling processes are complete, false otherwise.
4499
+
4500
+ Some scan endpoints return error responses if backfilling is not complete
4501
+ (e.g., `/v1/updates`), others return partial results (e.g., `/v0/transactions`).
4502
+ This endpoint is a simple indicator for whether historical information may be incomplete.
4503
+
4504
+ To determine the progress of individual backfilling processes, inspect the corresponding metrics.
4505
+ type: boolean
4506
+ EventHistoryRequest:
4507
+ type: object
4508
+ required:
4509
+ - page_size
4510
+ properties:
4511
+ after:
4512
+ $ref: "#/components/schemas/UpdateHistoryRequestAfter"
4513
+ description: |
4514
+ The events returned will either have a higher migration id or
4515
+ the same migration id and a record_time greater than the migration id and record time
4516
+ specified.
4517
+ page_size:
4518
+ description: |
4519
+ The maximum number of events returned for this request.
4520
+ type: integer
4521
+ format: int32
4522
+ minimum: 1
4523
+ maximum: 1000
4524
+ daml_value_encoding:
4525
+ $ref: "#/components/schemas/DamlValueEncoding"
4526
+ EventHistoryResponse:
4527
+ type: object
4528
+ required:
4529
+ - events
4530
+ properties:
4531
+ events:
4532
+ type: array
4533
+ items:
4534
+ $ref: "#/components/schemas/EventHistoryItem"
4535
+ EventHistoryItem:
4536
+ type: object
4537
+ description: |
4538
+ An event history item may contain a transaction update, a verdict from a mediator, both, or a contract reassignment.
4539
+ If an event pertains to a contract reassignment, there will be no verdict data.
4540
+ If an event pertains to a wholly private transaction, there will only be verdict data.
4541
+ If an event pertains to a transaction that is partially private, it may also bear verdict information for the private portions.
4542
+ When both fields are present, the transaction and verdict have the same `update_id` and `record_time`.
4543
+ properties:
4544
+ update:
4545
+ $ref: "#/components/schemas/UpdateHistoryItemV2"
4546
+ nullable: true
4547
+ verdict:
4548
+ $ref: "#/components/schemas/EventHistoryVerdict"
4549
+ nullable: true
4550
+ EventHistoryVerdict:
4551
+ type: object
4552
+ required:
4553
+ - update_id
4554
+ - migration_id
4555
+ - domain_id
4556
+ - record_time
4557
+ - finalization_time
4558
+ - submitting_parties
4559
+ - submitting_participant_uid
4560
+ - verdict_result
4561
+ - mediator_group
4562
+ - transaction_views
4563
+ properties:
4564
+ update_id:
4565
+ description: |
4566
+ The ID of the transaction update associated with this verdict.
4567
+ type: string
4568
+ migration_id:
4569
+ description: |
4570
+ The migration id of the domain through which this event was sequenced.
4571
+ type: integer
4572
+ format: int64
4573
+ domain_id:
4574
+ description: |
4575
+ The id of the domain through which this event was sequenced.
4576
+ type: string
4577
+ record_time:
4578
+ description: |
4579
+ The record_time of the transaction the verdict corresponds to.
4580
+ type: string
4581
+ finalization_time:
4582
+ description: |
4583
+ The finalization_time of the transaction the verdict corresponds to.
4584
+ Note that this time might be different between different scans/mediators.
4585
+ type: string
4586
+ submitting_parties:
4587
+ description: |
4588
+ Parties on whose behalf the transaction was submitted.
4589
+ type: array
4590
+ items:
4591
+ type: string
4592
+ submitting_participant_uid:
4593
+ description: |
4594
+ UID of the submitting participant.
4595
+ type: string
4596
+ verdict_result:
4597
+ description: |
4598
+ Result of the verdict.
4599
+ $ref: "#/components/schemas/VerdictResult"
4600
+ mediator_group:
4601
+ description: |
4602
+ The mediator group which finalized this verdict.
4603
+ type: integer
4604
+ format: int32
4605
+ transaction_views:
4606
+ $ref: "#/components/schemas/TransactionViews"
4607
+ TransactionViews:
4608
+ type: object
4609
+ required:
4610
+ - views
4611
+ - root_views
4612
+ properties:
4613
+ views:
4614
+ type: array
4615
+ items:
4616
+ $ref: "#/components/schemas/TransactionView"
4617
+ root_views:
4618
+ type: array
4619
+ items:
4620
+ type: integer
4621
+ format: int32
4622
+ TransactionView:
4623
+ type: object
4624
+ required:
4625
+ - view_id
4626
+ - informees
4627
+ - confirming_parties
4628
+ - sub_views
4629
+ - view_hash
4630
+ properties:
4631
+ view_id:
4632
+ type: integer
4633
+ format: int32
4634
+ informees:
4635
+ type: array
4636
+ items:
4637
+ type: string
4638
+ confirming_parties:
4639
+ type: array
4640
+ items:
4641
+ $ref: "#/components/schemas/Quorum"
4642
+ sub_views:
4643
+ type: array
4644
+ items:
4645
+ type: integer
4646
+ format: int32
4647
+ view_hash:
4648
+ description: Hash of the view, for correlation with sequencer traffic data. Empty for older data ingested before this field was added.
4649
+ type: string
4650
+ Quorum:
4651
+ type: object
4652
+ required:
4653
+ - parties
4654
+ - threshold
4655
+ properties:
4656
+ parties:
4657
+ type: array
4658
+ items:
4659
+ type: string
4660
+ threshold:
4661
+ type: integer
4662
+ format: int32
4663
+ VerdictResult:
4664
+ type: string
4665
+ enum:
4666
+ - VERDICT_RESULT_UNSPECIFIED
4667
+ - VERDICT_RESULT_ACCEPTED
4668
+ - VERDICT_RESULT_REJECTED
4669
+ ListUnclaimedDevelopmentFundCouponsResponse:
4670
+ type: object
4671
+ required:
4672
+ - unclaimed-development-fund-coupons
4673
+ properties:
4674
+ unclaimed-development-fund-coupons:
4675
+ description: |
4676
+ Contracts of the Daml template `Splice.Amulet:UnclaimedDevelopmentFundCoupon`.
4677
+ type: array
4678
+ items:
4679
+ type: object
4680
+ properties:
4681
+ contract:
4682
+ type: object
4683
+ properties:
4684
+ template_id:
4685
+ type: string
4686
+ contract_id:
4687
+ type: string
4688
+ payload:
4689
+ type: object
4690
+ created_event_blob:
4691
+ type: string
4692
+ created_at:
4693
+ type: string
4694
+ required:
4695
+ - template_id
4696
+ - contract_id
4697
+ - payload
4698
+ - created_event_blob
4699
+ - created_at
4700
+ domain_id:
4701
+ type: string
4702
+ required:
4703
+ - contract
4704
+ Status:
4705
+ type: object
4706
+ required:
4707
+ - id
4708
+ - uptime
4709
+ - ports
4710
+ - active
4711
+ properties:
4712
+ id:
4713
+ type: string
4714
+ uptime:
4715
+ type: string
4716
+ ports:
4717
+ type: object
4718
+ additionalProperties:
4719
+ type: integer
4720
+ format: int32
4721
+ extra:
4722
+ type: string
4723
+ format: binary
4724
+ active:
4725
+ type: boolean
4726
+ SuccessStatusResponse:
4727
+ type: object
4728
+ required:
4729
+ - success
4730
+ properties:
4731
+ success:
4732
+ $ref: "#/components/schemas/Status"
4733
+ NotInitialized:
4734
+ type: object
4735
+ required:
4736
+ - active
4737
+ properties:
4738
+ active:
4739
+ type: boolean
4740
+ NotInitializedStatusResponse:
4741
+ type: object
4742
+ required:
4743
+ - not_initialized
4744
+ properties:
4745
+ not_initialized:
4746
+ $ref: "#/components/schemas/NotInitialized"
4747
+ ErrorResponse:
4748
+ type: object
4749
+ required:
4750
+ - error
4751
+ properties:
4752
+ error:
4753
+ type: string
4754
+ FailureStatusResponse:
4755
+ type: object
4756
+ required:
4757
+ - failed
4758
+ properties:
4759
+ failed:
4760
+ $ref: "#/components/schemas/ErrorResponse"
4761
+ NodeStatus:
4762
+ oneOf:
4763
+ - $ref: "#/components/schemas/SuccessStatusResponse"
4764
+ - $ref: "#/components/schemas/NotInitializedStatusResponse"
4765
+ - $ref: "#/components/schemas/FailureStatusResponse"
4766
+ Version:
4767
+ type: object
4768
+ required:
4769
+ - version
4770
+ - commit_ts
4771
+ properties:
4772
+ version:
4773
+ type: string
4774
+ commit_ts:
4775
+ type: string
4776
+ format: date-time
4777
+ ContractWithState:
4778
+ type: object
4779
+ properties:
4780
+ contract:
4781
+ type: object
4782
+ properties:
4783
+ template_id:
4784
+ type: string
4785
+ contract_id:
4786
+ type: string
4787
+ payload:
4788
+ type: object
4789
+ created_event_blob:
4790
+ type: string
4791
+ created_at:
4792
+ type: string
4793
+ required:
4794
+ - template_id
4795
+ - contract_id
4796
+ - payload
4797
+ - created_event_blob
4798
+ - created_at
4799
+ domain_id:
4800
+ type: string
4801
+ required:
4802
+ - contract
4803
+ MaybeCachedContractWithState:
4804
+ type: object
4805
+ properties:
4806
+ contract:
4807
+ type: object
4808
+ properties:
4809
+ template_id:
4810
+ type: string
4811
+ contract_id:
4812
+ type: string
4813
+ payload:
4814
+ type: object
4815
+ created_event_blob:
4816
+ type: string
4817
+ created_at:
4818
+ type: string
4819
+ required:
4820
+ - template_id
4821
+ - contract_id
4822
+ - payload
4823
+ - created_event_blob
4824
+ - created_at
4825
+ domain_id:
4826
+ type: string