@bsv/sdk 1.8.2 → 1.8.4
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/cjs/package.json +1 -1
- package/dist/cjs/src/overlay-tools/LookupResolver.js +10 -1
- package/dist/cjs/src/overlay-tools/LookupResolver.js.map +1 -1
- package/dist/cjs/src/primitives/Random.js +78 -19
- package/dist/cjs/src/primitives/Random.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/overlay-tools/LookupResolver.js +10 -1
- package/dist/esm/src/overlay-tools/LookupResolver.js.map +1 -1
- package/dist/esm/src/primitives/Random.js +78 -19
- package/dist/esm/src/primitives/Random.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/overlay-tools/LookupResolver.d.ts +1 -0
- package/dist/types/src/overlay-tools/LookupResolver.d.ts.map +1 -1
- package/dist/types/src/primitives/Random.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +3 -3
- package/dist/umd/bundle.js.map +1 -1
- package/docs/reference/compat.md +27 -15
- package/docs/reference/identity.md +16 -12
- package/docs/reference/kvstore.md +25 -7
- package/docs/reference/messages.md +8 -0
- package/docs/reference/overlay-tools.md +22 -15
- package/docs/reference/primitives.md +168 -168
- package/docs/reference/registry.md +19 -9
- package/docs/reference/script.md +32 -31
- package/docs/reference/storage.md +14 -10
- package/docs/reference/totp.md +5 -5
- package/docs/reference/transaction.md +70 -67
- package/docs/reference/wallet.md +135 -131
- package/package.json +1 -1
- package/src/overlay-tools/LookupResolver.ts +11 -1
- package/src/primitives/Random.ts +86 -17
- package/src/primitives/__tests/Random.test.ts +21 -0
|
@@ -104,7 +104,7 @@ export interface LookupResolverConfig {
|
|
|
104
104
|
}
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
-
See also: [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
|
|
107
|
+
See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
|
|
108
108
|
|
|
109
109
|
#### Property additionalHosts
|
|
110
110
|
|
|
@@ -129,7 +129,7 @@ The facilitator used to make requests to Overlay Services hosts.
|
|
|
129
129
|
```ts
|
|
130
130
|
facilitator?: OverlayLookupFacilitator
|
|
131
131
|
```
|
|
132
|
-
See also: [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
|
|
132
|
+
See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
|
|
133
133
|
|
|
134
134
|
#### Property hostOverrides
|
|
135
135
|
|
|
@@ -171,7 +171,7 @@ export interface OverlayBroadcastFacilitator {
|
|
|
171
171
|
}
|
|
172
172
|
```
|
|
173
173
|
|
|
174
|
-
See also: [STEAK](#type-steak), [TaggedBEEF](#interface-taggedbeef)
|
|
174
|
+
See also: [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
|
|
175
175
|
|
|
176
176
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
177
177
|
|
|
@@ -186,7 +186,7 @@ export interface OverlayLookupFacilitator {
|
|
|
186
186
|
}
|
|
187
187
|
```
|
|
188
188
|
|
|
189
|
-
See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
|
|
189
|
+
See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
|
|
190
190
|
|
|
191
191
|
#### Property lookup
|
|
192
192
|
|
|
@@ -195,7 +195,7 @@ Returns a lookup answer for a lookup question
|
|
|
195
195
|
```ts
|
|
196
196
|
lookup: (url: string, question: LookupQuestion, timeout?: number) => Promise<LookupAnswer>
|
|
197
197
|
```
|
|
198
|
-
See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
|
|
198
|
+
See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
|
|
199
199
|
|
|
200
200
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
201
201
|
|
|
@@ -215,7 +215,7 @@ export interface SHIPBroadcasterConfig {
|
|
|
215
215
|
}
|
|
216
216
|
```
|
|
217
217
|
|
|
218
|
-
See also: [LookupResolver](#class-lookupresolver), [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator)
|
|
218
|
+
See also: [LookupResolver](./overlay-tools.md#class-lookupresolver), [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
|
|
219
219
|
|
|
220
220
|
#### Property facilitator
|
|
221
221
|
|
|
@@ -224,7 +224,7 @@ The facilitator used to make requests to Overlay Services hosts.
|
|
|
224
224
|
```ts
|
|
225
225
|
facilitator?: OverlayBroadcastFacilitator
|
|
226
226
|
```
|
|
227
|
-
See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator)
|
|
227
|
+
See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
|
|
228
228
|
|
|
229
229
|
#### Property networkPreset
|
|
230
230
|
|
|
@@ -268,7 +268,7 @@ The resolver used to locate suitable hosts with SHIP
|
|
|
268
268
|
```ts
|
|
269
269
|
resolver?: LookupResolver
|
|
270
270
|
```
|
|
271
|
-
See also: [LookupResolver](#class-lookupresolver)
|
|
271
|
+
See also: [LookupResolver](./overlay-tools.md#class-lookupresolver)
|
|
272
272
|
|
|
273
273
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
274
274
|
|
|
@@ -313,7 +313,7 @@ export class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilit
|
|
|
313
313
|
}
|
|
314
314
|
```
|
|
315
315
|
|
|
316
|
-
See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator), [STEAK](#type-steak), [TaggedBEEF](#interface-taggedbeef)
|
|
316
|
+
See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator), [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
|
|
317
317
|
|
|
318
318
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
319
319
|
|
|
@@ -329,7 +329,7 @@ export class HTTPSOverlayLookupFacilitator implements OverlayLookupFacilitator {
|
|
|
329
329
|
}
|
|
330
330
|
```
|
|
331
331
|
|
|
332
|
-
See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
|
|
332
|
+
See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
|
|
333
333
|
|
|
334
334
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
335
335
|
|
|
@@ -345,7 +345,7 @@ export default class LookupResolver {
|
|
|
345
345
|
}
|
|
346
346
|
```
|
|
347
347
|
|
|
348
|
-
See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [LookupResolverConfig](#interface-lookupresolverconfig)
|
|
348
|
+
See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [LookupResolverConfig](./overlay-tools.md#interface-lookupresolverconfig)
|
|
349
349
|
|
|
350
350
|
#### Method query
|
|
351
351
|
|
|
@@ -354,7 +354,7 @@ Given a LookupQuestion, returns a LookupAnswer. Aggregates across multiple servi
|
|
|
354
354
|
```ts
|
|
355
355
|
async query(question: LookupQuestion, timeout?: number): Promise<LookupAnswer>
|
|
356
356
|
```
|
|
357
|
-
See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
|
|
357
|
+
See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
|
|
358
358
|
|
|
359
359
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
360
360
|
|
|
@@ -381,6 +381,8 @@ export default class OverlayAdminTokenTemplate implements ScriptTemplate {
|
|
|
381
381
|
}
|
|
382
382
|
```
|
|
383
383
|
|
|
384
|
+
See also: [LockingScript](./script.md#class-lockingscript), [PushDrop](./script.md#class-pushdrop), [ScriptTemplate](./script.md#interface-scripttemplate), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [WalletInterface](./wallet.md#interface-walletinterface), [sign](./compat.md#variable-sign)
|
|
385
|
+
|
|
384
386
|
#### Constructor
|
|
385
387
|
|
|
386
388
|
Constructs a new Overlay Admin template instance
|
|
@@ -388,6 +390,7 @@ Constructs a new Overlay Admin template instance
|
|
|
388
390
|
```ts
|
|
389
391
|
constructor(wallet: WalletInterface)
|
|
390
392
|
```
|
|
393
|
+
See also: [WalletInterface](./wallet.md#interface-walletinterface)
|
|
391
394
|
|
|
392
395
|
Argument Details
|
|
393
396
|
|
|
@@ -406,6 +409,7 @@ static decode(script: LockingScript): {
|
|
|
406
409
|
topicOrService: string;
|
|
407
410
|
}
|
|
408
411
|
```
|
|
412
|
+
See also: [LockingScript](./script.md#class-lockingscript)
|
|
409
413
|
|
|
410
414
|
Returns
|
|
411
415
|
|
|
@@ -423,6 +427,7 @@ Creates a new advertisement locking script
|
|
|
423
427
|
```ts
|
|
424
428
|
async lock(protocol: "SHIP" | "SLAP", domain: string, topicOrService: string): Promise<LockingScript>
|
|
425
429
|
```
|
|
430
|
+
See also: [LockingScript](./script.md#class-lockingscript)
|
|
426
431
|
|
|
427
432
|
Returns
|
|
428
433
|
|
|
@@ -447,6 +452,7 @@ unlock(protocol: "SHIP" | "SLAP"): {
|
|
|
447
452
|
estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
|
|
448
453
|
}
|
|
449
454
|
```
|
|
455
|
+
See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
|
|
450
456
|
|
|
451
457
|
Returns
|
|
452
458
|
|
|
@@ -471,7 +477,7 @@ export default class TopicBroadcaster implements Broadcaster {
|
|
|
471
477
|
}
|
|
472
478
|
```
|
|
473
479
|
|
|
474
|
-
See also: [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig)
|
|
480
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig), [Transaction](./transaction.md#class-transaction)
|
|
475
481
|
|
|
476
482
|
#### Constructor
|
|
477
483
|
|
|
@@ -480,7 +486,7 @@ Constructs an instance of the SHIP broadcaster.
|
|
|
480
486
|
```ts
|
|
481
487
|
constructor(topics: string[], config: SHIPBroadcasterConfig = {})
|
|
482
488
|
```
|
|
483
|
-
See also: [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig)
|
|
489
|
+
See also: [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig)
|
|
484
490
|
|
|
485
491
|
Argument Details
|
|
486
492
|
|
|
@@ -496,6 +502,7 @@ Broadcasts a transaction to Overlay Services via SHIP.
|
|
|
496
502
|
```ts
|
|
497
503
|
async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>
|
|
498
504
|
```
|
|
505
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
|
|
499
506
|
|
|
500
507
|
Returns
|
|
501
508
|
|
|
@@ -549,7 +556,7 @@ Submitted Transaction Execution AcKnowledgment
|
|
|
549
556
|
export type STEAK = Record<string, AdmittanceInstructions>
|
|
550
557
|
```
|
|
551
558
|
|
|
552
|
-
See also: [AdmittanceInstructions](#interface-admittanceinstructions)
|
|
559
|
+
See also: [AdmittanceInstructions](./overlay-tools.md#interface-admittanceinstructions)
|
|
553
560
|
|
|
554
561
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
555
562
|
|