@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,903 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
'/readyz': {
|
|
3
|
+
get: operations['isReady'];
|
|
4
|
+
};
|
|
5
|
+
'/livez': {
|
|
6
|
+
get: operations['isLive'];
|
|
7
|
+
};
|
|
8
|
+
'/v0/validator-user': {
|
|
9
|
+
/** @description Get public information about the validator operator. */
|
|
10
|
+
get: operations['getValidatorUserInfo'];
|
|
11
|
+
};
|
|
12
|
+
'/v0/register': {
|
|
13
|
+
/**
|
|
14
|
+
* @description As an authenticated user, onboard yourself.
|
|
15
|
+
* Onboarding includes allocating a ledger API user and daml party,
|
|
16
|
+
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
17
|
+
*
|
|
18
|
+
* The ledger API user name is taken from the subject claim of the JWT token.
|
|
19
|
+
*
|
|
20
|
+
* Once this call returns a successful response, the user is fully onboarded.
|
|
21
|
+
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
22
|
+
* to check the status of the user onboarding.
|
|
23
|
+
*/
|
|
24
|
+
post: operations['register'];
|
|
25
|
+
};
|
|
26
|
+
'/v0/admin/users': {
|
|
27
|
+
/** @description Lists all users onboarded onto this validator. */
|
|
28
|
+
get: operations['listUsers'];
|
|
29
|
+
/**
|
|
30
|
+
* @description As the validator operator, onboard an arbitrary user specified in the request.
|
|
31
|
+
* Onboarding includes allocating a ledger API user and daml party,
|
|
32
|
+
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
33
|
+
*
|
|
34
|
+
* Once this call returns a successful response, the user is fully onboarded.
|
|
35
|
+
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
36
|
+
* to check the status of the user onboarding.
|
|
37
|
+
*/
|
|
38
|
+
post: operations['onboardUser'];
|
|
39
|
+
};
|
|
40
|
+
'/v0/admin/users/offboard': {
|
|
41
|
+
/**
|
|
42
|
+
* @description As the validator operator, offboard the user specified in the request.
|
|
43
|
+
* Offboarding archives the daml contracts required for the user to use a wallet on this validator.
|
|
44
|
+
* Offboarding does not delete the ledger API user, and does not archive any other daml contracts owned by the user.
|
|
45
|
+
*/
|
|
46
|
+
post: operations['offboardUser'];
|
|
47
|
+
};
|
|
48
|
+
'/v0/admin/participant/identities': {
|
|
49
|
+
/**
|
|
50
|
+
* @description Returns a dump of participant identities.
|
|
51
|
+
*
|
|
52
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
53
|
+
*/
|
|
54
|
+
get: operations['dumpParticipantIdentities'];
|
|
55
|
+
};
|
|
56
|
+
'/v0/admin/participant/global-domain-connection-config': {
|
|
57
|
+
/**
|
|
58
|
+
* @description Returns the connection configuration for the global synchronizer.
|
|
59
|
+
*
|
|
60
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
61
|
+
*/
|
|
62
|
+
get: operations['getDecentralizedSynchronizerConnectionConfig'];
|
|
63
|
+
};
|
|
64
|
+
'/v0/admin/domain/data-snapshot': {
|
|
65
|
+
/**
|
|
66
|
+
* @description Returns a snapshot of the global synchronizer data for this validator.
|
|
67
|
+
* The snapshot includes a list of parties, the active contract set (ACS), and node identities.
|
|
68
|
+
*
|
|
69
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
70
|
+
*/
|
|
71
|
+
get: operations['getValidatorDomainDataSnapshot'];
|
|
72
|
+
};
|
|
73
|
+
'/v0/admin/transfer-preapprovals/by-party/{receiver-party}': {
|
|
74
|
+
/** @description Lookup the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
75
|
+
get: operations['lookupTransferPreapprovalByParty'];
|
|
76
|
+
/** @description Remove the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
77
|
+
delete: operations['cancelTransferPreapprovalByParty'];
|
|
78
|
+
};
|
|
79
|
+
'/v0/admin/transfer-preapprovals': {
|
|
80
|
+
/** @description List all `Splice.AmuletRules.TransferPreapproval` contracts where the preapproval provider is the validator operator. */
|
|
81
|
+
get: operations['listTransferPreapprovals'];
|
|
82
|
+
};
|
|
83
|
+
'/v0/admin/external-party/transfer-preapproval/prepare-send': {
|
|
84
|
+
/**
|
|
85
|
+
* @description Prepare a transaction to create a TransferCommand with the given CC amount to the specified receiver
|
|
86
|
+
* from the externally hosted sender.
|
|
87
|
+
* The transaction then needs to be signed and submitted through
|
|
88
|
+
* /v0/admin/external-party/transfer-preapproval/submit-send.
|
|
89
|
+
*/
|
|
90
|
+
post: operations['prepareTransferPreapprovalSend'];
|
|
91
|
+
};
|
|
92
|
+
'/v0/admin/external-party/transfer-preapproval/submit-send': {
|
|
93
|
+
/**
|
|
94
|
+
* @description Submit transaction generated by /v0/admin/transfer-preapproval/prepare-send
|
|
95
|
+
* together with its signature. Note that this only waits until the TransferCommand is created.
|
|
96
|
+
* The actual transfer will happen afterwards through automation run by the SVs.
|
|
97
|
+
*/
|
|
98
|
+
post: operations['submitTransferPreapprovalSend'];
|
|
99
|
+
};
|
|
100
|
+
'/v0/admin/external-party/topology/generate': {
|
|
101
|
+
/**
|
|
102
|
+
* @description Creates a root namespace topology transaction, which will create the party and sets the public key
|
|
103
|
+
* controlling the party namespace,
|
|
104
|
+
* a party to participant mapping topology transaction, which hosts the party on the participant with Confirmation rights,
|
|
105
|
+
* and a party to key mapping topology transaction, which sets the key to authorize daml transactions.
|
|
106
|
+
* The hash of each of these transactions will be signed along with the corresponding topology transaction (unchanged)
|
|
107
|
+
* in the /v0/admin/external-party/topology/submit endpoint
|
|
108
|
+
*/
|
|
109
|
+
post: operations['generateExternalPartyTopology'];
|
|
110
|
+
};
|
|
111
|
+
'/v0/admin/external-party/topology/submit': {
|
|
112
|
+
/**
|
|
113
|
+
* @description Constructs a SignedTopologyTransaction and writes the topology transactions to the authorized store.
|
|
114
|
+
* The input will consist of the unchanged topology transaction and the signed hash from the /v0/external-party-topology/generate endpoint
|
|
115
|
+
*/
|
|
116
|
+
post: operations['submitExternalPartyTopology'];
|
|
117
|
+
};
|
|
118
|
+
'/v0/admin/external-party/setup-proposal': {
|
|
119
|
+
/** @description List all ExternalPartySetupProposal contracts. */
|
|
120
|
+
get: operations['listExternalPartySetupProposals'];
|
|
121
|
+
/**
|
|
122
|
+
* @description Create the ExternalPartySetupProposal contract as the validator operator
|
|
123
|
+
* which then has to be accepted by the external party using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
124
|
+
* and /v0/admin/external-party/setup-proposal/submit-accept
|
|
125
|
+
*/
|
|
126
|
+
post: operations['createExternalPartySetupProposal'];
|
|
127
|
+
};
|
|
128
|
+
'/v0/admin/external-party/setup-proposal/prepare-accept': {
|
|
129
|
+
/**
|
|
130
|
+
* @description Given a contract id of an ExternalPartySetupProposal, prepare the transaction
|
|
131
|
+
* to accept it such that it can be signed externally and then submitted using
|
|
132
|
+
* /v0/admin/external-party/setup-proposal/submit-accept
|
|
133
|
+
*/
|
|
134
|
+
post: operations['prepareAcceptExternalPartySetupProposal'];
|
|
135
|
+
};
|
|
136
|
+
'/v0/admin/external-party/setup-proposal/submit-accept': {
|
|
137
|
+
/**
|
|
138
|
+
* @description Submit a transaction prepared using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
139
|
+
* together with its signature.
|
|
140
|
+
*/
|
|
141
|
+
post: operations['submitAcceptExternalPartySetupProposal'];
|
|
142
|
+
};
|
|
143
|
+
'/v0/admin/external-party/balance': {
|
|
144
|
+
/** @description Get the balance of an external party. */
|
|
145
|
+
get: operations['getExternalPartyBalance'];
|
|
146
|
+
};
|
|
147
|
+
}
|
|
148
|
+
export type webhooks = Record<string, never>;
|
|
149
|
+
export interface components {
|
|
150
|
+
schemas: {
|
|
151
|
+
OnboardUserRequest: {
|
|
152
|
+
name: string;
|
|
153
|
+
/**
|
|
154
|
+
* @description The party id of the user to onboard. This is optional and if not provided
|
|
155
|
+
* a fresh party id will be generated by the backend.
|
|
156
|
+
*/
|
|
157
|
+
party_id?: string;
|
|
158
|
+
};
|
|
159
|
+
OnboardUserResponse: {
|
|
160
|
+
/** @description The daml party id of the user that was onboarded. */
|
|
161
|
+
party_id: string;
|
|
162
|
+
};
|
|
163
|
+
GenerateExternalPartyTopologyRequest: {
|
|
164
|
+
/** @description The actual party id will be constructed from this hint and a fingerprint of the public key. */
|
|
165
|
+
party_hint: string;
|
|
166
|
+
/** @description hex-encoded ed25519 public key */
|
|
167
|
+
public_key: string;
|
|
168
|
+
};
|
|
169
|
+
GenerateExternalPartyTopologyResponse: {
|
|
170
|
+
/** @description The generated party id of the external user. */
|
|
171
|
+
party_id: string;
|
|
172
|
+
topology_txs: components['schemas']['TopologyTx'][];
|
|
173
|
+
};
|
|
174
|
+
TopologyTx: {
|
|
175
|
+
/** @description base64 encoded topology transaction */
|
|
176
|
+
topology_tx: string;
|
|
177
|
+
/** @description hex-encoded hash of the topology transaction */
|
|
178
|
+
hash: string;
|
|
179
|
+
};
|
|
180
|
+
SubmitExternalPartyTopologyRequest: {
|
|
181
|
+
/** @description hex-encoded ed25519 public key */
|
|
182
|
+
public_key: string;
|
|
183
|
+
signed_topology_txs: components['schemas']['SignedTopologyTx'][];
|
|
184
|
+
};
|
|
185
|
+
SubmitExternalPartyTopologyResponse: {
|
|
186
|
+
party_id: string;
|
|
187
|
+
};
|
|
188
|
+
SignedTopologyTx: {
|
|
189
|
+
/**
|
|
190
|
+
* @description base64 encoded topology transaction, this should be identical to the topology transaction
|
|
191
|
+
* received from the /v0/external-party-topology/generate endpoint.
|
|
192
|
+
*/
|
|
193
|
+
topology_tx: string;
|
|
194
|
+
/**
|
|
195
|
+
* @description hex-encoded ed25519 signature of the hash return by the generate endpoint in the form
|
|
196
|
+
* `${r}${s}`.
|
|
197
|
+
*/
|
|
198
|
+
signed_hash: string;
|
|
199
|
+
};
|
|
200
|
+
RegistrationRequest: Record<string, unknown> | null;
|
|
201
|
+
RegistrationResponse: {
|
|
202
|
+
/** @description The party id of the user that was onboarded. */
|
|
203
|
+
party_id: string;
|
|
204
|
+
};
|
|
205
|
+
GetValidatorUserInfoResponse: {
|
|
206
|
+
/** @description The daml party id of the validator operator. */
|
|
207
|
+
party_id: string;
|
|
208
|
+
/** @description The ledger API user of the validator operator. */
|
|
209
|
+
user_name: string;
|
|
210
|
+
featured: boolean;
|
|
211
|
+
};
|
|
212
|
+
GetDecentralizedSynchronizerConnectionConfigResponse: {
|
|
213
|
+
sequencer_connections: components['schemas']['SequencerConnections'];
|
|
214
|
+
};
|
|
215
|
+
ListUsersResponse: {
|
|
216
|
+
usernames: string[];
|
|
217
|
+
};
|
|
218
|
+
SequencerConnections: {
|
|
219
|
+
connections: components['schemas']['SequencerAliasToConnections'][];
|
|
220
|
+
/** Format: int32 */
|
|
221
|
+
sequencer_trust_threshold: number;
|
|
222
|
+
submission_request_amplification: components['schemas']['SequencerSubmissionRequestAmplification'];
|
|
223
|
+
};
|
|
224
|
+
SequencerAliasToConnections: {
|
|
225
|
+
sequencer_alias: string;
|
|
226
|
+
endpoints: string[];
|
|
227
|
+
transport_security: boolean;
|
|
228
|
+
};
|
|
229
|
+
Dar: {
|
|
230
|
+
hash: string;
|
|
231
|
+
/** @description base64 encoded string of a dar package */
|
|
232
|
+
content: string;
|
|
233
|
+
};
|
|
234
|
+
DomainMigrationDump: {
|
|
235
|
+
participant: components['schemas']['NodeIdentitiesDump'];
|
|
236
|
+
participant_users: components['schemas']['ParticipantUsersData'];
|
|
237
|
+
/** @description base64 encoded string of acs snapshot for the requested party id */
|
|
238
|
+
acs_snapshot: string;
|
|
239
|
+
acs_timestamp: string;
|
|
240
|
+
dars: components['schemas']['Dar'][];
|
|
241
|
+
/** Format: int64 */
|
|
242
|
+
migration_id: number;
|
|
243
|
+
domain_id: string;
|
|
244
|
+
created_at: string;
|
|
245
|
+
};
|
|
246
|
+
GetValidatorDomainDataSnapshotResponse: {
|
|
247
|
+
data_snapshot: components['schemas']['DomainMigrationDump'];
|
|
248
|
+
/** Format: int64 */
|
|
249
|
+
migration_id: number;
|
|
250
|
+
};
|
|
251
|
+
SequencerSubmissionRequestAmplification: {
|
|
252
|
+
factor: number;
|
|
253
|
+
patience_seconds: number;
|
|
254
|
+
};
|
|
255
|
+
CreateExternalPartySetupProposalRequest: {
|
|
256
|
+
user_party_id: string;
|
|
257
|
+
};
|
|
258
|
+
CreateExternalPartySetupProposalResponse: {
|
|
259
|
+
contract_id: components['schemas']['ContractId'];
|
|
260
|
+
};
|
|
261
|
+
ListExternalPartySetupProposalsResponse: {
|
|
262
|
+
contracts: components['schemas']['ContractWithState'][];
|
|
263
|
+
};
|
|
264
|
+
PrepareAcceptExternalPartySetupProposalRequest: {
|
|
265
|
+
contract_id: components['schemas']['ContractId'];
|
|
266
|
+
user_party_id: string;
|
|
267
|
+
/**
|
|
268
|
+
* @description When true, the response will contain additional details on how the transaction was encoded and hashed.
|
|
269
|
+
* This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
|
|
270
|
+
*
|
|
271
|
+
* @default false
|
|
272
|
+
*/
|
|
273
|
+
verbose_hashing?: boolean;
|
|
274
|
+
};
|
|
275
|
+
PrepareAcceptExternalPartySetupProposalResponse: {
|
|
276
|
+
/**
|
|
277
|
+
* @description base64-encoded transaction. The transaction corresponds to
|
|
278
|
+
* the protobuf definition of a `PreparedTransaction`
|
|
279
|
+
* https://github.com/digital-asset/canton/blob/main/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive_submission_data.proto#L18
|
|
280
|
+
* and can be decoded using standard protobuf libraries.
|
|
281
|
+
*/
|
|
282
|
+
transaction: string;
|
|
283
|
+
/** @description Hex-encoded hash of the transaction */
|
|
284
|
+
tx_hash: string;
|
|
285
|
+
/**
|
|
286
|
+
* @description Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing=true in the request.
|
|
287
|
+
* Note that there are no guarantees on the stability of the format or content of this field.
|
|
288
|
+
* Its content should NOT be parsed and should only be used for troubleshooting purposes.
|
|
289
|
+
*/
|
|
290
|
+
hashing_details?: string;
|
|
291
|
+
};
|
|
292
|
+
SubmitAcceptExternalPartySetupProposalRequest: {
|
|
293
|
+
submission: components['schemas']['ExternalPartySubmission'];
|
|
294
|
+
};
|
|
295
|
+
SubmitAcceptExternalPartySetupProposalResponse: {
|
|
296
|
+
transfer_preapproval_contract_id: components['schemas']['ContractId'];
|
|
297
|
+
update_id: string;
|
|
298
|
+
};
|
|
299
|
+
ExternalPartyBalanceResponse: {
|
|
300
|
+
party_id: string;
|
|
301
|
+
total_unlocked_coin: string;
|
|
302
|
+
total_locked_coin: string;
|
|
303
|
+
total_coin_holdings: string;
|
|
304
|
+
accumulated_holding_fees_unlocked: string;
|
|
305
|
+
accumulated_holding_fees_locked: string;
|
|
306
|
+
accumulated_holding_fees_total: string;
|
|
307
|
+
total_available_coin: string;
|
|
308
|
+
/** Format: int64 */
|
|
309
|
+
computed_as_of_round: number;
|
|
310
|
+
};
|
|
311
|
+
ListTransferPreapprovalsResponse: {
|
|
312
|
+
contracts: components['schemas']['ContractWithState'][];
|
|
313
|
+
};
|
|
314
|
+
LookupTransferPreapprovalByPartyResponse: {
|
|
315
|
+
transfer_preapproval: components['schemas']['ContractWithState'];
|
|
316
|
+
};
|
|
317
|
+
PrepareTransferPreapprovalSendRequest: {
|
|
318
|
+
sender_party_id: string;
|
|
319
|
+
receiver_party_id: string;
|
|
320
|
+
amount: number;
|
|
321
|
+
/** Format: date-time */
|
|
322
|
+
expires_at: string;
|
|
323
|
+
/**
|
|
324
|
+
* Format: int64
|
|
325
|
+
* @description The expected value of the counter that is used to order and deduplicate TransferCommands. Starts at 0 and increases
|
|
326
|
+
* by 1 for each executed TransferCommand (independent of whether is succeeded or not). The most recent value can be read from scan
|
|
327
|
+
* through /v0/transfer-command-counter/{party}
|
|
328
|
+
*/
|
|
329
|
+
nonce: number;
|
|
330
|
+
/**
|
|
331
|
+
* @description When true, the response will contain additional details on how the transaction was encoded and hashed.
|
|
332
|
+
* This can be useful for troubleshooting of hash mismatches. Should only be used for debugging.
|
|
333
|
+
*
|
|
334
|
+
* @default false
|
|
335
|
+
*/
|
|
336
|
+
verbose_hashing?: boolean;
|
|
337
|
+
description?: string;
|
|
338
|
+
};
|
|
339
|
+
PrepareTransferPreapprovalSendResponse: {
|
|
340
|
+
/**
|
|
341
|
+
* @description base64-encoded transaction. The transaction corresponds to
|
|
342
|
+
* the protobuf definition of a `PreparedTransaction`
|
|
343
|
+
* https://github.com/digital-asset/canton/blob/main/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive_submission_data.proto#L18
|
|
344
|
+
* and can be decoded using standard protobuf libraries.
|
|
345
|
+
*/
|
|
346
|
+
transaction: string;
|
|
347
|
+
/** @description Hex-encoded hash of the transaction */
|
|
348
|
+
tx_hash: string;
|
|
349
|
+
/**
|
|
350
|
+
* @description Prefix of the ContractId of the created TransferCommand. Matches the contract id of the corresponding `Create` node in the prepared transaction which
|
|
351
|
+
* 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
|
|
352
|
+
* adds an additional suffix to the contract id.
|
|
353
|
+
*/
|
|
354
|
+
transfer_command_contract_id_prefix: string;
|
|
355
|
+
/**
|
|
356
|
+
* @description Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing=true in the request.
|
|
357
|
+
* Note that there are no guarantees on the stability of the format or content of this field.
|
|
358
|
+
* Its content should NOT be parsed and should only be used for troubleshooting purposes.
|
|
359
|
+
*/
|
|
360
|
+
hashing_details?: string;
|
|
361
|
+
};
|
|
362
|
+
SubmitTransferPreapprovalSendRequest: {
|
|
363
|
+
submission: components['schemas']['ExternalPartySubmission'];
|
|
364
|
+
};
|
|
365
|
+
SubmitTransferPreapprovalSendResponse: {
|
|
366
|
+
update_id: string;
|
|
367
|
+
};
|
|
368
|
+
ExternalPartySubmission: {
|
|
369
|
+
party_id: string;
|
|
370
|
+
/**
|
|
371
|
+
* @description base64-encoded transaction. The transaction corresponds to
|
|
372
|
+
* the protobuf definition of a `PreparedTransaction`
|
|
373
|
+
* https://github.com/digital-asset/canton/blob/main/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive_submission_data.proto#L18
|
|
374
|
+
* and can be decoded using standard protobuf libraries.
|
|
375
|
+
*/
|
|
376
|
+
transaction: string;
|
|
377
|
+
/**
|
|
378
|
+
* @description hex-encoded ed25519 signature of the hash return by the prepare endpoint in the form
|
|
379
|
+
* `${r}${s}`.
|
|
380
|
+
*/
|
|
381
|
+
signed_tx_hash: string;
|
|
382
|
+
/** @description hex-encoded ed25519 public key */
|
|
383
|
+
public_key: string;
|
|
384
|
+
};
|
|
385
|
+
ErrorResponse: {
|
|
386
|
+
error: string;
|
|
387
|
+
};
|
|
388
|
+
KeyPair: {
|
|
389
|
+
keyPair: string;
|
|
390
|
+
name?: string;
|
|
391
|
+
};
|
|
392
|
+
KmsKeyId: {
|
|
393
|
+
/** @enum {string} */
|
|
394
|
+
type: 'signing' | 'encryption';
|
|
395
|
+
keyId: string;
|
|
396
|
+
name?: string;
|
|
397
|
+
};
|
|
398
|
+
NodeKey: components['schemas']['KeyPair'] | components['schemas']['KmsKeyId'];
|
|
399
|
+
NodeIdentitiesDump: {
|
|
400
|
+
id: string;
|
|
401
|
+
keys: components['schemas']['NodeKey'][];
|
|
402
|
+
/** @description base64 encoded string of authorized store snapshot */
|
|
403
|
+
authorizedStoreSnapshot: string;
|
|
404
|
+
version?: string;
|
|
405
|
+
};
|
|
406
|
+
ParticipantIdentityProvider: {
|
|
407
|
+
id: string;
|
|
408
|
+
/** @default false */
|
|
409
|
+
isDeactivated: boolean;
|
|
410
|
+
jwksUrl: string;
|
|
411
|
+
issuer: string;
|
|
412
|
+
audience: string;
|
|
413
|
+
};
|
|
414
|
+
ParticipantUserRight: {
|
|
415
|
+
/** @enum {string} */
|
|
416
|
+
kind: 'participantAdmin' | 'canActAs' | 'canReadAs' | 'identityProviderAdmin' | 'canReadAsAnyParty';
|
|
417
|
+
party?: string;
|
|
418
|
+
};
|
|
419
|
+
ParticipantUserAnnotation: {
|
|
420
|
+
key: string;
|
|
421
|
+
value: string;
|
|
422
|
+
};
|
|
423
|
+
ParticipantUser: {
|
|
424
|
+
id: string;
|
|
425
|
+
primaryParty?: string;
|
|
426
|
+
rights: components['schemas']['ParticipantUserRight'][];
|
|
427
|
+
/** @default false */
|
|
428
|
+
isDeactivated: boolean;
|
|
429
|
+
annotations: components['schemas']['ParticipantUserAnnotation'][];
|
|
430
|
+
/** @default */
|
|
431
|
+
identityProviderId?: string;
|
|
432
|
+
};
|
|
433
|
+
ParticipantUsersData: {
|
|
434
|
+
identityProviders: components['schemas']['ParticipantIdentityProvider'][];
|
|
435
|
+
users: components['schemas']['ParticipantUser'][];
|
|
436
|
+
};
|
|
437
|
+
Contract: {
|
|
438
|
+
template_id: string;
|
|
439
|
+
contract_id: string;
|
|
440
|
+
payload: Record<string, never>;
|
|
441
|
+
created_event_blob: string;
|
|
442
|
+
created_at: string;
|
|
443
|
+
};
|
|
444
|
+
ContractWithState: {
|
|
445
|
+
contract: components['schemas']['Contract'];
|
|
446
|
+
domain_id?: string;
|
|
447
|
+
};
|
|
448
|
+
ContractId: string;
|
|
449
|
+
};
|
|
450
|
+
responses: {
|
|
451
|
+
/** @description bad request */
|
|
452
|
+
400: {
|
|
453
|
+
content: {
|
|
454
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
455
|
+
};
|
|
456
|
+
};
|
|
457
|
+
/** @description not found */
|
|
458
|
+
404: {
|
|
459
|
+
content: {
|
|
460
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
461
|
+
};
|
|
462
|
+
};
|
|
463
|
+
/** @description conflict */
|
|
464
|
+
409: {
|
|
465
|
+
content: {
|
|
466
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
467
|
+
};
|
|
468
|
+
};
|
|
469
|
+
/** @description internal server error */
|
|
470
|
+
500: {
|
|
471
|
+
content: {
|
|
472
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
/** @description not implemented */
|
|
476
|
+
501: {
|
|
477
|
+
content: {
|
|
478
|
+
'application/json': components['schemas']['ErrorResponse'];
|
|
479
|
+
};
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
parameters: never;
|
|
483
|
+
requestBodies: never;
|
|
484
|
+
headers: never;
|
|
485
|
+
pathItems: never;
|
|
486
|
+
}
|
|
487
|
+
export type $defs = Record<string, never>;
|
|
488
|
+
export type external = Record<string, never>;
|
|
489
|
+
export interface operations {
|
|
490
|
+
isReady: {
|
|
491
|
+
responses: {
|
|
492
|
+
/** @description ok */
|
|
493
|
+
200: {
|
|
494
|
+
content: never;
|
|
495
|
+
};
|
|
496
|
+
/** @description service_unavailable */
|
|
497
|
+
503: {
|
|
498
|
+
content: never;
|
|
499
|
+
};
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
isLive: {
|
|
503
|
+
responses: {
|
|
504
|
+
/** @description ok */
|
|
505
|
+
200: {
|
|
506
|
+
content: never;
|
|
507
|
+
};
|
|
508
|
+
/** @description service_unavailable */
|
|
509
|
+
503: {
|
|
510
|
+
content: never;
|
|
511
|
+
};
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
/** @description Get public information about the validator operator. */
|
|
515
|
+
getValidatorUserInfo: {
|
|
516
|
+
responses: {
|
|
517
|
+
/** @description ok */
|
|
518
|
+
200: {
|
|
519
|
+
content: {
|
|
520
|
+
'application/json': components['schemas']['GetValidatorUserInfoResponse'];
|
|
521
|
+
};
|
|
522
|
+
};
|
|
523
|
+
};
|
|
524
|
+
};
|
|
525
|
+
/**
|
|
526
|
+
* @description As an authenticated user, onboard yourself.
|
|
527
|
+
* Onboarding includes allocating a ledger API user and daml party,
|
|
528
|
+
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
529
|
+
*
|
|
530
|
+
* The ledger API user name is taken from the subject claim of the JWT token.
|
|
531
|
+
*
|
|
532
|
+
* Once this call returns a successful response, the user is fully onboarded.
|
|
533
|
+
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
534
|
+
* to check the status of the user onboarding.
|
|
535
|
+
*/
|
|
536
|
+
register: {
|
|
537
|
+
requestBody?: {
|
|
538
|
+
content: {
|
|
539
|
+
'application/json': components['schemas']['RegistrationRequest'];
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
responses: {
|
|
543
|
+
/** @description ok */
|
|
544
|
+
200: {
|
|
545
|
+
content: {
|
|
546
|
+
'application/json': components['schemas']['RegistrationResponse'];
|
|
547
|
+
};
|
|
548
|
+
};
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
/** @description Lists all users onboarded onto this validator. */
|
|
552
|
+
listUsers: {
|
|
553
|
+
responses: {
|
|
554
|
+
/** @description ok */
|
|
555
|
+
200: {
|
|
556
|
+
content: {
|
|
557
|
+
'application/json': components['schemas']['ListUsersResponse'];
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
};
|
|
561
|
+
};
|
|
562
|
+
/**
|
|
563
|
+
* @description As the validator operator, onboard an arbitrary user specified in the request.
|
|
564
|
+
* Onboarding includes allocating a ledger API user and daml party,
|
|
565
|
+
* and setting up daml contracts required for the user to use a wallet on this validator.
|
|
566
|
+
*
|
|
567
|
+
* Once this call returns a successful response, the user is fully onboarded.
|
|
568
|
+
* Use [v0/wallet/user-status](../../../../wallet/src/main/openapi/wallet-internal.yaml#/paths/v0/wallet/user-status)
|
|
569
|
+
* to check the status of the user onboarding.
|
|
570
|
+
*/
|
|
571
|
+
onboardUser: {
|
|
572
|
+
requestBody: {
|
|
573
|
+
content: {
|
|
574
|
+
'application/json': components['schemas']['OnboardUserRequest'];
|
|
575
|
+
};
|
|
576
|
+
};
|
|
577
|
+
responses: {
|
|
578
|
+
/** @description ok */
|
|
579
|
+
200: {
|
|
580
|
+
content: {
|
|
581
|
+
'application/json': components['schemas']['OnboardUserResponse'];
|
|
582
|
+
};
|
|
583
|
+
};
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
/**
|
|
587
|
+
* @description As the validator operator, offboard the user specified in the request.
|
|
588
|
+
* Offboarding archives the daml contracts required for the user to use a wallet on this validator.
|
|
589
|
+
* Offboarding does not delete the ledger API user, and does not archive any other daml contracts owned by the user.
|
|
590
|
+
*/
|
|
591
|
+
offboardUser: {
|
|
592
|
+
parameters: {
|
|
593
|
+
query: {
|
|
594
|
+
username: string;
|
|
595
|
+
};
|
|
596
|
+
};
|
|
597
|
+
responses: {
|
|
598
|
+
/** @description ok */
|
|
599
|
+
200: {
|
|
600
|
+
content: never;
|
|
601
|
+
};
|
|
602
|
+
404: components['responses']['404'];
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
/**
|
|
606
|
+
* @description Returns a dump of participant identities.
|
|
607
|
+
*
|
|
608
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
609
|
+
*/
|
|
610
|
+
dumpParticipantIdentities: {
|
|
611
|
+
responses: {
|
|
612
|
+
/** @description ok */
|
|
613
|
+
200: {
|
|
614
|
+
content: {
|
|
615
|
+
'application/json': components['schemas']['NodeIdentitiesDump'];
|
|
616
|
+
};
|
|
617
|
+
};
|
|
618
|
+
};
|
|
619
|
+
};
|
|
620
|
+
/**
|
|
621
|
+
* @description Returns the connection configuration for the global synchronizer.
|
|
622
|
+
*
|
|
623
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
624
|
+
*/
|
|
625
|
+
getDecentralizedSynchronizerConnectionConfig: {
|
|
626
|
+
responses: {
|
|
627
|
+
/** @description ok */
|
|
628
|
+
200: {
|
|
629
|
+
content: {
|
|
630
|
+
'application/json': components['schemas']['GetDecentralizedSynchronizerConnectionConfigResponse'];
|
|
631
|
+
};
|
|
632
|
+
};
|
|
633
|
+
};
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* @description Returns a snapshot of the global synchronizer data for this validator.
|
|
637
|
+
* The snapshot includes a list of parties, the active contract set (ACS), and node identities.
|
|
638
|
+
*
|
|
639
|
+
* Use this endpoint if instructed to do so by an operational manual or support.
|
|
640
|
+
*/
|
|
641
|
+
getValidatorDomainDataSnapshot: {
|
|
642
|
+
parameters: {
|
|
643
|
+
query: {
|
|
644
|
+
/**
|
|
645
|
+
* @description The timestamp as of which the dump (in particular, the ACS) is valid.
|
|
646
|
+
*
|
|
647
|
+
* Must in the ISO-8601 format in UTC timezone, e.g.,
|
|
648
|
+
* `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
|
|
649
|
+
*/
|
|
650
|
+
timestamp: string;
|
|
651
|
+
/** @description The current migration id. */
|
|
652
|
+
migration_id?: number;
|
|
653
|
+
/**
|
|
654
|
+
* @description If true, do not check whether the provided timestamp is clean.
|
|
655
|
+
* Not recommended for production,
|
|
656
|
+
* see the `ExportAcs` endpoint of the `ParticipantRepairService` participant gRPC API.
|
|
657
|
+
*/
|
|
658
|
+
force?: boolean;
|
|
659
|
+
};
|
|
660
|
+
};
|
|
661
|
+
responses: {
|
|
662
|
+
/** @description ok */
|
|
663
|
+
200: {
|
|
664
|
+
content: {
|
|
665
|
+
'application/json': components['schemas']['GetValidatorDomainDataSnapshotResponse'];
|
|
666
|
+
};
|
|
667
|
+
};
|
|
668
|
+
500: components['responses']['500'];
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
/** @description Lookup the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
672
|
+
lookupTransferPreapprovalByParty: {
|
|
673
|
+
parameters: {
|
|
674
|
+
path: {
|
|
675
|
+
'receiver-party': string;
|
|
676
|
+
};
|
|
677
|
+
};
|
|
678
|
+
responses: {
|
|
679
|
+
/** @description ok */
|
|
680
|
+
200: {
|
|
681
|
+
content: {
|
|
682
|
+
'application/json': components['schemas']['LookupTransferPreapprovalByPartyResponse'];
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
404: components['responses']['404'];
|
|
686
|
+
};
|
|
687
|
+
};
|
|
688
|
+
/** @description Remove the `Splice.AmuletRules.TransferPreapproval` contract for the given receiver party. */
|
|
689
|
+
cancelTransferPreapprovalByParty: {
|
|
690
|
+
parameters: {
|
|
691
|
+
path: {
|
|
692
|
+
'receiver-party': string;
|
|
693
|
+
};
|
|
694
|
+
};
|
|
695
|
+
responses: {
|
|
696
|
+
/** @description ok */
|
|
697
|
+
200: {
|
|
698
|
+
content: never;
|
|
699
|
+
};
|
|
700
|
+
404: components['responses']['404'];
|
|
701
|
+
};
|
|
702
|
+
};
|
|
703
|
+
/** @description List all `Splice.AmuletRules.TransferPreapproval` contracts where the preapproval provider is the validator operator. */
|
|
704
|
+
listTransferPreapprovals: {
|
|
705
|
+
responses: {
|
|
706
|
+
/** @description ok */
|
|
707
|
+
200: {
|
|
708
|
+
content: {
|
|
709
|
+
'application/json': components['schemas']['ListTransferPreapprovalsResponse'];
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
};
|
|
714
|
+
/**
|
|
715
|
+
* @description Prepare a transaction to create a TransferCommand with the given CC amount to the specified receiver
|
|
716
|
+
* from the externally hosted sender.
|
|
717
|
+
* The transaction then needs to be signed and submitted through
|
|
718
|
+
* /v0/admin/external-party/transfer-preapproval/submit-send.
|
|
719
|
+
*/
|
|
720
|
+
prepareTransferPreapprovalSend: {
|
|
721
|
+
requestBody: {
|
|
722
|
+
content: {
|
|
723
|
+
'application/json': components['schemas']['PrepareTransferPreapprovalSendRequest'];
|
|
724
|
+
};
|
|
725
|
+
};
|
|
726
|
+
responses: {
|
|
727
|
+
/** @description ok */
|
|
728
|
+
200: {
|
|
729
|
+
content: {
|
|
730
|
+
'application/json': components['schemas']['PrepareTransferPreapprovalSendResponse'];
|
|
731
|
+
};
|
|
732
|
+
};
|
|
733
|
+
400: components['responses']['400'];
|
|
734
|
+
404: components['responses']['404'];
|
|
735
|
+
501: components['responses']['501'];
|
|
736
|
+
};
|
|
737
|
+
};
|
|
738
|
+
/**
|
|
739
|
+
* @description Submit transaction generated by /v0/admin/transfer-preapproval/prepare-send
|
|
740
|
+
* together with its signature. Note that this only waits until the TransferCommand is created.
|
|
741
|
+
* The actual transfer will happen afterwards through automation run by the SVs.
|
|
742
|
+
*/
|
|
743
|
+
submitTransferPreapprovalSend: {
|
|
744
|
+
requestBody: {
|
|
745
|
+
content: {
|
|
746
|
+
'application/json': components['schemas']['SubmitTransferPreapprovalSendRequest'];
|
|
747
|
+
};
|
|
748
|
+
};
|
|
749
|
+
responses: {
|
|
750
|
+
/** @description ok */
|
|
751
|
+
200: {
|
|
752
|
+
content: {
|
|
753
|
+
'application/json': components['schemas']['SubmitTransferPreapprovalSendResponse'];
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
400: components['responses']['400'];
|
|
757
|
+
404: components['responses']['404'];
|
|
758
|
+
501: components['responses']['501'];
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
/**
|
|
762
|
+
* @description Creates a root namespace topology transaction, which will create the party and sets the public key
|
|
763
|
+
* controlling the party namespace,
|
|
764
|
+
* a party to participant mapping topology transaction, which hosts the party on the participant with Confirmation rights,
|
|
765
|
+
* and a party to key mapping topology transaction, which sets the key to authorize daml transactions.
|
|
766
|
+
* The hash of each of these transactions will be signed along with the corresponding topology transaction (unchanged)
|
|
767
|
+
* in the /v0/admin/external-party/topology/submit endpoint
|
|
768
|
+
*/
|
|
769
|
+
generateExternalPartyTopology: {
|
|
770
|
+
requestBody: {
|
|
771
|
+
content: {
|
|
772
|
+
'application/json': components['schemas']['GenerateExternalPartyTopologyRequest'];
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
responses: {
|
|
776
|
+
/** @description ok */
|
|
777
|
+
200: {
|
|
778
|
+
content: {
|
|
779
|
+
'application/json': components['schemas']['GenerateExternalPartyTopologyResponse'];
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
501: components['responses']['501'];
|
|
783
|
+
};
|
|
784
|
+
};
|
|
785
|
+
/**
|
|
786
|
+
* @description Constructs a SignedTopologyTransaction and writes the topology transactions to the authorized store.
|
|
787
|
+
* The input will consist of the unchanged topology transaction and the signed hash from the /v0/external-party-topology/generate endpoint
|
|
788
|
+
*/
|
|
789
|
+
submitExternalPartyTopology: {
|
|
790
|
+
requestBody: {
|
|
791
|
+
content: {
|
|
792
|
+
'application/json': components['schemas']['SubmitExternalPartyTopologyRequest'];
|
|
793
|
+
};
|
|
794
|
+
};
|
|
795
|
+
responses: {
|
|
796
|
+
/** @description ok */
|
|
797
|
+
200: {
|
|
798
|
+
content: {
|
|
799
|
+
'application/json': components['schemas']['SubmitExternalPartyTopologyResponse'];
|
|
800
|
+
};
|
|
801
|
+
};
|
|
802
|
+
501: components['responses']['501'];
|
|
803
|
+
};
|
|
804
|
+
};
|
|
805
|
+
/** @description List all ExternalPartySetupProposal contracts. */
|
|
806
|
+
listExternalPartySetupProposals: {
|
|
807
|
+
responses: {
|
|
808
|
+
/** @description ok */
|
|
809
|
+
200: {
|
|
810
|
+
content: {
|
|
811
|
+
'application/json': components['schemas']['ListExternalPartySetupProposalsResponse'];
|
|
812
|
+
};
|
|
813
|
+
};
|
|
814
|
+
501: components['responses']['501'];
|
|
815
|
+
};
|
|
816
|
+
};
|
|
817
|
+
/**
|
|
818
|
+
* @description Create the ExternalPartySetupProposal contract as the validator operator
|
|
819
|
+
* which then has to be accepted by the external party using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
820
|
+
* and /v0/admin/external-party/setup-proposal/submit-accept
|
|
821
|
+
*/
|
|
822
|
+
createExternalPartySetupProposal: {
|
|
823
|
+
requestBody: {
|
|
824
|
+
content: {
|
|
825
|
+
'application/json': components['schemas']['CreateExternalPartySetupProposalRequest'];
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
responses: {
|
|
829
|
+
/** @description ok */
|
|
830
|
+
200: {
|
|
831
|
+
content: {
|
|
832
|
+
'application/json': components['schemas']['CreateExternalPartySetupProposalResponse'];
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
404: components['responses']['404'];
|
|
836
|
+
409: components['responses']['409'];
|
|
837
|
+
501: components['responses']['501'];
|
|
838
|
+
};
|
|
839
|
+
};
|
|
840
|
+
/**
|
|
841
|
+
* @description Given a contract id of an ExternalPartySetupProposal, prepare the transaction
|
|
842
|
+
* to accept it such that it can be signed externally and then submitted using
|
|
843
|
+
* /v0/admin/external-party/setup-proposal/submit-accept
|
|
844
|
+
*/
|
|
845
|
+
prepareAcceptExternalPartySetupProposal: {
|
|
846
|
+
requestBody: {
|
|
847
|
+
content: {
|
|
848
|
+
'application/json': components['schemas']['PrepareAcceptExternalPartySetupProposalRequest'];
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
responses: {
|
|
852
|
+
/** @description ok */
|
|
853
|
+
200: {
|
|
854
|
+
content: {
|
|
855
|
+
'application/json': components['schemas']['PrepareAcceptExternalPartySetupProposalResponse'];
|
|
856
|
+
};
|
|
857
|
+
};
|
|
858
|
+
400: components['responses']['400'];
|
|
859
|
+
404: components['responses']['404'];
|
|
860
|
+
501: components['responses']['501'];
|
|
861
|
+
};
|
|
862
|
+
};
|
|
863
|
+
/**
|
|
864
|
+
* @description Submit a transaction prepared using /v0/admin/external-party/setup-proposal/prepare-accept
|
|
865
|
+
* together with its signature.
|
|
866
|
+
*/
|
|
867
|
+
submitAcceptExternalPartySetupProposal: {
|
|
868
|
+
requestBody: {
|
|
869
|
+
content: {
|
|
870
|
+
'application/json': components['schemas']['SubmitAcceptExternalPartySetupProposalRequest'];
|
|
871
|
+
};
|
|
872
|
+
};
|
|
873
|
+
responses: {
|
|
874
|
+
/** @description ok */
|
|
875
|
+
200: {
|
|
876
|
+
content: {
|
|
877
|
+
'application/json': components['schemas']['SubmitAcceptExternalPartySetupProposalResponse'];
|
|
878
|
+
};
|
|
879
|
+
};
|
|
880
|
+
404: components['responses']['404'];
|
|
881
|
+
501: components['responses']['501'];
|
|
882
|
+
};
|
|
883
|
+
};
|
|
884
|
+
/** @description Get the balance of an external party. */
|
|
885
|
+
getExternalPartyBalance: {
|
|
886
|
+
parameters: {
|
|
887
|
+
query: {
|
|
888
|
+
party_id: string;
|
|
889
|
+
};
|
|
890
|
+
};
|
|
891
|
+
responses: {
|
|
892
|
+
/** @description ok */
|
|
893
|
+
200: {
|
|
894
|
+
content: {
|
|
895
|
+
'application/json': components['schemas']['ExternalPartyBalanceResponse'];
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
404: components['responses']['404'];
|
|
899
|
+
501: components['responses']['501'];
|
|
900
|
+
};
|
|
901
|
+
};
|
|
902
|
+
}
|
|
903
|
+
//# sourceMappingURL=validator-internal.d.ts.map
|