@console-wallet/dapp-sdk 2.0.3 → 2.1.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/CHANGELOG.md +34 -0
- package/README.md +2 -2
- package/dist/cjs/api/client.api.js +1 -1
- package/dist/cjs/api/client.api.js.map +1 -1
- package/dist/cjs/helpers/handleResponse.helper.js +0 -1
- package/dist/cjs/helpers/handleResponse.helper.js.map +1 -1
- package/dist/cjs/openapi.json +2284 -0
- package/dist/cjs/requests/connect.js +3 -8
- package/dist/cjs/requests/connect.js.map +1 -1
- package/dist/cjs/services/wc-service/wc-service.d.ts +29 -1
- package/dist/cjs/services/wc-service/wc-service.js +40 -9
- package/dist/cjs/services/wc-service/wc-service.js.map +1 -1
- package/dist/esm/api/client.api.js +1 -1
- package/dist/esm/api/client.api.js.map +1 -1
- package/dist/esm/helpers/handleResponse.helper.js +0 -1
- package/dist/esm/helpers/handleResponse.helper.js.map +1 -1
- package/dist/esm/openapi.json +2284 -0
- package/dist/esm/requests/connect.js +3 -8
- package/dist/esm/requests/connect.js.map +1 -1
- package/dist/esm/services/wc-service/wc-service.d.ts +29 -1
- package/dist/esm/services/wc-service/wc-service.js +40 -9
- package/dist/esm/services/wc-service/wc-service.js.map +1 -1
- package/package.json +4 -4
|
@@ -0,0 +1,2284 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Canton Wallet Dapp SDK",
|
|
5
|
+
"version": "2.1.0"
|
|
6
|
+
},
|
|
7
|
+
"components": {
|
|
8
|
+
"schemas": {
|
|
9
|
+
"AvailabilityResponse": {
|
|
10
|
+
"additionalProperties": false,
|
|
11
|
+
"description": "Response for check availability query; mirrors `AvailabilityStatus`.",
|
|
12
|
+
"properties": {
|
|
13
|
+
"currentVersion": {
|
|
14
|
+
"$ref": "#/definitions/WalletVersion"
|
|
15
|
+
},
|
|
16
|
+
"isExtensionCapableByVersion": {
|
|
17
|
+
"type": "boolean"
|
|
18
|
+
},
|
|
19
|
+
"minimalCapableVersion": {
|
|
20
|
+
"$ref": "#/definitions/WalletVersion"
|
|
21
|
+
},
|
|
22
|
+
"status": {
|
|
23
|
+
"$ref": "#/definitions/AvailabilityStatus"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"required": [
|
|
27
|
+
"status"
|
|
28
|
+
],
|
|
29
|
+
"type": "object"
|
|
30
|
+
},
|
|
31
|
+
"AvailabilityStatus": {
|
|
32
|
+
"description": "Extension availability status",
|
|
33
|
+
"enum": [
|
|
34
|
+
"installed",
|
|
35
|
+
"notInstalled"
|
|
36
|
+
],
|
|
37
|
+
"type": "string"
|
|
38
|
+
},
|
|
39
|
+
"Base64Message": {
|
|
40
|
+
"additionalProperties": false,
|
|
41
|
+
"description": "Message body encoded as a base64 string.",
|
|
42
|
+
"properties": {
|
|
43
|
+
"base64": {
|
|
44
|
+
"type": "string"
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
"required": [
|
|
48
|
+
"base64"
|
|
49
|
+
],
|
|
50
|
+
"type": "object"
|
|
51
|
+
},
|
|
52
|
+
"BatchEnum": {
|
|
53
|
+
"description": "Enumerates the kinds of operations that can be batched for signing.",
|
|
54
|
+
"enum": [
|
|
55
|
+
"SEND",
|
|
56
|
+
"UNKNOWN"
|
|
57
|
+
],
|
|
58
|
+
"type": "string"
|
|
59
|
+
},
|
|
60
|
+
"BatchSend": {
|
|
61
|
+
"additionalProperties": false,
|
|
62
|
+
"description": "A batch of token transfer requests to be signed and sent.",
|
|
63
|
+
"properties": {
|
|
64
|
+
"batchType": {
|
|
65
|
+
"description": "A batch of token transfer requests.",
|
|
66
|
+
"type": "string",
|
|
67
|
+
"enum": [
|
|
68
|
+
"SEND"
|
|
69
|
+
]
|
|
70
|
+
},
|
|
71
|
+
"requests": {
|
|
72
|
+
"items": {
|
|
73
|
+
"additionalProperties": false,
|
|
74
|
+
"properties": {
|
|
75
|
+
"amount": {
|
|
76
|
+
"type": "string"
|
|
77
|
+
},
|
|
78
|
+
"expireDate": {
|
|
79
|
+
"type": "string"
|
|
80
|
+
},
|
|
81
|
+
"from": {
|
|
82
|
+
"type": "string"
|
|
83
|
+
},
|
|
84
|
+
"memo": {
|
|
85
|
+
"type": "string"
|
|
86
|
+
},
|
|
87
|
+
"to": {
|
|
88
|
+
"type": "string"
|
|
89
|
+
},
|
|
90
|
+
"token": {
|
|
91
|
+
"$ref": "#/definitions/CoinEnum"
|
|
92
|
+
},
|
|
93
|
+
"type": {
|
|
94
|
+
"$ref": "#/definitions/SendType"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"required": [
|
|
98
|
+
"amount",
|
|
99
|
+
"expireDate",
|
|
100
|
+
"from",
|
|
101
|
+
"to",
|
|
102
|
+
"token",
|
|
103
|
+
"type"
|
|
104
|
+
],
|
|
105
|
+
"type": "object"
|
|
106
|
+
},
|
|
107
|
+
"type": "array"
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"required": [
|
|
111
|
+
"batchType",
|
|
112
|
+
"requests"
|
|
113
|
+
],
|
|
114
|
+
"type": "object"
|
|
115
|
+
},
|
|
116
|
+
"BatchUnknown": {
|
|
117
|
+
"additionalProperties": false,
|
|
118
|
+
"description": "A batch of unrecognized or custom requests to be signed.",
|
|
119
|
+
"properties": {
|
|
120
|
+
"batchType": {
|
|
121
|
+
"description": "A batch of unrecognized or custom requests.",
|
|
122
|
+
"type": "string",
|
|
123
|
+
"enum": [
|
|
124
|
+
"UNKNOWN"
|
|
125
|
+
]
|
|
126
|
+
},
|
|
127
|
+
"hashToSign": {
|
|
128
|
+
"type": "string"
|
|
129
|
+
},
|
|
130
|
+
"requests": {
|
|
131
|
+
"items": {
|
|
132
|
+
"additionalProperties": {
|
|
133
|
+
"type": "string"
|
|
134
|
+
},
|
|
135
|
+
"type": "object"
|
|
136
|
+
},
|
|
137
|
+
"type": "array"
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
"required": [
|
|
141
|
+
"batchType",
|
|
142
|
+
"hashToSign",
|
|
143
|
+
"requests"
|
|
144
|
+
],
|
|
145
|
+
"type": "object"
|
|
146
|
+
},
|
|
147
|
+
"CAIP2_CANTON_NETWORKS": {
|
|
148
|
+
"enum": [
|
|
149
|
+
"canton:devnet",
|
|
150
|
+
"canton:testnet",
|
|
151
|
+
"canton:mainnet"
|
|
152
|
+
],
|
|
153
|
+
"type": "string"
|
|
154
|
+
},
|
|
155
|
+
"CANTON_NETWORK_VARIANTS": {
|
|
156
|
+
"description": "Supported Canton network variants the wallet can operate against.",
|
|
157
|
+
"enum": [
|
|
158
|
+
"CANTON_NETWORK_DEV",
|
|
159
|
+
"CANTON_NETWORK_TEST",
|
|
160
|
+
"CANTON_NETWORK"
|
|
161
|
+
],
|
|
162
|
+
"type": "string"
|
|
163
|
+
},
|
|
164
|
+
"CCPrices": {
|
|
165
|
+
"additionalProperties": false,
|
|
166
|
+
"description": "Canton Coin price data transfer object\n\nRepresents the current and historical price points of the native token (Canton Coin) at various significant time intervals. This DTO provides a comprehensive view of price movements for analytical purposes.",
|
|
167
|
+
"properties": {
|
|
168
|
+
"current": {
|
|
169
|
+
"description": "Current price of the token",
|
|
170
|
+
"format": "decimal",
|
|
171
|
+
"type": "string",
|
|
172
|
+
"nullable": true,
|
|
173
|
+
"example": "0.154"
|
|
174
|
+
},
|
|
175
|
+
"one_day_ago": {
|
|
176
|
+
"description": "Price exactly 24 hours ago\n\nThe price from 24 hours prior to the current time, enabling precise 24-hour change calculations.",
|
|
177
|
+
"format": "decimal",
|
|
178
|
+
"type": "string",
|
|
179
|
+
"nullable": true,
|
|
180
|
+
"example": "0.154"
|
|
181
|
+
},
|
|
182
|
+
"one_month_ago": {
|
|
183
|
+
"description": "Price from one month ago\n\nThe price from approximately 30 days prior to the current time.",
|
|
184
|
+
"format": "decimal",
|
|
185
|
+
"type": "string",
|
|
186
|
+
"nullable": true,
|
|
187
|
+
"example": "0.154"
|
|
188
|
+
},
|
|
189
|
+
"one_week_ago": {
|
|
190
|
+
"description": "Price from one week ago\n\nThe price from 7 days prior to the current time.",
|
|
191
|
+
"format": "decimal",
|
|
192
|
+
"type": "string",
|
|
193
|
+
"nullable": true,
|
|
194
|
+
"example": "0.154"
|
|
195
|
+
},
|
|
196
|
+
"one_year_ago": {
|
|
197
|
+
"description": "Price from one year ago\n\nThe price from 365 days prior to the current time.",
|
|
198
|
+
"format": "decimal",
|
|
199
|
+
"type": "string",
|
|
200
|
+
"nullable": true,
|
|
201
|
+
"example": "0.154"
|
|
202
|
+
},
|
|
203
|
+
"start_of_day": {
|
|
204
|
+
"description": "Price at the start of the current day\n\nRepresents the price at the beginning of the current day (00:00:00 UTC), useful for calculating daily price changes.",
|
|
205
|
+
"format": "decimal",
|
|
206
|
+
"type": "string",
|
|
207
|
+
"nullable": true,
|
|
208
|
+
"example": "0.154"
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"type": "object"
|
|
212
|
+
},
|
|
213
|
+
"Coin": {
|
|
214
|
+
"enum": [
|
|
215
|
+
"CC",
|
|
216
|
+
"CBTC",
|
|
217
|
+
"USDCx"
|
|
218
|
+
],
|
|
219
|
+
"type": "string"
|
|
220
|
+
},
|
|
221
|
+
"CoinEnum": {
|
|
222
|
+
"enum": [
|
|
223
|
+
"CC",
|
|
224
|
+
"CBTC",
|
|
225
|
+
"USDCx"
|
|
226
|
+
],
|
|
227
|
+
"type": "string"
|
|
228
|
+
},
|
|
229
|
+
"CoinTransfersFromNodeQuery": {
|
|
230
|
+
"description": "Query parameters accepted by the node for party standard coin transfers.",
|
|
231
|
+
"not": {}
|
|
232
|
+
},
|
|
233
|
+
"CoinTransfersFromNodeRequest": {
|
|
234
|
+
"additionalProperties": false,
|
|
235
|
+
"properties": {
|
|
236
|
+
"network": {
|
|
237
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
238
|
+
}
|
|
239
|
+
},
|
|
240
|
+
"required": [
|
|
241
|
+
"network"
|
|
242
|
+
],
|
|
243
|
+
"type": "object"
|
|
244
|
+
},
|
|
245
|
+
"CoinTransfersFromNodeResponse": {
|
|
246
|
+
"anyOf": [
|
|
247
|
+
{
|
|
248
|
+
"$ref": "#/definitions/GetTransfersHistoryResponseDTO"
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"nullable": true
|
|
252
|
+
}
|
|
253
|
+
],
|
|
254
|
+
"description": "Paged standard coin transfer summaries or null if no data exists."
|
|
255
|
+
},
|
|
256
|
+
"CombinedCursor": {
|
|
257
|
+
"description": "CombinedCursor CombinedCursor format: `{datetime},{id}`.\n- `datetime`: ISO-8601 timestamp with UTC timezone (e.g., 2025-10-28T10:15:00.000000Z)\n- `id`: **optional** uint64, unique index or sequence number\n\nExamples:\n- With ID: \"2025-10-28T10:15:00.000000Z,123\"\n- Without ID: \"2025-10-28T10:15:00.000000Z\"",
|
|
258
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z(?:,\\d+)?$",
|
|
259
|
+
"type": "string",
|
|
260
|
+
"example": "2025-10-28T10:15:00.000000Z,123"
|
|
261
|
+
},
|
|
262
|
+
"CommonDataFieldsRequest": {
|
|
263
|
+
"additionalProperties": false,
|
|
264
|
+
"description": "Common fields included in every request message posted to the wallet.\n\nFields:\n- `type`: The message type, one of PUBLIC_REQUESTS.\n- `target`: Target identifier to scope messages to the wallet.\n- `id`: Correlation ID used to match responses.",
|
|
265
|
+
"properties": {
|
|
266
|
+
"fromOrigin": {
|
|
267
|
+
"type": "string"
|
|
268
|
+
},
|
|
269
|
+
"id": {
|
|
270
|
+
"type": "string"
|
|
271
|
+
},
|
|
272
|
+
"sdkVersion": {
|
|
273
|
+
"type": "string"
|
|
274
|
+
},
|
|
275
|
+
"target": {
|
|
276
|
+
"type": "string"
|
|
277
|
+
},
|
|
278
|
+
"type": {
|
|
279
|
+
"type": "string"
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
"required": [
|
|
283
|
+
"type",
|
|
284
|
+
"target",
|
|
285
|
+
"id",
|
|
286
|
+
"fromOrigin"
|
|
287
|
+
],
|
|
288
|
+
"type": "object"
|
|
289
|
+
},
|
|
290
|
+
"CommonDataFieldsTrigger": {
|
|
291
|
+
"additionalProperties": false,
|
|
292
|
+
"properties": {
|
|
293
|
+
"forOrigin": {
|
|
294
|
+
"description": "Optional origin the trigger is intended for; used by the wallet.",
|
|
295
|
+
"type": "string"
|
|
296
|
+
},
|
|
297
|
+
"fromOrigin": {
|
|
298
|
+
"type": "string"
|
|
299
|
+
},
|
|
300
|
+
"id": {
|
|
301
|
+
"type": "string"
|
|
302
|
+
},
|
|
303
|
+
"sdkVersion": {
|
|
304
|
+
"type": "string"
|
|
305
|
+
},
|
|
306
|
+
"target": {
|
|
307
|
+
"type": "string"
|
|
308
|
+
},
|
|
309
|
+
"type": {
|
|
310
|
+
"type": "string"
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"required": [
|
|
314
|
+
"fromOrigin",
|
|
315
|
+
"id",
|
|
316
|
+
"target",
|
|
317
|
+
"type"
|
|
318
|
+
],
|
|
319
|
+
"type": "object"
|
|
320
|
+
},
|
|
321
|
+
"ConnectRequest": {
|
|
322
|
+
"additionalProperties": false,
|
|
323
|
+
"description": "Optional metadata provided by a dApp when initiating a connection. Used by the wallet UI to present context to the user.",
|
|
324
|
+
"properties": {
|
|
325
|
+
"icon": {
|
|
326
|
+
"type": "string"
|
|
327
|
+
},
|
|
328
|
+
"name": {
|
|
329
|
+
"type": "string"
|
|
330
|
+
},
|
|
331
|
+
"target": {
|
|
332
|
+
"$ref": "#/definitions/ConnectVariant"
|
|
333
|
+
}
|
|
334
|
+
},
|
|
335
|
+
"type": "object"
|
|
336
|
+
},
|
|
337
|
+
"ConnectRequestInternal": {
|
|
338
|
+
"additionalProperties": false,
|
|
339
|
+
"description": "Internal-only fields included by the wallet during connection flow. Not provided by the dApp.",
|
|
340
|
+
"properties": {
|
|
341
|
+
"referer": {
|
|
342
|
+
"type": "string"
|
|
343
|
+
}
|
|
344
|
+
},
|
|
345
|
+
"required": [
|
|
346
|
+
"referer"
|
|
347
|
+
],
|
|
348
|
+
"type": "object"
|
|
349
|
+
},
|
|
350
|
+
"ConnectResponse": {
|
|
351
|
+
"additionalProperties": false,
|
|
352
|
+
"description": "Response for connect/status queries; mirrors `ConnectStatus`.",
|
|
353
|
+
"properties": {
|
|
354
|
+
"isConnected": {
|
|
355
|
+
"type": "boolean"
|
|
356
|
+
},
|
|
357
|
+
"isNetworkConnected": {
|
|
358
|
+
"type": "boolean"
|
|
359
|
+
},
|
|
360
|
+
"networkReason": {
|
|
361
|
+
"type": "string"
|
|
362
|
+
},
|
|
363
|
+
"reason": {
|
|
364
|
+
"type": "string"
|
|
365
|
+
}
|
|
366
|
+
},
|
|
367
|
+
"required": [
|
|
368
|
+
"isConnected"
|
|
369
|
+
],
|
|
370
|
+
"type": "object"
|
|
371
|
+
},
|
|
372
|
+
"ConnectResponseLegacy": {
|
|
373
|
+
"description": "Connection status reported by the wallet for the dApp origin.",
|
|
374
|
+
"enum": [
|
|
375
|
+
"connected",
|
|
376
|
+
"disconnected"
|
|
377
|
+
],
|
|
378
|
+
"type": "string"
|
|
379
|
+
},
|
|
380
|
+
"ConnectResult": {
|
|
381
|
+
"$ref": "#/definitions/ConnectResponse",
|
|
382
|
+
"description": "Response for connect/status queries; mirrors `ConnectStatus`."
|
|
383
|
+
},
|
|
384
|
+
"ConnectStatus": {
|
|
385
|
+
"description": "Connection status reported by the wallet for the dApp origin.",
|
|
386
|
+
"type": "boolean"
|
|
387
|
+
},
|
|
388
|
+
"ConnectVariant": {
|
|
389
|
+
"description": "Connection variant. \"local\" for only extension connection, \"remote\" for only remote connection (mobile app), \"combined\" for both extension and remote connection. default: \"combined\"",
|
|
390
|
+
"enum": [
|
|
391
|
+
"local",
|
|
392
|
+
"remote",
|
|
393
|
+
"combined"
|
|
394
|
+
],
|
|
395
|
+
"type": "string"
|
|
396
|
+
},
|
|
397
|
+
"ConsoleWalletError": {
|
|
398
|
+
"$ref": "#/definitions/ProviderRpcError"
|
|
399
|
+
},
|
|
400
|
+
"ContractId": {
|
|
401
|
+
"description": "ContractId Daml contract ID encoded as a 138-character lowercase hexadecimal string",
|
|
402
|
+
"format": "byte",
|
|
403
|
+
"pattern": "^00[a-f0-9]{136}$",
|
|
404
|
+
"type": "string",
|
|
405
|
+
"example": "001dbd4eac6d06371a1dc850d3cc3d1039688403fe2f9ab98985e8e8d0701f211fca111220b859db866c3cf320cf3dda548cca9a43d7770b6a5a5937a926b771a222674385"
|
|
406
|
+
},
|
|
407
|
+
"DisconnectResponse": {
|
|
408
|
+
"description": "Response for disconnect",
|
|
409
|
+
"nullable": true
|
|
410
|
+
},
|
|
411
|
+
"EIP_1474_ERROR_ENUM": {
|
|
412
|
+
"enum": [
|
|
413
|
+
0,
|
|
414
|
+
1,
|
|
415
|
+
2,
|
|
416
|
+
3,
|
|
417
|
+
4,
|
|
418
|
+
5,
|
|
419
|
+
6,
|
|
420
|
+
7,
|
|
421
|
+
8,
|
|
422
|
+
9,
|
|
423
|
+
10,
|
|
424
|
+
11,
|
|
425
|
+
12,
|
|
426
|
+
13,
|
|
427
|
+
14,
|
|
428
|
+
15
|
|
429
|
+
],
|
|
430
|
+
"type": "number"
|
|
431
|
+
},
|
|
432
|
+
"ElementType<structure-1531355553-79543-81974-1531355553-79543-81976-1531355553-79535-81977-1531355553-79492-82075-1531355553-0-347510[]>": {
|
|
433
|
+
"additionalProperties": false,
|
|
434
|
+
"description": "Element type of an array; resolves `U` from `T extends U[]`.",
|
|
435
|
+
"properties": {
|
|
436
|
+
"amount": {
|
|
437
|
+
"description": "The amount of tokens to be transferred. Expressed in the base unit with full precision (e.g., 10.0 = 10 tokens).",
|
|
438
|
+
"format": "decimal",
|
|
439
|
+
"type": "string",
|
|
440
|
+
"example": "10.00000"
|
|
441
|
+
},
|
|
442
|
+
"contract_id": {
|
|
443
|
+
"anyOf": [
|
|
444
|
+
{
|
|
445
|
+
"nullable": true
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
"$ref": "#/definitions/ContractId"
|
|
449
|
+
}
|
|
450
|
+
],
|
|
451
|
+
"description": "The Daml contract ID representing this offer. Used to reference and exercise choices on the contract."
|
|
452
|
+
},
|
|
453
|
+
"event_id": {
|
|
454
|
+
"$ref": "#/definitions/EventId",
|
|
455
|
+
"description": "Unique identifier of the Daml event that created this offer. Used to track the creation event in the transaction log."
|
|
456
|
+
},
|
|
457
|
+
"external_cc_price": {
|
|
458
|
+
"description": "External market Canton-coin (CC) price in USD.\n\nThis price is sourced from external markets (e.g., exchanges) and reflects the current market value of CC.\n\nAvailable **only on mainnet**, where external price feeds are integrated. It can be used for reporting, analysis, or comparison against the internal price.",
|
|
459
|
+
"type": "string",
|
|
460
|
+
"nullable": true
|
|
461
|
+
},
|
|
462
|
+
"internal_cc_price": {
|
|
463
|
+
"description": "Internal Canton-coin (CC) price in USD.\n\nThis is the price approved by the committee via voting and used internally for calculations, valuations, and offer execution logic. It is always present and serves as the canonical internal valuation of CC.\n\nThe field not valid for /api/v1/offers/search. Use /api/v2/offers/search",
|
|
464
|
+
"type": "string"
|
|
465
|
+
},
|
|
466
|
+
"offer_type": {
|
|
467
|
+
"$ref": "#/definitions/OfferType",
|
|
468
|
+
"description": "Exact type of the offer."
|
|
469
|
+
},
|
|
470
|
+
"provider_party_id": {
|
|
471
|
+
"$ref": "#/definitions/PartyId",
|
|
472
|
+
"description": "The party identifier of the offer provider.\n\nThis is the party who is providing the offer creation."
|
|
473
|
+
},
|
|
474
|
+
"receiver_party_id": {
|
|
475
|
+
"$ref": "#/definitions/PartyId",
|
|
476
|
+
"description": "The intended recipient of the transfer (receiver in the first leg). May differ from final recipient if conditional logic applies."
|
|
477
|
+
},
|
|
478
|
+
"record_time": {
|
|
479
|
+
"description": "Assigned by the Canton domain, this reflects when the transaction was sequenced. Format: ISO 8601 Example: `\"2025-04-05T10:00:00Z\"`",
|
|
480
|
+
"format": "date-time",
|
|
481
|
+
"type": "string"
|
|
482
|
+
},
|
|
483
|
+
"sender_party_id": {
|
|
484
|
+
"$ref": "#/definitions/PartyId",
|
|
485
|
+
"description": "The party initiating the transfer (sender of the first leg). This is the original owner of the tokens being transferred."
|
|
486
|
+
},
|
|
487
|
+
"status": {
|
|
488
|
+
"$ref": "#/definitions/OfferStatus",
|
|
489
|
+
"description": "The current status of the offer (e.g., pending, executed, failed). Reflects the state of the Daml contract and whether transfers have been completed."
|
|
490
|
+
}
|
|
491
|
+
},
|
|
492
|
+
"required": [
|
|
493
|
+
"amount",
|
|
494
|
+
"event_id",
|
|
495
|
+
"internal_cc_price",
|
|
496
|
+
"offer_type",
|
|
497
|
+
"provider_party_id",
|
|
498
|
+
"receiver_party_id",
|
|
499
|
+
"record_time",
|
|
500
|
+
"sender_party_id",
|
|
501
|
+
"status"
|
|
502
|
+
],
|
|
503
|
+
"type": "object"
|
|
504
|
+
},
|
|
505
|
+
"EventId": {
|
|
506
|
+
"description": "eventId Daml event ID format: `update_id:number`.\n- `update_id`: 64-character hexadecimal string\n- `number`: **uint64**, event index within the update",
|
|
507
|
+
"format": "update_id:number",
|
|
508
|
+
"pattern": "^1220[a-f0-9]{64}:\\d+$",
|
|
509
|
+
"type": "string",
|
|
510
|
+
"example": "1220f66d301e0049af910c57e04f87697d0377c6086290bf8d6f89a64fad54ad7de3:46"
|
|
511
|
+
},
|
|
512
|
+
"ExternalTxId": {
|
|
513
|
+
"description": "Unique identifier of the signed transaction given by the Signing Provider. This may not be the same as the internal txId given by the Wallet Gateway.",
|
|
514
|
+
"type": "string"
|
|
515
|
+
},
|
|
516
|
+
"GetAccountResponse": {
|
|
517
|
+
"anyOf": [
|
|
518
|
+
{
|
|
519
|
+
"$ref": "#/definitions/Wallet"
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"not": {}
|
|
523
|
+
}
|
|
524
|
+
],
|
|
525
|
+
"description": "Single account or undefined when no active account is set."
|
|
526
|
+
},
|
|
527
|
+
"GetAccountsResponse": {
|
|
528
|
+
"anyOf": [
|
|
529
|
+
{
|
|
530
|
+
"items": {
|
|
531
|
+
"$ref": "#/definitions/Wallet"
|
|
532
|
+
},
|
|
533
|
+
"type": "array"
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"not": {}
|
|
537
|
+
}
|
|
538
|
+
],
|
|
539
|
+
"description": "Array of accounts or undefined when no accounts are available."
|
|
540
|
+
},
|
|
541
|
+
"GetBalanceRequest": {
|
|
542
|
+
"additionalProperties": false,
|
|
543
|
+
"description": "Party/network pair used to request balances from the wallet/indexer.",
|
|
544
|
+
"properties": {
|
|
545
|
+
"network": {
|
|
546
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
547
|
+
},
|
|
548
|
+
"party": {
|
|
549
|
+
"type": "string"
|
|
550
|
+
}
|
|
551
|
+
},
|
|
552
|
+
"required": [
|
|
553
|
+
"party",
|
|
554
|
+
"network"
|
|
555
|
+
],
|
|
556
|
+
"type": "object"
|
|
557
|
+
},
|
|
558
|
+
"GetBalanceResponse": {
|
|
559
|
+
"additionalProperties": false,
|
|
560
|
+
"description": "Token list, split-balance flag (multi-network party), and aggregated price.",
|
|
561
|
+
"properties": {
|
|
562
|
+
"isSplitedBalance": {
|
|
563
|
+
"type": "boolean"
|
|
564
|
+
},
|
|
565
|
+
"price": {
|
|
566
|
+
"type": "string"
|
|
567
|
+
},
|
|
568
|
+
"tokens": {
|
|
569
|
+
"items": {
|
|
570
|
+
"$ref": "#/definitions/TokenData"
|
|
571
|
+
},
|
|
572
|
+
"type": "array"
|
|
573
|
+
}
|
|
574
|
+
},
|
|
575
|
+
"required": [
|
|
576
|
+
"tokens",
|
|
577
|
+
"isSplitedBalance",
|
|
578
|
+
"price"
|
|
579
|
+
],
|
|
580
|
+
"type": "object"
|
|
581
|
+
},
|
|
582
|
+
"GetCoinsResponse": {
|
|
583
|
+
"additionalProperties": false,
|
|
584
|
+
"properties": {
|
|
585
|
+
"prices": {
|
|
586
|
+
"anyOf": [
|
|
587
|
+
{
|
|
588
|
+
"additionalProperties": false,
|
|
589
|
+
"properties": {
|
|
590
|
+
"CBTC": {
|
|
591
|
+
"$ref": "#/definitions/CCPrices"
|
|
592
|
+
},
|
|
593
|
+
"CC": {
|
|
594
|
+
"$ref": "#/definitions/CCPrices"
|
|
595
|
+
},
|
|
596
|
+
"USDCx": {
|
|
597
|
+
"$ref": "#/definitions/CCPrices"
|
|
598
|
+
}
|
|
599
|
+
},
|
|
600
|
+
"type": "object"
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"nullable": true
|
|
604
|
+
}
|
|
605
|
+
]
|
|
606
|
+
},
|
|
607
|
+
"tokens": {
|
|
608
|
+
"items": {
|
|
609
|
+
"$ref": "#/definitions/TokenData"
|
|
610
|
+
},
|
|
611
|
+
"type": "array"
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"required": [
|
|
615
|
+
"tokens",
|
|
616
|
+
"prices"
|
|
617
|
+
],
|
|
618
|
+
"type": "object"
|
|
619
|
+
},
|
|
620
|
+
"GetPendingTransactionsResponseDTO": {
|
|
621
|
+
"additionalProperties": false,
|
|
622
|
+
"properties": {
|
|
623
|
+
"items": {
|
|
624
|
+
"items": {
|
|
625
|
+
"$ref": "#/definitions/PendingTransfersResponseDTO"
|
|
626
|
+
},
|
|
627
|
+
"type": "array"
|
|
628
|
+
},
|
|
629
|
+
"totalAmount": {
|
|
630
|
+
"type": "number"
|
|
631
|
+
}
|
|
632
|
+
},
|
|
633
|
+
"required": [
|
|
634
|
+
"items",
|
|
635
|
+
"totalAmount"
|
|
636
|
+
],
|
|
637
|
+
"type": "object"
|
|
638
|
+
},
|
|
639
|
+
"GetTransfersHistoryResponseDTO": {
|
|
640
|
+
"additionalProperties": false,
|
|
641
|
+
"properties": {
|
|
642
|
+
"items": {
|
|
643
|
+
"items": {
|
|
644
|
+
"$ref": "#/definitions/TransferResponseDTO"
|
|
645
|
+
},
|
|
646
|
+
"type": "array"
|
|
647
|
+
},
|
|
648
|
+
"totalAmount": {
|
|
649
|
+
"type": "number"
|
|
650
|
+
}
|
|
651
|
+
},
|
|
652
|
+
"required": [
|
|
653
|
+
"items",
|
|
654
|
+
"totalAmount"
|
|
655
|
+
],
|
|
656
|
+
"type": "object"
|
|
657
|
+
},
|
|
658
|
+
"HexMessage": {
|
|
659
|
+
"additionalProperties": false,
|
|
660
|
+
"description": "Message body encoded as a hexadecimal string.",
|
|
661
|
+
"properties": {
|
|
662
|
+
"hex": {
|
|
663
|
+
"type": "string"
|
|
664
|
+
}
|
|
665
|
+
},
|
|
666
|
+
"required": [
|
|
667
|
+
"hex"
|
|
668
|
+
],
|
|
669
|
+
"type": "object"
|
|
670
|
+
},
|
|
671
|
+
"Hint": {
|
|
672
|
+
"description": "The party hint and name of the wallet.",
|
|
673
|
+
"type": "string"
|
|
674
|
+
},
|
|
675
|
+
"INTERNAL_REQUESTS": {
|
|
676
|
+
"description": "Internal message types used for extension background/offscreen communication. Not exposed to dApps directly.",
|
|
677
|
+
"enum": [
|
|
678
|
+
"SAVE_SESSION_DATA",
|
|
679
|
+
"GET_SESSION_DATA",
|
|
680
|
+
"RESET_SESSION_DATA",
|
|
681
|
+
"SET_PAGE_DATA",
|
|
682
|
+
"GET_PAGE_DATA",
|
|
683
|
+
"RESET_PAGE_DATA"
|
|
684
|
+
],
|
|
685
|
+
"type": "string"
|
|
686
|
+
},
|
|
687
|
+
"LedgerApiRequest": {
|
|
688
|
+
"additionalProperties": false,
|
|
689
|
+
"properties": {
|
|
690
|
+
"body": {
|
|
691
|
+
"description": "A serialized body for POST / PUT requests",
|
|
692
|
+
"type": "string"
|
|
693
|
+
},
|
|
694
|
+
"network": {
|
|
695
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
696
|
+
},
|
|
697
|
+
"requestMethod": {
|
|
698
|
+
"description": "A method to send request to",
|
|
699
|
+
"type": "string",
|
|
700
|
+
"enum": [
|
|
701
|
+
"GET"
|
|
702
|
+
],
|
|
703
|
+
"example": "GET"
|
|
704
|
+
},
|
|
705
|
+
"resource": {
|
|
706
|
+
"description": "A url resource to call via sdk",
|
|
707
|
+
"type": "string",
|
|
708
|
+
"example": "/v2/version"
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
"required": [
|
|
712
|
+
"body",
|
|
713
|
+
"network",
|
|
714
|
+
"requestMethod",
|
|
715
|
+
"resource"
|
|
716
|
+
],
|
|
717
|
+
"type": "object"
|
|
718
|
+
},
|
|
719
|
+
"LedgerApiResponse": {
|
|
720
|
+
"$ref": "#/definitions/SdkLedgerProxyResponseDTO"
|
|
721
|
+
},
|
|
722
|
+
"Namespace": {
|
|
723
|
+
"description": "The namespace of the party.",
|
|
724
|
+
"type": "string"
|
|
725
|
+
},
|
|
726
|
+
"Network": {
|
|
727
|
+
"additionalProperties": false,
|
|
728
|
+
"description": "Network metadata for display and routing to indexer/backends.",
|
|
729
|
+
"properties": {
|
|
730
|
+
"accessToken": {
|
|
731
|
+
"type": "string"
|
|
732
|
+
},
|
|
733
|
+
"baseUrl": {
|
|
734
|
+
"type": "string"
|
|
735
|
+
},
|
|
736
|
+
"description": {
|
|
737
|
+
"type": "string"
|
|
738
|
+
},
|
|
739
|
+
"explorerUrl": {
|
|
740
|
+
"type": "string"
|
|
741
|
+
},
|
|
742
|
+
"icon": {
|
|
743
|
+
"type": "string"
|
|
744
|
+
},
|
|
745
|
+
"id": {
|
|
746
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
747
|
+
},
|
|
748
|
+
"identityProviderId": {
|
|
749
|
+
"type": "string"
|
|
750
|
+
},
|
|
751
|
+
"ledgerApi": {
|
|
752
|
+
"type": "string"
|
|
753
|
+
},
|
|
754
|
+
"name": {
|
|
755
|
+
"type": "string"
|
|
756
|
+
},
|
|
757
|
+
"nativeTokenId": {
|
|
758
|
+
"description": "Token ID used as the network's native currency reference.",
|
|
759
|
+
"type": "string"
|
|
760
|
+
},
|
|
761
|
+
"networkId": {
|
|
762
|
+
"$ref": "#/definitions/CAIP2_CANTON_NETWORKS"
|
|
763
|
+
},
|
|
764
|
+
"shortName": {
|
|
765
|
+
"type": "string"
|
|
766
|
+
},
|
|
767
|
+
"synchronizerId": {
|
|
768
|
+
"type": "string"
|
|
769
|
+
}
|
|
770
|
+
},
|
|
771
|
+
"required": [
|
|
772
|
+
"id",
|
|
773
|
+
"networkId",
|
|
774
|
+
"name",
|
|
775
|
+
"description",
|
|
776
|
+
"identityProviderId",
|
|
777
|
+
"baseUrl",
|
|
778
|
+
"nativeTokenId"
|
|
779
|
+
],
|
|
780
|
+
"type": "object"
|
|
781
|
+
},
|
|
782
|
+
"NetworkStatus": {
|
|
783
|
+
"description": "Boolean alias indicating whether the network available",
|
|
784
|
+
"type": "boolean"
|
|
785
|
+
},
|
|
786
|
+
"OfferStatus": {
|
|
787
|
+
"default": "pending",
|
|
788
|
+
"description": "Status of an Offer. One of: pending, completed, rejected, withdrawn, expire, failed.",
|
|
789
|
+
"enum": [
|
|
790
|
+
"pending",
|
|
791
|
+
"completed",
|
|
792
|
+
"rejected",
|
|
793
|
+
"withdrawn",
|
|
794
|
+
"failed",
|
|
795
|
+
"expire"
|
|
796
|
+
],
|
|
797
|
+
"type": "string",
|
|
798
|
+
"example": "pending"
|
|
799
|
+
},
|
|
800
|
+
"OfferType": {
|
|
801
|
+
"default": "allocation",
|
|
802
|
+
"description": "Type of an Offer. One of: allocation, instruction, command.",
|
|
803
|
+
"enum": [
|
|
804
|
+
"allocation",
|
|
805
|
+
"instruction",
|
|
806
|
+
"command"
|
|
807
|
+
],
|
|
808
|
+
"type": "string",
|
|
809
|
+
"example": "allocation"
|
|
810
|
+
},
|
|
811
|
+
"OffersFromNodeQuery": {
|
|
812
|
+
"description": "Query parameters accepted by the indexer for offers by sender.",
|
|
813
|
+
"not": {}
|
|
814
|
+
},
|
|
815
|
+
"OffersFromNodeRequest": {
|
|
816
|
+
"additionalProperties": false,
|
|
817
|
+
"properties": {
|
|
818
|
+
"network": {
|
|
819
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
820
|
+
}
|
|
821
|
+
},
|
|
822
|
+
"required": [
|
|
823
|
+
"network"
|
|
824
|
+
],
|
|
825
|
+
"type": "object"
|
|
826
|
+
},
|
|
827
|
+
"OffersFromNodeResponse": {
|
|
828
|
+
"anyOf": [
|
|
829
|
+
{
|
|
830
|
+
"$ref": "#/definitions/GetPendingTransactionsResponseDTO"
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"nullable": true
|
|
834
|
+
}
|
|
835
|
+
],
|
|
836
|
+
"description": "Paged offers response or null if no data exists."
|
|
837
|
+
},
|
|
838
|
+
"OffersQuery": {
|
|
839
|
+
"description": "Query parameters accepted by the indexer for offers by sender.",
|
|
840
|
+
"not": {}
|
|
841
|
+
},
|
|
842
|
+
"OffersRequest": {
|
|
843
|
+
"additionalProperties": false,
|
|
844
|
+
"properties": {
|
|
845
|
+
"network": {
|
|
846
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"required": [
|
|
850
|
+
"network"
|
|
851
|
+
],
|
|
852
|
+
"type": "object"
|
|
853
|
+
},
|
|
854
|
+
"OffersResponse": {
|
|
855
|
+
"anyOf": [
|
|
856
|
+
{
|
|
857
|
+
"$ref": "#/definitions/PagedByCombinedCursorResponseOffer"
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"nullable": true
|
|
861
|
+
}
|
|
862
|
+
],
|
|
863
|
+
"description": "Paged offers response or null if no data exists."
|
|
864
|
+
},
|
|
865
|
+
"OutputTimeLock": {
|
|
866
|
+
"additionalProperties": false,
|
|
867
|
+
"description": "DTO representing a time lock condition on a transaction output.\n\nA time lock restricts spending of funds until certain conditions are met, such as a specific time or involvement of specific parties. This is often used for escrow, vesting, or delayed transfers.",
|
|
868
|
+
"properties": {
|
|
869
|
+
"context": {
|
|
870
|
+
"type": "string",
|
|
871
|
+
"nullable": true,
|
|
872
|
+
"example": "transfer to 'dev_test::122035334a67f4de9d2aecdd5b83485cbaee20682e3f0491bdf12b0a32d81cc93c90'"
|
|
873
|
+
},
|
|
874
|
+
"expires_at": {
|
|
875
|
+
"description": "The UTC timestamp after which the output can be spent.\n\nBefore this time, the output is locked and cannot be consumed in a transaction. Expressed in ISO 8601 format.\n\nExample: `\"2025-12-31T23:59:59Z\"`",
|
|
876
|
+
"format": "date-time",
|
|
877
|
+
"type": "string",
|
|
878
|
+
"example": "2025-12-31T23:59:59Z"
|
|
879
|
+
},
|
|
880
|
+
"holders": {
|
|
881
|
+
"description": "The list of parties (holders) who are authorized to spend this output once the lock expires.\n\nAll listed parties must agree (depending on script logic) to unlock and spend the funds. Used to enforce multi-party control over locked assets.",
|
|
882
|
+
"items": {
|
|
883
|
+
"$ref": "#/definitions/PartyId"
|
|
884
|
+
},
|
|
885
|
+
"type": "array",
|
|
886
|
+
"example": [
|
|
887
|
+
"DSO::1220be58c29e65de40bf273be1dc2b266d43a9a002ea5b18955aeef7aac881bb471a",
|
|
888
|
+
"alice::1220c7c1e52f96fe1b7165f890cdcf90991691e7555a7f0ca173757208f5c57541c4"
|
|
889
|
+
]
|
|
890
|
+
}
|
|
891
|
+
},
|
|
892
|
+
"required": [
|
|
893
|
+
"expires_at",
|
|
894
|
+
"holders"
|
|
895
|
+
],
|
|
896
|
+
"type": "object"
|
|
897
|
+
},
|
|
898
|
+
"POSSIBLE_RESPONSE_TYPE": {
|
|
899
|
+
"description": "Template-literal form for deriving a `${REQUEST}_RESPONSE` message type.",
|
|
900
|
+
"enum": [
|
|
901
|
+
"GET_IS_CONNECTED_NETWORK_RESPONSE",
|
|
902
|
+
"CONNECT_RESPONSE",
|
|
903
|
+
"DISCONNECT_RESPONSE",
|
|
904
|
+
"GET_IS_CONNECTED_RESPONSE",
|
|
905
|
+
"GET_VERSION_RESPONSE",
|
|
906
|
+
"GET_ACTIVE_NETWORK_RESPONSE",
|
|
907
|
+
"SIGN_MESSAGE_RESPONSE",
|
|
908
|
+
"SIGN_SEND_RESPONSE",
|
|
909
|
+
"SIGN_BATCH_RESPONSE",
|
|
910
|
+
"SIGN_INSTRUCTION_CHOICE_RESPONSE",
|
|
911
|
+
"GET_ACCOUNTS_RESPONSE",
|
|
912
|
+
"GET_ACTIVE_ACCOUNT_RESPONSE",
|
|
913
|
+
"GET_BALANCE_RESPONSE",
|
|
914
|
+
"GET_COINS_BALANCE_RESPONSE",
|
|
915
|
+
"GET_TRANSFERS_HISTORY_RESPONSE",
|
|
916
|
+
"GET_TRANSFER_DETAILS_RESPONSE",
|
|
917
|
+
"GET_OFFERS_HISTORY_RESPONSE",
|
|
918
|
+
"GET_NODE_TRANSFERS_HISTORY_RESPONSE",
|
|
919
|
+
"GET_NODE_TRANSFER_DETAILS_RESPONSE",
|
|
920
|
+
"GET_NODE_OFFERS_HISTORY_RESPONSE",
|
|
921
|
+
"LEDGER_API_RESPONSE"
|
|
922
|
+
],
|
|
923
|
+
"type": "string"
|
|
924
|
+
},
|
|
925
|
+
"POSSIBLE_TRIGGER_TYPE": {
|
|
926
|
+
"description": "Template-literal form for deriving a `${REQUEST}_TRIGGER` message type.",
|
|
927
|
+
"enum": [
|
|
928
|
+
"GET_IS_CONNECTED_NETWORK_TRIGGER",
|
|
929
|
+
"CONNECT_TRIGGER",
|
|
930
|
+
"DISCONNECT_TRIGGER",
|
|
931
|
+
"GET_IS_CONNECTED_TRIGGER",
|
|
932
|
+
"GET_VERSION_TRIGGER",
|
|
933
|
+
"GET_ACTIVE_NETWORK_TRIGGER",
|
|
934
|
+
"SIGN_MESSAGE_TRIGGER",
|
|
935
|
+
"SIGN_SEND_TRIGGER",
|
|
936
|
+
"SIGN_BATCH_TRIGGER",
|
|
937
|
+
"SIGN_INSTRUCTION_CHOICE_TRIGGER",
|
|
938
|
+
"GET_ACCOUNTS_TRIGGER",
|
|
939
|
+
"GET_ACTIVE_ACCOUNT_TRIGGER",
|
|
940
|
+
"GET_BALANCE_TRIGGER",
|
|
941
|
+
"GET_COINS_BALANCE_TRIGGER",
|
|
942
|
+
"GET_TRANSFERS_HISTORY_TRIGGER",
|
|
943
|
+
"GET_TRANSFER_DETAILS_TRIGGER",
|
|
944
|
+
"GET_OFFERS_HISTORY_TRIGGER",
|
|
945
|
+
"GET_NODE_TRANSFERS_HISTORY_TRIGGER",
|
|
946
|
+
"GET_NODE_TRANSFER_DETAILS_TRIGGER",
|
|
947
|
+
"GET_NODE_OFFERS_HISTORY_TRIGGER",
|
|
948
|
+
"LEDGER_API_TRIGGER"
|
|
949
|
+
],
|
|
950
|
+
"type": "string"
|
|
951
|
+
},
|
|
952
|
+
"PUBLIC_REQUESTS": {
|
|
953
|
+
"description": "Public request types that a dApp can post to the wallet. Each request has a corresponding `${REQUEST}_RESPONSE` message.",
|
|
954
|
+
"enum": [
|
|
955
|
+
"GET_IS_CONNECTED_NETWORK",
|
|
956
|
+
"CONNECT",
|
|
957
|
+
"DISCONNECT",
|
|
958
|
+
"GET_IS_CONNECTED",
|
|
959
|
+
"GET_VERSION",
|
|
960
|
+
"GET_ACTIVE_NETWORK",
|
|
961
|
+
"SIGN_MESSAGE",
|
|
962
|
+
"SIGN_SEND",
|
|
963
|
+
"SIGN_BATCH",
|
|
964
|
+
"SIGN_INSTRUCTION_CHOICE",
|
|
965
|
+
"GET_ACCOUNTS",
|
|
966
|
+
"GET_ACTIVE_ACCOUNT",
|
|
967
|
+
"GET_BALANCE",
|
|
968
|
+
"GET_COINS_BALANCE",
|
|
969
|
+
"GET_TRANSFERS_HISTORY",
|
|
970
|
+
"GET_TRANSFER_DETAILS",
|
|
971
|
+
"GET_OFFERS_HISTORY",
|
|
972
|
+
"GET_NODE_TRANSFERS_HISTORY",
|
|
973
|
+
"GET_NODE_TRANSFER_DETAILS",
|
|
974
|
+
"GET_NODE_OFFERS_HISTORY",
|
|
975
|
+
"LEDGER_API"
|
|
976
|
+
],
|
|
977
|
+
"type": "string"
|
|
978
|
+
},
|
|
979
|
+
"PagedByCombinedCursorResponseOffer": {
|
|
980
|
+
"additionalProperties": false,
|
|
981
|
+
"properties": {
|
|
982
|
+
"data": {
|
|
983
|
+
"description": "The list of items (records) retrieved for the current page.",
|
|
984
|
+
"items": {
|
|
985
|
+
"additionalProperties": false,
|
|
986
|
+
"properties": {
|
|
987
|
+
"amount": {
|
|
988
|
+
"description": "The amount of tokens to be transferred. Expressed in the base unit with full precision (e.g., 10.0 = 10 tokens).",
|
|
989
|
+
"format": "decimal",
|
|
990
|
+
"type": "string",
|
|
991
|
+
"example": "10.00000"
|
|
992
|
+
},
|
|
993
|
+
"contract_id": {
|
|
994
|
+
"anyOf": [
|
|
995
|
+
{
|
|
996
|
+
"nullable": true
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"$ref": "#/definitions/ContractId"
|
|
1000
|
+
}
|
|
1001
|
+
],
|
|
1002
|
+
"description": "The Daml contract ID representing this offer. Used to reference and exercise choices on the contract."
|
|
1003
|
+
},
|
|
1004
|
+
"event_id": {
|
|
1005
|
+
"$ref": "#/definitions/EventId",
|
|
1006
|
+
"description": "Unique identifier of the Daml event that created this offer. Used to track the creation event in the transaction log."
|
|
1007
|
+
},
|
|
1008
|
+
"external_cc_price": {
|
|
1009
|
+
"description": "External market Canton-coin (CC) price in USD.\n\nThis price is sourced from external markets (e.g., exchanges) and reflects the current market value of CC.\n\nAvailable **only on mainnet**, where external price feeds are integrated. It can be used for reporting, analysis, or comparison against the internal price.",
|
|
1010
|
+
"type": "string",
|
|
1011
|
+
"nullable": true
|
|
1012
|
+
},
|
|
1013
|
+
"internal_cc_price": {
|
|
1014
|
+
"description": "Internal Canton-coin (CC) price in USD.\n\nThis is the price approved by the committee via voting and used internally for calculations, valuations, and offer execution logic. It is always present and serves as the canonical internal valuation of CC.\n\nThe field not valid for /api/v1/offers/search. Use /api/v2/offers/search",
|
|
1015
|
+
"type": "string"
|
|
1016
|
+
},
|
|
1017
|
+
"offer_type": {
|
|
1018
|
+
"$ref": "#/definitions/OfferType",
|
|
1019
|
+
"description": "Exact type of the offer."
|
|
1020
|
+
},
|
|
1021
|
+
"provider_party_id": {
|
|
1022
|
+
"$ref": "#/definitions/PartyId",
|
|
1023
|
+
"description": "The party identifier of the offer provider.\n\nThis is the party who is providing the offer creation."
|
|
1024
|
+
},
|
|
1025
|
+
"receiver_party_id": {
|
|
1026
|
+
"$ref": "#/definitions/PartyId",
|
|
1027
|
+
"description": "The intended recipient of the transfer (receiver in the first leg). May differ from final recipient if conditional logic applies."
|
|
1028
|
+
},
|
|
1029
|
+
"record_time": {
|
|
1030
|
+
"description": "Assigned by the Canton domain, this reflects when the transaction was sequenced. Format: ISO 8601 Example: `\"2025-04-05T10:00:00Z\"`",
|
|
1031
|
+
"format": "date-time",
|
|
1032
|
+
"type": "string"
|
|
1033
|
+
},
|
|
1034
|
+
"sender_party_id": {
|
|
1035
|
+
"$ref": "#/definitions/PartyId",
|
|
1036
|
+
"description": "The party initiating the transfer (sender of the first leg). This is the original owner of the tokens being transferred."
|
|
1037
|
+
},
|
|
1038
|
+
"status": {
|
|
1039
|
+
"$ref": "#/definitions/OfferStatus",
|
|
1040
|
+
"description": "The current status of the offer (e.g., pending, executed, failed). Reflects the state of the Daml contract and whether transfers have been completed."
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
"required": [
|
|
1044
|
+
"amount",
|
|
1045
|
+
"event_id",
|
|
1046
|
+
"internal_cc_price",
|
|
1047
|
+
"offer_type",
|
|
1048
|
+
"provider_party_id",
|
|
1049
|
+
"receiver_party_id",
|
|
1050
|
+
"record_time",
|
|
1051
|
+
"sender_party_id",
|
|
1052
|
+
"status"
|
|
1053
|
+
],
|
|
1054
|
+
"type": "object"
|
|
1055
|
+
},
|
|
1056
|
+
"type": "array"
|
|
1057
|
+
},
|
|
1058
|
+
"next_cursor": {
|
|
1059
|
+
"anyOf": [
|
|
1060
|
+
{
|
|
1061
|
+
"nullable": true
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"$ref": "#/definitions/CombinedCursor"
|
|
1065
|
+
}
|
|
1066
|
+
],
|
|
1067
|
+
"description": "An optional cursor used for fetching the next page of results. This field is omitted from serialization if its value is `None`."
|
|
1068
|
+
}
|
|
1069
|
+
},
|
|
1070
|
+
"required": [
|
|
1071
|
+
"data"
|
|
1072
|
+
],
|
|
1073
|
+
"type": "object"
|
|
1074
|
+
},
|
|
1075
|
+
"PagedByCombinedCursorResponseTokenTransferSummary": {
|
|
1076
|
+
"additionalProperties": false,
|
|
1077
|
+
"properties": {
|
|
1078
|
+
"data": {
|
|
1079
|
+
"description": "The list of items (records) retrieved for the current page.",
|
|
1080
|
+
"items": {
|
|
1081
|
+
"additionalProperties": false,
|
|
1082
|
+
"properties": {
|
|
1083
|
+
"event_id": {
|
|
1084
|
+
"description": "eventId Daml event ID format: `update_id:number`.\n- `update_id`: 64-character hexadecimal string\n- `number`: **uint64**, event index within the update",
|
|
1085
|
+
"format": "update_id:number",
|
|
1086
|
+
"pattern": "^1220[a-f0-9]{64}:\\d+$",
|
|
1087
|
+
"type": "string",
|
|
1088
|
+
"example": "1220f66d301e0049af910c57e04f87697d0377c6086290bf8d6f89a64fad54ad7de3:46"
|
|
1089
|
+
},
|
|
1090
|
+
"record_time": {
|
|
1091
|
+
"format": "date-time",
|
|
1092
|
+
"type": "string"
|
|
1093
|
+
},
|
|
1094
|
+
"spent": {
|
|
1095
|
+
"$ref": "#/definitions/Spent",
|
|
1096
|
+
"description": "Detailed breakdown of token expenditure, including all fees and amounts received by counterparties. Provides a comprehensive summary of all outgoing value flows, including:\n- Fees paid to the network\n- Gross amount debited from sender's balance\n- Individual receiver allocations with net amounts"
|
|
1097
|
+
},
|
|
1098
|
+
"transfer_data": {
|
|
1099
|
+
"$ref": "#/definitions/TransferData",
|
|
1100
|
+
"description": "Original content of transfer data."
|
|
1101
|
+
},
|
|
1102
|
+
"transfer_type": {
|
|
1103
|
+
"$ref": "#/definitions/TokenTransferType",
|
|
1104
|
+
"description": "Type of transfer."
|
|
1105
|
+
},
|
|
1106
|
+
"update_id": {
|
|
1107
|
+
"description": "UpdateId Daml update ID in **multihash** format.\n- Begins with `1220` (indicating SHA-256 hash, 32-byte digest)\n- Followed by 64 lowercase hexadecimal characters\n- Total length: 68 characters This format ensures global uniqueness and cryptographic integrity in Canton.",
|
|
1108
|
+
"format": "byte",
|
|
1109
|
+
"pattern": "^1220[a-f0-9]{64}$",
|
|
1110
|
+
"type": "string",
|
|
1111
|
+
"example": "122050503ac262ae61001e430f2ba3ff9b1854b74f78a1a1da1f8f9948640088591f"
|
|
1112
|
+
}
|
|
1113
|
+
},
|
|
1114
|
+
"required": [
|
|
1115
|
+
"event_id",
|
|
1116
|
+
"record_time",
|
|
1117
|
+
"spent",
|
|
1118
|
+
"transfer_data",
|
|
1119
|
+
"transfer_type",
|
|
1120
|
+
"update_id"
|
|
1121
|
+
],
|
|
1122
|
+
"type": "object"
|
|
1123
|
+
},
|
|
1124
|
+
"type": "array"
|
|
1125
|
+
},
|
|
1126
|
+
"next_cursor": {
|
|
1127
|
+
"anyOf": [
|
|
1128
|
+
{
|
|
1129
|
+
"nullable": true
|
|
1130
|
+
},
|
|
1131
|
+
{
|
|
1132
|
+
"$ref": "#/definitions/CombinedCursor"
|
|
1133
|
+
}
|
|
1134
|
+
],
|
|
1135
|
+
"description": "An optional cursor used for fetching the next page of results. This field is omitted from serialization if its value is `None`."
|
|
1136
|
+
}
|
|
1137
|
+
},
|
|
1138
|
+
"required": [
|
|
1139
|
+
"data"
|
|
1140
|
+
],
|
|
1141
|
+
"type": "object"
|
|
1142
|
+
},
|
|
1143
|
+
"PartyId": {
|
|
1144
|
+
"description": "Template-literal type representing a party identifier ([a-zA-Z0-9:_-]*::[a-z0-9]) with namespace matching the pattern . Example: \"partHint::generatedPart\".",
|
|
1145
|
+
"type": "string"
|
|
1146
|
+
},
|
|
1147
|
+
"PendingTransfersResponseDTO": {
|
|
1148
|
+
"additionalProperties": false,
|
|
1149
|
+
"properties": {
|
|
1150
|
+
"amount": {
|
|
1151
|
+
"type": "string"
|
|
1152
|
+
},
|
|
1153
|
+
"coin": {
|
|
1154
|
+
"enum": [
|
|
1155
|
+
"CC",
|
|
1156
|
+
"CBTC",
|
|
1157
|
+
"USDCx"
|
|
1158
|
+
],
|
|
1159
|
+
"type": "string"
|
|
1160
|
+
},
|
|
1161
|
+
"createdAt": {
|
|
1162
|
+
"format": "date-time",
|
|
1163
|
+
"type": "string"
|
|
1164
|
+
},
|
|
1165
|
+
"expiredAt": {
|
|
1166
|
+
"format": "date-time",
|
|
1167
|
+
"type": "string"
|
|
1168
|
+
},
|
|
1169
|
+
"receiver": {
|
|
1170
|
+
"type": "string"
|
|
1171
|
+
},
|
|
1172
|
+
"sender": {
|
|
1173
|
+
"type": "string"
|
|
1174
|
+
},
|
|
1175
|
+
"status": {
|
|
1176
|
+
"enum": [
|
|
1177
|
+
"Pending",
|
|
1178
|
+
"SUCCESSFUL",
|
|
1179
|
+
"FAILED",
|
|
1180
|
+
"Accepted",
|
|
1181
|
+
"Rejected"
|
|
1182
|
+
],
|
|
1183
|
+
"type": "string"
|
|
1184
|
+
},
|
|
1185
|
+
"transferCid": {
|
|
1186
|
+
"type": "string"
|
|
1187
|
+
}
|
|
1188
|
+
},
|
|
1189
|
+
"required": [
|
|
1190
|
+
"amount",
|
|
1191
|
+
"coin",
|
|
1192
|
+
"createdAt",
|
|
1193
|
+
"expiredAt",
|
|
1194
|
+
"receiver",
|
|
1195
|
+
"sender",
|
|
1196
|
+
"status",
|
|
1197
|
+
"transferCid"
|
|
1198
|
+
],
|
|
1199
|
+
"type": "object"
|
|
1200
|
+
},
|
|
1201
|
+
"Primary": {
|
|
1202
|
+
"description": "Set as primary wallet for dApp usage.",
|
|
1203
|
+
"type": "boolean"
|
|
1204
|
+
},
|
|
1205
|
+
"Provider": {
|
|
1206
|
+
"additionalProperties": false,
|
|
1207
|
+
"properties": {
|
|
1208
|
+
"id": {
|
|
1209
|
+
"type": "string"
|
|
1210
|
+
},
|
|
1211
|
+
"providerType": {
|
|
1212
|
+
"$ref": "#/definitions/ProviderTypeEnum"
|
|
1213
|
+
},
|
|
1214
|
+
"version": {
|
|
1215
|
+
"type": "string"
|
|
1216
|
+
}
|
|
1217
|
+
},
|
|
1218
|
+
"required": [
|
|
1219
|
+
"id",
|
|
1220
|
+
"version",
|
|
1221
|
+
"providerType"
|
|
1222
|
+
],
|
|
1223
|
+
"type": "object"
|
|
1224
|
+
},
|
|
1225
|
+
"ProviderNetwork": {
|
|
1226
|
+
"additionalProperties": false,
|
|
1227
|
+
"properties": {
|
|
1228
|
+
"accessToken": {
|
|
1229
|
+
"type": "string"
|
|
1230
|
+
},
|
|
1231
|
+
"ledgerApi": {
|
|
1232
|
+
"type": "string"
|
|
1233
|
+
},
|
|
1234
|
+
"networkId": {
|
|
1235
|
+
"type": "string"
|
|
1236
|
+
}
|
|
1237
|
+
},
|
|
1238
|
+
"required": [
|
|
1239
|
+
"networkId"
|
|
1240
|
+
],
|
|
1241
|
+
"type": "object"
|
|
1242
|
+
},
|
|
1243
|
+
"ProviderRpcError": {
|
|
1244
|
+
"additionalProperties": false,
|
|
1245
|
+
"properties": {
|
|
1246
|
+
"code": {
|
|
1247
|
+
"type": "number"
|
|
1248
|
+
},
|
|
1249
|
+
"data": {},
|
|
1250
|
+
"message": {
|
|
1251
|
+
"type": "string"
|
|
1252
|
+
},
|
|
1253
|
+
"name": {
|
|
1254
|
+
"type": "string"
|
|
1255
|
+
},
|
|
1256
|
+
"stack": {
|
|
1257
|
+
"type": "string"
|
|
1258
|
+
}
|
|
1259
|
+
},
|
|
1260
|
+
"required": [
|
|
1261
|
+
"code",
|
|
1262
|
+
"message",
|
|
1263
|
+
"name"
|
|
1264
|
+
],
|
|
1265
|
+
"type": "object"
|
|
1266
|
+
},
|
|
1267
|
+
"ProviderTypeEnum": {
|
|
1268
|
+
"enum": [
|
|
1269
|
+
"browser",
|
|
1270
|
+
"desktop",
|
|
1271
|
+
"mobile",
|
|
1272
|
+
"remote"
|
|
1273
|
+
],
|
|
1274
|
+
"type": "string"
|
|
1275
|
+
},
|
|
1276
|
+
"PublicKey": {
|
|
1277
|
+
"description": "The public key of the party.",
|
|
1278
|
+
"type": "string"
|
|
1279
|
+
},
|
|
1280
|
+
"Received": {
|
|
1281
|
+
"additionalProperties": false,
|
|
1282
|
+
"description": "Represents income amount of a certain Party.",
|
|
1283
|
+
"properties": {
|
|
1284
|
+
"amount": {
|
|
1285
|
+
"description": "Net amount received by this party after all fees and allocations.\n\nRepresented as a decimal string to avoid floating-point precision issues.",
|
|
1286
|
+
"format": "decimal",
|
|
1287
|
+
"type": "string",
|
|
1288
|
+
"example": "49.92"
|
|
1289
|
+
},
|
|
1290
|
+
"receiver": {
|
|
1291
|
+
"$ref": "#/definitions/PartyId",
|
|
1292
|
+
"description": "Unique Canton party identifier of receiver (e.g., `\"Alice::123...\"`)"
|
|
1293
|
+
}
|
|
1294
|
+
},
|
|
1295
|
+
"required": [
|
|
1296
|
+
"amount",
|
|
1297
|
+
"receiver"
|
|
1298
|
+
],
|
|
1299
|
+
"type": "object"
|
|
1300
|
+
},
|
|
1301
|
+
"SdkLedgerProxyResponseDTO": {
|
|
1302
|
+
"additionalProperties": false,
|
|
1303
|
+
"properties": {
|
|
1304
|
+
"response": {
|
|
1305
|
+
"description": "A serialized response",
|
|
1306
|
+
"type": "string"
|
|
1307
|
+
}
|
|
1308
|
+
},
|
|
1309
|
+
"required": [
|
|
1310
|
+
"response"
|
|
1311
|
+
],
|
|
1312
|
+
"type": "object"
|
|
1313
|
+
},
|
|
1314
|
+
"SendConfirmationDataType": {
|
|
1315
|
+
"$ref": "#/definitions/ElementType%3Cstructure-1531355553-79543-81974-1531355553-79543-81976-1531355553-79535-81977-1531355553-79492-82075-1531355553-0-347510%5B%5D%3E",
|
|
1316
|
+
"description": "Element type of the confirmation data returned by the indexer wait function."
|
|
1317
|
+
},
|
|
1318
|
+
"SendType": {
|
|
1319
|
+
"description": "Specifies the type of token transfer being initiated.",
|
|
1320
|
+
"enum": [
|
|
1321
|
+
"OFFER",
|
|
1322
|
+
"DIRECT_TRANSFER"
|
|
1323
|
+
],
|
|
1324
|
+
"type": "string"
|
|
1325
|
+
},
|
|
1326
|
+
"Session": {
|
|
1327
|
+
"additionalProperties": false,
|
|
1328
|
+
"properties": {
|
|
1329
|
+
"accessToken": {
|
|
1330
|
+
"type": "string"
|
|
1331
|
+
},
|
|
1332
|
+
"userId": {
|
|
1333
|
+
"type": "string"
|
|
1334
|
+
}
|
|
1335
|
+
},
|
|
1336
|
+
"required": [
|
|
1337
|
+
"accessToken",
|
|
1338
|
+
"userId"
|
|
1339
|
+
],
|
|
1340
|
+
"type": "object"
|
|
1341
|
+
},
|
|
1342
|
+
"SignBatchRequest": {
|
|
1343
|
+
"anyOf": [
|
|
1344
|
+
{
|
|
1345
|
+
"$ref": "#/definitions/BatchSend"
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"$ref": "#/definitions/BatchUnknown"
|
|
1349
|
+
}
|
|
1350
|
+
],
|
|
1351
|
+
"description": "Union type representing a batch request for signing."
|
|
1352
|
+
},
|
|
1353
|
+
"SignBatchResponse": {
|
|
1354
|
+
"anyOf": [
|
|
1355
|
+
{
|
|
1356
|
+
"additionalProperties": false,
|
|
1357
|
+
"properties": {
|
|
1358
|
+
"signature": {
|
|
1359
|
+
"type": "string"
|
|
1360
|
+
},
|
|
1361
|
+
"status": {
|
|
1362
|
+
"enum": [
|
|
1363
|
+
true,
|
|
1364
|
+
false
|
|
1365
|
+
],
|
|
1366
|
+
"type": "boolean"
|
|
1367
|
+
}
|
|
1368
|
+
},
|
|
1369
|
+
"required": [
|
|
1370
|
+
"status"
|
|
1371
|
+
],
|
|
1372
|
+
"type": "object"
|
|
1373
|
+
},
|
|
1374
|
+
{
|
|
1375
|
+
"additionalProperties": false,
|
|
1376
|
+
"properties": {
|
|
1377
|
+
"signatures": {
|
|
1378
|
+
"items": {
|
|
1379
|
+
"type": "string"
|
|
1380
|
+
},
|
|
1381
|
+
"type": "array"
|
|
1382
|
+
},
|
|
1383
|
+
"status": {
|
|
1384
|
+
"enum": [
|
|
1385
|
+
true,
|
|
1386
|
+
false
|
|
1387
|
+
],
|
|
1388
|
+
"type": "boolean"
|
|
1389
|
+
}
|
|
1390
|
+
},
|
|
1391
|
+
"required": [
|
|
1392
|
+
"status",
|
|
1393
|
+
"signatures"
|
|
1394
|
+
],
|
|
1395
|
+
"type": "object"
|
|
1396
|
+
},
|
|
1397
|
+
{
|
|
1398
|
+
"not": {}
|
|
1399
|
+
}
|
|
1400
|
+
],
|
|
1401
|
+
"description": "Result of the sign batch operation."
|
|
1402
|
+
},
|
|
1403
|
+
"SignInstructionChoiceRequest": {
|
|
1404
|
+
"additionalProperties": false,
|
|
1405
|
+
"description": "Request to interact with a token transfer instruction",
|
|
1406
|
+
"properties": {
|
|
1407
|
+
"choice": {
|
|
1408
|
+
"$ref": "#/definitions/TransactionInstructionChoice"
|
|
1409
|
+
},
|
|
1410
|
+
"coin": {
|
|
1411
|
+
"$ref": "#/definitions/CoinEnum"
|
|
1412
|
+
},
|
|
1413
|
+
"instructionData": {
|
|
1414
|
+
"$ref": "#/definitions/PendingTransfersResponseDTO"
|
|
1415
|
+
},
|
|
1416
|
+
"transferCid": {
|
|
1417
|
+
"type": "string"
|
|
1418
|
+
}
|
|
1419
|
+
},
|
|
1420
|
+
"required": [
|
|
1421
|
+
"transferCid",
|
|
1422
|
+
"coin",
|
|
1423
|
+
"choice",
|
|
1424
|
+
"instructionData"
|
|
1425
|
+
],
|
|
1426
|
+
"type": "object"
|
|
1427
|
+
},
|
|
1428
|
+
"SignInstructionChoiceResponse": {
|
|
1429
|
+
"anyOf": [
|
|
1430
|
+
{
|
|
1431
|
+
"additionalProperties": false,
|
|
1432
|
+
"properties": {
|
|
1433
|
+
"signature": {
|
|
1434
|
+
"type": "string"
|
|
1435
|
+
},
|
|
1436
|
+
"status": {
|
|
1437
|
+
"enum": [
|
|
1438
|
+
true,
|
|
1439
|
+
false
|
|
1440
|
+
],
|
|
1441
|
+
"type": "boolean"
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
"required": [
|
|
1445
|
+
"status"
|
|
1446
|
+
],
|
|
1447
|
+
"type": "object"
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"not": {}
|
|
1451
|
+
}
|
|
1452
|
+
],
|
|
1453
|
+
"description": "Result of the instruction choice operation"
|
|
1454
|
+
},
|
|
1455
|
+
"SignMessageRequest": {
|
|
1456
|
+
"additionalProperties": false,
|
|
1457
|
+
"description": "Request to sign a message; provide either a hex or base64 payload.",
|
|
1458
|
+
"properties": {
|
|
1459
|
+
"message": {
|
|
1460
|
+
"anyOf": [
|
|
1461
|
+
{
|
|
1462
|
+
"$ref": "#/definitions/HexMessage"
|
|
1463
|
+
},
|
|
1464
|
+
{
|
|
1465
|
+
"$ref": "#/definitions/Base64Message"
|
|
1466
|
+
}
|
|
1467
|
+
]
|
|
1468
|
+
},
|
|
1469
|
+
"metaData": {
|
|
1470
|
+
"additionalProperties": {
|
|
1471
|
+
"type": "string"
|
|
1472
|
+
},
|
|
1473
|
+
"type": "object"
|
|
1474
|
+
}
|
|
1475
|
+
},
|
|
1476
|
+
"required": [
|
|
1477
|
+
"message"
|
|
1478
|
+
],
|
|
1479
|
+
"type": "object"
|
|
1480
|
+
},
|
|
1481
|
+
"SignSendRequest": {
|
|
1482
|
+
"additionalProperties": false,
|
|
1483
|
+
"description": "Request to sign and send a token transfer.",
|
|
1484
|
+
"properties": {
|
|
1485
|
+
"amount": {
|
|
1486
|
+
"type": "string"
|
|
1487
|
+
},
|
|
1488
|
+
"expireDate": {
|
|
1489
|
+
"type": "string"
|
|
1490
|
+
},
|
|
1491
|
+
"from": {
|
|
1492
|
+
"type": "string"
|
|
1493
|
+
},
|
|
1494
|
+
"memo": {
|
|
1495
|
+
"type": "string"
|
|
1496
|
+
},
|
|
1497
|
+
"to": {
|
|
1498
|
+
"type": "string"
|
|
1499
|
+
},
|
|
1500
|
+
"token": {
|
|
1501
|
+
"$ref": "#/definitions/CoinEnum"
|
|
1502
|
+
},
|
|
1503
|
+
"waitForFinalization": {
|
|
1504
|
+
"description": "Optional wait time in milliseconds for finalization; must be between MIN_WAITING and MAX_WAITING.",
|
|
1505
|
+
"type": "number"
|
|
1506
|
+
}
|
|
1507
|
+
},
|
|
1508
|
+
"required": [
|
|
1509
|
+
"amount",
|
|
1510
|
+
"expireDate",
|
|
1511
|
+
"from",
|
|
1512
|
+
"to",
|
|
1513
|
+
"token"
|
|
1514
|
+
],
|
|
1515
|
+
"type": "object"
|
|
1516
|
+
},
|
|
1517
|
+
"SignSendRequestRequiredFields": {
|
|
1518
|
+
"additionalProperties": false,
|
|
1519
|
+
"description": "Required fields for a sign-and-send token transfer request.",
|
|
1520
|
+
"properties": {
|
|
1521
|
+
"amount": {
|
|
1522
|
+
"type": "string"
|
|
1523
|
+
},
|
|
1524
|
+
"expireDate": {
|
|
1525
|
+
"type": "string"
|
|
1526
|
+
},
|
|
1527
|
+
"from": {
|
|
1528
|
+
"type": "string"
|
|
1529
|
+
},
|
|
1530
|
+
"memo": {
|
|
1531
|
+
"type": "string"
|
|
1532
|
+
},
|
|
1533
|
+
"to": {
|
|
1534
|
+
"type": "string"
|
|
1535
|
+
},
|
|
1536
|
+
"token": {
|
|
1537
|
+
"$ref": "#/definitions/CoinEnum"
|
|
1538
|
+
}
|
|
1539
|
+
},
|
|
1540
|
+
"required": [
|
|
1541
|
+
"from",
|
|
1542
|
+
"to",
|
|
1543
|
+
"token",
|
|
1544
|
+
"amount",
|
|
1545
|
+
"expireDate"
|
|
1546
|
+
],
|
|
1547
|
+
"type": "object"
|
|
1548
|
+
},
|
|
1549
|
+
"SignSendResponse": {
|
|
1550
|
+
"anyOf": [
|
|
1551
|
+
{
|
|
1552
|
+
"additionalProperties": false,
|
|
1553
|
+
"properties": {
|
|
1554
|
+
"confirmationData": {
|
|
1555
|
+
"$ref": "#/definitions/SendConfirmationDataType",
|
|
1556
|
+
"description": "Present when `waitForFinalization` is set and the indexer returns data."
|
|
1557
|
+
},
|
|
1558
|
+
"signature": {
|
|
1559
|
+
"type": "string"
|
|
1560
|
+
},
|
|
1561
|
+
"status": {
|
|
1562
|
+
"enum": [
|
|
1563
|
+
true,
|
|
1564
|
+
false
|
|
1565
|
+
],
|
|
1566
|
+
"type": "boolean"
|
|
1567
|
+
}
|
|
1568
|
+
},
|
|
1569
|
+
"required": [
|
|
1570
|
+
"status"
|
|
1571
|
+
],
|
|
1572
|
+
"type": "object"
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"not": {}
|
|
1576
|
+
}
|
|
1577
|
+
],
|
|
1578
|
+
"description": "Result of the sign-and-send operation, including optional confirmation data."
|
|
1579
|
+
},
|
|
1580
|
+
"SignedMessageResponse": {
|
|
1581
|
+
"anyOf": [
|
|
1582
|
+
{
|
|
1583
|
+
"type": "string"
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
"not": {}
|
|
1587
|
+
}
|
|
1588
|
+
],
|
|
1589
|
+
"description": "Result payload returned after signing an arbitrary message."
|
|
1590
|
+
},
|
|
1591
|
+
"SigningProviderId": {
|
|
1592
|
+
"description": "The signing provider ID the wallet corresponds to.",
|
|
1593
|
+
"type": "string"
|
|
1594
|
+
},
|
|
1595
|
+
"Spent": {
|
|
1596
|
+
"additionalProperties": false,
|
|
1597
|
+
"description": "Represents the summary of token expenditure and fee distribution for a sender in a Canton network token transfer.\n\nThis struct aggregates all outgoing value flows from the sender's perspective, including fees paid to the network, change returned (if any), and amounts received by counterparties. It is typically used in settlement summaries, audit trails, or user-facing transfer breakdowns within a Canton-based DLT (Distributed Ledger Technology) environment.",
|
|
1598
|
+
"properties": {
|
|
1599
|
+
"external_cc_price": {
|
|
1600
|
+
"description": "External market Canton-coin (CC) price in USD.\n\nThis price is sourced from external markets (e.g., exchanges) and reflects the current market value of CC. Available only on mainnet. Can be used for reporting, analysis, or comparison against internal price.",
|
|
1601
|
+
"type": "string",
|
|
1602
|
+
"nullable": true
|
|
1603
|
+
},
|
|
1604
|
+
"internal_cc_price": {
|
|
1605
|
+
"description": "Internal Canton-coin (CC) price in USD.\n\nThis is the price approved by the committee via voting and used internally for calculations, valuations, and settlement logic. Always present when set.",
|
|
1606
|
+
"type": "string",
|
|
1607
|
+
"nullable": true
|
|
1608
|
+
},
|
|
1609
|
+
"receivers": {
|
|
1610
|
+
"description": "List of individual receiver breakdowns — who received what amount, after fees or net settlement.",
|
|
1611
|
+
"items": {
|
|
1612
|
+
"$ref": "#/definitions/Received"
|
|
1613
|
+
},
|
|
1614
|
+
"type": "array"
|
|
1615
|
+
},
|
|
1616
|
+
"sender_send": {
|
|
1617
|
+
"description": "The gross amount of tokens debited from the sender’s balance (before fees; includes amounts sent to receivers + fees).",
|
|
1618
|
+
"type": "string"
|
|
1619
|
+
},
|
|
1620
|
+
"total_change_fee": {
|
|
1621
|
+
"description": "Fee associated with returning change to the sender (if UTXO or similar model is used).",
|
|
1622
|
+
"format": "decimal",
|
|
1623
|
+
"type": "string",
|
|
1624
|
+
"example": "1.8"
|
|
1625
|
+
},
|
|
1626
|
+
"total_fee": {
|
|
1627
|
+
"description": "The aggregate of all fees (`total_output_fee + total_change_fee + total_holder_fee`).",
|
|
1628
|
+
"format": "decimal",
|
|
1629
|
+
"type": "string",
|
|
1630
|
+
"example": "1.97646"
|
|
1631
|
+
},
|
|
1632
|
+
"total_holder_fee": {
|
|
1633
|
+
"description": "Fees paid to token holders or stakers (e.g., protocol-level holding or delegation fees).",
|
|
1634
|
+
"format": "decimal",
|
|
1635
|
+
"type": "string",
|
|
1636
|
+
"example": "0.8"
|
|
1637
|
+
},
|
|
1638
|
+
"total_output_fee": {
|
|
1639
|
+
"description": "Sum of fees paid for transferring tokens to receivers (e.g., routing or processing fees per output).",
|
|
1640
|
+
"format": "decimal",
|
|
1641
|
+
"type": "string",
|
|
1642
|
+
"example": "0.6"
|
|
1643
|
+
}
|
|
1644
|
+
},
|
|
1645
|
+
"required": [
|
|
1646
|
+
"receivers",
|
|
1647
|
+
"sender_send",
|
|
1648
|
+
"total_change_fee",
|
|
1649
|
+
"total_fee",
|
|
1650
|
+
"total_holder_fee",
|
|
1651
|
+
"total_output_fee"
|
|
1652
|
+
],
|
|
1653
|
+
"type": "object"
|
|
1654
|
+
},
|
|
1655
|
+
"StatusEvent": {
|
|
1656
|
+
"additionalProperties": false,
|
|
1657
|
+
"properties": {
|
|
1658
|
+
"connection": {
|
|
1659
|
+
"$ref": "#/definitions/ConnectResult"
|
|
1660
|
+
},
|
|
1661
|
+
"network": {
|
|
1662
|
+
"$ref": "#/definitions/ProviderNetwork"
|
|
1663
|
+
},
|
|
1664
|
+
"provider": {
|
|
1665
|
+
"$ref": "#/definitions/Provider"
|
|
1666
|
+
},
|
|
1667
|
+
"session": {
|
|
1668
|
+
"$ref": "#/definitions/Session"
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
"required": [
|
|
1672
|
+
"connection",
|
|
1673
|
+
"provider"
|
|
1674
|
+
],
|
|
1675
|
+
"type": "object"
|
|
1676
|
+
},
|
|
1677
|
+
"TokenData": {
|
|
1678
|
+
"additionalProperties": false,
|
|
1679
|
+
"description": "Token balance data for a specific network.",
|
|
1680
|
+
"properties": {
|
|
1681
|
+
"balance": {
|
|
1682
|
+
"type": "string"
|
|
1683
|
+
},
|
|
1684
|
+
"balanceBigInt": {
|
|
1685
|
+
"type": "string"
|
|
1686
|
+
},
|
|
1687
|
+
"balanceUsd": {
|
|
1688
|
+
"type": "string"
|
|
1689
|
+
},
|
|
1690
|
+
"decimals": {
|
|
1691
|
+
"type": "number"
|
|
1692
|
+
},
|
|
1693
|
+
"id": {
|
|
1694
|
+
"type": "string"
|
|
1695
|
+
},
|
|
1696
|
+
"imageSrc": {
|
|
1697
|
+
"type": "string"
|
|
1698
|
+
},
|
|
1699
|
+
"name": {
|
|
1700
|
+
"type": "string"
|
|
1701
|
+
},
|
|
1702
|
+
"network": {
|
|
1703
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
1704
|
+
},
|
|
1705
|
+
"price": {
|
|
1706
|
+
"type": "string"
|
|
1707
|
+
},
|
|
1708
|
+
"symbol": {
|
|
1709
|
+
"$ref": "#/definitions/CoinEnum"
|
|
1710
|
+
}
|
|
1711
|
+
},
|
|
1712
|
+
"required": [
|
|
1713
|
+
"id",
|
|
1714
|
+
"symbol",
|
|
1715
|
+
"balance",
|
|
1716
|
+
"balanceBigInt",
|
|
1717
|
+
"decimals",
|
|
1718
|
+
"name",
|
|
1719
|
+
"price",
|
|
1720
|
+
"network",
|
|
1721
|
+
"imageSrc"
|
|
1722
|
+
],
|
|
1723
|
+
"type": "object"
|
|
1724
|
+
},
|
|
1725
|
+
"TokenTransferType": {
|
|
1726
|
+
"default": "transfer",
|
|
1727
|
+
"description": "Type of Token Transfer. One of: allocation, command, instuction, other.",
|
|
1728
|
+
"enum": [
|
|
1729
|
+
"allocation",
|
|
1730
|
+
"command",
|
|
1731
|
+
"instruction",
|
|
1732
|
+
"transfer",
|
|
1733
|
+
"merge_split"
|
|
1734
|
+
],
|
|
1735
|
+
"type": "string",
|
|
1736
|
+
"example": "allocation"
|
|
1737
|
+
},
|
|
1738
|
+
"TokenTransfersQuery": {
|
|
1739
|
+
"description": "Query parameters accepted by the indexer for party token transfers.",
|
|
1740
|
+
"not": {}
|
|
1741
|
+
},
|
|
1742
|
+
"TokenTransfersRequest": {
|
|
1743
|
+
"additionalProperties": false,
|
|
1744
|
+
"properties": {
|
|
1745
|
+
"network": {
|
|
1746
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
1747
|
+
}
|
|
1748
|
+
},
|
|
1749
|
+
"required": [
|
|
1750
|
+
"network"
|
|
1751
|
+
],
|
|
1752
|
+
"type": "object"
|
|
1753
|
+
},
|
|
1754
|
+
"TokenTransfersResponse": {
|
|
1755
|
+
"anyOf": [
|
|
1756
|
+
{
|
|
1757
|
+
"$ref": "#/definitions/PagedByCombinedCursorResponseTokenTransferSummary"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"nullable": true
|
|
1761
|
+
}
|
|
1762
|
+
],
|
|
1763
|
+
"description": "Paged token transfer summaries or null if no data exists."
|
|
1764
|
+
},
|
|
1765
|
+
"TopologyTransactions": {
|
|
1766
|
+
"description": "The topology transactions",
|
|
1767
|
+
"type": "string"
|
|
1768
|
+
},
|
|
1769
|
+
"TransactionInstructionChoice": {
|
|
1770
|
+
"enum": [
|
|
1771
|
+
"Accept",
|
|
1772
|
+
"Reject",
|
|
1773
|
+
"Withdraw"
|
|
1774
|
+
],
|
|
1775
|
+
"type": "string"
|
|
1776
|
+
},
|
|
1777
|
+
"TransferData": {
|
|
1778
|
+
"additionalProperties": false,
|
|
1779
|
+
"description": "Data Transfer Object representing a complete transfer request or record.\n\nContains sender, provider, recipients with outputs, fees, round context, and metadata. Used in transaction submission, auditing, or API responses.",
|
|
1780
|
+
"properties": {
|
|
1781
|
+
"holding_fee": {
|
|
1782
|
+
"description": "The holding fee applied to the transfer, paid by the sender.\n\nExpressed in the base token (e.g., AMULET). This fee compensates the provider for temporary custody or processing.",
|
|
1783
|
+
"format": "decimal",
|
|
1784
|
+
"type": "string",
|
|
1785
|
+
"example": 0.000123
|
|
1786
|
+
},
|
|
1787
|
+
"input_amount": {
|
|
1788
|
+
"description": "The total input amount being transferred (before fees).\n\nMust match the sum of all output amounts and fees.",
|
|
1789
|
+
"format": "decimal",
|
|
1790
|
+
"type": "string",
|
|
1791
|
+
"example": "100.0338"
|
|
1792
|
+
},
|
|
1793
|
+
"metadata": {
|
|
1794
|
+
"additionalProperties": {
|
|
1795
|
+
"type": "string"
|
|
1796
|
+
},
|
|
1797
|
+
"description": "Additional metadata associated with the transfer.\n\nKey-value tags for tracking, analytics, or compliance (e.g., \"source\", \"campaign\"). Not part of the cryptographic payload, but may be logged.",
|
|
1798
|
+
"type": "object",
|
|
1799
|
+
"example": {
|
|
1800
|
+
"splice.lfdecentralizedtrust.org/burned": "0.8671428572",
|
|
1801
|
+
"splice.lfdecentralizedtrust.org/sender": "v-7-user-3::122044310988c02106b5f0f37b76f997935db73dd2a49075067130c4d00fcc95a2c1",
|
|
1802
|
+
"splice.lfdecentralizedtrust.org/tx-kind": "transfer"
|
|
1803
|
+
}
|
|
1804
|
+
},
|
|
1805
|
+
"provider": {
|
|
1806
|
+
"$ref": "#/definitions/PartyId",
|
|
1807
|
+
"description": "The service provider facilitating the transfer (e.g., relayer, validator, DSO). May collect fees or enforce policies. This party is responsible for transaction inclusion.\n\n Example: \"DSO::1220be58c29e65de40bf273be1dc2b266d43a9a002ea5b18955aeef7aac881bb471a\""
|
|
1808
|
+
},
|
|
1809
|
+
"receivers": {
|
|
1810
|
+
"additionalProperties": {
|
|
1811
|
+
"items": {
|
|
1812
|
+
"$ref": "#/definitions/TransferOutput"
|
|
1813
|
+
},
|
|
1814
|
+
"type": "array"
|
|
1815
|
+
},
|
|
1816
|
+
"description": "Map of recipients to their list of transfer outputs.\n\nEach recipient (key) can receive multiple outputs (e.g., split payments, change). Used to support complex payout structures.",
|
|
1817
|
+
"type": "object",
|
|
1818
|
+
"example": {
|
|
1819
|
+
"auth0_007c68658b8598cd2db9f3e70120::1220907f4c19293a3b5fb6ed3943938abe65647748090e34993387950631d0024444": [
|
|
1820
|
+
{
|
|
1821
|
+
"amount": "1987.0388584460",
|
|
1822
|
+
"fee": "0.6000000000",
|
|
1823
|
+
"lock": null,
|
|
1824
|
+
"output_number": 0,
|
|
1825
|
+
"receiver_fee_ratio": "0"
|
|
1826
|
+
}
|
|
1827
|
+
]
|
|
1828
|
+
}
|
|
1829
|
+
},
|
|
1830
|
+
"round": {
|
|
1831
|
+
"description": "The mining round in which this transfer is submitted or processed. Used for reward calculation, auditing, and economic modeling.",
|
|
1832
|
+
"format": "int64",
|
|
1833
|
+
"type": "number",
|
|
1834
|
+
"example": 2
|
|
1835
|
+
},
|
|
1836
|
+
"sender": {
|
|
1837
|
+
"$ref": "#/definitions/PartyId",
|
|
1838
|
+
"description": "The party initiating the transfer. Must have sufficient balance and authorization to spend the input amount.\n\nExample: `dev_test_sender_email_com::122035334a67f4de9d2aecdd5b83485cbaee20682e3f0491bdf12b0a32d81cc93c90`"
|
|
1839
|
+
},
|
|
1840
|
+
"sender_change_amount": {
|
|
1841
|
+
"description": "The unspent sender amount being transferred back.",
|
|
1842
|
+
"format": "decimal",
|
|
1843
|
+
"type": "string",
|
|
1844
|
+
"example": 100
|
|
1845
|
+
},
|
|
1846
|
+
"sender_change_fee": {
|
|
1847
|
+
"description": "The fee amount of creation change amulet.",
|
|
1848
|
+
"format": "decimal",
|
|
1849
|
+
"type": "string",
|
|
1850
|
+
"example": 100
|
|
1851
|
+
}
|
|
1852
|
+
},
|
|
1853
|
+
"required": [
|
|
1854
|
+
"holding_fee",
|
|
1855
|
+
"input_amount",
|
|
1856
|
+
"metadata",
|
|
1857
|
+
"provider",
|
|
1858
|
+
"receivers",
|
|
1859
|
+
"round",
|
|
1860
|
+
"sender",
|
|
1861
|
+
"sender_change_amount",
|
|
1862
|
+
"sender_change_fee"
|
|
1863
|
+
],
|
|
1864
|
+
"type": "object"
|
|
1865
|
+
},
|
|
1866
|
+
"TransferFromNodeRequest": {
|
|
1867
|
+
"additionalProperties": false,
|
|
1868
|
+
"description": "Request parameters for retrieving a single transfer by event ID.",
|
|
1869
|
+
"properties": {
|
|
1870
|
+
"network": {
|
|
1871
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
1872
|
+
},
|
|
1873
|
+
"transferId": {
|
|
1874
|
+
"type": "number"
|
|
1875
|
+
}
|
|
1876
|
+
},
|
|
1877
|
+
"required": [
|
|
1878
|
+
"transferId",
|
|
1879
|
+
"network"
|
|
1880
|
+
],
|
|
1881
|
+
"type": "object"
|
|
1882
|
+
},
|
|
1883
|
+
"TransferFromNodeResponse": {
|
|
1884
|
+
"anyOf": [
|
|
1885
|
+
{
|
|
1886
|
+
"$ref": "#/definitions/TransferResponseDTO"
|
|
1887
|
+
},
|
|
1888
|
+
{
|
|
1889
|
+
"nullable": true
|
|
1890
|
+
}
|
|
1891
|
+
],
|
|
1892
|
+
"description": "Detailed transfer response or null if event is not found."
|
|
1893
|
+
},
|
|
1894
|
+
"TransferOutput": {
|
|
1895
|
+
"additionalProperties": false,
|
|
1896
|
+
"description": "Data Transfer Object representing a single output in a transfer transaction.\n\nThis includes the amount, fee distribution, and optional locking conditions.",
|
|
1897
|
+
"properties": {
|
|
1898
|
+
"amount": {
|
|
1899
|
+
"description": "Total transfer amount sent to the receiver (excluding fees).\n\nExpressed in the base unit of the token (e.g., AMULET). This is the net amount the recipient receives after fees are deducted.",
|
|
1900
|
+
"format": "decimal",
|
|
1901
|
+
"type": "string",
|
|
1902
|
+
"example": 50
|
|
1903
|
+
},
|
|
1904
|
+
"fee": {
|
|
1905
|
+
"description": "The total fee amount deducted from the transfer.\n\nThis may include validators, DSO, or service provider fees. It is calculated based on the amount and applicable fee rules.",
|
|
1906
|
+
"format": "decimal",
|
|
1907
|
+
"type": "string",
|
|
1908
|
+
"example": 0.5
|
|
1909
|
+
},
|
|
1910
|
+
"lock": {
|
|
1911
|
+
"anyOf": [
|
|
1912
|
+
{
|
|
1913
|
+
"nullable": true
|
|
1914
|
+
},
|
|
1915
|
+
{
|
|
1916
|
+
"$ref": "#/definitions/OutputTimeLock"
|
|
1917
|
+
}
|
|
1918
|
+
],
|
|
1919
|
+
"description": "Optional time lock that prevents the output from being spent before a certain time or block.\n\nIf present, the recipient cannot spend these funds until the lock conditions are met. Used for vesting, escrow, or delayed payouts."
|
|
1920
|
+
},
|
|
1921
|
+
"output_number": {
|
|
1922
|
+
"description": "The index/number of the output in the transaction.\n\nIndicates the position of this output within the list of outputs. Used for referencing in scripts or off-ledger systems.",
|
|
1923
|
+
"format": "int32",
|
|
1924
|
+
"type": "number",
|
|
1925
|
+
"example": 1
|
|
1926
|
+
},
|
|
1927
|
+
"receiver_fee_ratio": {
|
|
1928
|
+
"description": "The fee ratio that the receiver agrees to pay, expressed as a decimal.\n\nFor example, `0.01` means the receiver pays 1% of the transfer as a fee. Used to incentivize on-chain activity or cover network costs.",
|
|
1929
|
+
"format": "decimal",
|
|
1930
|
+
"type": "string",
|
|
1931
|
+
"example": 0.01
|
|
1932
|
+
}
|
|
1933
|
+
},
|
|
1934
|
+
"required": [
|
|
1935
|
+
"amount",
|
|
1936
|
+
"fee",
|
|
1937
|
+
"output_number",
|
|
1938
|
+
"receiver_fee_ratio"
|
|
1939
|
+
],
|
|
1940
|
+
"type": "object"
|
|
1941
|
+
},
|
|
1942
|
+
"TransferRequest": {
|
|
1943
|
+
"additionalProperties": false,
|
|
1944
|
+
"description": "Request parameters for retrieving a single transfer by event ID.",
|
|
1945
|
+
"properties": {
|
|
1946
|
+
"eventId": {
|
|
1947
|
+
"type": "string"
|
|
1948
|
+
},
|
|
1949
|
+
"network": {
|
|
1950
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
1951
|
+
}
|
|
1952
|
+
},
|
|
1953
|
+
"required": [
|
|
1954
|
+
"eventId",
|
|
1955
|
+
"network"
|
|
1956
|
+
],
|
|
1957
|
+
"type": "object"
|
|
1958
|
+
},
|
|
1959
|
+
"TransferResponse": {
|
|
1960
|
+
"anyOf": [
|
|
1961
|
+
{
|
|
1962
|
+
"description": "Failed to correctly infer type"
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"nullable": true
|
|
1966
|
+
}
|
|
1967
|
+
],
|
|
1968
|
+
"description": "Detailed transfer response or null if event is not found."
|
|
1969
|
+
},
|
|
1970
|
+
"TransferResponseDTO": {
|
|
1971
|
+
"additionalProperties": false,
|
|
1972
|
+
"properties": {
|
|
1973
|
+
"action": {
|
|
1974
|
+
"enum": [
|
|
1975
|
+
"create",
|
|
1976
|
+
"resolve"
|
|
1977
|
+
],
|
|
1978
|
+
"type": "string"
|
|
1979
|
+
},
|
|
1980
|
+
"amount": {
|
|
1981
|
+
"type": "string"
|
|
1982
|
+
},
|
|
1983
|
+
"choice": {
|
|
1984
|
+
"enum": [
|
|
1985
|
+
"Accept",
|
|
1986
|
+
"Reject",
|
|
1987
|
+
"Withdraw",
|
|
1988
|
+
null
|
|
1989
|
+
],
|
|
1990
|
+
"type": "string",
|
|
1991
|
+
"nullable": true
|
|
1992
|
+
},
|
|
1993
|
+
"coin": {
|
|
1994
|
+
"enum": [
|
|
1995
|
+
"CC",
|
|
1996
|
+
"CBTC",
|
|
1997
|
+
"USDCx"
|
|
1998
|
+
],
|
|
1999
|
+
"type": "string"
|
|
2000
|
+
},
|
|
2001
|
+
"contractId": {
|
|
2002
|
+
"type": "string",
|
|
2003
|
+
"nullable": true
|
|
2004
|
+
},
|
|
2005
|
+
"createdAt": {
|
|
2006
|
+
"format": "date-time",
|
|
2007
|
+
"type": "string"
|
|
2008
|
+
},
|
|
2009
|
+
"holdingFee": {
|
|
2010
|
+
"type": "string"
|
|
2011
|
+
},
|
|
2012
|
+
"id": {
|
|
2013
|
+
"type": "number"
|
|
2014
|
+
},
|
|
2015
|
+
"offerCreatedAt": {
|
|
2016
|
+
"format": "date-time",
|
|
2017
|
+
"type": "string"
|
|
2018
|
+
},
|
|
2019
|
+
"outputFee": {
|
|
2020
|
+
"type": "string"
|
|
2021
|
+
},
|
|
2022
|
+
"receiver": {
|
|
2023
|
+
"type": "string"
|
|
2024
|
+
},
|
|
2025
|
+
"sender": {
|
|
2026
|
+
"type": "string"
|
|
2027
|
+
},
|
|
2028
|
+
"senderFee": {
|
|
2029
|
+
"type": "string"
|
|
2030
|
+
},
|
|
2031
|
+
"status": {
|
|
2032
|
+
"enum": [
|
|
2033
|
+
"Pending",
|
|
2034
|
+
"SUCCESSFUL",
|
|
2035
|
+
"FAILED",
|
|
2036
|
+
"Accepted",
|
|
2037
|
+
"Rejected"
|
|
2038
|
+
],
|
|
2039
|
+
"type": "string"
|
|
2040
|
+
},
|
|
2041
|
+
"type": {
|
|
2042
|
+
"enum": [
|
|
2043
|
+
"Instruction",
|
|
2044
|
+
"Transfer",
|
|
2045
|
+
"BATCH_TRANSFER",
|
|
2046
|
+
"BATCH_MARKERS",
|
|
2047
|
+
"MERGE_UTXOS"
|
|
2048
|
+
],
|
|
2049
|
+
"type": "string"
|
|
2050
|
+
}
|
|
2051
|
+
},
|
|
2052
|
+
"required": [
|
|
2053
|
+
"action",
|
|
2054
|
+
"amount",
|
|
2055
|
+
"choice",
|
|
2056
|
+
"coin",
|
|
2057
|
+
"createdAt",
|
|
2058
|
+
"holdingFee",
|
|
2059
|
+
"id",
|
|
2060
|
+
"offerCreatedAt",
|
|
2061
|
+
"outputFee",
|
|
2062
|
+
"receiver",
|
|
2063
|
+
"sender",
|
|
2064
|
+
"senderFee",
|
|
2065
|
+
"status",
|
|
2066
|
+
"type"
|
|
2067
|
+
],
|
|
2068
|
+
"type": "object"
|
|
2069
|
+
},
|
|
2070
|
+
"TxChangedEvent": {
|
|
2071
|
+
"anyOf": [
|
|
2072
|
+
{
|
|
2073
|
+
"$ref": "#/definitions/TxChangedPendingEvent"
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
"$ref": "#/definitions/TxChangedSignedEvent"
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"$ref": "#/definitions/TxChangedExecutedEvent"
|
|
2080
|
+
},
|
|
2081
|
+
{
|
|
2082
|
+
"$ref": "#/definitions/TxChangedFailedEvent"
|
|
2083
|
+
}
|
|
2084
|
+
],
|
|
2085
|
+
"description": "Union of all transaction status change events."
|
|
2086
|
+
},
|
|
2087
|
+
"TxChangedExecutedEvent": {
|
|
2088
|
+
"additionalProperties": false,
|
|
2089
|
+
"description": "Trigger event emitted when a transaction is executed.",
|
|
2090
|
+
"properties": {
|
|
2091
|
+
"commandId": {
|
|
2092
|
+
"type": "string"
|
|
2093
|
+
},
|
|
2094
|
+
"payload": {
|
|
2095
|
+
"$ref": "#/definitions/TxChangedExecutedPayload"
|
|
2096
|
+
},
|
|
2097
|
+
"status": {
|
|
2098
|
+
"type": "string",
|
|
2099
|
+
"enum": [
|
|
2100
|
+
"executed"
|
|
2101
|
+
]
|
|
2102
|
+
}
|
|
2103
|
+
},
|
|
2104
|
+
"required": [
|
|
2105
|
+
"status",
|
|
2106
|
+
"commandId",
|
|
2107
|
+
"payload"
|
|
2108
|
+
],
|
|
2109
|
+
"type": "object"
|
|
2110
|
+
},
|
|
2111
|
+
"TxChangedExecutedPayload": {
|
|
2112
|
+
"additionalProperties": false,
|
|
2113
|
+
"description": "Payload included when a transaction reaches execution/finalization.",
|
|
2114
|
+
"properties": {
|
|
2115
|
+
"completionOffset": {
|
|
2116
|
+
"type": "number"
|
|
2117
|
+
},
|
|
2118
|
+
"updateId": {
|
|
2119
|
+
"type": "string"
|
|
2120
|
+
}
|
|
2121
|
+
},
|
|
2122
|
+
"required": [
|
|
2123
|
+
"updateId",
|
|
2124
|
+
"completionOffset"
|
|
2125
|
+
],
|
|
2126
|
+
"type": "object"
|
|
2127
|
+
},
|
|
2128
|
+
"TxChangedFailedEvent": {
|
|
2129
|
+
"additionalProperties": false,
|
|
2130
|
+
"description": "Trigger event emitted when a transaction fails.",
|
|
2131
|
+
"properties": {
|
|
2132
|
+
"commandId": {
|
|
2133
|
+
"type": "string"
|
|
2134
|
+
},
|
|
2135
|
+
"status": {
|
|
2136
|
+
"type": "string",
|
|
2137
|
+
"enum": [
|
|
2138
|
+
"failed"
|
|
2139
|
+
]
|
|
2140
|
+
}
|
|
2141
|
+
},
|
|
2142
|
+
"required": [
|
|
2143
|
+
"status",
|
|
2144
|
+
"commandId"
|
|
2145
|
+
],
|
|
2146
|
+
"type": "object"
|
|
2147
|
+
},
|
|
2148
|
+
"TxChangedPendingEvent": {
|
|
2149
|
+
"additionalProperties": false,
|
|
2150
|
+
"description": "Trigger event emitted when a transaction is queued/pending.",
|
|
2151
|
+
"properties": {
|
|
2152
|
+
"commandId": {
|
|
2153
|
+
"type": "string"
|
|
2154
|
+
},
|
|
2155
|
+
"status": {
|
|
2156
|
+
"type": "string",
|
|
2157
|
+
"enum": [
|
|
2158
|
+
"pending"
|
|
2159
|
+
]
|
|
2160
|
+
}
|
|
2161
|
+
},
|
|
2162
|
+
"required": [
|
|
2163
|
+
"status",
|
|
2164
|
+
"commandId"
|
|
2165
|
+
],
|
|
2166
|
+
"type": "object"
|
|
2167
|
+
},
|
|
2168
|
+
"TxChangedSignedEvent": {
|
|
2169
|
+
"additionalProperties": false,
|
|
2170
|
+
"description": "Trigger event emitted when the wallet signs a transaction.",
|
|
2171
|
+
"properties": {
|
|
2172
|
+
"commandId": {
|
|
2173
|
+
"type": "string"
|
|
2174
|
+
},
|
|
2175
|
+
"payload": {
|
|
2176
|
+
"$ref": "#/definitions/TxChangedSignedPayload"
|
|
2177
|
+
},
|
|
2178
|
+
"status": {
|
|
2179
|
+
"type": "string",
|
|
2180
|
+
"enum": [
|
|
2181
|
+
"signed"
|
|
2182
|
+
]
|
|
2183
|
+
}
|
|
2184
|
+
},
|
|
2185
|
+
"required": [
|
|
2186
|
+
"status",
|
|
2187
|
+
"commandId",
|
|
2188
|
+
"payload"
|
|
2189
|
+
],
|
|
2190
|
+
"type": "object"
|
|
2191
|
+
},
|
|
2192
|
+
"TxChangedSignedPayload": {
|
|
2193
|
+
"additionalProperties": false,
|
|
2194
|
+
"description": "Payload included when a transaction is signed.",
|
|
2195
|
+
"properties": {
|
|
2196
|
+
"party": {
|
|
2197
|
+
"type": "string"
|
|
2198
|
+
},
|
|
2199
|
+
"signature": {
|
|
2200
|
+
"type": "string"
|
|
2201
|
+
},
|
|
2202
|
+
"signedBy": {
|
|
2203
|
+
"type": "string"
|
|
2204
|
+
}
|
|
2205
|
+
},
|
|
2206
|
+
"required": [
|
|
2207
|
+
"signature",
|
|
2208
|
+
"signedBy",
|
|
2209
|
+
"party"
|
|
2210
|
+
],
|
|
2211
|
+
"type": "object"
|
|
2212
|
+
},
|
|
2213
|
+
"TxEventStatus": {
|
|
2214
|
+
"description": "Transaction lifecycle status values used in wallet trigger events.",
|
|
2215
|
+
"enum": [
|
|
2216
|
+
"pending",
|
|
2217
|
+
"signed",
|
|
2218
|
+
"executed",
|
|
2219
|
+
"failed"
|
|
2220
|
+
],
|
|
2221
|
+
"type": "string"
|
|
2222
|
+
},
|
|
2223
|
+
"Wallet": {
|
|
2224
|
+
"additionalProperties": false,
|
|
2225
|
+
"description": "Structure representing a wallet",
|
|
2226
|
+
"properties": {
|
|
2227
|
+
"externalTxId": {
|
|
2228
|
+
"$ref": "#/definitions/ExternalTxId"
|
|
2229
|
+
},
|
|
2230
|
+
"hint": {
|
|
2231
|
+
"$ref": "#/definitions/Hint"
|
|
2232
|
+
},
|
|
2233
|
+
"namespace": {
|
|
2234
|
+
"$ref": "#/definitions/Namespace"
|
|
2235
|
+
},
|
|
2236
|
+
"networkId": {
|
|
2237
|
+
"$ref": "#/definitions/CANTON_NETWORK_VARIANTS"
|
|
2238
|
+
},
|
|
2239
|
+
"partyId": {
|
|
2240
|
+
"$ref": "#/definitions/PartyId"
|
|
2241
|
+
},
|
|
2242
|
+
"primary": {
|
|
2243
|
+
"$ref": "#/definitions/Primary"
|
|
2244
|
+
},
|
|
2245
|
+
"publicKey": {
|
|
2246
|
+
"$ref": "#/definitions/PublicKey"
|
|
2247
|
+
},
|
|
2248
|
+
"signingProviderId": {
|
|
2249
|
+
"$ref": "#/definitions/SigningProviderId"
|
|
2250
|
+
},
|
|
2251
|
+
"status": {
|
|
2252
|
+
"$ref": "#/definitions/WalletStatus"
|
|
2253
|
+
},
|
|
2254
|
+
"topologyTransactions": {
|
|
2255
|
+
"$ref": "#/definitions/TopologyTransactions"
|
|
2256
|
+
}
|
|
2257
|
+
},
|
|
2258
|
+
"required": [
|
|
2259
|
+
"primary",
|
|
2260
|
+
"status",
|
|
2261
|
+
"partyId",
|
|
2262
|
+
"hint",
|
|
2263
|
+
"publicKey",
|
|
2264
|
+
"namespace",
|
|
2265
|
+
"networkId",
|
|
2266
|
+
"signingProviderId"
|
|
2267
|
+
],
|
|
2268
|
+
"type": "object"
|
|
2269
|
+
},
|
|
2270
|
+
"WalletStatus": {
|
|
2271
|
+
"description": "The status of the wallet.",
|
|
2272
|
+
"enum": [
|
|
2273
|
+
"initialized",
|
|
2274
|
+
"allocated"
|
|
2275
|
+
],
|
|
2276
|
+
"type": "string"
|
|
2277
|
+
},
|
|
2278
|
+
"WalletVersion": {
|
|
2279
|
+
"description": "Wallet version",
|
|
2280
|
+
"type": "string"
|
|
2281
|
+
}
|
|
2282
|
+
}
|
|
2283
|
+
}
|
|
2284
|
+
}
|