@bsv/sdk 1.4.24 → 1.5.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/README.md +14 -0
- package/dist/cjs/package.json +1 -1
- package/dist/cjs/src/wallet/WalletClient.js +12 -2
- package/dist/cjs/src/wallet/WalletClient.js.map +1 -1
- package/dist/cjs/src/wallet/substrates/ReactNativeWebView.js +165 -0
- package/dist/cjs/src/wallet/substrates/ReactNativeWebView.js.map +1 -0
- package/dist/cjs/src/wallet/substrates/index.js +3 -1
- package/dist/cjs/src/wallet/substrates/index.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/wallet/WalletClient.js +12 -2
- package/dist/esm/src/wallet/WalletClient.js.map +1 -1
- package/dist/esm/src/wallet/substrates/ReactNativeWebView.js +137 -0
- package/dist/esm/src/wallet/substrates/ReactNativeWebView.js.map +1 -0
- package/dist/esm/src/wallet/substrates/index.js +1 -0
- package/dist/esm/src/wallet/substrates/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/wallet/WalletClient.d.ts.map +1 -1
- package/dist/types/src/wallet/substrates/ReactNativeWebView.d.ts +412 -0
- package/dist/types/src/wallet/substrates/ReactNativeWebView.d.ts.map +1 -0
- package/dist/types/src/wallet/substrates/index.d.ts +1 -0
- package/dist/types/src/wallet/substrates/index.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +1 -1
- package/docs/auth.md +47 -101
- package/docs/compat.md +24 -48
- package/docs/identity.md +8 -14
- package/docs/kvstore.md +3 -9
- package/docs/messages.md +4 -4
- package/docs/overlay-tools.md +21 -69
- package/docs/primitives.md +235 -379
- package/docs/registry.md +14 -20
- package/docs/script.md +32 -80
- package/docs/storage.md +11 -17
- package/docs/totp.md +5 -11
- package/docs/transaction.md +66 -144
- package/docs/wallet.md +586 -183
- package/package.json +1 -1
- package/src/wallet/WalletClient.ts +13 -4
- package/src/wallet/substrates/ReactNativeWebView.ts +560 -0
- package/src/wallet/substrates/index.ts +1 -0
package/docs/auth.md
CHANGED
|
@@ -33,7 +33,7 @@ export interface AuthMessage {
|
|
|
33
33
|
}
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset), [VerifiableCertificate](#class-verifiablecertificate)
|
|
36
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate)
|
|
37
37
|
|
|
38
38
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
39
39
|
|
|
@@ -62,7 +62,7 @@ export interface RequestedCertificateSet {
|
|
|
62
62
|
}
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
See also: [RequestedCertificateTypeIDAndFieldList](#interface-requestedcertificatetypeidandfieldlist)
|
|
65
|
+
See also: [RequestedCertificateTypeIDAndFieldList](./auth.md#interface-requestedcertificatetypeidandfieldlist)
|
|
66
66
|
|
|
67
67
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
68
68
|
|
|
@@ -87,7 +87,7 @@ export interface Transport {
|
|
|
87
87
|
}
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
See also: [AuthMessage](#interface-authmessage)
|
|
90
|
+
See also: [AuthMessage](./auth.md#interface-authmessage)
|
|
91
91
|
|
|
92
92
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
93
93
|
|
|
@@ -128,11 +128,7 @@ export class AuthFetch {
|
|
|
128
128
|
}
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset), [SessionManager](#class-sessionmanager), [VerifiableCertificate](#class-verifiablecertificate), [WalletInterface](#interface-walletinterface)
|
|
132
|
-
|
|
133
|
-
<details>
|
|
134
|
-
|
|
135
|
-
<summary>Class AuthFetch Details</summary>
|
|
131
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
136
132
|
|
|
137
133
|
#### Constructor
|
|
138
134
|
|
|
@@ -141,7 +137,7 @@ Constructs a new AuthFetch instance.
|
|
|
141
137
|
```ts
|
|
142
138
|
constructor(wallet: WalletInterface, requestedCertificates?: RequestedCertificateSet, sessionManager?: SessionManager)
|
|
143
139
|
```
|
|
144
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset), [SessionManager](#class-sessionmanager), [WalletInterface](#interface-walletinterface)
|
|
140
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
145
141
|
|
|
146
142
|
Argument Details
|
|
147
143
|
|
|
@@ -157,7 +153,7 @@ Return any certificates we've collected thus far, then clear them out.
|
|
|
157
153
|
```ts
|
|
158
154
|
public consumeReceivedCertificates(): VerifiableCertificate[]
|
|
159
155
|
```
|
|
160
|
-
See also: [VerifiableCertificate](#class-verifiablecertificate)
|
|
156
|
+
See also: [VerifiableCertificate](./auth.md#class-verifiablecertificate)
|
|
161
157
|
|
|
162
158
|
#### Method fetch
|
|
163
159
|
|
|
@@ -193,9 +189,7 @@ Request Certificates from a Peer
|
|
|
193
189
|
```ts
|
|
194
190
|
async sendCertificateRequest(baseUrl: string, certificatesToRequest: RequestedCertificateSet): Promise<VerifiableCertificate[]>
|
|
195
191
|
```
|
|
196
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset), [VerifiableCertificate](#class-verifiablecertificate)
|
|
197
|
-
|
|
198
|
-
</details>
|
|
192
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate)
|
|
199
193
|
|
|
200
194
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
201
195
|
|
|
@@ -227,11 +221,7 @@ export default class Certificate {
|
|
|
227
221
|
}
|
|
228
222
|
```
|
|
229
223
|
|
|
230
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [ProtoWallet](#class-protowallet), [PubKeyHex](#type-pubkeyhex), [WalletProtocol](#type-walletprotocol), [sign](#variable-sign), [verify](#variable-verify)
|
|
231
|
-
|
|
232
|
-
<details>
|
|
233
|
-
|
|
234
|
-
<summary>Class Certificate Details</summary>
|
|
224
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletProtocol](./wallet.md#type-walletprotocol), [sign](./compat.md#variable-sign), [verify](./compat.md#variable-verify)
|
|
235
225
|
|
|
236
226
|
#### Constructor
|
|
237
227
|
|
|
@@ -240,7 +230,7 @@ Constructs a new Certificate.
|
|
|
240
230
|
```ts
|
|
241
231
|
constructor(type: Base64String, serialNumber: Base64String, subject: PubKeyHex, certifier: PubKeyHex, revocationOutpoint: OutpointString, fields: Record<CertificateFieldNameUnder50Bytes, string>, signature?: HexString)
|
|
242
232
|
```
|
|
243
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
|
|
233
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
244
234
|
|
|
245
235
|
Argument Details
|
|
246
236
|
|
|
@@ -266,7 +256,7 @@ Public key of the certifier who issued the certificate, compressed public key he
|
|
|
266
256
|
```ts
|
|
267
257
|
certifier: PubKeyHex
|
|
268
258
|
```
|
|
269
|
-
See also: [PubKeyHex](#type-pubkeyhex)
|
|
259
|
+
See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
270
260
|
|
|
271
261
|
#### Property fields
|
|
272
262
|
|
|
@@ -275,7 +265,7 @@ All the fields present in the certificate, with field names as keys and encrypte
|
|
|
275
265
|
```ts
|
|
276
266
|
fields: Record<CertificateFieldNameUnder50Bytes, Base64String>
|
|
277
267
|
```
|
|
278
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes)
|
|
268
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes)
|
|
279
269
|
|
|
280
270
|
#### Property revocationOutpoint
|
|
281
271
|
|
|
@@ -284,7 +274,7 @@ The outpoint used to confirm that the certificate has not been revoked (TXID.Out
|
|
|
284
274
|
```ts
|
|
285
275
|
revocationOutpoint: OutpointString
|
|
286
276
|
```
|
|
287
|
-
See also: [OutpointString](#type-outpointstring)
|
|
277
|
+
See also: [OutpointString](./wallet.md#type-outpointstring)
|
|
288
278
|
|
|
289
279
|
#### Property serialNumber
|
|
290
280
|
|
|
@@ -293,7 +283,7 @@ Unique serial number of the certificate, base64 encoded string, 32 bytes.
|
|
|
293
283
|
```ts
|
|
294
284
|
serialNumber: Base64String
|
|
295
285
|
```
|
|
296
|
-
See also: [Base64String](#type-base64string)
|
|
286
|
+
See also: [Base64String](./wallet.md#type-base64string)
|
|
297
287
|
|
|
298
288
|
#### Property signature
|
|
299
289
|
|
|
@@ -302,7 +292,7 @@ Certificate signature by the certifier's private key, DER encoded hex string.
|
|
|
302
292
|
```ts
|
|
303
293
|
signature?: HexString
|
|
304
294
|
```
|
|
305
|
-
See also: [HexString](#type-hexstring)
|
|
295
|
+
See also: [HexString](./wallet.md#type-hexstring)
|
|
306
296
|
|
|
307
297
|
#### Property subject
|
|
308
298
|
|
|
@@ -311,7 +301,7 @@ The public key belonging to the certificate's subject, compressed public key hex
|
|
|
311
301
|
```ts
|
|
312
302
|
subject: PubKeyHex
|
|
313
303
|
```
|
|
314
|
-
See also: [PubKeyHex](#type-pubkeyhex)
|
|
304
|
+
See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
315
305
|
|
|
316
306
|
#### Property type
|
|
317
307
|
|
|
@@ -320,7 +310,7 @@ Type identifier for the certificate, base64 encoded string, 32 bytes.
|
|
|
320
310
|
```ts
|
|
321
311
|
type: Base64String
|
|
322
312
|
```
|
|
323
|
-
See also: [Base64String](#type-base64string)
|
|
313
|
+
See also: [Base64String](./wallet.md#type-base64string)
|
|
324
314
|
|
|
325
315
|
#### Method fromBinary
|
|
326
316
|
|
|
@@ -329,7 +319,7 @@ Deserializes a certificate from binary format.
|
|
|
329
319
|
```ts
|
|
330
320
|
static fromBinary(bin: number[]): Certificate
|
|
331
321
|
```
|
|
332
|
-
See also: [Certificate](#class-certificate)
|
|
322
|
+
See also: [Certificate](./auth.md#class-certificate)
|
|
333
323
|
|
|
334
324
|
Returns
|
|
335
325
|
|
|
@@ -356,7 +346,7 @@ static getCertificateFieldEncryptionDetails(fieldName: string, serialNumber?: st
|
|
|
356
346
|
keyID: string;
|
|
357
347
|
}
|
|
358
348
|
```
|
|
359
|
-
See also: [WalletProtocol](#type-walletprotocol)
|
|
349
|
+
See also: [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
360
350
|
|
|
361
351
|
Returns
|
|
362
352
|
|
|
@@ -379,7 +369,7 @@ Signs the certificate using the provided certifier wallet.
|
|
|
379
369
|
```ts
|
|
380
370
|
async sign(certifierWallet: ProtoWallet): Promise<void>
|
|
381
371
|
```
|
|
382
|
-
See also: [ProtoWallet](#class-protowallet)
|
|
372
|
+
See also: [ProtoWallet](./wallet.md#class-protowallet)
|
|
383
373
|
|
|
384
374
|
Argument Details
|
|
385
375
|
|
|
@@ -415,8 +405,6 @@ Returns
|
|
|
415
405
|
|
|
416
406
|
- A promise that resolves to true if the signature is valid.
|
|
417
407
|
|
|
418
|
-
</details>
|
|
419
|
-
|
|
420
408
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
421
409
|
|
|
422
410
|
---
|
|
@@ -451,7 +439,7 @@ export class CompletedProtoWallet extends ProtoWallet implements WalletInterface
|
|
|
451
439
|
}
|
|
452
440
|
```
|
|
453
441
|
|
|
454
|
-
See also: [AbortActionResult](#interface-abortactionresult), [AcquireCertificateResult](#type-acquirecertificateresult), [AuthenticatedResult](#interface-authenticatedresult), [CreateActionResult](#interface-createactionresult), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [GetHeaderResult](#interface-getheaderresult), [GetHeightResult](#interface-getheightresult), [GetNetworkResult](#interface-getnetworkresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [GetVersionResult](#interface-getversionresult), [InternalizeActionResult](#interface-internalizeactionresult), [KeyDeriver](#class-keyderiver), [KeyDeriverApi](#interface-keyderiverapi), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsResult](#interface-listoutputsresult), [PrivateKey](#class-privatekey), [ProtoWallet](#class-protowallet), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [RelinquishCertificateResult](#interface-relinquishcertificateresult), [RelinquishOutputResult](#interface-relinquishoutputresult), [SignActionResult](#interface-signactionresult), [WalletInterface](#interface-walletinterface)
|
|
442
|
+
See also: [AbortActionResult](./wallet.md#interface-abortactionresult), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [CreateActionResult](./wallet.md#interface-createactionresult), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [GetHeaderResult](./wallet.md#interface-getheaderresult), [GetHeightResult](./wallet.md#interface-getheightresult), [GetNetworkResult](./wallet.md#interface-getnetworkresult), [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [GetVersionResult](./wallet.md#interface-getversionresult), [InternalizeActionResult](./wallet.md#interface-internalizeactionresult), [KeyDeriver](./wallet.md#class-keyderiver), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [PrivateKey](./primitives.md#class-privatekey), [ProtoWallet](./wallet.md#class-protowallet), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [RelinquishCertificateResult](./wallet.md#interface-relinquishcertificateresult), [RelinquishOutputResult](./wallet.md#interface-relinquishoutputresult), [SignActionResult](./wallet.md#interface-signactionresult), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
455
443
|
|
|
456
444
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
457
445
|
|
|
@@ -489,11 +477,7 @@ export class MasterCertificate extends Certificate {
|
|
|
489
477
|
}
|
|
490
478
|
```
|
|
491
479
|
|
|
492
|
-
See also: [Base64String](#type-base64string), [Certificate](#class-certificate), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [ProtoWallet](#class-protowallet), [PubKeyHex](#type-pubkeyhex), [WalletCounterparty](#type-walletcounterparty)
|
|
493
|
-
|
|
494
|
-
<details>
|
|
495
|
-
|
|
496
|
-
<summary>Class MasterCertificate Details</summary>
|
|
480
|
+
See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCounterparty](./wallet.md#type-walletcounterparty)
|
|
497
481
|
|
|
498
482
|
#### Method createCertificateFields
|
|
499
483
|
|
|
@@ -504,7 +488,7 @@ and sign off on the fields, along with the encrypted certificate fields.
|
|
|
504
488
|
```ts
|
|
505
489
|
static async createCertificateFields(creatorWallet: ProtoWallet, certifierOrSubject: WalletCounterparty, fields: Record<CertificateFieldNameUnder50Bytes, string>, privileged?: boolean, privilegedReason?: string): Promise<CreateCertificateFieldsResult>
|
|
506
490
|
```
|
|
507
|
-
See also: [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [ProtoWallet](#class-protowallet), [WalletCounterparty](#type-walletcounterparty)
|
|
491
|
+
See also: [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [ProtoWallet](./wallet.md#class-protowallet), [WalletCounterparty](./wallet.md#type-walletcounterparty)
|
|
508
492
|
|
|
509
493
|
Returns
|
|
510
494
|
|
|
@@ -537,7 +521,7 @@ for the verifier to access the designated fields.
|
|
|
537
521
|
```ts
|
|
538
522
|
static async createKeyringForVerifier(subjectWallet: ProtoWallet, certifier: WalletCounterparty, verifier: WalletCounterparty, fields: Record<CertificateFieldNameUnder50Bytes, Base64String>, fieldsToReveal: string[], masterKeyring: Record<CertificateFieldNameUnder50Bytes, Base64String>, serialNumber: Base64String, privileged?: boolean, privilegedReason?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
|
|
539
523
|
```
|
|
540
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [ProtoWallet](#class-protowallet), [WalletCounterparty](#type-walletcounterparty)
|
|
524
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [ProtoWallet](./wallet.md#class-protowallet), [WalletCounterparty](./wallet.md#type-walletcounterparty)
|
|
541
525
|
|
|
542
526
|
Returns
|
|
543
527
|
|
|
@@ -578,7 +562,7 @@ The counterparty used for decryption depends on how the certificate fields were
|
|
|
578
562
|
```ts
|
|
579
563
|
static async decryptFields(subjectOrCertifierWallet: ProtoWallet, masterKeyring: Record<CertificateFieldNameUnder50Bytes, Base64String>, fields: Record<CertificateFieldNameUnder50Bytes, Base64String>, counterparty: WalletCounterparty, privileged?: boolean, privilegedReason?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
|
|
580
564
|
```
|
|
581
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [ProtoWallet](#class-protowallet), [WalletCounterparty](#type-walletcounterparty)
|
|
565
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [ProtoWallet](./wallet.md#class-protowallet), [WalletCounterparty](./wallet.md#type-walletcounterparty)
|
|
582
566
|
|
|
583
567
|
Returns
|
|
584
568
|
|
|
@@ -618,7 +602,7 @@ static async issueCertificateForSubject(certifierWallet: ProtoWallet, subject: W
|
|
|
618
602
|
return "Certificate revocation not tracked.";
|
|
619
603
|
}, serialNumber?: string): Promise<MasterCertificate>
|
|
620
604
|
```
|
|
621
|
-
See also: [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [MasterCertificate](#class-mastercertificate), [ProtoWallet](#class-protowallet), [WalletCounterparty](#type-walletcounterparty)
|
|
605
|
+
See also: [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [MasterCertificate](./auth.md#class-mastercertificate), [ProtoWallet](./wallet.md#class-protowallet), [WalletCounterparty](./wallet.md#type-walletcounterparty)
|
|
622
606
|
|
|
623
607
|
Returns
|
|
624
608
|
|
|
@@ -644,8 +628,6 @@ Throws
|
|
|
644
628
|
|
|
645
629
|
Throws an error if any operation (e.g., encryption, signing) fails during certificate issuance.
|
|
646
630
|
|
|
647
|
-
</details>
|
|
648
|
-
|
|
649
631
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
650
632
|
|
|
651
633
|
---
|
|
@@ -675,11 +657,7 @@ export class Peer {
|
|
|
675
657
|
}
|
|
676
658
|
```
|
|
677
659
|
|
|
678
|
-
See also: [PeerSession](#interface-peersession), [RequestedCertificateSet](#interface-requestedcertificateset), [SessionManager](#class-sessionmanager), [Transport](#interface-transport), [VerifiableCertificate](#class-verifiablecertificate), [WalletInterface](#interface-walletinterface)
|
|
679
|
-
|
|
680
|
-
<details>
|
|
681
|
-
|
|
682
|
-
<summary>Class Peer Details</summary>
|
|
660
|
+
See also: [PeerSession](./auth.md#interface-peersession), [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [Transport](./auth.md#interface-transport), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
683
661
|
|
|
684
662
|
#### Constructor
|
|
685
663
|
|
|
@@ -688,7 +666,7 @@ Creates a new Peer instance
|
|
|
688
666
|
```ts
|
|
689
667
|
constructor(wallet: WalletInterface, transport: Transport, certificatesToRequest?: RequestedCertificateSet, sessionManager?: SessionManager, autoPersistLastSession?: boolean)
|
|
690
668
|
```
|
|
691
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset), [SessionManager](#class-sessionmanager), [Transport](#interface-transport), [WalletInterface](#interface-walletinterface)
|
|
669
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [Transport](./auth.md#interface-transport), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
692
670
|
|
|
693
671
|
Argument Details
|
|
694
672
|
|
|
@@ -715,7 +693,7 @@ or the session is not authenticated, initiates a handshake to create or authenti
|
|
|
715
693
|
```ts
|
|
716
694
|
async getAuthenticatedSession(identityKey?: string, maxWaitTime?: number): Promise<PeerSession>
|
|
717
695
|
```
|
|
718
|
-
See also: [PeerSession](#interface-peersession)
|
|
696
|
+
See also: [PeerSession](./auth.md#interface-peersession)
|
|
719
697
|
|
|
720
698
|
Returns
|
|
721
699
|
|
|
@@ -735,7 +713,7 @@ Registers a callback to listen for certificates received from peers.
|
|
|
735
713
|
```ts
|
|
736
714
|
listenForCertificatesReceived(callback: (senderPublicKey: string, certs: VerifiableCertificate[]) => void): number
|
|
737
715
|
```
|
|
738
|
-
See also: [VerifiableCertificate](#class-verifiablecertificate)
|
|
716
|
+
See also: [VerifiableCertificate](./auth.md#class-verifiablecertificate)
|
|
739
717
|
|
|
740
718
|
Returns
|
|
741
719
|
|
|
@@ -753,7 +731,7 @@ Registers a callback to listen for certificates requested from peers.
|
|
|
753
731
|
```ts
|
|
754
732
|
listenForCertificatesRequested(callback: (senderPublicKey: string, requestedCertificates: RequestedCertificateSet) => void): number
|
|
755
733
|
```
|
|
756
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset)
|
|
734
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset)
|
|
757
735
|
|
|
758
736
|
Returns
|
|
759
737
|
|
|
@@ -790,7 +768,7 @@ an initial handshake or message has been exchanged.
|
|
|
790
768
|
```ts
|
|
791
769
|
async requestCertificates(certificatesToRequest: RequestedCertificateSet, identityKey?: string, maxWaitTime = 10000): Promise<void>
|
|
792
770
|
```
|
|
793
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset)
|
|
771
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset)
|
|
794
772
|
|
|
795
773
|
Returns
|
|
796
774
|
|
|
@@ -816,7 +794,7 @@ Sends a certificate response message containing the specified certificates to a
|
|
|
816
794
|
```ts
|
|
817
795
|
async sendCertificateResponse(verifierIdentityKey: string, certificates: VerifiableCertificate[]): Promise<void>
|
|
818
796
|
```
|
|
819
|
-
See also: [VerifiableCertificate](#class-verifiablecertificate)
|
|
797
|
+
See also: [VerifiableCertificate](./auth.md#class-verifiablecertificate)
|
|
820
798
|
|
|
821
799
|
Argument Details
|
|
822
800
|
|
|
@@ -889,8 +867,6 @@ Throws
|
|
|
889
867
|
|
|
890
868
|
Will throw an error if the message fails to send.
|
|
891
869
|
|
|
892
|
-
</details>
|
|
893
|
-
|
|
894
870
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
895
871
|
|
|
896
872
|
---
|
|
@@ -910,11 +886,7 @@ export class SessionManager {
|
|
|
910
886
|
}
|
|
911
887
|
```
|
|
912
888
|
|
|
913
|
-
See also: [PeerSession](#interface-peersession)
|
|
914
|
-
|
|
915
|
-
<details>
|
|
916
|
-
|
|
917
|
-
<summary>Class SessionManager Details</summary>
|
|
889
|
+
See also: [PeerSession](./auth.md#interface-peersession)
|
|
918
890
|
|
|
919
891
|
#### Method addSession
|
|
920
892
|
|
|
@@ -927,7 +899,7 @@ allowing multiple concurrent sessions for the same peer.
|
|
|
927
899
|
```ts
|
|
928
900
|
addSession(session: PeerSession): void
|
|
929
901
|
```
|
|
930
|
-
See also: [PeerSession](#interface-peersession)
|
|
902
|
+
See also: [PeerSession](./auth.md#interface-peersession)
|
|
931
903
|
|
|
932
904
|
Argument Details
|
|
933
905
|
|
|
@@ -947,7 +919,7 @@ authenticated) session associated with that peer, if any.
|
|
|
947
919
|
```ts
|
|
948
920
|
getSession(identifier: string): PeerSession | undefined
|
|
949
921
|
```
|
|
950
|
-
See also: [PeerSession](#interface-peersession)
|
|
922
|
+
See also: [PeerSession](./auth.md#interface-peersession)
|
|
951
923
|
|
|
952
924
|
Returns
|
|
953
925
|
|
|
@@ -982,7 +954,7 @@ Removes a session from the manager by clearing all associated identifiers.
|
|
|
982
954
|
```ts
|
|
983
955
|
removeSession(session: PeerSession): void
|
|
984
956
|
```
|
|
985
|
-
See also: [PeerSession](#interface-peersession)
|
|
957
|
+
See also: [PeerSession](./auth.md#interface-peersession)
|
|
986
958
|
|
|
987
959
|
Argument Details
|
|
988
960
|
|
|
@@ -997,15 +969,13 @@ ensuring we record the latest data (e.g., isAuthenticated, lastUpdate, etc.).
|
|
|
997
969
|
```ts
|
|
998
970
|
updateSession(session: PeerSession): void
|
|
999
971
|
```
|
|
1000
|
-
See also: [PeerSession](#interface-peersession)
|
|
972
|
+
See also: [PeerSession](./auth.md#interface-peersession)
|
|
1001
973
|
|
|
1002
974
|
Argument Details
|
|
1003
975
|
|
|
1004
976
|
+ **session**
|
|
1005
977
|
+ The peer session to update.
|
|
1006
978
|
|
|
1007
|
-
</details>
|
|
1008
|
-
|
|
1009
979
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1010
980
|
|
|
1011
981
|
---
|
|
@@ -1031,11 +1001,7 @@ export class SimplifiedFetchTransport implements Transport {
|
|
|
1031
1001
|
}
|
|
1032
1002
|
```
|
|
1033
1003
|
|
|
1034
|
-
See also: [AuthMessage](#interface-authmessage), [Transport](#interface-transport)
|
|
1035
|
-
|
|
1036
|
-
<details>
|
|
1037
|
-
|
|
1038
|
-
<summary>Class SimplifiedFetchTransport Details</summary>
|
|
1004
|
+
See also: [AuthMessage](./auth.md#interface-authmessage), [Transport](./auth.md#interface-transport)
|
|
1039
1005
|
|
|
1040
1006
|
#### Constructor
|
|
1041
1007
|
|
|
@@ -1084,7 +1050,7 @@ This must be called before sending any messages to ensure responses can be proce
|
|
|
1084
1050
|
```ts
|
|
1085
1051
|
async onData(callback: (message: AuthMessage) => Promise<void>): Promise<void>
|
|
1086
1052
|
```
|
|
1087
|
-
See also: [AuthMessage](#interface-authmessage)
|
|
1053
|
+
See also: [AuthMessage](./auth.md#interface-authmessage)
|
|
1088
1054
|
|
|
1089
1055
|
Returns
|
|
1090
1056
|
|
|
@@ -1105,7 +1071,7 @@ the message is sent as a POST request to the `/auth` endpoint.
|
|
|
1105
1071
|
```ts
|
|
1106
1072
|
async send(message: AuthMessage): Promise<void>
|
|
1107
1073
|
```
|
|
1108
|
-
See also: [AuthMessage](#interface-authmessage)
|
|
1074
|
+
See also: [AuthMessage](./auth.md#interface-authmessage)
|
|
1109
1075
|
|
|
1110
1076
|
Returns
|
|
1111
1077
|
|
|
@@ -1120,8 +1086,6 @@ Throws
|
|
|
1120
1086
|
|
|
1121
1087
|
Will throw an error if no listener has been registered via `onData`.
|
|
1122
1088
|
|
|
1123
|
-
</details>
|
|
1124
|
-
|
|
1125
1089
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1126
1090
|
|
|
1127
1091
|
---
|
|
@@ -1147,11 +1111,7 @@ export class VerifiableCertificate extends Certificate {
|
|
|
1147
1111
|
}
|
|
1148
1112
|
```
|
|
1149
1113
|
|
|
1150
|
-
See also: [Base64String](#type-base64string), [Certificate](#class-certificate), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [ProtoWallet](#class-protowallet), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
1151
|
-
|
|
1152
|
-
<details>
|
|
1153
|
-
|
|
1154
|
-
<summary>Class VerifiableCertificate Details</summary>
|
|
1114
|
+
See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
1155
1115
|
|
|
1156
1116
|
#### Method decryptFields
|
|
1157
1117
|
|
|
@@ -1160,7 +1120,7 @@ Decrypts selectively revealed certificate fields using the provided keyring and
|
|
|
1160
1120
|
```ts
|
|
1161
1121
|
async decryptFields(verifierWallet: ProtoWallet, privileged?: boolean, privilegedReason?: string): Promise<Record<CertificateFieldNameUnder50Bytes, string>>
|
|
1162
1122
|
```
|
|
1163
|
-
See also: [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [ProtoWallet](#class-protowallet)
|
|
1123
|
+
See also: [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [ProtoWallet](./wallet.md#class-protowallet)
|
|
1164
1124
|
|
|
1165
1125
|
Returns
|
|
1166
1126
|
|
|
@@ -1184,7 +1144,7 @@ Throws an error if any of the decryption operations fail, with a message indicat
|
|
|
1184
1144
|
```ts
|
|
1185
1145
|
static fromCertificate(certificate: WalletCertificate, keyring: Record<CertificateFieldNameUnder50Bytes, string>): VerifiableCertificate
|
|
1186
1146
|
```
|
|
1187
|
-
See also: [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [VerifiableCertificate](#class-verifiablecertificate), [WalletCertificate](#interface-walletcertificate)
|
|
1147
|
+
See also: [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
1188
1148
|
|
|
1189
1149
|
Returns
|
|
1190
1150
|
|
|
@@ -1198,8 +1158,6 @@ Argument Details
|
|
|
1198
1158
|
+ **keyring**
|
|
1199
1159
|
+ – A allows the verifier to decrypt selected certificate fields.
|
|
1200
1160
|
|
|
1201
|
-
</details>
|
|
1202
|
-
|
|
1203
1161
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1204
1162
|
|
|
1205
1163
|
---
|
|
@@ -1222,11 +1180,7 @@ Creates a nonce derived from a wallet
|
|
|
1222
1180
|
export async function createNonce(wallet: WalletInterface, counterparty: WalletCounterparty = "self"): Promise<Base64String>
|
|
1223
1181
|
```
|
|
1224
1182
|
|
|
1225
|
-
See also: [Base64String](#type-base64string), [WalletCounterparty](#type-walletcounterparty), [WalletInterface](#interface-walletinterface)
|
|
1226
|
-
|
|
1227
|
-
<details>
|
|
1228
|
-
|
|
1229
|
-
<summary>Function createNonce Details</summary>
|
|
1183
|
+
See also: [Base64String](./wallet.md#type-base64string), [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
1230
1184
|
|
|
1231
1185
|
Returns
|
|
1232
1186
|
|
|
@@ -1237,8 +1191,6 @@ Argument Details
|
|
|
1237
1191
|
+ **counterparty**
|
|
1238
1192
|
+ The counterparty to the nonce creation. Defaults to 'self'.
|
|
1239
1193
|
|
|
1240
|
-
</details>
|
|
1241
|
-
|
|
1242
1194
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1243
1195
|
|
|
1244
1196
|
---
|
|
@@ -1250,11 +1202,7 @@ Verifies a nonce derived from a wallet
|
|
|
1250
1202
|
export async function verifyNonce(nonce: Base64String, wallet: WalletInterface, counterparty: WalletCounterparty = "self"): Promise<boolean>
|
|
1251
1203
|
```
|
|
1252
1204
|
|
|
1253
|
-
See also: [Base64String](#type-base64string), [WalletCounterparty](#type-walletcounterparty), [WalletInterface](#interface-walletinterface)
|
|
1254
|
-
|
|
1255
|
-
<details>
|
|
1256
|
-
|
|
1257
|
-
<summary>Function verifyNonce Details</summary>
|
|
1205
|
+
See also: [Base64String](./wallet.md#type-base64string), [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
1258
1206
|
|
|
1259
1207
|
Returns
|
|
1260
1208
|
|
|
@@ -1267,8 +1215,6 @@ Argument Details
|
|
|
1267
1215
|
+ **counterparty**
|
|
1268
1216
|
+ The counterparty to the nonce creation. Defaults to 'self'.
|
|
1269
1217
|
|
|
1270
|
-
</details>
|
|
1271
|
-
|
|
1272
1218
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1273
1219
|
|
|
1274
1220
|
---
|
|
@@ -1306,7 +1252,7 @@ getVerifiableCertificates = async (wallet: WalletInterface, requestedCertificate
|
|
|
1306
1252
|
}
|
|
1307
1253
|
```
|
|
1308
1254
|
|
|
1309
|
-
See also: [RequestedCertificateSet](#interface-requestedcertificateset), [VerifiableCertificate](#class-verifiablecertificate), [WalletInterface](#interface-walletinterface)
|
|
1255
|
+
See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
|
|
1310
1256
|
|
|
1311
1257
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1312
1258
|
|
|
@@ -1342,7 +1288,7 @@ validateCertificates = async (verifierWallet: WalletInterface, message: AuthMess
|
|
|
1342
1288
|
}
|
|
1343
1289
|
```
|
|
1344
1290
|
|
|
1345
|
-
See also: [AuthMessage](#interface-authmessage), [Certificate](#class-certificate), [RequestedCertificateSet](#interface-requestedcertificateset), [VerifiableCertificate](#class-verifiablecertificate), [WalletInterface](#interface-walletinterface), [verify](#variable-verify)
|
|
1291
|
+
See also: [AuthMessage](./auth.md#interface-authmessage), [Certificate](./auth.md#class-certificate), [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface), [verify](./compat.md#variable-verify)
|
|
1346
1292
|
|
|
1347
1293
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1348
1294
|
|