@xyo-network/xl1-providers 1.26.14 → 1.26.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -1161
  2. package/package.json +63 -29
package/README.md CHANGED
@@ -1,1173 +1,24 @@
1
- # @xyo-network/chain-viewers
1
+ # @xyo-network/xl1-providers
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 API
10
7
 
11
- XYO Layer One API
8
+ ## Install
12
9
 
13
-
14
-
15
- ## Reference
16
-
17
- **@xyo-network/chain-viewers**
18
-
19
- ***
20
-
21
- ## Classes
22
-
23
- - [SimpleNetworkStakeViewer](#classes/SimpleNetworkStakeViewer)
24
- - [SimpleStepRewardsByPositionViewer](#classes/SimpleStepRewardsByPositionViewer)
25
- - [SimpleStepRewardsByStakerViewer](#classes/SimpleStepRewardsByStakerViewer)
26
- - [SimpleStepRewardsByStepViewer](#classes/SimpleStepRewardsByStepViewer)
27
- - [SimpleStepRewardsViewer](#classes/SimpleStepRewardsViewer)
28
-
29
- ## Interfaces
30
-
31
- - [SimpleNetworkStakeViewerParams](#interfaces/SimpleNetworkStakeViewerParams)
32
- - [SimpleStepRewardsByPositionViewerParams](#interfaces/SimpleStepRewardsByPositionViewerParams)
33
- - [SimpleStepRewardsByStakerViewerParams](#interfaces/SimpleStepRewardsByStakerViewerParams)
34
- - [SimpleStepRewardsByStepViewerParams](#interfaces/SimpleStepRewardsByStepViewerParams)
35
- - [NodeStepRewardsViewerParams](#interfaces/NodeStepRewardsViewerParams)
36
-
37
- ### classes
38
-
39
- ### <a id="SimpleNetworkStakeViewer"></a>SimpleNetworkStakeViewer
40
-
41
- [**@xyo-network/chain-viewers**](#../README)
42
-
43
- ***
44
-
45
- ## Extends
46
-
47
- - `AbstractCreatable`\<[`SimpleNetworkStakeViewerParams`](#../interfaces/SimpleNetworkStakeViewerParams)\>
48
-
49
- ## Implements
50
-
51
- - `NetworkStakeViewer`
52
-
53
- ## Constructors
54
-
55
- ### Constructor
56
-
57
- ```ts
58
- new SimpleNetworkStakeViewer(key, params): SimpleNetworkStakeViewer;
59
- ```
60
-
61
- ### Parameters
62
-
63
- #### key
64
-
65
- `unknown`
66
-
67
- #### params
68
-
69
- `Partial`\<`TParams` & `RequiredCreatableParams`\>
70
-
71
- ### Returns
72
-
73
- `SimpleNetworkStakeViewer`
74
-
75
- ### Inherited from
76
-
77
- ```ts
78
- AbstractCreatable<SimpleNetworkStakeViewerParams>.constructor
79
- ```
80
-
81
- ## Accessors
82
-
83
- ### context
84
-
85
- ### Get Signature
86
-
87
- ```ts
88
- get context(): StakedChainContextRead;
89
- ```
90
-
91
- #### Returns
92
-
93
- `StakedChainContextRead`
94
-
95
- ***
96
-
97
- ### rewardMultipliers
98
-
99
- ### Get Signature
100
-
101
- ```ts
102
- get rewardMultipliers(): XL1RangeMultipliers | undefined;
103
- ```
104
-
105
- #### Returns
106
-
107
- `XL1RangeMultipliers` \| `undefined`
108
-
109
- ***
110
-
111
- ### stepRewards
112
-
113
- ### Get Signature
114
-
115
- ```ts
116
- get stepRewards(): NetworkStakeStepRewardsViewer;
117
- ```
118
-
119
- #### Returns
120
-
121
- `NetworkStakeStepRewardsViewer`
122
-
123
- ### Implementation of
124
-
125
- ```ts
126
- NetworkStakeViewer.stepRewards
127
- ```
128
-
129
- ## Methods
130
-
131
- ### active()
132
-
133
- ```ts
134
- active(blockNumber?): Promise<[bigint, number]>;
135
- ```
136
-
137
- ### Parameters
138
-
139
- #### blockNumber?
140
-
141
- `number`
142
-
143
- ### Returns
144
-
145
- `Promise`\<\[`bigint`, `number`\]\>
146
-
147
- the active stake and the number of active validators [active, block]
148
-
149
- ### Implementation of
150
-
151
- ```ts
152
- NetworkStakeViewer.active
153
- ```
154
-
155
- ***
156
-
157
- ### createHandler()
158
-
159
- ```ts
160
- createHandler(): Promise<void>;
161
- ```
162
-
163
- ### Returns
164
-
165
- `Promise`\<`void`\>
166
-
167
- ### Overrides
168
-
169
- ```ts
170
- AbstractCreatable.createHandler
171
- ```
172
-
173
- ***
174
-
175
- ### startHandler()
176
-
177
- ```ts
178
- protected startHandler(): Promise<void>;
179
- ```
180
-
181
- ### Returns
182
-
183
- `Promise`\<`void`\>
184
-
185
- ### Overrides
186
-
187
- ```ts
188
- AbstractCreatable.startHandler
189
- ```
190
-
191
- ### <a id="SimpleStepRewardsByPositionViewer"></a>SimpleStepRewardsByPositionViewer
192
-
193
- [**@xyo-network/chain-viewers**](#../README)
194
-
195
- ***
196
-
197
- ## Extends
198
-
199
- - `AbstractCreatable`\<[`SimpleStepRewardsByPositionViewerParams`](#../interfaces/SimpleStepRewardsByPositionViewerParams)\>
200
-
201
- ## Implements
202
-
203
- - `NetworkStakeStepRewardsByPositionViewer`
204
-
205
- ## Constructors
206
-
207
- ### Constructor
208
-
209
- ```ts
210
- new SimpleStepRewardsByPositionViewer(key, params): SimpleStepRewardsByPositionViewer;
211
- ```
212
-
213
- ### Parameters
214
-
215
- #### key
216
-
217
- `unknown`
218
-
219
- #### params
220
-
221
- `Partial`\<`TParams` & `RequiredCreatableParams`\>
222
-
223
- ### Returns
224
-
225
- `SimpleStepRewardsByPositionViewer`
226
-
227
- ### Inherited from
228
-
229
- ```ts
230
- AbstractCreatable<SimpleStepRewardsByPositionViewerParams>.constructor
231
- ```
232
-
233
- ## Accessors
234
-
235
- ### context
236
-
237
- ### Get Signature
238
-
239
- ```ts
240
- get context(): StakedChainContextRead;
241
- ```
242
-
243
- #### Returns
244
-
245
- `StakedChainContextRead`
246
-
247
- ***
248
-
249
- ### rewardMultipliers
250
-
251
- ### Get Signature
252
-
253
- ```ts
254
- get rewardMultipliers(): XL1RangeMultipliers;
255
- ```
256
-
257
- #### Returns
258
-
259
- `XL1RangeMultipliers`
260
-
261
- ## Methods
262
-
263
- ### bonus()
264
-
265
- ```ts
266
- bonus(__namedParameters): Promise<Record<number, AttoXL1>>;
267
- ```
268
-
269
- ### Parameters
270
-
271
- #### \_\_namedParameters
272
-
273
- `NetworkStakeStepRewardsByPositionViewerOptions` = `{}`
274
-
275
- ### Returns
276
-
277
- `Promise`\<`Record`\<`number`, `AttoXL1`\>\>
278
-
279
- ### Implementation of
280
-
281
- ```ts
282
- NetworkStakeStepRewardsByPositionViewer.bonus
283
- ```
284
-
285
- ***
286
-
287
- ### claimed()
288
-
289
- ```ts
290
- claimed(_options?): Promisable<Record<number, AttoXL1>>;
291
- ```
292
-
293
- ### Parameters
294
-
295
- #### \_options?
296
-
297
- `NetworkStakeStepRewardsByPositionViewerOptions`
298
-
299
- ### Returns
300
-
301
- `Promisable`\<`Record`\<`number`, `AttoXL1`\>\>
302
-
303
- ### Implementation of
304
-
305
- ```ts
306
- NetworkStakeStepRewardsByPositionViewer.claimed
307
- ```
308
-
309
- ***
310
-
311
- ### earned()
312
-
313
- ```ts
314
- earned(__namedParameters): Promise<Record<number, AttoXL1>>;
315
- ```
316
-
317
- ### Parameters
318
-
319
- #### \_\_namedParameters
320
-
321
- `NetworkStakeStepRewardsByPositionViewerOptions` = `{}`
322
-
323
- ### Returns
324
-
325
- `Promise`\<`Record`\<`number`, `AttoXL1`\>\>
326
-
327
- ### Implementation of
328
-
329
- ```ts
330
- NetworkStakeStepRewardsByPositionViewer.earned
331
- ```
332
-
333
- ***
334
-
335
- ### total()
336
-
337
- ```ts
338
- total(__namedParameters): Promise<Record<number, AttoXL1>>;
339
- ```
340
-
341
- ### Parameters
342
-
343
- #### \_\_namedParameters
344
-
345
- `NetworkStakeStepRewardsByPositionViewerOptions` = `{}`
346
-
347
- ### Returns
348
-
349
- `Promise`\<`Record`\<`number`, `AttoXL1`\>\>
350
-
351
- ### Implementation of
352
-
353
- ```ts
354
- NetworkStakeStepRewardsByPositionViewer.total
355
- ```
356
-
357
- ***
358
-
359
- ### unclaimed()
360
-
361
- ```ts
362
- unclaimed(_options): Promisable<Record<number, AttoXL1>>;
363
- ```
364
-
365
- ### Parameters
366
-
367
- #### \_options
368
-
369
- `NetworkStakeStepRewardsByPositionViewerOptions` = `{}`
370
-
371
- ### Returns
372
-
373
- `Promisable`\<`Record`\<`number`, `AttoXL1`\>\>
374
-
375
- ### Implementation of
376
-
377
- ```ts
378
- NetworkStakeStepRewardsByPositionViewer.unclaimed
379
- ```
380
-
381
- ***
382
-
383
- ### calculateRewards()
384
-
385
- ```ts
386
- protected calculateRewards(__namedParameters, rewardMultipliers?): Promise<Record<number, AttoXL1>>;
387
- ```
388
-
389
- ### Parameters
390
-
391
- #### \_\_namedParameters
392
-
393
- `NetworkStakeStepRewardsByPositionViewerOptions` = `{}`
394
-
395
- #### rewardMultipliers?
396
-
397
- `XL1RangeMultipliers`
398
-
399
- ### Returns
400
-
401
- `Promise`\<`Record`\<`number`, `AttoXL1`\>\>
402
-
403
- ### <a id="SimpleStepRewardsByStakerViewer"></a>SimpleStepRewardsByStakerViewer
404
-
405
- [**@xyo-network/chain-viewers**](#../README)
406
-
407
- ***
408
-
409
- ## Extends
410
-
411
- - `AbstractCreatable`\<[`SimpleStepRewardsByStakerViewerParams`](#../interfaces/SimpleStepRewardsByStakerViewerParams)\>
412
-
413
- ## Implements
414
-
415
- - `NetworkStakeStepRewardsByStakerViewer`
416
-
417
- ## Constructors
418
-
419
- ### Constructor
420
-
421
- ```ts
422
- new SimpleStepRewardsByStakerViewer(key, params): SimpleStepRewardsByStakerViewer;
423
- ```
424
-
425
- ### Parameters
426
-
427
- #### key
428
-
429
- `unknown`
430
-
431
- #### params
432
-
433
- `Partial`\<`TParams` & `RequiredCreatableParams`\>
434
-
435
- ### Returns
436
-
437
- `SimpleStepRewardsByStakerViewer`
438
-
439
- ### Inherited from
440
-
441
- ```ts
442
- AbstractCreatable<SimpleStepRewardsByStakerViewerParams>.constructor
443
- ```
444
-
445
- ## Accessors
446
-
447
- ### context
448
-
449
- ### Get Signature
450
-
451
- ```ts
452
- get context(): StakedChainContextRead;
453
- ```
454
-
455
- #### Returns
456
-
457
- `StakedChainContextRead`
458
-
459
- ***
460
-
461
- ### rewardMultipliers
462
-
463
- ### Get Signature
464
-
465
- ```ts
466
- get rewardMultipliers(): XL1RangeMultipliers;
467
- ```
468
-
469
- #### Returns
470
-
471
- `XL1RangeMultipliers`
472
-
473
- ***
474
-
475
- ### stakedChainContext
476
-
477
- ### Get Signature
478
-
479
- ```ts
480
- get stakedChainContext(): StakedChainContextRead;
481
- ```
482
-
483
- #### Returns
484
-
485
- `StakedChainContextRead`
486
-
487
- ## Methods
488
-
489
- ### bonus()
490
-
491
- ```ts
492
- bonus(__namedParameters): Promise<Record<Address, AttoXL1>>;
493
- ```
494
-
495
- ### Parameters
496
-
497
- #### \_\_namedParameters
498
-
499
- `NetworkStakeStepRewardsByStakerViewerOptions` = `{}`
500
-
501
- ### Returns
502
-
503
- `Promise`\<`Record`\<`Address`, `AttoXL1`\>\>
504
-
505
- ### Implementation of
506
-
507
- ```ts
508
- NetworkStakeStepRewardsByStakerViewer.bonus
509
- ```
510
-
511
- ***
512
-
513
- ### claimed()
514
-
515
- ```ts
516
- claimed(_options?): Promisable<Record<Address, AttoXL1>>;
517
- ```
518
-
519
- ### Parameters
520
-
521
- #### \_options?
522
-
523
- `NetworkStakeStepRewardsByStakerViewerOptions`
524
-
525
- ### Returns
526
-
527
- `Promisable`\<`Record`\<`Address`, `AttoXL1`\>\>
528
-
529
- ### Implementation of
530
-
531
- ```ts
532
- NetworkStakeStepRewardsByStakerViewer.claimed
533
- ```
534
-
535
- ***
536
-
537
- ### earned()
538
-
539
- ```ts
540
- earned(options): Promise<Record<Address, AttoXL1>>;
541
- ```
542
-
543
- ### Parameters
544
-
545
- #### options
546
-
547
- `NetworkStakeStepRewardsByStakerViewerOptions` = `{}`
548
-
549
- ### Returns
550
-
551
- `Promise`\<`Record`\<`Address`, `AttoXL1`\>\>
552
-
553
- ### Implementation of
554
-
555
- ```ts
556
- NetworkStakeStepRewardsByStakerViewer.earned
557
- ```
558
-
559
- ***
560
-
561
- ### total()
562
-
563
- ```ts
564
- total(options): Promise<Record<Address, AttoXL1>>;
565
- ```
566
-
567
- ### Parameters
568
-
569
- #### options
570
-
571
- `NetworkStakeStepRewardsByStakerViewerOptions` = `{}`
572
-
573
- ### Returns
574
-
575
- `Promise`\<`Record`\<`Address`, `AttoXL1`\>\>
576
-
577
- ### Implementation of
578
-
579
- ```ts
580
- NetworkStakeStepRewardsByStakerViewer.total
581
- ```
582
-
583
- ***
584
-
585
- ### unclaimed()
586
-
587
- ```ts
588
- unclaimed(_options): Promisable<Record<Address, AttoXL1>>;
589
- ```
590
-
591
- ### Parameters
592
-
593
- #### \_options
594
-
595
- `NetworkStakeStepRewardsByStakerViewerOptions` = `{}`
596
-
597
- ### Returns
598
-
599
- `Promisable`\<`Record`\<`Address`, `AttoXL1`\>\>
600
-
601
- ### Implementation of
602
-
603
- ```ts
604
- NetworkStakeStepRewardsByStakerViewer.unclaimed
605
- ```
606
-
607
- ***
608
-
609
- ### calculateRewards()
610
-
611
- ```ts
612
- protected calculateRewards(__namedParameters, rewardMultipliers?): Promise<Record<Address, AttoXL1>>;
613
- ```
614
-
615
- ### Parameters
616
-
617
- #### \_\_namedParameters
618
-
619
- `NetworkStakeStepRewardsByStakerViewerOptions` = `{}`
620
-
621
- #### rewardMultipliers?
622
-
623
- `XL1RangeMultipliers`
624
-
625
- ### Returns
626
-
627
- `Promise`\<`Record`\<`Address`, `AttoXL1`\>\>
628
-
629
- ### <a id="SimpleStepRewardsByStepViewer"></a>SimpleStepRewardsByStepViewer
630
-
631
- [**@xyo-network/chain-viewers**](#../README)
632
-
633
- ***
634
-
635
- ## Extends
636
-
637
- - `AbstractCreatable`\<[`SimpleStepRewardsByStepViewerParams`](#../interfaces/SimpleStepRewardsByStepViewerParams)\>
638
-
639
- ## Implements
640
-
641
- - `NetworkStakeStepRewardsByStepViewer`
642
-
643
- ## Constructors
644
-
645
- ### Constructor
646
-
647
- ```ts
648
- new SimpleStepRewardsByStepViewer(key, params): SimpleStepRewardsByStepViewer;
649
- ```
650
-
651
- ### Parameters
652
-
653
- #### key
654
-
655
- `unknown`
656
-
657
- #### params
658
-
659
- `Partial`\<`TParams` & `RequiredCreatableParams`\>
660
-
661
- ### Returns
662
-
663
- `SimpleStepRewardsByStepViewer`
664
-
665
- ### Inherited from
666
-
667
- ```ts
668
- AbstractCreatable<SimpleStepRewardsByStepViewerParams>.constructor
669
- ```
670
-
671
- ## Accessors
672
-
673
- ### context
674
-
675
- ### Get Signature
676
-
677
- ```ts
678
- get context(): StakedChainContextRead;
679
- ```
680
-
681
- #### Returns
682
-
683
- `StakedChainContextRead`
684
-
685
- ***
686
-
687
- ### rewardMultipliers
688
-
689
- ### Get Signature
690
-
691
- ```ts
692
- get rewardMultipliers(): XL1RangeMultipliers;
693
- ```
694
-
695
- #### Returns
696
-
697
- `XL1RangeMultipliers`
698
-
699
- ## Methods
700
-
701
- ### bonus()
702
-
703
- ```ts
704
- bonus(__namedParameters): Promise<Record<StepIdentityString, AttoXL1>>;
705
- ```
706
-
707
- ### Parameters
708
-
709
- #### \_\_namedParameters
710
-
711
- `NetworkStakeStepRewardsByStepViewerOptions` = `{}`
712
-
713
- ### Returns
714
-
715
- `Promise`\<`Record`\<`StepIdentityString`, `AttoXL1`\>\>
716
-
717
- ### Implementation of
718
-
719
- ```ts
720
- NetworkStakeStepRewardsByStepViewer.bonus
721
- ```
722
-
723
- ***
724
-
725
- ### claimed()
726
-
727
- ```ts
728
- claimed(_options?): Promisable<Record<StepIdentityString, AttoXL1>>;
729
- ```
730
-
731
- ### Parameters
732
-
733
- #### \_options?
734
-
735
- `NetworkStakeStepRewardsByStepViewerOptions`
736
-
737
- ### Returns
738
-
739
- `Promisable`\<`Record`\<`StepIdentityString`, `AttoXL1`\>\>
740
-
741
- ### Implementation of
742
-
743
- ```ts
744
- NetworkStakeStepRewardsByStepViewer.claimed
745
- ```
746
-
747
- ***
748
-
749
- ### earned()
750
-
751
- ```ts
752
- earned(__namedParameters): Promise<Record<StepIdentityString, AttoXL1>>;
753
- ```
754
-
755
- ### Parameters
756
-
757
- #### \_\_namedParameters
758
-
759
- `NetworkStakeStepRewardsByStepViewerOptions` = `{}`
760
-
761
- ### Returns
762
-
763
- `Promise`\<`Record`\<`StepIdentityString`, `AttoXL1`\>\>
764
-
765
- ### Implementation of
766
-
767
- ```ts
768
- NetworkStakeStepRewardsByStepViewer.earned
769
- ```
770
-
771
- ***
772
-
773
- ### total()
774
-
775
- ```ts
776
- total(__namedParameters): Promise<Record<StepIdentityString, AttoXL1>>;
777
- ```
778
-
779
- ### Parameters
780
-
781
- #### \_\_namedParameters
782
-
783
- `NetworkStakeStepRewardsByStepViewerOptions` = `{}`
784
-
785
- ### Returns
786
-
787
- `Promise`\<`Record`\<`StepIdentityString`, `AttoXL1`\>\>
788
-
789
- ### Implementation of
790
-
791
- ```ts
792
- NetworkStakeStepRewardsByStepViewer.total
793
- ```
794
-
795
- ***
796
-
797
- ### unclaimed()
798
-
799
- ```ts
800
- unclaimed(_options): Promisable<Record<StepIdentityString, AttoXL1>>;
801
- ```
802
-
803
- ### Parameters
804
-
805
- #### \_options
806
-
807
- `NetworkStakeStepRewardsByStepViewerOptions` = `{}`
808
-
809
- ### Returns
810
-
811
- `Promisable`\<`Record`\<`StepIdentityString`, `AttoXL1`\>\>
812
-
813
- ### Implementation of
814
-
815
- ```ts
816
- NetworkStakeStepRewardsByStepViewer.unclaimed
817
- ```
818
-
819
- ### <a id="SimpleStepRewardsViewer"></a>SimpleStepRewardsViewer
820
-
821
- [**@xyo-network/chain-viewers**](#../README)
822
-
823
- ***
824
-
825
- ## Extends
826
-
827
- - `AbstractCreatable`\<[`NodeStepRewardsViewerParams`](#../interfaces/NodeStepRewardsViewerParams)\>
828
-
829
- ## Implements
830
-
831
- - `NetworkStakeStepRewardsViewer`
832
-
833
- ## Constructors
834
-
835
- ### Constructor
836
-
837
- ```ts
838
- new SimpleStepRewardsViewer(key, params): SimpleStepRewardsViewer;
839
- ```
840
-
841
- ### Parameters
842
-
843
- #### key
844
-
845
- `unknown`
846
-
847
- #### params
848
-
849
- `Partial`\<`TParams` & `RequiredCreatableParams`\>
850
-
851
- ### Returns
852
-
853
- `SimpleStepRewardsViewer`
854
-
855
- ### Inherited from
856
-
857
- ```ts
858
- AbstractCreatable<NodeStepRewardsViewerParams>.constructor
859
- ```
860
-
861
- ## Accessors
862
-
863
- ### position
864
-
865
- ### Get Signature
866
-
867
- ```ts
868
- get position(): NetworkStakeStepRewardsByPositionViewer;
869
- ```
870
-
871
- #### Returns
872
-
873
- `NetworkStakeStepRewardsByPositionViewer`
874
-
875
- ### Implementation of
876
-
877
- ```ts
878
- NetworkStakeStepRewardsViewer.position
879
- ```
880
-
881
- ***
882
-
883
- ### staker
884
-
885
- ### Get Signature
886
-
887
- ```ts
888
- get staker(): NetworkStakeStepRewardsByStakerViewer;
889
- ```
890
-
891
- #### Returns
892
-
893
- `NetworkStakeStepRewardsByStakerViewer`
894
-
895
- ### Implementation of
896
-
897
- ```ts
898
- NetworkStakeStepRewardsViewer.staker
10
+ ```sh
11
+ {{pm}} add {{name}}
899
12
  ```
900
13
 
901
- ***
902
-
903
- ### step
904
-
905
- ### Get Signature
906
-
907
- ```ts
908
- get step(): NetworkStakeStepRewardsByStepViewer;
909
- ```
910
-
911
- #### Returns
912
-
913
- `NetworkStakeStepRewardsByStepViewer`
914
-
915
- ### Implementation of
916
-
917
- ```ts
918
- NetworkStakeStepRewardsViewer.step
919
- ```
920
-
921
- ***
922
-
923
- ### total
924
-
925
- ### Get Signature
926
-
927
- ```ts
928
- get total(): NetworkStakeStepRewardsTotalViewer;
929
- ```
930
-
931
- #### Returns
932
-
933
- `NetworkStakeStepRewardsTotalViewer`
934
-
935
- ### Implementation of
936
-
937
- ```ts
938
- NetworkStakeStepRewardsViewer.total
939
- ```
940
-
941
- ***
942
-
943
- ### context
944
-
945
- ### Get Signature
946
-
947
- ```ts
948
- get protected context(): StakedChainContextRead;
949
- ```
950
-
951
- #### Returns
952
-
953
- `StakedChainContextRead`
954
-
955
- ***
956
-
957
- ### rewardMultipliers
958
-
959
- ### Get Signature
960
-
961
- ```ts
962
- get protected rewardMultipliers(): XL1RangeMultipliers | undefined;
963
- ```
964
-
965
- #### Returns
966
-
967
- `XL1RangeMultipliers` \| `undefined`
968
-
969
- ## Methods
970
-
971
- ### createHandler()
972
-
973
- ```ts
974
- createHandler(): Promise<void>;
975
- ```
976
-
977
- ### Returns
978
-
979
- `Promise`\<`void`\>
980
-
981
- ### Overrides
982
-
983
- ```ts
984
- AbstractCreatable.createHandler
985
- ```
986
-
987
- ***
988
-
989
- ### startHandler()
990
-
991
- ```ts
992
- protected startHandler(): Promise<void>;
993
- ```
994
-
995
- ### Returns
996
-
997
- `Promise`\<`void`\>
998
-
999
- ### Overrides
1000
-
1001
- ```ts
1002
- AbstractCreatable.startHandler
1003
- ```
1004
-
1005
- ### interfaces
1006
-
1007
- ### <a id="NodeStepRewardsViewerParams"></a>NodeStepRewardsViewerParams
1008
-
1009
- [**@xyo-network/chain-viewers**](#../README)
1010
-
1011
- ***
1012
-
1013
- ## Extends
1014
-
1015
- - `CreatableParams`
1016
-
1017
- ## Properties
1018
-
1019
- ### context
1020
-
1021
- ```ts
1022
- context: StakedChainContextRead;
1023
- ```
1024
-
1025
- ***
1026
-
1027
- ### rewardMultipliers?
1028
-
1029
- ```ts
1030
- optional rewardMultipliers: XL1RangeMultipliers;
1031
- ```
1032
-
1033
- ### <a id="SimpleNetworkStakeViewerParams"></a>SimpleNetworkStakeViewerParams
1034
-
1035
- [**@xyo-network/chain-viewers**](#../README)
1036
-
1037
- ***
1038
-
1039
- ## Extends
1040
-
1041
- - `CreatableParams`
1042
-
1043
- ## Properties
1044
-
1045
- ### context
1046
-
1047
- ```ts
1048
- context: StakedChainContextRead;
1049
- ```
1050
-
1051
- ***
1052
-
1053
- ### rewardMultipliers?
1054
-
1055
- ```ts
1056
- optional rewardMultipliers: XL1RangeMultipliers;
1057
- ```
1058
-
1059
- ### <a id="SimpleStepRewardsByPositionViewerParams"></a>SimpleStepRewardsByPositionViewerParams
1060
-
1061
- [**@xyo-network/chain-viewers**](#../README)
1062
-
1063
- ***
1064
-
1065
- ## Extends
1066
-
1067
- - `CreatableParams`
1068
-
1069
- ## Properties
1070
-
1071
- ### context
1072
-
1073
- ```ts
1074
- context: StakedChainContextRead;
1075
- ```
1076
-
1077
- ***
1078
-
1079
- ### rewardMultipliers?
1080
-
1081
- ```ts
1082
- optional rewardMultipliers: XL1RangeMultipliers;
1083
- ```
1084
-
1085
- ### <a id="SimpleStepRewardsByStakerViewerParams"></a>SimpleStepRewardsByStakerViewerParams
1086
-
1087
- [**@xyo-network/chain-viewers**](#../README)
1088
-
1089
- ***
1090
-
1091
- ## Extends
1092
-
1093
- - `CreatableParams`
1094
-
1095
- ## Properties
1096
-
1097
- ### context
1098
-
1099
- ```ts
1100
- context: StakedChainContextRead;
1101
- ```
1102
-
1103
- ***
1104
-
1105
- ### rewardMultipliers?
1106
-
1107
- ```ts
1108
- optional rewardMultipliers: XL1RangeMultipliers;
1109
- ```
1110
-
1111
- ### <a id="SimpleStepRewardsByStepViewerParams"></a>SimpleStepRewardsByStepViewerParams
1112
-
1113
- [**@xyo-network/chain-viewers**](#../README)
1114
-
1115
- ***
1116
-
1117
- ## Extends
1118
-
1119
- - `CreatableParams`
1120
-
1121
- ## Properties
1122
-
1123
- ### context
1124
-
1125
- ```ts
1126
- context: StakedChainContextRead;
1127
- ```
1128
-
1129
- ***
1130
-
1131
- ### rewardMultipliers?
1132
-
1133
- ```ts
1134
- optional rewardMultipliers: XL1RangeMultipliers;
1135
- ```
1136
-
1137
- ***
1138
-
1139
- ### stakeEventsViewer
1140
-
1141
- ```ts
1142
- stakeEventsViewer: StakeEventsViewer;
1143
- ```
1144
-
1145
-
1146
- ## Maintainers
1147
-
1148
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
1149
- - [Matt Jones](https://github.com/jonesmac)
1150
- - [Joel Carter](https://github.com/JoelBCarter)
1151
- - [Jordan Trouw](https://github.com/jordantrouw)
1152
14
 
1153
15
  ## License
1154
16
 
1155
- > See the [LICENSE](LICENSE) file for license details
1156
-
1157
- ## Credits
1158
-
1159
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
1160
-
1161
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
1162
-
1163
- [npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-viewers.svg
1164
- [npm-link]: https://www.npmjs.com/package/@xyo-network/chain-viewers
17
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
1165
18
 
1166
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/chain-viewers
1167
- [npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-viewers
1168
19
 
1169
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/chain-viewers/badge
1170
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-viewers
1171
20
 
1172
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/chain-viewers
1173
- [socket-link]: https://socket.dev/npm/package/@xyo-network/chain-viewers
21
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-providers.svg
22
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-providers
23
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-providers.svg
24
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xl1-providers",
3
- "version": "1.26.14",
3
+ "version": "1.26.17",
4
4
  "description": "XYO Layer One API",
5
5
  "homepage": "https://xylabs.com",
6
6
  "bugs": {
@@ -36,9 +36,6 @@
36
36
  },
37
37
  "./package.json": "./package.json"
38
38
  },
39
- "module": "./dist/neutral/index.mjs",
40
- "source": "./src/index.ts",
41
- "types": "./dist/neutral/index.d.ts",
42
39
  "files": [
43
40
  "dist",
44
41
  "!**/*.bench.*",
@@ -48,34 +45,75 @@
48
45
  ],
49
46
  "dependencies": {
50
47
  "@opentelemetry/api": "^1.9.1",
51
- "@xyo-network/xl1-protocol-lib": "~1.26.14",
52
- "@xyo-network/xl1-protocol-sdk": "~1.26.14",
53
- "@xyo-network/xl1-rpc": "~1.26.14"
48
+ "@xyo-network/xl1-protocol-lib": "~1.26.17",
49
+ "@xyo-network/xl1-protocol-sdk": "~1.26.17",
50
+ "@xyo-network/xl1-rpc": "~1.26.17"
54
51
  },
55
52
  "devDependencies": {
56
- "@metamask/providers": "^22.1.1",
57
- "@types/node": "^25.5.0",
58
- "@xylabs/geo": "^5.0.93",
59
- "@xylabs/sdk-js": "~5.0.93",
60
- "@xylabs/ts-scripts-common": "~7.6.18",
61
- "@xylabs/ts-scripts-pnpm": "~7.6.18",
62
- "@xylabs/tsconfig": "~7.6.18",
63
- "@xyo-network/sdk-js": "^5.3.25",
64
- "acorn": "^8.16.0",
65
- "ajv": "^8.18.0",
53
+ "@types/node": "^25.5.2",
54
+ "@xylabs/sdk-js": "~5.0.95",
55
+ "@xylabs/ts-scripts-common": "~7.9.0",
56
+ "@xylabs/ts-scripts-pnpm": "~7.9.0",
57
+ "@xylabs/tsconfig": "~7.9.0",
58
+ "@xyo-network/account": "~5.3.30",
59
+ "@xyo-network/account-model": "~5.3.30",
60
+ "@xyo-network/api-models": "~5.3.30",
61
+ "@xyo-network/archivist-abstract": "~5.3.30",
62
+ "@xyo-network/archivist-generic": "~5.3.30",
63
+ "@xyo-network/archivist-memory": "~5.3.30",
64
+ "@xyo-network/archivist-model": "~5.3.30",
65
+ "@xyo-network/archivist-view": "~5.3.30",
66
+ "@xyo-network/archivist-wrapper": "~5.3",
67
+ "@xyo-network/boundwitness-builder": "~5.3.30",
68
+ "@xyo-network/boundwitness-validator": "~5.3.30",
69
+ "@xyo-network/bridge-abstract": "~5.3.30",
70
+ "@xyo-network/bridge-model": "~5.3.30",
71
+ "@xyo-network/config-payload-plugin": "~5.3.30",
72
+ "@xyo-network/data": "~5.3.30",
73
+ "@xyo-network/diviner-abstract": "~5.3",
74
+ "@xyo-network/diviner-boundwitness-memory": "~5.3.30",
75
+ "@xyo-network/diviner-identity": "~5.3.30",
76
+ "@xyo-network/diviner-model": "~5.3.30",
77
+ "@xyo-network/diviner-payload-generic": "~5.3.30",
78
+ "@xyo-network/diviner-payload-model": "~5.3.30",
79
+ "@xyo-network/diviner-wrapper": "~5.3",
80
+ "@xyo-network/dns": "~5.3.30",
81
+ "@xyo-network/domain-payload-plugin": "~5.3.30",
82
+ "@xyo-network/elliptic": "~5.3.30",
83
+ "@xyo-network/hash": "~5.3.30",
84
+ "@xyo-network/huri": "~5.3.30",
85
+ "@xyo-network/manifest-model": "~5.3.30",
86
+ "@xyo-network/module-abstract": "~5.3.30",
87
+ "@xyo-network/module-model": "~5.3.30",
88
+ "@xyo-network/module-resolver": "~5.3.30",
89
+ "@xyo-network/module-wrapper": "~5.3",
90
+ "@xyo-network/network": "~5.3.30",
91
+ "@xyo-network/node-abstract": "~5.3.30",
92
+ "@xyo-network/node-memory": "~5.3.30",
93
+ "@xyo-network/node-model": "~5.3.30",
94
+ "@xyo-network/node-view": "~5.3.30",
95
+ "@xyo-network/node-wrapper": "~5.3",
96
+ "@xyo-network/payload-builder": "~5.3.30",
97
+ "@xyo-network/payload-model": "~5.3.30",
98
+ "@xyo-network/payload-validator": "~5.3.30",
99
+ "@xyo-network/previous-hash-store-model": "~5.3.30",
100
+ "@xyo-network/sdk-js": "^5.3.30",
101
+ "@xyo-network/sentinel-abstract": "~5.3.30",
102
+ "@xyo-network/sentinel-memory": "~5.3.30",
103
+ "@xyo-network/sentinel-model": "~5.3.30",
104
+ "@xyo-network/wallet-model": "~5.3.30",
105
+ "@xyo-network/wasm": "~5.3.30",
106
+ "@xyo-network/witness-adhoc": "~5.3.30",
107
+ "@xyo-network/witness-model": "~5.3.30",
66
108
  "axios": "^1.14.0",
67
- "dotenv": "~17.4.0",
109
+ "dotenv": "~17.4.1",
68
110
  "esbuild": "^0.28.0",
69
111
  "ethers": "^6.16.0",
70
- "firebase": "^12.11.0",
71
- "lru-cache": "^11.2.7",
72
- "mapbox-gl": "^3.21.0",
73
- "mongodb": "^7.1.1",
112
+ "pako": "~2.1.0",
74
113
  "tslib": "^2.8.1",
75
114
  "typescript": "~5.9.3",
76
- "vite": "^8.0.3",
77
- "vitest": "~4.1.2",
78
- "webextension-polyfill": "^0.12.0",
115
+ "vite": "^8.0.7",
116
+ "vitest": "~4.1.3",
79
117
  "zod": "~4.3.6"
80
118
  },
81
119
  "peerDependencies": {
@@ -83,15 +121,11 @@
83
121
  "@xyo-network/sdk-js": "^5",
84
122
  "axios": "^1",
85
123
  "ethers": "^6",
86
- "mongodb": "^6 || ^7",
87
124
  "zod": "^4"
88
125
  },
89
126
  "engines": {
90
127
  "node": ">=22"
91
128
  },
92
- "volta": {
93
- "node": "22.5.1"
94
- },
95
129
  "publishConfig": {
96
130
  "access": "public"
97
131
  },