@canton-network/core-splice-client 0.16.2 → 0.17.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 +309 -37
- package/dist/generated-clients/scan-proxy.d.ts.map +1 -1
- package/dist/generated-clients/scan.d.ts +1754 -474
- package/dist/generated-clients/scan.d.ts.map +1 -1
- package/dist/generated-clients/validator-internal.d.ts +533 -161
- package/dist/generated-clients/validator-internal.d.ts.map +1 -1
- package/package.json +3 -3
|
@@ -1,149 +1,393 @@
|
|
|
1
1
|
export interface paths {
|
|
2
2
|
'/readyz': {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
3
9
|
get: operations['isReady'];
|
|
10
|
+
put?: never;
|
|
11
|
+
post?: never;
|
|
12
|
+
delete?: never;
|
|
13
|
+
options?: never;
|
|
14
|
+
head?: never;
|
|
15
|
+
patch?: never;
|
|
16
|
+
trace?: never;
|
|
4
17
|
};
|
|
5
18
|
'/livez': {
|
|
19
|
+
parameters: {
|
|
20
|
+
query?: never;
|
|
21
|
+
header?: never;
|
|
22
|
+
path?: never;
|
|
23
|
+
cookie?: never;
|
|
24
|
+
};
|
|
6
25
|
get: operations['isLive'];
|
|
26
|
+
put?: never;
|
|
27
|
+
post?: never;
|
|
28
|
+
delete?: never;
|
|
29
|
+
options?: never;
|
|
30
|
+
head?: never;
|
|
31
|
+
patch?: never;
|
|
32
|
+
trace?: never;
|
|
7
33
|
};
|
|
8
34
|
'/v0/validator-user': {
|
|
35
|
+
parameters: {
|
|
36
|
+
query?: never;
|
|
37
|
+
header?: never;
|
|
38
|
+
path?: never;
|
|
39
|
+
cookie?: never;
|
|
40
|
+
};
|
|
9
41
|
/** @description Get public information about the validator operator. */
|
|
10
42
|
get: operations['getValidatorUserInfo'];
|
|
43
|
+
put?: never;
|
|
44
|
+
post?: never;
|
|
45
|
+
delete?: never;
|
|
46
|
+
options?: never;
|
|
47
|
+
head?: never;
|
|
48
|
+
patch?: never;
|
|
49
|
+
trace?: never;
|
|
11
50
|
};
|
|
12
51
|
'/v0/register': {
|
|
52
|
+
parameters: {
|
|
53
|
+
query?: never;
|
|
54
|
+
header?: never;
|
|
55
|
+
path?: never;
|
|
56
|
+
cookie?: never;
|
|
57
|
+
};
|
|
58
|
+
get?: never;
|
|
59
|
+
put?: never;
|
|
13
60
|
/**
|
|
14
61
|
* @description As an authenticated user, onboard yourself.
|
|
15
|
-
*
|
|
16
|
-
*
|
|
62
|
+
* Onboarding includes allocating a ledger API user and daml party,
|
|
63
|
+
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
17
64
|
*
|
|
18
|
-
*
|
|
65
|
+
* The ledger API user name is taken from the subject claim of the JWT token.
|
|
19
66
|
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
67
|
+
* Once this call returns a successful response, the user is fully onboarded.
|
|
68
|
+
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
69
|
+
* to check the status of the user onboarding.
|
|
23
70
|
*/
|
|
24
71
|
post: operations['register'];
|
|
72
|
+
delete?: never;
|
|
73
|
+
options?: never;
|
|
74
|
+
head?: never;
|
|
75
|
+
patch?: never;
|
|
76
|
+
trace?: never;
|
|
25
77
|
};
|
|
26
78
|
'/v0/admin/users': {
|
|
79
|
+
parameters: {
|
|
80
|
+
query?: never;
|
|
81
|
+
header?: never;
|
|
82
|
+
path?: never;
|
|
83
|
+
cookie?: never;
|
|
84
|
+
};
|
|
27
85
|
/** @description Lists all users onboarded onto this validator. */
|
|
28
86
|
get: operations['listUsers'];
|
|
87
|
+
put?: never;
|
|
29
88
|
/**
|
|
30
89
|
* @description As the validator operator, onboard an arbitrary user specified in the request.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
90
|
+
* Onboarding includes allocating a ledger API user and daml party,
|
|
91
|
+
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
33
92
|
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
93
|
+
* Once this call returns a successful response, the user is fully onboarded.
|
|
94
|
+
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
95
|
+
* to check the status of the user onboarding.
|
|
37
96
|
*/
|
|
38
97
|
post: operations['onboardUser'];
|
|
98
|
+
delete?: never;
|
|
99
|
+
options?: never;
|
|
100
|
+
head?: never;
|
|
101
|
+
patch?: never;
|
|
102
|
+
trace?: never;
|
|
39
103
|
};
|
|
40
104
|
'/v0/admin/users/offboard': {
|
|
105
|
+
parameters: {
|
|
106
|
+
query?: never;
|
|
107
|
+
header?: never;
|
|
108
|
+
path?: never;
|
|
109
|
+
cookie?: never;
|
|
110
|
+
};
|
|
111
|
+
get?: never;
|
|
112
|
+
put?: never;
|
|
41
113
|
/**
|
|
42
114
|
* @description As the validator operator, offboard the user specified in the request.
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
115
|
+
* Offboarding archives the daml contracts required for the user to use a wallet on this validator.
|
|
116
|
+
* Offboarding deletes the ledger API user.
|
|
117
|
+
* Offboarding does not archive any other daml contracts owned by the user.
|
|
46
118
|
*/
|
|
47
119
|
post: operations['offboardUser'];
|
|
120
|
+
delete?: never;
|
|
121
|
+
options?: never;
|
|
122
|
+
head?: never;
|
|
123
|
+
patch?: never;
|
|
124
|
+
trace?: never;
|
|
48
125
|
};
|
|
49
126
|
'/v0/admin/participant/identities': {
|
|
127
|
+
parameters: {
|
|
128
|
+
query?: never;
|
|
129
|
+
header?: never;
|
|
130
|
+
path?: never;
|
|
131
|
+
cookie?: never;
|
|
132
|
+
};
|
|
50
133
|
/**
|
|
51
134
|
* @description Returns a dump of participant identities.
|
|
52
135
|
*
|
|
53
|
-
*
|
|
136
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
54
137
|
*/
|
|
55
138
|
get: operations['dumpParticipantIdentities'];
|
|
139
|
+
put?: never;
|
|
140
|
+
post?: never;
|
|
141
|
+
delete?: never;
|
|
142
|
+
options?: never;
|
|
143
|
+
head?: never;
|
|
144
|
+
patch?: never;
|
|
145
|
+
trace?: never;
|
|
56
146
|
};
|
|
57
147
|
'/v0/admin/participant/global-domain-connection-config': {
|
|
148
|
+
parameters: {
|
|
149
|
+
query?: never;
|
|
150
|
+
header?: never;
|
|
151
|
+
path?: never;
|
|
152
|
+
cookie?: never;
|
|
153
|
+
};
|
|
58
154
|
/**
|
|
59
155
|
* @description Returns the connection configuration for the global synchronizer.
|
|
60
156
|
*
|
|
61
|
-
*
|
|
157
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
62
158
|
*/
|
|
63
159
|
get: operations['getDecentralizedSynchronizerConnectionConfig'];
|
|
160
|
+
put?: never;
|
|
161
|
+
post?: never;
|
|
162
|
+
delete?: never;
|
|
163
|
+
options?: never;
|
|
164
|
+
head?: never;
|
|
165
|
+
patch?: never;
|
|
166
|
+
trace?: never;
|
|
64
167
|
};
|
|
65
168
|
'/v0/admin/domain/data-snapshot': {
|
|
169
|
+
parameters: {
|
|
170
|
+
query?: never;
|
|
171
|
+
header?: never;
|
|
172
|
+
path?: never;
|
|
173
|
+
cookie?: never;
|
|
174
|
+
};
|
|
66
175
|
/**
|
|
67
176
|
* @description Returns a snapshot of the global synchronizer data for this validator.
|
|
68
|
-
*
|
|
177
|
+
* The snapshot includes a list of parties, the active contract set (ACS), and node identities.
|
|
69
178
|
*
|
|
70
|
-
*
|
|
179
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
71
180
|
*/
|
|
72
181
|
get: operations['getValidatorDomainDataSnapshot'];
|
|
182
|
+
put?: never;
|
|
183
|
+
post?: never;
|
|
184
|
+
delete?: never;
|
|
185
|
+
options?: never;
|
|
186
|
+
head?: never;
|
|
187
|
+
patch?: never;
|
|
188
|
+
trace?: never;
|
|
73
189
|
};
|
|
74
190
|
'/v0/admin/transfer-preapprovals/by-party/{receiver-party}': {
|
|
191
|
+
parameters: {
|
|
192
|
+
query?: never;
|
|
193
|
+
header?: never;
|
|
194
|
+
path?: never;
|
|
195
|
+
cookie?: never;
|
|
196
|
+
};
|
|
75
197
|
/** @description Lookup the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
76
198
|
get: operations['lookupTransferPreapprovalByParty'];
|
|
199
|
+
put?: never;
|
|
200
|
+
post?: never;
|
|
77
201
|
/** @description Remove the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
78
202
|
delete: operations['cancelTransferPreapprovalByParty'];
|
|
203
|
+
options?: never;
|
|
204
|
+
head?: never;
|
|
205
|
+
patch?: never;
|
|
206
|
+
trace?: never;
|
|
79
207
|
};
|
|
80
208
|
'/v0/admin/transfer-preapprovals': {
|
|
209
|
+
parameters: {
|
|
210
|
+
query?: never;
|
|
211
|
+
header?: never;
|
|
212
|
+
path?: never;
|
|
213
|
+
cookie?: never;
|
|
214
|
+
};
|
|
81
215
|
/** @description List all `Splice.AmuletRules.TransferPreapproval` contracts where the preapproval provider is the validator operator. */
|
|
82
216
|
get: operations['listTransferPreapprovals'];
|
|
217
|
+
put?: never;
|
|
218
|
+
post?: never;
|
|
219
|
+
delete?: never;
|
|
220
|
+
options?: never;
|
|
221
|
+
head?: never;
|
|
222
|
+
patch?: never;
|
|
223
|
+
trace?: never;
|
|
83
224
|
};
|
|
84
225
|
'/v0/admin/external-party/transfer-preapproval/prepare-send': {
|
|
226
|
+
parameters: {
|
|
227
|
+
query?: never;
|
|
228
|
+
header?: never;
|
|
229
|
+
path?: never;
|
|
230
|
+
cookie?: never;
|
|
231
|
+
};
|
|
232
|
+
get?: never;
|
|
233
|
+
put?: never;
|
|
85
234
|
/**
|
|
86
235
|
* @description Prepare a transaction to create a TransferCommand with the given CC amount to the specified receiver
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
236
|
+
* from the externally hosted sender.
|
|
237
|
+
* The transaction then needs to be signed and submitted through
|
|
238
|
+
* /v0/admin/external-party/transfer-preapproval/submit-send.
|
|
90
239
|
*/
|
|
91
240
|
post: operations['prepareTransferPreapprovalSend'];
|
|
241
|
+
delete?: never;
|
|
242
|
+
options?: never;
|
|
243
|
+
head?: never;
|
|
244
|
+
patch?: never;
|
|
245
|
+
trace?: never;
|
|
92
246
|
};
|
|
93
247
|
'/v0/admin/external-party/transfer-preapproval/submit-send': {
|
|
248
|
+
parameters: {
|
|
249
|
+
query?: never;
|
|
250
|
+
header?: never;
|
|
251
|
+
path?: never;
|
|
252
|
+
cookie?: never;
|
|
253
|
+
};
|
|
254
|
+
get?: never;
|
|
255
|
+
put?: never;
|
|
94
256
|
/**
|
|
95
257
|
* @description Submit transaction generated by /v0/admin/transfer-preapproval/prepare-send
|
|
96
|
-
*
|
|
97
|
-
*
|
|
258
|
+
* together with its signature. Note that this only waits until the TransferCommand is created.
|
|
259
|
+
* The actual transfer will happen afterwards through automation run by the SVs.
|
|
98
260
|
*/
|
|
99
261
|
post: operations['submitTransferPreapprovalSend'];
|
|
262
|
+
delete?: never;
|
|
263
|
+
options?: never;
|
|
264
|
+
head?: never;
|
|
265
|
+
patch?: never;
|
|
266
|
+
trace?: never;
|
|
100
267
|
};
|
|
101
268
|
'/v0/admin/external-party/topology/generate': {
|
|
269
|
+
parameters: {
|
|
270
|
+
query?: never;
|
|
271
|
+
header?: never;
|
|
272
|
+
path?: never;
|
|
273
|
+
cookie?: never;
|
|
274
|
+
};
|
|
275
|
+
get?: never;
|
|
276
|
+
put?: never;
|
|
102
277
|
/**
|
|
103
278
|
* @description Creates a root namespace topology transaction, which will create the party and sets the public key
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
279
|
+
* controlling the party namespace,
|
|
280
|
+
* a party to participant mapping topology transaction, which hosts the party on the participant with Confirmation rights,
|
|
281
|
+
* and a party to key mapping topology transaction, which sets the key to authorize daml transactions.
|
|
282
|
+
* The hash of each of these transactions will be signed along with the corresponding topology transaction (unchanged)
|
|
283
|
+
* in the /v0/admin/external-party/topology/submit endpoint
|
|
109
284
|
*/
|
|
110
285
|
post: operations['generateExternalPartyTopology'];
|
|
286
|
+
delete?: never;
|
|
287
|
+
options?: never;
|
|
288
|
+
head?: never;
|
|
289
|
+
patch?: never;
|
|
290
|
+
trace?: never;
|
|
111
291
|
};
|
|
112
292
|
'/v0/admin/external-party/topology/submit': {
|
|
293
|
+
parameters: {
|
|
294
|
+
query?: never;
|
|
295
|
+
header?: never;
|
|
296
|
+
path?: never;
|
|
297
|
+
cookie?: never;
|
|
298
|
+
};
|
|
299
|
+
get?: never;
|
|
300
|
+
put?: never;
|
|
113
301
|
/**
|
|
114
302
|
* @description Constructs a SignedTopologyTransaction and writes the topology transactions to the authorized store.
|
|
115
|
-
*
|
|
303
|
+
* The input will consist of the unchanged topology transaction and the signed hash from the /v0/external-party-topology/generate endpoint
|
|
116
304
|
*/
|
|
117
305
|
post: operations['submitExternalPartyTopology'];
|
|
306
|
+
delete?: never;
|
|
307
|
+
options?: never;
|
|
308
|
+
head?: never;
|
|
309
|
+
patch?: never;
|
|
310
|
+
trace?: never;
|
|
118
311
|
};
|
|
119
312
|
'/v0/admin/external-party/setup-proposal': {
|
|
313
|
+
parameters: {
|
|
314
|
+
query?: never;
|
|
315
|
+
header?: never;
|
|
316
|
+
path?: never;
|
|
317
|
+
cookie?: never;
|
|
318
|
+
};
|
|
120
319
|
/** @description List all ExternalPartySetupProposal contracts. */
|
|
121
320
|
get: operations['listExternalPartySetupProposals'];
|
|
321
|
+
put?: never;
|
|
122
322
|
/**
|
|
123
323
|
* @description Create the ExternalPartySetupProposal contract as the validator operator
|
|
124
|
-
*
|
|
125
|
-
*
|
|
324
|
+
* which then has to be accepted by the external party using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
325
|
+
* and /v0/admin/external-party/setup-proposal/submit-accept
|
|
126
326
|
*/
|
|
127
327
|
post: operations['createExternalPartySetupProposal'];
|
|
328
|
+
delete?: never;
|
|
329
|
+
options?: never;
|
|
330
|
+
head?: never;
|
|
331
|
+
patch?: never;
|
|
332
|
+
trace?: never;
|
|
128
333
|
};
|
|
129
334
|
'/v0/admin/external-party/setup-proposal/prepare-accept': {
|
|
335
|
+
parameters: {
|
|
336
|
+
query?: never;
|
|
337
|
+
header?: never;
|
|
338
|
+
path?: never;
|
|
339
|
+
cookie?: never;
|
|
340
|
+
};
|
|
341
|
+
get?: never;
|
|
342
|
+
put?: never;
|
|
130
343
|
/**
|
|
131
344
|
* @description Given a contract id of an ExternalPartySetupProposal, prepare the transaction
|
|
132
|
-
*
|
|
133
|
-
*
|
|
345
|
+
* to accept it such that it can be signed externally and then submitted using
|
|
346
|
+
* /v0/admin/external-party/setup-proposal/submit-accept
|
|
134
347
|
*/
|
|
135
348
|
post: operations['prepareAcceptExternalPartySetupProposal'];
|
|
349
|
+
delete?: never;
|
|
350
|
+
options?: never;
|
|
351
|
+
head?: never;
|
|
352
|
+
patch?: never;
|
|
353
|
+
trace?: never;
|
|
136
354
|
};
|
|
137
355
|
'/v0/admin/external-party/setup-proposal/submit-accept': {
|
|
356
|
+
parameters: {
|
|
357
|
+
query?: never;
|
|
358
|
+
header?: never;
|
|
359
|
+
path?: never;
|
|
360
|
+
cookie?: never;
|
|
361
|
+
};
|
|
362
|
+
get?: never;
|
|
363
|
+
put?: never;
|
|
138
364
|
/**
|
|
139
365
|
* @description Submit a transaction prepared using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
140
|
-
*
|
|
366
|
+
* together with its signature.
|
|
141
367
|
*/
|
|
142
368
|
post: operations['submitAcceptExternalPartySetupProposal'];
|
|
369
|
+
delete?: never;
|
|
370
|
+
options?: never;
|
|
371
|
+
head?: never;
|
|
372
|
+
patch?: never;
|
|
373
|
+
trace?: never;
|
|
143
374
|
};
|
|
144
375
|
'/v0/admin/external-party/balance': {
|
|
376
|
+
parameters: {
|
|
377
|
+
query?: never;
|
|
378
|
+
header?: never;
|
|
379
|
+
path?: never;
|
|
380
|
+
cookie?: never;
|
|
381
|
+
};
|
|
145
382
|
/** @description Get the balance of an external party. */
|
|
146
383
|
get: operations['getExternalPartyBalance'];
|
|
384
|
+
put?: never;
|
|
385
|
+
post?: never;
|
|
386
|
+
delete?: never;
|
|
387
|
+
options?: never;
|
|
388
|
+
head?: never;
|
|
389
|
+
patch?: never;
|
|
390
|
+
trace?: never;
|
|
147
391
|
};
|
|
148
392
|
}
|
|
149
393
|
export type webhooks = Record<string, never>;
|
|
@@ -153,7 +397,7 @@ export interface components {
|
|
|
153
397
|
name: string;
|
|
154
398
|
/**
|
|
155
399
|
* @description The party id of the user to onboard. This is optional and if not provided
|
|
156
|
-
*
|
|
400
|
+
* a fresh party id will be generated by the backend.
|
|
157
401
|
*/
|
|
158
402
|
party_id?: string;
|
|
159
403
|
};
|
|
@@ -189,16 +433,16 @@ export interface components {
|
|
|
189
433
|
SignedTopologyTx: {
|
|
190
434
|
/**
|
|
191
435
|
* @description base64 encoded topology transaction, this should be identical to the topology transaction
|
|
192
|
-
*
|
|
436
|
+
* received from the /v0/external-party-topology/generate endpoint.
|
|
193
437
|
*/
|
|
194
438
|
topology_tx: string;
|
|
195
439
|
/**
|
|
196
440
|
* @description hex-encoded ed25519 signature of the hash return by the generate endpoint in the form
|
|
197
|
-
*
|
|
441
|
+
* `${r}${s}`.
|
|
198
442
|
*/
|
|
199
443
|
signed_hash: string;
|
|
200
444
|
};
|
|
201
|
-
RegistrationRequest: Record<string,
|
|
445
|
+
RegistrationRequest: Record<string, never> | null;
|
|
202
446
|
RegistrationResponse: {
|
|
203
447
|
/** @description The party id of the user that was onboarded. */
|
|
204
448
|
party_id: string;
|
|
@@ -270,26 +514,25 @@ export interface components {
|
|
|
270
514
|
user_party_id: string;
|
|
271
515
|
/**
|
|
272
516
|
* @description When true, the response will contain additional details on how the transaction was encoded and hashed.
|
|
273
|
-
*
|
|
274
|
-
*
|
|
517
|
+
* This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
|
|
275
518
|
* @default false
|
|
276
519
|
*/
|
|
277
|
-
verbose_hashing
|
|
520
|
+
verbose_hashing: boolean;
|
|
278
521
|
};
|
|
279
522
|
PrepareAcceptExternalPartySetupProposalResponse: {
|
|
280
523
|
/**
|
|
281
524
|
* @description base64-encoded transaction. The transaction corresponds to
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
525
|
+
* the protobuf definition of a `PreparedTransaction`
|
|
526
|
+
* https://github.com/digital-asset/canton/blob/main/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive_submission_data.proto#L18
|
|
527
|
+
* and can be decoded using standard protobuf libraries.
|
|
285
528
|
*/
|
|
286
529
|
transaction: string;
|
|
287
530
|
/** @description Hex-encoded hash of the transaction */
|
|
288
531
|
tx_hash: string;
|
|
289
532
|
/**
|
|
290
533
|
* @description Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing=true in the request.
|
|
291
|
-
*
|
|
292
|
-
*
|
|
534
|
+
* Note that there are no guarantees on the stability of the format or content of this field.
|
|
535
|
+
* Its content should NOT be parsed and should only be used for troubleshooting purposes.
|
|
293
536
|
*/
|
|
294
537
|
hashing_details?: string;
|
|
295
538
|
};
|
|
@@ -327,39 +570,38 @@ export interface components {
|
|
|
327
570
|
/**
|
|
328
571
|
* Format: int64
|
|
329
572
|
* @description The expected value of the counter that is used to order and deduplicate TransferCommands. Starts at 0 and increases
|
|
330
|
-
*
|
|
331
|
-
*
|
|
573
|
+
* by 1 for each executed TransferCommand (independent of whether is succeeded or not). The most recent value can be read from scan
|
|
574
|
+
* through /v0/transfer-command-counter/{party}
|
|
332
575
|
*/
|
|
333
576
|
nonce: number;
|
|
334
577
|
/**
|
|
335
578
|
* @description When true, the response will contain additional details on how the transaction was encoded and hashed.
|
|
336
|
-
*
|
|
337
|
-
*
|
|
579
|
+
* This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
|
|
338
580
|
* @default false
|
|
339
581
|
*/
|
|
340
|
-
verbose_hashing
|
|
582
|
+
verbose_hashing: boolean;
|
|
341
583
|
description?: string;
|
|
342
584
|
};
|
|
343
585
|
PrepareTransferPreapprovalSendResponse: {
|
|
344
586
|
/**
|
|
345
587
|
* @description base64-encoded transaction. The transaction corresponds to
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
588
|
+
* the protobuf definition of a `PreparedTransaction`
|
|
589
|
+
* https://github.com/digital-asset/canton/blob/main/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive_submission_data.proto#L18
|
|
590
|
+
* and can be decoded using standard protobuf libraries.
|
|
349
591
|
*/
|
|
350
592
|
transaction: string;
|
|
351
593
|
/** @description Hex-encoded hash of the transaction */
|
|
352
594
|
tx_hash: string;
|
|
353
595
|
/**
|
|
354
596
|
* @description Prefix of the ContractId of the created TransferCommand. Matches the contract id of the corresponding `Create` node in the prepared transaction which
|
|
355
|
-
*
|
|
356
|
-
*
|
|
597
|
+
* also only contains the prefix. The final transaction observed on the update stream or in the result of looking up the transfer command status on Scan
|
|
598
|
+
* adds an additional suffix to the contract id.
|
|
357
599
|
*/
|
|
358
600
|
transfer_command_contract_id_prefix: string;
|
|
359
601
|
/**
|
|
360
602
|
* @description Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing=true in the request.
|
|
361
|
-
*
|
|
362
|
-
*
|
|
603
|
+
* Note that there are no guarantees on the stability of the format or content of this field.
|
|
604
|
+
* Its content should NOT be parsed and should only be used for troubleshooting purposes.
|
|
363
605
|
*/
|
|
364
606
|
hashing_details?: string;
|
|
365
607
|
};
|
|
@@ -373,14 +615,14 @@ export interface components {
|
|
|
373
615
|
party_id: string;
|
|
374
616
|
/**
|
|
375
617
|
* @description base64-encoded transaction. The transaction corresponds to
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
618
|
+
* the protobuf definition of a `PreparedTransaction`
|
|
619
|
+
* https://github.com/digital-asset/canton/blob/main/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive_submission_data.proto#L18
|
|
620
|
+
* and can be decoded using standard protobuf libraries.
|
|
379
621
|
*/
|
|
380
622
|
transaction: string;
|
|
381
623
|
/**
|
|
382
624
|
* @description hex-encoded ed25519 signature of the hash return by the prepare endpoint in the form
|
|
383
|
-
*
|
|
625
|
+
* `${r}${s}`.
|
|
384
626
|
*/
|
|
385
627
|
signed_tx_hash: string;
|
|
386
628
|
/** @description hex-encoded ed25519 public key */
|
|
@@ -431,8 +673,8 @@ export interface components {
|
|
|
431
673
|
/** @default false */
|
|
432
674
|
isDeactivated: boolean;
|
|
433
675
|
annotations: components['schemas']['ParticipantUserAnnotation'][];
|
|
434
|
-
/** @default
|
|
435
|
-
identityProviderId
|
|
676
|
+
/** @default */
|
|
677
|
+
identityProviderId: string;
|
|
436
678
|
};
|
|
437
679
|
ParticipantUsersData: {
|
|
438
680
|
identityProviders: components['schemas']['ParticipantIdentityProvider'][];
|
|
@@ -454,30 +696,45 @@ export interface components {
|
|
|
454
696
|
responses: {
|
|
455
697
|
/** @description bad request */
|
|
456
698
|
400: {
|
|
699
|
+
headers: {
|
|
700
|
+
[name: string]: unknown;
|
|
701
|
+
};
|
|
457
702
|
content: {
|
|
458
703
|
'application/json': components['schemas']['ErrorResponse'];
|
|
459
704
|
};
|
|
460
705
|
};
|
|
461
706
|
/** @description not found */
|
|
462
707
|
404: {
|
|
708
|
+
headers: {
|
|
709
|
+
[name: string]: unknown;
|
|
710
|
+
};
|
|
463
711
|
content: {
|
|
464
712
|
'application/json': components['schemas']['ErrorResponse'];
|
|
465
713
|
};
|
|
466
714
|
};
|
|
467
715
|
/** @description conflict */
|
|
468
716
|
409: {
|
|
717
|
+
headers: {
|
|
718
|
+
[name: string]: unknown;
|
|
719
|
+
};
|
|
469
720
|
content: {
|
|
470
721
|
'application/json': components['schemas']['ErrorResponse'];
|
|
471
722
|
};
|
|
472
723
|
};
|
|
473
724
|
/** @description internal server error */
|
|
474
725
|
500: {
|
|
726
|
+
headers: {
|
|
727
|
+
[name: string]: unknown;
|
|
728
|
+
};
|
|
475
729
|
content: {
|
|
476
730
|
'application/json': components['schemas']['ErrorResponse'];
|
|
477
731
|
};
|
|
478
732
|
};
|
|
479
733
|
/** @description not implemented */
|
|
480
734
|
501: {
|
|
735
|
+
headers: {
|
|
736
|
+
[name: string]: unknown;
|
|
737
|
+
};
|
|
481
738
|
content: {
|
|
482
739
|
'application/json': components['schemas']['ErrorResponse'];
|
|
483
740
|
};
|
|
@@ -489,55 +746,84 @@ export interface components {
|
|
|
489
746
|
pathItems: never;
|
|
490
747
|
}
|
|
491
748
|
export type $defs = Record<string, never>;
|
|
492
|
-
export type external = Record<string, never>;
|
|
493
749
|
export interface operations {
|
|
494
750
|
isReady: {
|
|
751
|
+
parameters: {
|
|
752
|
+
query?: never;
|
|
753
|
+
header?: never;
|
|
754
|
+
path?: never;
|
|
755
|
+
cookie?: never;
|
|
756
|
+
};
|
|
757
|
+
requestBody?: never;
|
|
495
758
|
responses: {
|
|
496
759
|
/** @description ok */
|
|
497
760
|
200: {
|
|
498
|
-
|
|
761
|
+
headers: {
|
|
762
|
+
[name: string]: unknown;
|
|
763
|
+
};
|
|
764
|
+
content?: never;
|
|
499
765
|
};
|
|
500
766
|
/** @description service_unavailable */
|
|
501
767
|
503: {
|
|
502
|
-
|
|
768
|
+
headers: {
|
|
769
|
+
[name: string]: unknown;
|
|
770
|
+
};
|
|
771
|
+
content?: never;
|
|
503
772
|
};
|
|
504
773
|
};
|
|
505
774
|
};
|
|
506
775
|
isLive: {
|
|
776
|
+
parameters: {
|
|
777
|
+
query?: never;
|
|
778
|
+
header?: never;
|
|
779
|
+
path?: never;
|
|
780
|
+
cookie?: never;
|
|
781
|
+
};
|
|
782
|
+
requestBody?: never;
|
|
507
783
|
responses: {
|
|
508
784
|
/** @description ok */
|
|
509
785
|
200: {
|
|
510
|
-
|
|
786
|
+
headers: {
|
|
787
|
+
[name: string]: unknown;
|
|
788
|
+
};
|
|
789
|
+
content?: never;
|
|
511
790
|
};
|
|
512
791
|
/** @description service_unavailable */
|
|
513
792
|
503: {
|
|
514
|
-
|
|
793
|
+
headers: {
|
|
794
|
+
[name: string]: unknown;
|
|
795
|
+
};
|
|
796
|
+
content?: never;
|
|
515
797
|
};
|
|
516
798
|
};
|
|
517
799
|
};
|
|
518
|
-
/** @description Get public information about the validator operator. */
|
|
519
800
|
getValidatorUserInfo: {
|
|
801
|
+
parameters: {
|
|
802
|
+
query?: never;
|
|
803
|
+
header?: never;
|
|
804
|
+
path?: never;
|
|
805
|
+
cookie?: never;
|
|
806
|
+
};
|
|
807
|
+
requestBody?: never;
|
|
520
808
|
responses: {
|
|
521
809
|
/** @description ok */
|
|
522
810
|
200: {
|
|
811
|
+
headers: {
|
|
812
|
+
[name: string]: unknown;
|
|
813
|
+
};
|
|
523
814
|
content: {
|
|
524
815
|
'application/json': components['schemas']['GetValidatorUserInfoResponse'];
|
|
525
816
|
};
|
|
526
817
|
};
|
|
527
818
|
};
|
|
528
819
|
};
|
|
529
|
-
/**
|
|
530
|
-
* @description As an authenticated user, onboard yourself.
|
|
531
|
-
* Onboarding includes allocating a ledger API user and daml party,
|
|
532
|
-
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
533
|
-
*
|
|
534
|
-
* The ledger API user name is taken from the subject claim of the JWT token.
|
|
535
|
-
*
|
|
536
|
-
* Once this call returns a successful response, the user is fully onboarded.
|
|
537
|
-
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
538
|
-
* to check the status of the user onboarding.
|
|
539
|
-
*/
|
|
540
820
|
register: {
|
|
821
|
+
parameters: {
|
|
822
|
+
query?: never;
|
|
823
|
+
header?: never;
|
|
824
|
+
path?: never;
|
|
825
|
+
cookie?: never;
|
|
826
|
+
};
|
|
541
827
|
requestBody?: {
|
|
542
828
|
content: {
|
|
543
829
|
'application/json': components['schemas']['RegistrationRequest'];
|
|
@@ -546,33 +832,42 @@ export interface operations {
|
|
|
546
832
|
responses: {
|
|
547
833
|
/** @description ok */
|
|
548
834
|
200: {
|
|
835
|
+
headers: {
|
|
836
|
+
[name: string]: unknown;
|
|
837
|
+
};
|
|
549
838
|
content: {
|
|
550
839
|
'application/json': components['schemas']['RegistrationResponse'];
|
|
551
840
|
};
|
|
552
841
|
};
|
|
553
842
|
};
|
|
554
843
|
};
|
|
555
|
-
/** @description Lists all users onboarded onto this validator. */
|
|
556
844
|
listUsers: {
|
|
845
|
+
parameters: {
|
|
846
|
+
query?: never;
|
|
847
|
+
header?: never;
|
|
848
|
+
path?: never;
|
|
849
|
+
cookie?: never;
|
|
850
|
+
};
|
|
851
|
+
requestBody?: never;
|
|
557
852
|
responses: {
|
|
558
853
|
/** @description ok */
|
|
559
854
|
200: {
|
|
855
|
+
headers: {
|
|
856
|
+
[name: string]: unknown;
|
|
857
|
+
};
|
|
560
858
|
content: {
|
|
561
859
|
'application/json': components['schemas']['ListUsersResponse'];
|
|
562
860
|
};
|
|
563
861
|
};
|
|
564
862
|
};
|
|
565
863
|
};
|
|
566
|
-
/**
|
|
567
|
-
* @description As the validator operator, onboard an arbitrary user specified in the request.
|
|
568
|
-
* Onboarding includes allocating a ledger API user and daml party,
|
|
569
|
-
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
570
|
-
*
|
|
571
|
-
* Once this call returns a successful response, the user is fully onboarded.
|
|
572
|
-
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
573
|
-
* to check the status of the user onboarding.
|
|
574
|
-
*/
|
|
575
864
|
onboardUser: {
|
|
865
|
+
parameters: {
|
|
866
|
+
query?: never;
|
|
867
|
+
header?: never;
|
|
868
|
+
path?: never;
|
|
869
|
+
cookie?: never;
|
|
870
|
+
};
|
|
576
871
|
requestBody: {
|
|
577
872
|
content: {
|
|
578
873
|
'application/json': components['schemas']['OnboardUserRequest'];
|
|
@@ -581,91 +876,106 @@ export interface operations {
|
|
|
581
876
|
responses: {
|
|
582
877
|
/** @description ok */
|
|
583
878
|
200: {
|
|
879
|
+
headers: {
|
|
880
|
+
[name: string]: unknown;
|
|
881
|
+
};
|
|
584
882
|
content: {
|
|
585
883
|
'application/json': components['schemas']['OnboardUserResponse'];
|
|
586
884
|
};
|
|
587
885
|
};
|
|
588
886
|
};
|
|
589
887
|
};
|
|
590
|
-
/**
|
|
591
|
-
* @description As the validator operator, offboard the user specified in the request.
|
|
592
|
-
* Offboarding archives the daml contracts required for the user to use a wallet on this validator.
|
|
593
|
-
* Offboarding deletes the ledger API user.
|
|
594
|
-
* Offboarding does not archive any other daml contracts owned by the user.
|
|
595
|
-
*/
|
|
596
888
|
offboardUser: {
|
|
597
889
|
parameters: {
|
|
598
890
|
query: {
|
|
599
891
|
username: string;
|
|
600
892
|
};
|
|
893
|
+
header?: never;
|
|
894
|
+
path?: never;
|
|
895
|
+
cookie?: never;
|
|
601
896
|
};
|
|
897
|
+
requestBody?: never;
|
|
602
898
|
responses: {
|
|
603
899
|
/** @description ok */
|
|
604
900
|
200: {
|
|
605
|
-
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content?: never;
|
|
606
905
|
};
|
|
607
906
|
404: components['responses']['404'];
|
|
608
907
|
};
|
|
609
908
|
};
|
|
610
|
-
/**
|
|
611
|
-
* @description Returns a dump of participant identities.
|
|
612
|
-
*
|
|
613
|
-
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
614
|
-
*/
|
|
615
909
|
dumpParticipantIdentities: {
|
|
910
|
+
parameters: {
|
|
911
|
+
query?: never;
|
|
912
|
+
header?: never;
|
|
913
|
+
path?: never;
|
|
914
|
+
cookie?: never;
|
|
915
|
+
};
|
|
916
|
+
requestBody?: never;
|
|
616
917
|
responses: {
|
|
617
918
|
/** @description ok */
|
|
618
919
|
200: {
|
|
920
|
+
headers: {
|
|
921
|
+
[name: string]: unknown;
|
|
922
|
+
};
|
|
619
923
|
content: {
|
|
620
924
|
'application/json': components['schemas']['NodeIdentitiesDump'];
|
|
621
925
|
};
|
|
622
926
|
};
|
|
623
927
|
};
|
|
624
928
|
};
|
|
625
|
-
/**
|
|
626
|
-
* @description Returns the connection configuration for the global synchronizer.
|
|
627
|
-
*
|
|
628
|
-
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
629
|
-
*/
|
|
630
929
|
getDecentralizedSynchronizerConnectionConfig: {
|
|
930
|
+
parameters: {
|
|
931
|
+
query?: never;
|
|
932
|
+
header?: never;
|
|
933
|
+
path?: never;
|
|
934
|
+
cookie?: never;
|
|
935
|
+
};
|
|
936
|
+
requestBody?: never;
|
|
631
937
|
responses: {
|
|
632
938
|
/** @description ok */
|
|
633
939
|
200: {
|
|
940
|
+
headers: {
|
|
941
|
+
[name: string]: unknown;
|
|
942
|
+
};
|
|
634
943
|
content: {
|
|
635
944
|
'application/json': components['schemas']['GetDecentralizedSynchronizerConnectionConfigResponse'];
|
|
636
945
|
};
|
|
637
946
|
};
|
|
638
947
|
};
|
|
639
948
|
};
|
|
640
|
-
/**
|
|
641
|
-
* @description Returns a snapshot of the global synchronizer data for this validator.
|
|
642
|
-
* The snapshot includes a list of parties, the active contract set (ACS), and node identities.
|
|
643
|
-
*
|
|
644
|
-
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
645
|
-
*/
|
|
646
949
|
getValidatorDomainDataSnapshot: {
|
|
647
950
|
parameters: {
|
|
648
951
|
query: {
|
|
649
952
|
/**
|
|
650
953
|
* @description The timestamp as of which the dump (in particular, the ACS) is valid.
|
|
651
954
|
*
|
|
652
|
-
*
|
|
653
|
-
*
|
|
955
|
+
* Must in the ISO-8601 format in UTC timezone, e.g.,
|
|
956
|
+
* `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
|
|
654
957
|
*/
|
|
655
958
|
timestamp: string;
|
|
656
959
|
/** @description The current migration id. */
|
|
657
960
|
migration_id?: number;
|
|
658
961
|
/**
|
|
659
962
|
* @description If true, do not check whether the provided timestamp is clean.
|
|
660
|
-
*
|
|
661
|
-
*
|
|
963
|
+
* Not recommended for production,
|
|
964
|
+
* see the `ExportAcs` endpoint of the `ParticipantRepairService` participant gRPC API.
|
|
662
965
|
*/
|
|
663
966
|
force?: boolean;
|
|
664
967
|
};
|
|
968
|
+
header?: never;
|
|
969
|
+
path?: never;
|
|
970
|
+
cookie?: never;
|
|
665
971
|
};
|
|
972
|
+
requestBody?: never;
|
|
666
973
|
responses: {
|
|
667
974
|
/** @description ok */
|
|
668
975
|
200: {
|
|
976
|
+
headers: {
|
|
977
|
+
[name: string]: unknown;
|
|
978
|
+
};
|
|
669
979
|
content: {
|
|
670
980
|
'application/json': components['schemas']['GetValidatorDomainDataSnapshotResponse'];
|
|
671
981
|
};
|
|
@@ -673,16 +983,22 @@ export interface operations {
|
|
|
673
983
|
500: components['responses']['500'];
|
|
674
984
|
};
|
|
675
985
|
};
|
|
676
|
-
/** @description Lookup the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
677
986
|
lookupTransferPreapprovalByParty: {
|
|
678
987
|
parameters: {
|
|
988
|
+
query?: never;
|
|
989
|
+
header?: never;
|
|
679
990
|
path: {
|
|
680
991
|
'receiver-party': string;
|
|
681
992
|
};
|
|
993
|
+
cookie?: never;
|
|
682
994
|
};
|
|
995
|
+
requestBody?: never;
|
|
683
996
|
responses: {
|
|
684
997
|
/** @description ok */
|
|
685
998
|
200: {
|
|
999
|
+
headers: {
|
|
1000
|
+
[name: string]: unknown;
|
|
1001
|
+
};
|
|
686
1002
|
content: {
|
|
687
1003
|
'application/json': components['schemas']['LookupTransferPreapprovalByPartyResponse'];
|
|
688
1004
|
};
|
|
@@ -690,39 +1006,54 @@ export interface operations {
|
|
|
690
1006
|
404: components['responses']['404'];
|
|
691
1007
|
};
|
|
692
1008
|
};
|
|
693
|
-
/** @description Remove the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
694
1009
|
cancelTransferPreapprovalByParty: {
|
|
695
1010
|
parameters: {
|
|
1011
|
+
query?: never;
|
|
1012
|
+
header?: never;
|
|
696
1013
|
path: {
|
|
697
1014
|
'receiver-party': string;
|
|
698
1015
|
};
|
|
1016
|
+
cookie?: never;
|
|
699
1017
|
};
|
|
1018
|
+
requestBody?: never;
|
|
700
1019
|
responses: {
|
|
701
1020
|
/** @description ok */
|
|
702
1021
|
200: {
|
|
703
|
-
|
|
1022
|
+
headers: {
|
|
1023
|
+
[name: string]: unknown;
|
|
1024
|
+
};
|
|
1025
|
+
content?: never;
|
|
704
1026
|
};
|
|
705
1027
|
404: components['responses']['404'];
|
|
706
1028
|
};
|
|
707
1029
|
};
|
|
708
|
-
/** @description List all `Splice.AmuletRules.TransferPreapproval` contracts where the preapproval provider is the validator operator. */
|
|
709
1030
|
listTransferPreapprovals: {
|
|
1031
|
+
parameters: {
|
|
1032
|
+
query?: never;
|
|
1033
|
+
header?: never;
|
|
1034
|
+
path?: never;
|
|
1035
|
+
cookie?: never;
|
|
1036
|
+
};
|
|
1037
|
+
requestBody?: never;
|
|
710
1038
|
responses: {
|
|
711
1039
|
/** @description ok */
|
|
712
1040
|
200: {
|
|
1041
|
+
headers: {
|
|
1042
|
+
[name: string]: unknown;
|
|
1043
|
+
};
|
|
713
1044
|
content: {
|
|
714
1045
|
'application/json': components['schemas']['ListTransferPreapprovalsResponse'];
|
|
715
1046
|
};
|
|
716
1047
|
};
|
|
717
1048
|
};
|
|
718
1049
|
};
|
|
719
|
-
/**
|
|
720
|
-
* @description Prepare a transaction to create a TransferCommand with the given CC amount to the specified receiver
|
|
721
|
-
* from the externally hosted sender.
|
|
722
|
-
* The transaction then needs to be signed and submitted through
|
|
723
|
-
* /v0/admin/external-party/transfer-preapproval/submit-send.
|
|
724
|
-
*/
|
|
725
1050
|
prepareTransferPreapprovalSend: {
|
|
1051
|
+
parameters: {
|
|
1052
|
+
query?: never;
|
|
1053
|
+
header?: never;
|
|
1054
|
+
path?: never;
|
|
1055
|
+
cookie?: never;
|
|
1056
|
+
};
|
|
726
1057
|
requestBody: {
|
|
727
1058
|
content: {
|
|
728
1059
|
'application/json': components['schemas']['PrepareTransferPreapprovalSendRequest'];
|
|
@@ -731,6 +1062,9 @@ export interface operations {
|
|
|
731
1062
|
responses: {
|
|
732
1063
|
/** @description ok */
|
|
733
1064
|
200: {
|
|
1065
|
+
headers: {
|
|
1066
|
+
[name: string]: unknown;
|
|
1067
|
+
};
|
|
734
1068
|
content: {
|
|
735
1069
|
'application/json': components['schemas']['PrepareTransferPreapprovalSendResponse'];
|
|
736
1070
|
};
|
|
@@ -740,12 +1074,13 @@ export interface operations {
|
|
|
740
1074
|
501: components['responses']['501'];
|
|
741
1075
|
};
|
|
742
1076
|
};
|
|
743
|
-
/**
|
|
744
|
-
* @description Submit transaction generated by /v0/admin/transfer-preapproval/prepare-send
|
|
745
|
-
* together with its signature. Note that this only waits until the TransferCommand is created.
|
|
746
|
-
* The actual transfer will happen afterwards through automation run by the SVs.
|
|
747
|
-
*/
|
|
748
1077
|
submitTransferPreapprovalSend: {
|
|
1078
|
+
parameters: {
|
|
1079
|
+
query?: never;
|
|
1080
|
+
header?: never;
|
|
1081
|
+
path?: never;
|
|
1082
|
+
cookie?: never;
|
|
1083
|
+
};
|
|
749
1084
|
requestBody: {
|
|
750
1085
|
content: {
|
|
751
1086
|
'application/json': components['schemas']['SubmitTransferPreapprovalSendRequest'];
|
|
@@ -754,6 +1089,9 @@ export interface operations {
|
|
|
754
1089
|
responses: {
|
|
755
1090
|
/** @description ok */
|
|
756
1091
|
200: {
|
|
1092
|
+
headers: {
|
|
1093
|
+
[name: string]: unknown;
|
|
1094
|
+
};
|
|
757
1095
|
content: {
|
|
758
1096
|
'application/json': components['schemas']['SubmitTransferPreapprovalSendResponse'];
|
|
759
1097
|
};
|
|
@@ -763,15 +1101,13 @@ export interface operations {
|
|
|
763
1101
|
501: components['responses']['501'];
|
|
764
1102
|
};
|
|
765
1103
|
};
|
|
766
|
-
/**
|
|
767
|
-
* @description Creates a root namespace topology transaction, which will create the party and sets the public key
|
|
768
|
-
* controlling the party namespace,
|
|
769
|
-
* a party to participant mapping topology transaction, which hosts the party on the participant with Confirmation rights,
|
|
770
|
-
* and a party to key mapping topology transaction, which sets the key to authorize daml transactions.
|
|
771
|
-
* The hash of each of these transactions will be signed along with the corresponding topology transaction (unchanged)
|
|
772
|
-
* in the /v0/admin/external-party/topology/submit endpoint
|
|
773
|
-
*/
|
|
774
1104
|
generateExternalPartyTopology: {
|
|
1105
|
+
parameters: {
|
|
1106
|
+
query?: never;
|
|
1107
|
+
header?: never;
|
|
1108
|
+
path?: never;
|
|
1109
|
+
cookie?: never;
|
|
1110
|
+
};
|
|
775
1111
|
requestBody: {
|
|
776
1112
|
content: {
|
|
777
1113
|
'application/json': components['schemas']['GenerateExternalPartyTopologyRequest'];
|
|
@@ -780,6 +1116,9 @@ export interface operations {
|
|
|
780
1116
|
responses: {
|
|
781
1117
|
/** @description ok */
|
|
782
1118
|
200: {
|
|
1119
|
+
headers: {
|
|
1120
|
+
[name: string]: unknown;
|
|
1121
|
+
};
|
|
783
1122
|
content: {
|
|
784
1123
|
'application/json': components['schemas']['GenerateExternalPartyTopologyResponse'];
|
|
785
1124
|
};
|
|
@@ -787,11 +1126,13 @@ export interface operations {
|
|
|
787
1126
|
501: components['responses']['501'];
|
|
788
1127
|
};
|
|
789
1128
|
};
|
|
790
|
-
/**
|
|
791
|
-
* @description Constructs a SignedTopologyTransaction and writes the topology transactions to the authorized store.
|
|
792
|
-
* The input will consist of the unchanged topology transaction and the signed hash from the /v0/external-party-topology/generate endpoint
|
|
793
|
-
*/
|
|
794
1129
|
submitExternalPartyTopology: {
|
|
1130
|
+
parameters: {
|
|
1131
|
+
query?: never;
|
|
1132
|
+
header?: never;
|
|
1133
|
+
path?: never;
|
|
1134
|
+
cookie?: never;
|
|
1135
|
+
};
|
|
795
1136
|
requestBody: {
|
|
796
1137
|
content: {
|
|
797
1138
|
'application/json': components['schemas']['SubmitExternalPartyTopologyRequest'];
|
|
@@ -800,6 +1141,9 @@ export interface operations {
|
|
|
800
1141
|
responses: {
|
|
801
1142
|
/** @description ok */
|
|
802
1143
|
200: {
|
|
1144
|
+
headers: {
|
|
1145
|
+
[name: string]: unknown;
|
|
1146
|
+
};
|
|
803
1147
|
content: {
|
|
804
1148
|
'application/json': components['schemas']['SubmitExternalPartyTopologyResponse'];
|
|
805
1149
|
};
|
|
@@ -807,11 +1151,20 @@ export interface operations {
|
|
|
807
1151
|
501: components['responses']['501'];
|
|
808
1152
|
};
|
|
809
1153
|
};
|
|
810
|
-
/** @description List all ExternalPartySetupProposal contracts. */
|
|
811
1154
|
listExternalPartySetupProposals: {
|
|
1155
|
+
parameters: {
|
|
1156
|
+
query?: never;
|
|
1157
|
+
header?: never;
|
|
1158
|
+
path?: never;
|
|
1159
|
+
cookie?: never;
|
|
1160
|
+
};
|
|
1161
|
+
requestBody?: never;
|
|
812
1162
|
responses: {
|
|
813
1163
|
/** @description ok */
|
|
814
1164
|
200: {
|
|
1165
|
+
headers: {
|
|
1166
|
+
[name: string]: unknown;
|
|
1167
|
+
};
|
|
815
1168
|
content: {
|
|
816
1169
|
'application/json': components['schemas']['ListExternalPartySetupProposalsResponse'];
|
|
817
1170
|
};
|
|
@@ -819,12 +1172,13 @@ export interface operations {
|
|
|
819
1172
|
501: components['responses']['501'];
|
|
820
1173
|
};
|
|
821
1174
|
};
|
|
822
|
-
/**
|
|
823
|
-
* @description Create the ExternalPartySetupProposal contract as the validator operator
|
|
824
|
-
* which then has to be accepted by the external party using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
825
|
-
* and /v0/admin/external-party/setup-proposal/submit-accept
|
|
826
|
-
*/
|
|
827
1175
|
createExternalPartySetupProposal: {
|
|
1176
|
+
parameters: {
|
|
1177
|
+
query?: never;
|
|
1178
|
+
header?: never;
|
|
1179
|
+
path?: never;
|
|
1180
|
+
cookie?: never;
|
|
1181
|
+
};
|
|
828
1182
|
requestBody: {
|
|
829
1183
|
content: {
|
|
830
1184
|
'application/json': components['schemas']['CreateExternalPartySetupProposalRequest'];
|
|
@@ -833,6 +1187,9 @@ export interface operations {
|
|
|
833
1187
|
responses: {
|
|
834
1188
|
/** @description ok */
|
|
835
1189
|
200: {
|
|
1190
|
+
headers: {
|
|
1191
|
+
[name: string]: unknown;
|
|
1192
|
+
};
|
|
836
1193
|
content: {
|
|
837
1194
|
'application/json': components['schemas']['CreateExternalPartySetupProposalResponse'];
|
|
838
1195
|
};
|
|
@@ -842,12 +1199,13 @@ export interface operations {
|
|
|
842
1199
|
501: components['responses']['501'];
|
|
843
1200
|
};
|
|
844
1201
|
};
|
|
845
|
-
/**
|
|
846
|
-
* @description Given a contract id of an ExternalPartySetupProposal, prepare the transaction
|
|
847
|
-
* to accept it such that it can be signed externally and then submitted using
|
|
848
|
-
* /v0/admin/external-party/setup-proposal/submit-accept
|
|
849
|
-
*/
|
|
850
1202
|
prepareAcceptExternalPartySetupProposal: {
|
|
1203
|
+
parameters: {
|
|
1204
|
+
query?: never;
|
|
1205
|
+
header?: never;
|
|
1206
|
+
path?: never;
|
|
1207
|
+
cookie?: never;
|
|
1208
|
+
};
|
|
851
1209
|
requestBody: {
|
|
852
1210
|
content: {
|
|
853
1211
|
'application/json': components['schemas']['PrepareAcceptExternalPartySetupProposalRequest'];
|
|
@@ -856,6 +1214,9 @@ export interface operations {
|
|
|
856
1214
|
responses: {
|
|
857
1215
|
/** @description ok */
|
|
858
1216
|
200: {
|
|
1217
|
+
headers: {
|
|
1218
|
+
[name: string]: unknown;
|
|
1219
|
+
};
|
|
859
1220
|
content: {
|
|
860
1221
|
'application/json': components['schemas']['PrepareAcceptExternalPartySetupProposalResponse'];
|
|
861
1222
|
};
|
|
@@ -865,11 +1226,13 @@ export interface operations {
|
|
|
865
1226
|
501: components['responses']['501'];
|
|
866
1227
|
};
|
|
867
1228
|
};
|
|
868
|
-
/**
|
|
869
|
-
* @description Submit a transaction prepared using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
870
|
-
* together with its signature.
|
|
871
|
-
*/
|
|
872
1229
|
submitAcceptExternalPartySetupProposal: {
|
|
1230
|
+
parameters: {
|
|
1231
|
+
query?: never;
|
|
1232
|
+
header?: never;
|
|
1233
|
+
path?: never;
|
|
1234
|
+
cookie?: never;
|
|
1235
|
+
};
|
|
873
1236
|
requestBody: {
|
|
874
1237
|
content: {
|
|
875
1238
|
'application/json': components['schemas']['SubmitAcceptExternalPartySetupProposalRequest'];
|
|
@@ -878,6 +1241,9 @@ export interface operations {
|
|
|
878
1241
|
responses: {
|
|
879
1242
|
/** @description ok */
|
|
880
1243
|
200: {
|
|
1244
|
+
headers: {
|
|
1245
|
+
[name: string]: unknown;
|
|
1246
|
+
};
|
|
881
1247
|
content: {
|
|
882
1248
|
'application/json': components['schemas']['SubmitAcceptExternalPartySetupProposalResponse'];
|
|
883
1249
|
};
|
|
@@ -886,16 +1252,22 @@ export interface operations {
|
|
|
886
1252
|
501: components['responses']['501'];
|
|
887
1253
|
};
|
|
888
1254
|
};
|
|
889
|
-
/** @description Get the balance of an external party. */
|
|
890
1255
|
getExternalPartyBalance: {
|
|
891
1256
|
parameters: {
|
|
892
1257
|
query: {
|
|
893
1258
|
party_id: string;
|
|
894
1259
|
};
|
|
1260
|
+
header?: never;
|
|
1261
|
+
path?: never;
|
|
1262
|
+
cookie?: never;
|
|
895
1263
|
};
|
|
1264
|
+
requestBody?: never;
|
|
896
1265
|
responses: {
|
|
897
1266
|
/** @description ok */
|
|
898
1267
|
200: {
|
|
1268
|
+
headers: {
|
|
1269
|
+
[name: string]: unknown;
|
|
1270
|
+
};
|
|
899
1271
|
content: {
|
|
900
1272
|
'application/json': components['schemas']['ExternalPartyBalanceResponse'];
|
|
901
1273
|
};
|