@xyo-network/chain-wrappers 1.15.2 → 1.15.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/README.md
CHANGED
|
@@ -20,33 +20,379 @@ XYO Layer One SDK Wrappers
|
|
|
20
20
|
|
|
21
21
|
## Classes
|
|
22
22
|
|
|
23
|
-
- [FeesWrapper](#classes/FeesWrapper)
|
|
24
|
-
- [SignatureWrapper](#classes/SignatureWrapper)
|
|
25
|
-
- [ShiftedBigInt](#classes/ShiftedBigInt)
|
|
26
|
-
- [XL1Amount](#classes/XL1Amount)
|
|
27
23
|
- [HydratedBlockWrapper](#classes/HydratedBlockWrapper)
|
|
28
24
|
- [IndexedHydratedBlockRangeStore](#classes/IndexedHydratedBlockRangeStore)
|
|
25
|
+
- [BaseWrapper](#classes/BaseWrapper)
|
|
26
|
+
- [FeesWrapper](#classes/FeesWrapper)
|
|
27
|
+
- [SignatureWrapper](#classes/SignatureWrapper)
|
|
28
|
+
- [~~ShiftedBigInt~~](#classes/ShiftedBigInt)
|
|
29
|
+
- [~~XL1Amount~~](#classes/XL1Amount)
|
|
30
|
+
- [ChainWrapper](#classes/ChainWrapper)
|
|
29
31
|
- [HydratedTransactionWrapper](#classes/HydratedTransactionWrapper)
|
|
30
32
|
|
|
31
33
|
## Interfaces
|
|
32
34
|
|
|
33
|
-
- [XL1AmountInstance](#interfaces/XL1AmountInstance)
|
|
34
35
|
- [HydratedBlockStoreInstance](#interfaces/HydratedBlockStoreInstance)
|
|
35
36
|
- [IndexedHydratedBlockStoreInstance](#interfaces/IndexedHydratedBlockStoreInstance)
|
|
36
37
|
- [HydratedBlockRangeStoreParams](#interfaces/HydratedBlockRangeStoreParams)
|
|
37
38
|
- [IndexedHydratedBlockRangeStoreInstance](#interfaces/IndexedHydratedBlockRangeStoreInstance)
|
|
39
|
+
- [BaseWrapperConfig](#interfaces/BaseWrapperConfig)
|
|
40
|
+
- [~~XL1AmountInstance~~](#interfaces/XL1AmountInstance)
|
|
38
41
|
|
|
39
42
|
## Type Aliases
|
|
40
43
|
|
|
41
44
|
- [HydratedBlockStoreParams](#type-aliases/HydratedBlockStoreParams)
|
|
42
45
|
|
|
43
|
-
##
|
|
46
|
+
## Variables
|
|
44
47
|
|
|
45
|
-
- [splitOnDecimal](#
|
|
46
|
-
- [splitOnDecimalToString](#
|
|
48
|
+
- [~~splitOnDecimal~~](#variables/splitOnDecimal)
|
|
49
|
+
- [~~splitOnDecimalToString~~](#variables/splitOnDecimalToString)
|
|
50
|
+
- [createSignatureWrappers](#variables/createSignatureWrappers)
|
|
47
51
|
|
|
48
52
|
### classes
|
|
49
53
|
|
|
54
|
+
### <a id="BaseWrapper"></a>BaseWrapper
|
|
55
|
+
|
|
56
|
+
[**@xyo-network/chain-wrappers**](#../README)
|
|
57
|
+
|
|
58
|
+
***
|
|
59
|
+
|
|
60
|
+
## Extended by
|
|
61
|
+
|
|
62
|
+
- [`ChainWrapper`](#ChainWrapper)
|
|
63
|
+
|
|
64
|
+
## Type Parameters
|
|
65
|
+
|
|
66
|
+
### T
|
|
67
|
+
|
|
68
|
+
`T`
|
|
69
|
+
|
|
70
|
+
### C
|
|
71
|
+
|
|
72
|
+
`C` *extends* [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\> = [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>
|
|
73
|
+
|
|
74
|
+
## Constructors
|
|
75
|
+
|
|
76
|
+
### Constructor
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
protected new BaseWrapper<T, C>(value, config?): BaseWrapper<T, C>;
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Parameters
|
|
83
|
+
|
|
84
|
+
#### value
|
|
85
|
+
|
|
86
|
+
`T`
|
|
87
|
+
|
|
88
|
+
#### config?
|
|
89
|
+
|
|
90
|
+
`Partial`\<`C`\>
|
|
91
|
+
|
|
92
|
+
### Returns
|
|
93
|
+
|
|
94
|
+
`BaseWrapper`\<`T`, `C`\>
|
|
95
|
+
|
|
96
|
+
## Properties
|
|
97
|
+
|
|
98
|
+
### config
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
protected readonly config: Partial<C>;
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
***
|
|
105
|
+
|
|
106
|
+
### value
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
protected readonly value: T;
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Accessors
|
|
113
|
+
|
|
114
|
+
### provider
|
|
115
|
+
|
|
116
|
+
### Get Signature
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
get provider(): undefined | XyoConnection;
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
#### Returns
|
|
123
|
+
|
|
124
|
+
`undefined` \| `XyoConnection`
|
|
125
|
+
|
|
126
|
+
## Methods
|
|
127
|
+
|
|
128
|
+
### create()
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
static create<T, C>(value, config?): Promise<BaseWrapper<T, BaseWrapperConfig<T>>>;
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Type Parameters
|
|
135
|
+
|
|
136
|
+
#### T
|
|
137
|
+
|
|
138
|
+
`T`
|
|
139
|
+
|
|
140
|
+
#### C
|
|
141
|
+
|
|
142
|
+
`C` *extends* [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\> = [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
#### value
|
|
147
|
+
|
|
148
|
+
`T`
|
|
149
|
+
|
|
150
|
+
#### config?
|
|
151
|
+
|
|
152
|
+
`Partial`\<`C`\>
|
|
153
|
+
|
|
154
|
+
### Returns
|
|
155
|
+
|
|
156
|
+
`Promise`\<`BaseWrapper`\<`T`, [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>\>\>
|
|
157
|
+
|
|
158
|
+
***
|
|
159
|
+
|
|
160
|
+
### validateConfig()
|
|
161
|
+
|
|
162
|
+
```ts
|
|
163
|
+
static validateConfig(_config): PromisableArray<Error>;
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Parameters
|
|
167
|
+
|
|
168
|
+
#### \_config
|
|
169
|
+
|
|
170
|
+
`unknown`
|
|
171
|
+
|
|
172
|
+
### Returns
|
|
173
|
+
|
|
174
|
+
`PromisableArray`\<`Error`\>
|
|
175
|
+
|
|
176
|
+
***
|
|
177
|
+
|
|
178
|
+
### validateValue()
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
static validateValue(_value): PromisableArray<Error>;
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Parameters
|
|
185
|
+
|
|
186
|
+
#### \_value
|
|
187
|
+
|
|
188
|
+
`unknown`
|
|
189
|
+
|
|
190
|
+
### Returns
|
|
191
|
+
|
|
192
|
+
`PromisableArray`\<`Error`\>
|
|
193
|
+
|
|
194
|
+
***
|
|
195
|
+
|
|
196
|
+
### validate()
|
|
197
|
+
|
|
198
|
+
```ts
|
|
199
|
+
validate(): PromisableArray<Error>;
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Returns
|
|
203
|
+
|
|
204
|
+
`PromisableArray`\<`Error`\>
|
|
205
|
+
|
|
206
|
+
### <a id="ChainWrapper"></a>ChainWrapper
|
|
207
|
+
|
|
208
|
+
[**@xyo-network/chain-wrappers**](#../README)
|
|
209
|
+
|
|
210
|
+
***
|
|
211
|
+
|
|
212
|
+
## Extends
|
|
213
|
+
|
|
214
|
+
- [`BaseWrapper`](#BaseWrapper)\<`Address`, [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`Address`\>\>
|
|
215
|
+
|
|
216
|
+
## Constructors
|
|
217
|
+
|
|
218
|
+
### Constructor
|
|
219
|
+
|
|
220
|
+
```ts
|
|
221
|
+
protected new ChainWrapper(value, config?): ChainWrapper;
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Parameters
|
|
225
|
+
|
|
226
|
+
#### value
|
|
227
|
+
|
|
228
|
+
`Brand`
|
|
229
|
+
|
|
230
|
+
#### config?
|
|
231
|
+
|
|
232
|
+
`Partial`\<[`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
233
|
+
\}\>, \{
|
|
234
|
+
\}\>\>\>
|
|
235
|
+
|
|
236
|
+
### Returns
|
|
237
|
+
|
|
238
|
+
`ChainWrapper`
|
|
239
|
+
|
|
240
|
+
### Inherited from
|
|
241
|
+
|
|
242
|
+
[`BaseWrapper`](#BaseWrapper).[`constructor`](BaseWrapper.md#constructor)
|
|
243
|
+
|
|
244
|
+
## Properties
|
|
245
|
+
|
|
246
|
+
### config
|
|
247
|
+
|
|
248
|
+
```ts
|
|
249
|
+
protected readonly config: Partial<C>;
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Inherited from
|
|
253
|
+
|
|
254
|
+
[`BaseWrapper`](#BaseWrapper).[`config`](BaseWrapper.md#config)
|
|
255
|
+
|
|
256
|
+
***
|
|
257
|
+
|
|
258
|
+
### value
|
|
259
|
+
|
|
260
|
+
```ts
|
|
261
|
+
protected readonly value: Brand;
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Inherited from
|
|
265
|
+
|
|
266
|
+
[`BaseWrapper`](#BaseWrapper).[`value`](BaseWrapper.md#value)
|
|
267
|
+
|
|
268
|
+
## Accessors
|
|
269
|
+
|
|
270
|
+
### provider
|
|
271
|
+
|
|
272
|
+
### Get Signature
|
|
273
|
+
|
|
274
|
+
```ts
|
|
275
|
+
get provider(): undefined | XyoConnection;
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
#### Returns
|
|
279
|
+
|
|
280
|
+
`undefined` \| `XyoConnection`
|
|
281
|
+
|
|
282
|
+
### Inherited from
|
|
283
|
+
|
|
284
|
+
[`BaseWrapper`](#BaseWrapper).[`provider`](BaseWrapper.md#provider)
|
|
285
|
+
|
|
286
|
+
***
|
|
287
|
+
|
|
288
|
+
### id
|
|
289
|
+
|
|
290
|
+
### Get Signature
|
|
291
|
+
|
|
292
|
+
```ts
|
|
293
|
+
get id(): Brand;
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
#### Returns
|
|
297
|
+
|
|
298
|
+
`Brand`
|
|
299
|
+
|
|
300
|
+
## Methods
|
|
301
|
+
|
|
302
|
+
### create()
|
|
303
|
+
|
|
304
|
+
```ts
|
|
305
|
+
static create<T, C>(value, config?): Promise<BaseWrapper<T, BaseWrapperConfig<T>>>;
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
### Type Parameters
|
|
309
|
+
|
|
310
|
+
#### T
|
|
311
|
+
|
|
312
|
+
`T`
|
|
313
|
+
|
|
314
|
+
#### C
|
|
315
|
+
|
|
316
|
+
`C` *extends* [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\> = [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
#### value
|
|
321
|
+
|
|
322
|
+
`T`
|
|
323
|
+
|
|
324
|
+
#### config?
|
|
325
|
+
|
|
326
|
+
`Partial`\<`C`\>
|
|
327
|
+
|
|
328
|
+
### Returns
|
|
329
|
+
|
|
330
|
+
`Promise`\<[`BaseWrapper`](#BaseWrapper)\<`T`, [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>\>\>
|
|
331
|
+
|
|
332
|
+
### Inherited from
|
|
333
|
+
|
|
334
|
+
[`BaseWrapper`](#BaseWrapper).[`create`](BaseWrapper.md#create)
|
|
335
|
+
|
|
336
|
+
***
|
|
337
|
+
|
|
338
|
+
### validateConfig()
|
|
339
|
+
|
|
340
|
+
```ts
|
|
341
|
+
static validateConfig(_config): PromisableArray<Error>;
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
#### \_config
|
|
347
|
+
|
|
348
|
+
`unknown`
|
|
349
|
+
|
|
350
|
+
### Returns
|
|
351
|
+
|
|
352
|
+
`PromisableArray`\<`Error`\>
|
|
353
|
+
|
|
354
|
+
### Inherited from
|
|
355
|
+
|
|
356
|
+
[`BaseWrapper`](#BaseWrapper).[`validateConfig`](BaseWrapper.md#validateconfig)
|
|
357
|
+
|
|
358
|
+
***
|
|
359
|
+
|
|
360
|
+
### validateValue()
|
|
361
|
+
|
|
362
|
+
```ts
|
|
363
|
+
static validateValue(_value): PromisableArray<Error>;
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Parameters
|
|
367
|
+
|
|
368
|
+
#### \_value
|
|
369
|
+
|
|
370
|
+
`unknown`
|
|
371
|
+
|
|
372
|
+
### Returns
|
|
373
|
+
|
|
374
|
+
`PromisableArray`\<`Error`\>
|
|
375
|
+
|
|
376
|
+
### Inherited from
|
|
377
|
+
|
|
378
|
+
[`BaseWrapper`](#BaseWrapper).[`validateValue`](BaseWrapper.md#validatevalue)
|
|
379
|
+
|
|
380
|
+
***
|
|
381
|
+
|
|
382
|
+
### validate()
|
|
383
|
+
|
|
384
|
+
```ts
|
|
385
|
+
validate(): PromisableArray<Error>;
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
### Returns
|
|
389
|
+
|
|
390
|
+
`PromisableArray`\<`Error`\>
|
|
391
|
+
|
|
392
|
+
### Inherited from
|
|
393
|
+
|
|
394
|
+
[`BaseWrapper`](#BaseWrapper).[`validate`](BaseWrapper.md#validate)
|
|
395
|
+
|
|
50
396
|
### <a id="FeesWrapper"></a>FeesWrapper
|
|
51
397
|
|
|
52
398
|
[**@xyo-network/chain-wrappers**](#../README)
|
|
@@ -228,7 +574,7 @@ protected allPayloadsCache: WithHashStorageMeta<WithHashStorageMeta<T[1][number]
|
|
|
228
574
|
### transactionsCache
|
|
229
575
|
|
|
230
576
|
```ts
|
|
231
|
-
protected transactionsCache: HydratedTransactionInstance<
|
|
577
|
+
protected transactionsCache: HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[] = [];
|
|
232
578
|
```
|
|
233
579
|
|
|
234
580
|
## Accessors
|
|
@@ -272,12 +618,26 @@ HydratedBlockInstance.boundWitness
|
|
|
272
618
|
### Get Signature
|
|
273
619
|
|
|
274
620
|
```ts
|
|
275
|
-
get chain():
|
|
621
|
+
get chain(): Brand;
|
|
276
622
|
```
|
|
277
623
|
|
|
278
624
|
#### Returns
|
|
279
625
|
|
|
280
|
-
`
|
|
626
|
+
`Brand`
|
|
627
|
+
|
|
628
|
+
***
|
|
629
|
+
|
|
630
|
+
### parseErrors
|
|
631
|
+
|
|
632
|
+
### Get Signature
|
|
633
|
+
|
|
634
|
+
```ts
|
|
635
|
+
get parseErrors(): Error[];
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
#### Returns
|
|
639
|
+
|
|
640
|
+
`Error`[]
|
|
281
641
|
|
|
282
642
|
***
|
|
283
643
|
|
|
@@ -386,12 +746,16 @@ HydratedBlockInstance.signatures
|
|
|
386
746
|
### Get Signature
|
|
387
747
|
|
|
388
748
|
```ts
|
|
389
|
-
get stepHashes(): Lowercase<string
|
|
749
|
+
get stepHashes(): Brand<Brand<Lowercase<string>, {
|
|
750
|
+
}>, {
|
|
751
|
+
}>[];
|
|
390
752
|
```
|
|
391
753
|
|
|
392
754
|
#### Returns
|
|
393
755
|
|
|
394
|
-
`Lowercase`\<`string
|
|
756
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
757
|
+
\}\>, \{
|
|
758
|
+
\}\>[]
|
|
395
759
|
|
|
396
760
|
***
|
|
397
761
|
|
|
@@ -420,12 +784,12 @@ HydratedBlockInstance.transactionCount
|
|
|
420
784
|
### Get Signature
|
|
421
785
|
|
|
422
786
|
```ts
|
|
423
|
-
get transactions(): HydratedTransactionInstance<
|
|
787
|
+
get transactions(): HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[];
|
|
424
788
|
```
|
|
425
789
|
|
|
426
790
|
#### Returns
|
|
427
791
|
|
|
428
|
-
`HydratedTransactionInstance`\<`
|
|
792
|
+
`HydratedTransactionInstance`\<`HydratedTransactionWithStorageMeta`, `AllowedBlockPayload`\>[]
|
|
429
793
|
|
|
430
794
|
### Implementation of
|
|
431
795
|
|
|
@@ -516,7 +880,7 @@ HydratedBlockInstance.signature
|
|
|
516
880
|
```ts
|
|
517
881
|
transaction(index):
|
|
518
882
|
| undefined
|
|
519
|
-
| HydratedTransactionInstance<
|
|
883
|
+
| HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>;
|
|
520
884
|
```
|
|
521
885
|
|
|
522
886
|
### Parameters
|
|
@@ -528,7 +892,7 @@ transaction(index):
|
|
|
528
892
|
### Returns
|
|
529
893
|
|
|
530
894
|
\| `undefined`
|
|
531
|
-
\| `HydratedTransactionInstance`\<`
|
|
895
|
+
\| `HydratedTransactionInstance`\<`HydratedTransactionWithStorageMeta`, `AllowedBlockPayload`\>
|
|
532
896
|
|
|
533
897
|
### Implementation of
|
|
534
898
|
|
|
@@ -602,7 +966,7 @@ protected parse(validate): Promise<HydratedBlockInstance<[WithHashStorageMeta<T[
|
|
|
602
966
|
|
|
603
967
|
### T
|
|
604
968
|
|
|
605
|
-
`T` *extends* `
|
|
969
|
+
`T` *extends* `HydratedTransactionWithStorageMeta`
|
|
606
970
|
|
|
607
971
|
## Implements
|
|
608
972
|
|
|
@@ -659,7 +1023,7 @@ HydratedTransactionInstance.fees
|
|
|
659
1023
|
### payloadsCache
|
|
660
1024
|
|
|
661
1025
|
```ts
|
|
662
|
-
protected payloadsCache: WithStorageMeta<Payload>[]
|
|
1026
|
+
protected payloadsCache: WithStorageMeta<Payload>[];
|
|
663
1027
|
```
|
|
664
1028
|
|
|
665
1029
|
## Accessors
|
|
@@ -749,12 +1113,20 @@ HydratedTransactionInstance.externalPayloads
|
|
|
749
1113
|
### Get Signature
|
|
750
1114
|
|
|
751
1115
|
```ts
|
|
752
|
-
get from(): Lowercase<string
|
|
1116
|
+
get from(): Brand<Brand<Lowercase<string>, {
|
|
1117
|
+
__hex: true;
|
|
1118
|
+
}>, {
|
|
1119
|
+
__address: true;
|
|
1120
|
+
}>;
|
|
753
1121
|
```
|
|
754
1122
|
|
|
755
1123
|
#### Returns
|
|
756
1124
|
|
|
757
|
-
`Lowercase`\<`string
|
|
1125
|
+
`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1126
|
+
`__hex`: `true`;
|
|
1127
|
+
\}\>, \{
|
|
1128
|
+
`__address`: `true`;
|
|
1129
|
+
\}\>
|
|
758
1130
|
|
|
759
1131
|
***
|
|
760
1132
|
|
|
@@ -881,14 +1253,14 @@ HydratedTransactionInstance.signatures
|
|
|
881
1253
|
### parse()
|
|
882
1254
|
|
|
883
1255
|
```ts
|
|
884
|
-
static parse<T>(transaction, validate): Promise<HydratedTransactionInstance<[T[0], T[1][number][]], AllowedBlockPayload>>;
|
|
1256
|
+
static parse<T>(transaction, validate?): Promise<HydratedTransactionInstance<[T[0], T[1][number][]], AllowedBlockPayload>>;
|
|
885
1257
|
```
|
|
886
1258
|
|
|
887
1259
|
### Type Parameters
|
|
888
1260
|
|
|
889
1261
|
#### T
|
|
890
1262
|
|
|
891
|
-
`T` *extends* `
|
|
1263
|
+
`T` *extends* `HydratedTransactionWithStorageMeta`
|
|
892
1264
|
|
|
893
1265
|
### Parameters
|
|
894
1266
|
|
|
@@ -896,9 +1268,9 @@ static parse<T>(transaction, validate): Promise<HydratedTransactionInstance<[T[0
|
|
|
896
1268
|
|
|
897
1269
|
`T`
|
|
898
1270
|
|
|
899
|
-
#### validate
|
|
1271
|
+
#### validate?
|
|
900
1272
|
|
|
901
|
-
`boolean`
|
|
1273
|
+
`boolean`
|
|
902
1274
|
|
|
903
1275
|
### Returns
|
|
904
1276
|
|
|
@@ -1032,14 +1404,14 @@ HydratedTransactionInstance.validate
|
|
|
1032
1404
|
### parse()
|
|
1033
1405
|
|
|
1034
1406
|
```ts
|
|
1035
|
-
protected parse(validate): Promise<HydratedTransactionInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]], AllowedBlockPayload>>;
|
|
1407
|
+
protected parse(validate?): Promise<HydratedTransactionInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]], AllowedBlockPayload>>;
|
|
1036
1408
|
```
|
|
1037
1409
|
|
|
1038
1410
|
### Parameters
|
|
1039
1411
|
|
|
1040
|
-
#### validate
|
|
1412
|
+
#### validate?
|
|
1041
1413
|
|
|
1042
|
-
`boolean`
|
|
1414
|
+
`boolean`
|
|
1043
1415
|
|
|
1044
1416
|
### Returns
|
|
1045
1417
|
|
|
@@ -1137,12 +1509,20 @@ get numberRange(): [number, number];
|
|
|
1137
1509
|
### Get Signature
|
|
1138
1510
|
|
|
1139
1511
|
```ts
|
|
1140
|
-
get range(): [Lowercase<string>,
|
|
1512
|
+
get range(): [Brand<Brand<Lowercase<string>, {
|
|
1513
|
+
}>, {
|
|
1514
|
+
}>, Brand<Brand<Lowercase<string>, {
|
|
1515
|
+
}>, {
|
|
1516
|
+
}>];
|
|
1141
1517
|
```
|
|
1142
1518
|
|
|
1143
1519
|
#### Returns
|
|
1144
1520
|
|
|
1145
|
-
\[`Lowercase`\<`string`\>,
|
|
1521
|
+
\[`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1522
|
+
\}\>, \{
|
|
1523
|
+
\}\>, `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
|
|
1524
|
+
\}\>, \{
|
|
1525
|
+
\}\>\]
|
|
1146
1526
|
|
|
1147
1527
|
### Implementation of
|
|
1148
1528
|
|
|
@@ -1194,7 +1574,7 @@ fromHash(hash): Promise<undefined | HydratedBlock>;
|
|
|
1194
1574
|
|
|
1195
1575
|
#### hash
|
|
1196
1576
|
|
|
1197
|
-
`
|
|
1577
|
+
`Brand`
|
|
1198
1578
|
|
|
1199
1579
|
### Returns
|
|
1200
1580
|
|
|
@@ -1344,12 +1724,16 @@ prev(from, count): Promise<HydratedBlock[]>;
|
|
|
1344
1724
|
|
|
1345
1725
|
***
|
|
1346
1726
|
|
|
1727
|
+
## Deprecated
|
|
1728
|
+
|
|
1729
|
+
use from @xyo-network/xl1-protocol instead
|
|
1730
|
+
|
|
1347
1731
|
## Constructors
|
|
1348
1732
|
|
|
1349
1733
|
### Constructor
|
|
1350
1734
|
|
|
1351
1735
|
```ts
|
|
1352
|
-
new ShiftedBigInt(value, config): ShiftedBigInt;
|
|
1736
|
+
new ShiftedBigInt(value, config?): ShiftedBigInt;
|
|
1353
1737
|
```
|
|
1354
1738
|
|
|
1355
1739
|
### Parameters
|
|
@@ -1358,9 +1742,9 @@ new ShiftedBigInt(value, config): ShiftedBigInt;
|
|
|
1358
1742
|
|
|
1359
1743
|
`bigint` | `ShiftedBigInt`
|
|
1360
1744
|
|
|
1361
|
-
#### config
|
|
1745
|
+
#### config?
|
|
1362
1746
|
|
|
1363
|
-
`Partial`\<`ShiftedBigIntConfig`\>
|
|
1747
|
+
`Partial`\<`ShiftedBigIntConfig`\>
|
|
1364
1748
|
|
|
1365
1749
|
### Returns
|
|
1366
1750
|
|
|
@@ -1368,7 +1752,7 @@ new ShiftedBigInt(value, config): ShiftedBigInt;
|
|
|
1368
1752
|
|
|
1369
1753
|
## Properties
|
|
1370
1754
|
|
|
1371
|
-
### defaultConfig
|
|
1755
|
+
### ~~defaultConfig~~
|
|
1372
1756
|
|
|
1373
1757
|
```ts
|
|
1374
1758
|
readonly static defaultConfig: ShiftedBigIntConfig;
|
|
@@ -1376,7 +1760,7 @@ readonly static defaultConfig: ShiftedBigIntConfig;
|
|
|
1376
1760
|
|
|
1377
1761
|
***
|
|
1378
1762
|
|
|
1379
|
-
### config
|
|
1763
|
+
### ~~config~~
|
|
1380
1764
|
|
|
1381
1765
|
```ts
|
|
1382
1766
|
config: ShiftedBigIntConfig;
|
|
@@ -1384,7 +1768,7 @@ config: ShiftedBigIntConfig;
|
|
|
1384
1768
|
|
|
1385
1769
|
***
|
|
1386
1770
|
|
|
1387
|
-
### value
|
|
1771
|
+
### ~~value~~
|
|
1388
1772
|
|
|
1389
1773
|
```ts
|
|
1390
1774
|
value: bigint;
|
|
@@ -1392,7 +1776,7 @@ value: bigint;
|
|
|
1392
1776
|
|
|
1393
1777
|
## Accessors
|
|
1394
1778
|
|
|
1395
|
-
### locale
|
|
1779
|
+
### ~~locale~~
|
|
1396
1780
|
|
|
1397
1781
|
### Get Signature
|
|
1398
1782
|
|
|
@@ -1406,7 +1790,7 @@ get locale(): LocalesArgument;
|
|
|
1406
1790
|
|
|
1407
1791
|
***
|
|
1408
1792
|
|
|
1409
|
-
### maxCharacters
|
|
1793
|
+
### ~~maxCharacters~~
|
|
1410
1794
|
|
|
1411
1795
|
### Get Signature
|
|
1412
1796
|
|
|
@@ -1420,7 +1804,7 @@ get maxCharacters(): number;
|
|
|
1420
1804
|
|
|
1421
1805
|
***
|
|
1422
1806
|
|
|
1423
|
-
### maxDecimal
|
|
1807
|
+
### ~~maxDecimal~~
|
|
1424
1808
|
|
|
1425
1809
|
### Get Signature
|
|
1426
1810
|
|
|
@@ -1434,7 +1818,7 @@ get maxDecimal(): number;
|
|
|
1434
1818
|
|
|
1435
1819
|
***
|
|
1436
1820
|
|
|
1437
|
-
### minDecimals
|
|
1821
|
+
### ~~minDecimals~~
|
|
1438
1822
|
|
|
1439
1823
|
### Get Signature
|
|
1440
1824
|
|
|
@@ -1448,7 +1832,7 @@ get minDecimals(): number;
|
|
|
1448
1832
|
|
|
1449
1833
|
***
|
|
1450
1834
|
|
|
1451
|
-
### places
|
|
1835
|
+
### ~~places~~
|
|
1452
1836
|
|
|
1453
1837
|
### Get Signature
|
|
1454
1838
|
|
|
@@ -1462,7 +1846,7 @@ get places(): number;
|
|
|
1462
1846
|
|
|
1463
1847
|
## Methods
|
|
1464
1848
|
|
|
1465
|
-
### toFullString()
|
|
1849
|
+
### ~~toFullString()~~
|
|
1466
1850
|
|
|
1467
1851
|
```ts
|
|
1468
1852
|
toFullString(): string;
|
|
@@ -1474,7 +1858,7 @@ toFullString(): string;
|
|
|
1474
1858
|
|
|
1475
1859
|
***
|
|
1476
1860
|
|
|
1477
|
-
### toShortString()
|
|
1861
|
+
### ~~toShortString()~~
|
|
1478
1862
|
|
|
1479
1863
|
```ts
|
|
1480
1864
|
toShortString(): string;
|
|
@@ -1486,7 +1870,7 @@ toShortString(): string;
|
|
|
1486
1870
|
|
|
1487
1871
|
***
|
|
1488
1872
|
|
|
1489
|
-
### toString()
|
|
1873
|
+
### ~~toString()~~
|
|
1490
1874
|
|
|
1491
1875
|
```ts
|
|
1492
1876
|
toString(): string;
|
|
@@ -1521,15 +1905,15 @@ new SignatureWrapper(
|
|
|
1521
1905
|
|
|
1522
1906
|
#### signature
|
|
1523
1907
|
|
|
1524
|
-
`
|
|
1908
|
+
`Brand`
|
|
1525
1909
|
|
|
1526
1910
|
#### address
|
|
1527
1911
|
|
|
1528
|
-
`
|
|
1912
|
+
`Brand`
|
|
1529
1913
|
|
|
1530
1914
|
#### hash
|
|
1531
1915
|
|
|
1532
|
-
`
|
|
1916
|
+
`Brand`
|
|
1533
1917
|
|
|
1534
1918
|
### Returns
|
|
1535
1919
|
|
|
@@ -1540,7 +1924,7 @@ new SignatureWrapper(
|
|
|
1540
1924
|
### address
|
|
1541
1925
|
|
|
1542
1926
|
```ts
|
|
1543
|
-
address:
|
|
1927
|
+
address: Brand;
|
|
1544
1928
|
```
|
|
1545
1929
|
|
|
1546
1930
|
### Implementation of
|
|
@@ -1554,7 +1938,7 @@ SignatureInstance.address
|
|
|
1554
1938
|
### hash
|
|
1555
1939
|
|
|
1556
1940
|
```ts
|
|
1557
|
-
hash:
|
|
1941
|
+
hash: Brand;
|
|
1558
1942
|
```
|
|
1559
1943
|
|
|
1560
1944
|
### Implementation of
|
|
@@ -1568,7 +1952,7 @@ SignatureInstance.hash
|
|
|
1568
1952
|
### signature
|
|
1569
1953
|
|
|
1570
1954
|
```ts
|
|
1571
|
-
signature:
|
|
1955
|
+
signature: Brand;
|
|
1572
1956
|
```
|
|
1573
1957
|
|
|
1574
1958
|
### Implementation of
|
|
@@ -1592,15 +1976,15 @@ signature): Promise<Error[]>;
|
|
|
1592
1976
|
|
|
1593
1977
|
#### hash
|
|
1594
1978
|
|
|
1595
|
-
`
|
|
1979
|
+
`Brand`
|
|
1596
1980
|
|
|
1597
1981
|
#### address
|
|
1598
1982
|
|
|
1599
|
-
`
|
|
1983
|
+
`Brand`
|
|
1600
1984
|
|
|
1601
1985
|
#### signature
|
|
1602
1986
|
|
|
1603
|
-
`
|
|
1987
|
+
`Brand`
|
|
1604
1988
|
|
|
1605
1989
|
### Returns
|
|
1606
1990
|
|
|
@@ -1630,6 +2014,10 @@ SignatureInstance.validate
|
|
|
1630
2014
|
|
|
1631
2015
|
***
|
|
1632
2016
|
|
|
2017
|
+
## Deprecated
|
|
2018
|
+
|
|
2019
|
+
use from @xyo-network/xl1-protocol instead
|
|
2020
|
+
|
|
1633
2021
|
## Implements
|
|
1634
2022
|
|
|
1635
2023
|
- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance)
|
|
@@ -1639,7 +2027,7 @@ SignatureInstance.validate
|
|
|
1639
2027
|
### Constructor
|
|
1640
2028
|
|
|
1641
2029
|
```ts
|
|
1642
|
-
new XL1Amount(value, locale): XL1Amount;
|
|
2030
|
+
new XL1Amount(value, locale?): XL1Amount;
|
|
1643
2031
|
```
|
|
1644
2032
|
|
|
1645
2033
|
### Parameters
|
|
@@ -1648,9 +2036,9 @@ new XL1Amount(value, locale): XL1Amount;
|
|
|
1648
2036
|
|
|
1649
2037
|
`bigint`
|
|
1650
2038
|
|
|
1651
|
-
#### locale
|
|
2039
|
+
#### locale?
|
|
1652
2040
|
|
|
1653
|
-
`LocalesArgument`
|
|
2041
|
+
`LocalesArgument`
|
|
1654
2042
|
|
|
1655
2043
|
### Returns
|
|
1656
2044
|
|
|
@@ -1658,7 +2046,7 @@ new XL1Amount(value, locale): XL1Amount;
|
|
|
1658
2046
|
|
|
1659
2047
|
## Properties
|
|
1660
2048
|
|
|
1661
|
-
### value
|
|
2049
|
+
### ~~value~~
|
|
1662
2050
|
|
|
1663
2051
|
```ts
|
|
1664
2052
|
value: AttoXL1;
|
|
@@ -1670,7 +2058,7 @@ value: AttoXL1;
|
|
|
1670
2058
|
|
|
1671
2059
|
## Accessors
|
|
1672
2060
|
|
|
1673
|
-
### milli
|
|
2061
|
+
### ~~milli~~
|
|
1674
2062
|
|
|
1675
2063
|
### Get Signature
|
|
1676
2064
|
|
|
@@ -1688,7 +2076,7 @@ get milli(): MilliXL1;
|
|
|
1688
2076
|
|
|
1689
2077
|
***
|
|
1690
2078
|
|
|
1691
|
-
### micro
|
|
2079
|
+
### ~~micro~~
|
|
1692
2080
|
|
|
1693
2081
|
### Get Signature
|
|
1694
2082
|
|
|
@@ -1706,7 +2094,7 @@ get micro(): MicroXL1;
|
|
|
1706
2094
|
|
|
1707
2095
|
***
|
|
1708
2096
|
|
|
1709
|
-
### nano
|
|
2097
|
+
### ~~nano~~
|
|
1710
2098
|
|
|
1711
2099
|
### Get Signature
|
|
1712
2100
|
|
|
@@ -1724,7 +2112,7 @@ get nano(): NanoXL1;
|
|
|
1724
2112
|
|
|
1725
2113
|
***
|
|
1726
2114
|
|
|
1727
|
-
### pico
|
|
2115
|
+
### ~~pico~~
|
|
1728
2116
|
|
|
1729
2117
|
### Get Signature
|
|
1730
2118
|
|
|
@@ -1742,7 +2130,7 @@ get pico(): PicoXL1;
|
|
|
1742
2130
|
|
|
1743
2131
|
***
|
|
1744
2132
|
|
|
1745
|
-
### femto
|
|
2133
|
+
### ~~femto~~
|
|
1746
2134
|
|
|
1747
2135
|
### Get Signature
|
|
1748
2136
|
|
|
@@ -1760,7 +2148,7 @@ get femto(): FemtoXL1;
|
|
|
1760
2148
|
|
|
1761
2149
|
***
|
|
1762
2150
|
|
|
1763
|
-
### atto
|
|
2151
|
+
### ~~atto~~
|
|
1764
2152
|
|
|
1765
2153
|
### Get Signature
|
|
1766
2154
|
|
|
@@ -1778,10 +2166,10 @@ get atto(): AttoXL1;
|
|
|
1778
2166
|
|
|
1779
2167
|
## Methods
|
|
1780
2168
|
|
|
1781
|
-
### from()
|
|
2169
|
+
### ~~from()~~
|
|
1782
2170
|
|
|
1783
2171
|
```ts
|
|
1784
|
-
static from(value, places): XL1Amount;
|
|
2172
|
+
static from(value, places?): XL1Amount;
|
|
1785
2173
|
```
|
|
1786
2174
|
|
|
1787
2175
|
### Parameters
|
|
@@ -1790,9 +2178,9 @@ static from(value, places): XL1Amount;
|
|
|
1790
2178
|
|
|
1791
2179
|
`bigint`
|
|
1792
2180
|
|
|
1793
|
-
#### places
|
|
2181
|
+
#### places?
|
|
1794
2182
|
|
|
1795
|
-
`bigint`
|
|
2183
|
+
`bigint`
|
|
1796
2184
|
|
|
1797
2185
|
### Returns
|
|
1798
2186
|
|
|
@@ -1800,7 +2188,7 @@ static from(value, places): XL1Amount;
|
|
|
1800
2188
|
|
|
1801
2189
|
***
|
|
1802
2190
|
|
|
1803
|
-
### fromMilli()
|
|
2191
|
+
### ~~fromMilli()~~
|
|
1804
2192
|
|
|
1805
2193
|
```ts
|
|
1806
2194
|
static fromMilli(value): XL1Amount;
|
|
@@ -1818,7 +2206,7 @@ static fromMilli(value): XL1Amount;
|
|
|
1818
2206
|
|
|
1819
2207
|
***
|
|
1820
2208
|
|
|
1821
|
-
### fromMicro()
|
|
2209
|
+
### ~~fromMicro()~~
|
|
1822
2210
|
|
|
1823
2211
|
```ts
|
|
1824
2212
|
static fromMicro(value): XL1Amount;
|
|
@@ -1836,7 +2224,7 @@ static fromMicro(value): XL1Amount;
|
|
|
1836
2224
|
|
|
1837
2225
|
***
|
|
1838
2226
|
|
|
1839
|
-
### fromNano()
|
|
2227
|
+
### ~~fromNano()~~
|
|
1840
2228
|
|
|
1841
2229
|
```ts
|
|
1842
2230
|
static fromNano(value): XL1Amount;
|
|
@@ -1854,7 +2242,7 @@ static fromNano(value): XL1Amount;
|
|
|
1854
2242
|
|
|
1855
2243
|
***
|
|
1856
2244
|
|
|
1857
|
-
### fromPico()
|
|
2245
|
+
### ~~fromPico()~~
|
|
1858
2246
|
|
|
1859
2247
|
```ts
|
|
1860
2248
|
static fromPico(value): XL1Amount;
|
|
@@ -1872,7 +2260,7 @@ static fromPico(value): XL1Amount;
|
|
|
1872
2260
|
|
|
1873
2261
|
***
|
|
1874
2262
|
|
|
1875
|
-
### fromFemto()
|
|
2263
|
+
### ~~fromFemto()~~
|
|
1876
2264
|
|
|
1877
2265
|
```ts
|
|
1878
2266
|
static fromFemto(value): XL1Amount;
|
|
@@ -1890,7 +2278,7 @@ static fromFemto(value): XL1Amount;
|
|
|
1890
2278
|
|
|
1891
2279
|
***
|
|
1892
2280
|
|
|
1893
|
-
### fromAtto()
|
|
2281
|
+
### ~~fromAtto()~~
|
|
1894
2282
|
|
|
1895
2283
|
```ts
|
|
1896
2284
|
static fromAtto(value): XL1Amount;
|
|
@@ -1908,15 +2296,15 @@ static fromAtto(value): XL1Amount;
|
|
|
1908
2296
|
|
|
1909
2297
|
***
|
|
1910
2298
|
|
|
1911
|
-
### to()
|
|
2299
|
+
### ~~to()~~
|
|
1912
2300
|
|
|
1913
2301
|
```ts
|
|
1914
|
-
to(places): bigint;
|
|
2302
|
+
to(places?): bigint;
|
|
1915
2303
|
```
|
|
1916
2304
|
|
|
1917
2305
|
### Parameters
|
|
1918
2306
|
|
|
1919
|
-
#### places
|
|
2307
|
+
#### places?
|
|
1920
2308
|
|
|
1921
2309
|
`number` | `bigint`
|
|
1922
2310
|
|
|
@@ -1930,21 +2318,21 @@ to(places): bigint;
|
|
|
1930
2318
|
|
|
1931
2319
|
***
|
|
1932
2320
|
|
|
1933
|
-
### toString()
|
|
2321
|
+
### ~~toString()~~
|
|
1934
2322
|
|
|
1935
2323
|
```ts
|
|
1936
|
-
toString(places
|
|
2324
|
+
toString(places?, config?): string;
|
|
1937
2325
|
```
|
|
1938
2326
|
|
|
1939
2327
|
### Parameters
|
|
1940
2328
|
|
|
1941
|
-
#### places
|
|
2329
|
+
#### places?
|
|
1942
2330
|
|
|
1943
|
-
`number`
|
|
2331
|
+
`number`
|
|
1944
2332
|
|
|
1945
|
-
#### config
|
|
2333
|
+
#### config?
|
|
1946
2334
|
|
|
1947
|
-
`Partial`\<`ShiftedBigIntConfig`\>
|
|
2335
|
+
`Partial`\<`ShiftedBigIntConfig`\>
|
|
1948
2336
|
|
|
1949
2337
|
### Returns
|
|
1950
2338
|
|
|
@@ -1954,79 +2342,35 @@ toString(places, config): string;
|
|
|
1954
2342
|
|
|
1955
2343
|
[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`toString`](../interfaces/XL1AmountInstance.md#tostring)
|
|
1956
2344
|
|
|
1957
|
-
###
|
|
2345
|
+
### interfaces
|
|
1958
2346
|
|
|
1959
|
-
### <a id="
|
|
2347
|
+
### <a id="BaseWrapperConfig"></a>BaseWrapperConfig
|
|
1960
2348
|
|
|
1961
2349
|
[**@xyo-network/chain-wrappers**](#../README)
|
|
1962
2350
|
|
|
1963
2351
|
***
|
|
1964
2352
|
|
|
1965
|
-
|
|
1966
|
-
function splitOnDecimal(value, places): [bigint, bigint];
|
|
1967
|
-
```
|
|
1968
|
-
|
|
1969
|
-
## Parameters
|
|
1970
|
-
|
|
1971
|
-
### value
|
|
1972
|
-
|
|
1973
|
-
`bigint`
|
|
1974
|
-
|
|
1975
|
-
### places
|
|
1976
|
-
|
|
1977
|
-
`number` = `18`
|
|
1978
|
-
|
|
1979
|
-
## Returns
|
|
2353
|
+
## Type Parameters
|
|
1980
2354
|
|
|
1981
|
-
|
|
2355
|
+
### T
|
|
1982
2356
|
|
|
1983
|
-
|
|
2357
|
+
`T`
|
|
1984
2358
|
|
|
1985
|
-
|
|
2359
|
+
## Properties
|
|
1986
2360
|
|
|
1987
|
-
|
|
2361
|
+
### provider
|
|
1988
2362
|
|
|
1989
2363
|
```ts
|
|
1990
|
-
|
|
1991
|
-
value,
|
|
1992
|
-
places,
|
|
1993
|
-
maxDecimal,
|
|
1994
|
-
maxCharacters,
|
|
1995
|
-
minDecimals,
|
|
1996
|
-
locale): string;
|
|
2364
|
+
provider: XyoConnection;
|
|
1997
2365
|
```
|
|
1998
2366
|
|
|
1999
|
-
|
|
2367
|
+
***
|
|
2000
2368
|
|
|
2001
2369
|
### value
|
|
2002
2370
|
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
`number` = `18`
|
|
2008
|
-
|
|
2009
|
-
### maxDecimal
|
|
2010
|
-
|
|
2011
|
-
`number` = `places`
|
|
2012
|
-
|
|
2013
|
-
### maxCharacters
|
|
2014
|
-
|
|
2015
|
-
`number` = `9`
|
|
2016
|
-
|
|
2017
|
-
### minDecimals
|
|
2018
|
-
|
|
2019
|
-
`number` = `1`
|
|
2020
|
-
|
|
2021
|
-
### locale
|
|
2022
|
-
|
|
2023
|
-
`LocalesArgument` = `'en-US'`
|
|
2024
|
-
|
|
2025
|
-
## Returns
|
|
2026
|
-
|
|
2027
|
-
`string`
|
|
2028
|
-
|
|
2029
|
-
### interfaces
|
|
2371
|
+
```ts
|
|
2372
|
+
value: T;
|
|
2373
|
+
```
|
|
2030
2374
|
|
|
2031
2375
|
### <a id="HydratedBlockRangeStoreParams"></a>HydratedBlockRangeStoreParams
|
|
2032
2376
|
|
|
@@ -2061,7 +2405,7 @@ HydratedBlockStoreParams.sourceArchivist
|
|
|
2061
2405
|
### first
|
|
2062
2406
|
|
|
2063
2407
|
```ts
|
|
2064
|
-
first:
|
|
2408
|
+
first: Brand;
|
|
2065
2409
|
```
|
|
2066
2410
|
|
|
2067
2411
|
### Inherited from
|
|
@@ -2075,7 +2419,7 @@ HydratedBlockStoreParams.first
|
|
|
2075
2419
|
### last
|
|
2076
2420
|
|
|
2077
2421
|
```ts
|
|
2078
|
-
last:
|
|
2422
|
+
last: Brand;
|
|
2079
2423
|
```
|
|
2080
2424
|
|
|
2081
2425
|
### Inherited from
|
|
@@ -2120,7 +2464,7 @@ fromHash(hash): Promisable<undefined | HydratedBlock>;
|
|
|
2120
2464
|
|
|
2121
2465
|
#### hash
|
|
2122
2466
|
|
|
2123
|
-
`
|
|
2467
|
+
`Brand`
|
|
2124
2468
|
|
|
2125
2469
|
### Returns
|
|
2126
2470
|
|
|
@@ -2169,7 +2513,11 @@ BlockWindowInstance.numberRange
|
|
|
2169
2513
|
### range
|
|
2170
2514
|
|
|
2171
2515
|
```ts
|
|
2172
|
-
range: [Lowercase<string>,
|
|
2516
|
+
range: [Brand<Brand<Lowercase<string>, {
|
|
2517
|
+
}>, {
|
|
2518
|
+
}>, Brand<Brand<Lowercase<string>, {
|
|
2519
|
+
}>, {
|
|
2520
|
+
}>];
|
|
2173
2521
|
```
|
|
2174
2522
|
|
|
2175
2523
|
### Inherited from
|
|
@@ -2190,7 +2538,7 @@ fromHash(hash): Promisable<undefined | HydratedBlock>;
|
|
|
2190
2538
|
|
|
2191
2539
|
#### hash
|
|
2192
2540
|
|
|
2193
|
-
`
|
|
2541
|
+
`Brand`
|
|
2194
2542
|
|
|
2195
2543
|
### Returns
|
|
2196
2544
|
|
|
@@ -2352,7 +2700,7 @@ fromHash(hash): Promisable<undefined | HydratedBlock>;
|
|
|
2352
2700
|
|
|
2353
2701
|
#### hash
|
|
2354
2702
|
|
|
2355
|
-
`
|
|
2703
|
+
`Brand`
|
|
2356
2704
|
|
|
2357
2705
|
### Returns
|
|
2358
2706
|
|
|
@@ -2386,9 +2734,13 @@ fromNumber(number): Promisable<undefined | HydratedBlock>;
|
|
|
2386
2734
|
|
|
2387
2735
|
***
|
|
2388
2736
|
|
|
2737
|
+
## Deprecated
|
|
2738
|
+
|
|
2739
|
+
use from @xyo-network/xl1-protocol instead
|
|
2740
|
+
|
|
2389
2741
|
## Properties
|
|
2390
2742
|
|
|
2391
|
-
### value
|
|
2743
|
+
### ~~value~~
|
|
2392
2744
|
|
|
2393
2745
|
```ts
|
|
2394
2746
|
value: AttoXL1;
|
|
@@ -2396,7 +2748,7 @@ value: AttoXL1;
|
|
|
2396
2748
|
|
|
2397
2749
|
***
|
|
2398
2750
|
|
|
2399
|
-
### milli
|
|
2751
|
+
### ~~milli~~
|
|
2400
2752
|
|
|
2401
2753
|
```ts
|
|
2402
2754
|
milli: MilliXL1;
|
|
@@ -2404,7 +2756,7 @@ milli: MilliXL1;
|
|
|
2404
2756
|
|
|
2405
2757
|
***
|
|
2406
2758
|
|
|
2407
|
-
### micro
|
|
2759
|
+
### ~~micro~~
|
|
2408
2760
|
|
|
2409
2761
|
```ts
|
|
2410
2762
|
micro: MicroXL1;
|
|
@@ -2412,7 +2764,7 @@ micro: MicroXL1;
|
|
|
2412
2764
|
|
|
2413
2765
|
***
|
|
2414
2766
|
|
|
2415
|
-
### nano
|
|
2767
|
+
### ~~nano~~
|
|
2416
2768
|
|
|
2417
2769
|
```ts
|
|
2418
2770
|
nano: NanoXL1;
|
|
@@ -2420,7 +2772,7 @@ nano: NanoXL1;
|
|
|
2420
2772
|
|
|
2421
2773
|
***
|
|
2422
2774
|
|
|
2423
|
-
### pico
|
|
2775
|
+
### ~~pico~~
|
|
2424
2776
|
|
|
2425
2777
|
```ts
|
|
2426
2778
|
pico: PicoXL1;
|
|
@@ -2428,7 +2780,7 @@ pico: PicoXL1;
|
|
|
2428
2780
|
|
|
2429
2781
|
***
|
|
2430
2782
|
|
|
2431
|
-
### femto
|
|
2783
|
+
### ~~femto~~
|
|
2432
2784
|
|
|
2433
2785
|
```ts
|
|
2434
2786
|
femto: FemtoXL1;
|
|
@@ -2436,7 +2788,7 @@ femto: FemtoXL1;
|
|
|
2436
2788
|
|
|
2437
2789
|
***
|
|
2438
2790
|
|
|
2439
|
-
### atto
|
|
2791
|
+
### ~~atto~~
|
|
2440
2792
|
|
|
2441
2793
|
```ts
|
|
2442
2794
|
atto: AttoXL1;
|
|
@@ -2444,7 +2796,7 @@ atto: AttoXL1;
|
|
|
2444
2796
|
|
|
2445
2797
|
## Methods
|
|
2446
2798
|
|
|
2447
|
-
### to()
|
|
2799
|
+
### ~~to()~~
|
|
2448
2800
|
|
|
2449
2801
|
```ts
|
|
2450
2802
|
to(places): bigint;
|
|
@@ -2462,7 +2814,7 @@ to(places): bigint;
|
|
|
2462
2814
|
|
|
2463
2815
|
***
|
|
2464
2816
|
|
|
2465
|
-
### toString()
|
|
2817
|
+
### ~~toString()~~
|
|
2466
2818
|
|
|
2467
2819
|
```ts
|
|
2468
2820
|
toString(places, config): string;
|
|
@@ -2500,6 +2852,100 @@ type HydratedBlockStoreParams<TAdditionalParams> = BaseParams<object & TAddition
|
|
|
2500
2852
|
|
|
2501
2853
|
`TAdditionalParams` *extends* `EmptyObject` = `EmptyObject`
|
|
2502
2854
|
|
|
2855
|
+
### variables
|
|
2856
|
+
|
|
2857
|
+
### <a id="createSignatureWrappers"></a>createSignatureWrappers
|
|
2858
|
+
|
|
2859
|
+
[**@xyo-network/chain-wrappers**](#../README)
|
|
2860
|
+
|
|
2861
|
+
***
|
|
2862
|
+
|
|
2863
|
+
```ts
|
|
2864
|
+
const createSignatureWrappers: (bw) => Promise<SignatureInstance[]>;
|
|
2865
|
+
```
|
|
2866
|
+
|
|
2867
|
+
## Parameters
|
|
2868
|
+
|
|
2869
|
+
### bw
|
|
2870
|
+
|
|
2871
|
+
`BoundWitness`
|
|
2872
|
+
|
|
2873
|
+
## Returns
|
|
2874
|
+
|
|
2875
|
+
`Promise`\<`SignatureInstance`[]\>
|
|
2876
|
+
|
|
2877
|
+
### <a id="splitOnDecimal"></a>splitOnDecimal
|
|
2878
|
+
|
|
2879
|
+
[**@xyo-network/chain-wrappers**](#../README)
|
|
2880
|
+
|
|
2881
|
+
***
|
|
2882
|
+
|
|
2883
|
+
```ts
|
|
2884
|
+
const splitOnDecimal: (value, places?) => [bigint, bigint];
|
|
2885
|
+
```
|
|
2886
|
+
|
|
2887
|
+
## Parameters
|
|
2888
|
+
|
|
2889
|
+
### value
|
|
2890
|
+
|
|
2891
|
+
`bigint`
|
|
2892
|
+
|
|
2893
|
+
### places?
|
|
2894
|
+
|
|
2895
|
+
`number`
|
|
2896
|
+
|
|
2897
|
+
## Returns
|
|
2898
|
+
|
|
2899
|
+
\[`bigint`, `bigint`\]
|
|
2900
|
+
|
|
2901
|
+
## Deprecated
|
|
2902
|
+
|
|
2903
|
+
use from @xyo-network/xl1-protocol instead
|
|
2904
|
+
|
|
2905
|
+
### <a id="splitOnDecimalToString"></a>splitOnDecimalToString
|
|
2906
|
+
|
|
2907
|
+
[**@xyo-network/chain-wrappers**](#../README)
|
|
2908
|
+
|
|
2909
|
+
***
|
|
2910
|
+
|
|
2911
|
+
```ts
|
|
2912
|
+
const splitOnDecimalToString: (value, places?, maxDecimal?, maxCharacters?, minDecimals?, locale?) => string;
|
|
2913
|
+
```
|
|
2914
|
+
|
|
2915
|
+
## Parameters
|
|
2916
|
+
|
|
2917
|
+
### value
|
|
2918
|
+
|
|
2919
|
+
`bigint`
|
|
2920
|
+
|
|
2921
|
+
### places?
|
|
2922
|
+
|
|
2923
|
+
`number`
|
|
2924
|
+
|
|
2925
|
+
### maxDecimal?
|
|
2926
|
+
|
|
2927
|
+
`number`
|
|
2928
|
+
|
|
2929
|
+
### maxCharacters?
|
|
2930
|
+
|
|
2931
|
+
`number`
|
|
2932
|
+
|
|
2933
|
+
### minDecimals?
|
|
2934
|
+
|
|
2935
|
+
`number`
|
|
2936
|
+
|
|
2937
|
+
### locale?
|
|
2938
|
+
|
|
2939
|
+
`Intl.LocalesArgument`
|
|
2940
|
+
|
|
2941
|
+
## Returns
|
|
2942
|
+
|
|
2943
|
+
`string`
|
|
2944
|
+
|
|
2945
|
+
## Deprecated
|
|
2946
|
+
|
|
2947
|
+
use from @xyo-network/xl1-protocol instead
|
|
2948
|
+
|
|
2503
2949
|
|
|
2504
2950
|
## Maintainers
|
|
2505
2951
|
|