@xyo-network/chain-wrappers 1.20.14 → 1.20.16

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
@@ -1,2269 +1,24 @@
1
1
  # @xyo-network/chain-wrappers
2
2
 
3
- [![logo][]](https://xyo.network)
3
+ [![npm][npm-badge]][npm-link]
4
+ [![license][license-badge]][license-link]
4
5
 
5
- [![npm-badge][]][npm-link]
6
- [![npm-downloads-badge][]][npm-link]
7
- [![jsdelivr-badge][]][jsdelivr-link]
8
- [![npm-license-badge][]](LICENSE)
9
- [![socket-badge][]][socket-link]
6
+ > XYO Layer One SDK Wrappers
10
7
 
11
- XYO Layer One SDK Wrappers
8
+ ## Install
12
9
 
13
-
14
-
15
- ## Reference
16
-
17
- **@xyo-network/chain-wrappers**
18
-
19
- ***
20
-
21
- ## Classes
22
-
23
- - [HydratedBlockWrapper](#classes/HydratedBlockWrapper)
24
- - [IndexedHydratedBlockRangeStore](#classes/IndexedHydratedBlockRangeStore)
25
- - [BaseWrapper](#classes/BaseWrapper)
26
- - [FeesWrapper](#classes/FeesWrapper)
27
- - [SignatureWrapper](#classes/SignatureWrapper)
28
- - [ChainWrapper](#classes/ChainWrapper)
29
- - [HydratedTransactionWrapper](#classes/HydratedTransactionWrapper)
30
-
31
- ## Interfaces
32
-
33
- - [HydratedBlockStoreInstance](#interfaces/HydratedBlockStoreInstance)
34
- - [IndexedHydratedBlockStoreInstance](#interfaces/IndexedHydratedBlockStoreInstance)
35
- - [HydratedBlockRangeStoreParams](#interfaces/HydratedBlockRangeStoreParams)
36
- - [IndexedHydratedBlockRangeStoreInstance](#interfaces/IndexedHydratedBlockRangeStoreInstance)
37
- - [BaseWrapperConfig](#interfaces/BaseWrapperConfig)
38
-
39
- ## Type Aliases
40
-
41
- - [HydratedBlockStoreParams](#type-aliases/HydratedBlockStoreParams)
42
-
43
- ## Variables
44
-
45
- - [createSignatureWrappers](#variables/createSignatureWrappers)
46
-
47
- ### classes
48
-
49
- ### <a id="BaseWrapper"></a>BaseWrapper
50
-
51
- [**@xyo-network/chain-wrappers**](#../README)
52
-
53
- ***
54
-
55
- ## Extended by
56
-
57
- - [`ChainWrapper`](#ChainWrapper)
58
-
59
- ## Type Parameters
60
-
61
- ### T
62
-
63
- `T`
64
-
65
- ### C
66
-
67
- `C` *extends* [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\> = [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>
68
-
69
- ## Constructors
70
-
71
- ### Constructor
72
-
73
- ```ts
74
- protected new BaseWrapper<T, C>(value, config?): BaseWrapper<T, C>;
75
- ```
76
-
77
- ### Parameters
78
-
79
- #### value
80
-
81
- `T`
82
-
83
- #### config?
84
-
85
- `Partial`\<`C`\>
86
-
87
- ### Returns
88
-
89
- `BaseWrapper`\<`T`, `C`\>
90
-
91
- ## Properties
92
-
93
- ### config
94
-
95
- ```ts
96
- protected readonly config: Partial<C>;
97
- ```
98
-
99
- ***
100
-
101
- ### value
102
-
103
- ```ts
104
- protected readonly value: T;
105
- ```
106
-
107
- ## Accessors
108
-
109
- ### provider
110
-
111
- ### Get Signature
112
-
113
- ```ts
114
- get provider(): XyoConnection | undefined;
115
- ```
116
-
117
- #### Returns
118
-
119
- `XyoConnection` \| `undefined`
120
-
121
- ## Methods
122
-
123
- ### create()
124
-
125
- ```ts
126
- static create<T, C>(value, config?): Promise<BaseWrapper<T, BaseWrapperConfig<T>>>;
127
- ```
128
-
129
- ### Type Parameters
130
-
131
- #### T
132
-
133
- `T`
134
-
135
- #### C
136
-
137
- `C` *extends* [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\> = [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>
138
-
139
- ### Parameters
140
-
141
- #### value
142
-
143
- `T`
144
-
145
- #### config?
146
-
147
- `Partial`\<`C`\>
148
-
149
- ### Returns
150
-
151
- `Promise`\<`BaseWrapper`\<`T`, [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>\>\>
152
-
153
- ***
154
-
155
- ### validateConfig()
156
-
157
- ```ts
158
- static validateConfig(_config): PromisableArray<Error>;
159
- ```
160
-
161
- ### Parameters
162
-
163
- #### \_config
164
-
165
- `unknown`
166
-
167
- ### Returns
168
-
169
- `PromisableArray`\<`Error`\>
170
-
171
- ***
172
-
173
- ### validateValue()
174
-
175
- ```ts
176
- static validateValue(_value): PromisableArray<Error>;
177
- ```
178
-
179
- ### Parameters
180
-
181
- #### \_value
182
-
183
- `unknown`
184
-
185
- ### Returns
186
-
187
- `PromisableArray`\<`Error`\>
188
-
189
- ***
190
-
191
- ### validate()
192
-
193
- ```ts
194
- validate(): PromisableArray<Error>;
195
- ```
196
-
197
- ### Returns
198
-
199
- `PromisableArray`\<`Error`\>
200
-
201
- ### <a id="ChainWrapper"></a>ChainWrapper
202
-
203
- [**@xyo-network/chain-wrappers**](#../README)
204
-
205
- ***
206
-
207
- ## Extends
208
-
209
- - [`BaseWrapper`](#BaseWrapper)\<`Address`, [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`Address`\>\>
210
-
211
- ## Constructors
212
-
213
- ### Constructor
214
-
215
- ```ts
216
- protected new ChainWrapper(value, config?): ChainWrapper;
217
- ```
218
-
219
- ### Parameters
220
-
221
- #### value
222
-
223
- `Address`
224
-
225
- #### config?
226
-
227
- `Partial`\<[`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`Address`\>\>
228
-
229
- ### Returns
230
-
231
- `ChainWrapper`
232
-
233
- ### Inherited from
234
-
235
- [`BaseWrapper`](#BaseWrapper).[`constructor`](BaseWrapper.md#constructor)
236
-
237
- ## Properties
238
-
239
- ### config
240
-
241
- ```ts
242
- protected readonly config: Partial<C>;
243
- ```
244
-
245
- ### Inherited from
246
-
247
- [`BaseWrapper`](#BaseWrapper).[`config`](BaseWrapper.md#config)
248
-
249
- ***
250
-
251
- ### value
252
-
253
- ```ts
254
- protected readonly value: Address;
255
- ```
256
-
257
- ### Inherited from
258
-
259
- [`BaseWrapper`](#BaseWrapper).[`value`](BaseWrapper.md#value)
260
-
261
- ## Accessors
262
-
263
- ### provider
264
-
265
- ### Get Signature
266
-
267
- ```ts
268
- get provider(): XyoConnection | undefined;
269
- ```
270
-
271
- #### Returns
272
-
273
- `XyoConnection` \| `undefined`
274
-
275
- ### Inherited from
276
-
277
- [`BaseWrapper`](#BaseWrapper).[`provider`](BaseWrapper.md#provider)
278
-
279
- ***
280
-
281
- ### id
282
-
283
- ### Get Signature
284
-
285
- ```ts
286
- get id(): Address;
287
- ```
288
-
289
- #### Returns
290
-
291
- `Address`
292
-
293
- ## Methods
294
-
295
- ### create()
296
-
297
- ```ts
298
- static create<T, C>(value, config?): Promise<BaseWrapper<T, BaseWrapperConfig<T>>>;
299
- ```
300
-
301
- ### Type Parameters
302
-
303
- #### T
304
-
305
- `T`
306
-
307
- #### C
308
-
309
- `C` *extends* [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\> = [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>
310
-
311
- ### Parameters
312
-
313
- #### value
314
-
315
- `T`
316
-
317
- #### config?
318
-
319
- `Partial`\<`C`\>
320
-
321
- ### Returns
322
-
323
- `Promise`\<[`BaseWrapper`](#BaseWrapper)\<`T`, [`BaseWrapperConfig`](#../interfaces/BaseWrapperConfig)\<`T`\>\>\>
324
-
325
- ### Inherited from
326
-
327
- [`BaseWrapper`](#BaseWrapper).[`create`](BaseWrapper.md#create)
328
-
329
- ***
330
-
331
- ### validateConfig()
332
-
333
- ```ts
334
- static validateConfig(_config): PromisableArray<Error>;
335
- ```
336
-
337
- ### Parameters
338
-
339
- #### \_config
340
-
341
- `unknown`
342
-
343
- ### Returns
344
-
345
- `PromisableArray`\<`Error`\>
346
-
347
- ### Inherited from
348
-
349
- [`BaseWrapper`](#BaseWrapper).[`validateConfig`](BaseWrapper.md#validateconfig)
350
-
351
- ***
352
-
353
- ### validateValue()
354
-
355
- ```ts
356
- static validateValue(_value): PromisableArray<Error>;
357
- ```
358
-
359
- ### Parameters
360
-
361
- #### \_value
362
-
363
- `unknown`
364
-
365
- ### Returns
366
-
367
- `PromisableArray`\<`Error`\>
368
-
369
- ### Inherited from
370
-
371
- [`BaseWrapper`](#BaseWrapper).[`validateValue`](BaseWrapper.md#validatevalue)
372
-
373
- ***
374
-
375
- ### validate()
376
-
377
- ```ts
378
- validate(): PromisableArray<Error>;
379
- ```
380
-
381
- ### Returns
382
-
383
- `PromisableArray`\<`Error`\>
384
-
385
- ### Inherited from
386
-
387
- [`BaseWrapper`](#BaseWrapper).[`validate`](BaseWrapper.md#validate)
388
-
389
- ### <a id="FeesWrapper"></a>FeesWrapper
390
-
391
- [**@xyo-network/chain-wrappers**](#../README)
392
-
393
- ***
394
-
395
- ## Implements
396
-
397
- - `TransactionFeesInstance`
398
-
399
- ## Constructors
400
-
401
- ### Constructor
402
-
403
- ```ts
404
- new FeesWrapper(__namedParameters): FeesWrapper;
405
- ```
406
-
407
- ### Parameters
408
-
409
- #### \_\_namedParameters
410
-
411
- `TransactionFeesHex` | `TransactionFeesBigInt`
412
-
413
- ### Returns
414
-
415
- `FeesWrapper`
416
-
417
- ## Properties
418
-
419
- ### base
420
-
421
- ```ts
422
- base: AttoXL1;
423
- ```
424
-
425
- ### Implementation of
426
-
427
- ```ts
428
- TransactionFeesInstance.base
429
- ```
430
-
431
- ***
432
-
433
- ### gasLimit
434
-
435
- ```ts
436
- gasLimit: AttoXL1;
437
- ```
438
-
439
- ### Implementation of
440
-
441
- ```ts
442
- TransactionFeesInstance.gasLimit
443
- ```
444
-
445
- ***
446
-
447
- ### gasPrice
448
-
449
- ```ts
450
- gasPrice: AttoXL1;
451
- ```
452
-
453
- ### Implementation of
454
-
455
- ```ts
456
- TransactionFeesInstance.gasPrice
457
- ```
458
-
459
- ***
460
-
461
- ### priority
462
-
463
- ```ts
464
- priority: AttoXL1;
465
- ```
466
-
467
- ### Implementation of
468
-
469
- ```ts
470
- TransactionFeesInstance.priority
471
- ```
472
-
473
- ## Methods
474
-
475
- ### validate()
476
-
477
- ```ts
478
- static validate(__namedParameters): Promisable<Error[]>;
479
- ```
480
-
481
- ### Parameters
482
-
483
- #### \_\_namedParameters
484
-
485
- `TransactionFeesHex` | `TransactionFeesBigInt`
486
-
487
- ### Returns
488
-
489
- `Promisable`\<`Error`[]\>
490
-
491
- ***
492
-
493
- ### validate()
494
-
495
- ```ts
496
- validate(): Promise<Error[]>;
497
- ```
498
-
499
- ### Returns
500
-
501
- `Promise`\<`Error`[]\>
502
-
503
- ### Implementation of
504
-
505
- ```ts
506
- TransactionFeesInstance.validate
507
- ```
508
-
509
- ### <a id="HydratedBlockWrapper"></a>HydratedBlockWrapper
510
-
511
- [**@xyo-network/chain-wrappers**](#../README)
512
-
513
- ***
514
-
515
- ## Type Parameters
516
-
517
- ### T
518
-
519
- `T` *extends* `HydratedBlock`
520
-
521
- ## Implements
522
-
523
- - `HydratedBlockInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>
524
-
525
- ## Constructors
526
-
527
- ### Constructor
528
-
529
- ```ts
530
- protected new HydratedBlockWrapper<T>(data): HydratedBlockWrapper<T>;
531
- ```
532
-
533
- ### Parameters
534
-
535
- #### data
536
-
537
- \[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\]
538
-
539
- ### Returns
540
-
541
- `HydratedBlockWrapper`\<`T`\>
542
-
543
- ## Properties
544
-
545
- ### data
546
-
547
- ```ts
548
- data: [WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]];
549
- ```
550
-
551
- ### Implementation of
552
-
553
- ```ts
554
- HydratedBlockInstance.data
555
- ```
556
-
557
- ***
558
-
559
- ### allPayloadsCache
560
-
561
- ```ts
562
- protected allPayloadsCache: WithHashMeta<WithHashMeta<T[1][number]>>[] = [];
563
- ```
564
-
565
- ***
566
-
567
- ### transactionsCache
568
-
569
- ```ts
570
- protected transactionsCache: HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[] = [];
571
- ```
572
-
573
- ## Accessors
574
-
575
- ### block
576
-
577
- ### Get Signature
578
-
579
- ```ts
580
- get block(): number & object & object;
581
- ```
582
-
583
- #### Returns
584
-
585
- `number` & `object` & `object`
586
-
587
- ***
588
-
589
- ### boundWitness
590
-
591
- ### Get Signature
592
-
593
- ```ts
594
- get boundWitness(): WithHashMeta<T[0]>;
595
- ```
596
-
597
- #### Returns
598
-
599
- `WithHashMeta`\<`T`\[`0`\]\>
600
-
601
- ### Implementation of
602
-
603
- ```ts
604
- HydratedBlockInstance.boundWitness
605
- ```
606
-
607
- ***
608
-
609
- ### chain
610
-
611
- ### Get Signature
612
-
613
- ```ts
614
- get chain(): Hex;
615
- ```
616
-
617
- #### Returns
618
-
619
- `Hex`
620
-
621
- ***
622
-
623
- ### parseErrors
624
-
625
- ### Get Signature
626
-
627
- ```ts
628
- get parseErrors(): Error[];
629
- ```
630
-
631
- #### Returns
632
-
633
- `Error`[]
634
-
635
- ***
636
-
637
- ### payloadCount
638
-
639
- ### Get Signature
640
-
641
- ```ts
642
- get payloadCount(): number;
643
- ```
644
-
645
- #### Returns
646
-
647
- `number`
648
-
649
- ### Implementation of
650
-
651
- ```ts
652
- HydratedBlockInstance.payloadCount
653
- ```
654
-
655
- ***
656
-
657
- ### payloads
658
-
659
- ### Get Signature
660
-
661
- ```ts
662
- get payloads(): T[1][number][];
663
- ```
664
-
665
- #### Returns
666
-
667
- `T`\[`1`\]\[`number`\][]
668
-
669
- ### Implementation of
670
-
671
- ```ts
672
- HydratedBlockInstance.payloads
673
- ```
674
-
675
- ***
676
-
677
- ### reward
678
-
679
- ### Get Signature
680
-
681
- ```ts
682
- get reward(): bigint;
683
- ```
684
-
685
- #### Returns
686
-
687
- `bigint`
688
-
689
- ### Implementation of
690
-
691
- ```ts
692
- HydratedBlockInstance.reward
693
- ```
694
-
695
- ***
696
-
697
- ### signatureCount
698
-
699
- ### Get Signature
700
-
701
- ```ts
702
- get signatureCount(): number;
703
- ```
704
-
705
- #### Returns
706
-
707
- `number`
708
-
709
- ### Implementation of
710
-
711
- ```ts
712
- HydratedBlockInstance.signatureCount
713
- ```
714
-
715
- ***
716
-
717
- ### signatures
718
-
719
- ### Get Signature
720
-
721
- ```ts
722
- get signatures(): SignatureInstance[];
723
- ```
724
-
725
- #### Returns
726
-
727
- `SignatureInstance`[]
728
-
729
- ### Implementation of
730
-
731
- ```ts
732
- HydratedBlockInstance.signatures
733
- ```
734
-
735
- ***
736
-
737
- ### stepHashes
738
-
739
- ### Get Signature
740
-
741
- ```ts
742
- get stepHashes(): Hash[];
743
- ```
744
-
745
- #### Returns
746
-
747
- `Hash`[]
748
-
749
- ***
750
-
751
- ### transactionCount
752
-
753
- ### Get Signature
754
-
755
- ```ts
756
- get transactionCount(): number;
757
- ```
758
-
759
- #### Returns
760
-
761
- `number`
762
-
763
- ### Implementation of
764
-
765
- ```ts
766
- HydratedBlockInstance.transactionCount
767
- ```
768
-
769
- ***
770
-
771
- ### transactions
772
-
773
- ### Get Signature
774
-
775
- ```ts
776
- get transactions(): HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>[];
777
- ```
778
-
779
- #### Returns
780
-
781
- `HydratedTransactionInstance`\<`HydratedTransactionWithStorageMeta`, `AllowedBlockPayload`\>[]
782
-
783
- ### Implementation of
784
-
785
- ```ts
786
- HydratedBlockInstance.transactions
787
- ```
788
-
789
- ## Methods
790
-
791
- ### parse()
792
-
793
- ```ts
794
- static parse<T>(block, validate): Promise<HydratedBlockInstance<HydratedBlock>>;
795
- ```
796
-
797
- ### Type Parameters
798
-
799
- #### T
800
-
801
- `T` *extends* `HydratedBlock`
802
-
803
- ### Parameters
804
-
805
- #### block
806
-
807
- `T`
808
-
809
- #### validate
810
-
811
- `boolean` = `false`
812
-
813
- ### Returns
814
-
815
- `Promise`\<`HydratedBlockInstance`\<`HydratedBlock`\>\>
816
-
817
- ***
818
-
819
- ### payload()
820
-
821
- ```ts
822
- payload(index): WithHashMeta<T[1][number]> | undefined;
823
- ```
824
-
825
- ### Parameters
826
-
827
- #### index
828
-
829
- `number`
830
-
831
- ### Returns
832
-
833
- `WithHashMeta`\<`T`\[`1`\]\[`number`\]\> \| `undefined`
834
-
835
- ### Implementation of
836
-
837
- ```ts
838
- HydratedBlockInstance.payload
839
- ```
840
-
841
- ***
842
-
843
- ### signature()
844
-
845
- ```ts
846
- signature(index): SignatureInstance | undefined;
847
- ```
848
-
849
- ### Parameters
850
-
851
- #### index
852
-
853
- `number`
854
-
855
- ### Returns
856
-
857
- `SignatureInstance` \| `undefined`
858
-
859
- ### Implementation of
860
-
861
- ```ts
862
- HydratedBlockInstance.signature
863
- ```
864
-
865
- ***
866
-
867
- ### transaction()
868
-
869
- ```ts
870
- transaction(index):
871
- | HydratedTransactionInstance<HydratedTransactionWithStorageMeta, AllowedBlockPayload>
872
- | undefined;
873
- ```
874
-
875
- ### Parameters
876
-
877
- #### index
878
-
879
- `number`
880
-
881
- ### Returns
882
-
883
- \| `HydratedTransactionInstance`\<`HydratedTransactionWithStorageMeta`, `AllowedBlockPayload`\>
884
- \| `undefined`
885
-
886
- ### Implementation of
887
-
888
- ```ts
889
- HydratedBlockInstance.transaction
890
- ```
891
-
892
- ***
893
-
894
- ### validate()
895
-
896
- ```ts
897
- validate(): Promise<Error[]>;
898
- ```
899
-
900
- ### Returns
901
-
902
- `Promise`\<`Error`[]\>
903
-
904
- ### Implementation of
905
-
906
- ```ts
907
- HydratedBlockInstance.validate
908
- ```
909
-
910
- ***
911
-
912
- ### validateState()
913
-
914
- ```ts
915
- validateState(services): Promise<Error[]>;
916
- ```
917
-
918
- ### Parameters
919
-
920
- #### services
921
-
922
- ##### accountBalance
923
-
924
- `AccountBalanceService`
925
-
926
- ### Returns
927
-
928
- `Promise`\<`Error`[]\>
929
-
930
- ***
931
-
932
- ### parse()
933
-
934
- ```ts
935
- protected parse(validate): Promise<HydratedBlockInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]]>>;
936
- ```
937
-
938
- ### Parameters
939
-
940
- #### validate
941
-
942
- `boolean` = `false`
943
-
944
- ### Returns
945
-
946
- `Promise`\<`HydratedBlockInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>\>
947
-
948
- ### <a id="HydratedTransactionWrapper"></a>HydratedTransactionWrapper
949
-
950
- [**@xyo-network/chain-wrappers**](#../README)
951
-
952
- ***
953
-
954
- ## Type Parameters
955
-
956
- ### T
957
-
958
- `T` *extends* `HydratedTransactionWithStorageMeta`
959
-
960
- ## Implements
961
-
962
- - `HydratedTransactionInstance`\<\[`T`\[`0`\], `T`\[`1`\]\[`number`\][]\]\>
963
-
964
- ## Constructors
965
-
966
- ### Constructor
967
-
968
- ```ts
969
- protected new HydratedTransactionWrapper<T>(data): HydratedTransactionWrapper<T>;
970
- ```
971
-
972
- ### Parameters
973
-
974
- #### data
975
-
976
- `T`
977
-
978
- ### Returns
979
-
980
- `HydratedTransactionWrapper`\<`T`\>
981
-
982
- ## Properties
983
-
984
- ### data
985
-
986
- ```ts
987
- data: T;
988
- ```
989
-
990
- ### Implementation of
991
-
992
- ```ts
993
- HydratedTransactionInstance.data
994
- ```
995
-
996
- ***
997
-
998
- ### fees
999
-
1000
- ```ts
1001
- fees: TransactionFeesInstance;
1002
- ```
1003
-
1004
- ### Implementation of
1005
-
1006
- ```ts
1007
- HydratedTransactionInstance.fees
1008
- ```
1009
-
1010
- ***
1011
-
1012
- ### payloadsCache
1013
-
1014
- ```ts
1015
- protected payloadsCache: WithStorageMeta<Payload>[];
1016
- ```
1017
-
1018
- ## Accessors
1019
-
1020
- ### boundWitness
1021
-
1022
- ### Get Signature
1023
-
1024
- ```ts
1025
- get boundWitness(): T[0];
1026
- ```
1027
-
1028
- #### Returns
1029
-
1030
- `T`\[`0`\]
1031
-
1032
- ### Implementation of
1033
-
1034
- ```ts
1035
- HydratedTransactionInstance.boundWitness
1036
- ```
1037
-
1038
- ***
1039
-
1040
- ### elevatedPayloadCount
1041
-
1042
- ### Get Signature
1043
-
1044
- ```ts
1045
- get elevatedPayloadCount(): number;
1046
- ```
1047
-
1048
- #### Returns
1049
-
1050
- `number`
1051
-
1052
- ### Implementation of
1053
-
1054
- ```ts
1055
- HydratedTransactionInstance.elevatedPayloadCount
1056
- ```
1057
-
1058
- ***
1059
-
1060
- ### elevatedPayloads
1061
-
1062
- ### Get Signature
1063
-
1064
- ```ts
1065
- get elevatedPayloads(): WithStorageMeta<AllowedBlockPayload>[];
1066
- ```
1067
-
1068
- #### Returns
1069
-
1070
- `WithStorageMeta`\<`AllowedBlockPayload`\>[]
1071
-
1072
- ### Implementation of
1073
-
1074
- ```ts
1075
- HydratedTransactionInstance.elevatedPayloads
1076
- ```
1077
-
1078
- ***
1079
-
1080
- ### externalPayloads
1081
-
1082
- ### Get Signature
1083
-
1084
- ```ts
1085
- get externalPayloads(): Record<Hash, Schema | Payload>;
1086
- ```
1087
-
1088
- #### Returns
1089
-
1090
- `Record`\<`Hash`, `Schema` \| `Payload`\>
1091
-
1092
- ### Implementation of
1093
-
1094
- ```ts
1095
- HydratedTransactionInstance.externalPayloads
1096
- ```
1097
-
1098
- ***
1099
-
1100
- ### from
1101
-
1102
- ### Get Signature
1103
-
1104
- ```ts
1105
- get from(): Address;
1106
- ```
1107
-
1108
- #### Returns
1109
-
1110
- `Address`
1111
-
1112
- ***
1113
-
1114
- ### payloadCount
1115
-
1116
- ### Get Signature
1117
-
1118
- ```ts
1119
- get payloadCount(): number;
1120
- ```
1121
-
1122
- #### Returns
1123
-
1124
- `number`
1125
-
1126
- ### Implementation of
1127
-
1128
- ```ts
1129
- HydratedTransactionInstance.payloadCount
1130
- ```
1131
-
1132
- ***
1133
-
1134
- ### payloads
1135
-
1136
- ### Get Signature
1137
-
1138
- ```ts
1139
- get payloads(): WithHashMeta<WithStorageMeta<T[1][number]>>[];
1140
- ```
1141
-
1142
- #### Returns
1143
-
1144
- `WithHashMeta`\<`WithStorageMeta`\<`T`\[`1`\]\[`number`\]\>\>[]
1145
-
1146
- ### Implementation of
1147
-
1148
- ```ts
1149
- HydratedTransactionInstance.payloads
1150
- ```
1151
-
1152
- ***
1153
-
1154
- ### privateExternalPayloads
1155
-
1156
- ### Get Signature
1157
-
1158
- ```ts
1159
- get privateExternalPayloads(): Record<Hash, Schema>;
1160
- ```
1161
-
1162
- #### Returns
1163
-
1164
- `Record`\<`Hash`, `Schema`\>
1165
-
1166
- ### Implementation of
1167
-
1168
- ```ts
1169
- HydratedTransactionInstance.privateExternalPayloads
1170
- ```
1171
-
1172
- ***
1173
-
1174
- ### publicExternalPayloads
1175
-
1176
- ### Get Signature
1177
-
1178
- ```ts
1179
- get publicExternalPayloads(): Payload[];
1180
- ```
1181
-
1182
- #### Returns
1183
-
1184
- `Payload`[]
1185
-
1186
- ### Implementation of
1187
-
1188
- ```ts
1189
- HydratedTransactionInstance.publicExternalPayloads
1190
- ```
1191
-
1192
- ***
1193
-
1194
- ### signatureCount
1195
-
1196
- ### Get Signature
1197
-
1198
- ```ts
1199
- get signatureCount(): number;
1200
- ```
1201
-
1202
- #### Returns
1203
-
1204
- `number`
1205
-
1206
- ### Implementation of
1207
-
1208
- ```ts
1209
- HydratedTransactionInstance.signatureCount
1210
- ```
1211
-
1212
- ***
1213
-
1214
- ### signatures
1215
-
1216
- ### Get Signature
1217
-
1218
- ```ts
1219
- get signatures(): SignatureInstance[];
1220
- ```
1221
-
1222
- #### Returns
1223
-
1224
- `SignatureInstance`[]
1225
-
1226
- ### Implementation of
1227
-
1228
- ```ts
1229
- HydratedTransactionInstance.signatures
1230
- ```
1231
-
1232
- ## Methods
1233
-
1234
- ### parse()
1235
-
1236
- ```ts
1237
- static parse<T>(transaction, validate?): Promise<HydratedTransactionInstance<[T[0], T[1][number][]], AllowedBlockPayload>>;
1238
- ```
1239
-
1240
- ### Type Parameters
1241
-
1242
- #### T
1243
-
1244
- `T` *extends* `HydratedTransactionWithStorageMeta`
1245
-
1246
- ### Parameters
1247
-
1248
- #### transaction
1249
-
1250
- `T`
1251
-
1252
- #### validate?
1253
-
1254
- `boolean`
1255
-
1256
- ### Returns
1257
-
1258
- `Promise`\<`HydratedTransactionInstance`\<\[`T`\[`0`\], `T`\[`1`\]\[`number`\][]\], `AllowedBlockPayload`\>\>
1259
-
1260
- ***
1261
-
1262
- ### elevatedPayload()
1263
-
1264
- ```ts
1265
- elevatedPayload(index): WithHashMeta<AllowedBlockPayload & T[1][number]> | undefined;
1266
- ```
1267
-
1268
- ### Parameters
1269
-
1270
- #### index
1271
-
1272
- `number`
1273
-
1274
- ### Returns
1275
-
1276
- `WithHashMeta`\<AllowedBlockPayload & T\[1\]\[number\]\> \| `undefined`
1277
-
1278
- ### Implementation of
1279
-
1280
- ```ts
1281
- HydratedTransactionInstance.elevatedPayload
1282
- ```
1283
-
1284
- ***
1285
-
1286
- ### gasRequired()
1287
-
1288
- ```ts
1289
- gasRequired(): bigint;
1290
- ```
1291
-
1292
- ### Returns
1293
-
1294
- `bigint`
1295
-
1296
- ***
1297
-
1298
- ### payload()
1299
-
1300
- ```ts
1301
- payload(index): WithStorageMeta<Payload> | undefined;
1302
- ```
1303
-
1304
- ### Parameters
1305
-
1306
- #### index
1307
-
1308
- `number`
1309
-
1310
- ### Returns
1311
-
1312
- `WithStorageMeta`\<`Payload`\> \| `undefined`
1313
-
1314
- ### Implementation of
1315
-
1316
- ```ts
1317
- HydratedTransactionInstance.payload
1318
- ```
1319
-
1320
- ***
1321
-
1322
- ### reward()
1323
-
1324
- ```ts
1325
- reward(): bigint;
1326
- ```
1327
-
1328
- ### Returns
1329
-
1330
- `bigint`
1331
-
1332
- ### Implementation of
1333
-
1334
- ```ts
1335
- HydratedTransactionInstance.reward
1336
- ```
1337
-
1338
- ***
1339
-
1340
- ### signature()
1341
-
1342
- ```ts
1343
- signature(index): SignatureInstance | undefined;
1344
- ```
1345
-
1346
- ### Parameters
1347
-
1348
- #### index
1349
-
1350
- `number`
1351
-
1352
- ### Returns
1353
-
1354
- `SignatureInstance` \| `undefined`
1355
-
1356
- ### Implementation of
1357
-
1358
- ```ts
1359
- HydratedTransactionInstance.signature
1360
- ```
1361
-
1362
- ***
1363
-
1364
- ### validate()
1365
-
1366
- ```ts
1367
- validate(): Promise<Error[]>;
1368
- ```
1369
-
1370
- ### Returns
1371
-
1372
- `Promise`\<`Error`[]\>
1373
-
1374
- ### Implementation of
1375
-
1376
- ```ts
1377
- HydratedTransactionInstance.validate
1378
- ```
1379
-
1380
- ***
1381
-
1382
- ### parse()
1383
-
1384
- ```ts
1385
- protected parse(validate?): Promise<HydratedTransactionInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]], AllowedBlockPayload>>;
1386
- ```
1387
-
1388
- ### Parameters
1389
-
1390
- #### validate?
1391
-
1392
- `boolean`
1393
-
1394
- ### Returns
1395
-
1396
- `Promise`\<`HydratedTransactionInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\], `AllowedBlockPayload`\>\>
1397
-
1398
- ### <a id="IndexedHydratedBlockRangeStore"></a>IndexedHydratedBlockRangeStore
1399
-
1400
- [**@xyo-network/chain-wrappers**](#../README)
1401
-
1402
- ***
1403
-
1404
- ## Extends
1405
-
1406
- - `BaseEmitter`\<[`HydratedBlockRangeStoreParams`](#../interfaces/HydratedBlockRangeStoreParams)\>
1407
-
1408
- ## Implements
1409
-
1410
- - [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance)
1411
-
1412
- ## Constructors
1413
-
1414
- ### Constructor
1415
-
1416
- ```ts
1417
- protected new IndexedHydratedBlockRangeStore(
1418
- params,
1419
- firstNumber,
1420
- lastNumber): IndexedHydratedBlockRangeStore;
1421
- ```
1422
-
1423
- ### Parameters
1424
-
1425
- #### params
1426
-
1427
- [`HydratedBlockRangeStoreParams`](#../interfaces/HydratedBlockRangeStoreParams)
1428
-
1429
- #### firstNumber
1430
-
1431
- `number`
1432
-
1433
- #### lastNumber
1434
-
1435
- `number`
1436
-
1437
- ### Returns
1438
-
1439
- `IndexedHydratedBlockRangeStore`
1440
-
1441
- ### Overrides
1442
-
1443
- ```ts
1444
- BaseEmitter<HydratedBlockRangeStoreParams>.constructor
1445
- ```
1446
-
1447
- ## Accessors
1448
-
1449
- ### count
1450
-
1451
- ### Get Signature
1452
-
1453
- ```ts
1454
- get count(): number;
1455
- ```
1456
-
1457
- #### Returns
1458
-
1459
- `number`
1460
-
1461
- ### Implementation of
1462
-
1463
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`count`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#count)
1464
-
1465
- ***
1466
-
1467
- ### numberRange
1468
-
1469
- ### Get Signature
1470
-
1471
- ```ts
1472
- get numberRange(): [number, number];
1473
- ```
1474
-
1475
- #### Returns
1476
-
1477
- \[`number`, `number`\]
1478
-
1479
- ### Implementation of
1480
-
1481
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`numberRange`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#numberrange)
1482
-
1483
- ***
1484
-
1485
- ### range
1486
-
1487
- ### Get Signature
1488
-
1489
- ```ts
1490
- get range(): [Hash, Hash];
1491
- ```
1492
-
1493
- #### Returns
1494
-
1495
- \[`Hash`, `Hash`\]
1496
-
1497
- ### Implementation of
1498
-
1499
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`range`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#range)
1500
-
1501
- ## Methods
1502
-
1503
- ### create()
1504
-
1505
- ```ts
1506
- static create(params): Promise<IndexedHydratedBlockRangeStore>;
1507
- ```
1508
-
1509
- ### Parameters
1510
-
1511
- #### params
1512
-
1513
- [`HydratedBlockRangeStoreParams`](#../interfaces/HydratedBlockRangeStoreParams)
1514
-
1515
- ### Returns
1516
-
1517
- `Promise`\<`IndexedHydratedBlockRangeStore`\>
1518
-
1519
- ***
1520
-
1521
- ### first()
1522
-
1523
- ```ts
1524
- first(): Promise<HydratedBlock>;
1525
- ```
1526
-
1527
- ### Returns
1528
-
1529
- `Promise`\<`HydratedBlock`\>
1530
-
1531
- ### Implementation of
1532
-
1533
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`first`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#first)
1534
-
1535
- ***
1536
-
1537
- ### fromHash()
1538
-
1539
- ```ts
1540
- fromHash(hash): Promise<HydratedBlock | undefined>;
1541
- ```
1542
-
1543
- ### Parameters
1544
-
1545
- #### hash
1546
-
1547
- `Hash`
1548
-
1549
- ### Returns
1550
-
1551
- `Promise`\<`HydratedBlock` \| `undefined`\>
1552
-
1553
- ### Implementation of
1554
-
1555
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`fromHash`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#fromhash)
1556
-
1557
- ***
1558
-
1559
- ### fromNumber()
1560
-
1561
- ```ts
1562
- fromNumber(number): Promisable<HydratedBlock | undefined>;
1563
- ```
1564
-
1565
- ### Parameters
1566
-
1567
- #### number
1568
-
1569
- `number`
1570
-
1571
- ### Returns
1572
-
1573
- `Promisable`\<`HydratedBlock` \| `undefined`\>
1574
-
1575
- ### Implementation of
1576
-
1577
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`fromNumber`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#fromnumber)
1578
-
1579
- ***
1580
-
1581
- ### last()
1582
-
1583
- ```ts
1584
- last(): Promise<HydratedBlock>;
1585
- ```
1586
-
1587
- ### Returns
1588
-
1589
- `Promise`\<`HydratedBlock`\>
1590
-
1591
- ### Implementation of
1592
-
1593
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`last`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#last)
1594
-
1595
- ***
1596
-
1597
- ### next()
1598
-
1599
- ### Call Signature
1600
-
1601
- ```ts
1602
- next(from): Promise<HydratedBlock | undefined>;
1603
- ```
1604
-
1605
- #### Parameters
1606
-
1607
- ##### from
1608
-
1609
- `HydratedBlock`
1610
-
1611
- #### Returns
1612
-
1613
- `Promise`\<`HydratedBlock` \| `undefined`\>
1614
-
1615
- #### Implementation of
1616
-
1617
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`next`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#next)
1618
-
1619
- ### Call Signature
1620
-
1621
- ```ts
1622
- next(from, count): Promise<HydratedBlock[]>;
1623
- ```
1624
-
1625
- #### Parameters
1626
-
1627
- ##### from
1628
-
1629
- `HydratedBlock`
1630
-
1631
- ##### count
1632
-
1633
- `number`
1634
-
1635
- #### Returns
1636
-
1637
- `Promise`\<`HydratedBlock`[]\>
1638
-
1639
- #### Implementation of
1640
-
1641
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`next`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#next)
1642
-
1643
- ***
1644
-
1645
- ### prev()
1646
-
1647
- ### Call Signature
1648
-
1649
- ```ts
1650
- prev(from): Promise<HydratedBlock | undefined>;
1651
- ```
1652
-
1653
- #### Parameters
1654
-
1655
- ##### from
1656
-
1657
- `HydratedBlock`
1658
-
1659
- #### Returns
1660
-
1661
- `Promise`\<`HydratedBlock` \| `undefined`\>
1662
-
1663
- #### Implementation of
1664
-
1665
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`prev`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#prev)
1666
-
1667
- ### Call Signature
1668
-
1669
- ```ts
1670
- prev(from, count): Promise<HydratedBlock[]>;
1671
- ```
1672
-
1673
- #### Parameters
1674
-
1675
- ##### from
1676
-
1677
- `HydratedBlock`
1678
-
1679
- ##### count
1680
-
1681
- `number`
1682
-
1683
- #### Returns
1684
-
1685
- `Promise`\<`HydratedBlock`[]\>
1686
-
1687
- #### Implementation of
1688
-
1689
- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`prev`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#prev)
1690
-
1691
- ### <a id="SignatureWrapper"></a>SignatureWrapper
1692
-
1693
- [**@xyo-network/chain-wrappers**](#../README)
1694
-
1695
- ***
1696
-
1697
- ## Implements
1698
-
1699
- - `SignatureInstance`
1700
-
1701
- ## Constructors
1702
-
1703
- ### Constructor
1704
-
1705
- ```ts
1706
- new SignatureWrapper(
1707
- signature,
1708
- address,
1709
- hash): SignatureWrapper;
1710
- ```
1711
-
1712
- ### Parameters
1713
-
1714
- #### signature
1715
-
1716
- `Hex`
1717
-
1718
- #### address
1719
-
1720
- `Address`
1721
-
1722
- #### hash
1723
-
1724
- `Hash`
1725
-
1726
- ### Returns
1727
-
1728
- `SignatureWrapper`
1729
-
1730
- ## Properties
1731
-
1732
- ### address
1733
-
1734
- ```ts
1735
- address: Address;
1736
- ```
1737
-
1738
- ### Implementation of
1739
-
1740
- ```ts
1741
- SignatureInstance.address
1742
- ```
1743
-
1744
- ***
1745
-
1746
- ### hash
1747
-
1748
- ```ts
1749
- hash: Hash;
1750
- ```
1751
-
1752
- ### Implementation of
1753
-
1754
- ```ts
1755
- SignatureInstance.hash
1756
- ```
1757
-
1758
- ***
1759
-
1760
- ### signature
1761
-
1762
- ```ts
1763
- signature: Hex;
1764
- ```
1765
-
1766
- ### Implementation of
1767
-
1768
- ```ts
1769
- SignatureInstance.signature
1770
- ```
1771
-
1772
- ## Methods
1773
-
1774
- ### validate()
1775
-
1776
- ```ts
1777
- static validate(
1778
- hash,
1779
- address,
1780
- signature): Promise<Error[]>;
1781
- ```
1782
-
1783
- ### Parameters
1784
-
1785
- #### hash
1786
-
1787
- `Hash`
1788
-
1789
- #### address
1790
-
1791
- `Address`
1792
-
1793
- #### signature
1794
-
1795
- `Hex`
1796
-
1797
- ### Returns
1798
-
1799
- `Promise`\<`Error`[]\>
1800
-
1801
- ***
1802
-
1803
- ### validate()
1804
-
1805
- ```ts
1806
- validate(): Promise<Error[]>;
1807
- ```
1808
-
1809
- ### Returns
1810
-
1811
- `Promise`\<`Error`[]\>
1812
-
1813
- ### Implementation of
1814
-
1815
- ```ts
1816
- SignatureInstance.validate
1817
- ```
1818
-
1819
- ### interfaces
1820
-
1821
- ### <a id="BaseWrapperConfig"></a>BaseWrapperConfig
1822
-
1823
- [**@xyo-network/chain-wrappers**](#../README)
1824
-
1825
- ***
1826
-
1827
- ## Type Parameters
1828
-
1829
- ### T
1830
-
1831
- `T`
1832
-
1833
- ## Properties
1834
-
1835
- ### provider
1836
-
1837
- ```ts
1838
- provider: XyoConnection;
1839
- ```
1840
-
1841
- ***
1842
-
1843
- ### value
1844
-
1845
- ```ts
1846
- value: T;
1847
- ```
1848
-
1849
- ### <a id="HydratedBlockRangeStoreParams"></a>HydratedBlockRangeStoreParams
1850
-
1851
- [**@xyo-network/chain-wrappers**](#../README)
1852
-
1853
- ***
1854
-
1855
- ## Extends
1856
-
1857
- - [`HydratedBlockStoreParams`](#../type-aliases/HydratedBlockStoreParams)\<\{
1858
- `first`: `Hash`;
1859
- `last`: `Hash`;
1860
- `snapshotArchivist`: `ArchivistInstance`;
1861
- \}\>
1862
-
1863
- ## Properties
1864
-
1865
- ### sourceArchivist
1866
-
1867
- ```ts
1868
- sourceArchivist: ArchivistInstance;
1869
- ```
1870
-
1871
- ### Inherited from
1872
-
1873
- ```ts
1874
- HydratedBlockStoreParams.sourceArchivist
1875
- ```
1876
-
1877
- ***
1878
-
1879
- ### first
1880
-
1881
- ```ts
1882
- first: Hash;
1883
- ```
1884
-
1885
- ### Inherited from
1886
-
1887
- ```ts
1888
- HydratedBlockStoreParams.first
1889
- ```
1890
-
1891
- ***
1892
-
1893
- ### last
1894
-
1895
- ```ts
1896
- last: Hash;
1897
- ```
1898
-
1899
- ### Inherited from
1900
-
1901
- ```ts
1902
- HydratedBlockStoreParams.last
1903
- ```
1904
-
1905
- ***
1906
-
1907
- ### snapshotArchivist
1908
-
1909
- ```ts
1910
- snapshotArchivist: ArchivistInstance;
1911
- ```
1912
-
1913
- ### Inherited from
1914
-
1915
- ```ts
1916
- HydratedBlockStoreParams.snapshotArchivist
1917
- ```
1918
-
1919
- ### <a id="HydratedBlockStoreInstance"></a>HydratedBlockStoreInstance
1920
-
1921
- [**@xyo-network/chain-wrappers**](#../README)
1922
-
1923
- ***
1924
-
1925
- ## Extended by
1926
-
1927
- - [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
1928
-
1929
- ## Methods
1930
-
1931
- ### fromHash()
1932
-
1933
- ```ts
1934
- fromHash(hash): Promisable<HydratedBlock | undefined>;
1935
- ```
1936
-
1937
- ### Parameters
1938
-
1939
- #### hash
1940
-
1941
- `Hash`
1942
-
1943
- ### Returns
1944
-
1945
- `Promisable`\<`HydratedBlock` \| `undefined`\>
1946
-
1947
- ### <a id="IndexedHydratedBlockRangeStoreInstance"></a>IndexedHydratedBlockRangeStoreInstance
1948
-
1949
- [**@xyo-network/chain-wrappers**](#../README)
1950
-
1951
- ***
1952
-
1953
- ## Extends
1954
-
1955
- - `BlockWindowInstance`.[`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
1956
-
1957
- ## Properties
1958
-
1959
- ### count
1960
-
1961
- ```ts
1962
- count: number;
1963
- ```
1964
-
1965
- ### Inherited from
1966
-
1967
- ```ts
1968
- BlockWindowInstance.count
1969
- ```
1970
-
1971
- ***
1972
-
1973
- ### numberRange
1974
-
1975
- ```ts
1976
- numberRange: [number, number];
1977
- ```
1978
-
1979
- ### Inherited from
1980
-
1981
- ```ts
1982
- BlockWindowInstance.numberRange
1983
- ```
1984
-
1985
- ***
1986
-
1987
- ### range
1988
-
1989
- ```ts
1990
- range: [Hash, Hash];
1991
- ```
1992
-
1993
- ### Inherited from
1994
-
1995
- ```ts
1996
- BlockWindowInstance.range
1997
- ```
1998
-
1999
- ## Methods
2000
-
2001
- ### fromHash()
2002
-
2003
- ```ts
2004
- fromHash(hash): Promisable<HydratedBlock | undefined>;
2005
- ```
2006
-
2007
- ### Parameters
2008
-
2009
- #### hash
2010
-
2011
- `Hash`
2012
-
2013
- ### Returns
2014
-
2015
- `Promisable`\<`HydratedBlock` \| `undefined`\>
2016
-
2017
- ### Inherited from
2018
-
2019
- [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromHash`](IndexedHydratedBlockStoreInstance.md#fromhash)
2020
-
2021
- ***
2022
-
2023
- ### fromNumber()
2024
-
2025
- ```ts
2026
- fromNumber(number): Promisable<HydratedBlock | undefined>;
2027
- ```
2028
-
2029
- ### Parameters
2030
-
2031
- #### number
2032
-
2033
- `number`
2034
-
2035
- ### Returns
2036
-
2037
- `Promisable`\<`HydratedBlock` \| `undefined`\>
2038
-
2039
- ### Inherited from
2040
-
2041
- [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromNumber`](IndexedHydratedBlockStoreInstance.md#fromnumber)
2042
-
2043
- ***
2044
-
2045
- ### first()
2046
-
2047
- ```ts
2048
- first(): Promisable<HydratedBlock>;
2049
- ```
2050
-
2051
- ### Returns
2052
-
2053
- `Promisable`\<`HydratedBlock`\>
2054
-
2055
- ***
2056
-
2057
- ### last()
2058
-
2059
- ```ts
2060
- last(): Promisable<HydratedBlock>;
2061
- ```
2062
-
2063
- ### Returns
2064
-
2065
- `Promisable`\<`HydratedBlock`\>
2066
-
2067
- ***
2068
-
2069
- ### next()
2070
-
2071
- ### Call Signature
2072
-
2073
- ```ts
2074
- next(from): Promisable<HydratedBlock | undefined>;
2075
- ```
2076
-
2077
- #### Parameters
2078
-
2079
- ##### from
2080
-
2081
- `HydratedBlock`
2082
-
2083
- #### Returns
2084
-
2085
- `Promisable`\<`HydratedBlock` \| `undefined`\>
2086
-
2087
- ### Call Signature
2088
-
2089
- ```ts
2090
- next(from, count): Promisable<HydratedBlock[]>;
2091
- ```
2092
-
2093
- #### Parameters
2094
-
2095
- ##### from
2096
-
2097
- `HydratedBlock`
2098
-
2099
- ##### count
2100
-
2101
- `number`
2102
-
2103
- #### Returns
2104
-
2105
- `Promisable`\<`HydratedBlock`[]\>
2106
-
2107
- ***
2108
-
2109
- ### prev()
2110
-
2111
- ### Call Signature
2112
-
2113
- ```ts
2114
- prev(from): Promisable<HydratedBlock | undefined>;
2115
- ```
2116
-
2117
- #### Parameters
2118
-
2119
- ##### from
2120
-
2121
- `HydratedBlock`
2122
-
2123
- #### Returns
2124
-
2125
- `Promisable`\<`HydratedBlock` \| `undefined`\>
2126
-
2127
- ### Call Signature
2128
-
2129
- ```ts
2130
- prev(from, count): Promisable<HydratedBlock[]>;
2131
- ```
2132
-
2133
- #### Parameters
2134
-
2135
- ##### from
2136
-
2137
- `HydratedBlock`
2138
-
2139
- ##### count
2140
-
2141
- `number`
2142
-
2143
- #### Returns
2144
-
2145
- `Promisable`\<`HydratedBlock`[]\>
2146
-
2147
- ### <a id="IndexedHydratedBlockStoreInstance"></a>IndexedHydratedBlockStoreInstance
2148
-
2149
- [**@xyo-network/chain-wrappers**](#../README)
2150
-
2151
- ***
2152
-
2153
- ## Extends
2154
-
2155
- - [`HydratedBlockStoreInstance`](#HydratedBlockStoreInstance)
2156
-
2157
- ## Extended by
2158
-
2159
- - [`IndexedHydratedBlockRangeStoreInstance`](#IndexedHydratedBlockRangeStoreInstance)
2160
-
2161
- ## Methods
2162
-
2163
- ### fromHash()
2164
-
2165
- ```ts
2166
- fromHash(hash): Promisable<HydratedBlock | undefined>;
2167
- ```
2168
-
2169
- ### Parameters
2170
-
2171
- #### hash
2172
-
2173
- `Hash`
2174
-
2175
- ### Returns
2176
-
2177
- `Promisable`\<`HydratedBlock` \| `undefined`\>
2178
-
2179
- ### Inherited from
2180
-
2181
- [`HydratedBlockStoreInstance`](#HydratedBlockStoreInstance).[`fromHash`](HydratedBlockStoreInstance.md#fromhash)
2182
-
2183
- ***
2184
-
2185
- ### fromNumber()
2186
-
2187
- ```ts
2188
- fromNumber(number): Promisable<HydratedBlock | undefined>;
2189
- ```
2190
-
2191
- ### Parameters
2192
-
2193
- #### number
2194
-
2195
- `number`
2196
-
2197
- ### Returns
2198
-
2199
- `Promisable`\<`HydratedBlock` \| `undefined`\>
2200
-
2201
- ### type-aliases
2202
-
2203
- ### <a id="HydratedBlockStoreParams"></a>HydratedBlockStoreParams
2204
-
2205
- [**@xyo-network/chain-wrappers**](#../README)
2206
-
2207
- ***
2208
-
2209
- ```ts
2210
- type HydratedBlockStoreParams<TAdditionalParams> = BaseParams<object & TAdditionalParams>;
2211
- ```
2212
-
2213
- ## Type Parameters
2214
-
2215
- ### TAdditionalParams
2216
-
2217
- `TAdditionalParams` *extends* `EmptyObject` = `EmptyObject`
2218
-
2219
- ### variables
2220
-
2221
- ### <a id="createSignatureWrappers"></a>createSignatureWrappers
2222
-
2223
- [**@xyo-network/chain-wrappers**](#../README)
2224
-
2225
- ***
2226
-
2227
- ```ts
2228
- const createSignatureWrappers: (bw) => Promise<SignatureInstance[]>;
10
+ ```sh
11
+ {{pm}} add {{name}}
2229
12
  ```
2230
13
 
2231
- ## Parameters
2232
-
2233
- ### bw
2234
-
2235
- `BoundWitness`
2236
-
2237
- ## Returns
2238
-
2239
- `Promise`\<`SignatureInstance`[]\>
2240
-
2241
-
2242
- ## Maintainers
2243
-
2244
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
2245
- - [Matt Jones](https://github.com/jonesmac)
2246
- - [Joel Carter](https://github.com/JoelBCarter)
2247
- - [Jordan Trouw](https://github.com/jordantrouw)
2248
14
 
2249
15
  ## License
2250
16
 
2251
- > See the [LICENSE](LICENSE) file for license details
17
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
2252
18
 
2253
- ## Credits
2254
19
 
2255
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
2256
-
2257
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
2258
20
 
2259
21
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-wrappers.svg
2260
22
  [npm-link]: https://www.npmjs.com/package/@xyo-network/chain-wrappers
2261
-
2262
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/chain-wrappers
2263
- [npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-wrappers
2264
-
2265
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/chain-wrappers/badge
2266
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-wrappers
2267
-
2268
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/chain-wrappers
2269
- [socket-link]: https://socket.dev/npm/package/@xyo-network/chain-wrappers
23
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-wrappers.svg
24
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE