@miden-sdk/miden-wallet-adapter-miden 0.16.2 → 0.16.3

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.
@@ -1,506 +0,0 @@
1
- [**@miden-sdk/miden-wallet-adapter-miden**](../README.md)
2
-
3
- ***
4
-
5
- [@miden-sdk/miden-wallet-adapter-miden](../README.md) / MidenWallet
6
-
7
- # Interface: MidenWallet
8
-
9
- ## Extends
10
-
11
- - `EventEmitter`\<[`MidenWalletEvents`](MidenWalletEvents.md)\>
12
-
13
- ## Properties
14
-
15
- ### address?
16
-
17
- > `optional` **address**: `string`
18
-
19
- ***
20
-
21
- ### publicKey?
22
-
23
- > `optional` **publicKey**: `Uint8Array`
24
-
25
- ## Methods
26
-
27
- ### addListener()
28
-
29
- > **addListener**\<`T`\>(`event`, `fn`, `context?`): `this`
30
-
31
- #### Type Parameters
32
-
33
- ##### T
34
-
35
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
36
-
37
- #### Parameters
38
-
39
- ##### event
40
-
41
- `T`
42
-
43
- ##### fn
44
-
45
- (...`args`) => `void`
46
-
47
- ##### context?
48
-
49
- `any`
50
-
51
- #### Returns
52
-
53
- `this`
54
-
55
- #### Inherited from
56
-
57
- `EventEmitter.addListener`
58
-
59
- ***
60
-
61
- ### connect()
62
-
63
- > **connect**(`privateDataPermission`, `network`, `allowedPrivateData?`): `Promise`\<`void`\>
64
-
65
- #### Parameters
66
-
67
- ##### privateDataPermission
68
-
69
- `PrivateDataPermission`
70
-
71
- ##### network
72
-
73
- `WalletAdapterNetwork`
74
-
75
- ##### allowedPrivateData?
76
-
77
- `AllowedPrivateData`
78
-
79
- #### Returns
80
-
81
- `Promise`\<`void`\>
82
-
83
- ***
84
-
85
- ### disconnect()
86
-
87
- > **disconnect**(): `Promise`\<`void`\>
88
-
89
- #### Returns
90
-
91
- `Promise`\<`void`\>
92
-
93
- ***
94
-
95
- ### emit()
96
-
97
- > **emit**\<`T`\>(`event`, ...`args`): `boolean`
98
-
99
- Calls each of the listeners registered for a given event.
100
-
101
- #### Type Parameters
102
-
103
- ##### T
104
-
105
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
106
-
107
- #### Parameters
108
-
109
- ##### event
110
-
111
- `T`
112
-
113
- ##### args
114
-
115
- ...`ArgumentMap`\<[`MidenWalletEvents`](MidenWalletEvents.md)\>\[`Extract`\<`T`, keyof [`MidenWalletEvents`](MidenWalletEvents.md)\>\]
116
-
117
- #### Returns
118
-
119
- `boolean`
120
-
121
- #### Inherited from
122
-
123
- `EventEmitter.emit`
124
-
125
- ***
126
-
127
- ### eventNames()
128
-
129
- > **eventNames**(): keyof [`MidenWalletEvents`](MidenWalletEvents.md)[]
130
-
131
- Return an array listing the events for which the emitter has registered
132
- listeners.
133
-
134
- #### Returns
135
-
136
- keyof [`MidenWalletEvents`](MidenWalletEvents.md)[]
137
-
138
- #### Inherited from
139
-
140
- `EventEmitter.eventNames`
141
-
142
- ***
143
-
144
- ### importPrivateNote()
145
-
146
- > **importPrivateNote**(`note`): `Promise`\<\{ `noteId`: `string`; \}\>
147
-
148
- #### Parameters
149
-
150
- ##### note
151
-
152
- `Uint8Array`
153
-
154
- #### Returns
155
-
156
- `Promise`\<\{ `noteId`: `string`; \}\>
157
-
158
- ***
159
-
160
- ### listenerCount()
161
-
162
- > **listenerCount**(`event`): `number`
163
-
164
- Return the number of listeners listening to a given event.
165
-
166
- #### Parameters
167
-
168
- ##### event
169
-
170
- keyof [`MidenWalletEvents`](MidenWalletEvents.md)
171
-
172
- #### Returns
173
-
174
- `number`
175
-
176
- #### Inherited from
177
-
178
- `EventEmitter.listenerCount`
179
-
180
- ***
181
-
182
- ### listeners()
183
-
184
- > **listeners**\<`T`\>(`event`): (...`args`) => `void`[]
185
-
186
- Return the listeners registered for a given event.
187
-
188
- #### Type Parameters
189
-
190
- ##### T
191
-
192
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
193
-
194
- #### Parameters
195
-
196
- ##### event
197
-
198
- `T`
199
-
200
- #### Returns
201
-
202
- (...`args`) => `void`[]
203
-
204
- #### Inherited from
205
-
206
- `EventEmitter.listeners`
207
-
208
- ***
209
-
210
- ### off()
211
-
212
- > **off**\<`T`\>(`event`, `fn?`, `context?`, `once?`): `this`
213
-
214
- #### Type Parameters
215
-
216
- ##### T
217
-
218
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
219
-
220
- #### Parameters
221
-
222
- ##### event
223
-
224
- `T`
225
-
226
- ##### fn?
227
-
228
- (...`args`) => `void`
229
-
230
- ##### context?
231
-
232
- `any`
233
-
234
- ##### once?
235
-
236
- `boolean`
237
-
238
- #### Returns
239
-
240
- `this`
241
-
242
- #### Inherited from
243
-
244
- `EventEmitter.off`
245
-
246
- ***
247
-
248
- ### on()
249
-
250
- > **on**\<`T`\>(`event`, `fn`, `context?`): `this`
251
-
252
- Add a listener for a given event.
253
-
254
- #### Type Parameters
255
-
256
- ##### T
257
-
258
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
259
-
260
- #### Parameters
261
-
262
- ##### event
263
-
264
- `T`
265
-
266
- ##### fn
267
-
268
- (...`args`) => `void`
269
-
270
- ##### context?
271
-
272
- `any`
273
-
274
- #### Returns
275
-
276
- `this`
277
-
278
- #### Inherited from
279
-
280
- `EventEmitter.on`
281
-
282
- ***
283
-
284
- ### once()
285
-
286
- > **once**\<`T`\>(`event`, `fn`, `context?`): `this`
287
-
288
- Add a one-time listener for a given event.
289
-
290
- #### Type Parameters
291
-
292
- ##### T
293
-
294
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
295
-
296
- #### Parameters
297
-
298
- ##### event
299
-
300
- `T`
301
-
302
- ##### fn
303
-
304
- (...`args`) => `void`
305
-
306
- ##### context?
307
-
308
- `any`
309
-
310
- #### Returns
311
-
312
- `this`
313
-
314
- #### Inherited from
315
-
316
- `EventEmitter.once`
317
-
318
- ***
319
-
320
- ### removeAllListeners()
321
-
322
- > **removeAllListeners**(`event?`): `this`
323
-
324
- Remove all listeners, or those of the specified event.
325
-
326
- #### Parameters
327
-
328
- ##### event?
329
-
330
- keyof [`MidenWalletEvents`](MidenWalletEvents.md)
331
-
332
- #### Returns
333
-
334
- `this`
335
-
336
- #### Inherited from
337
-
338
- `EventEmitter.removeAllListeners`
339
-
340
- ***
341
-
342
- ### removeListener()
343
-
344
- > **removeListener**\<`T`\>(`event`, `fn?`, `context?`, `once?`): `this`
345
-
346
- Remove the listeners of a given event.
347
-
348
- #### Type Parameters
349
-
350
- ##### T
351
-
352
- `T` *extends* keyof [`MidenWalletEvents`](MidenWalletEvents.md)
353
-
354
- #### Parameters
355
-
356
- ##### event
357
-
358
- `T`
359
-
360
- ##### fn?
361
-
362
- (...`args`) => `void`
363
-
364
- ##### context?
365
-
366
- `any`
367
-
368
- ##### once?
369
-
370
- `boolean`
371
-
372
- #### Returns
373
-
374
- `this`
375
-
376
- #### Inherited from
377
-
378
- `EventEmitter.removeListener`
379
-
380
- ***
381
-
382
- ### requestAssets()
383
-
384
- > **requestAssets**(): `Promise`\<\{ `assets`: `Asset`[]; \}\>
385
-
386
- #### Returns
387
-
388
- `Promise`\<\{ `assets`: `Asset`[]; \}\>
389
-
390
- ***
391
-
392
- ### requestConsumableNotes()
393
-
394
- > **requestConsumableNotes**(): `Promise`\<\{ `consumableNotes`: `InputNoteDetails`[]; \}\>
395
-
396
- #### Returns
397
-
398
- `Promise`\<\{ `consumableNotes`: `InputNoteDetails`[]; \}\>
399
-
400
- ***
401
-
402
- ### requestConsume()
403
-
404
- > **requestConsume**(`transaction`): `Promise`\<\{ `transactionId?`: `string`; \}\>
405
-
406
- #### Parameters
407
-
408
- ##### transaction
409
-
410
- `MidenConsumeTransaction`
411
-
412
- #### Returns
413
-
414
- `Promise`\<\{ `transactionId?`: `string`; \}\>
415
-
416
- ***
417
-
418
- ### requestPrivateNotes()
419
-
420
- > **requestPrivateNotes**(`noteFilterType`, `noteIds?`): `Promise`\<\{ `privateNotes`: `InputNoteDetails`[]; \}\>
421
-
422
- #### Parameters
423
-
424
- ##### noteFilterType
425
-
426
- `NoteFilterTypes`
427
-
428
- ##### noteIds?
429
-
430
- `string`[]
431
-
432
- #### Returns
433
-
434
- `Promise`\<\{ `privateNotes`: `InputNoteDetails`[]; \}\>
435
-
436
- ***
437
-
438
- ### requestSend()
439
-
440
- > **requestSend**(`transaction`): `Promise`\<\{ `transactionId?`: `string`; \}\>
441
-
442
- #### Parameters
443
-
444
- ##### transaction
445
-
446
- `MidenSendTransaction`
447
-
448
- #### Returns
449
-
450
- `Promise`\<\{ `transactionId?`: `string`; \}\>
451
-
452
- ***
453
-
454
- ### requestTransaction()
455
-
456
- > **requestTransaction**(`transaction`): `Promise`\<\{ `transactionId?`: `string`; \}\>
457
-
458
- #### Parameters
459
-
460
- ##### transaction
461
-
462
- `MidenTransaction`
463
-
464
- #### Returns
465
-
466
- `Promise`\<\{ `transactionId?`: `string`; \}\>
467
-
468
- ***
469
-
470
- ### signBytes()
471
-
472
- > **signBytes**(`message`, `kind`): `Promise`\<\{ `signature`: `Uint8Array`; \}\>
473
-
474
- #### Parameters
475
-
476
- ##### message
477
-
478
- `Uint8Array`
479
-
480
- ##### kind
481
-
482
- `SignKind`
483
-
484
- #### Returns
485
-
486
- `Promise`\<\{ `signature`: `Uint8Array`; \}\>
487
-
488
- ***
489
-
490
- ### waitForTransaction()
491
-
492
- > **waitForTransaction**(`txId`, `timeout?`): `Promise`\<`WalletTransactionOutput`\>
493
-
494
- #### Parameters
495
-
496
- ##### txId
497
-
498
- `string`
499
-
500
- ##### timeout?
501
-
502
- `number`
503
-
504
- #### Returns
505
-
506
- `Promise`\<`WalletTransactionOutput`\>
@@ -1,13 +0,0 @@
1
- [**@miden-sdk/miden-wallet-adapter-miden**](../README.md)
2
-
3
- ***
4
-
5
- [@miden-sdk/miden-wallet-adapter-miden](../README.md) / MidenWalletAdapterConfig
6
-
7
- # Interface: MidenWalletAdapterConfig
8
-
9
- ## Properties
10
-
11
- ### appName?
12
-
13
- > `optional` **appName**: `string`
@@ -1,55 +0,0 @@
1
- [**@miden-sdk/miden-wallet-adapter-miden**](../README.md)
2
-
3
- ***
4
-
5
- [@miden-sdk/miden-wallet-adapter-miden](../README.md) / MidenWalletEvents
6
-
7
- # Interface: MidenWalletEvents
8
-
9
- ## Methods
10
-
11
- ### accountChange()
12
-
13
- > **accountChange**(...`args`): `unknown`
14
-
15
- #### Parameters
16
-
17
- ##### args
18
-
19
- ...`unknown`[]
20
-
21
- #### Returns
22
-
23
- `unknown`
24
-
25
- ***
26
-
27
- ### connect()
28
-
29
- > **connect**(...`args`): `unknown`
30
-
31
- #### Parameters
32
-
33
- ##### args
34
-
35
- ...`unknown`[]
36
-
37
- #### Returns
38
-
39
- `unknown`
40
-
41
- ***
42
-
43
- ### disconnect()
44
-
45
- > **disconnect**(...`args`): `unknown`
46
-
47
- #### Parameters
48
-
49
- ##### args
50
-
51
- ...`unknown`[]
52
-
53
- #### Returns
54
-
55
- `unknown`