@miden-sdk/miden-wallet-adapter-base 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.
- package/dist/adapter.js.map +1 -1
- package/dist/errors.js.map +1 -1
- package/dist/helpers.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/signer.js.map +1 -1
- package/dist/transaction.js.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +9 -3
- package/__tests__/adapter.test.ts +0 -82
- package/__tests__/errors.test.ts +0 -100
- package/__tests__/helpers.test.ts +0 -39
- package/__tests__/signer.test.ts +0 -20
- package/__tests__/transaction.test.ts +0 -166
- package/adapter.ts +0 -146
- package/dist/__tests__/adapter.test.d.ts +0 -1
- package/dist/__tests__/adapter.test.js +0 -66
- package/dist/__tests__/adapter.test.js.map +0 -1
- package/dist/__tests__/errors.test.d.ts +0 -1
- package/dist/__tests__/errors.test.js +0 -70
- package/dist/__tests__/errors.test.js.map +0 -1
- package/dist/__tests__/helpers.test.d.ts +0 -1
- package/dist/__tests__/helpers.test.js +0 -35
- package/dist/__tests__/helpers.test.js.map +0 -1
- package/dist/__tests__/signer.test.d.ts +0 -1
- package/dist/__tests__/signer.test.js +0 -18
- package/dist/__tests__/signer.test.js.map +0 -1
- package/dist/__tests__/transaction.test.d.ts +0 -1
- package/dist/__tests__/transaction.test.js +0 -113
- package/dist/__tests__/transaction.test.js.map +0 -1
- package/dist/vitest.config.d.ts +0 -2
- package/dist/vitest.config.js +0 -8
- package/dist/vitest.config.js.map +0 -1
- package/docs/@miden-sdk/namespaces/EventEmitter/README.md +0 -24
- package/docs/@miden-sdk/namespaces/EventEmitter/interfaces/EventEmitterStatic.md +0 -17
- package/docs/@miden-sdk/namespaces/EventEmitter/interfaces/ListenerFn.md +0 -25
- package/docs/@miden-sdk/namespaces/EventEmitter/type-aliases/ArgumentMap.md +0 -15
- package/docs/@miden-sdk/namespaces/EventEmitter/type-aliases/EventArgs.md +0 -19
- package/docs/@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md +0 -19
- package/docs/@miden-sdk/namespaces/EventEmitter/type-aliases/EventNames.md +0 -15
- package/docs/@miden-sdk/namespaces/EventEmitter/type-aliases/ValidEventTypes.md +0 -17
- package/docs/@miden-sdk/namespaces/EventEmitter/variables/EventEmitter.md +0 -9
- package/docs/README.md +0 -88
- package/docs/classes/BaseMessageSignerWalletAdapter.md +0 -755
- package/docs/classes/BaseSignerWalletAdapter.md +0 -579
- package/docs/classes/BaseWalletAdapter.md +0 -535
- package/docs/classes/ConsumeTransaction.md +0 -93
- package/docs/classes/CustomTransaction.md +0 -93
- package/docs/classes/EventEmitter.md +0 -305
- package/docs/classes/SendTransaction.md +0 -107
- package/docs/classes/Transaction.md +0 -151
- package/docs/classes/WalletAccountError.md +0 -223
- package/docs/classes/WalletAddressError.md +0 -223
- package/docs/classes/WalletConfigError.md +0 -223
- package/docs/classes/WalletConnectionError.md +0 -223
- package/docs/classes/WalletDecryptionError.md +0 -223
- package/docs/classes/WalletDecryptionNotAllowedError.md +0 -223
- package/docs/classes/WalletDisconnectedError.md +0 -223
- package/docs/classes/WalletDisconnectionError.md +0 -223
- package/docs/classes/WalletError.md +0 -244
- package/docs/classes/WalletKeypairError.md +0 -223
- package/docs/classes/WalletLoadError.md +0 -223
- package/docs/classes/WalletNotConnectedError.md +0 -223
- package/docs/classes/WalletNotReadyError.md +0 -223
- package/docs/classes/WalletNotSelectedError.md +0 -223
- package/docs/classes/WalletPrivateDataPermissionError.md +0 -223
- package/docs/classes/WalletRecordsError.md +0 -223
- package/docs/classes/WalletSendTransactionError.md +0 -223
- package/docs/classes/WalletSignMessageError.md +0 -223
- package/docs/classes/WalletSignTransactionError.md +0 -223
- package/docs/classes/WalletTimeoutError.md +0 -223
- package/docs/classes/WalletTransactionError.md +0 -223
- package/docs/classes/WalletWindowBlockedError.md +0 -223
- package/docs/classes/WalletWindowClosedError.md +0 -223
- package/docs/enumerations/AllowedPrivateData.md +0 -37
- package/docs/enumerations/PrivateDataPermission.md +0 -19
- package/docs/enumerations/TransactionType.md +0 -25
- package/docs/enumerations/WalletAdapterNetwork.md +0 -19
- package/docs/enumerations/WalletReadyState.md +0 -49
- package/docs/functions/b64ToU8.md +0 -19
- package/docs/functions/scopePollingDetectionStrategy.md +0 -19
- package/docs/functions/u8ToB64.md +0 -19
- package/docs/interfaces/Asset.md +0 -19
- package/docs/interfaces/IFailedTransactionOutput.md +0 -13
- package/docs/interfaces/MessageSignerWalletAdapterProps.md +0 -293
- package/docs/interfaces/MidenConsumeTransaction.md +0 -37
- package/docs/interfaces/MidenCustomTransaction.md +0 -37
- package/docs/interfaces/MidenSendTransaction.md +0 -43
- package/docs/interfaces/MidenTransaction.md +0 -19
- package/docs/interfaces/SignerWalletAdapterProps.md +0 -149
- package/docs/interfaces/TransactionOutput.md +0 -19
- package/docs/interfaces/WalletAdapterEvents.md +0 -69
- package/docs/interfaces/WalletAdapterProps.md +0 -106
- package/docs/interfaces/WalletTransactionSuccessOutput.md +0 -19
- package/docs/type-aliases/Adapter.md +0 -9
- package/docs/type-aliases/FungibleAssetDetails.md +0 -21
- package/docs/type-aliases/InputNoteDetails.md +0 -45
- package/docs/type-aliases/MessageSignerWalletAdapter.md +0 -15
- package/docs/type-aliases/NoteTypeString.md +0 -9
- package/docs/type-aliases/SignKind.md +0 -9
- package/docs/type-aliases/SignerWalletAdapter.md +0 -15
- package/docs/type-aliases/SupportedTransactionVersions.md +0 -9
- package/docs/type-aliases/TransactionOrVersionedTransaction.md +0 -15
- package/docs/type-aliases/TransactionPayload.md +0 -9
- package/docs/type-aliases/WalletAdapter.md +0 -15
- package/docs/type-aliases/WalletName.md +0 -21
- package/docs/type-aliases/WalletTransactionOutput.md +0 -9
- package/errors.ts +0 -97
- package/helpers.ts +0 -28
- package/index.ts +0 -6
- package/signer.ts +0 -84
- package/transaction.ts +0 -178
- package/tsconfig.json +0 -15
- package/types.ts +0 -93
- package/vitest.config.ts +0 -8
|
@@ -1,535 +0,0 @@
|
|
|
1
|
-
[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@miden-sdk/miden-wallet-adapter-base](../README.md) / BaseWalletAdapter
|
|
6
|
-
|
|
7
|
-
# Abstract Class: BaseWalletAdapter\<Name\>
|
|
8
|
-
|
|
9
|
-
Minimal `EventEmitter` interface that is molded against the Node.js
|
|
10
|
-
`EventEmitter` interface.
|
|
11
|
-
|
|
12
|
-
## Extends
|
|
13
|
-
|
|
14
|
-
- [`EventEmitter`](EventEmitter.md)\<[`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)\>
|
|
15
|
-
|
|
16
|
-
## Extended by
|
|
17
|
-
|
|
18
|
-
- [`BaseSignerWalletAdapter`](BaseSignerWalletAdapter.md)
|
|
19
|
-
|
|
20
|
-
## Type Parameters
|
|
21
|
-
|
|
22
|
-
### Name
|
|
23
|
-
|
|
24
|
-
`Name` *extends* `string` = `string`
|
|
25
|
-
|
|
26
|
-
## Implements
|
|
27
|
-
|
|
28
|
-
- [`WalletAdapter`](../type-aliases/WalletAdapter.md)\<`Name`\>
|
|
29
|
-
|
|
30
|
-
## Constructors
|
|
31
|
-
|
|
32
|
-
### Constructor
|
|
33
|
-
|
|
34
|
-
> **new BaseWalletAdapter**\<`Name`\>(): `BaseWalletAdapter`\<`Name`\>
|
|
35
|
-
|
|
36
|
-
#### Returns
|
|
37
|
-
|
|
38
|
-
`BaseWalletAdapter`\<`Name`\>
|
|
39
|
-
|
|
40
|
-
#### Inherited from
|
|
41
|
-
|
|
42
|
-
[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructor)
|
|
43
|
-
|
|
44
|
-
## Properties
|
|
45
|
-
|
|
46
|
-
### address
|
|
47
|
-
|
|
48
|
-
> `abstract` **address**: `string`
|
|
49
|
-
|
|
50
|
-
#### Implementation of
|
|
51
|
-
|
|
52
|
-
`WalletAdapter.address`
|
|
53
|
-
|
|
54
|
-
***
|
|
55
|
-
|
|
56
|
-
### connecting
|
|
57
|
-
|
|
58
|
-
> `abstract` **connecting**: `boolean`
|
|
59
|
-
|
|
60
|
-
#### Implementation of
|
|
61
|
-
|
|
62
|
-
`WalletAdapter.connecting`
|
|
63
|
-
|
|
64
|
-
***
|
|
65
|
-
|
|
66
|
-
### icon
|
|
67
|
-
|
|
68
|
-
> `abstract` **icon**: `string`
|
|
69
|
-
|
|
70
|
-
#### Implementation of
|
|
71
|
-
|
|
72
|
-
`WalletAdapter.icon`
|
|
73
|
-
|
|
74
|
-
***
|
|
75
|
-
|
|
76
|
-
### name
|
|
77
|
-
|
|
78
|
-
> `abstract` **name**: [`WalletName`](../type-aliases/WalletName.md)\<`Name`\>
|
|
79
|
-
|
|
80
|
-
#### Implementation of
|
|
81
|
-
|
|
82
|
-
`WalletAdapter.name`
|
|
83
|
-
|
|
84
|
-
***
|
|
85
|
-
|
|
86
|
-
### publicKey
|
|
87
|
-
|
|
88
|
-
> `abstract` **publicKey**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
89
|
-
|
|
90
|
-
#### Implementation of
|
|
91
|
-
|
|
92
|
-
`WalletAdapter.publicKey`
|
|
93
|
-
|
|
94
|
-
***
|
|
95
|
-
|
|
96
|
-
### readyState
|
|
97
|
-
|
|
98
|
-
> `abstract` **readyState**: [`WalletReadyState`](../enumerations/WalletReadyState.md)
|
|
99
|
-
|
|
100
|
-
#### Implementation of
|
|
101
|
-
|
|
102
|
-
`WalletAdapter.readyState`
|
|
103
|
-
|
|
104
|
-
***
|
|
105
|
-
|
|
106
|
-
### supportedTransactionVersions
|
|
107
|
-
|
|
108
|
-
> `abstract` **supportedTransactionVersions**: `ReadonlySet`
|
|
109
|
-
|
|
110
|
-
#### Implementation of
|
|
111
|
-
|
|
112
|
-
`WalletAdapter.supportedTransactionVersions`
|
|
113
|
-
|
|
114
|
-
***
|
|
115
|
-
|
|
116
|
-
### url
|
|
117
|
-
|
|
118
|
-
> `abstract` **url**: `string`
|
|
119
|
-
|
|
120
|
-
#### Implementation of
|
|
121
|
-
|
|
122
|
-
`WalletAdapter.url`
|
|
123
|
-
|
|
124
|
-
***
|
|
125
|
-
|
|
126
|
-
### prefixed
|
|
127
|
-
|
|
128
|
-
> `static` **prefixed**: `string` \| `boolean`
|
|
129
|
-
|
|
130
|
-
#### Inherited from
|
|
131
|
-
|
|
132
|
-
[`EventEmitter`](EventEmitter.md).[`prefixed`](EventEmitter.md#prefixed)
|
|
133
|
-
|
|
134
|
-
## Accessors
|
|
135
|
-
|
|
136
|
-
### connected
|
|
137
|
-
|
|
138
|
-
#### Get Signature
|
|
139
|
-
|
|
140
|
-
> **get** **connected**(): `boolean`
|
|
141
|
-
|
|
142
|
-
##### Returns
|
|
143
|
-
|
|
144
|
-
`boolean`
|
|
145
|
-
|
|
146
|
-
#### Implementation of
|
|
147
|
-
|
|
148
|
-
`WalletAdapter.connected`
|
|
149
|
-
|
|
150
|
-
## Methods
|
|
151
|
-
|
|
152
|
-
### addListener()
|
|
153
|
-
|
|
154
|
-
> **addListener**\<`T`\>(`event`, `fn`, `context?`): `this`
|
|
155
|
-
|
|
156
|
-
#### Type Parameters
|
|
157
|
-
|
|
158
|
-
##### T
|
|
159
|
-
|
|
160
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
161
|
-
|
|
162
|
-
#### Parameters
|
|
163
|
-
|
|
164
|
-
##### event
|
|
165
|
-
|
|
166
|
-
`T`
|
|
167
|
-
|
|
168
|
-
##### fn
|
|
169
|
-
|
|
170
|
-
(...`args`) => `void`
|
|
171
|
-
|
|
172
|
-
##### context?
|
|
173
|
-
|
|
174
|
-
`any`
|
|
175
|
-
|
|
176
|
-
#### Returns
|
|
177
|
-
|
|
178
|
-
`this`
|
|
179
|
-
|
|
180
|
-
#### Implementation of
|
|
181
|
-
|
|
182
|
-
`WalletAdapter.addListener`
|
|
183
|
-
|
|
184
|
-
#### Inherited from
|
|
185
|
-
|
|
186
|
-
[`EventEmitter`](EventEmitter.md).[`addListener`](EventEmitter.md#addlistener)
|
|
187
|
-
|
|
188
|
-
***
|
|
189
|
-
|
|
190
|
-
### connect()
|
|
191
|
-
|
|
192
|
-
> `abstract` **connect**(`privateDataPermission`, `network`, `allowedPrivateData?`): `Promise`\<`void`\>
|
|
193
|
-
|
|
194
|
-
#### Parameters
|
|
195
|
-
|
|
196
|
-
##### privateDataPermission
|
|
197
|
-
|
|
198
|
-
[`PrivateDataPermission`](../enumerations/PrivateDataPermission.md)
|
|
199
|
-
|
|
200
|
-
##### network
|
|
201
|
-
|
|
202
|
-
[`WalletAdapterNetwork`](../enumerations/WalletAdapterNetwork.md)
|
|
203
|
-
|
|
204
|
-
##### allowedPrivateData?
|
|
205
|
-
|
|
206
|
-
[`AllowedPrivateData`](../enumerations/AllowedPrivateData.md)
|
|
207
|
-
|
|
208
|
-
#### Returns
|
|
209
|
-
|
|
210
|
-
`Promise`\<`void`\>
|
|
211
|
-
|
|
212
|
-
#### Implementation of
|
|
213
|
-
|
|
214
|
-
`WalletAdapter.connect`
|
|
215
|
-
|
|
216
|
-
***
|
|
217
|
-
|
|
218
|
-
### disconnect()
|
|
219
|
-
|
|
220
|
-
> `abstract` **disconnect**(): `Promise`\<`void`\>
|
|
221
|
-
|
|
222
|
-
#### Returns
|
|
223
|
-
|
|
224
|
-
`Promise`\<`void`\>
|
|
225
|
-
|
|
226
|
-
#### Implementation of
|
|
227
|
-
|
|
228
|
-
`WalletAdapter.disconnect`
|
|
229
|
-
|
|
230
|
-
***
|
|
231
|
-
|
|
232
|
-
### emit()
|
|
233
|
-
|
|
234
|
-
> **emit**\<`T`\>(`event`, ...`args`): `boolean`
|
|
235
|
-
|
|
236
|
-
Calls each of the listeners registered for a given event.
|
|
237
|
-
|
|
238
|
-
#### Type Parameters
|
|
239
|
-
|
|
240
|
-
##### T
|
|
241
|
-
|
|
242
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
243
|
-
|
|
244
|
-
#### Parameters
|
|
245
|
-
|
|
246
|
-
##### event
|
|
247
|
-
|
|
248
|
-
`T`
|
|
249
|
-
|
|
250
|
-
##### args
|
|
251
|
-
|
|
252
|
-
...[`ArgumentMap`](../@miden-sdk/namespaces/EventEmitter/type-aliases/ArgumentMap.md)\<[`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)\>\[`Extract`\<`T`, keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)\>\]
|
|
253
|
-
|
|
254
|
-
#### Returns
|
|
255
|
-
|
|
256
|
-
`boolean`
|
|
257
|
-
|
|
258
|
-
#### Implementation of
|
|
259
|
-
|
|
260
|
-
`WalletAdapter.emit`
|
|
261
|
-
|
|
262
|
-
#### Inherited from
|
|
263
|
-
|
|
264
|
-
[`EventEmitter`](EventEmitter.md).[`emit`](EventEmitter.md#emit)
|
|
265
|
-
|
|
266
|
-
***
|
|
267
|
-
|
|
268
|
-
### eventNames()
|
|
269
|
-
|
|
270
|
-
> **eventNames**(): keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)[]
|
|
271
|
-
|
|
272
|
-
Return an array listing the events for which the emitter has registered
|
|
273
|
-
listeners.
|
|
274
|
-
|
|
275
|
-
#### Returns
|
|
276
|
-
|
|
277
|
-
keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)[]
|
|
278
|
-
|
|
279
|
-
#### Implementation of
|
|
280
|
-
|
|
281
|
-
`WalletAdapter.eventNames`
|
|
282
|
-
|
|
283
|
-
#### Inherited from
|
|
284
|
-
|
|
285
|
-
[`EventEmitter`](EventEmitter.md).[`eventNames`](EventEmitter.md#eventnames)
|
|
286
|
-
|
|
287
|
-
***
|
|
288
|
-
|
|
289
|
-
### listenerCount()
|
|
290
|
-
|
|
291
|
-
> **listenerCount**(`event`): `number`
|
|
292
|
-
|
|
293
|
-
Return the number of listeners listening to a given event.
|
|
294
|
-
|
|
295
|
-
#### Parameters
|
|
296
|
-
|
|
297
|
-
##### event
|
|
298
|
-
|
|
299
|
-
keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
300
|
-
|
|
301
|
-
#### Returns
|
|
302
|
-
|
|
303
|
-
`number`
|
|
304
|
-
|
|
305
|
-
#### Implementation of
|
|
306
|
-
|
|
307
|
-
`WalletAdapter.listenerCount`
|
|
308
|
-
|
|
309
|
-
#### Inherited from
|
|
310
|
-
|
|
311
|
-
[`EventEmitter`](EventEmitter.md).[`listenerCount`](EventEmitter.md#listenercount)
|
|
312
|
-
|
|
313
|
-
***
|
|
314
|
-
|
|
315
|
-
### listeners()
|
|
316
|
-
|
|
317
|
-
> **listeners**\<`T`\>(`event`): (...`args`) => `void`[]
|
|
318
|
-
|
|
319
|
-
Return the listeners registered for a given event.
|
|
320
|
-
|
|
321
|
-
#### Type Parameters
|
|
322
|
-
|
|
323
|
-
##### T
|
|
324
|
-
|
|
325
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
326
|
-
|
|
327
|
-
#### Parameters
|
|
328
|
-
|
|
329
|
-
##### event
|
|
330
|
-
|
|
331
|
-
`T`
|
|
332
|
-
|
|
333
|
-
#### Returns
|
|
334
|
-
|
|
335
|
-
(...`args`) => `void`[]
|
|
336
|
-
|
|
337
|
-
#### Implementation of
|
|
338
|
-
|
|
339
|
-
`WalletAdapter.listeners`
|
|
340
|
-
|
|
341
|
-
#### Inherited from
|
|
342
|
-
|
|
343
|
-
[`EventEmitter`](EventEmitter.md).[`listeners`](EventEmitter.md#listeners)
|
|
344
|
-
|
|
345
|
-
***
|
|
346
|
-
|
|
347
|
-
### off()
|
|
348
|
-
|
|
349
|
-
> **off**\<`T`\>(`event`, `fn?`, `context?`, `once?`): `this`
|
|
350
|
-
|
|
351
|
-
#### Type Parameters
|
|
352
|
-
|
|
353
|
-
##### T
|
|
354
|
-
|
|
355
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
356
|
-
|
|
357
|
-
#### Parameters
|
|
358
|
-
|
|
359
|
-
##### event
|
|
360
|
-
|
|
361
|
-
`T`
|
|
362
|
-
|
|
363
|
-
##### fn?
|
|
364
|
-
|
|
365
|
-
(...`args`) => `void`
|
|
366
|
-
|
|
367
|
-
##### context?
|
|
368
|
-
|
|
369
|
-
`any`
|
|
370
|
-
|
|
371
|
-
##### once?
|
|
372
|
-
|
|
373
|
-
`boolean`
|
|
374
|
-
|
|
375
|
-
#### Returns
|
|
376
|
-
|
|
377
|
-
`this`
|
|
378
|
-
|
|
379
|
-
#### Implementation of
|
|
380
|
-
|
|
381
|
-
`WalletAdapter.off`
|
|
382
|
-
|
|
383
|
-
#### Inherited from
|
|
384
|
-
|
|
385
|
-
[`EventEmitter`](EventEmitter.md).[`off`](EventEmitter.md#off)
|
|
386
|
-
|
|
387
|
-
***
|
|
388
|
-
|
|
389
|
-
### on()
|
|
390
|
-
|
|
391
|
-
> **on**\<`T`\>(`event`, `fn`, `context?`): `this`
|
|
392
|
-
|
|
393
|
-
Add a listener for a given event.
|
|
394
|
-
|
|
395
|
-
#### Type Parameters
|
|
396
|
-
|
|
397
|
-
##### T
|
|
398
|
-
|
|
399
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
400
|
-
|
|
401
|
-
#### Parameters
|
|
402
|
-
|
|
403
|
-
##### event
|
|
404
|
-
|
|
405
|
-
`T`
|
|
406
|
-
|
|
407
|
-
##### fn
|
|
408
|
-
|
|
409
|
-
(...`args`) => `void`
|
|
410
|
-
|
|
411
|
-
##### context?
|
|
412
|
-
|
|
413
|
-
`any`
|
|
414
|
-
|
|
415
|
-
#### Returns
|
|
416
|
-
|
|
417
|
-
`this`
|
|
418
|
-
|
|
419
|
-
#### Implementation of
|
|
420
|
-
|
|
421
|
-
`WalletAdapter.on`
|
|
422
|
-
|
|
423
|
-
#### Inherited from
|
|
424
|
-
|
|
425
|
-
[`EventEmitter`](EventEmitter.md).[`on`](EventEmitter.md#on)
|
|
426
|
-
|
|
427
|
-
***
|
|
428
|
-
|
|
429
|
-
### once()
|
|
430
|
-
|
|
431
|
-
> **once**\<`T`\>(`event`, `fn`, `context?`): `this`
|
|
432
|
-
|
|
433
|
-
Add a one-time listener for a given event.
|
|
434
|
-
|
|
435
|
-
#### Type Parameters
|
|
436
|
-
|
|
437
|
-
##### T
|
|
438
|
-
|
|
439
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
440
|
-
|
|
441
|
-
#### Parameters
|
|
442
|
-
|
|
443
|
-
##### event
|
|
444
|
-
|
|
445
|
-
`T`
|
|
446
|
-
|
|
447
|
-
##### fn
|
|
448
|
-
|
|
449
|
-
(...`args`) => `void`
|
|
450
|
-
|
|
451
|
-
##### context?
|
|
452
|
-
|
|
453
|
-
`any`
|
|
454
|
-
|
|
455
|
-
#### Returns
|
|
456
|
-
|
|
457
|
-
`this`
|
|
458
|
-
|
|
459
|
-
#### Implementation of
|
|
460
|
-
|
|
461
|
-
`WalletAdapter.once`
|
|
462
|
-
|
|
463
|
-
#### Inherited from
|
|
464
|
-
|
|
465
|
-
[`EventEmitter`](EventEmitter.md).[`once`](EventEmitter.md#once)
|
|
466
|
-
|
|
467
|
-
***
|
|
468
|
-
|
|
469
|
-
### removeAllListeners()
|
|
470
|
-
|
|
471
|
-
> **removeAllListeners**(`event?`): `this`
|
|
472
|
-
|
|
473
|
-
Remove all listeners, or those of the specified event.
|
|
474
|
-
|
|
475
|
-
#### Parameters
|
|
476
|
-
|
|
477
|
-
##### event?
|
|
478
|
-
|
|
479
|
-
keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
480
|
-
|
|
481
|
-
#### Returns
|
|
482
|
-
|
|
483
|
-
`this`
|
|
484
|
-
|
|
485
|
-
#### Implementation of
|
|
486
|
-
|
|
487
|
-
`WalletAdapter.removeAllListeners`
|
|
488
|
-
|
|
489
|
-
#### Inherited from
|
|
490
|
-
|
|
491
|
-
[`EventEmitter`](EventEmitter.md).[`removeAllListeners`](EventEmitter.md#removealllisteners)
|
|
492
|
-
|
|
493
|
-
***
|
|
494
|
-
|
|
495
|
-
### removeListener()
|
|
496
|
-
|
|
497
|
-
> **removeListener**\<`T`\>(`event`, `fn?`, `context?`, `once?`): `this`
|
|
498
|
-
|
|
499
|
-
Remove the listeners of a given event.
|
|
500
|
-
|
|
501
|
-
#### Type Parameters
|
|
502
|
-
|
|
503
|
-
##### T
|
|
504
|
-
|
|
505
|
-
`T` *extends* keyof [`WalletAdapterEvents`](../interfaces/WalletAdapterEvents.md)
|
|
506
|
-
|
|
507
|
-
#### Parameters
|
|
508
|
-
|
|
509
|
-
##### event
|
|
510
|
-
|
|
511
|
-
`T`
|
|
512
|
-
|
|
513
|
-
##### fn?
|
|
514
|
-
|
|
515
|
-
(...`args`) => `void`
|
|
516
|
-
|
|
517
|
-
##### context?
|
|
518
|
-
|
|
519
|
-
`any`
|
|
520
|
-
|
|
521
|
-
##### once?
|
|
522
|
-
|
|
523
|
-
`boolean`
|
|
524
|
-
|
|
525
|
-
#### Returns
|
|
526
|
-
|
|
527
|
-
`this`
|
|
528
|
-
|
|
529
|
-
#### Implementation of
|
|
530
|
-
|
|
531
|
-
`WalletAdapter.removeListener`
|
|
532
|
-
|
|
533
|
-
#### Inherited from
|
|
534
|
-
|
|
535
|
-
[`EventEmitter`](EventEmitter.md).[`removeListener`](EventEmitter.md#removelistener)
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@miden-sdk/miden-wallet-adapter-base](../README.md) / ConsumeTransaction
|
|
6
|
-
|
|
7
|
-
# Class: ConsumeTransaction
|
|
8
|
-
|
|
9
|
-
## Implements
|
|
10
|
-
|
|
11
|
-
- [`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md)
|
|
12
|
-
|
|
13
|
-
## Constructors
|
|
14
|
-
|
|
15
|
-
### Constructor
|
|
16
|
-
|
|
17
|
-
> **new ConsumeTransaction**(`faucetId`, `noteId`, `noteType`, `amount`, `noteBytes?`): `ConsumeTransaction`
|
|
18
|
-
|
|
19
|
-
#### Parameters
|
|
20
|
-
|
|
21
|
-
##### faucetId
|
|
22
|
-
|
|
23
|
-
`string`
|
|
24
|
-
|
|
25
|
-
##### noteId
|
|
26
|
-
|
|
27
|
-
`string`
|
|
28
|
-
|
|
29
|
-
##### noteType
|
|
30
|
-
|
|
31
|
-
[`NoteTypeString`](../type-aliases/NoteTypeString.md)
|
|
32
|
-
|
|
33
|
-
##### amount
|
|
34
|
-
|
|
35
|
-
`number`
|
|
36
|
-
|
|
37
|
-
##### noteBytes?
|
|
38
|
-
|
|
39
|
-
`Uint8Array`
|
|
40
|
-
|
|
41
|
-
#### Returns
|
|
42
|
-
|
|
43
|
-
`ConsumeTransaction`
|
|
44
|
-
|
|
45
|
-
## Properties
|
|
46
|
-
|
|
47
|
-
### amount
|
|
48
|
-
|
|
49
|
-
> **amount**: `number`
|
|
50
|
-
|
|
51
|
-
#### Implementation of
|
|
52
|
-
|
|
53
|
-
[`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md).[`amount`](../interfaces/MidenConsumeTransaction.md#amount)
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### faucetId
|
|
58
|
-
|
|
59
|
-
> **faucetId**: `string`
|
|
60
|
-
|
|
61
|
-
#### Implementation of
|
|
62
|
-
|
|
63
|
-
[`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md).[`faucetId`](../interfaces/MidenConsumeTransaction.md#faucetid)
|
|
64
|
-
|
|
65
|
-
***
|
|
66
|
-
|
|
67
|
-
### noteBytes?
|
|
68
|
-
|
|
69
|
-
> `optional` **noteBytes**: `string`
|
|
70
|
-
|
|
71
|
-
#### Implementation of
|
|
72
|
-
|
|
73
|
-
[`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md).[`noteBytes`](../interfaces/MidenConsumeTransaction.md#notebytes)
|
|
74
|
-
|
|
75
|
-
***
|
|
76
|
-
|
|
77
|
-
### noteId
|
|
78
|
-
|
|
79
|
-
> **noteId**: `string`
|
|
80
|
-
|
|
81
|
-
#### Implementation of
|
|
82
|
-
|
|
83
|
-
[`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md).[`noteId`](../interfaces/MidenConsumeTransaction.md#noteid)
|
|
84
|
-
|
|
85
|
-
***
|
|
86
|
-
|
|
87
|
-
### noteType
|
|
88
|
-
|
|
89
|
-
> **noteType**: [`NoteTypeString`](../type-aliases/NoteTypeString.md)
|
|
90
|
-
|
|
91
|
-
#### Implementation of
|
|
92
|
-
|
|
93
|
-
[`MidenConsumeTransaction`](../interfaces/MidenConsumeTransaction.md).[`noteType`](../interfaces/MidenConsumeTransaction.md#notetype)
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@miden-sdk/miden-wallet-adapter-base](../README.md) / CustomTransaction
|
|
6
|
-
|
|
7
|
-
# Class: CustomTransaction
|
|
8
|
-
|
|
9
|
-
## Implements
|
|
10
|
-
|
|
11
|
-
- [`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md)
|
|
12
|
-
|
|
13
|
-
## Constructors
|
|
14
|
-
|
|
15
|
-
### Constructor
|
|
16
|
-
|
|
17
|
-
> **new CustomTransaction**(`address`, `recipientAddress`, `transactionRequest`, `inputNotesIds?`, `inputNoteBytes?`): `CustomTransaction`
|
|
18
|
-
|
|
19
|
-
#### Parameters
|
|
20
|
-
|
|
21
|
-
##### address
|
|
22
|
-
|
|
23
|
-
`string`
|
|
24
|
-
|
|
25
|
-
##### recipientAddress
|
|
26
|
-
|
|
27
|
-
`string`
|
|
28
|
-
|
|
29
|
-
##### transactionRequest
|
|
30
|
-
|
|
31
|
-
`TransactionRequest`
|
|
32
|
-
|
|
33
|
-
##### inputNotesIds?
|
|
34
|
-
|
|
35
|
-
`string`[]
|
|
36
|
-
|
|
37
|
-
##### inputNoteBytes?
|
|
38
|
-
|
|
39
|
-
`Uint8Array`\<`ArrayBufferLike`\>[]
|
|
40
|
-
|
|
41
|
-
#### Returns
|
|
42
|
-
|
|
43
|
-
`CustomTransaction`
|
|
44
|
-
|
|
45
|
-
## Properties
|
|
46
|
-
|
|
47
|
-
### address
|
|
48
|
-
|
|
49
|
-
> **address**: `string`
|
|
50
|
-
|
|
51
|
-
#### Implementation of
|
|
52
|
-
|
|
53
|
-
[`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md).[`address`](../interfaces/MidenCustomTransaction.md#address)
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### importNotes?
|
|
58
|
-
|
|
59
|
-
> `optional` **importNotes**: `string`[]
|
|
60
|
-
|
|
61
|
-
#### Implementation of
|
|
62
|
-
|
|
63
|
-
[`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md).[`importNotes`](../interfaces/MidenCustomTransaction.md#importnotes)
|
|
64
|
-
|
|
65
|
-
***
|
|
66
|
-
|
|
67
|
-
### inputNoteIds?
|
|
68
|
-
|
|
69
|
-
> `optional` **inputNoteIds**: `string`[]
|
|
70
|
-
|
|
71
|
-
#### Implementation of
|
|
72
|
-
|
|
73
|
-
[`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md).[`inputNoteIds`](../interfaces/MidenCustomTransaction.md#inputnoteids)
|
|
74
|
-
|
|
75
|
-
***
|
|
76
|
-
|
|
77
|
-
### recipientAddress
|
|
78
|
-
|
|
79
|
-
> **recipientAddress**: `string`
|
|
80
|
-
|
|
81
|
-
#### Implementation of
|
|
82
|
-
|
|
83
|
-
[`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md).[`recipientAddress`](../interfaces/MidenCustomTransaction.md#recipientaddress)
|
|
84
|
-
|
|
85
|
-
***
|
|
86
|
-
|
|
87
|
-
### transactionRequest
|
|
88
|
-
|
|
89
|
-
> **transactionRequest**: `string`
|
|
90
|
-
|
|
91
|
-
#### Implementation of
|
|
92
|
-
|
|
93
|
-
[`MidenCustomTransaction`](../interfaces/MidenCustomTransaction.md).[`transactionRequest`](../interfaces/MidenCustomTransaction.md#transactionrequest)
|