1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
#ifndef __sovrin__ledger_included__
#define __sovrin__ledger_included__
#include "sovrin_mod.h"
#include "sovrin_types.h"
#ifdef __cplusplus
extern "C" {
#endif
/// Signs and submits request message to validator pool.
///
/// Adds submitter information to passed request json, signs it with submitter
/// sign key (see wallet_sign), and sends signed request message
/// to validator pool (see write_request).
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// pool_handle: pool handle (created by open_pool_ledger).
/// wallet_handle: wallet handle (created by open_wallet).
/// submitter_did: Id of Identity stored in secured Wallet.
/// request_json: Request data json.
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
/// Wallet*
/// Ledger*
/// Crypto*
extern sovrin_error_t sovrin_sign_and_submit_request(sovrin_handle_t command_handle,
sovrin_handle_t pool_handle,
sovrin_handle_t wallet_handle,
const char * submitter_did,
const char * request_json,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_result_json)
);
/// Publishes request message to validator pool (no signing, unlike sign_and_submit_request).
///
/// The request is sent to the validator pool as is. It's assumed that it's already prepared.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// pool_handle: pool handle (created by open_pool_ledger).
/// request_json: Request data json.
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
/// Ledger*
extern sovrin_error_t sovrin_submit_request(sovrin_handle_t command_handle,
sovrin_handle_t pool_handle,
const char * request_json,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_result_json)
);
/// Builds a request to get a DDO.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_get_ddo_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * target_did,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_result_json)
);
/// Builds a NYM request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// verkey: verification key
/// alias
/// role: Role of a user NYM record
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_nym_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * target_did,
const char * verkey,
const char * alias,
const char * role,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds an ATTRIB request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// hash: Hash of attribute data
/// raw: represented as json, where key is attribute name and value is it's value
/// enc: Encrypted attribute data
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_attrib_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * target_did,
const char * hash,
const char * raw,
const char * enc,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a GET_ATTRIB request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// data: name (attribute name)
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_get_attrib_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * target_did,
const char * data,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a GET_NYM request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_get_nym_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * target_did,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a SCHEMA request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// data: name, version, type, attr_names (ip, port, keys)
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_schema_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * data,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a GET_SCHEMA request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// dest: Id of Identity stored in secured Wallet.
/// data: name, version
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_get_schema_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * dest,
const char * data,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds an CLAIM_DEF request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// xref: Seq. number of schema
/// signature_type
/// data: components of a key in json: N, R, S, Z
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_claim_def_txn(sovrin_handle_t command_handle,
const char * submitter_did,
const char * xref,
const char * signature_type,
const char * data,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a GET_CLAIM_DEF request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// xref: Seq. number of schema
/// signature_type: signature type (only CL supported now)
/// origin: issuer did
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_get_claim_def_txn(sovrin_handle_t command_handle,
const char * submitter_did,
const char * xref,
const char * signature_type,
const char * origin,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a NODE request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// data: id of a target NYM record
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_node_request(sovrin_handle_t command_handle,
const char * submitter_did,
const char * target_did,
const char * data,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
/// Builds a NODE request.
///
/// #Params
/// command_handle: command handle to map callback to caller context.
/// submitter_did: Id of Identity stored in secured Wallet.
/// target_did: Id of Identity stored in secured Wallet.
/// data: id of a target NYM record
/// cb: Callback that takes command result as parameter.
///
/// #Returns
/// Request result as json.
///
/// #Errors
/// Common*
extern sovrin_error_t sovrin_build_get_txn_request(sovrin_handle_t command_handle,
const char * submitter_did,
sovrin_i32_t data,
void (*cb)(sovrin_handle_t xcommand_handle,
sovrin_error_t err,
const char* request_json)
);
#ifdef __cplusplus
}
#endif
#endif