@canton-network/core-splice-client 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated-clients/scan-proxy.d.ts +345 -0
- package/dist/generated-clients/scan-proxy.d.ts.map +1 -0
- package/dist/generated-clients/scan-proxy.js +3 -0
- package/dist/generated-clients/scan.d.ts +3033 -0
- package/dist/generated-clients/scan.d.ts.map +1 -0
- package/dist/generated-clients/scan.js +3 -0
- package/dist/generated-clients/validator-internal.d.ts +903 -0
- package/dist/generated-clients/validator-internal.d.ts.map +1 -0
- package/dist/generated-clients/validator-internal.js +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -0
- package/dist/scan-client.d.ts +60 -0
- package/dist/scan-client.d.ts.map +1 -0
- package/dist/scan-client.js +67 -0
- package/dist/validator-internal-client.d.ts +59 -0
- package/dist/validator-internal-client.d.ts.map +1 -0
- package/dist/validator-internal-client.js +47 -0
- package/package.json +31 -0
|
@@ -0,0 +1,3033 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
'/readyz': {
|
|
7
|
+
get: operations['isReady'];
|
|
8
|
+
};
|
|
9
|
+
'/livez': {
|
|
10
|
+
get: operations['isLive'];
|
|
11
|
+
};
|
|
12
|
+
'/status': {
|
|
13
|
+
get: operations['getHealthStatus'];
|
|
14
|
+
};
|
|
15
|
+
'/version': {
|
|
16
|
+
get: operations['getVersion'];
|
|
17
|
+
};
|
|
18
|
+
'/v0/dso': {
|
|
19
|
+
get: operations['getDsoInfo'];
|
|
20
|
+
};
|
|
21
|
+
'/v0/validators/validator-faucets': {
|
|
22
|
+
/**
|
|
23
|
+
* @description For every argument that is a valid onboarded validator, return
|
|
24
|
+
* statistics on its liveness activity, according to on-ledger state at the
|
|
25
|
+
* time of the request.
|
|
26
|
+
*/
|
|
27
|
+
get: operations['getValidatorFaucetsByValidator'];
|
|
28
|
+
};
|
|
29
|
+
'/v0/scans': {
|
|
30
|
+
/**
|
|
31
|
+
* @description Retrieve Canton scan configuration for all SVs, grouped by
|
|
32
|
+
* connected synchronizer ID
|
|
33
|
+
*/
|
|
34
|
+
get: operations['listDsoScans'];
|
|
35
|
+
};
|
|
36
|
+
'/v0/admin/validator/licenses': {
|
|
37
|
+
/**
|
|
38
|
+
* @description List all validators currently approved by members of the DSO, paginated,
|
|
39
|
+
* sorted newest-first.
|
|
40
|
+
*/
|
|
41
|
+
get: operations['listValidatorLicenses'];
|
|
42
|
+
};
|
|
43
|
+
'/v0/dso-sequencers': {
|
|
44
|
+
/**
|
|
45
|
+
* @description Retrieve Canton sequencer configuration for all SVs, grouped by
|
|
46
|
+
* connected synchronizer ID
|
|
47
|
+
*/
|
|
48
|
+
get: operations['listDsoSequencers'];
|
|
49
|
+
};
|
|
50
|
+
'/v0/sv-bft-sequencers': {
|
|
51
|
+
/** @description Retrieve Canton BFT sequencer configuration for this SV, for each configured Synchronizer */
|
|
52
|
+
get: operations['listSvBftSequencers'];
|
|
53
|
+
};
|
|
54
|
+
'/v0/domains/{domain_id}/parties/{party_id}/participant-id': {
|
|
55
|
+
/**
|
|
56
|
+
* @description Get the ID of the participant hosting a given party. This will fail if
|
|
57
|
+
* there are multiple party-to-participant mappings for the given
|
|
58
|
+
* synchronizer and party, which is not currently supported.
|
|
59
|
+
*/
|
|
60
|
+
get: operations['getPartyToParticipant'];
|
|
61
|
+
};
|
|
62
|
+
'/v0/domains/{domain_id}/members/{member_id}/traffic-status': {
|
|
63
|
+
/**
|
|
64
|
+
* @description Get a member's traffic status as reported by the sequencer, according to
|
|
65
|
+
* ledger state at the time of the request.
|
|
66
|
+
*/
|
|
67
|
+
get: operations['getMemberTrafficStatus'];
|
|
68
|
+
};
|
|
69
|
+
'/v0/closed-rounds': {
|
|
70
|
+
/**
|
|
71
|
+
* @description Every closed mining round on the ledger still in post-close process for
|
|
72
|
+
* the connected Splice network, in round number order, earliest-first.
|
|
73
|
+
*/
|
|
74
|
+
get: operations['getClosedRounds'];
|
|
75
|
+
};
|
|
76
|
+
'/v0/open-and-issuing-mining-rounds': {
|
|
77
|
+
/**
|
|
78
|
+
* @description All current open and issuing mining rounds, if the request is empty;
|
|
79
|
+
* passing contract IDs in the request can reduce the response data for
|
|
80
|
+
* polling/client-cache-update efficiency.
|
|
81
|
+
*/
|
|
82
|
+
post: operations['getOpenAndIssuingMiningRounds'];
|
|
83
|
+
};
|
|
84
|
+
'/v2/updates': {
|
|
85
|
+
/**
|
|
86
|
+
* @description Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
|
|
87
|
+
* Compared to `/v1/updates`, the `/v2/updates` removes the `offset` field in responses,
|
|
88
|
+
* which was hardcoded to 1 in `/v1/updates` for compatibility, and is now removed.
|
|
89
|
+
* `/v2/updates` sorts events lexicographically in `events_by_id` by `ID` for convenience, which should not be confused with the
|
|
90
|
+
* order of events in the transaction, for this you should rely on the order of `root_event_ids` and `child_event_ids`.
|
|
91
|
+
* Updates are ordered lexicographically by `(migration id, record time)`.
|
|
92
|
+
* For a given migration id, each update has a unique record time.
|
|
93
|
+
* The record time ranges of different migrations may overlap, i.e.,
|
|
94
|
+
* it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
|
|
95
|
+
* and there may be two updates with the same record time but different migration ids.
|
|
96
|
+
*/
|
|
97
|
+
post: operations['getUpdateHistoryV2'];
|
|
98
|
+
};
|
|
99
|
+
'/v2/updates/{update_id}': {
|
|
100
|
+
/**
|
|
101
|
+
* @description Returns the update with the given update_id.
|
|
102
|
+
* Compared to `/v1/updates/{update_id}`, the `/v2/updates/{update_id}` removes the `offset` field in responses,
|
|
103
|
+
* which was hardcoded to 1 in `/v1/updates/{update_id}` for compatibility, and is now removed.
|
|
104
|
+
* `/v2/updates/{update_id}` sorts events lexicographically in `events_by_id` by `ID` for convenience, which should not be confused with the
|
|
105
|
+
* order of events in the transaction, for this you should rely on the order of `root_event_ids` and `child_event_ids`.
|
|
106
|
+
*/
|
|
107
|
+
get: operations['getUpdateByIdV2'];
|
|
108
|
+
};
|
|
109
|
+
'/v1/updates': {
|
|
110
|
+
/**
|
|
111
|
+
* @deprecated
|
|
112
|
+
* @description Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
|
|
113
|
+
* Unlike /v0/updates, this endpoint returns responses that are consistent across different
|
|
114
|
+
* scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates.
|
|
115
|
+
*
|
|
116
|
+
* Updates are ordered lexicographically by `(migration id, record time)`.
|
|
117
|
+
* For a given migration id, each update has a unique record time.
|
|
118
|
+
* The record time ranges of different migrations may overlap, i.e.,
|
|
119
|
+
* it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
|
|
120
|
+
* and there may be two updates with the same record time but different migration ids.
|
|
121
|
+
* The order of items in events_by_id is not defined.
|
|
122
|
+
*/
|
|
123
|
+
post: operations['getUpdateHistoryV1'];
|
|
124
|
+
};
|
|
125
|
+
'/v1/updates/{update_id}': {
|
|
126
|
+
/**
|
|
127
|
+
* @deprecated
|
|
128
|
+
* @description Returns the update with the given update_id.
|
|
129
|
+
* Unlike /v0/updates/{update_id}, this endpoint returns responses that are consistent across different
|
|
130
|
+
* scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates.
|
|
131
|
+
* The order of items in events_by_id is not defined.
|
|
132
|
+
*/
|
|
133
|
+
get: operations['getUpdateByIdV1'];
|
|
134
|
+
};
|
|
135
|
+
'/v0/state/acs/snapshot-timestamp': {
|
|
136
|
+
/**
|
|
137
|
+
* @description Returns the timestamp of the most recent snapshot before the given date, for the given migration_id.
|
|
138
|
+
* This corresponds to the record time of the last transaction in the snapshot.
|
|
139
|
+
*/
|
|
140
|
+
get: operations['getDateOfMostRecentSnapshotBefore'];
|
|
141
|
+
};
|
|
142
|
+
'/v0/state/acs': {
|
|
143
|
+
/** @description Returns the ACS in creation date ascending order, paged, for a given migration id and record time. */
|
|
144
|
+
post: operations['getAcsSnapshotAt'];
|
|
145
|
+
};
|
|
146
|
+
'/v0/state/acs/force': {
|
|
147
|
+
/**
|
|
148
|
+
* @description Takes a snapshot of the ACS at the current time.
|
|
149
|
+
* The responses can be used as parameters to `/v0/state/acs` to retrieve the snapshot.
|
|
150
|
+
* Disabled in production environments due to its persistent alteration of
|
|
151
|
+
* the behavior of future invocations of `/v0/state/acs`, as it causes an
|
|
152
|
+
* immediate internal snapshot and delay in the next automatic snapshot.
|
|
153
|
+
*/
|
|
154
|
+
post: operations['forceAcsSnapshotNow'];
|
|
155
|
+
};
|
|
156
|
+
'/v0/holdings/state': {
|
|
157
|
+
/** @description Returns the active amulet contracts for a given migration id and record time, in creation date ascending order, paged. */
|
|
158
|
+
post: operations['getHoldingsStateAt'];
|
|
159
|
+
};
|
|
160
|
+
'/v0/holdings/summary': {
|
|
161
|
+
/**
|
|
162
|
+
* @description Returns the summary of active amulet contracts for a given migration id and record time, for the given parties.
|
|
163
|
+
* This is an aggregate of `/v0/holdings/state` by owner party ID with better performance than client-side computation.
|
|
164
|
+
*/
|
|
165
|
+
post: operations['getHoldingsSummaryAt'];
|
|
166
|
+
};
|
|
167
|
+
'/v0/ans-entries': {
|
|
168
|
+
/**
|
|
169
|
+
* @description Lists all non-expired ANS entries whose names are prefixed with the
|
|
170
|
+
* `name_prefix`, up to `page_size` entries.
|
|
171
|
+
*/
|
|
172
|
+
get: operations['listAnsEntries'];
|
|
173
|
+
};
|
|
174
|
+
'/v0/ans-entries/by-party/{party}': {
|
|
175
|
+
/**
|
|
176
|
+
* @description If present, the first ANS entry for user `party` according to
|
|
177
|
+
* `name` lexicographic order.
|
|
178
|
+
*/
|
|
179
|
+
get: operations['lookupAnsEntryByParty'];
|
|
180
|
+
};
|
|
181
|
+
'/v0/ans-entries/by-name/{name}': {
|
|
182
|
+
/** @description If present, the ANS entry named exactly `name`. */
|
|
183
|
+
get: operations['lookupAnsEntryByName'];
|
|
184
|
+
};
|
|
185
|
+
'/v0/dso-party-id': {
|
|
186
|
+
/** @description The party ID of the DSO for the Splice network connected by this Scan app. */
|
|
187
|
+
get: operations['getDsoPartyId'];
|
|
188
|
+
};
|
|
189
|
+
'/v0/amulet-rules': {
|
|
190
|
+
post: operations['getAmuletRules'];
|
|
191
|
+
};
|
|
192
|
+
'/v0/external-party-amulet-rules': {
|
|
193
|
+
post: operations['getExternalPartyAmuletRules'];
|
|
194
|
+
};
|
|
195
|
+
'/v0/ans-rules': {
|
|
196
|
+
post: operations['getAnsRules'];
|
|
197
|
+
};
|
|
198
|
+
'/v0/featured-apps': {
|
|
199
|
+
/** @description List every `FeaturedAppRight` registered with the DSO on the ledger. */
|
|
200
|
+
get: operations['listFeaturedAppRights'];
|
|
201
|
+
};
|
|
202
|
+
'/v0/featured-apps/{provider_party_id}': {
|
|
203
|
+
/**
|
|
204
|
+
* @description If `provider_party_id` has a `FeaturedAppRight` registered with the DSO,
|
|
205
|
+
* return it; `featured_app_right` will be empty otherwise.
|
|
206
|
+
*/
|
|
207
|
+
get: operations['lookupFeaturedAppRight'];
|
|
208
|
+
};
|
|
209
|
+
'/v0/top-validators-by-validator-faucets': {
|
|
210
|
+
/**
|
|
211
|
+
* @description Get a list of top validators by number of rounds in which they collected
|
|
212
|
+
* faucets, and basis statistics on their round collection history
|
|
213
|
+
*/
|
|
214
|
+
get: operations['getTopValidatorsByValidatorFaucets'];
|
|
215
|
+
};
|
|
216
|
+
'/v0/transfer-preapprovals/by-party/{party}': {
|
|
217
|
+
/** @description Lookup a TransferPreapproval by the receiver party. */
|
|
218
|
+
get: operations['lookupTransferPreapprovalByParty'];
|
|
219
|
+
};
|
|
220
|
+
'/v0/transfer-command-counter/{party}': {
|
|
221
|
+
/** @description Lookup a TransferCommandCounter by the receiver party. */
|
|
222
|
+
get: operations['lookupTransferCommandCounterByParty'];
|
|
223
|
+
};
|
|
224
|
+
'/v0/transfer-command/status': {
|
|
225
|
+
/** @description Retrieve the status of all transfer commands (up to a limit of 100) of the given sender for the specified nonce. */
|
|
226
|
+
get: operations['lookupTransferCommandStatus'];
|
|
227
|
+
};
|
|
228
|
+
'/v0/migrations/schedule': {
|
|
229
|
+
/**
|
|
230
|
+
* @description If the DSO has scheduled a synchronizer upgrade, return its planned time
|
|
231
|
+
* and the new migration ID.
|
|
232
|
+
*/
|
|
233
|
+
get: operations['getMigrationSchedule'];
|
|
234
|
+
};
|
|
235
|
+
'/v0/synchronizer-identities/{domain_id_prefix}': {
|
|
236
|
+
get: operations['getSynchronizerIdentities'];
|
|
237
|
+
};
|
|
238
|
+
'/v0/synchronizer-bootstrapping-transactions/{domain_id_prefix}': {
|
|
239
|
+
get: operations['getSynchronizerBootstrappingTransactions'];
|
|
240
|
+
};
|
|
241
|
+
'/v0/splice-instance-names': {
|
|
242
|
+
/** @description Retrieve the UI names of various elements of this Splice network. */
|
|
243
|
+
get: operations['getSpliceInstanceNames'];
|
|
244
|
+
};
|
|
245
|
+
'/v0/amulet-price/votes': {
|
|
246
|
+
/** @description Retrieve a list of the latest amulet price votes */
|
|
247
|
+
get: operations['listAmuletPriceVotes'];
|
|
248
|
+
};
|
|
249
|
+
'/v0/voterequest': {
|
|
250
|
+
/** @description Look up several `VoteRequest`\ s at once by their contract IDs. */
|
|
251
|
+
post: operations['listVoteRequestsByTrackingCid'];
|
|
252
|
+
};
|
|
253
|
+
'/v0/voterequests/{vote_request_contract_id}': {
|
|
254
|
+
/** @description Look up a `VoteRequest` by contract ID. */
|
|
255
|
+
get: operations['lookupDsoRulesVoteRequest'];
|
|
256
|
+
};
|
|
257
|
+
'/v0/admin/sv/voterequests': {
|
|
258
|
+
/** @description List all active `VoteRequest`\ s. */
|
|
259
|
+
get: operations['listDsoRulesVoteRequests'];
|
|
260
|
+
};
|
|
261
|
+
'/v0/admin/sv/voteresults': {
|
|
262
|
+
post: operations['listVoteRequestResults'];
|
|
263
|
+
};
|
|
264
|
+
'/v0/backfilling/migration-info': {
|
|
265
|
+
/** @description List all previous synchronizer migrations in this Splice network's history. */
|
|
266
|
+
post: operations['getMigrationInfo'];
|
|
267
|
+
};
|
|
268
|
+
'/v0/backfilling/updates-before': {
|
|
269
|
+
/**
|
|
270
|
+
* @description Retrieve transactions and synchronizer reassignments prior to the
|
|
271
|
+
* request's specification.
|
|
272
|
+
*/
|
|
273
|
+
post: operations['getUpdatesBefore'];
|
|
274
|
+
};
|
|
275
|
+
'/v0/backfilling/status': {
|
|
276
|
+
/** @description Retrieve the status of the backfilling process. */
|
|
277
|
+
get: operations['getBackfillingStatus'];
|
|
278
|
+
};
|
|
279
|
+
'/v0/acs/{party}': {
|
|
280
|
+
/**
|
|
281
|
+
* @deprecated
|
|
282
|
+
* @description **Deprecated**. Fetch the current SV participant ACS snapshot for the DSO and `party`.
|
|
283
|
+
*/
|
|
284
|
+
get: operations['getAcsSnapshot'];
|
|
285
|
+
};
|
|
286
|
+
'/v0/aggregated-rounds': {
|
|
287
|
+
/**
|
|
288
|
+
* @deprecated
|
|
289
|
+
* @description **Deprecated**. Retrieve the current earliest and latest rounds aggregated for this Scan.
|
|
290
|
+
*/
|
|
291
|
+
get: operations['getAggregatedRounds'];
|
|
292
|
+
};
|
|
293
|
+
'/v0/round-totals': {
|
|
294
|
+
/**
|
|
295
|
+
* @deprecated
|
|
296
|
+
* @description **Deprecated**. List Amulet statistics for up to 200 closed rounds.
|
|
297
|
+
*/
|
|
298
|
+
post: operations['listRoundTotals'];
|
|
299
|
+
};
|
|
300
|
+
'/v0/round-party-totals': {
|
|
301
|
+
/**
|
|
302
|
+
* @deprecated
|
|
303
|
+
* @description **Deprecated**. Retrieve per-party Amulet statistics for up to 50 closed rounds.
|
|
304
|
+
*/
|
|
305
|
+
post: operations['listRoundPartyTotals'];
|
|
306
|
+
};
|
|
307
|
+
'/v0/total-amulet-balance': {
|
|
308
|
+
/**
|
|
309
|
+
* @deprecated
|
|
310
|
+
* @description **Deprecated**. Get the total balance of Amulet in the network
|
|
311
|
+
*/
|
|
312
|
+
get: operations['getTotalAmuletBalance'];
|
|
313
|
+
};
|
|
314
|
+
'/v0/wallet-balance': {
|
|
315
|
+
/**
|
|
316
|
+
* @deprecated
|
|
317
|
+
* @description **Deprecated**, use /v0/holdings/summary with /v0/state/acs/snapshot-timestamp instead. Get the Amulet balance for a specific party at the end of a closed round
|
|
318
|
+
*/
|
|
319
|
+
get: operations['getWalletBalance'];
|
|
320
|
+
};
|
|
321
|
+
'/v0/amulet-config-for-round': {
|
|
322
|
+
/**
|
|
323
|
+
* @deprecated
|
|
324
|
+
* @description **Deprecated**. Retrieve some information from the `AmuletRules` selected for the given round
|
|
325
|
+
*/
|
|
326
|
+
get: operations['getAmuletConfigForRound'];
|
|
327
|
+
};
|
|
328
|
+
'/v0/round-of-latest-data': {
|
|
329
|
+
/**
|
|
330
|
+
* @deprecated
|
|
331
|
+
* @description **Deprecated**. Get the latest round number for which aggregated data is available and
|
|
332
|
+
* the ledger effective time at which the round was closed.
|
|
333
|
+
*/
|
|
334
|
+
get: operations['getRoundOfLatestData'];
|
|
335
|
+
};
|
|
336
|
+
'/v0/rewards-collected': {
|
|
337
|
+
/**
|
|
338
|
+
* @deprecated
|
|
339
|
+
* @description **Deprecated**. Get the total rewards collected ever
|
|
340
|
+
*/
|
|
341
|
+
get: operations['getRewardsCollected'];
|
|
342
|
+
};
|
|
343
|
+
'/v0/top-providers-by-app-rewards': {
|
|
344
|
+
/**
|
|
345
|
+
* @deprecated
|
|
346
|
+
* @description **Deprecated**. Get a list of top-earning app providers, and the total earned app
|
|
347
|
+
* rewards for each
|
|
348
|
+
*/
|
|
349
|
+
get: operations['getTopProvidersByAppRewards'];
|
|
350
|
+
};
|
|
351
|
+
'/v0/top-validators-by-validator-rewards': {
|
|
352
|
+
/**
|
|
353
|
+
* @deprecated
|
|
354
|
+
* @description **Deprecated**. Get a list of top-earning validators, and the total earned validator
|
|
355
|
+
* rewards for each
|
|
356
|
+
*/
|
|
357
|
+
get: operations['getTopValidatorsByValidatorRewards'];
|
|
358
|
+
};
|
|
359
|
+
'/v0/top-validators-by-purchased-traffic': {
|
|
360
|
+
/**
|
|
361
|
+
* @deprecated
|
|
362
|
+
* @description **Deprecated**. Get a list of validators and their domain fees spends, sorted by the
|
|
363
|
+
* amount of extra traffic purchased
|
|
364
|
+
*/
|
|
365
|
+
get: operations['getTopValidatorsByPurchasedTraffic'];
|
|
366
|
+
};
|
|
367
|
+
'/v0/activities': {
|
|
368
|
+
/**
|
|
369
|
+
* @deprecated
|
|
370
|
+
* @description **Deprecated**. Lists activities in descending order, paged, optionally starting after a provided event id.
|
|
371
|
+
*/
|
|
372
|
+
post: operations['listActivity'];
|
|
373
|
+
};
|
|
374
|
+
'/v0/transactions': {
|
|
375
|
+
/**
|
|
376
|
+
* @deprecated
|
|
377
|
+
* @description **Deprecated**. Lists transactions, by default in ascending order, paged, from ledger begin or optionally starting after a provided event id.
|
|
378
|
+
*/
|
|
379
|
+
post: operations['listTransactionHistory'];
|
|
380
|
+
};
|
|
381
|
+
'/v0/updates': {
|
|
382
|
+
/**
|
|
383
|
+
* @deprecated
|
|
384
|
+
* @description **Deprecated**, use /v2/updates instead.
|
|
385
|
+
* Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
|
|
386
|
+
*/
|
|
387
|
+
post: operations['getUpdateHistory'];
|
|
388
|
+
};
|
|
389
|
+
'/v0/updates/{update_id}': {
|
|
390
|
+
/**
|
|
391
|
+
* @deprecated
|
|
392
|
+
* @description **Deprecated**, use /v2/updates/{update_id} instead.
|
|
393
|
+
*/
|
|
394
|
+
get: operations['getUpdateById'];
|
|
395
|
+
};
|
|
396
|
+
'/v0/feature-support': {
|
|
397
|
+
get: operations['featureSupport'];
|
|
398
|
+
};
|
|
399
|
+
'/v0/backfilling/import-updates': {
|
|
400
|
+
post: operations['getImportUpdates'];
|
|
401
|
+
};
|
|
402
|
+
}
|
|
403
|
+
export type webhooks = Record<string, never>;
|
|
404
|
+
export interface components {
|
|
405
|
+
schemas: {
|
|
406
|
+
GetSpliceInstanceNamesResponse: {
|
|
407
|
+
/** @description What to call this Splice network. */
|
|
408
|
+
network_name: string;
|
|
409
|
+
/** @description URL of an HTML favicon for this Splice network. */
|
|
410
|
+
network_favicon_url: string;
|
|
411
|
+
/** @description What this Splice network calls Amulet. */
|
|
412
|
+
amulet_name: string;
|
|
413
|
+
/** @description The three-letter acronym for Amulet. */
|
|
414
|
+
amulet_name_acronym: string;
|
|
415
|
+
/** @description What this Splice network calls the Amulet Name Service. */
|
|
416
|
+
name_service_name: string;
|
|
417
|
+
/** @description The acronym for `name_service_name`. */
|
|
418
|
+
name_service_name_acronym: string;
|
|
419
|
+
};
|
|
420
|
+
GetDsoPartyIdResponse: {
|
|
421
|
+
dso_party_id: string;
|
|
422
|
+
};
|
|
423
|
+
GetClosedRoundsResponse: {
|
|
424
|
+
/**
|
|
425
|
+
* @description Contracts of the Daml template `Splice.Round:ClosedMiningRound`, one
|
|
426
|
+
* for every closed round that is still in process, i.e. it either has
|
|
427
|
+
* unprocessed rewards or a missing `Splice.DsoRules:Confirmation`.
|
|
428
|
+
*/
|
|
429
|
+
rounds: components['schemas']['Contract'][];
|
|
430
|
+
};
|
|
431
|
+
GetOpenAndIssuingMiningRoundsRequest: {
|
|
432
|
+
/**
|
|
433
|
+
* @description The contract IDs for `open_mining_rounds` in the response the caller
|
|
434
|
+
* knows about. If unsure, an empty array is fine; only a performance
|
|
435
|
+
* penalty is incurred.
|
|
436
|
+
*/
|
|
437
|
+
cached_open_mining_round_contract_ids: components['schemas']['ContractId'][];
|
|
438
|
+
/**
|
|
439
|
+
* @description The contract IDs for `issuing_mining_rounds` in the response the
|
|
440
|
+
* caller knows about. If unsure, an empty array is fine; only a
|
|
441
|
+
* performance penalty is incurred.
|
|
442
|
+
*/
|
|
443
|
+
cached_issuing_round_contract_ids: components['schemas']['ContractId'][];
|
|
444
|
+
};
|
|
445
|
+
/**
|
|
446
|
+
* @description Daml contracts of the templates `Splice.Round.OpenMiningRound` and
|
|
447
|
+
* `Splice.Round.IssuingMiningRound` representing rounds for which rewards
|
|
448
|
+
* can be registered or are currently being computed, respectively.
|
|
449
|
+
* Contract IDs in the input serve as input sets for the two
|
|
450
|
+
* `MaybeCachedContractWithStateMap`s as described for that structure for
|
|
451
|
+
* `open_mining_rounds` and `issuing_mining_rounds`.
|
|
452
|
+
*/
|
|
453
|
+
GetOpenAndIssuingMiningRoundsResponse: {
|
|
454
|
+
/**
|
|
455
|
+
* @description Suggested cache TTL for the response; this should expire before the
|
|
456
|
+
* `opensAt` of any open rounds that may not be in this response yet.
|
|
457
|
+
*/
|
|
458
|
+
time_to_live_in_microseconds: number;
|
|
459
|
+
open_mining_rounds: components['schemas']['MaybeCachedContractWithStateMap'];
|
|
460
|
+
issuing_mining_rounds: components['schemas']['MaybeCachedContractWithStateMap'];
|
|
461
|
+
};
|
|
462
|
+
GetAmuletRulesRequest: {
|
|
463
|
+
cached_amulet_rules_contract_id?: components['schemas']['ContractId'];
|
|
464
|
+
cached_amulet_rules_domain_id?: string;
|
|
465
|
+
};
|
|
466
|
+
/**
|
|
467
|
+
* @description Contract of the Daml template `Splice.AmuletRules.AmuletRules`,
|
|
468
|
+
* including the full schedule of `AmuletConfig` changes approved by
|
|
469
|
+
* the DSO. Callers should not assume that `initialValue` is up-to-date,
|
|
470
|
+
* and should instead search `futureValues` for the latest configuration
|
|
471
|
+
* valid as of now. `contract` will be absent if its ID matches the input
|
|
472
|
+
* `cached_amulet_rules_contract_id`.
|
|
473
|
+
*/
|
|
474
|
+
GetAmuletRulesResponse: {
|
|
475
|
+
amulet_rules_update: components['schemas']['MaybeCachedContractWithState'];
|
|
476
|
+
};
|
|
477
|
+
GetExternalPartyAmuletRulesRequest: {
|
|
478
|
+
cached_external_party_amulet_rules_contract_id?: components['schemas']['ContractId'];
|
|
479
|
+
cached_external_party_amulet_rules_domain_id?: string;
|
|
480
|
+
};
|
|
481
|
+
/**
|
|
482
|
+
* @description A contract state update of Daml template
|
|
483
|
+
* `Splice.ExternalPartyAmuletRules.ExternalPartyAmuletRules`
|
|
484
|
+
*/
|
|
485
|
+
GetExternalPartyAmuletRulesResponse: {
|
|
486
|
+
external_party_amulet_rules_update: components['schemas']['MaybeCachedContractWithState'];
|
|
487
|
+
};
|
|
488
|
+
GetAnsRulesRequest: {
|
|
489
|
+
cached_ans_rules_contract_id?: components['schemas']['ContractId'];
|
|
490
|
+
cached_ans_rules_domain_id?: string;
|
|
491
|
+
};
|
|
492
|
+
/** @description A contract state update of Daml template `Splice.Ans.AnsRules`. */
|
|
493
|
+
GetAnsRulesResponse: {
|
|
494
|
+
ans_rules_update: components['schemas']['MaybeCachedContractWithState'];
|
|
495
|
+
};
|
|
496
|
+
/** @description Contracts of Daml template `Splice.Amulet.FeaturedAppRight`. */
|
|
497
|
+
ListFeaturedAppRightsResponse: {
|
|
498
|
+
featured_apps: components['schemas']['Contract'][];
|
|
499
|
+
};
|
|
500
|
+
/** @description If defined, a contract of Daml template `Splice.Amulet.FeaturedAppRight`. */
|
|
501
|
+
LookupFeaturedAppRightResponse: {
|
|
502
|
+
featured_app_right?: components['schemas']['Contract'];
|
|
503
|
+
};
|
|
504
|
+
GetWalletBalanceResponse: {
|
|
505
|
+
wallet_balance: string;
|
|
506
|
+
};
|
|
507
|
+
GetTotalAmuletBalanceResponse: {
|
|
508
|
+
total_balance: string;
|
|
509
|
+
};
|
|
510
|
+
GetAmuletConfigForRoundResponse: {
|
|
511
|
+
amulet_create_fee: string;
|
|
512
|
+
holding_fee: string;
|
|
513
|
+
lock_holder_fee: string;
|
|
514
|
+
transfer_fee: components['schemas']['SteppedRate'];
|
|
515
|
+
};
|
|
516
|
+
SteppedRate: {
|
|
517
|
+
initial: string;
|
|
518
|
+
steps: components['schemas']['RateStep'][];
|
|
519
|
+
};
|
|
520
|
+
RateStep: {
|
|
521
|
+
amount: string;
|
|
522
|
+
rate: string;
|
|
523
|
+
};
|
|
524
|
+
GetRoundOfLatestDataResponse: {
|
|
525
|
+
/** Format: int64 */
|
|
526
|
+
round: number;
|
|
527
|
+
/** Format: date-time */
|
|
528
|
+
effectiveAt: string;
|
|
529
|
+
};
|
|
530
|
+
GetRewardsCollectedResponse: {
|
|
531
|
+
amount: string;
|
|
532
|
+
};
|
|
533
|
+
GetValidatorTrafficBalanceResponse: {
|
|
534
|
+
/** Format: double */
|
|
535
|
+
remainingBalance: number;
|
|
536
|
+
/** Format: double */
|
|
537
|
+
totalPurchased: number;
|
|
538
|
+
};
|
|
539
|
+
CheckAndUpdateValidatorTrafficBalanceResponse: {
|
|
540
|
+
approved: boolean;
|
|
541
|
+
};
|
|
542
|
+
GetTopProvidersByAppRewardsResponse: {
|
|
543
|
+
providersAndRewards: components['schemas']['PartyAndRewards'][];
|
|
544
|
+
};
|
|
545
|
+
GetTopValidatorsByValidatorRewardsResponse: {
|
|
546
|
+
validatorsAndRewards: components['schemas']['PartyAndRewards'][];
|
|
547
|
+
};
|
|
548
|
+
PartyAndRewards: {
|
|
549
|
+
provider: string;
|
|
550
|
+
rewards: string;
|
|
551
|
+
};
|
|
552
|
+
GetTopValidatorsByValidatorFaucetsResponse: {
|
|
553
|
+
/**
|
|
554
|
+
* @description Up to `limit` validators, sorted greatest number of rounds
|
|
555
|
+
* collected first
|
|
556
|
+
*/
|
|
557
|
+
validatorsByReceivedFaucets: external['scan.yaml']['components']['schemas']['ValidatorReceivedFaucets'][];
|
|
558
|
+
};
|
|
559
|
+
GetTopValidatorsByPurchasedTrafficResponse: {
|
|
560
|
+
validatorsByPurchasedTraffic: components['schemas']['ValidatorPurchasedTraffic'][];
|
|
561
|
+
};
|
|
562
|
+
ValidatorPurchasedTraffic: {
|
|
563
|
+
validator: string;
|
|
564
|
+
/** Format: int64 */
|
|
565
|
+
numPurchases: number;
|
|
566
|
+
/** Format: int64 */
|
|
567
|
+
totalTrafficPurchased: number;
|
|
568
|
+
totalCcSpent: string;
|
|
569
|
+
/** Format: int64 */
|
|
570
|
+
lastPurchasedInRound: number;
|
|
571
|
+
};
|
|
572
|
+
ListSvBftSequencersResponse: {
|
|
573
|
+
bftSequencers: components['schemas']['SynchronizerBftSequencer'][];
|
|
574
|
+
};
|
|
575
|
+
SynchronizerBftSequencer: {
|
|
576
|
+
/**
|
|
577
|
+
* Format: int64
|
|
578
|
+
* @description The synchronizer migration id corresponding to this sequencer.
|
|
579
|
+
*/
|
|
580
|
+
migrationId: number;
|
|
581
|
+
/** @description The id of the sequencer. */
|
|
582
|
+
id: string;
|
|
583
|
+
/** @description The public accessible P2P url of the sequencer, use for inter sequencer communication. */
|
|
584
|
+
p2pUrl: string;
|
|
585
|
+
};
|
|
586
|
+
ListDsoSequencersResponse: {
|
|
587
|
+
domainSequencers: components['schemas']['DomainSequencers'][];
|
|
588
|
+
};
|
|
589
|
+
DomainSequencers: {
|
|
590
|
+
/** @description the synchronizer ID for the associated sequencers */
|
|
591
|
+
domainId: string;
|
|
592
|
+
/** @description the sequencers associated with the synchronizer */
|
|
593
|
+
sequencers: components['schemas']['DsoSequencer'][];
|
|
594
|
+
};
|
|
595
|
+
DsoSequencer: {
|
|
596
|
+
/**
|
|
597
|
+
* Format: int64
|
|
598
|
+
* @description The synchronizer migration id corresponding to this sequencer.
|
|
599
|
+
*/
|
|
600
|
+
migrationId: number;
|
|
601
|
+
/** @description The id of the sequencer. */
|
|
602
|
+
id: string;
|
|
603
|
+
/** @description The public accessible url of the sequencer. */
|
|
604
|
+
url: string;
|
|
605
|
+
/** @description The sequencer's operating SV name. */
|
|
606
|
+
svName: string;
|
|
607
|
+
/**
|
|
608
|
+
* Format: date-time
|
|
609
|
+
* @description Any participant should subscribe to this sequencer after this time.
|
|
610
|
+
*/
|
|
611
|
+
availableAfter: string;
|
|
612
|
+
};
|
|
613
|
+
ListDsoScansResponse: {
|
|
614
|
+
scans: components['schemas']['DomainScans'][];
|
|
615
|
+
};
|
|
616
|
+
DomainScans: {
|
|
617
|
+
domainId: string;
|
|
618
|
+
/**
|
|
619
|
+
* @description SV scans for the associated synchronizer ID; there is at most one
|
|
620
|
+
* scan per SV for each synchronizer ID.
|
|
621
|
+
*/
|
|
622
|
+
scans: components['schemas']['ScanInfo'][];
|
|
623
|
+
};
|
|
624
|
+
ScanInfo: {
|
|
625
|
+
/** @description The public accessible url of the scan. */
|
|
626
|
+
publicUrl: string;
|
|
627
|
+
/** @description The sequencer's operating SV name. */
|
|
628
|
+
svName: string;
|
|
629
|
+
};
|
|
630
|
+
TransactionHistoryRequest: {
|
|
631
|
+
/**
|
|
632
|
+
* @description Note that all transactions carry some monotonically-increasing event_id.
|
|
633
|
+
* 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.
|
|
634
|
+
* 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.
|
|
635
|
+
* 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.
|
|
636
|
+
*/
|
|
637
|
+
page_end_event_id?: string;
|
|
638
|
+
/**
|
|
639
|
+
* @description Sort order for the transactions. For ascending order, from beginning to the end of the ledger, use "asc".
|
|
640
|
+
* For descending order, from end to beginning of the ledger, use "desc".
|
|
641
|
+
* "asc" is used if the sort_order is omitted.
|
|
642
|
+
*
|
|
643
|
+
* @enum {string}
|
|
644
|
+
*/
|
|
645
|
+
sort_order?: 'asc' | 'desc';
|
|
646
|
+
/**
|
|
647
|
+
* Format: int64
|
|
648
|
+
* @description The maximum number of transactions returned for this request.
|
|
649
|
+
*/
|
|
650
|
+
page_size: number;
|
|
651
|
+
};
|
|
652
|
+
TransactionHistoryResponse: {
|
|
653
|
+
transactions: components['schemas']['TransactionHistoryResponseItem'][];
|
|
654
|
+
};
|
|
655
|
+
TransactionHistoryResponseItem: {
|
|
656
|
+
/**
|
|
657
|
+
* @description Describes the type of activity that occurred.
|
|
658
|
+
* Determines if the data for the transaction should be read
|
|
659
|
+
* from the `transfer`, `mint`, or `tap` property.
|
|
660
|
+
*
|
|
661
|
+
* @enum {string}
|
|
662
|
+
*/
|
|
663
|
+
transaction_type: 'transfer' | 'mint' | 'devnet_tap' | 'abort_transfer_instruction';
|
|
664
|
+
/** @description The event id. */
|
|
665
|
+
event_id: string;
|
|
666
|
+
/**
|
|
667
|
+
* @description The ledger offset of the event.
|
|
668
|
+
* Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
|
|
669
|
+
*/
|
|
670
|
+
offset?: string;
|
|
671
|
+
/**
|
|
672
|
+
* Format: date-time
|
|
673
|
+
* @description The effective date of the event.
|
|
674
|
+
*/
|
|
675
|
+
date: string;
|
|
676
|
+
/** @description The id of the domain through which this transaction was sequenced. */
|
|
677
|
+
domain_id: string;
|
|
678
|
+
/**
|
|
679
|
+
* Format: int64
|
|
680
|
+
* @description The round for which this transaction was registered.
|
|
681
|
+
*/
|
|
682
|
+
round?: number;
|
|
683
|
+
/** @description The amulet price for the round at which this transfer was executed. */
|
|
684
|
+
amulet_price?: string;
|
|
685
|
+
/** @description A (batch) transfer from sender to receivers. */
|
|
686
|
+
transfer?: components['schemas']['Transfer'];
|
|
687
|
+
/** @description The DSO mints amulet for the cases where the DSO rules allow for that. */
|
|
688
|
+
mint?: components['schemas']['AmuletAmount'];
|
|
689
|
+
/** @description A tap creates a Amulet, only used for development purposes, and enabled only on DevNet. */
|
|
690
|
+
tap?: components['schemas']['AmuletAmount'];
|
|
691
|
+
abort_transfer_instruction?: components['schemas']['AbortTransferInstruction'];
|
|
692
|
+
};
|
|
693
|
+
UpdateHistoryRequestAfter: {
|
|
694
|
+
/**
|
|
695
|
+
* Format: int64
|
|
696
|
+
* @description The migration id from which to start returning transactions. This is inclusive.
|
|
697
|
+
*/
|
|
698
|
+
after_migration_id: number;
|
|
699
|
+
/**
|
|
700
|
+
* @description The record time to start returning transactions from. This only affects
|
|
701
|
+
* transactions with the same migration id as after_migration_id. Higher migration ids
|
|
702
|
+
* are always considered to be later.
|
|
703
|
+
*/
|
|
704
|
+
after_record_time: string;
|
|
705
|
+
};
|
|
706
|
+
UpdateHistoryRequest: {
|
|
707
|
+
/**
|
|
708
|
+
* @description The transactions returned will either have a higher migration id or
|
|
709
|
+
* the same migration id and a record_time greater than the migration id and record time
|
|
710
|
+
* specified.
|
|
711
|
+
*/
|
|
712
|
+
after?: components['schemas']['UpdateHistoryRequestAfter'];
|
|
713
|
+
/**
|
|
714
|
+
* Format: int32
|
|
715
|
+
* @description The maximum number of transactions returned for this request.
|
|
716
|
+
*/
|
|
717
|
+
page_size: number;
|
|
718
|
+
/**
|
|
719
|
+
* @description Whether contract payload should be encoded into json using a lossless, but much harder to process, encoding.
|
|
720
|
+
* This is mostly used for backend calls, and is not recommended for external users.
|
|
721
|
+
* Optional and defaults to false.
|
|
722
|
+
*/
|
|
723
|
+
lossless?: boolean;
|
|
724
|
+
};
|
|
725
|
+
UpdateHistoryRequestV1: {
|
|
726
|
+
/**
|
|
727
|
+
* @description The transactions returned will either have a higher migration id or
|
|
728
|
+
* the same migration id and a record_time greater than the migration id and record time
|
|
729
|
+
* specified.
|
|
730
|
+
*/
|
|
731
|
+
after?: components['schemas']['UpdateHistoryRequestAfter'];
|
|
732
|
+
/**
|
|
733
|
+
* Format: int32
|
|
734
|
+
* @description The maximum number of transactions returned for this request.
|
|
735
|
+
*/
|
|
736
|
+
page_size: number;
|
|
737
|
+
daml_value_encoding?: components['schemas']['DamlValueEncoding'];
|
|
738
|
+
};
|
|
739
|
+
UpdateHistoryRequestV2: {
|
|
740
|
+
/**
|
|
741
|
+
* @description The transactions returned will either have a higher migration id or
|
|
742
|
+
* the same migration id and a record_time greater than the migration id and record time
|
|
743
|
+
* specified.
|
|
744
|
+
*/
|
|
745
|
+
after?: components['schemas']['UpdateHistoryRequestAfter'];
|
|
746
|
+
/**
|
|
747
|
+
* Format: int32
|
|
748
|
+
* @description The maximum number of transactions returned for this request.
|
|
749
|
+
*/
|
|
750
|
+
page_size: number;
|
|
751
|
+
daml_value_encoding?: components['schemas']['DamlValueEncoding'];
|
|
752
|
+
};
|
|
753
|
+
UpdateHistoryResponseV2: {
|
|
754
|
+
transactions: components['schemas']['UpdateHistoryItemV2'][];
|
|
755
|
+
};
|
|
756
|
+
UpdateHistoryResponse: {
|
|
757
|
+
transactions: components['schemas']['UpdateHistoryItem'][];
|
|
758
|
+
};
|
|
759
|
+
/** @description An individual item in the update history. May be a transaction or a contract reassignment. */
|
|
760
|
+
UpdateHistoryItemV2: components['schemas']['UpdateHistoryTransactionV2'] | components['schemas']['UpdateHistoryReassignment'];
|
|
761
|
+
/** @description An individual item in the update history. May be a transaction or a contract reassignment. */
|
|
762
|
+
UpdateHistoryItem: components['schemas']['UpdateHistoryTransaction'] | components['schemas']['UpdateHistoryReassignment'];
|
|
763
|
+
/** @description A contract reassignment between synchronizer. May be an assignment or unassignment. */
|
|
764
|
+
UpdateHistoryReassignment: {
|
|
765
|
+
/** @description The id of the update. */
|
|
766
|
+
update_id: string;
|
|
767
|
+
/**
|
|
768
|
+
* @description The absolute offset.
|
|
769
|
+
* Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
|
|
770
|
+
*/
|
|
771
|
+
offset: string;
|
|
772
|
+
/** @description The time at which the transaction was sequenced. */
|
|
773
|
+
record_time: string;
|
|
774
|
+
/** @description The reassignment event. May be an assignment or unassignment. */
|
|
775
|
+
event: components['schemas']['UpdateHistoryAssignment'] | components['schemas']['UpdateHistoryUnassignment'];
|
|
776
|
+
};
|
|
777
|
+
UpdateHistoryAssignment: {
|
|
778
|
+
/** @description The party ID who submitted this reassignment */
|
|
779
|
+
submitter: string;
|
|
780
|
+
/** @description The id of the synchronizer from which the contract was reassigned */
|
|
781
|
+
source_synchronizer: string;
|
|
782
|
+
/** @description The id of the synchronizer to which the contract was reassigned */
|
|
783
|
+
target_synchronizer: string;
|
|
784
|
+
/**
|
|
785
|
+
* Format: int64
|
|
786
|
+
* @description The migration id of the target synchronizer
|
|
787
|
+
*/
|
|
788
|
+
migration_id: number;
|
|
789
|
+
/**
|
|
790
|
+
* @description The id of the corresponding unassign event; this assignment will
|
|
791
|
+
* usually, but not always, occur after the so-identified unassignment
|
|
792
|
+
* event.
|
|
793
|
+
*/
|
|
794
|
+
unassign_id: string;
|
|
795
|
+
/** @description The corresponding contract create event */
|
|
796
|
+
created_event: components['schemas']['CreatedEvent'];
|
|
797
|
+
/**
|
|
798
|
+
* Format: int64
|
|
799
|
+
* @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.
|
|
800
|
+
*/
|
|
801
|
+
reassignment_counter: number;
|
|
802
|
+
};
|
|
803
|
+
UpdateHistoryUnassignment: {
|
|
804
|
+
/** @description The party who submitted this reassignment */
|
|
805
|
+
submitter: string;
|
|
806
|
+
/** @description The id of the synchronizer from which the contract was reassigned */
|
|
807
|
+
source_synchronizer: string;
|
|
808
|
+
/**
|
|
809
|
+
* Format: int64
|
|
810
|
+
* @description The migration id of the synchronizer from which the contract was reassigned
|
|
811
|
+
*/
|
|
812
|
+
migration_id: number;
|
|
813
|
+
/** @description The id of the synchronizer to which the contract was reassigned */
|
|
814
|
+
target_synchronizer: string;
|
|
815
|
+
/** @description The id of the unassign event, to later be correlated to an assign event */
|
|
816
|
+
unassign_id: string;
|
|
817
|
+
/**
|
|
818
|
+
* Format: int64
|
|
819
|
+
* @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.
|
|
820
|
+
*/
|
|
821
|
+
reassignment_counter: number;
|
|
822
|
+
/** @description The id of the unassigned contract */
|
|
823
|
+
contract_id: string;
|
|
824
|
+
};
|
|
825
|
+
UpdateHistoryTransaction: {
|
|
826
|
+
/** @description The id of the update. */
|
|
827
|
+
update_id: string;
|
|
828
|
+
/**
|
|
829
|
+
* Format: int64
|
|
830
|
+
* @description The migration id of the synchronizer.
|
|
831
|
+
*/
|
|
832
|
+
migration_id: number;
|
|
833
|
+
/**
|
|
834
|
+
* @description This transaction's Daml workflow ID; a workflow ID can be associated
|
|
835
|
+
* with multiple transactions. If empty, no workflow ID was set.
|
|
836
|
+
*/
|
|
837
|
+
workflow_id: string;
|
|
838
|
+
/**
|
|
839
|
+
* @description The time at which the transaction was sequenced, with microsecond
|
|
840
|
+
* resolution, using ISO-8601 representation.
|
|
841
|
+
*/
|
|
842
|
+
record_time: string;
|
|
843
|
+
/** @description The id of the synchronizer through which this transaction was sequenced. */
|
|
844
|
+
synchronizer_id: string;
|
|
845
|
+
/**
|
|
846
|
+
* @description Ledger effective time, using ISO-8601 representation. This is the time
|
|
847
|
+
* returned by `getTime` for all Daml executed as part of this transaction,
|
|
848
|
+
* both by the submitting participant and all confirming participants.
|
|
849
|
+
*/
|
|
850
|
+
effective_at: string;
|
|
851
|
+
/**
|
|
852
|
+
* @description The absolute offset.
|
|
853
|
+
* Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
|
|
854
|
+
* However, within a single SV's scan, it is monotonically, lexicographically increasing.
|
|
855
|
+
*/
|
|
856
|
+
offset: string;
|
|
857
|
+
/**
|
|
858
|
+
* @description Roots of the transaction tree. These are guaranteed to occur as keys
|
|
859
|
+
* of the `events_by_id` object.
|
|
860
|
+
*/
|
|
861
|
+
root_event_ids: string[];
|
|
862
|
+
/**
|
|
863
|
+
* @description Changes to the ledger that were caused by this transaction, keyed by ID.
|
|
864
|
+
* Values are nodes of the transaction tree.
|
|
865
|
+
* Within a transaction, IDs may be referenced by `root_event_ids` or
|
|
866
|
+
* `child_event_ids` in `ExercisedEvent` herein.
|
|
867
|
+
*/
|
|
868
|
+
events_by_id: {
|
|
869
|
+
[key: string]: components['schemas']['TreeEvent'];
|
|
870
|
+
};
|
|
871
|
+
};
|
|
872
|
+
UpdateHistoryTransactionV2: {
|
|
873
|
+
/** @description The id of the update. */
|
|
874
|
+
update_id: string;
|
|
875
|
+
/**
|
|
876
|
+
* Format: int64
|
|
877
|
+
* @description The migration id of the synchronizer.
|
|
878
|
+
*/
|
|
879
|
+
migration_id: number;
|
|
880
|
+
/**
|
|
881
|
+
* @description This transaction's Daml workflow ID; a workflow ID can be associated
|
|
882
|
+
* with multiple transactions. If empty, no workflow ID was set.
|
|
883
|
+
*/
|
|
884
|
+
workflow_id: string;
|
|
885
|
+
/**
|
|
886
|
+
* @description The time at which the transaction was sequenced, with microsecond
|
|
887
|
+
* resolution, using ISO-8601 representation.
|
|
888
|
+
*/
|
|
889
|
+
record_time: string;
|
|
890
|
+
/** @description The id of the synchronizer through which this transaction was sequenced. */
|
|
891
|
+
synchronizer_id: string;
|
|
892
|
+
/**
|
|
893
|
+
* @description Ledger effective time, using ISO-8601 representation. This is the time
|
|
894
|
+
* returned by `getTime` for all Daml executed as part of this transaction,
|
|
895
|
+
* both by the submitting participant and all confirming participants.
|
|
896
|
+
*/
|
|
897
|
+
effective_at: string;
|
|
898
|
+
/**
|
|
899
|
+
* @description Roots of the transaction tree. These are guaranteed to occur as keys
|
|
900
|
+
* of the `events_by_id` object.
|
|
901
|
+
*/
|
|
902
|
+
root_event_ids: string[];
|
|
903
|
+
/**
|
|
904
|
+
* @description Changes to the ledger that were caused by this transaction, keyed by ID and sorted lexicographically by ID for display consistency.
|
|
905
|
+
* Values are nodes of the transaction tree.
|
|
906
|
+
* Within a transaction, IDs may be referenced by `root_event_ids` or
|
|
907
|
+
* `child_event_ids` in `ExercisedEvent` herein, which are sorted in the order as they occurred in the transaction.
|
|
908
|
+
*/
|
|
909
|
+
events_by_id: {
|
|
910
|
+
[key: string]: components['schemas']['TreeEvent'];
|
|
911
|
+
};
|
|
912
|
+
};
|
|
913
|
+
/** @description Either a creation or an exercise of a contract. */
|
|
914
|
+
TreeEvent: components['schemas']['CreatedEvent'] | components['schemas']['ExercisedEvent'];
|
|
915
|
+
CreatedEvent: {
|
|
916
|
+
event_type: string;
|
|
917
|
+
/**
|
|
918
|
+
* @description The ID of this particular event. Equal to the key of this element of
|
|
919
|
+
* the containing `events_by_id` if this is part of a `TreeEvent`.
|
|
920
|
+
*/
|
|
921
|
+
event_id: string;
|
|
922
|
+
/** @description The ID of the created contract. */
|
|
923
|
+
contract_id: string;
|
|
924
|
+
/** @description The template of the created contract. */
|
|
925
|
+
template_id: string;
|
|
926
|
+
/** @description The package name of the created contract. */
|
|
927
|
+
package_name: string;
|
|
928
|
+
/**
|
|
929
|
+
* @description The arguments that have been used to create the contract, in the
|
|
930
|
+
* form of JSON representation of a Daml record.
|
|
931
|
+
*/
|
|
932
|
+
create_arguments: Record<string, never>;
|
|
933
|
+
/**
|
|
934
|
+
* Format: date-time
|
|
935
|
+
* @description Ledger effective time of the transaction that created the contract.
|
|
936
|
+
*/
|
|
937
|
+
created_at: string;
|
|
938
|
+
/** @description Signatories to the contract, in the form of party IDs. */
|
|
939
|
+
signatories: string[];
|
|
940
|
+
/** @description Observers to the contract, in the form of party IDs. */
|
|
941
|
+
observers: string[];
|
|
942
|
+
};
|
|
943
|
+
ExercisedEvent: {
|
|
944
|
+
event_type: string;
|
|
945
|
+
/**
|
|
946
|
+
* @description The ID of this particular event. Equal to the key of this element of
|
|
947
|
+
* the containing `events_by_id` if this is part of a `TreeEvent`.
|
|
948
|
+
*/
|
|
949
|
+
event_id: string;
|
|
950
|
+
/** @description The ID of the created contract. */
|
|
951
|
+
contract_id: string;
|
|
952
|
+
/** @description The template of the created contract. */
|
|
953
|
+
template_id: string;
|
|
954
|
+
/** @description The package name of the created contract. */
|
|
955
|
+
package_name: string;
|
|
956
|
+
/**
|
|
957
|
+
* @description The choice that was exercised on the target contract, as an unqualified
|
|
958
|
+
* choice name, i.e. with no package or module name qualifiers.
|
|
959
|
+
*/
|
|
960
|
+
choice: string;
|
|
961
|
+
/**
|
|
962
|
+
* @description The argument of the exercised choice, in the form of JSON
|
|
963
|
+
* representation of a Daml value. This is usually a record with field
|
|
964
|
+
* names being the argument names, even in the case of a single apparent
|
|
965
|
+
* choice argument, which is represented as a single-element Daml record.
|
|
966
|
+
*/
|
|
967
|
+
choice_argument: Record<string, never>;
|
|
968
|
+
/**
|
|
969
|
+
* @description References to further events in the same transaction that appeared as a result of this ExercisedEvent.
|
|
970
|
+
* It contains only the immediate children of this event, not all members of the subtree rooted at this node.
|
|
971
|
+
* The order of the children is the same as the event order in the transaction.
|
|
972
|
+
*/
|
|
973
|
+
child_event_ids: string[];
|
|
974
|
+
/**
|
|
975
|
+
* @description The result of exercising the choice, as the JSON representation of a
|
|
976
|
+
* Daml value.
|
|
977
|
+
*/
|
|
978
|
+
exercise_result: Record<string, never>;
|
|
979
|
+
/** @description If true, the target contract may no longer be exercised. */
|
|
980
|
+
consuming: boolean;
|
|
981
|
+
/** @description The parties that exercised the choice, in the form of party IDs. */
|
|
982
|
+
acting_parties: string[];
|
|
983
|
+
/** @description The interface where the choice is defined, if inherited. */
|
|
984
|
+
interface_id?: string;
|
|
985
|
+
};
|
|
986
|
+
AcsSnapshotTimestampResponse: {
|
|
987
|
+
/**
|
|
988
|
+
* Format: date-time
|
|
989
|
+
* @description The record time of the last transaction in the snapshot.
|
|
990
|
+
*/
|
|
991
|
+
record_time: string;
|
|
992
|
+
};
|
|
993
|
+
AcsRequest: {
|
|
994
|
+
/**
|
|
995
|
+
* Format: int64
|
|
996
|
+
* @description The migration id for which to return the ACS.
|
|
997
|
+
*/
|
|
998
|
+
migration_id: number;
|
|
999
|
+
/**
|
|
1000
|
+
* Format: date-time
|
|
1001
|
+
* @description The timestamp at which the contract set was active. Currently, needs to be an exact timestamp, i.e.,
|
|
1002
|
+
* needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp`.
|
|
1003
|
+
*/
|
|
1004
|
+
record_time: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Format: int64
|
|
1007
|
+
* @description Pagination token for the next page of results. For this to be valid,
|
|
1008
|
+
* this must be the `next_page_token` from a prior request with identical
|
|
1009
|
+
* parameters aside from `after` and `page_size`; the response may be
|
|
1010
|
+
* invalid otherwise.
|
|
1011
|
+
*/
|
|
1012
|
+
after?: number;
|
|
1013
|
+
/**
|
|
1014
|
+
* Format: int32
|
|
1015
|
+
* @description The maximum number of created events returned for this request.
|
|
1016
|
+
*/
|
|
1017
|
+
page_size: number;
|
|
1018
|
+
/** @description Filters the ACS by contracts in which these party IDs are stakeholders. */
|
|
1019
|
+
party_ids?: string[];
|
|
1020
|
+
/** @description Filters the ACS by contracts with these template IDs, specified as "PACKAGE_NAME:MODULE_NAME:ENTITY_NAME". */
|
|
1021
|
+
templates?: string[];
|
|
1022
|
+
};
|
|
1023
|
+
HoldingsStateRequest: {
|
|
1024
|
+
/**
|
|
1025
|
+
* Format: int64
|
|
1026
|
+
* @description The migration id for which to return the ACS.
|
|
1027
|
+
*/
|
|
1028
|
+
migration_id: number;
|
|
1029
|
+
/**
|
|
1030
|
+
* Format: date-time
|
|
1031
|
+
* @description The timestamp at which the contract set was active. Currently, needs to be an exact timestamp, i.e.,
|
|
1032
|
+
* needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp`.
|
|
1033
|
+
*/
|
|
1034
|
+
record_time: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* Format: int64
|
|
1037
|
+
* @description Pagination token for the next page of results.
|
|
1038
|
+
*/
|
|
1039
|
+
after?: number;
|
|
1040
|
+
/**
|
|
1041
|
+
* Format: int32
|
|
1042
|
+
* @description The maximum number of created events returned for this request.
|
|
1043
|
+
*/
|
|
1044
|
+
page_size: number;
|
|
1045
|
+
/** @description Filters by contracts in which these party_ids are the owners of the amulets. */
|
|
1046
|
+
owner_party_ids: string[];
|
|
1047
|
+
};
|
|
1048
|
+
HoldingsSummaryRequest: {
|
|
1049
|
+
/**
|
|
1050
|
+
* Format: int64
|
|
1051
|
+
* @description The migration id for which to return the summary.
|
|
1052
|
+
*/
|
|
1053
|
+
migration_id: number;
|
|
1054
|
+
/**
|
|
1055
|
+
* Format: date-time
|
|
1056
|
+
* @description The timestamp at which the contract set was active. Currently, needs to be an exact timestamp, i.e.,
|
|
1057
|
+
* needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp`.
|
|
1058
|
+
*/
|
|
1059
|
+
record_time: string;
|
|
1060
|
+
/** @description The owners for which to compute the summary. */
|
|
1061
|
+
owner_party_ids: string[];
|
|
1062
|
+
/**
|
|
1063
|
+
* Format: int64
|
|
1064
|
+
* @description Compute holding fees as of this round. Defaults to the earliest open mining round.
|
|
1065
|
+
*/
|
|
1066
|
+
as_of_round?: number;
|
|
1067
|
+
};
|
|
1068
|
+
ForceAcsSnapshotResponse: {
|
|
1069
|
+
/**
|
|
1070
|
+
* Format: date-time
|
|
1071
|
+
* @description The [recent] time for which this ACS snapshot was persisted.
|
|
1072
|
+
*/
|
|
1073
|
+
record_time: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* Format: int64
|
|
1076
|
+
* @description The current migration ID of the Scan.
|
|
1077
|
+
*/
|
|
1078
|
+
migration_id: number;
|
|
1079
|
+
};
|
|
1080
|
+
AcsResponse: {
|
|
1081
|
+
/**
|
|
1082
|
+
* Format: date-time
|
|
1083
|
+
* @description The same `record_time` as in the request.
|
|
1084
|
+
*/
|
|
1085
|
+
record_time: string;
|
|
1086
|
+
/**
|
|
1087
|
+
* Format: int64
|
|
1088
|
+
* @description The same `migration_id` as in the request.
|
|
1089
|
+
*/
|
|
1090
|
+
migration_id: number;
|
|
1091
|
+
/**
|
|
1092
|
+
* @description Up to `page_size` contracts in the ACS.
|
|
1093
|
+
* `create_arguments` are always encoded as `compact_json`.
|
|
1094
|
+
*/
|
|
1095
|
+
created_events: components['schemas']['CreatedEvent'][];
|
|
1096
|
+
/**
|
|
1097
|
+
* Format: int64
|
|
1098
|
+
* @description When requesting the next page of results, pass this as `after`
|
|
1099
|
+
* to the `AcsRequest` or `HoldingsStateRequest`.
|
|
1100
|
+
* Will be absent when there are no more pages.
|
|
1101
|
+
*/
|
|
1102
|
+
next_page_token?: number;
|
|
1103
|
+
};
|
|
1104
|
+
HoldingsSummaryResponse: {
|
|
1105
|
+
/**
|
|
1106
|
+
* Format: date-time
|
|
1107
|
+
* @description The same `record_time` as in the request.
|
|
1108
|
+
*/
|
|
1109
|
+
record_time: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Format: int64
|
|
1112
|
+
* @description The same `migration_id` as in the request.
|
|
1113
|
+
*/
|
|
1114
|
+
migration_id: number;
|
|
1115
|
+
/**
|
|
1116
|
+
* Format: int64
|
|
1117
|
+
* @description The same `as_of_round` as in the request, with the same default.
|
|
1118
|
+
*/
|
|
1119
|
+
computed_as_of_round: number;
|
|
1120
|
+
summaries: components['schemas']['HoldingsSummary'][];
|
|
1121
|
+
};
|
|
1122
|
+
/** @description Aggregate Amulet totals for a particular owner party ID. */
|
|
1123
|
+
HoldingsSummary: {
|
|
1124
|
+
/** @description Owner party ID of the amulet. Guaranteed to be unique among `summaries`. */
|
|
1125
|
+
party_id: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* @description Sum of unlocked amulet at time of reception, not counting holding
|
|
1128
|
+
* fees deducted since.
|
|
1129
|
+
*/
|
|
1130
|
+
total_unlocked_coin: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* @description Sum of locked amulet at time of original amulet reception, not
|
|
1133
|
+
* counting holding fees deducted since.
|
|
1134
|
+
*/
|
|
1135
|
+
total_locked_coin: string;
|
|
1136
|
+
/** @description `total_unlocked_coin` + `total_locked_coin`. */
|
|
1137
|
+
total_coin_holdings: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* @description Sum of holding fees as of `computed_as_of_round` that apply to
|
|
1140
|
+
* unlocked amulet.
|
|
1141
|
+
*/
|
|
1142
|
+
accumulated_holding_fees_unlocked: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* @description Sum of holding fees as of `computed_as_of_round` that apply to
|
|
1145
|
+
* locked amulet, including fees applied since the amulet's creation
|
|
1146
|
+
* round.
|
|
1147
|
+
*/
|
|
1148
|
+
accumulated_holding_fees_locked: string;
|
|
1149
|
+
/** @description Same as `accumulated_holding_fees_unlocked` + `accumulated_holding_fees_locked`. */
|
|
1150
|
+
accumulated_holding_fees_total: string;
|
|
1151
|
+
/** @description Same as `total_unlocked_coin` - `accumulated_holding_fees_unlocked`. */
|
|
1152
|
+
total_available_coin: string;
|
|
1153
|
+
};
|
|
1154
|
+
ListActivityRequest: {
|
|
1155
|
+
/**
|
|
1156
|
+
* @description Minimal event_id for returned activities.
|
|
1157
|
+
* Note that all activities carry some monotonically-increasing event_id. begin_after_id sets the minimum value for event_id's for the query.
|
|
1158
|
+
*/
|
|
1159
|
+
begin_after_id?: string;
|
|
1160
|
+
/**
|
|
1161
|
+
* Format: int64
|
|
1162
|
+
* @description The maximum number of activity items returned for this request.
|
|
1163
|
+
*/
|
|
1164
|
+
page_size: number;
|
|
1165
|
+
};
|
|
1166
|
+
ListActivityResponse: {
|
|
1167
|
+
activities: components['schemas']['ListActivityResponseItem'][];
|
|
1168
|
+
};
|
|
1169
|
+
ListActivityResponseItem: {
|
|
1170
|
+
/**
|
|
1171
|
+
* @description Describes the type of activity that occurred.
|
|
1172
|
+
* Determines if the data for the activity should be read
|
|
1173
|
+
* from the `transfer`, `mint`, or `tap` property.
|
|
1174
|
+
*
|
|
1175
|
+
* @enum {string}
|
|
1176
|
+
*/
|
|
1177
|
+
activity_type: 'transfer' | 'mint' | 'devnet_tap' | 'abort_transfer_instruction';
|
|
1178
|
+
/** @description The event id. */
|
|
1179
|
+
event_id: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* @description The ledger offset of the event.
|
|
1182
|
+
* Note that this field may not be the same across nodes, and therefore should not be compared between SVs.
|
|
1183
|
+
*/
|
|
1184
|
+
offset?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* Format: date-time
|
|
1187
|
+
* @description The effective date of the event.
|
|
1188
|
+
*/
|
|
1189
|
+
date: string;
|
|
1190
|
+
/** @description The id of the domain through which this transaction was sequenced. */
|
|
1191
|
+
domain_id: string;
|
|
1192
|
+
/**
|
|
1193
|
+
* Format: int64
|
|
1194
|
+
* @description The round for which this transaction was registered.
|
|
1195
|
+
*/
|
|
1196
|
+
round?: number;
|
|
1197
|
+
/** @description The amulet price for the round at which this transfer was executed. */
|
|
1198
|
+
amulet_price?: string;
|
|
1199
|
+
/** @description A (batch) transfer from sender to receivers. */
|
|
1200
|
+
transfer?: components['schemas']['Transfer'];
|
|
1201
|
+
/** @description The DSO mints amulet for the cases where the DSO rules allow for that. */
|
|
1202
|
+
mint?: components['schemas']['AmuletAmount'];
|
|
1203
|
+
/** @description A tap creates a Amulet, only used for development purposes, and enabled only on DevNet. */
|
|
1204
|
+
tap?: components['schemas']['AmuletAmount'];
|
|
1205
|
+
abort_transfer_instruction?: components['schemas']['AbortTransferInstruction'];
|
|
1206
|
+
};
|
|
1207
|
+
/** @description A transfer between one sender and possibly many receivers, provided by an application provider. */
|
|
1208
|
+
Transfer: {
|
|
1209
|
+
/** @description The application provider. */
|
|
1210
|
+
provider: string;
|
|
1211
|
+
/** @description The sender amounts and fees. */
|
|
1212
|
+
sender: components['schemas']['SenderAmount'];
|
|
1213
|
+
/** @description The amounts and fees per receiver. */
|
|
1214
|
+
receivers: components['schemas']['ReceiverAmount'][];
|
|
1215
|
+
/** @description Normalized balance changes per party caused by this transfer. */
|
|
1216
|
+
balance_changes: components['schemas']['BalanceChange'][];
|
|
1217
|
+
description?: string;
|
|
1218
|
+
transferInstructionReceiver?: string;
|
|
1219
|
+
transferInstructionAmount?: string;
|
|
1220
|
+
transferInstructionCid?: string;
|
|
1221
|
+
/** @enum {string} */
|
|
1222
|
+
transfer_kind?: 'create_transfer_instruction' | 'transfer_instruction_accept' | 'preapproval_send';
|
|
1223
|
+
};
|
|
1224
|
+
AbortTransferInstruction: {
|
|
1225
|
+
/** @enum {string} */
|
|
1226
|
+
abort_kind: 'withdraw' | 'reject';
|
|
1227
|
+
transfer_instruction_cid: string;
|
|
1228
|
+
};
|
|
1229
|
+
BalanceChange: {
|
|
1230
|
+
/** @description The party for which the balance changes. */
|
|
1231
|
+
party: string;
|
|
1232
|
+
/**
|
|
1233
|
+
* @description The change to the total balance introduced by this balance change, normalized to round zero, i.e.,
|
|
1234
|
+
* a amulet created in round 3 is treated as a amulet created in round 0 with a higher initial amount.
|
|
1235
|
+
*/
|
|
1236
|
+
change_to_initial_amount_as_of_round_zero: string;
|
|
1237
|
+
/** @description The change of total holding fees introduced by this balance change. */
|
|
1238
|
+
change_to_holding_fees_rate: string;
|
|
1239
|
+
};
|
|
1240
|
+
AmuletAmount: {
|
|
1241
|
+
/** @description The party that owns the amulet. */
|
|
1242
|
+
amulet_owner: string;
|
|
1243
|
+
/** @description The amulet amount. */
|
|
1244
|
+
amulet_amount: string;
|
|
1245
|
+
};
|
|
1246
|
+
SenderAmount: {
|
|
1247
|
+
/** @description The sender who has transferred amulet. */
|
|
1248
|
+
party: string;
|
|
1249
|
+
/** @description Total amount of amulet input into this transfer, before deducting holding fees. */
|
|
1250
|
+
input_amulet_amount?: string;
|
|
1251
|
+
/** @description Total amount of app rewards input into this transfer. */
|
|
1252
|
+
input_app_reward_amount?: string;
|
|
1253
|
+
/** @description Total amount of validator rewards input into this transfer. */
|
|
1254
|
+
input_validator_reward_amount?: string;
|
|
1255
|
+
/** @description Total amount of sv rewards input into this transfer. */
|
|
1256
|
+
input_sv_reward_amount?: string;
|
|
1257
|
+
/** @description Total amount of validator faucet coupon issuance input into this transfer. */
|
|
1258
|
+
input_validator_faucet_amount?: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* @description Fee charged for returning change to the sender,
|
|
1261
|
+
* which is the smaller of the left-over balance after paying for all outputs
|
|
1262
|
+
* or one amulet create fee.
|
|
1263
|
+
*/
|
|
1264
|
+
sender_change_fee: string;
|
|
1265
|
+
/** @description The final amount of amulet returned to the sender after paying for all outputs and fees. */
|
|
1266
|
+
sender_change_amount: string;
|
|
1267
|
+
/** @description Total fees paid by the sender, based on receiver's receiver_fee_ratio on outputs */
|
|
1268
|
+
sender_fee: string;
|
|
1269
|
+
/** @description Holding fees paid by the sender on their input amulets. */
|
|
1270
|
+
holding_fees: string;
|
|
1271
|
+
};
|
|
1272
|
+
ReceiverAmount: {
|
|
1273
|
+
/** @description The receiver who will own the created output amulet. */
|
|
1274
|
+
party: string;
|
|
1275
|
+
/** @description The amount of amulet to receive, before deducting receiver's part of the fees. */
|
|
1276
|
+
amount: string;
|
|
1277
|
+
/** @description Total fees paid by the receiver, based on receiver_fee_ratio on outputs */
|
|
1278
|
+
receiver_fee: string;
|
|
1279
|
+
};
|
|
1280
|
+
ListEntriesResponse: {
|
|
1281
|
+
entries: components['schemas']['AnsEntry'][];
|
|
1282
|
+
};
|
|
1283
|
+
LookupEntryByPartyResponse: {
|
|
1284
|
+
entry: components['schemas']['AnsEntry'];
|
|
1285
|
+
};
|
|
1286
|
+
LookupEntryByNameResponse: {
|
|
1287
|
+
entry: components['schemas']['AnsEntry'];
|
|
1288
|
+
};
|
|
1289
|
+
/** @description A Daml contract of template `Splice.AmuletRules:TransferPreapproval`. */
|
|
1290
|
+
LookupTransferPreapprovalByPartyResponse: {
|
|
1291
|
+
transfer_preapproval: components['schemas']['ContractWithState'];
|
|
1292
|
+
};
|
|
1293
|
+
/** @description A Daml contract of template `Splice.ExternalPartyAmuletRules:TransferCommandCounter`. */
|
|
1294
|
+
LookupTransferCommandCounterByPartyResponse: {
|
|
1295
|
+
transfer_command_counter: components['schemas']['ContractWithState'];
|
|
1296
|
+
};
|
|
1297
|
+
LookupTransferCommandStatusResponse: {
|
|
1298
|
+
transfer_commands_by_contract_id: components['schemas']['TransferCommandMap'];
|
|
1299
|
+
};
|
|
1300
|
+
TransferCommandMap: {
|
|
1301
|
+
[key: string]: components['schemas']['TransferCommandContractWithStatus'];
|
|
1302
|
+
};
|
|
1303
|
+
/**
|
|
1304
|
+
* @description A contract of Daml template `Splice.ExternalPartyAmuletRules:TransferCommand`,
|
|
1305
|
+
* and its status determined by the latest transactions.
|
|
1306
|
+
*/
|
|
1307
|
+
TransferCommandContractWithStatus: {
|
|
1308
|
+
contract: components['schemas']['Contract'];
|
|
1309
|
+
status: components['schemas']['TransferCommandContractStatus'];
|
|
1310
|
+
};
|
|
1311
|
+
TransferCommandContractStatus: components['schemas']['TransferCommandCreatedResponse'] | components['schemas']['TransferCommandSentResponse'] | components['schemas']['TransferCommandFailedResponse'];
|
|
1312
|
+
BaseLookupTransferCommandStatusResponse: {
|
|
1313
|
+
/**
|
|
1314
|
+
* @description The status of the transfer command.
|
|
1315
|
+
* created:
|
|
1316
|
+
* The transfer command has been created and is waiting for automation to complete it.
|
|
1317
|
+
* sent:
|
|
1318
|
+
* The transfer command has been completed and the transfer to the receiver has finished.
|
|
1319
|
+
* failed:
|
|
1320
|
+
* The transfer command has failed permanently and nothing has been transferred. Refer to
|
|
1321
|
+
* failure_reason for details. A new transfer command can be created.
|
|
1322
|
+
*/
|
|
1323
|
+
status: string;
|
|
1324
|
+
};
|
|
1325
|
+
TransferCommandCreatedResponse: components['schemas']['BaseLookupTransferCommandStatusResponse'];
|
|
1326
|
+
TransferCommandSentResponse: components['schemas']['BaseLookupTransferCommandStatusResponse'];
|
|
1327
|
+
TransferCommandFailedResponse: components['schemas']['BaseLookupTransferCommandStatusResponse'] & {
|
|
1328
|
+
/**
|
|
1329
|
+
* @description The reason for the failure of the TransferCommand.
|
|
1330
|
+
* failed:
|
|
1331
|
+
* Completing the transfer failed, check the reason for details.
|
|
1332
|
+
* withdrawn:
|
|
1333
|
+
* The sender has withdrawn the TransferCommand before it could be completed.
|
|
1334
|
+
* expired:
|
|
1335
|
+
* The expiry time on the TransferCommand was reached before it could be completed.
|
|
1336
|
+
*
|
|
1337
|
+
* @enum {string}
|
|
1338
|
+
*/
|
|
1339
|
+
failure_kind: 'failed' | 'expired' | 'withdrawn';
|
|
1340
|
+
/** @description Human readable description of the failure */
|
|
1341
|
+
reason: string;
|
|
1342
|
+
};
|
|
1343
|
+
GetAcsSnapshotResponse: {
|
|
1344
|
+
/** @description base64-encoded ACS snapshot for the intersection of the DSO party and the requested party’s ACS */
|
|
1345
|
+
acs_snapshot: string;
|
|
1346
|
+
};
|
|
1347
|
+
AnsEntry: {
|
|
1348
|
+
/**
|
|
1349
|
+
* @description If present, Daml contract ID of template `Splice.Ans:AnsEntry`.
|
|
1350
|
+
* If absent, this is a DSO-provided entry for either the DSO or an SV.
|
|
1351
|
+
*/
|
|
1352
|
+
contract_id?: string;
|
|
1353
|
+
/** @description Owner party ID of this ANS entry. */
|
|
1354
|
+
user: string;
|
|
1355
|
+
/** @description The ANS entry name. */
|
|
1356
|
+
name: string;
|
|
1357
|
+
/** @description Either empty, or an http/https URL supplied by the `user`. */
|
|
1358
|
+
url: string;
|
|
1359
|
+
/** @description Arbitrary description text supplied by `user`; may be empty. */
|
|
1360
|
+
description: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* Format: date-time
|
|
1363
|
+
* @description Time after which this ANS entry expires; if renewed, it will have a
|
|
1364
|
+
* new `contract_id` and `expires_at`.
|
|
1365
|
+
* If `null` or absent, does not expire; this is the case only for
|
|
1366
|
+
* special entries provided by the DSO.
|
|
1367
|
+
*/
|
|
1368
|
+
expires_at?: string;
|
|
1369
|
+
};
|
|
1370
|
+
GetAggregatedRoundsResponse: {
|
|
1371
|
+
/** Format: int64 */
|
|
1372
|
+
start: number;
|
|
1373
|
+
/** Format: int64 */
|
|
1374
|
+
end: number;
|
|
1375
|
+
};
|
|
1376
|
+
ListRoundTotalsRequest: {
|
|
1377
|
+
/** Format: int64 */
|
|
1378
|
+
start_round: number;
|
|
1379
|
+
/** Format: int64 */
|
|
1380
|
+
end_round: number;
|
|
1381
|
+
};
|
|
1382
|
+
ListRoundPartyTotalsRequest: {
|
|
1383
|
+
/** Format: int64 */
|
|
1384
|
+
start_round: number;
|
|
1385
|
+
/** Format: int64 */
|
|
1386
|
+
end_round: number;
|
|
1387
|
+
};
|
|
1388
|
+
ListRoundTotalsResponse: {
|
|
1389
|
+
entries: components['schemas']['RoundTotals'][];
|
|
1390
|
+
};
|
|
1391
|
+
ListRoundPartyTotalsResponse: {
|
|
1392
|
+
entries: components['schemas']['RoundPartyTotals'][];
|
|
1393
|
+
};
|
|
1394
|
+
RoundPartyTotals: {
|
|
1395
|
+
/** Format: int64 */
|
|
1396
|
+
closed_round: number;
|
|
1397
|
+
party: string;
|
|
1398
|
+
app_rewards: string;
|
|
1399
|
+
validator_rewards: string;
|
|
1400
|
+
/** Format: int64 */
|
|
1401
|
+
traffic_purchased: number;
|
|
1402
|
+
traffic_purchased_cc_spent: string;
|
|
1403
|
+
/** Format: int64 */
|
|
1404
|
+
traffic_num_purchases: number;
|
|
1405
|
+
cumulative_app_rewards: string;
|
|
1406
|
+
cumulative_validator_rewards: string;
|
|
1407
|
+
cumulative_change_to_initial_amount_as_of_round_zero: string;
|
|
1408
|
+
cumulative_change_to_holding_fees_rate: string;
|
|
1409
|
+
/** Format: int64 */
|
|
1410
|
+
cumulative_traffic_purchased: number;
|
|
1411
|
+
cumulative_traffic_purchased_cc_spent: string;
|
|
1412
|
+
/** Format: int64 */
|
|
1413
|
+
cumulative_traffic_num_purchases: number;
|
|
1414
|
+
};
|
|
1415
|
+
RoundTotals: {
|
|
1416
|
+
/** Format: int64 */
|
|
1417
|
+
closed_round: number;
|
|
1418
|
+
/** Format: date-time */
|
|
1419
|
+
closed_round_effective_at: string;
|
|
1420
|
+
app_rewards: string;
|
|
1421
|
+
validator_rewards: string;
|
|
1422
|
+
change_to_initial_amount_as_of_round_zero: string;
|
|
1423
|
+
change_to_holding_fees_rate: string;
|
|
1424
|
+
cumulative_app_rewards: string;
|
|
1425
|
+
cumulative_validator_rewards: string;
|
|
1426
|
+
cumulative_change_to_initial_amount_as_of_round_zero: string;
|
|
1427
|
+
cumulative_change_to_holding_fees_rate: string;
|
|
1428
|
+
total_amulet_balance: string;
|
|
1429
|
+
};
|
|
1430
|
+
MigrationSchedule: {
|
|
1431
|
+
/** Format: date-time */
|
|
1432
|
+
time: string;
|
|
1433
|
+
/** Format: int64 */
|
|
1434
|
+
migration_id: number;
|
|
1435
|
+
};
|
|
1436
|
+
SynchronizerIdentities: {
|
|
1437
|
+
sequencer_id: string;
|
|
1438
|
+
sequencer_identity_transactions: string[];
|
|
1439
|
+
mediator_id: string;
|
|
1440
|
+
mediator_identity_transactions: string[];
|
|
1441
|
+
};
|
|
1442
|
+
SynchronizerBootstrappingTransactions: {
|
|
1443
|
+
domain_parameters: string;
|
|
1444
|
+
sequencer_domain_state: string;
|
|
1445
|
+
mediator_domain_state: string;
|
|
1446
|
+
};
|
|
1447
|
+
GetMigrationInfoRequest: {
|
|
1448
|
+
/** Format: int64 */
|
|
1449
|
+
migration_id: number;
|
|
1450
|
+
};
|
|
1451
|
+
GetMigrationInfoResponse: {
|
|
1452
|
+
/**
|
|
1453
|
+
* Format: int64
|
|
1454
|
+
* @description The migration id that was active before the given migration id, if any.
|
|
1455
|
+
*/
|
|
1456
|
+
previous_migration_id?: number;
|
|
1457
|
+
/**
|
|
1458
|
+
* @description All domains for which there are updates in the given migration id,
|
|
1459
|
+
* along with the record time of the newest and oldest update associated with each domain
|
|
1460
|
+
*/
|
|
1461
|
+
record_time_range: components['schemas']['RecordTimeRange'][];
|
|
1462
|
+
/**
|
|
1463
|
+
* @description The update id of the last import update (where import updates are sorted by update id, ascending)
|
|
1464
|
+
* for the given migration id, if any
|
|
1465
|
+
*/
|
|
1466
|
+
last_import_update_id?: string;
|
|
1467
|
+
/** @description True if this scan has all non-import updates for given migration id */
|
|
1468
|
+
complete: boolean;
|
|
1469
|
+
/** @description True if this scan has all import updates for the given migration id */
|
|
1470
|
+
import_updates_complete?: boolean;
|
|
1471
|
+
};
|
|
1472
|
+
RecordTimeRange: {
|
|
1473
|
+
synchronizer_id: string;
|
|
1474
|
+
/** Format: date-time */
|
|
1475
|
+
min: string;
|
|
1476
|
+
/** Format: date-time */
|
|
1477
|
+
max: string;
|
|
1478
|
+
};
|
|
1479
|
+
GetUpdatesBeforeRequest: {
|
|
1480
|
+
/** Format: int64 */
|
|
1481
|
+
migration_id: number;
|
|
1482
|
+
synchronizer_id: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* Format: date-time
|
|
1485
|
+
* @description Only return updates with a record time strictly smaller than this time.
|
|
1486
|
+
*/
|
|
1487
|
+
before: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* Format: date-time
|
|
1490
|
+
* @description Only return updates with a record time equal to or greater than this time.
|
|
1491
|
+
*/
|
|
1492
|
+
at_or_after?: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* Format: int32
|
|
1495
|
+
* @description Return at most this many updates. The actual number of updates returned may be smaller.
|
|
1496
|
+
*/
|
|
1497
|
+
count: number;
|
|
1498
|
+
};
|
|
1499
|
+
GetUpdatesBeforeResponse: {
|
|
1500
|
+
transactions: components['schemas']['UpdateHistoryItem'][];
|
|
1501
|
+
};
|
|
1502
|
+
GetImportUpdatesRequest: {
|
|
1503
|
+
/** Format: int64 */
|
|
1504
|
+
migration_id: number;
|
|
1505
|
+
/** @description Only return updates with an update id strictly greater than this. */
|
|
1506
|
+
after_update_id: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* Format: int32
|
|
1509
|
+
* @description Return at most this many updates. The actual number of updates returned may be smaller.
|
|
1510
|
+
*/
|
|
1511
|
+
limit: number;
|
|
1512
|
+
};
|
|
1513
|
+
GetImportUpdatesResponse: {
|
|
1514
|
+
transactions: components['schemas']['UpdateHistoryItem'][];
|
|
1515
|
+
};
|
|
1516
|
+
/**
|
|
1517
|
+
* @description How daml values should be encoded in the response.
|
|
1518
|
+
* "compact_json" is a compact, human-readable JSON encoding. It is the same encoding
|
|
1519
|
+
* as the one used in the HTTP JSON API or the JavaScript codegen.
|
|
1520
|
+
* "protobuf_json" is a verbose JSON encoding that is more difficult to parse,
|
|
1521
|
+
* but contains type information, i.e., the values can be parsed losslessly
|
|
1522
|
+
* without having access to the Daml source code.
|
|
1523
|
+
* Optional and defaults to "compact_json".
|
|
1524
|
+
*
|
|
1525
|
+
* @enum {string}
|
|
1526
|
+
*/
|
|
1527
|
+
DamlValueEncoding: 'compact_json' | 'protobuf_json';
|
|
1528
|
+
GetMemberTrafficStatusResponse: {
|
|
1529
|
+
/**
|
|
1530
|
+
* @description The current traffic state for the member on the synchronizer under
|
|
1531
|
+
* `actual`, and the total purchased traffic under `target`. The purchased
|
|
1532
|
+
* traffic may exceed the `actual` limit as purchases take time to be
|
|
1533
|
+
* incorporated into the limit.
|
|
1534
|
+
*/
|
|
1535
|
+
traffic_status: components['schemas']['MemberTrafficStatus'];
|
|
1536
|
+
};
|
|
1537
|
+
MemberTrafficStatus: {
|
|
1538
|
+
/** @description The current traffic state for the member on the synchronizer */
|
|
1539
|
+
actual: components['schemas']['ActualMemberTrafficState'];
|
|
1540
|
+
/** @description Total purchased traffic; may exceed limit in `actual` */
|
|
1541
|
+
target: components['schemas']['TargetMemberTrafficState'];
|
|
1542
|
+
};
|
|
1543
|
+
ActualMemberTrafficState: {
|
|
1544
|
+
/**
|
|
1545
|
+
* Format: int64
|
|
1546
|
+
* @description Total extra traffic consumed by the member on the given synchronizer
|
|
1547
|
+
*/
|
|
1548
|
+
total_consumed: number;
|
|
1549
|
+
/**
|
|
1550
|
+
* Format: int64
|
|
1551
|
+
* @description Current extra traffic limit set for the member on the given synchronizer.
|
|
1552
|
+
* An extra traffic top-up is complete once total_limit matches total_purchased.
|
|
1553
|
+
*/
|
|
1554
|
+
total_limit: number;
|
|
1555
|
+
};
|
|
1556
|
+
TargetMemberTrafficState: {
|
|
1557
|
+
/**
|
|
1558
|
+
* Format: int64
|
|
1559
|
+
* @description Total extra traffic purchased for the member on the given
|
|
1560
|
+
* synchronizer in bytes.
|
|
1561
|
+
*/
|
|
1562
|
+
total_purchased: number;
|
|
1563
|
+
};
|
|
1564
|
+
GetPartyToParticipantResponse: {
|
|
1565
|
+
/**
|
|
1566
|
+
* @description ID of the participant hosting the provided party, in the form
|
|
1567
|
+
* `PAR::id::fingerprint`
|
|
1568
|
+
*/
|
|
1569
|
+
participant_id: string;
|
|
1570
|
+
};
|
|
1571
|
+
GetValidatorFaucetsByValidatorResponse: {
|
|
1572
|
+
/**
|
|
1573
|
+
* @description Statistics for any party ID arguments found to have valid onboarding
|
|
1574
|
+
* licenses; the order in the response is unrelated to argument order.
|
|
1575
|
+
*/
|
|
1576
|
+
validatorsReceivedFaucets: components['schemas']['ValidatorReceivedFaucets'][];
|
|
1577
|
+
};
|
|
1578
|
+
ValidatorReceivedFaucets: {
|
|
1579
|
+
/** @description The party ID of the onboarded validator */
|
|
1580
|
+
validator: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* Format: int64
|
|
1583
|
+
* @description how many rounds the validator has received a faucet for; guaranteed
|
|
1584
|
+
* that collected + missed = last - first + 1
|
|
1585
|
+
*/
|
|
1586
|
+
numRoundsCollected: number;
|
|
1587
|
+
/**
|
|
1588
|
+
* Format: int64
|
|
1589
|
+
* @description how many rounds between firstCollected and lastCollected in which
|
|
1590
|
+
* the validator failed to collect (i.e. was not active or available);
|
|
1591
|
+
* can at most be max(0, lastCollected - firstCollected - 1).
|
|
1592
|
+
*/
|
|
1593
|
+
numRoundsMissed: number;
|
|
1594
|
+
/**
|
|
1595
|
+
* Format: int64
|
|
1596
|
+
* @description the round number when this validator started collecting faucets;
|
|
1597
|
+
* the validator definitely recorded liveness in this round
|
|
1598
|
+
*/
|
|
1599
|
+
firstCollectedInRound: number;
|
|
1600
|
+
/**
|
|
1601
|
+
* Format: int64
|
|
1602
|
+
* @description The most recent round number in which the validator collected a faucet;
|
|
1603
|
+
* the validator definitely recorded liveness in this round. Will equal
|
|
1604
|
+
* `firstCollected` if the validator has collected in only one round
|
|
1605
|
+
*/
|
|
1606
|
+
lastCollectedInRound: number;
|
|
1607
|
+
};
|
|
1608
|
+
GetBackfillingStatusResponse: {
|
|
1609
|
+
/**
|
|
1610
|
+
* @description True if ALL backfilling processes are complete, false otherwise.
|
|
1611
|
+
*
|
|
1612
|
+
* Some scan endpoints return error responses if backfilling is not complete
|
|
1613
|
+
* (e.g., `/v1/updates`), others return partial results (e.g., `/v0/transactions`).
|
|
1614
|
+
* This endpoint is a simple indicator for whether historical information may be incomplete.
|
|
1615
|
+
*
|
|
1616
|
+
* To determine the progress of individual backfilling processes, inspect the corresponding metrics.
|
|
1617
|
+
*/
|
|
1618
|
+
complete: boolean;
|
|
1619
|
+
};
|
|
1620
|
+
Status: {
|
|
1621
|
+
id: string;
|
|
1622
|
+
uptime: string;
|
|
1623
|
+
ports: {
|
|
1624
|
+
[key: string]: number;
|
|
1625
|
+
};
|
|
1626
|
+
/** Format: binary */
|
|
1627
|
+
extra?: string;
|
|
1628
|
+
active: boolean;
|
|
1629
|
+
};
|
|
1630
|
+
SuccessStatusResponse: {
|
|
1631
|
+
success: components['schemas']['Status'];
|
|
1632
|
+
};
|
|
1633
|
+
NotInitialized: {
|
|
1634
|
+
active: boolean;
|
|
1635
|
+
};
|
|
1636
|
+
NotInitializedStatusResponse: {
|
|
1637
|
+
not_initialized: components['schemas']['NotInitialized'];
|
|
1638
|
+
};
|
|
1639
|
+
ErrorResponse: {
|
|
1640
|
+
error: string;
|
|
1641
|
+
};
|
|
1642
|
+
FailureStatusResponse: {
|
|
1643
|
+
failed: components['schemas']['ErrorResponse'];
|
|
1644
|
+
};
|
|
1645
|
+
NodeStatus: components['schemas']['SuccessStatusResponse'] | components['schemas']['NotInitializedStatusResponse'] | components['schemas']['FailureStatusResponse'];
|
|
1646
|
+
Version: {
|
|
1647
|
+
version: string;
|
|
1648
|
+
/** Format: date-time */
|
|
1649
|
+
commit_ts: string;
|
|
1650
|
+
};
|
|
1651
|
+
Contract: {
|
|
1652
|
+
template_id: string;
|
|
1653
|
+
contract_id: string;
|
|
1654
|
+
payload: Record<string, never>;
|
|
1655
|
+
created_event_blob: string;
|
|
1656
|
+
created_at: string;
|
|
1657
|
+
};
|
|
1658
|
+
ContractWithState: {
|
|
1659
|
+
contract: components['schemas']['Contract'];
|
|
1660
|
+
domain_id?: string;
|
|
1661
|
+
};
|
|
1662
|
+
GetDsoInfoResponse: {
|
|
1663
|
+
/** @description User ID representing the SV */
|
|
1664
|
+
sv_user: string;
|
|
1665
|
+
/** @description Party representing the SV */
|
|
1666
|
+
sv_party_id: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* @description Party representing the whole DSO; for Scan only, also returned by
|
|
1669
|
+
* `/v0/dso-party-id`
|
|
1670
|
+
*/
|
|
1671
|
+
dso_party_id: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* @description Threshold required to pass vote requests; also known as the
|
|
1674
|
+
* "governance threshold", it is always derived from the number of
|
|
1675
|
+
* `svs` in `dso_rules`
|
|
1676
|
+
*/
|
|
1677
|
+
voting_threshold: number;
|
|
1678
|
+
/**
|
|
1679
|
+
* @description Contract of the Daml template `Splice.Round.OpenMiningRound`, the
|
|
1680
|
+
* one with the highest round number on the ledger that has been signed
|
|
1681
|
+
* by `dso_party_id`. The round may not be usable as it may not be
|
|
1682
|
+
* opened yet, in accordance with its `opensAt` template field
|
|
1683
|
+
*/
|
|
1684
|
+
latest_mining_round: components['schemas']['ContractWithState'];
|
|
1685
|
+
/**
|
|
1686
|
+
* @description Contract of the Daml template `Splice.AmuletRules.AmuletRules`,
|
|
1687
|
+
* including the full schedule of `AmuletConfig` changes approved by
|
|
1688
|
+
* the DSO. Callers should not assume that `initialValue` is up-to-date,
|
|
1689
|
+
* and should instead search `futureValues` for the latest configuration
|
|
1690
|
+
* valid as of now
|
|
1691
|
+
*/
|
|
1692
|
+
amulet_rules: components['schemas']['ContractWithState'];
|
|
1693
|
+
/**
|
|
1694
|
+
* @description Contract of the Daml template `Splice.DsoRules.DsoRules`, listing
|
|
1695
|
+
* the governance rules approved by the DSO governing this Splice network.
|
|
1696
|
+
*/
|
|
1697
|
+
dso_rules: components['schemas']['ContractWithState'];
|
|
1698
|
+
/**
|
|
1699
|
+
* @description For every one of `svs` listed in `dso_rules`, a contract of the Daml
|
|
1700
|
+
* template `Splice.DSO.SvState.SvNodeState`. This does not include
|
|
1701
|
+
* states for offboarded SVs, though they may still have an on-ledger
|
|
1702
|
+
* state contract
|
|
1703
|
+
*/
|
|
1704
|
+
sv_node_states: components['schemas']['ContractWithState'][];
|
|
1705
|
+
/** @description Initial round from which the network bootstraps */
|
|
1706
|
+
initial_round?: string;
|
|
1707
|
+
};
|
|
1708
|
+
ListValidatorLicensesResponse: {
|
|
1709
|
+
/** @description Contracts of Daml template `Splice.ValidatorLicense:ValidatorLicense`. */
|
|
1710
|
+
validator_licenses: components['schemas']['Contract'][];
|
|
1711
|
+
/**
|
|
1712
|
+
* Format: int64
|
|
1713
|
+
* @description When requesting the next page of results, pass this as URL query parameter `after`.
|
|
1714
|
+
* If absent or `null`, there are no more pages.
|
|
1715
|
+
*/
|
|
1716
|
+
next_page_token?: number;
|
|
1717
|
+
};
|
|
1718
|
+
ContractId: string;
|
|
1719
|
+
MaybeCachedContractWithState: {
|
|
1720
|
+
contract?: components['schemas']['Contract'];
|
|
1721
|
+
domain_id?: string;
|
|
1722
|
+
};
|
|
1723
|
+
/**
|
|
1724
|
+
* @description Always created with respect to an input set of contract IDs. If an input
|
|
1725
|
+
* contract ID is absent from the keys of this map, that contract should be
|
|
1726
|
+
* considered removed by the caller; if present, `contract` may be empty,
|
|
1727
|
+
* reflecting that the caller should already have the full contract data
|
|
1728
|
+
* for that contract ID. Contracts not present in the input set will have
|
|
1729
|
+
* full contract data. `domain_id` is always up-to-date; if undefined the
|
|
1730
|
+
* contract is currently unassigned to a synchronizer, i.e. "in-flight".
|
|
1731
|
+
*/
|
|
1732
|
+
MaybeCachedContractWithStateMap: {
|
|
1733
|
+
[key: string]: components['schemas']['MaybeCachedContractWithState'];
|
|
1734
|
+
};
|
|
1735
|
+
/** @description Contracts of Daml template `Splice.DSO:AmuletPrice:AmuletPriceVote`. */
|
|
1736
|
+
ListAmuletPriceVotesResponse: {
|
|
1737
|
+
amulet_price_votes: components['schemas']['Contract'][];
|
|
1738
|
+
};
|
|
1739
|
+
BatchListVotesByVoteRequestsRequest: {
|
|
1740
|
+
/** @description Contract IDs of Daml template `Splice.DsoRules:VoteRequest`. */
|
|
1741
|
+
vote_request_contract_ids: string[];
|
|
1742
|
+
};
|
|
1743
|
+
ListVoteRequestByTrackingCidResponse: {
|
|
1744
|
+
/**
|
|
1745
|
+
* @description Contracts of Daml template `Splice.DsoRules:VoteRequest` that match
|
|
1746
|
+
* `vote_request_contract_ids` in the request.
|
|
1747
|
+
*/
|
|
1748
|
+
vote_requests: components['schemas']['Contract'][];
|
|
1749
|
+
};
|
|
1750
|
+
/** @description A contract of Daml template `Splice.DsoRules:VoteRequest`. */
|
|
1751
|
+
LookupDsoRulesVoteRequestResponse: {
|
|
1752
|
+
dso_rules_vote_request: components['schemas']['Contract'];
|
|
1753
|
+
};
|
|
1754
|
+
/** @description Contracts of Daml template `Splice.DsoRules:VoteRequest`. */
|
|
1755
|
+
ListDsoRulesVoteRequestsResponse: {
|
|
1756
|
+
dso_rules_vote_requests: components['schemas']['Contract'][];
|
|
1757
|
+
};
|
|
1758
|
+
ListVoteResultsRequest: {
|
|
1759
|
+
actionName?: string;
|
|
1760
|
+
accepted?: boolean;
|
|
1761
|
+
requester?: string;
|
|
1762
|
+
effectiveFrom?: string;
|
|
1763
|
+
effectiveTo?: string;
|
|
1764
|
+
limit: number;
|
|
1765
|
+
};
|
|
1766
|
+
ListDsoRulesVoteResultsResponse: {
|
|
1767
|
+
dso_rules_vote_results: Record<string, never>[];
|
|
1768
|
+
};
|
|
1769
|
+
FeatureSupportResponse: {
|
|
1770
|
+
my_feature: boolean;
|
|
1771
|
+
};
|
|
1772
|
+
};
|
|
1773
|
+
responses: {
|
|
1774
|
+
/** @description bad request */
|
|
1775
|
+
400: {
|
|
1776
|
+
content: {
|
|
1777
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
1778
|
+
};
|
|
1779
|
+
};
|
|
1780
|
+
/** @description not found */
|
|
1781
|
+
404: {
|
|
1782
|
+
content: {
|
|
1783
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
1784
|
+
};
|
|
1785
|
+
};
|
|
1786
|
+
/** @description internal server error */
|
|
1787
|
+
500: {
|
|
1788
|
+
content: {
|
|
1789
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
};
|
|
1793
|
+
parameters: never;
|
|
1794
|
+
requestBodies: never;
|
|
1795
|
+
headers: never;
|
|
1796
|
+
pathItems: never;
|
|
1797
|
+
}
|
|
1798
|
+
export type $defs = Record<string, never>;
|
|
1799
|
+
export type external = Record<string, never>;
|
|
1800
|
+
export interface operations {
|
|
1801
|
+
isReady: {
|
|
1802
|
+
responses: {
|
|
1803
|
+
/** @description ok */
|
|
1804
|
+
200: {
|
|
1805
|
+
content: never;
|
|
1806
|
+
};
|
|
1807
|
+
/** @description service_unavailable */
|
|
1808
|
+
503: {
|
|
1809
|
+
content: never;
|
|
1810
|
+
};
|
|
1811
|
+
};
|
|
1812
|
+
};
|
|
1813
|
+
isLive: {
|
|
1814
|
+
responses: {
|
|
1815
|
+
/** @description ok */
|
|
1816
|
+
200: {
|
|
1817
|
+
content: never;
|
|
1818
|
+
};
|
|
1819
|
+
/** @description service_unavailable */
|
|
1820
|
+
503: {
|
|
1821
|
+
content: never;
|
|
1822
|
+
};
|
|
1823
|
+
};
|
|
1824
|
+
};
|
|
1825
|
+
getHealthStatus: {
|
|
1826
|
+
responses: {
|
|
1827
|
+
/** @description ok */
|
|
1828
|
+
200: {
|
|
1829
|
+
content: {
|
|
1830
|
+
'application/json': components['schemas']['NodeStatus'];
|
|
1831
|
+
};
|
|
1832
|
+
};
|
|
1833
|
+
};
|
|
1834
|
+
};
|
|
1835
|
+
getVersion: {
|
|
1836
|
+
responses: {
|
|
1837
|
+
/** @description ok */
|
|
1838
|
+
200: {
|
|
1839
|
+
content: {
|
|
1840
|
+
'application/json': components['schemas']['Version'];
|
|
1841
|
+
};
|
|
1842
|
+
};
|
|
1843
|
+
};
|
|
1844
|
+
};
|
|
1845
|
+
getDsoInfo: {
|
|
1846
|
+
responses: {
|
|
1847
|
+
/** @description ok */
|
|
1848
|
+
200: {
|
|
1849
|
+
content: {
|
|
1850
|
+
'application/json': components['schemas']['GetDsoInfoResponse'];
|
|
1851
|
+
};
|
|
1852
|
+
};
|
|
1853
|
+
};
|
|
1854
|
+
};
|
|
1855
|
+
/**
|
|
1856
|
+
* @description For every argument that is a valid onboarded validator, return
|
|
1857
|
+
* statistics on its liveness activity, according to on-ledger state at the
|
|
1858
|
+
* time of the request.
|
|
1859
|
+
*/
|
|
1860
|
+
getValidatorFaucetsByValidator: {
|
|
1861
|
+
parameters: {
|
|
1862
|
+
query: {
|
|
1863
|
+
/**
|
|
1864
|
+
* @description A list of validator party IDs, one per specification of the parameter.
|
|
1865
|
+
* Any party IDs not matching onboarded validators will be ignored
|
|
1866
|
+
*/
|
|
1867
|
+
validator_ids: string[];
|
|
1868
|
+
};
|
|
1869
|
+
};
|
|
1870
|
+
responses: {
|
|
1871
|
+
/** @description ok */
|
|
1872
|
+
200: {
|
|
1873
|
+
content: {
|
|
1874
|
+
'application/json': components['schemas']['GetValidatorFaucetsByValidatorResponse'];
|
|
1875
|
+
};
|
|
1876
|
+
};
|
|
1877
|
+
400: components['responses']['400'];
|
|
1878
|
+
404: components['responses']['404'];
|
|
1879
|
+
};
|
|
1880
|
+
};
|
|
1881
|
+
/**
|
|
1882
|
+
* @description Retrieve Canton scan configuration for all SVs, grouped by
|
|
1883
|
+
* connected synchronizer ID
|
|
1884
|
+
*/
|
|
1885
|
+
listDsoScans: {
|
|
1886
|
+
responses: {
|
|
1887
|
+
/** @description ok */
|
|
1888
|
+
200: {
|
|
1889
|
+
content: {
|
|
1890
|
+
'application/json': components['schemas']['ListDsoScansResponse'];
|
|
1891
|
+
};
|
|
1892
|
+
};
|
|
1893
|
+
};
|
|
1894
|
+
};
|
|
1895
|
+
/**
|
|
1896
|
+
* @description List all validators currently approved by members of the DSO, paginated,
|
|
1897
|
+
* sorted newest-first.
|
|
1898
|
+
*/
|
|
1899
|
+
listValidatorLicenses: {
|
|
1900
|
+
parameters: {
|
|
1901
|
+
query?: {
|
|
1902
|
+
/** @description A `next_page_token` from a prior response; if absent, return the first page. */
|
|
1903
|
+
after?: number;
|
|
1904
|
+
/** @description Maximum number of elements to return, 1000 by default. */
|
|
1905
|
+
limit?: number;
|
|
1906
|
+
};
|
|
1907
|
+
};
|
|
1908
|
+
responses: {
|
|
1909
|
+
/** @description ok */
|
|
1910
|
+
200: {
|
|
1911
|
+
content: {
|
|
1912
|
+
'application/json': components['schemas']['ListValidatorLicensesResponse'];
|
|
1913
|
+
};
|
|
1914
|
+
};
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
/**
|
|
1918
|
+
* @description Retrieve Canton sequencer configuration for all SVs, grouped by
|
|
1919
|
+
* connected synchronizer ID
|
|
1920
|
+
*/
|
|
1921
|
+
listDsoSequencers: {
|
|
1922
|
+
responses: {
|
|
1923
|
+
/** @description ok */
|
|
1924
|
+
200: {
|
|
1925
|
+
content: {
|
|
1926
|
+
'application/json': components['schemas']['ListDsoSequencersResponse'];
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
/** @description Retrieve Canton BFT sequencer configuration for this SV, for each configured Synchronizer */
|
|
1932
|
+
listSvBftSequencers: {
|
|
1933
|
+
responses: {
|
|
1934
|
+
/** @description ok */
|
|
1935
|
+
200: {
|
|
1936
|
+
content: {
|
|
1937
|
+
'application/json': components['schemas']['ListSvBftSequencersResponse'];
|
|
1938
|
+
};
|
|
1939
|
+
};
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
/**
|
|
1943
|
+
* @description Get the ID of the participant hosting a given party. This will fail if
|
|
1944
|
+
* there are multiple party-to-participant mappings for the given
|
|
1945
|
+
* synchronizer and party, which is not currently supported.
|
|
1946
|
+
*/
|
|
1947
|
+
getPartyToParticipant: {
|
|
1948
|
+
parameters: {
|
|
1949
|
+
path: {
|
|
1950
|
+
/** @description The synchronizer ID to look up a mapping for. */
|
|
1951
|
+
domain_id: string;
|
|
1952
|
+
/** @description The party ID to lookup a participant ID for. */
|
|
1953
|
+
party_id: string;
|
|
1954
|
+
};
|
|
1955
|
+
};
|
|
1956
|
+
responses: {
|
|
1957
|
+
/** @description ok */
|
|
1958
|
+
200: {
|
|
1959
|
+
content: {
|
|
1960
|
+
'application/json': components['schemas']['GetPartyToParticipantResponse'];
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
404: components['responses']['404'];
|
|
1964
|
+
500: components['responses']['500'];
|
|
1965
|
+
};
|
|
1966
|
+
};
|
|
1967
|
+
/**
|
|
1968
|
+
* @description Get a member's traffic status as reported by the sequencer, according to
|
|
1969
|
+
* ledger state at the time of the request.
|
|
1970
|
+
*/
|
|
1971
|
+
getMemberTrafficStatus: {
|
|
1972
|
+
parameters: {
|
|
1973
|
+
path: {
|
|
1974
|
+
/** @description The synchronizer ID to look up traffic for. */
|
|
1975
|
+
domain_id: string;
|
|
1976
|
+
/**
|
|
1977
|
+
* @description The participant or mediator whose traffic to look up, in the format
|
|
1978
|
+
* `code::id::fingerprint` where `code` is `PAR` or `MED`.
|
|
1979
|
+
*/
|
|
1980
|
+
member_id: string;
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
responses: {
|
|
1984
|
+
/** @description ok */
|
|
1985
|
+
200: {
|
|
1986
|
+
content: {
|
|
1987
|
+
'application/json': components['schemas']['GetMemberTrafficStatusResponse'];
|
|
1988
|
+
};
|
|
1989
|
+
};
|
|
1990
|
+
400: components['responses']['400'];
|
|
1991
|
+
404: components['responses']['404'];
|
|
1992
|
+
500: components['responses']['500'];
|
|
1993
|
+
};
|
|
1994
|
+
};
|
|
1995
|
+
/**
|
|
1996
|
+
* @description Every closed mining round on the ledger still in post-close process for
|
|
1997
|
+
* the connected Splice network, in round number order, earliest-first.
|
|
1998
|
+
*/
|
|
1999
|
+
getClosedRounds: {
|
|
2000
|
+
responses: {
|
|
2001
|
+
/** @description ok */
|
|
2002
|
+
200: {
|
|
2003
|
+
content: {
|
|
2004
|
+
'application/json': components['schemas']['GetClosedRoundsResponse'];
|
|
2005
|
+
};
|
|
2006
|
+
};
|
|
2007
|
+
};
|
|
2008
|
+
};
|
|
2009
|
+
/**
|
|
2010
|
+
* @description All current open and issuing mining rounds, if the request is empty;
|
|
2011
|
+
* passing contract IDs in the request can reduce the response data for
|
|
2012
|
+
* polling/client-cache-update efficiency.
|
|
2013
|
+
*/
|
|
2014
|
+
getOpenAndIssuingMiningRounds: {
|
|
2015
|
+
requestBody: {
|
|
2016
|
+
content: {
|
|
2017
|
+
'application/json': components['schemas']['GetOpenAndIssuingMiningRoundsRequest'];
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
responses: {
|
|
2021
|
+
/** @description ok */
|
|
2022
|
+
200: {
|
|
2023
|
+
content: {
|
|
2024
|
+
'application/json': components['schemas']['GetOpenAndIssuingMiningRoundsResponse'];
|
|
2025
|
+
};
|
|
2026
|
+
};
|
|
2027
|
+
};
|
|
2028
|
+
};
|
|
2029
|
+
/**
|
|
2030
|
+
* @description Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
|
|
2031
|
+
* Compared to `/v1/updates`, the `/v2/updates` removes the `offset` field in responses,
|
|
2032
|
+
* which was hardcoded to 1 in `/v1/updates` for compatibility, and is now removed.
|
|
2033
|
+
* `/v2/updates` sorts events lexicographically in `events_by_id` by `ID` for convenience, which should not be confused with the
|
|
2034
|
+
* order of events in the transaction, for this you should rely on the order of `root_event_ids` and `child_event_ids`.
|
|
2035
|
+
* Updates are ordered lexicographically by `(migration id, record time)`.
|
|
2036
|
+
* For a given migration id, each update has a unique record time.
|
|
2037
|
+
* The record time ranges of different migrations may overlap, i.e.,
|
|
2038
|
+
* it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
|
|
2039
|
+
* and there may be two updates with the same record time but different migration ids.
|
|
2040
|
+
*/
|
|
2041
|
+
getUpdateHistoryV2: {
|
|
2042
|
+
requestBody: {
|
|
2043
|
+
content: {
|
|
2044
|
+
'application/json': components['schemas']['UpdateHistoryRequestV2'];
|
|
2045
|
+
};
|
|
2046
|
+
};
|
|
2047
|
+
responses: {
|
|
2048
|
+
/** @description ok */
|
|
2049
|
+
200: {
|
|
2050
|
+
content: {
|
|
2051
|
+
'application/json': components['schemas']['UpdateHistoryResponseV2'];
|
|
2052
|
+
};
|
|
2053
|
+
};
|
|
2054
|
+
400: components['responses']['400'];
|
|
2055
|
+
500: components['responses']['500'];
|
|
2056
|
+
};
|
|
2057
|
+
};
|
|
2058
|
+
/**
|
|
2059
|
+
* @description Returns the update with the given update_id.
|
|
2060
|
+
* Compared to `/v1/updates/{update_id}`, the `/v2/updates/{update_id}` removes the `offset` field in responses,
|
|
2061
|
+
* which was hardcoded to 1 in `/v1/updates/{update_id}` for compatibility, and is now removed.
|
|
2062
|
+
* `/v2/updates/{update_id}` sorts events lexicographically in `events_by_id` by `ID` for convenience, which should not be confused with the
|
|
2063
|
+
* order of events in the transaction, for this you should rely on the order of `root_event_ids` and `child_event_ids`.
|
|
2064
|
+
*/
|
|
2065
|
+
getUpdateByIdV2: {
|
|
2066
|
+
parameters: {
|
|
2067
|
+
query?: {
|
|
2068
|
+
daml_value_encoding?: components['schemas']['DamlValueEncoding'];
|
|
2069
|
+
};
|
|
2070
|
+
path: {
|
|
2071
|
+
update_id: string;
|
|
2072
|
+
};
|
|
2073
|
+
};
|
|
2074
|
+
responses: {
|
|
2075
|
+
/** @description ok */
|
|
2076
|
+
200: {
|
|
2077
|
+
content: {
|
|
2078
|
+
'application/json': components['schemas']['UpdateHistoryItemV2'];
|
|
2079
|
+
};
|
|
2080
|
+
};
|
|
2081
|
+
400: components['responses']['400'];
|
|
2082
|
+
404: components['responses']['404'];
|
|
2083
|
+
500: components['responses']['500'];
|
|
2084
|
+
};
|
|
2085
|
+
};
|
|
2086
|
+
/**
|
|
2087
|
+
* @deprecated
|
|
2088
|
+
* @description Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
|
|
2089
|
+
* Unlike /v0/updates, this endpoint returns responses that are consistent across different
|
|
2090
|
+
* scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates.
|
|
2091
|
+
*
|
|
2092
|
+
* Updates are ordered lexicographically by `(migration id, record time)`.
|
|
2093
|
+
* For a given migration id, each update has a unique record time.
|
|
2094
|
+
* The record time ranges of different migrations may overlap, i.e.,
|
|
2095
|
+
* it is not guaranteed that the maximum record time of one migration is smaller than the minimum record time of the next migration,
|
|
2096
|
+
* and there may be two updates with the same record time but different migration ids.
|
|
2097
|
+
* The order of items in events_by_id is not defined.
|
|
2098
|
+
*/
|
|
2099
|
+
getUpdateHistoryV1: {
|
|
2100
|
+
requestBody: {
|
|
2101
|
+
content: {
|
|
2102
|
+
'application/json': components['schemas']['UpdateHistoryRequestV1'];
|
|
2103
|
+
};
|
|
2104
|
+
};
|
|
2105
|
+
responses: {
|
|
2106
|
+
/** @description ok */
|
|
2107
|
+
200: {
|
|
2108
|
+
content: {
|
|
2109
|
+
'application/json': components['schemas']['UpdateHistoryResponse'];
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
400: components['responses']['400'];
|
|
2113
|
+
500: components['responses']['500'];
|
|
2114
|
+
};
|
|
2115
|
+
};
|
|
2116
|
+
/**
|
|
2117
|
+
* @deprecated
|
|
2118
|
+
* @description Returns the update with the given update_id.
|
|
2119
|
+
* Unlike /v0/updates/{update_id}, this endpoint returns responses that are consistent across different
|
|
2120
|
+
* scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates.
|
|
2121
|
+
* The order of items in events_by_id is not defined.
|
|
2122
|
+
*/
|
|
2123
|
+
getUpdateByIdV1: {
|
|
2124
|
+
parameters: {
|
|
2125
|
+
query?: {
|
|
2126
|
+
daml_value_encoding?: components['schemas']['DamlValueEncoding'];
|
|
2127
|
+
};
|
|
2128
|
+
path: {
|
|
2129
|
+
update_id: string;
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
responses: {
|
|
2133
|
+
/** @description ok */
|
|
2134
|
+
200: {
|
|
2135
|
+
content: {
|
|
2136
|
+
'application/json': components['schemas']['UpdateHistoryItem'];
|
|
2137
|
+
};
|
|
2138
|
+
};
|
|
2139
|
+
400: components['responses']['400'];
|
|
2140
|
+
404: components['responses']['404'];
|
|
2141
|
+
500: components['responses']['500'];
|
|
2142
|
+
};
|
|
2143
|
+
};
|
|
2144
|
+
/**
|
|
2145
|
+
* @description Returns the timestamp of the most recent snapshot before the given date, for the given migration_id.
|
|
2146
|
+
* This corresponds to the record time of the last transaction in the snapshot.
|
|
2147
|
+
*/
|
|
2148
|
+
getDateOfMostRecentSnapshotBefore: {
|
|
2149
|
+
parameters: {
|
|
2150
|
+
query: {
|
|
2151
|
+
before: string;
|
|
2152
|
+
migration_id: number;
|
|
2153
|
+
};
|
|
2154
|
+
};
|
|
2155
|
+
responses: {
|
|
2156
|
+
/** @description ok */
|
|
2157
|
+
200: {
|
|
2158
|
+
content: {
|
|
2159
|
+
'application/json': components['schemas']['AcsSnapshotTimestampResponse'];
|
|
2160
|
+
};
|
|
2161
|
+
};
|
|
2162
|
+
400: components['responses']['400'];
|
|
2163
|
+
404: components['responses']['404'];
|
|
2164
|
+
500: components['responses']['500'];
|
|
2165
|
+
};
|
|
2166
|
+
};
|
|
2167
|
+
/** @description Returns the ACS in creation date ascending order, paged, for a given migration id and record time. */
|
|
2168
|
+
getAcsSnapshotAt: {
|
|
2169
|
+
requestBody: {
|
|
2170
|
+
content: {
|
|
2171
|
+
'application/json': components['schemas']['AcsRequest'];
|
|
2172
|
+
};
|
|
2173
|
+
};
|
|
2174
|
+
responses: {
|
|
2175
|
+
/** @description ok */
|
|
2176
|
+
200: {
|
|
2177
|
+
content: {
|
|
2178
|
+
'application/json': components['schemas']['AcsResponse'];
|
|
2179
|
+
};
|
|
2180
|
+
};
|
|
2181
|
+
400: components['responses']['400'];
|
|
2182
|
+
404: components['responses']['404'];
|
|
2183
|
+
500: components['responses']['500'];
|
|
2184
|
+
};
|
|
2185
|
+
};
|
|
2186
|
+
/**
|
|
2187
|
+
* @description Takes a snapshot of the ACS at the current time.
|
|
2188
|
+
* The responses can be used as parameters to `/v0/state/acs` to retrieve the snapshot.
|
|
2189
|
+
* Disabled in production environments due to its persistent alteration of
|
|
2190
|
+
* the behavior of future invocations of `/v0/state/acs`, as it causes an
|
|
2191
|
+
* immediate internal snapshot and delay in the next automatic snapshot.
|
|
2192
|
+
*/
|
|
2193
|
+
forceAcsSnapshotNow: {
|
|
2194
|
+
responses: {
|
|
2195
|
+
/** @description ok */
|
|
2196
|
+
200: {
|
|
2197
|
+
content: {
|
|
2198
|
+
'application/json': components['schemas']['ForceAcsSnapshotResponse'];
|
|
2199
|
+
};
|
|
2200
|
+
};
|
|
2201
|
+
400: components['responses']['400'];
|
|
2202
|
+
500: components['responses']['500'];
|
|
2203
|
+
};
|
|
2204
|
+
};
|
|
2205
|
+
/** @description Returns the active amulet contracts for a given migration id and record time, in creation date ascending order, paged. */
|
|
2206
|
+
getHoldingsStateAt: {
|
|
2207
|
+
requestBody: {
|
|
2208
|
+
content: {
|
|
2209
|
+
'application/json': components['schemas']['HoldingsStateRequest'];
|
|
2210
|
+
};
|
|
2211
|
+
};
|
|
2212
|
+
responses: {
|
|
2213
|
+
/** @description ok */
|
|
2214
|
+
200: {
|
|
2215
|
+
content: {
|
|
2216
|
+
'application/json': components['schemas']['AcsResponse'];
|
|
2217
|
+
};
|
|
2218
|
+
};
|
|
2219
|
+
400: components['responses']['400'];
|
|
2220
|
+
404: components['responses']['404'];
|
|
2221
|
+
500: components['responses']['500'];
|
|
2222
|
+
};
|
|
2223
|
+
};
|
|
2224
|
+
/**
|
|
2225
|
+
* @description Returns the summary of active amulet contracts for a given migration id and record time, for the given parties.
|
|
2226
|
+
* This is an aggregate of `/v0/holdings/state` by owner party ID with better performance than client-side computation.
|
|
2227
|
+
*/
|
|
2228
|
+
getHoldingsSummaryAt: {
|
|
2229
|
+
requestBody: {
|
|
2230
|
+
content: {
|
|
2231
|
+
'application/json': components['schemas']['HoldingsSummaryRequest'];
|
|
2232
|
+
};
|
|
2233
|
+
};
|
|
2234
|
+
responses: {
|
|
2235
|
+
/** @description ok */
|
|
2236
|
+
200: {
|
|
2237
|
+
content: {
|
|
2238
|
+
'application/json': components['schemas']['HoldingsSummaryResponse'];
|
|
2239
|
+
};
|
|
2240
|
+
};
|
|
2241
|
+
400: components['responses']['400'];
|
|
2242
|
+
404: components['responses']['404'];
|
|
2243
|
+
500: components['responses']['500'];
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
/**
|
|
2247
|
+
* @description Lists all non-expired ANS entries whose names are prefixed with the
|
|
2248
|
+
* `name_prefix`, up to `page_size` entries.
|
|
2249
|
+
*/
|
|
2250
|
+
listAnsEntries: {
|
|
2251
|
+
parameters: {
|
|
2252
|
+
query: {
|
|
2253
|
+
/**
|
|
2254
|
+
* @description Every result's name will start with this substring; if empty or absent,
|
|
2255
|
+
* all entries will be listed.
|
|
2256
|
+
* Does not have to be a whole word or segment; any substring will be accepted.
|
|
2257
|
+
*/
|
|
2258
|
+
name_prefix?: string;
|
|
2259
|
+
/**
|
|
2260
|
+
* @description The maximum number of results returned.
|
|
2261
|
+
* Older (but still non-expired) results are listed first.
|
|
2262
|
+
*/
|
|
2263
|
+
page_size: number;
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
responses: {
|
|
2267
|
+
/** @description ok */
|
|
2268
|
+
200: {
|
|
2269
|
+
content: {
|
|
2270
|
+
'application/json': components['schemas']['ListEntriesResponse'];
|
|
2271
|
+
};
|
|
2272
|
+
};
|
|
2273
|
+
};
|
|
2274
|
+
};
|
|
2275
|
+
/**
|
|
2276
|
+
* @description If present, the first ANS entry for user `party` according to
|
|
2277
|
+
* `name` lexicographic order.
|
|
2278
|
+
*/
|
|
2279
|
+
lookupAnsEntryByParty: {
|
|
2280
|
+
parameters: {
|
|
2281
|
+
path: {
|
|
2282
|
+
/** @description The user party ID that holds the ANS entry. */
|
|
2283
|
+
party: string;
|
|
2284
|
+
};
|
|
2285
|
+
};
|
|
2286
|
+
responses: {
|
|
2287
|
+
/** @description ok */
|
|
2288
|
+
200: {
|
|
2289
|
+
content: {
|
|
2290
|
+
'application/json': components['schemas']['LookupEntryByPartyResponse'];
|
|
2291
|
+
};
|
|
2292
|
+
};
|
|
2293
|
+
404: components['responses']['404'];
|
|
2294
|
+
};
|
|
2295
|
+
};
|
|
2296
|
+
/** @description If present, the ANS entry named exactly `name`. */
|
|
2297
|
+
lookupAnsEntryByName: {
|
|
2298
|
+
parameters: {
|
|
2299
|
+
path: {
|
|
2300
|
+
name: string;
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
responses: {
|
|
2304
|
+
/** @description ok */
|
|
2305
|
+
200: {
|
|
2306
|
+
content: {
|
|
2307
|
+
'application/json': components['schemas']['LookupEntryByNameResponse'];
|
|
2308
|
+
};
|
|
2309
|
+
};
|
|
2310
|
+
404: components['responses']['404'];
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
/** @description The party ID of the DSO for the Splice network connected by this Scan app. */
|
|
2314
|
+
getDsoPartyId: {
|
|
2315
|
+
responses: {
|
|
2316
|
+
/** @description ok */
|
|
2317
|
+
200: {
|
|
2318
|
+
content: {
|
|
2319
|
+
'application/json': components['schemas']['GetDsoPartyIdResponse'];
|
|
2320
|
+
};
|
|
2321
|
+
};
|
|
2322
|
+
};
|
|
2323
|
+
};
|
|
2324
|
+
getAmuletRules: {
|
|
2325
|
+
requestBody: {
|
|
2326
|
+
content: {
|
|
2327
|
+
'application/json': components['schemas']['GetAmuletRulesRequest'];
|
|
2328
|
+
};
|
|
2329
|
+
};
|
|
2330
|
+
responses: {
|
|
2331
|
+
/** @description ok */
|
|
2332
|
+
200: {
|
|
2333
|
+
content: {
|
|
2334
|
+
'application/json': components['schemas']['GetAmuletRulesResponse'];
|
|
2335
|
+
};
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2338
|
+
};
|
|
2339
|
+
getExternalPartyAmuletRules: {
|
|
2340
|
+
requestBody: {
|
|
2341
|
+
content: {
|
|
2342
|
+
'application/json': components['schemas']['GetExternalPartyAmuletRulesRequest'];
|
|
2343
|
+
};
|
|
2344
|
+
};
|
|
2345
|
+
responses: {
|
|
2346
|
+
/** @description ok */
|
|
2347
|
+
200: {
|
|
2348
|
+
content: {
|
|
2349
|
+
'application/json': components['schemas']['GetExternalPartyAmuletRulesResponse'];
|
|
2350
|
+
};
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
};
|
|
2354
|
+
getAnsRules: {
|
|
2355
|
+
requestBody: {
|
|
2356
|
+
content: {
|
|
2357
|
+
'application/json': components['schemas']['GetAnsRulesRequest'];
|
|
2358
|
+
};
|
|
2359
|
+
};
|
|
2360
|
+
responses: {
|
|
2361
|
+
/** @description ok */
|
|
2362
|
+
200: {
|
|
2363
|
+
content: {
|
|
2364
|
+
'application/json': components['schemas']['GetAnsRulesResponse'];
|
|
2365
|
+
};
|
|
2366
|
+
};
|
|
2367
|
+
};
|
|
2368
|
+
};
|
|
2369
|
+
/** @description List every `FeaturedAppRight` registered with the DSO on the ledger. */
|
|
2370
|
+
listFeaturedAppRights: {
|
|
2371
|
+
responses: {
|
|
2372
|
+
/** @description ok */
|
|
2373
|
+
200: {
|
|
2374
|
+
content: {
|
|
2375
|
+
'application/json': components['schemas']['ListFeaturedAppRightsResponse'];
|
|
2376
|
+
};
|
|
2377
|
+
};
|
|
2378
|
+
};
|
|
2379
|
+
};
|
|
2380
|
+
/**
|
|
2381
|
+
* @description If `provider_party_id` has a `FeaturedAppRight` registered with the DSO,
|
|
2382
|
+
* return it; `featured_app_right` will be empty otherwise.
|
|
2383
|
+
*/
|
|
2384
|
+
lookupFeaturedAppRight: {
|
|
2385
|
+
parameters: {
|
|
2386
|
+
path: {
|
|
2387
|
+
provider_party_id: string;
|
|
2388
|
+
};
|
|
2389
|
+
};
|
|
2390
|
+
responses: {
|
|
2391
|
+
/** @description ok */
|
|
2392
|
+
200: {
|
|
2393
|
+
content: {
|
|
2394
|
+
'application/json': components['schemas']['LookupFeaturedAppRightResponse'];
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
};
|
|
2398
|
+
};
|
|
2399
|
+
/**
|
|
2400
|
+
* @description Get a list of top validators by number of rounds in which they collected
|
|
2401
|
+
* faucets, and basis statistics on their round collection history
|
|
2402
|
+
*/
|
|
2403
|
+
getTopValidatorsByValidatorFaucets: {
|
|
2404
|
+
parameters: {
|
|
2405
|
+
query: {
|
|
2406
|
+
/**
|
|
2407
|
+
* @description Maximum number of validator records that may be returned in the
|
|
2408
|
+
* response
|
|
2409
|
+
*/
|
|
2410
|
+
limit: number;
|
|
2411
|
+
};
|
|
2412
|
+
};
|
|
2413
|
+
responses: {
|
|
2414
|
+
/** @description ok */
|
|
2415
|
+
200: {
|
|
2416
|
+
content: {
|
|
2417
|
+
'application/json': components['schemas']['GetTopValidatorsByValidatorFaucetsResponse'];
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
2420
|
+
400: components['responses']['400'];
|
|
2421
|
+
404: components['responses']['404'];
|
|
2422
|
+
};
|
|
2423
|
+
};
|
|
2424
|
+
/** @description Lookup a TransferPreapproval by the receiver party. */
|
|
2425
|
+
lookupTransferPreapprovalByParty: {
|
|
2426
|
+
parameters: {
|
|
2427
|
+
path: {
|
|
2428
|
+
party: string;
|
|
2429
|
+
};
|
|
2430
|
+
};
|
|
2431
|
+
responses: {
|
|
2432
|
+
/** @description ok */
|
|
2433
|
+
200: {
|
|
2434
|
+
content: {
|
|
2435
|
+
'application/json': components['schemas']['LookupTransferPreapprovalByPartyResponse'];
|
|
2436
|
+
};
|
|
2437
|
+
};
|
|
2438
|
+
404: components['responses']['404'];
|
|
2439
|
+
};
|
|
2440
|
+
};
|
|
2441
|
+
/** @description Lookup a TransferCommandCounter by the receiver party. */
|
|
2442
|
+
lookupTransferCommandCounterByParty: {
|
|
2443
|
+
parameters: {
|
|
2444
|
+
path: {
|
|
2445
|
+
party: string;
|
|
2446
|
+
};
|
|
2447
|
+
};
|
|
2448
|
+
responses: {
|
|
2449
|
+
/** @description ok */
|
|
2450
|
+
200: {
|
|
2451
|
+
content: {
|
|
2452
|
+
'application/json': components['schemas']['LookupTransferCommandCounterByPartyResponse'];
|
|
2453
|
+
};
|
|
2454
|
+
};
|
|
2455
|
+
/** @description No TransferCommandCounter exists for this party. This means the nonce that should be used is 0. */
|
|
2456
|
+
404: components['responses']['404'];
|
|
2457
|
+
};
|
|
2458
|
+
};
|
|
2459
|
+
/** @description Retrieve the status of all transfer commands (up to a limit of 100) of the given sender for the specified nonce. */
|
|
2460
|
+
lookupTransferCommandStatus: {
|
|
2461
|
+
parameters: {
|
|
2462
|
+
query: {
|
|
2463
|
+
sender: string;
|
|
2464
|
+
nonce: number;
|
|
2465
|
+
};
|
|
2466
|
+
};
|
|
2467
|
+
responses: {
|
|
2468
|
+
/** @description ok */
|
|
2469
|
+
200: {
|
|
2470
|
+
content: {
|
|
2471
|
+
'application/json': components['schemas']['LookupTransferCommandStatusResponse'];
|
|
2472
|
+
};
|
|
2473
|
+
};
|
|
2474
|
+
/** @description No TransferCommand exists with this contract id within the last 24h */
|
|
2475
|
+
404: components['responses']['404'];
|
|
2476
|
+
};
|
|
2477
|
+
};
|
|
2478
|
+
/**
|
|
2479
|
+
* @description If the DSO has scheduled a synchronizer upgrade, return its planned time
|
|
2480
|
+
* and the new migration ID.
|
|
2481
|
+
*/
|
|
2482
|
+
getMigrationSchedule: {
|
|
2483
|
+
responses: {
|
|
2484
|
+
/** @description ok */
|
|
2485
|
+
200: {
|
|
2486
|
+
content: {
|
|
2487
|
+
'application/json': components['schemas']['MigrationSchedule'];
|
|
2488
|
+
};
|
|
2489
|
+
};
|
|
2490
|
+
/** @description No migration scheduled */
|
|
2491
|
+
404: {
|
|
2492
|
+
content: never;
|
|
2493
|
+
};
|
|
2494
|
+
};
|
|
2495
|
+
};
|
|
2496
|
+
getSynchronizerIdentities: {
|
|
2497
|
+
parameters: {
|
|
2498
|
+
path: {
|
|
2499
|
+
domain_id_prefix: string;
|
|
2500
|
+
};
|
|
2501
|
+
};
|
|
2502
|
+
responses: {
|
|
2503
|
+
/** @description ok */
|
|
2504
|
+
200: {
|
|
2505
|
+
content: {
|
|
2506
|
+
'application/json': components['schemas']['SynchronizerIdentities'];
|
|
2507
|
+
};
|
|
2508
|
+
};
|
|
2509
|
+
404: components['responses']['404'];
|
|
2510
|
+
};
|
|
2511
|
+
};
|
|
2512
|
+
getSynchronizerBootstrappingTransactions: {
|
|
2513
|
+
parameters: {
|
|
2514
|
+
path: {
|
|
2515
|
+
domain_id_prefix: string;
|
|
2516
|
+
};
|
|
2517
|
+
};
|
|
2518
|
+
responses: {
|
|
2519
|
+
/** @description ok */
|
|
2520
|
+
200: {
|
|
2521
|
+
content: {
|
|
2522
|
+
'application/json': components['schemas']['SynchronizerBootstrappingTransactions'];
|
|
2523
|
+
};
|
|
2524
|
+
};
|
|
2525
|
+
404: components['responses']['404'];
|
|
2526
|
+
};
|
|
2527
|
+
};
|
|
2528
|
+
/** @description Retrieve the UI names of various elements of this Splice network. */
|
|
2529
|
+
getSpliceInstanceNames: {
|
|
2530
|
+
responses: {
|
|
2531
|
+
/** @description ok */
|
|
2532
|
+
200: {
|
|
2533
|
+
content: {
|
|
2534
|
+
'application/json': components['schemas']['GetSpliceInstanceNamesResponse'];
|
|
2535
|
+
};
|
|
2536
|
+
};
|
|
2537
|
+
404: components['responses']['404'];
|
|
2538
|
+
};
|
|
2539
|
+
};
|
|
2540
|
+
/** @description Retrieve a list of the latest amulet price votes */
|
|
2541
|
+
listAmuletPriceVotes: {
|
|
2542
|
+
responses: {
|
|
2543
|
+
/** @description ok */
|
|
2544
|
+
200: {
|
|
2545
|
+
content: {
|
|
2546
|
+
'application/json': components['schemas']['ListAmuletPriceVotesResponse'];
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
};
|
|
2551
|
+
/** @description Look up several `VoteRequest`\ s at once by their contract IDs. */
|
|
2552
|
+
listVoteRequestsByTrackingCid: {
|
|
2553
|
+
requestBody: {
|
|
2554
|
+
content: {
|
|
2555
|
+
'application/json': components['schemas']['BatchListVotesByVoteRequestsRequest'];
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
responses: {
|
|
2559
|
+
/** @description ok */
|
|
2560
|
+
200: {
|
|
2561
|
+
content: {
|
|
2562
|
+
'application/json': components['schemas']['ListVoteRequestByTrackingCidResponse'];
|
|
2563
|
+
};
|
|
2564
|
+
};
|
|
2565
|
+
};
|
|
2566
|
+
};
|
|
2567
|
+
/** @description Look up a `VoteRequest` by contract ID. */
|
|
2568
|
+
lookupDsoRulesVoteRequest: {
|
|
2569
|
+
parameters: {
|
|
2570
|
+
path: {
|
|
2571
|
+
vote_request_contract_id: string;
|
|
2572
|
+
};
|
|
2573
|
+
};
|
|
2574
|
+
responses: {
|
|
2575
|
+
/** @description ok */
|
|
2576
|
+
200: {
|
|
2577
|
+
content: {
|
|
2578
|
+
'application/json': components['schemas']['LookupDsoRulesVoteRequestResponse'];
|
|
2579
|
+
};
|
|
2580
|
+
};
|
|
2581
|
+
/** @description VoteRequest contract not found. */
|
|
2582
|
+
404: {
|
|
2583
|
+
content: {
|
|
2584
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
2585
|
+
};
|
|
2586
|
+
};
|
|
2587
|
+
};
|
|
2588
|
+
};
|
|
2589
|
+
/** @description List all active `VoteRequest`\ s. */
|
|
2590
|
+
listDsoRulesVoteRequests: {
|
|
2591
|
+
responses: {
|
|
2592
|
+
/** @description ok */
|
|
2593
|
+
200: {
|
|
2594
|
+
content: {
|
|
2595
|
+
'application/json': components['schemas']['ListDsoRulesVoteRequestsResponse'];
|
|
2596
|
+
};
|
|
2597
|
+
};
|
|
2598
|
+
};
|
|
2599
|
+
};
|
|
2600
|
+
listVoteRequestResults: {
|
|
2601
|
+
requestBody: {
|
|
2602
|
+
content: {
|
|
2603
|
+
'application/json': components['schemas']['ListVoteResultsRequest'];
|
|
2604
|
+
};
|
|
2605
|
+
};
|
|
2606
|
+
responses: {
|
|
2607
|
+
/** @description ok */
|
|
2608
|
+
200: {
|
|
2609
|
+
content: {
|
|
2610
|
+
'application/json': components['schemas']['ListDsoRulesVoteResultsResponse'];
|
|
2611
|
+
};
|
|
2612
|
+
};
|
|
2613
|
+
};
|
|
2614
|
+
};
|
|
2615
|
+
/** @description List all previous synchronizer migrations in this Splice network's history. */
|
|
2616
|
+
getMigrationInfo: {
|
|
2617
|
+
requestBody: {
|
|
2618
|
+
content: {
|
|
2619
|
+
'application/json': components['schemas']['GetMigrationInfoRequest'];
|
|
2620
|
+
};
|
|
2621
|
+
};
|
|
2622
|
+
responses: {
|
|
2623
|
+
/** @description ok */
|
|
2624
|
+
200: {
|
|
2625
|
+
content: {
|
|
2626
|
+
'application/json': components['schemas']['GetMigrationInfoResponse'];
|
|
2627
|
+
};
|
|
2628
|
+
};
|
|
2629
|
+
404: components['responses']['404'];
|
|
2630
|
+
};
|
|
2631
|
+
};
|
|
2632
|
+
/**
|
|
2633
|
+
* @description Retrieve transactions and synchronizer reassignments prior to the
|
|
2634
|
+
* request's specification.
|
|
2635
|
+
*/
|
|
2636
|
+
getUpdatesBefore: {
|
|
2637
|
+
requestBody: {
|
|
2638
|
+
content: {
|
|
2639
|
+
'application/json': components['schemas']['GetUpdatesBeforeRequest'];
|
|
2640
|
+
};
|
|
2641
|
+
};
|
|
2642
|
+
responses: {
|
|
2643
|
+
/** @description ok */
|
|
2644
|
+
200: {
|
|
2645
|
+
content: {
|
|
2646
|
+
'application/json': components['schemas']['GetUpdatesBeforeResponse'];
|
|
2647
|
+
};
|
|
2648
|
+
};
|
|
2649
|
+
404: components['responses']['404'];
|
|
2650
|
+
};
|
|
2651
|
+
};
|
|
2652
|
+
/** @description Retrieve the status of the backfilling process. */
|
|
2653
|
+
getBackfillingStatus: {
|
|
2654
|
+
responses: {
|
|
2655
|
+
/** @description ok */
|
|
2656
|
+
200: {
|
|
2657
|
+
content: {
|
|
2658
|
+
'application/json': components['schemas']['GetBackfillingStatusResponse'];
|
|
2659
|
+
};
|
|
2660
|
+
};
|
|
2661
|
+
};
|
|
2662
|
+
};
|
|
2663
|
+
/**
|
|
2664
|
+
* @deprecated
|
|
2665
|
+
* @description **Deprecated**. Fetch the current SV participant ACS snapshot for the DSO and `party`.
|
|
2666
|
+
*/
|
|
2667
|
+
getAcsSnapshot: {
|
|
2668
|
+
parameters: {
|
|
2669
|
+
query?: {
|
|
2670
|
+
record_time?: string;
|
|
2671
|
+
};
|
|
2672
|
+
path: {
|
|
2673
|
+
party: string;
|
|
2674
|
+
};
|
|
2675
|
+
};
|
|
2676
|
+
responses: {
|
|
2677
|
+
/** @description ok */
|
|
2678
|
+
200: {
|
|
2679
|
+
content: {
|
|
2680
|
+
'application/json': components['schemas']['GetAcsSnapshotResponse'];
|
|
2681
|
+
};
|
|
2682
|
+
};
|
|
2683
|
+
};
|
|
2684
|
+
};
|
|
2685
|
+
/**
|
|
2686
|
+
* @deprecated
|
|
2687
|
+
* @description **Deprecated**. Retrieve the current earliest and latest rounds aggregated for this Scan.
|
|
2688
|
+
*/
|
|
2689
|
+
getAggregatedRounds: {
|
|
2690
|
+
responses: {
|
|
2691
|
+
/** @description ok */
|
|
2692
|
+
200: {
|
|
2693
|
+
content: {
|
|
2694
|
+
'application/json': components['schemas']['GetAggregatedRoundsResponse'];
|
|
2695
|
+
};
|
|
2696
|
+
};
|
|
2697
|
+
404: components['responses']['404'];
|
|
2698
|
+
};
|
|
2699
|
+
};
|
|
2700
|
+
/**
|
|
2701
|
+
* @deprecated
|
|
2702
|
+
* @description **Deprecated**. List Amulet statistics for up to 200 closed rounds.
|
|
2703
|
+
*/
|
|
2704
|
+
listRoundTotals: {
|
|
2705
|
+
requestBody: {
|
|
2706
|
+
content: {
|
|
2707
|
+
'application/json': components['schemas']['ListRoundTotalsRequest'];
|
|
2708
|
+
};
|
|
2709
|
+
};
|
|
2710
|
+
responses: {
|
|
2711
|
+
/** @description ok */
|
|
2712
|
+
200: {
|
|
2713
|
+
content: {
|
|
2714
|
+
'application/json': components['schemas']['ListRoundTotalsResponse'];
|
|
2715
|
+
};
|
|
2716
|
+
};
|
|
2717
|
+
400: components['responses']['400'];
|
|
2718
|
+
404: components['responses']['404'];
|
|
2719
|
+
500: components['responses']['500'];
|
|
2720
|
+
};
|
|
2721
|
+
};
|
|
2722
|
+
/**
|
|
2723
|
+
* @deprecated
|
|
2724
|
+
* @description **Deprecated**. Retrieve per-party Amulet statistics for up to 50 closed rounds.
|
|
2725
|
+
*/
|
|
2726
|
+
listRoundPartyTotals: {
|
|
2727
|
+
requestBody: {
|
|
2728
|
+
content: {
|
|
2729
|
+
'application/json': components['schemas']['ListRoundPartyTotalsRequest'];
|
|
2730
|
+
};
|
|
2731
|
+
};
|
|
2732
|
+
responses: {
|
|
2733
|
+
/** @description ok */
|
|
2734
|
+
200: {
|
|
2735
|
+
content: {
|
|
2736
|
+
'application/json': components['schemas']['ListRoundPartyTotalsResponse'];
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
400: components['responses']['400'];
|
|
2740
|
+
404: components['responses']['404'];
|
|
2741
|
+
500: components['responses']['500'];
|
|
2742
|
+
};
|
|
2743
|
+
};
|
|
2744
|
+
/**
|
|
2745
|
+
* @deprecated
|
|
2746
|
+
* @description **Deprecated**. Get the total balance of Amulet in the network
|
|
2747
|
+
*/
|
|
2748
|
+
getTotalAmuletBalance: {
|
|
2749
|
+
parameters: {
|
|
2750
|
+
query: {
|
|
2751
|
+
asOfEndOfRound: number;
|
|
2752
|
+
};
|
|
2753
|
+
};
|
|
2754
|
+
responses: {
|
|
2755
|
+
/** @description ok */
|
|
2756
|
+
200: {
|
|
2757
|
+
content: {
|
|
2758
|
+
'application/json': components['schemas']['GetTotalAmuletBalanceResponse'];
|
|
2759
|
+
};
|
|
2760
|
+
};
|
|
2761
|
+
404: components['responses']['404'];
|
|
2762
|
+
};
|
|
2763
|
+
};
|
|
2764
|
+
/**
|
|
2765
|
+
* @deprecated
|
|
2766
|
+
* @description **Deprecated**, use /v0/holdings/summary with /v0/state/acs/snapshot-timestamp instead. Get the Amulet balance for a specific party at the end of a closed round
|
|
2767
|
+
*/
|
|
2768
|
+
getWalletBalance: {
|
|
2769
|
+
parameters: {
|
|
2770
|
+
query: {
|
|
2771
|
+
party_id: string;
|
|
2772
|
+
asOfEndOfRound: number;
|
|
2773
|
+
};
|
|
2774
|
+
};
|
|
2775
|
+
responses: {
|
|
2776
|
+
/** @description ok */
|
|
2777
|
+
200: {
|
|
2778
|
+
content: {
|
|
2779
|
+
'application/json': components['schemas']['GetWalletBalanceResponse'];
|
|
2780
|
+
};
|
|
2781
|
+
};
|
|
2782
|
+
404: components['responses']['404'];
|
|
2783
|
+
};
|
|
2784
|
+
};
|
|
2785
|
+
/**
|
|
2786
|
+
* @deprecated
|
|
2787
|
+
* @description **Deprecated**. Retrieve some information from the `AmuletRules` selected for the given round
|
|
2788
|
+
*/
|
|
2789
|
+
getAmuletConfigForRound: {
|
|
2790
|
+
parameters: {
|
|
2791
|
+
query: {
|
|
2792
|
+
round: number;
|
|
2793
|
+
};
|
|
2794
|
+
};
|
|
2795
|
+
responses: {
|
|
2796
|
+
/** @description ok */
|
|
2797
|
+
200: {
|
|
2798
|
+
content: {
|
|
2799
|
+
'application/json': components['schemas']['GetAmuletConfigForRoundResponse'];
|
|
2800
|
+
};
|
|
2801
|
+
};
|
|
2802
|
+
404: components['responses']['404'];
|
|
2803
|
+
};
|
|
2804
|
+
};
|
|
2805
|
+
/**
|
|
2806
|
+
* @deprecated
|
|
2807
|
+
* @description **Deprecated**. Get the latest round number for which aggregated data is available and
|
|
2808
|
+
* the ledger effective time at which the round was closed.
|
|
2809
|
+
*/
|
|
2810
|
+
getRoundOfLatestData: {
|
|
2811
|
+
responses: {
|
|
2812
|
+
/** @description ok */
|
|
2813
|
+
200: {
|
|
2814
|
+
content: {
|
|
2815
|
+
'application/json': components['schemas']['GetRoundOfLatestDataResponse'];
|
|
2816
|
+
};
|
|
2817
|
+
};
|
|
2818
|
+
404: components['responses']['404'];
|
|
2819
|
+
};
|
|
2820
|
+
};
|
|
2821
|
+
/**
|
|
2822
|
+
* @deprecated
|
|
2823
|
+
* @description **Deprecated**. Get the total rewards collected ever
|
|
2824
|
+
*/
|
|
2825
|
+
getRewardsCollected: {
|
|
2826
|
+
parameters: {
|
|
2827
|
+
query?: {
|
|
2828
|
+
round?: number;
|
|
2829
|
+
};
|
|
2830
|
+
};
|
|
2831
|
+
responses: {
|
|
2832
|
+
/** @description ok */
|
|
2833
|
+
200: {
|
|
2834
|
+
content: {
|
|
2835
|
+
'application/json': components['schemas']['GetRewardsCollectedResponse'];
|
|
2836
|
+
};
|
|
2837
|
+
};
|
|
2838
|
+
404: components['responses']['404'];
|
|
2839
|
+
};
|
|
2840
|
+
};
|
|
2841
|
+
/**
|
|
2842
|
+
* @deprecated
|
|
2843
|
+
* @description **Deprecated**. Get a list of top-earning app providers, and the total earned app
|
|
2844
|
+
* rewards for each
|
|
2845
|
+
*/
|
|
2846
|
+
getTopProvidersByAppRewards: {
|
|
2847
|
+
parameters: {
|
|
2848
|
+
query: {
|
|
2849
|
+
round: number;
|
|
2850
|
+
limit: number;
|
|
2851
|
+
};
|
|
2852
|
+
};
|
|
2853
|
+
responses: {
|
|
2854
|
+
/** @description ok */
|
|
2855
|
+
200: {
|
|
2856
|
+
content: {
|
|
2857
|
+
'application/json': components['schemas']['GetTopProvidersByAppRewardsResponse'];
|
|
2858
|
+
};
|
|
2859
|
+
};
|
|
2860
|
+
400: components['responses']['400'];
|
|
2861
|
+
404: components['responses']['404'];
|
|
2862
|
+
};
|
|
2863
|
+
};
|
|
2864
|
+
/**
|
|
2865
|
+
* @deprecated
|
|
2866
|
+
* @description **Deprecated**. Get a list of top-earning validators, and the total earned validator
|
|
2867
|
+
* rewards for each
|
|
2868
|
+
*/
|
|
2869
|
+
getTopValidatorsByValidatorRewards: {
|
|
2870
|
+
parameters: {
|
|
2871
|
+
query: {
|
|
2872
|
+
round: number;
|
|
2873
|
+
limit: number;
|
|
2874
|
+
};
|
|
2875
|
+
};
|
|
2876
|
+
responses: {
|
|
2877
|
+
/** @description ok */
|
|
2878
|
+
200: {
|
|
2879
|
+
content: {
|
|
2880
|
+
'application/json': components['schemas']['GetTopValidatorsByValidatorRewardsResponse'];
|
|
2881
|
+
};
|
|
2882
|
+
};
|
|
2883
|
+
400: components['responses']['400'];
|
|
2884
|
+
404: components['responses']['404'];
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
/**
|
|
2888
|
+
* @deprecated
|
|
2889
|
+
* @description **Deprecated**. Get a list of validators and their domain fees spends, sorted by the
|
|
2890
|
+
* amount of extra traffic purchased
|
|
2891
|
+
*/
|
|
2892
|
+
getTopValidatorsByPurchasedTraffic: {
|
|
2893
|
+
parameters: {
|
|
2894
|
+
query: {
|
|
2895
|
+
round: number;
|
|
2896
|
+
limit: number;
|
|
2897
|
+
};
|
|
2898
|
+
};
|
|
2899
|
+
responses: {
|
|
2900
|
+
/** @description ok */
|
|
2901
|
+
200: {
|
|
2902
|
+
content: {
|
|
2903
|
+
'application/json': components['schemas']['GetTopValidatorsByPurchasedTrafficResponse'];
|
|
2904
|
+
};
|
|
2905
|
+
};
|
|
2906
|
+
400: components['responses']['400'];
|
|
2907
|
+
404: components['responses']['404'];
|
|
2908
|
+
};
|
|
2909
|
+
};
|
|
2910
|
+
/**
|
|
2911
|
+
* @deprecated
|
|
2912
|
+
* @description **Deprecated**. Lists activities in descending order, paged, optionally starting after a provided event id.
|
|
2913
|
+
*/
|
|
2914
|
+
listActivity: {
|
|
2915
|
+
requestBody: {
|
|
2916
|
+
content: {
|
|
2917
|
+
'application/json': components['schemas']['ListActivityRequest'];
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
responses: {
|
|
2921
|
+
/** @description ok */
|
|
2922
|
+
200: {
|
|
2923
|
+
content: {
|
|
2924
|
+
'application/json': components['schemas']['ListActivityResponse'];
|
|
2925
|
+
};
|
|
2926
|
+
};
|
|
2927
|
+
404: components['responses']['404'];
|
|
2928
|
+
500: components['responses']['500'];
|
|
2929
|
+
};
|
|
2930
|
+
};
|
|
2931
|
+
/**
|
|
2932
|
+
* @deprecated
|
|
2933
|
+
* @description **Deprecated**. Lists transactions, by default in ascending order, paged, from ledger begin or optionally starting after a provided event id.
|
|
2934
|
+
*/
|
|
2935
|
+
listTransactionHistory: {
|
|
2936
|
+
requestBody: {
|
|
2937
|
+
content: {
|
|
2938
|
+
'application/json': components['schemas']['TransactionHistoryRequest'];
|
|
2939
|
+
};
|
|
2940
|
+
};
|
|
2941
|
+
responses: {
|
|
2942
|
+
/** @description ok */
|
|
2943
|
+
200: {
|
|
2944
|
+
content: {
|
|
2945
|
+
'application/json': components['schemas']['TransactionHistoryResponse'];
|
|
2946
|
+
};
|
|
2947
|
+
};
|
|
2948
|
+
400: components['responses']['400'];
|
|
2949
|
+
404: components['responses']['404'];
|
|
2950
|
+
500: components['responses']['500'];
|
|
2951
|
+
};
|
|
2952
|
+
};
|
|
2953
|
+
/**
|
|
2954
|
+
* @deprecated
|
|
2955
|
+
* @description **Deprecated**, use /v2/updates instead.
|
|
2956
|
+
* Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time.
|
|
2957
|
+
*/
|
|
2958
|
+
getUpdateHistory: {
|
|
2959
|
+
requestBody: {
|
|
2960
|
+
content: {
|
|
2961
|
+
'application/json': components['schemas']['UpdateHistoryRequest'];
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2964
|
+
responses: {
|
|
2965
|
+
/** @description ok */
|
|
2966
|
+
200: {
|
|
2967
|
+
content: {
|
|
2968
|
+
'application/json': components['schemas']['UpdateHistoryResponse'];
|
|
2969
|
+
};
|
|
2970
|
+
};
|
|
2971
|
+
400: components['responses']['400'];
|
|
2972
|
+
500: components['responses']['500'];
|
|
2973
|
+
};
|
|
2974
|
+
};
|
|
2975
|
+
/**
|
|
2976
|
+
* @deprecated
|
|
2977
|
+
* @description **Deprecated**, use /v2/updates/{update_id} instead.
|
|
2978
|
+
*/
|
|
2979
|
+
getUpdateById: {
|
|
2980
|
+
parameters: {
|
|
2981
|
+
query?: {
|
|
2982
|
+
/**
|
|
2983
|
+
* @description Whether contract payload should be encoded into json using a lossless, but much harder to process, encoding.
|
|
2984
|
+
* This is mostly used for backend calls, and is not recommended for external users.
|
|
2985
|
+
* Optional and defaults to false.
|
|
2986
|
+
*/
|
|
2987
|
+
lossless?: boolean;
|
|
2988
|
+
};
|
|
2989
|
+
path: {
|
|
2990
|
+
update_id: string;
|
|
2991
|
+
};
|
|
2992
|
+
};
|
|
2993
|
+
responses: {
|
|
2994
|
+
/** @description ok */
|
|
2995
|
+
200: {
|
|
2996
|
+
content: {
|
|
2997
|
+
'application/json': components['schemas']['UpdateHistoryItem'];
|
|
2998
|
+
};
|
|
2999
|
+
};
|
|
3000
|
+
400: components['responses']['400'];
|
|
3001
|
+
404: components['responses']['404'];
|
|
3002
|
+
500: components['responses']['500'];
|
|
3003
|
+
};
|
|
3004
|
+
};
|
|
3005
|
+
featureSupport: {
|
|
3006
|
+
responses: {
|
|
3007
|
+
/** @description ok */
|
|
3008
|
+
200: {
|
|
3009
|
+
content: {
|
|
3010
|
+
'application/json': components['schemas']['FeatureSupportResponse'];
|
|
3011
|
+
};
|
|
3012
|
+
};
|
|
3013
|
+
500: components['responses']['500'];
|
|
3014
|
+
};
|
|
3015
|
+
};
|
|
3016
|
+
getImportUpdates: {
|
|
3017
|
+
requestBody: {
|
|
3018
|
+
content: {
|
|
3019
|
+
'application/json': components['schemas']['GetImportUpdatesRequest'];
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
responses: {
|
|
3023
|
+
/** @description ok */
|
|
3024
|
+
200: {
|
|
3025
|
+
content: {
|
|
3026
|
+
'application/json': components['schemas']['GetImportUpdatesResponse'];
|
|
3027
|
+
};
|
|
3028
|
+
};
|
|
3029
|
+
404: components['responses']['404'];
|
|
3030
|
+
};
|
|
3031
|
+
};
|
|
3032
|
+
}
|
|
3033
|
+
//# sourceMappingURL=scan.d.ts.map
|