@bsv/sdk 1.8.0 → 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.
- package/dist/cjs/package.json +1 -1
- package/dist/cjs/src/kvstore/GlobalKVStore.js +420 -0
- package/dist/cjs/src/kvstore/GlobalKVStore.js.map +1 -0
- package/dist/cjs/src/kvstore/LocalKVStore.js +6 -6
- package/dist/cjs/src/kvstore/LocalKVStore.js.map +1 -1
- package/dist/cjs/src/kvstore/index.js +3 -1
- package/dist/cjs/src/kvstore/index.js.map +1 -1
- package/dist/cjs/src/kvstore/kvStoreInterpreter.js +74 -0
- package/dist/cjs/src/kvstore/kvStoreInterpreter.js.map +1 -0
- package/dist/cjs/src/kvstore/types.js +11 -0
- package/dist/cjs/src/kvstore/types.js.map +1 -0
- package/dist/cjs/src/overlay-tools/Historian.js +153 -0
- package/dist/cjs/src/overlay-tools/Historian.js.map +1 -0
- package/dist/cjs/src/script/templates/PushDrop.js +2 -2
- package/dist/cjs/src/script/templates/PushDrop.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/kvstore/GlobalKVStore.js +416 -0
- package/dist/esm/src/kvstore/GlobalKVStore.js.map +1 -0
- package/dist/esm/src/kvstore/LocalKVStore.js +6 -6
- package/dist/esm/src/kvstore/LocalKVStore.js.map +1 -1
- package/dist/esm/src/kvstore/index.js +1 -0
- package/dist/esm/src/kvstore/index.js.map +1 -1
- package/dist/esm/src/kvstore/kvStoreInterpreter.js +47 -0
- package/dist/esm/src/kvstore/kvStoreInterpreter.js.map +1 -0
- package/dist/esm/src/kvstore/types.js +8 -0
- package/dist/esm/src/kvstore/types.js.map +1 -0
- package/dist/esm/src/overlay-tools/Historian.js +155 -0
- package/dist/esm/src/overlay-tools/Historian.js.map +1 -0
- package/dist/esm/src/script/templates/PushDrop.js +2 -2
- package/dist/esm/src/script/templates/PushDrop.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/kvstore/GlobalKVStore.d.ts +129 -0
- package/dist/types/src/kvstore/GlobalKVStore.d.ts.map +1 -0
- package/dist/types/src/kvstore/index.d.ts +1 -0
- package/dist/types/src/kvstore/index.d.ts.map +1 -1
- package/dist/types/src/kvstore/kvStoreInterpreter.d.ts +22 -0
- package/dist/types/src/kvstore/kvStoreInterpreter.d.ts.map +1 -0
- package/dist/types/src/kvstore/types.d.ts +106 -0
- package/dist/types/src/kvstore/types.d.ts.map +1 -0
- package/dist/types/src/overlay-tools/Historian.d.ts +92 -0
- package/dist/types/src/overlay-tools/Historian.d.ts.map +1 -0
- package/dist/types/src/script/templates/PushDrop.d.ts +6 -5
- package/dist/types/src/script/templates/PushDrop.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 +15 -27
- package/docs/reference/identity.md +12 -16
- package/docs/reference/kvstore.md +471 -4
- package/docs/reference/messages.md +0 -8
- package/docs/reference/overlay-tools.md +15 -22
- package/docs/reference/primitives.md +168 -168
- package/docs/reference/registry.md +9 -19
- package/docs/reference/script.md +35 -48
- package/docs/reference/storage.md +10 -14
- package/docs/reference/totp.md +5 -5
- package/docs/reference/transaction.md +117 -69
- package/docs/reference/wallet.md +131 -135
- package/package.json +1 -1
- package/src/kvstore/GlobalKVStore.ts +478 -0
- package/src/kvstore/LocalKVStore.ts +7 -7
- package/src/kvstore/__tests/GlobalKVStore.test.ts +965 -0
- package/src/kvstore/__tests/LocalKVStore.test.ts +72 -0
- package/src/kvstore/index.ts +1 -0
- package/src/kvstore/kvStoreInterpreter.ts +49 -0
- package/src/kvstore/types.ts +114 -0
- package/src/overlay-tools/Historian.ts +195 -0
- package/src/overlay-tools/__tests/Historian.test.ts +690 -0
- package/src/script/templates/PushDrop.ts +6 -5
|
@@ -36,8 +36,6 @@ export interface BasketDefinitionData {
|
|
|
36
36
|
}
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
40
|
-
|
|
41
39
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
42
40
|
|
|
43
41
|
---
|
|
@@ -76,7 +74,7 @@ export interface CertificateDefinitionData {
|
|
|
76
74
|
}
|
|
77
75
|
```
|
|
78
76
|
|
|
79
|
-
See also: [CertificateFieldDescriptor](
|
|
77
|
+
See also: [CertificateFieldDescriptor](#interface-certificatefielddescriptor)
|
|
80
78
|
|
|
81
79
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
82
80
|
|
|
@@ -131,8 +129,6 @@ export interface ProtocolDefinitionData {
|
|
|
131
129
|
}
|
|
132
130
|
```
|
|
133
131
|
|
|
134
|
-
See also: [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
135
|
-
|
|
136
132
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
137
133
|
|
|
138
134
|
---
|
|
@@ -151,8 +147,6 @@ export interface ProtocolQuery {
|
|
|
151
147
|
}
|
|
152
148
|
```
|
|
153
149
|
|
|
154
|
-
See also: [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
155
|
-
|
|
156
150
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
157
151
|
|
|
158
152
|
---
|
|
@@ -168,7 +162,7 @@ export interface RegistryQueryMapping {
|
|
|
168
162
|
}
|
|
169
163
|
```
|
|
170
164
|
|
|
171
|
-
See also: [BasketQuery](
|
|
165
|
+
See also: [BasketQuery](#interface-basketquery), [CertificateQuery](#interface-certificatequery), [ProtocolQuery](#interface-protocolquery)
|
|
172
166
|
|
|
173
167
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
174
168
|
|
|
@@ -187,8 +181,6 @@ export interface TokenData {
|
|
|
187
181
|
}
|
|
188
182
|
```
|
|
189
183
|
|
|
190
|
-
See also: [BEEF](./wallet.md#type-beef)
|
|
191
|
-
|
|
192
184
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
193
185
|
|
|
194
186
|
---
|
|
@@ -220,7 +212,7 @@ export class RegistryClient {
|
|
|
220
212
|
}
|
|
221
213
|
```
|
|
222
214
|
|
|
223
|
-
See also: [
|
|
215
|
+
See also: [DefinitionData](#type-definitiondata), [DefinitionType](#type-definitiontype), [RegistryQueryMapping](#interface-registryquerymapping), [RegistryRecord](#type-registryrecord)
|
|
224
216
|
|
|
225
217
|
#### Method listOwnRegistryEntries
|
|
226
218
|
|
|
@@ -231,7 +223,7 @@ Returns parsed registry records including transaction details such as txid, outp
|
|
|
231
223
|
```ts
|
|
232
224
|
async listOwnRegistryEntries(definitionType: DefinitionType): Promise<RegistryRecord[]>
|
|
233
225
|
```
|
|
234
|
-
See also: [DefinitionType](
|
|
226
|
+
See also: [DefinitionType](#type-definitiontype), [RegistryRecord](#type-registryrecord)
|
|
235
227
|
|
|
236
228
|
Returns
|
|
237
229
|
|
|
@@ -253,7 +245,7 @@ to establish canonical references for basket IDs, protocol specs, or certificate
|
|
|
253
245
|
```ts
|
|
254
246
|
async registerDefinition(data: DefinitionData): Promise<BroadcastResponse | BroadcastFailure>
|
|
255
247
|
```
|
|
256
|
-
See also: [
|
|
248
|
+
See also: [DefinitionData](#type-definitiondata)
|
|
257
249
|
|
|
258
250
|
Returns
|
|
259
251
|
|
|
@@ -279,7 +271,7 @@ The query object shape depends on the registry type:
|
|
|
279
271
|
```ts
|
|
280
272
|
async resolve<T extends DefinitionType>(definitionType: T, query: RegistryQueryMapping[T]): Promise<DefinitionData[]>
|
|
281
273
|
```
|
|
282
|
-
See also: [DefinitionData](
|
|
274
|
+
See also: [DefinitionData](#type-definitiondata), [DefinitionType](#type-definitiontype), [RegistryQueryMapping](#interface-registryquerymapping)
|
|
283
275
|
|
|
284
276
|
Returns
|
|
285
277
|
|
|
@@ -299,7 +291,7 @@ Revokes a registry record by spending its associated UTXO.
|
|
|
299
291
|
```ts
|
|
300
292
|
async revokeOwnRegistryEntry(registryRecord: RegistryRecord): Promise<BroadcastResponse | BroadcastFailure>
|
|
301
293
|
```
|
|
302
|
-
See also: [
|
|
294
|
+
See also: [RegistryRecord](#type-registryrecord)
|
|
303
295
|
|
|
304
296
|
Returns
|
|
305
297
|
|
|
@@ -321,8 +313,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
321
313
|
export function deserializeWalletProtocol(str: string): WalletProtocol
|
|
322
314
|
```
|
|
323
315
|
|
|
324
|
-
See also: [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
325
|
-
|
|
326
316
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
327
317
|
|
|
328
318
|
---
|
|
@@ -346,7 +336,7 @@ Union of all possible definition data objects.
|
|
|
346
336
|
export type DefinitionData = BasketDefinitionData | ProtocolDefinitionData | CertificateDefinitionData
|
|
347
337
|
```
|
|
348
338
|
|
|
349
|
-
See also: [BasketDefinitionData](
|
|
339
|
+
See also: [BasketDefinitionData](#interface-basketdefinitiondata), [CertificateDefinitionData](#interface-certificatedefinitiondata), [ProtocolDefinitionData](#interface-protocoldefinitiondata)
|
|
350
340
|
|
|
351
341
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
352
342
|
|
|
@@ -372,7 +362,7 @@ plus the on-chain token data for the UTXO holding it.
|
|
|
372
362
|
export type RegistryRecord = DefinitionData & TokenData
|
|
373
363
|
```
|
|
374
364
|
|
|
375
|
-
See also: [DefinitionData](
|
|
365
|
+
See also: [DefinitionData](#type-definitiondata), [TokenData](#interface-tokendata)
|
|
376
366
|
|
|
377
367
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
378
368
|
|
package/docs/reference/script.md
CHANGED
|
@@ -37,7 +37,7 @@ export default interface ScriptTemplate {
|
|
|
37
37
|
}
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
See also: [LockingScript](
|
|
40
|
+
See also: [LockingScript](#class-lockingscript), [ScriptTemplateUnlock](#interface-scripttemplateunlock)
|
|
41
41
|
|
|
42
42
|
#### Property lock
|
|
43
43
|
|
|
@@ -46,7 +46,7 @@ Creates a locking script with the given parameters.
|
|
|
46
46
|
```ts
|
|
47
47
|
lock: (...params: any[]) => LockingScript | Promise<LockingScript>
|
|
48
48
|
```
|
|
49
|
-
See also: [LockingScript](
|
|
49
|
+
See also: [LockingScript](#class-lockingscript)
|
|
50
50
|
|
|
51
51
|
#### Property unlock
|
|
52
52
|
|
|
@@ -59,7 +59,7 @@ This method returns an object containing two functions:
|
|
|
59
59
|
```ts
|
|
60
60
|
unlock: (...params: any[]) => ScriptTemplateUnlock
|
|
61
61
|
```
|
|
62
|
-
See also: [ScriptTemplateUnlock](
|
|
62
|
+
See also: [ScriptTemplateUnlock](#interface-scripttemplateunlock)
|
|
63
63
|
|
|
64
64
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
65
65
|
|
|
@@ -73,7 +73,7 @@ export default interface ScriptTemplateUnlock {
|
|
|
73
73
|
}
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
See also: [
|
|
76
|
+
See also: [UnlockingScript](#class-unlockingscript)
|
|
77
77
|
|
|
78
78
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
79
79
|
|
|
@@ -109,7 +109,7 @@ export default class LockingScript extends Script {
|
|
|
109
109
|
}
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
See also: [Script](
|
|
112
|
+
See also: [Script](#class-script)
|
|
113
113
|
|
|
114
114
|
#### Method isLockingScript
|
|
115
115
|
|
|
@@ -150,7 +150,7 @@ export default class P2PKH implements ScriptTemplate {
|
|
|
150
150
|
}
|
|
151
151
|
```
|
|
152
152
|
|
|
153
|
-
See also: [LockingScript](
|
|
153
|
+
See also: [LockingScript](#class-lockingscript), [Script](#class-script), [ScriptTemplate](#interface-scripttemplate), [UnlockingScript](#class-unlockingscript)
|
|
154
154
|
|
|
155
155
|
#### Method lock
|
|
156
156
|
|
|
@@ -159,7 +159,7 @@ Creates a P2PKH locking script for a given public key hash or address string
|
|
|
159
159
|
```ts
|
|
160
160
|
lock(pubkeyhash: string | number[]): LockingScript
|
|
161
161
|
```
|
|
162
|
-
See also: [LockingScript](
|
|
162
|
+
See also: [LockingScript](#class-lockingscript)
|
|
163
163
|
|
|
164
164
|
Returns
|
|
165
165
|
|
|
@@ -185,7 +185,7 @@ unlock(privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", a
|
|
|
185
185
|
estimateLength: () => Promise<108>;
|
|
186
186
|
}
|
|
187
187
|
```
|
|
188
|
-
See also: [
|
|
188
|
+
See also: [Script](#class-script), [UnlockingScript](#class-unlockingscript)
|
|
189
189
|
|
|
190
190
|
Returns
|
|
191
191
|
|
|
@@ -218,21 +218,15 @@ export default class PushDrop implements ScriptTemplate {
|
|
|
218
218
|
fields: number[][];
|
|
219
219
|
}
|
|
220
220
|
constructor(wallet: WalletInterface, originator?: string)
|
|
221
|
-
async lock(fields: number[][], protocolID:
|
|
222
|
-
|
|
223
|
-
string
|
|
224
|
-
], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript>
|
|
225
|
-
unlock(protocolID: [
|
|
226
|
-
SecurityLevel,
|
|
227
|
-
string
|
|
228
|
-
], keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
|
|
221
|
+
async lock(fields: number[][], protocolID: WalletProtocol, keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript>
|
|
222
|
+
unlock(protocolID: WalletProtocol, keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
|
|
229
223
|
sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
|
|
230
224
|
estimateLength: () => Promise<73>;
|
|
231
225
|
}
|
|
232
226
|
}
|
|
233
227
|
```
|
|
234
228
|
|
|
235
|
-
See also: [LockingScript](
|
|
229
|
+
See also: [LockingScript](#class-lockingscript), [ScriptTemplate](#interface-scripttemplate), [UnlockingScript](#class-unlockingscript)
|
|
236
230
|
|
|
237
231
|
#### Constructor
|
|
238
232
|
|
|
@@ -241,7 +235,6 @@ Constructs a new instance of the PushDrop class.
|
|
|
241
235
|
```ts
|
|
242
236
|
constructor(wallet: WalletInterface, originator?: string)
|
|
243
237
|
```
|
|
244
|
-
See also: [WalletInterface](./wallet.md#interface-walletinterface)
|
|
245
238
|
|
|
246
239
|
Argument Details
|
|
247
240
|
|
|
@@ -261,7 +254,7 @@ static decode(script: LockingScript): {
|
|
|
261
254
|
fields: number[][];
|
|
262
255
|
}
|
|
263
256
|
```
|
|
264
|
-
See also: [LockingScript](
|
|
257
|
+
See also: [LockingScript](#class-lockingscript)
|
|
265
258
|
|
|
266
259
|
Returns
|
|
267
260
|
|
|
@@ -277,12 +270,9 @@ Argument Details
|
|
|
277
270
|
Creates a PushDrop locking script with arbitrary data fields and a public key lock.
|
|
278
271
|
|
|
279
272
|
```ts
|
|
280
|
-
async lock(fields: number[][], protocolID:
|
|
281
|
-
SecurityLevel,
|
|
282
|
-
string
|
|
283
|
-
], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript>
|
|
273
|
+
async lock(fields: number[][], protocolID: WalletProtocol, keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript>
|
|
284
274
|
```
|
|
285
|
-
See also: [LockingScript](
|
|
275
|
+
See also: [LockingScript](#class-lockingscript)
|
|
286
276
|
|
|
287
277
|
Returns
|
|
288
278
|
|
|
@@ -308,15 +298,12 @@ Argument Details
|
|
|
308
298
|
Creates an unlocking script for spending a PushDrop token output.
|
|
309
299
|
|
|
310
300
|
```ts
|
|
311
|
-
unlock(protocolID:
|
|
312
|
-
SecurityLevel,
|
|
313
|
-
string
|
|
314
|
-
], keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
|
|
301
|
+
unlock(protocolID: WalletProtocol, keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
|
|
315
302
|
sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
|
|
316
303
|
estimateLength: () => Promise<73>;
|
|
317
304
|
}
|
|
318
305
|
```
|
|
319
|
-
See also: [LockingScript](
|
|
306
|
+
See also: [LockingScript](#class-lockingscript), [UnlockingScript](#class-unlockingscript)
|
|
320
307
|
|
|
321
308
|
Returns
|
|
322
309
|
|
|
@@ -362,7 +349,7 @@ export default class RPuzzle implements ScriptTemplate {
|
|
|
362
349
|
}
|
|
363
350
|
```
|
|
364
351
|
|
|
365
|
-
See also: [
|
|
352
|
+
See also: [LockingScript](#class-lockingscript), [ScriptTemplate](#interface-scripttemplate), [UnlockingScript](#class-unlockingscript)
|
|
366
353
|
|
|
367
354
|
#### Constructor
|
|
368
355
|
|
|
@@ -382,7 +369,7 @@ Creates an R puzzle locking script for a given R value or R value hash.
|
|
|
382
369
|
```ts
|
|
383
370
|
lock(value: number[]): LockingScript
|
|
384
371
|
```
|
|
385
|
-
See also: [LockingScript](
|
|
372
|
+
See also: [LockingScript](#class-lockingscript)
|
|
386
373
|
|
|
387
374
|
Returns
|
|
388
375
|
|
|
@@ -408,7 +395,7 @@ unlock(k: BigNumber, privateKey: PrivateKey, signOutputs: "all" | "none" | "sing
|
|
|
408
395
|
estimateLength: () => Promise<108>;
|
|
409
396
|
}
|
|
410
397
|
```
|
|
411
|
-
See also: [
|
|
398
|
+
See also: [UnlockingScript](#class-unlockingscript)
|
|
412
399
|
|
|
413
400
|
Returns
|
|
414
401
|
|
|
@@ -458,14 +445,14 @@ export default class Script {
|
|
|
458
445
|
}
|
|
459
446
|
```
|
|
460
447
|
|
|
461
|
-
See also: [
|
|
448
|
+
See also: [ScriptChunk](#interface-scriptchunk)
|
|
462
449
|
|
|
463
450
|
#### Constructor
|
|
464
451
|
|
|
465
452
|
```ts
|
|
466
453
|
constructor(chunks: ScriptChunk[] = [])
|
|
467
454
|
```
|
|
468
|
-
See also: [ScriptChunk](
|
|
455
|
+
See also: [ScriptChunk](#interface-scriptchunk)
|
|
469
456
|
|
|
470
457
|
Argument Details
|
|
471
458
|
|
|
@@ -479,7 +466,7 @@ Deletes the given item wherever it appears in the current script.
|
|
|
479
466
|
```ts
|
|
480
467
|
findAndDelete(script: Script): Script
|
|
481
468
|
```
|
|
482
|
-
See also: [Script](
|
|
469
|
+
See also: [Script](#class-script)
|
|
483
470
|
|
|
484
471
|
Returns
|
|
485
472
|
|
|
@@ -495,7 +482,7 @@ Argument Details
|
|
|
495
482
|
```ts
|
|
496
483
|
static fromASM(asm: string): Script
|
|
497
484
|
```
|
|
498
|
-
See also: [Script](
|
|
485
|
+
See also: [Script](#class-script)
|
|
499
486
|
|
|
500
487
|
Returns
|
|
501
488
|
|
|
@@ -517,7 +504,7 @@ const script = Script.fromASM("OP_DUP OP_HASH160 abcd... OP_EQUALVERIFY OP_CHECK
|
|
|
517
504
|
```ts
|
|
518
505
|
static fromBinary(bin: number[]): Script
|
|
519
506
|
```
|
|
520
|
-
See also: [Script](
|
|
507
|
+
See also: [Script](#class-script)
|
|
521
508
|
|
|
522
509
|
Returns
|
|
523
510
|
|
|
@@ -539,7 +526,7 @@ const script = Script.fromBinary([0x76, 0xa9, ...])
|
|
|
539
526
|
```ts
|
|
540
527
|
static fromHex(hex: string): Script
|
|
541
528
|
```
|
|
542
|
-
See also: [Script](
|
|
529
|
+
See also: [Script](#class-script)
|
|
543
530
|
|
|
544
531
|
Returns
|
|
545
532
|
|
|
@@ -591,7 +578,7 @@ True if the script is an unlocking script, otherwise false.
|
|
|
591
578
|
```ts
|
|
592
579
|
removeCodeseparators(): Script
|
|
593
580
|
```
|
|
594
|
-
See also: [Script](
|
|
581
|
+
See also: [Script](#class-script)
|
|
595
582
|
|
|
596
583
|
Returns
|
|
597
584
|
|
|
@@ -602,7 +589,7 @@ This script instance for chaining.
|
|
|
602
589
|
```ts
|
|
603
590
|
setChunkOpCode(i: number, op: number): Script
|
|
604
591
|
```
|
|
605
|
-
See also: [Script](
|
|
592
|
+
See also: [Script](#class-script)
|
|
606
593
|
|
|
607
594
|
Returns
|
|
608
595
|
|
|
@@ -650,7 +637,7 @@ The script in hexadecimal format.
|
|
|
650
637
|
```ts
|
|
651
638
|
writeBin(bin: number[]): Script
|
|
652
639
|
```
|
|
653
|
-
See also: [Script](
|
|
640
|
+
See also: [Script](#class-script)
|
|
654
641
|
|
|
655
642
|
Returns
|
|
656
643
|
|
|
@@ -670,7 +657,7 @@ Throws an error if the data is too large to be pushed.
|
|
|
670
657
|
```ts
|
|
671
658
|
writeBn(bn: BigNumber): Script
|
|
672
659
|
```
|
|
673
|
-
See also: [
|
|
660
|
+
See also: [Script](#class-script)
|
|
674
661
|
|
|
675
662
|
Returns
|
|
676
663
|
|
|
@@ -686,7 +673,7 @@ Argument Details
|
|
|
686
673
|
```ts
|
|
687
674
|
writeNumber(num: number): Script
|
|
688
675
|
```
|
|
689
|
-
See also: [Script](
|
|
676
|
+
See also: [Script](#class-script)
|
|
690
677
|
|
|
691
678
|
Returns
|
|
692
679
|
|
|
@@ -702,7 +689,7 @@ Argument Details
|
|
|
702
689
|
```ts
|
|
703
690
|
writeOpCode(op: number): Script
|
|
704
691
|
```
|
|
705
|
-
See also: [Script](
|
|
692
|
+
See also: [Script](#class-script)
|
|
706
693
|
|
|
707
694
|
Returns
|
|
708
695
|
|
|
@@ -718,7 +705,7 @@ Argument Details
|
|
|
718
705
|
```ts
|
|
719
706
|
writeScript(script: Script): Script
|
|
720
707
|
```
|
|
721
|
-
See also: [Script](
|
|
708
|
+
See also: [Script](#class-script)
|
|
722
709
|
|
|
723
710
|
Returns
|
|
724
711
|
|
|
@@ -811,7 +798,7 @@ export default class Spend {
|
|
|
811
798
|
}
|
|
812
799
|
```
|
|
813
800
|
|
|
814
|
-
See also: [LockingScript](
|
|
801
|
+
See also: [LockingScript](#class-lockingscript), [UnlockingScript](#class-unlockingscript)
|
|
815
802
|
|
|
816
803
|
#### Constructor
|
|
817
804
|
|
|
@@ -831,7 +818,7 @@ constructor(params: {
|
|
|
831
818
|
memoryLimit?: number;
|
|
832
819
|
})
|
|
833
820
|
```
|
|
834
|
-
See also: [LockingScript](
|
|
821
|
+
See also: [LockingScript](#class-lockingscript), [UnlockingScript](#class-unlockingscript)
|
|
835
822
|
|
|
836
823
|
Argument Details
|
|
837
824
|
|
|
@@ -915,7 +902,7 @@ export default class UnlockingScript extends Script {
|
|
|
915
902
|
}
|
|
916
903
|
```
|
|
917
904
|
|
|
918
|
-
See also: [Script](
|
|
905
|
+
See also: [Script](#class-script)
|
|
919
906
|
|
|
920
907
|
#### Method isLockingScript
|
|
921
908
|
|
|
@@ -102,8 +102,6 @@ export interface UploaderConfig {
|
|
|
102
102
|
}
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
-
See also: [WalletInterface](./wallet.md#interface-walletinterface)
|
|
106
|
-
|
|
107
105
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
108
106
|
|
|
109
107
|
---
|
|
@@ -128,7 +126,7 @@ export class StorageDownloader {
|
|
|
128
126
|
}
|
|
129
127
|
```
|
|
130
128
|
|
|
131
|
-
See also: [DownloadResult](
|
|
129
|
+
See also: [DownloadResult](#interface-downloadresult), [DownloaderConfig](#interface-downloaderconfig)
|
|
132
130
|
|
|
133
131
|
#### Method download
|
|
134
132
|
|
|
@@ -137,7 +135,7 @@ Downloads the content from the UHRP URL after validating the hash for integrity.
|
|
|
137
135
|
```ts
|
|
138
136
|
public async download(uhrpUrl: string): Promise<DownloadResult>
|
|
139
137
|
```
|
|
140
|
-
See also: [DownloadResult](
|
|
138
|
+
See also: [DownloadResult](#interface-downloadresult)
|
|
141
139
|
|
|
142
140
|
Returns
|
|
143
141
|
|
|
@@ -189,7 +187,7 @@ export class StorageUploader {
|
|
|
189
187
|
}
|
|
190
188
|
```
|
|
191
189
|
|
|
192
|
-
See also: [FindFileData](
|
|
190
|
+
See also: [FindFileData](#interface-findfiledata), [RenewFileResult](#interface-renewfileresult), [UploadFileResult](#interface-uploadfileresult), [UploadableFile](#interface-uploadablefile), [UploaderConfig](#interface-uploaderconfig)
|
|
193
191
|
|
|
194
192
|
#### Constructor
|
|
195
193
|
|
|
@@ -198,7 +196,7 @@ Creates a new StorageUploader instance.
|
|
|
198
196
|
```ts
|
|
199
197
|
constructor(config: UploaderConfig)
|
|
200
198
|
```
|
|
201
|
-
See also: [UploaderConfig](
|
|
199
|
+
See also: [UploaderConfig](#interface-uploaderconfig)
|
|
202
200
|
|
|
203
201
|
Argument Details
|
|
204
202
|
|
|
@@ -212,7 +210,7 @@ Retrieves metadata for a file matching the given UHRP URL from the `/find` route
|
|
|
212
210
|
```ts
|
|
213
211
|
public async findFile(uhrpUrl: string): Promise<FindFileData>
|
|
214
212
|
```
|
|
215
|
-
See also: [FindFileData](
|
|
213
|
+
See also: [FindFileData](#interface-findfiledata)
|
|
216
214
|
|
|
217
215
|
Returns
|
|
218
216
|
|
|
@@ -258,7 +256,7 @@ public async publishFile(params: {
|
|
|
258
256
|
retentionPeriod: number;
|
|
259
257
|
}): Promise<UploadFileResult>
|
|
260
258
|
```
|
|
261
|
-
See also: [UploadFileResult](
|
|
259
|
+
See also: [UploadFileResult](#interface-uploadfileresult), [UploadableFile](#interface-uploadablefile)
|
|
262
260
|
|
|
263
261
|
Returns
|
|
264
262
|
|
|
@@ -277,7 +275,7 @@ and re-mint the advertisement token on-chain.
|
|
|
277
275
|
```ts
|
|
278
276
|
public async renewFile(uhrpUrl: string, additionalMinutes: number): Promise<RenewFileResult>
|
|
279
277
|
```
|
|
280
|
-
See also: [RenewFileResult](
|
|
278
|
+
See also: [RenewFileResult](#interface-renewfileresult)
|
|
281
279
|
|
|
282
280
|
Returns
|
|
283
281
|
|
|
@@ -333,7 +331,7 @@ getHashFromURL = (URL: string): number[] => {
|
|
|
333
331
|
}
|
|
334
332
|
```
|
|
335
333
|
|
|
336
|
-
See also: [
|
|
334
|
+
See also: [normalizeURL](#variable-normalizeurl)
|
|
337
335
|
|
|
338
336
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
339
337
|
|
|
@@ -354,7 +352,7 @@ getURLForFile = (file: Uint8Array | number[]): string => {
|
|
|
354
352
|
}
|
|
355
353
|
```
|
|
356
354
|
|
|
357
|
-
See also: [
|
|
355
|
+
See also: [getURLForHash](#variable-geturlforhash)
|
|
358
356
|
|
|
359
357
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
360
358
|
|
|
@@ -370,8 +368,6 @@ getURLForHash = (hash: number[]): string => {
|
|
|
370
368
|
}
|
|
371
369
|
```
|
|
372
370
|
|
|
373
|
-
See also: [toArray](./primitives.md#variable-toarray), [toBase58Check](./primitives.md#variable-tobase58check)
|
|
374
|
-
|
|
375
371
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
376
372
|
|
|
377
373
|
---
|
|
@@ -389,7 +385,7 @@ isValidURL = (URL: string): boolean => {
|
|
|
389
385
|
}
|
|
390
386
|
```
|
|
391
387
|
|
|
392
|
-
See also: [getHashFromURL](
|
|
388
|
+
See also: [getHashFromURL](#variable-gethashfromurl)
|
|
393
389
|
|
|
394
390
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
395
391
|
|
package/docs/reference/totp.md
CHANGED
|
@@ -17,7 +17,7 @@ export interface TOTPOptions {
|
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
See also: [TOTPAlgorithm](
|
|
20
|
+
See also: [TOTPAlgorithm](#type-totpalgorithm)
|
|
21
21
|
|
|
22
22
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
23
23
|
|
|
@@ -33,7 +33,7 @@ export class TOTP {
|
|
|
33
33
|
}
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
See also: [TOTPOptions](
|
|
36
|
+
See also: [TOTPOptions](#interface-totpoptions), [TOTPValidateOptions](#type-totpvalidateoptions)
|
|
37
37
|
|
|
38
38
|
#### Method generate
|
|
39
39
|
|
|
@@ -42,7 +42,7 @@ Generates a Time-based One-Time Password (TOTP).
|
|
|
42
42
|
```ts
|
|
43
43
|
static generate(secret: number[], options?: TOTPOptions): string
|
|
44
44
|
```
|
|
45
|
-
See also: [TOTPOptions](
|
|
45
|
+
See also: [TOTPOptions](#interface-totpoptions)
|
|
46
46
|
|
|
47
47
|
Returns
|
|
48
48
|
|
|
@@ -62,7 +62,7 @@ Validates a Time-based One-Time Password (TOTP).
|
|
|
62
62
|
```ts
|
|
63
63
|
static validate(secret: number[], passcode: string, options?: TOTPValidateOptions): boolean
|
|
64
64
|
```
|
|
65
|
-
See also: [TOTPValidateOptions](
|
|
65
|
+
See also: [TOTPValidateOptions](#type-totpvalidateoptions)
|
|
66
66
|
|
|
67
67
|
Returns
|
|
68
68
|
|
|
@@ -112,7 +112,7 @@ export type TOTPValidateOptions = TOTPOptions & {
|
|
|
112
112
|
}
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
See also: [TOTPOptions](
|
|
115
|
+
See also: [TOTPOptions](#interface-totpoptions)
|
|
116
116
|
|
|
117
117
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
118
118
|
|