@bsv/sdk 1.8.1 → 1.8.2

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.
Files changed (26) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/kvstore/index.js +3 -1
  3. package/dist/cjs/src/kvstore/index.js.map +1 -1
  4. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  5. package/dist/esm/src/kvstore/index.js +1 -0
  6. package/dist/esm/src/kvstore/index.js.map +1 -1
  7. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  8. package/dist/types/src/kvstore/index.d.ts +1 -0
  9. package/dist/types/src/kvstore/index.d.ts.map +1 -1
  10. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  11. package/dist/umd/bundle.js +3 -3
  12. package/dist/umd/bundle.js.map +1 -1
  13. package/docs/reference/compat.md +15 -27
  14. package/docs/reference/identity.md +12 -16
  15. package/docs/reference/kvstore.md +471 -4
  16. package/docs/reference/messages.md +0 -8
  17. package/docs/reference/overlay-tools.md +15 -22
  18. package/docs/reference/primitives.md +168 -168
  19. package/docs/reference/registry.md +9 -19
  20. package/docs/reference/script.md +31 -32
  21. package/docs/reference/storage.md +10 -14
  22. package/docs/reference/totp.md +5 -5
  23. package/docs/reference/transaction.md +67 -70
  24. package/docs/reference/wallet.md +131 -135
  25. package/package.json +1 -1
  26. package/src/kvstore/index.ts +1 -0
package/docs/reference/overlay-tools.md CHANGED
@@ -104,7 +104,7 @@ export interface LookupResolverConfig {
104
104
  }
105
105
  ```
106
106
 
107
- See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
107
+ See also: [OverlayLookupFacilitator](#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](./overlay-tools.md#interface-overlaylookupfacilitator)
132
+ See also: [OverlayLookupFacilitator](#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](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
174
+ See also: [STEAK](#type-steak), [TaggedBEEF](#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](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
189
+ See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#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](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
198
+ See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#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](./overlay-tools.md#class-lookupresolver), [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
218
+ See also: [LookupResolver](#class-lookupresolver), [OverlayBroadcastFacilitator](#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](./overlay-tools.md#interface-overlaybroadcastfacilitator)
227
+ See also: [OverlayBroadcastFacilitator](#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](./overlay-tools.md#class-lookupresolver)
271
+ See also: [LookupResolver](#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](./overlay-tools.md#interface-overlaybroadcastfacilitator), [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
316
+ See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator), [STEAK](#type-steak), [TaggedBEEF](#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](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
332
+ See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [OverlayLookupFacilitator](#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](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [LookupResolverConfig](./overlay-tools.md#interface-lookupresolverconfig)
348
+ See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [LookupResolverConfig](#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](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
357
+ See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
358
358
 
359
359
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
360
360
 
@@ -381,8 +381,6 @@ 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
-
386
384
  #### Constructor
387
385
 
388
386
  Constructs a new Overlay Admin template instance
@@ -390,7 +388,6 @@ Constructs a new Overlay Admin template instance
390
388
  ```ts
391
389
  constructor(wallet: WalletInterface)
392
390
  ```
393
- See also: [WalletInterface](./wallet.md#interface-walletinterface)
394
391
 
395
392
  Argument Details
396
393
 
@@ -409,7 +406,6 @@ static decode(script: LockingScript): {
409
406
  topicOrService: string;
410
407
  }
411
408
  ```
412
- See also: [LockingScript](./script.md#class-lockingscript)
413
409
 
414
410
  Returns
415
411
 
@@ -427,7 +423,6 @@ Creates a new advertisement locking script
427
423
  ```ts
428
424
  async lock(protocol: "SHIP" | "SLAP", domain: string, topicOrService: string): Promise<LockingScript>
429
425
  ```
430
- See also: [LockingScript](./script.md#class-lockingscript)
431
426
 
432
427
  Returns
433
428
 
@@ -452,7 +447,6 @@ unlock(protocol: "SHIP" | "SLAP"): {
452
447
  estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
453
448
  }
454
449
  ```
455
- See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
456
450
 
457
451
  Returns
458
452
 
@@ -477,7 +471,7 @@ export default class TopicBroadcaster implements Broadcaster {
477
471
  }
478
472
  ```
479
473
 
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)
474
+ See also: [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig)
481
475
 
482
476
  #### Constructor
483
477
 
@@ -486,7 +480,7 @@ Constructs an instance of the SHIP broadcaster.
486
480
  ```ts
487
481
  constructor(topics: string[], config: SHIPBroadcasterConfig = {})
488
482
  ```
489
- See also: [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig)
483
+ See also: [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig)
490
484
 
491
485
  Argument Details
492
486
 
@@ -502,7 +496,6 @@ Broadcasts a transaction to Overlay Services via SHIP.
502
496
  ```ts
503
497
  async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>
504
498
  ```
505
- See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
506
499
 
507
500
  Returns
508
501
 
@@ -556,7 +549,7 @@ Submitted Transaction Execution AcKnowledgment
556
549
  export type STEAK = Record<string, AdmittanceInstructions>
557
550
  ```
558
551
 
559
- See also: [AdmittanceInstructions](./overlay-tools.md#interface-admittanceinstructions)
552
+ See also: [AdmittanceInstructions](#interface-admittanceinstructions)
560
553
 
561
554
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
562
555