@xyo-network/xl1-cli-lib 1.20.15 → 1.20.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.
package/README.md CHANGED
@@ -1,2846 +1,24 @@
1
1
  # @xyo-network/xl1-cli-lib
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 CLI Library
10
7
 
11
- XYO Layer One CLI Library
8
+ ## Install
12
9
 
13
-
14
-
15
- ## Reference
16
-
17
- **@xyo-network/xl1-cli-lib**
18
-
19
- ***
20
-
21
- ## Classes
22
-
23
- - [BalanceActor](#classes/BalanceActor)
24
- - [ChainHeadUpdateActor](#classes/ChainHeadUpdateActor)
25
- - [ProducerActor](#classes/ProducerActor)
26
- - [ValidatorActor](#classes/ValidatorActor)
27
- - [Actor](#classes/Actor)
28
- - [Orchestrator](#classes/Orchestrator)
29
- - [RuntimeStatusMonitor](#classes/RuntimeStatusMonitor)
30
- - [LoggerStatusReporter](#classes/LoggerStatusReporter)
31
-
32
- ## Interfaces
33
-
34
- - [IActor](#interfaces/IActor)
35
- - [IOrchestrator](#interfaces/IOrchestrator)
36
-
37
- ## Type Aliases
38
-
39
- - [BalanceActorParams](#type-aliases/BalanceActorParams)
40
- - [ChainHeadUpdateActorParams](#type-aliases/ChainHeadUpdateActorParams)
41
- - [ProducerActorParams](#type-aliases/ProducerActorParams)
42
- - [ValidatorActorParams](#type-aliases/ValidatorActorParams)
43
- - [ActorParams](#type-aliases/ActorParams)
44
- - [GlobalTransitionHandler](#type-aliases/GlobalTransitionHandler)
45
- - [TransitionHandler](#type-aliases/TransitionHandler)
46
-
47
- ## Variables
48
-
49
- - [initHealthEndpoints](#variables/initHealthEndpoints)
50
- - [initAccount](#variables/initAccount)
51
- - [initBalanceService](#variables/initBalanceService)
52
- - [initChainService](#variables/initChainService)
53
- - [initHead](#variables/initHead)
54
- - [initChainIterator](#variables/initChainIterator)
55
- - [initStakeIntentService](#variables/initStakeIntentService)
56
- - [initElectionService](#variables/initElectionService)
57
- - [initPendingTransactions](#variables/initPendingTransactions)
58
- - [initBlockProducer](#variables/initBlockProducer)
59
- - [initBlockRewardService](#variables/initBlockRewardService)
60
- - [initTimeService](#variables/initTimeService)
61
- - [initTransferService](#variables/initTransferService)
62
- - [initValidator](#variables/initValidator)
63
-
64
- ## Functions
65
-
66
- - [initServices](#functions/initServices)
67
- - [initEvmProvider](#functions/initEvmProvider)
68
- - [canUseEvmProvider](#functions/canUseEvmProvider)
69
- - [runCLI](#functions/runCLI)
70
- - [start](#functions/start)
71
-
72
- ### classes
73
-
74
- ### <a id="Actor"></a>Actor
75
-
76
- [**@xyo-network/xl1-cli-lib**](#../README)
77
-
78
- ***
79
-
80
- ## Extends
81
-
82
- - `Base`\<`TParams`\>
83
-
84
- ## Extended by
85
-
86
- - [`BalanceActor`](#BalanceActor)
87
- - [`ChainHeadUpdateActor`](#ChainHeadUpdateActor)
88
- - [`ProducerActor`](#ProducerActor)
89
- - [`ValidatorActor`](#ValidatorActor)
90
-
91
- ## Type Parameters
92
-
93
- ### TParams
94
-
95
- `TParams` *extends* [`ActorParams`](#../type-aliases/ActorParams) = [`ActorParams`](#../type-aliases/ActorParams)
96
-
97
- ## Implements
98
-
99
- - [`IActor`](#../interfaces/IActor)
100
-
101
- ## Constructors
102
-
103
- ### Constructor
104
-
105
- ```ts
106
- new Actor<TParams>(
107
- id,
108
- displayName,
109
- params): Actor<TParams>;
110
- ```
111
-
112
- ### Parameters
113
-
114
- #### id
115
-
116
- `string`
117
-
118
- #### displayName
119
-
120
- `string` = `'Actor'`
121
-
122
- #### params
123
-
124
- `TParams`
125
-
126
- ### Returns
127
-
128
- `Actor`\<`TParams`\>
129
-
130
- ### Overrides
131
-
132
- ```ts
133
- Base<TParams>.constructor
134
- ```
135
-
136
- ## Properties
137
-
138
- ### \_intervals
139
-
140
- ```ts
141
- protected readonly _intervals: Map<string, Timeout>;
142
- ```
143
-
144
- ***
145
-
146
- ### \_semaphores
147
-
148
- ```ts
149
- protected readonly _semaphores: Map<string, Semaphore>;
150
- ```
151
-
152
- ***
153
-
154
- ### \_timeouts
155
-
156
- ```ts
157
- protected readonly _timeouts: Map<string, Timeout>;
158
- ```
159
-
160
- ## Accessors
161
-
162
- ### displayName
163
-
164
- ### Get Signature
165
-
166
- ```ts
167
- get displayName(): string;
168
- ```
169
-
170
- #### Returns
171
-
172
- `string`
173
-
174
- ***
175
-
176
- ### id
177
-
178
- ### Get Signature
179
-
180
- ```ts
181
- get id(): string;
182
- ```
183
-
184
- #### Returns
185
-
186
- `string`
187
-
188
- ***
189
-
190
- ### name
191
-
192
- ### Get Signature
193
-
194
- ```ts
195
- get name(): string;
196
- ```
197
-
198
- #### Returns
199
-
200
- `string`
201
-
202
- ***
203
-
204
- ### logPrefix
205
-
206
- ### Get Signature
207
-
208
- ```ts
209
- get protected logPrefix(): string;
210
- ```
211
-
212
- #### Returns
213
-
214
- `string`
215
-
216
- ## Methods
217
-
218
- ### registerTimer()
219
-
220
- ```ts
221
- registerTimer(
222
- timerName,
223
- callback,
224
- dueTimeMs,
225
- periodMs): void;
226
- ```
227
-
228
- The timer runs until the actor is deactivated (or you manually stop it).
229
-
230
- ### Parameters
231
-
232
- #### timerName
233
-
234
- `string`
235
-
236
- #### callback
237
-
238
- () => `Promise`\<`void`\>
239
-
240
- #### dueTimeMs
241
-
242
- `number`
243
-
244
- #### periodMs
245
-
246
- `number`
247
-
248
- ### Returns
249
-
250
- `void`
251
-
252
- ***
253
-
254
- ### span()
255
-
256
- ```ts
257
- span<T>(name, fn): T;
258
- ```
259
-
260
- ### Type Parameters
261
-
262
- #### T
263
-
264
- `T`
265
-
266
- ### Parameters
267
-
268
- #### name
269
-
270
- `string`
271
-
272
- #### fn
273
-
274
- () => `T`
275
-
276
- ### Returns
277
-
278
- `T`
279
-
280
- ***
281
-
282
- ### spanAsync()
283
-
284
- ```ts
285
- spanAsync<T>(name, fn): Promise<T>;
286
- ```
287
-
288
- ### Type Parameters
289
-
290
- #### T
291
-
292
- `T`
293
-
294
- ### Parameters
295
-
296
- #### name
297
-
298
- `string`
299
-
300
- #### fn
301
-
302
- () => `Promise`\<`T`\>
303
-
304
- ### Returns
305
-
306
- `Promise`\<`T`\>
307
-
308
- ***
309
-
310
- ### start()
311
-
312
- ```ts
313
- start(): Promise<void>;
314
- ```
315
-
316
- Called by the Orchestrator when the actor is activated.
317
-
318
- ### Returns
319
-
320
- `Promise`\<`void`\>
321
-
322
- ### Implementation of
323
-
324
- [`IActor`](#../interfaces/IActor).[`start`](../interfaces/IActor.md#start)
325
-
326
- ***
327
-
328
- ### stop()
329
-
330
- ```ts
331
- stop(): Promise<void>;
332
- ```
333
-
334
- Called by the Orchestrator when the actor is deactivated.
335
- Stop all running timers.
336
-
337
- ### Returns
338
-
339
- `Promise`\<`void`\>
340
-
341
- ### Implementation of
342
-
343
- [`IActor`](#../interfaces/IActor).[`stop`](../interfaces/IActor.md#stop)
344
-
345
- ### <a id="BalanceActor"></a>BalanceActor
346
-
347
- [**@xyo-network/xl1-cli-lib**](#../README)
348
-
349
- ***
350
-
351
- ## Extends
352
-
353
- - [`Actor`](#Actor)\<[`BalanceActorParams`](#../type-aliases/BalanceActorParams)\>
354
-
355
- ## Constructors
356
-
357
- ### Constructor
358
-
359
- ```ts
360
- protected new BalanceActor(params): BalanceActor;
361
- ```
362
-
363
- ### Parameters
364
-
365
- #### params
366
-
367
- [`BalanceActorParams`](#../type-aliases/BalanceActorParams)
368
-
369
- ### Returns
370
-
371
- `BalanceActor`
372
-
373
- ### Overrides
374
-
375
- [`Actor`](#Actor).[`constructor`](Actor.md#constructor)
376
-
377
- ## Properties
378
-
379
- ### \_updateMutex
380
-
381
- ```ts
382
- protected _updateMutex: Mutex;
383
- ```
384
-
385
- ***
386
-
387
- ### \_intervals
388
-
389
- ```ts
390
- protected readonly _intervals: Map<string, Timeout>;
391
- ```
392
-
393
- ### Inherited from
394
-
395
- [`Actor`](#Actor).[`_intervals`](Actor.md#_intervals)
396
-
397
- ***
398
-
399
- ### \_semaphores
400
-
401
- ```ts
402
- protected readonly _semaphores: Map<string, Semaphore>;
403
- ```
404
-
405
- ### Inherited from
406
-
407
- [`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
408
-
409
- ***
410
-
411
- ### \_timeouts
412
-
413
- ```ts
414
- protected readonly _timeouts: Map<string, Timeout>;
415
- ```
416
-
417
- ### Inherited from
418
-
419
- [`Actor`](#Actor).[`_timeouts`](Actor.md#_timeouts)
420
-
421
- ## Accessors
422
-
423
- ### balanceService
424
-
425
- ### Get Signature
426
-
427
- ```ts
428
- get protected balanceService(): AccountBalanceService;
429
- ```
430
-
431
- #### Returns
432
-
433
- `AccountBalanceService`
434
-
435
- ***
436
-
437
- ### chainIterator
438
-
439
- ### Get Signature
440
-
441
- ```ts
442
- get protected chainIterator(): EventingChainBlockNumberIteratorService;
443
- ```
444
-
445
- #### Returns
446
-
447
- `EventingChainBlockNumberIteratorService`
448
-
449
- ***
450
-
451
- ### displayName
452
-
453
- ### Get Signature
454
-
455
- ```ts
456
- get displayName(): string;
457
- ```
458
-
459
- #### Returns
460
-
461
- `string`
462
-
463
- ### Inherited from
464
-
465
- [`Actor`](#Actor).[`displayName`](Actor.md#displayname)
466
-
467
- ***
468
-
469
- ### id
470
-
471
- ### Get Signature
472
-
473
- ```ts
474
- get id(): string;
475
- ```
476
-
477
- #### Returns
478
-
479
- `string`
480
-
481
- ### Inherited from
482
-
483
- [`Actor`](#Actor).[`id`](Actor.md#id)
484
-
485
- ***
486
-
487
- ### name
488
-
489
- ### Get Signature
490
-
491
- ```ts
492
- get name(): string;
493
- ```
494
-
495
- #### Returns
496
-
497
- `string`
498
-
499
- ### Inherited from
500
-
501
- [`Actor`](#Actor).[`name`](Actor.md#name)
502
-
503
- ***
504
-
505
- ### logPrefix
506
-
507
- ### Get Signature
508
-
509
- ```ts
510
- get protected logPrefix(): string;
511
- ```
512
-
513
- #### Returns
514
-
515
- `string`
516
-
517
- ### Inherited from
518
-
519
- [`Actor`](#Actor).[`logPrefix`](Actor.md#logprefix)
520
-
521
- ## Methods
522
-
523
- ### create()
524
-
525
- ```ts
526
- static create(params): Promisable<BalanceActor>;
527
- ```
528
-
529
- ### Parameters
530
-
531
- #### params
532
-
533
- [`BalanceActorParams`](#../type-aliases/BalanceActorParams)
534
-
535
- ### Returns
536
-
537
- `Promisable`\<`BalanceActor`\>
538
-
539
- ***
540
-
541
- ### start()
542
-
543
- ```ts
544
- start(): Promise<void>;
545
- ```
546
-
547
- Called by the Orchestrator when the actor is activated.
548
-
549
- ### Returns
550
-
551
- `Promise`\<`void`\>
552
-
553
- ### Overrides
554
-
555
- [`Actor`](#Actor).[`start`](Actor.md#start)
556
-
557
- ***
558
-
559
- ### updateBalance()
560
-
561
- ```ts
562
- protected updateBalance(): Promise<void>;
563
- ```
564
-
565
- ### Returns
566
-
567
- `Promise`\<`void`\>
568
-
569
- ***
570
-
571
- ### registerTimer()
572
-
573
- ```ts
574
- registerTimer(
575
- timerName,
576
- callback,
577
- dueTimeMs,
578
- periodMs): void;
579
- ```
580
-
581
- The timer runs until the actor is deactivated (or you manually stop it).
582
-
583
- ### Parameters
584
-
585
- #### timerName
586
-
587
- `string`
588
-
589
- #### callback
590
-
591
- () => `Promise`\<`void`\>
592
-
593
- #### dueTimeMs
594
-
595
- `number`
596
-
597
- #### periodMs
598
-
599
- `number`
600
-
601
- ### Returns
602
-
603
- `void`
604
-
605
- ### Inherited from
606
-
607
- [`Actor`](#Actor).[`registerTimer`](Actor.md#registertimer)
608
-
609
- ***
610
-
611
- ### span()
612
-
613
- ```ts
614
- span<T>(name, fn): T;
615
- ```
616
-
617
- ### Type Parameters
618
-
619
- #### T
620
-
621
- `T`
622
-
623
- ### Parameters
624
-
625
- #### name
626
-
627
- `string`
628
-
629
- #### fn
630
-
631
- () => `T`
632
-
633
- ### Returns
634
-
635
- `T`
636
-
637
- ### Inherited from
638
-
639
- [`Actor`](#Actor).[`span`](Actor.md#span)
640
-
641
- ***
642
-
643
- ### spanAsync()
644
-
645
- ```ts
646
- spanAsync<T>(name, fn): Promise<T>;
647
- ```
648
-
649
- ### Type Parameters
650
-
651
- #### T
652
-
653
- `T`
654
-
655
- ### Parameters
656
-
657
- #### name
658
-
659
- `string`
660
-
661
- #### fn
662
-
663
- () => `Promise`\<`T`\>
664
-
665
- ### Returns
666
-
667
- `Promise`\<`T`\>
668
-
669
- ### Inherited from
670
-
671
- [`Actor`](#Actor).[`spanAsync`](Actor.md#spanasync)
672
-
673
- ***
674
-
675
- ### stop()
676
-
677
- ```ts
678
- stop(): Promise<void>;
679
- ```
680
-
681
- Called by the Orchestrator when the actor is deactivated.
682
- Stop all running timers.
683
-
684
- ### Returns
685
-
686
- `Promise`\<`void`\>
687
-
688
- ### Inherited from
689
-
690
- [`Actor`](#Actor).[`stop`](Actor.md#stop)
691
-
692
- ### <a id="ChainHeadUpdateActor"></a>ChainHeadUpdateActor
693
-
694
- [**@xyo-network/xl1-cli-lib**](#../README)
695
-
696
- ***
697
-
698
- ## Extends
699
-
700
- - [`Actor`](#Actor)\<[`ChainHeadUpdateActorParams`](#../type-aliases/ChainHeadUpdateActorParams)\>
701
-
702
- ## Constructors
703
-
704
- ### Constructor
705
-
706
- ```ts
707
- protected new ChainHeadUpdateActor(params): ChainHeadUpdateActor;
708
- ```
709
-
710
- ### Parameters
711
-
712
- #### params
713
-
714
- [`ChainHeadUpdateActorParams`](#../type-aliases/ChainHeadUpdateActorParams)
715
-
716
- ### Returns
717
-
718
- `ChainHeadUpdateActor`
719
-
720
- ### Overrides
721
-
722
- [`Actor`](#Actor).[`constructor`](Actor.md#constructor)
723
-
724
- ## Properties
725
-
726
- ### \_intervals
727
-
728
- ```ts
729
- protected readonly _intervals: Map<string, Timeout>;
730
- ```
731
-
732
- ### Inherited from
733
-
734
- [`Actor`](#Actor).[`_intervals`](Actor.md#_intervals)
735
-
736
- ***
737
-
738
- ### \_semaphores
739
-
740
- ```ts
741
- protected readonly _semaphores: Map<string, Semaphore>;
742
- ```
743
-
744
- ### Inherited from
745
-
746
- [`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
747
-
748
- ***
749
-
750
- ### \_timeouts
751
-
752
- ```ts
753
- protected readonly _timeouts: Map<string, Timeout>;
754
- ```
755
-
756
- ### Inherited from
757
-
758
- [`Actor`](#Actor).[`_timeouts`](Actor.md#_timeouts)
759
-
760
- ## Accessors
761
-
762
- ### chainFinalizedArchivist
763
-
764
- ### Get Signature
765
-
766
- ```ts
767
- get protected chainFinalizedArchivist(): ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>;
768
- ```
769
-
770
- #### Returns
771
-
772
- `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
773
-
774
- ***
775
-
776
- ### chainIterator
777
-
778
- ### Get Signature
779
-
780
- ```ts
781
- get protected chainIterator(): EventingChainBlockNumberIteratorService;
782
- ```
783
-
784
- #### Returns
785
-
786
- `EventingChainBlockNumberIteratorService`
787
-
788
- ***
789
-
790
- ### displayName
791
-
792
- ### Get Signature
793
-
794
- ```ts
795
- get displayName(): string;
796
- ```
797
-
798
- #### Returns
799
-
800
- `string`
801
-
802
- ### Inherited from
803
-
804
- [`Actor`](#Actor).[`displayName`](Actor.md#displayname)
805
-
806
- ***
807
-
808
- ### id
809
-
810
- ### Get Signature
811
-
812
- ```ts
813
- get id(): string;
814
- ```
815
-
816
- #### Returns
817
-
818
- `string`
819
-
820
- ### Inherited from
821
-
822
- [`Actor`](#Actor).[`id`](Actor.md#id)
823
-
824
- ***
825
-
826
- ### name
827
-
828
- ### Get Signature
829
-
830
- ```ts
831
- get name(): string;
832
- ```
833
-
834
- #### Returns
835
-
836
- `string`
837
-
838
- ### Inherited from
839
-
840
- [`Actor`](#Actor).[`name`](Actor.md#name)
841
-
842
- ***
843
-
844
- ### logPrefix
845
-
846
- ### Get Signature
847
-
848
- ```ts
849
- get protected logPrefix(): string;
850
- ```
851
-
852
- #### Returns
853
-
854
- `string`
855
-
856
- ### Inherited from
857
-
858
- [`Actor`](#Actor).[`logPrefix`](Actor.md#logprefix)
859
-
860
- ## Methods
861
-
862
- ### create()
863
-
864
- ```ts
865
- static create(params): Promisable<ChainHeadUpdateActor>;
866
- ```
867
-
868
- ### Parameters
869
-
870
- #### params
871
-
872
- [`ChainHeadUpdateActorParams`](#../type-aliases/ChainHeadUpdateActorParams)
873
-
874
- ### Returns
875
-
876
- `Promisable`\<`ChainHeadUpdateActor`\>
877
-
878
- ***
879
-
880
- ### start()
881
-
882
- ```ts
883
- start(): Promise<void>;
884
- ```
885
-
886
- Called by the Orchestrator when the actor is activated.
887
-
888
- ### Returns
889
-
890
- `Promise`\<`void`\>
891
-
892
- ### Overrides
893
-
894
- [`Actor`](#Actor).[`start`](Actor.md#start)
895
-
896
- ***
897
-
898
- ### registerTimer()
899
-
900
- ```ts
901
- registerTimer(
902
- timerName,
903
- callback,
904
- dueTimeMs,
905
- periodMs): void;
906
- ```
907
-
908
- The timer runs until the actor is deactivated (or you manually stop it).
909
-
910
- ### Parameters
911
-
912
- #### timerName
913
-
914
- `string`
915
-
916
- #### callback
917
-
918
- () => `Promise`\<`void`\>
919
-
920
- #### dueTimeMs
921
-
922
- `number`
923
-
924
- #### periodMs
925
-
926
- `number`
927
-
928
- ### Returns
929
-
930
- `void`
931
-
932
- ### Inherited from
933
-
934
- [`Actor`](#Actor).[`registerTimer`](Actor.md#registertimer)
935
-
936
- ***
937
-
938
- ### span()
939
-
940
- ```ts
941
- span<T>(name, fn): T;
942
- ```
943
-
944
- ### Type Parameters
945
-
946
- #### T
947
-
948
- `T`
949
-
950
- ### Parameters
951
-
952
- #### name
953
-
954
- `string`
955
-
956
- #### fn
957
-
958
- () => `T`
959
-
960
- ### Returns
961
-
962
- `T`
963
-
964
- ### Inherited from
965
-
966
- [`Actor`](#Actor).[`span`](Actor.md#span)
967
-
968
- ***
969
-
970
- ### spanAsync()
971
-
972
- ```ts
973
- spanAsync<T>(name, fn): Promise<T>;
974
- ```
975
-
976
- ### Type Parameters
977
-
978
- #### T
979
-
980
- `T`
981
-
982
- ### Parameters
983
-
984
- #### name
985
-
986
- `string`
987
-
988
- #### fn
989
-
990
- () => `Promise`\<`T`\>
991
-
992
- ### Returns
993
-
994
- `Promise`\<`T`\>
995
-
996
- ### Inherited from
997
-
998
- [`Actor`](#Actor).[`spanAsync`](Actor.md#spanasync)
999
-
1000
- ***
1001
-
1002
- ### stop()
1003
-
1004
- ```ts
1005
- stop(): Promise<void>;
1006
- ```
1007
-
1008
- Called by the Orchestrator when the actor is deactivated.
1009
- Stop all running timers.
1010
-
1011
- ### Returns
1012
-
1013
- `Promise`\<`void`\>
1014
-
1015
- ### Inherited from
1016
-
1017
- [`Actor`](#Actor).[`stop`](Actor.md#stop)
1018
-
1019
- ### <a id="LoggerStatusReporter"></a>LoggerStatusReporter
1020
-
1021
- [**@xyo-network/xl1-cli-lib**](#../README)
1022
-
1023
- ***
1024
-
1025
- ## Extended by
1026
-
1027
- - [`RuntimeStatusMonitor`](#RuntimeStatusMonitor)
1028
-
1029
- ## Implements
1030
-
1031
- - `CreatableStatusReporter`
1032
-
1033
- ## Constructors
1034
-
1035
- ### Constructor
1036
-
1037
- ```ts
1038
- new LoggerStatusReporter(logger): LoggerStatusReporter;
1039
- ```
1040
-
1041
- ### Parameters
1042
-
1043
- #### logger
1044
-
1045
- `Logger`
1046
-
1047
- ### Returns
1048
-
1049
- `LoggerStatusReporter`
1050
-
1051
- ## Properties
1052
-
1053
- ### logger
1054
-
1055
- ```ts
1056
- protected logger: Logger;
1057
- ```
1058
-
1059
- ***
1060
-
1061
- ### statusMap
1062
-
1063
- ```ts
1064
- protected statusMap: Record<CreatableName, CreatableStatus> = {};
1065
- ```
1066
-
1067
- ## Methods
1068
-
1069
- ### report()
1070
-
1071
- ```ts
1072
- report(
1073
- name,
1074
- status,
1075
- progress?): void;
1076
- ```
1077
-
1078
- ### Parameters
1079
-
1080
- #### name
1081
-
1082
- `CreatableName`
1083
-
1084
- #### status
1085
-
1086
- `CreatableStatus`
1087
-
1088
- #### progress?
1089
-
1090
- `number` | `Error`
1091
-
1092
- ### Returns
1093
-
1094
- `void`
1095
-
1096
- ### Implementation of
1097
-
1098
- ```ts
1099
- CreatableStatusReporter.report
1100
- ```
1101
-
1102
- ### <a id="Orchestrator"></a>Orchestrator
1103
-
1104
- [**@xyo-network/xl1-cli-lib**](#../README)
1105
-
1106
- ***
1107
-
1108
- ## Implements
1109
-
1110
- - [`IOrchestrator`](#../interfaces/IOrchestrator)
1111
-
1112
- ## Constructors
1113
-
1114
- ### Constructor
1115
-
1116
- ```ts
1117
- new Orchestrator(logger?): Orchestrator;
1118
- ```
1119
-
1120
- ### Parameters
1121
-
1122
- #### logger?
1123
-
1124
- `Logger`
1125
-
1126
- ### Returns
1127
-
1128
- `Orchestrator`
1129
-
1130
- ## Properties
1131
-
1132
- ### actors
1133
-
1134
- ```ts
1135
- protected actors: IActor[] = [];
1136
- ```
1137
-
1138
- ***
1139
-
1140
- ### keepAliveHandle
1141
-
1142
- ```ts
1143
- protected keepAliveHandle: Timeout | null = null;
1144
- ```
1145
-
1146
- ***
1147
-
1148
- ### logger?
1149
-
1150
- ```ts
1151
- protected readonly optional logger: Logger;
1152
- ```
1153
-
1154
- ***
1155
-
1156
- ### running
1157
-
1158
- ```ts
1159
- protected running: boolean = false;
1160
- ```
1161
-
1162
- ## Methods
1163
-
1164
- ### registerActor()
1165
-
1166
- ```ts
1167
- registerActor(actor): Promise<void>;
1168
- ```
1169
-
1170
- Registers an actor.
1171
- (We won't activate the actor until `start()` is called.)
1172
-
1173
- ### Parameters
1174
-
1175
- #### actor
1176
-
1177
- [`IActor`](#../interfaces/IActor)
1178
-
1179
- ### Returns
1180
-
1181
- `Promise`\<`void`\>
1182
-
1183
- ***
1184
-
1185
- ### start()
1186
-
1187
- ```ts
1188
- start(): Promise<void>;
1189
- ```
1190
-
1191
- Starts the orchestrator: activates all actors.
1192
-
1193
- ### Returns
1194
-
1195
- `Promise`\<`void`\>
1196
-
1197
- ### Implementation of
1198
-
1199
- [`IOrchestrator`](#../interfaces/IOrchestrator).[`start`](../interfaces/IOrchestrator.md#start)
1200
-
1201
- ***
1202
-
1203
- ### stop()
1204
-
1205
- ```ts
1206
- stop(): Promise<void>;
1207
- ```
1208
-
1209
- Stops the orchestrator: deactivates all actors.
1210
-
1211
- ### Returns
1212
-
1213
- `Promise`\<`void`\>
1214
-
1215
- ### Implementation of
1216
-
1217
- [`IOrchestrator`](#../interfaces/IOrchestrator).[`stop`](../interfaces/IOrchestrator.md#stop)
1218
-
1219
- ### <a id="ProducerActor"></a>ProducerActor
1220
-
1221
- [**@xyo-network/xl1-cli-lib**](#../README)
1222
-
1223
- ***
1224
-
1225
- ## Extends
1226
-
1227
- - [`Actor`](#Actor)\<[`ProducerActorParams`](#../type-aliases/ProducerActorParams)\>
1228
-
1229
- ## Constructors
1230
-
1231
- ### Constructor
1232
-
1233
- ```ts
1234
- protected new ProducerActor(params): ProducerActor;
1235
- ```
1236
-
1237
- ### Parameters
1238
-
1239
- #### params
1240
-
1241
- [`ProducerActorParams`](#../type-aliases/ProducerActorParams)
1242
-
1243
- ### Returns
1244
-
1245
- `ProducerActor`
1246
-
1247
- ### Overrides
1248
-
1249
- [`Actor`](#Actor).[`constructor`](Actor.md#constructor)
1250
-
1251
- ## Properties
1252
-
1253
- ### \_lastProducedBlock
1254
-
1255
- ```ts
1256
- protected _lastProducedBlock: HydratedBlock | undefined;
1257
- ```
1258
-
1259
- ***
1260
-
1261
- ### \_lastRedeclarationIntent
1262
-
1263
- ```ts
1264
- protected _lastRedeclarationIntent: ChainStakeIntent | undefined;
1265
- ```
1266
-
1267
- ***
1268
-
1269
- ### \_intervals
1270
-
1271
- ```ts
1272
- protected readonly _intervals: Map<string, Timeout>;
1273
- ```
1274
-
1275
- ### Inherited from
1276
-
1277
- [`Actor`](#Actor).[`_intervals`](Actor.md#_intervals)
1278
-
1279
- ***
1280
-
1281
- ### \_semaphores
1282
-
1283
- ```ts
1284
- protected readonly _semaphores: Map<string, Semaphore>;
1285
- ```
1286
-
1287
- ### Inherited from
1288
-
1289
- [`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
1290
-
1291
- ***
1292
-
1293
- ### \_timeouts
1294
-
1295
- ```ts
1296
- protected readonly _timeouts: Map<string, Timeout>;
1297
- ```
1298
-
1299
- ### Inherited from
1300
-
1301
- [`Actor`](#Actor).[`_timeouts`](Actor.md#_timeouts)
1302
-
1303
- ## Accessors
1304
-
1305
- ### account
1306
-
1307
- ### Get Signature
1308
-
1309
- ```ts
1310
- get protected account(): WalletInstance;
1311
- ```
1312
-
1313
- #### Returns
1314
-
1315
- `WalletInstance`
1316
-
1317
- ***
1318
-
1319
- ### balanceService
1320
-
1321
- ### Get Signature
1322
-
1323
- ```ts
1324
- get protected balanceService(): AccountBalanceService;
1325
- ```
1326
-
1327
- #### Returns
1328
-
1329
- `AccountBalanceService`
1330
-
1331
- ***
1332
-
1333
- ### chainIterator
1334
-
1335
- ### Get Signature
1336
-
1337
- ```ts
1338
- get protected chainIterator(): EventingChainBlockNumberIteratorService;
1339
- ```
1340
-
1341
- #### Returns
1342
-
1343
- `EventingChainBlockNumberIteratorService`
1344
-
1345
- ***
1346
-
1347
- ### chainStakeViewer
1348
-
1349
- ### Get Signature
1350
-
1351
- ```ts
1352
- get protected chainStakeViewer(): ChainStakeViewer;
1353
- ```
1354
-
1355
- #### Returns
1356
-
1357
- `ChainStakeViewer`
1358
-
1359
- ***
1360
-
1361
- ### chainSubmissionsArchivistWrite
1362
-
1363
- ### Get Signature
1364
-
1365
- ```ts
1366
- get protected chainSubmissionsArchivistWrite(): WriteArchivist<Payload, Payload, Payload, Hash>;
1367
- ```
1368
-
1369
- #### Returns
1370
-
1371
- `WriteArchivist`\<`Payload`, `Payload`, `Payload`, `Hash`\>
1372
-
1373
- ***
1374
-
1375
- ### pendingBundledTransactionsArchivistWrite
1376
-
1377
- ### Get Signature
1378
-
1379
- ```ts
1380
- get protected pendingBundledTransactionsArchivistWrite(): ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>;
1381
- ```
1382
-
1383
- #### Returns
1384
-
1385
- `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
1386
-
1387
- ***
1388
-
1389
- ### producer
1390
-
1391
- ### Get Signature
1392
-
1393
- ```ts
1394
- get protected producer(): BlockProducerService;
1395
- ```
1396
-
1397
- #### Returns
1398
-
1399
- `BlockProducerService`
1400
-
1401
- ***
1402
-
1403
- ### stakeIntentService
1404
-
1405
- ### Get Signature
1406
-
1407
- ```ts
1408
- get protected stakeIntentService(): StakeIntentService;
1409
- ```
1410
-
1411
- #### Returns
1412
-
1413
- `StakeIntentService`
1414
-
1415
- ***
1416
-
1417
- ### displayName
1418
-
1419
- ### Get Signature
1420
-
1421
- ```ts
1422
- get displayName(): string;
1423
- ```
1424
-
1425
- #### Returns
1426
-
1427
- `string`
1428
-
1429
- ### Inherited from
1430
-
1431
- [`Actor`](#Actor).[`displayName`](Actor.md#displayname)
1432
-
1433
- ***
1434
-
1435
- ### id
1436
-
1437
- ### Get Signature
1438
-
1439
- ```ts
1440
- get id(): string;
1441
- ```
1442
-
1443
- #### Returns
1444
-
1445
- `string`
1446
-
1447
- ### Inherited from
1448
-
1449
- [`Actor`](#Actor).[`id`](Actor.md#id)
1450
-
1451
- ***
1452
-
1453
- ### name
1454
-
1455
- ### Get Signature
1456
-
1457
- ```ts
1458
- get name(): string;
1459
- ```
1460
-
1461
- #### Returns
1462
-
1463
- `string`
1464
-
1465
- ### Inherited from
1466
-
1467
- [`Actor`](#Actor).[`name`](Actor.md#name)
1468
-
1469
- ***
1470
-
1471
- ### logPrefix
1472
-
1473
- ### Get Signature
1474
-
1475
- ```ts
1476
- get protected logPrefix(): string;
1477
- ```
1478
-
1479
- #### Returns
1480
-
1481
- `string`
1482
-
1483
- ### Inherited from
1484
-
1485
- [`Actor`](#Actor).[`logPrefix`](Actor.md#logprefix)
1486
-
1487
- ## Methods
1488
-
1489
- ### create()
1490
-
1491
- ```ts
1492
- static create(params): Promisable<ProducerActor>;
1493
- ```
1494
-
1495
- ### Parameters
1496
-
1497
- #### params
1498
-
1499
- [`ProducerActorParams`](#../type-aliases/ProducerActorParams)
1500
-
1501
- ### Returns
1502
-
1503
- `Promisable`\<`ProducerActor`\>
1504
-
1505
- ***
1506
-
1507
- ### start()
1508
-
1509
- ```ts
1510
- start(): Promise<void>;
1511
- ```
1512
-
1513
- Called by the Orchestrator when the actor is activated.
1514
-
1515
- ### Returns
1516
-
1517
- `Promise`\<`void`\>
1518
-
1519
- ### Overrides
1520
-
1521
- [`Actor`](#Actor).[`start`](Actor.md#start)
1522
-
1523
- ***
1524
-
1525
- ### calculateBlocksUntilProducerDeclarationExpiration()
1526
-
1527
- ```ts
1528
- protected calculateBlocksUntilProducerDeclarationExpiration(currentBlock): Promise<number>;
1529
- ```
1530
-
1531
- ### Parameters
1532
-
1533
- #### currentBlock
1534
-
1535
- `number`
1536
-
1537
- ### Returns
1538
-
1539
- `Promise`\<`number`\>
1540
-
1541
- ***
1542
-
1543
- ### produceBlock()
1544
-
1545
- ```ts
1546
- protected produceBlock(): Promise<void>;
1547
- ```
1548
-
1549
- ### Returns
1550
-
1551
- `Promise`\<`void`\>
1552
-
1553
- ***
1554
-
1555
- ### redeclareIntent()
1556
-
1557
- ```ts
1558
- protected redeclareIntent(): Promise<void>;
1559
- ```
1560
-
1561
- ### Returns
1562
-
1563
- `Promise`\<`void`\>
1564
-
1565
- ***
1566
-
1567
- ### submitRedeclarationIntent()
1568
-
1569
- ```ts
1570
- protected submitRedeclarationIntent(currentBlock, redeclarationIntent): Promise<void>;
1571
- ```
1572
-
1573
- ### Parameters
1574
-
1575
- #### currentBlock
1576
-
1577
- `number`
1578
-
1579
- #### redeclarationIntent
1580
-
1581
- `ChainStakeIntent`
1582
-
1583
- ### Returns
1584
-
1585
- `Promise`\<`void`\>
1586
-
1587
- ***
1588
-
1589
- ### validateCurrentBalance()
1590
-
1591
- ```ts
1592
- protected validateCurrentBalance(): Promise<boolean>;
1593
- ```
1594
-
1595
- ### Returns
1596
-
1597
- `Promise`\<`boolean`\>
1598
-
1599
- ***
1600
-
1601
- ### validateCurrentStake()
1602
-
1603
- ```ts
1604
- protected validateCurrentStake(): Promise<boolean>;
1605
- ```
1606
-
1607
- ### Returns
1608
-
1609
- `Promise`\<`boolean`\>
1610
-
1611
- ***
1612
-
1613
- ### registerTimer()
1614
-
1615
- ```ts
1616
- registerTimer(
1617
- timerName,
1618
- callback,
1619
- dueTimeMs,
1620
- periodMs): void;
1621
- ```
1622
-
1623
- The timer runs until the actor is deactivated (or you manually stop it).
1624
-
1625
- ### Parameters
1626
-
1627
- #### timerName
1628
-
1629
- `string`
1630
-
1631
- #### callback
1632
-
1633
- () => `Promise`\<`void`\>
1634
-
1635
- #### dueTimeMs
1636
-
1637
- `number`
1638
-
1639
- #### periodMs
1640
-
1641
- `number`
1642
-
1643
- ### Returns
1644
-
1645
- `void`
1646
-
1647
- ### Inherited from
1648
-
1649
- [`Actor`](#Actor).[`registerTimer`](Actor.md#registertimer)
1650
-
1651
- ***
1652
-
1653
- ### span()
1654
-
1655
- ```ts
1656
- span<T>(name, fn): T;
1657
- ```
1658
-
1659
- ### Type Parameters
1660
-
1661
- #### T
1662
-
1663
- `T`
1664
-
1665
- ### Parameters
1666
-
1667
- #### name
1668
-
1669
- `string`
1670
-
1671
- #### fn
1672
-
1673
- () => `T`
1674
-
1675
- ### Returns
1676
-
1677
- `T`
1678
-
1679
- ### Inherited from
1680
-
1681
- [`Actor`](#Actor).[`span`](Actor.md#span)
1682
-
1683
- ***
1684
-
1685
- ### spanAsync()
1686
-
1687
- ```ts
1688
- spanAsync<T>(name, fn): Promise<T>;
1689
- ```
1690
-
1691
- ### Type Parameters
1692
-
1693
- #### T
1694
-
1695
- `T`
1696
-
1697
- ### Parameters
1698
-
1699
- #### name
1700
-
1701
- `string`
1702
-
1703
- #### fn
1704
-
1705
- () => `Promise`\<`T`\>
1706
-
1707
- ### Returns
1708
-
1709
- `Promise`\<`T`\>
1710
-
1711
- ### Inherited from
1712
-
1713
- [`Actor`](#Actor).[`spanAsync`](Actor.md#spanasync)
1714
-
1715
- ***
1716
-
1717
- ### stop()
1718
-
1719
- ```ts
1720
- stop(): Promise<void>;
1721
- ```
1722
-
1723
- Called by the Orchestrator when the actor is deactivated.
1724
- Stop all running timers.
1725
-
1726
- ### Returns
1727
-
1728
- `Promise`\<`void`\>
1729
-
1730
- ### Inherited from
1731
-
1732
- [`Actor`](#Actor).[`stop`](Actor.md#stop)
1733
-
1734
- ### <a id="RuntimeStatusMonitor"></a>RuntimeStatusMonitor
1735
-
1736
- [**@xyo-network/xl1-cli-lib**](#../README)
1737
-
1738
- ***
1739
-
1740
- ## Extends
1741
-
1742
- - [`LoggerStatusReporter`](#LoggerStatusReporter)
1743
-
1744
- ## Constructors
1745
-
1746
- ### Constructor
1747
-
1748
- ```ts
1749
- new RuntimeStatusMonitor(logger): RuntimeStatusMonitor;
1750
- ```
1751
-
1752
- ### Parameters
1753
-
1754
- #### logger
1755
-
1756
- `Logger`
1757
-
1758
- ### Returns
1759
-
1760
- `RuntimeStatusMonitor`
1761
-
1762
- ### Inherited from
1763
-
1764
- [`LoggerStatusReporter`](#LoggerStatusReporter).[`constructor`](LoggerStatusReporter.md#constructor)
1765
-
1766
- ## Properties
1767
-
1768
- ### logger
1769
-
1770
- ```ts
1771
- protected logger: Logger;
1772
- ```
1773
-
1774
- ### Inherited from
1775
-
1776
- [`LoggerStatusReporter`](#LoggerStatusReporter).[`logger`](LoggerStatusReporter.md#logger)
1777
-
1778
- ***
1779
-
1780
- ### statusMap
1781
-
1782
- ```ts
1783
- protected statusMap: Record<CreatableName, CreatableStatus> = {};
1784
- ```
1785
-
1786
- ### Inherited from
1787
-
1788
- [`LoggerStatusReporter`](#LoggerStatusReporter).[`statusMap`](LoggerStatusReporter.md#statusmap)
1789
-
1790
- ## Methods
1791
-
1792
- ### getGlobalStatus()
1793
-
1794
- ```ts
1795
- getGlobalStatus(): CreatableStatus;
1796
- ```
1797
-
1798
- ### Returns
1799
-
1800
- `CreatableStatus`
1801
-
1802
- ***
1803
-
1804
- ### getStatus()
1805
-
1806
- ```ts
1807
- getStatus(name): CreatableStatus | undefined;
1808
- ```
1809
-
1810
- ### Parameters
1811
-
1812
- #### name
1813
-
1814
- `CreatableName`
1815
-
1816
- ### Returns
1817
-
1818
- `CreatableStatus` \| `undefined`
1819
-
1820
- ***
1821
-
1822
- ### onGlobalTransition()
1823
-
1824
- ```ts
1825
- onGlobalTransition(match, handler): void;
1826
- ```
1827
-
1828
- ### Parameters
1829
-
1830
- #### match
1831
-
1832
- ##### from?
1833
-
1834
- `CreatableStatus`
1835
-
1836
- ##### to?
1837
-
1838
- `CreatableStatus`
1839
-
1840
- #### handler
1841
-
1842
- (`from`, `to`) => `void`
1843
-
1844
- ### Returns
1845
-
1846
- `void`
1847
-
1848
- ***
1849
-
1850
- ### onTransition()
1851
-
1852
- ```ts
1853
- onTransition(match, handler): void;
1854
- ```
1855
-
1856
- Register a callback to be called on a specific transition.
1857
-
1858
- ### Parameters
1859
-
1860
- #### match
1861
-
1862
- ##### from?
1863
-
1864
- `CreatableStatus`
1865
-
1866
- ##### name
1867
-
1868
- `string`
1869
-
1870
- ##### to?
1871
-
1872
- `CreatableStatus`
1873
-
1874
- #### handler
1875
-
1876
- (`from`, `to`) => `void`
1877
-
1878
- ### Returns
1879
-
1880
- `void`
1881
-
1882
- ***
1883
-
1884
- ### report()
1885
-
1886
- ```ts
1887
- report(
1888
- name,
1889
- status,
1890
- progress?): void;
1891
- ```
1892
-
1893
- ### Parameters
1894
-
1895
- #### name
1896
-
1897
- `CreatableName`
1898
-
1899
- #### status
1900
-
1901
- `CreatableStatus`
1902
-
1903
- #### progress?
1904
-
1905
- `number` | `Error`
1906
-
1907
- ### Returns
1908
-
1909
- `void`
1910
-
1911
- ### Overrides
1912
-
1913
- [`LoggerStatusReporter`](#LoggerStatusReporter).[`report`](LoggerStatusReporter.md#report)
1914
-
1915
- ### <a id="ValidatorActor"></a>ValidatorActor
1916
-
1917
- [**@xyo-network/xl1-cli-lib**](#../README)
1918
-
1919
- ***
1920
-
1921
- ## Extends
1922
-
1923
- - [`Actor`](#Actor)\<[`ValidatorActorParams`](#../type-aliases/ValidatorActorParams)\>
1924
-
1925
- ## Constructors
1926
-
1927
- ### Constructor
1928
-
1929
- ```ts
1930
- protected new ValidatorActor(params): ValidatorActor;
1931
- ```
1932
-
1933
- ### Parameters
1934
-
1935
- #### params
1936
-
1937
- [`ValidatorActorParams`](#../type-aliases/ValidatorActorParams)
1938
-
1939
- ### Returns
1940
-
1941
- `ValidatorActor`
1942
-
1943
- ### Overrides
1944
-
1945
- [`Actor`](#Actor).[`constructor`](Actor.md#constructor)
1946
-
1947
- ## Properties
1948
-
1949
- ### \_lastValidatedBlock
1950
-
1951
- ```ts
1952
- protected _lastValidatedBlock: BlockBoundWitness | undefined;
1953
- ```
1954
-
1955
- ***
1956
-
1957
- ### \_lastValidatedBlockHash
1958
-
1959
- ```ts
1960
- protected _lastValidatedBlockHash: Hash | undefined;
1961
- ```
1962
-
1963
- ***
1964
-
1965
- ### \_intervals
1966
-
1967
- ```ts
1968
- protected readonly _intervals: Map<string, Timeout>;
1969
- ```
1970
-
1971
- ### Inherited from
1972
-
1973
- [`Actor`](#Actor).[`_intervals`](Actor.md#_intervals)
1974
-
1975
- ***
1976
-
1977
- ### \_semaphores
1978
-
1979
- ```ts
1980
- protected readonly _semaphores: Map<string, Semaphore>;
1981
- ```
1982
-
1983
- ### Inherited from
1984
-
1985
- [`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
1986
-
1987
- ***
1988
-
1989
- ### \_timeouts
1990
-
1991
- ```ts
1992
- protected readonly _timeouts: Map<string, Timeout>;
1993
- ```
1994
-
1995
- ### Inherited from
1996
-
1997
- [`Actor`](#Actor).[`_timeouts`](Actor.md#_timeouts)
1998
-
1999
- ## Accessors
2000
-
2001
- ### account
2002
-
2003
- ### Get Signature
2004
-
2005
- ```ts
2006
- get protected account(): WalletInstance;
2007
- ```
2008
-
2009
- #### Returns
2010
-
2011
- `WalletInstance`
2012
-
2013
- ***
2014
-
2015
- ### balanceService
2016
-
2017
- ### Get Signature
2018
-
2019
- ```ts
2020
- get protected balanceService(): AccountBalanceService;
2021
- ```
2022
-
2023
- #### Returns
2024
-
2025
- `AccountBalanceService`
2026
-
2027
- ***
2028
-
2029
- ### chainIterator
2030
-
2031
- ### Get Signature
2032
-
2033
- ```ts
2034
- get protected chainIterator(): EventingChainBlockNumberIteratorService;
2035
- ```
2036
-
2037
- #### Returns
2038
-
2039
- `EventingChainBlockNumberIteratorService`
2040
-
2041
- ***
2042
-
2043
- ### chainStakeViewer
2044
-
2045
- ### Get Signature
2046
-
2047
- ```ts
2048
- get protected chainStakeViewer(): ChainStakeViewer;
2049
- ```
2050
-
2051
- #### Returns
2052
-
2053
- `ChainStakeViewer`
2054
-
2055
- ***
2056
-
2057
- ### chainSubmissionsArchivistWrite
2058
-
2059
- ### Get Signature
2060
-
2061
- ```ts
2062
- get protected chainSubmissionsArchivistWrite(): WriteArchivist<Payload, Payload, Payload, Hash>;
2063
- ```
2064
-
2065
- #### Returns
2066
-
2067
- `WriteArchivist`\<`Payload`, `Payload`, `Payload`, `Hash`\>
2068
-
2069
- ***
2070
-
2071
- ### pendingBundledTransactionsArchivistWrite
2072
-
2073
- ### Get Signature
2074
-
2075
- ```ts
2076
- get protected pendingBundledTransactionsArchivistWrite(): ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>;
2077
- ```
2078
-
2079
- #### Returns
2080
-
2081
- `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
2082
-
2083
- ***
2084
-
2085
- ### stakeIntentService
2086
-
2087
- ### Get Signature
2088
-
2089
- ```ts
2090
- get protected stakeIntentService(): StakeIntentService;
2091
- ```
2092
-
2093
- #### Returns
2094
-
2095
- `StakeIntentService`
2096
-
2097
- ***
2098
-
2099
- ### displayName
2100
-
2101
- ### Get Signature
2102
-
2103
- ```ts
2104
- get displayName(): string;
2105
- ```
2106
-
2107
- #### Returns
2108
-
2109
- `string`
2110
-
2111
- ### Inherited from
2112
-
2113
- [`Actor`](#Actor).[`displayName`](Actor.md#displayname)
2114
-
2115
- ***
2116
-
2117
- ### id
2118
-
2119
- ### Get Signature
2120
-
2121
- ```ts
2122
- get id(): string;
2123
- ```
2124
-
2125
- #### Returns
2126
-
2127
- `string`
2128
-
2129
- ### Inherited from
2130
-
2131
- [`Actor`](#Actor).[`id`](Actor.md#id)
2132
-
2133
- ***
2134
-
2135
- ### name
2136
-
2137
- ### Get Signature
2138
-
2139
- ```ts
2140
- get name(): string;
2141
- ```
2142
-
2143
- #### Returns
2144
-
2145
- `string`
2146
-
2147
- ### Inherited from
2148
-
2149
- [`Actor`](#Actor).[`name`](Actor.md#name)
2150
-
2151
- ***
2152
-
2153
- ### logPrefix
2154
-
2155
- ### Get Signature
2156
-
2157
- ```ts
2158
- get protected logPrefix(): string;
2159
- ```
2160
-
2161
- #### Returns
2162
-
2163
- `string`
2164
-
2165
- ### Inherited from
2166
-
2167
- [`Actor`](#Actor).[`logPrefix`](Actor.md#logprefix)
2168
-
2169
- ## Methods
2170
-
2171
- ### create()
2172
-
2173
- ```ts
2174
- static create(params): Promisable<ValidatorActor>;
2175
- ```
2176
-
2177
- ### Parameters
2178
-
2179
- #### params
2180
-
2181
- [`ValidatorActorParams`](#../type-aliases/ValidatorActorParams)
2182
-
2183
- ### Returns
2184
-
2185
- `Promisable`\<`ValidatorActor`\>
2186
-
2187
- ***
2188
-
2189
- ### start()
2190
-
2191
- ```ts
2192
- start(): Promise<void>;
2193
- ```
2194
-
2195
- Called by the Orchestrator when the actor is activated.
2196
-
2197
- ### Returns
2198
-
2199
- `Promise`\<`void`\>
2200
-
2201
- ### Overrides
2202
-
2203
- [`Actor`](#Actor).[`start`](Actor.md#start)
2204
-
2205
- ***
2206
-
2207
- ### slashInvalidBlock()
2208
-
2209
- ```ts
2210
- protected slashInvalidBlock(_block): Promise<boolean>;
2211
- ```
2212
-
2213
- ### Parameters
2214
-
2215
- #### \_block
2216
-
2217
- `BlockBoundWitness`
2218
-
2219
- ### Returns
2220
-
2221
- `Promise`\<`boolean`\>
2222
-
2223
- ***
2224
-
2225
- ### validateBlock()
2226
-
2227
- ```ts
2228
- protected validateBlock(block): Promise<boolean>;
2229
- ```
2230
-
2231
- ### Parameters
2232
-
2233
- #### block
2234
-
2235
- `BlockBoundWitness`
2236
-
2237
- ### Returns
2238
-
2239
- `Promise`\<`boolean`\>
2240
-
2241
- ***
2242
-
2243
- ### registerTimer()
2244
-
2245
- ```ts
2246
- registerTimer(
2247
- timerName,
2248
- callback,
2249
- dueTimeMs,
2250
- periodMs): void;
2251
- ```
2252
-
2253
- The timer runs until the actor is deactivated (or you manually stop it).
2254
-
2255
- ### Parameters
2256
-
2257
- #### timerName
2258
-
2259
- `string`
2260
-
2261
- #### callback
2262
-
2263
- () => `Promise`\<`void`\>
2264
-
2265
- #### dueTimeMs
2266
-
2267
- `number`
2268
-
2269
- #### periodMs
2270
-
2271
- `number`
2272
-
2273
- ### Returns
2274
-
2275
- `void`
2276
-
2277
- ### Inherited from
2278
-
2279
- [`Actor`](#Actor).[`registerTimer`](Actor.md#registertimer)
2280
-
2281
- ***
2282
-
2283
- ### span()
2284
-
2285
- ```ts
2286
- span<T>(name, fn): T;
10
+ ```sh
11
+ {{pm}} add {{name}}
2287
12
  ```
2288
13
 
2289
- ### Type Parameters
2290
-
2291
- #### T
2292
-
2293
- `T`
2294
-
2295
- ### Parameters
2296
-
2297
- #### name
2298
-
2299
- `string`
2300
-
2301
- #### fn
2302
-
2303
- () => `T`
2304
-
2305
- ### Returns
2306
-
2307
- `T`
2308
-
2309
- ### Inherited from
2310
-
2311
- [`Actor`](#Actor).[`span`](Actor.md#span)
2312
-
2313
- ***
2314
-
2315
- ### spanAsync()
2316
-
2317
- ```ts
2318
- spanAsync<T>(name, fn): Promise<T>;
2319
- ```
2320
-
2321
- ### Type Parameters
2322
-
2323
- #### T
2324
-
2325
- `T`
2326
-
2327
- ### Parameters
2328
-
2329
- #### name
2330
-
2331
- `string`
2332
-
2333
- #### fn
2334
-
2335
- () => `Promise`\<`T`\>
2336
-
2337
- ### Returns
2338
-
2339
- `Promise`\<`T`\>
2340
-
2341
- ### Inherited from
2342
-
2343
- [`Actor`](#Actor).[`spanAsync`](Actor.md#spanasync)
2344
-
2345
- ***
2346
-
2347
- ### stop()
2348
-
2349
- ```ts
2350
- stop(): Promise<void>;
2351
- ```
2352
-
2353
- Called by the Orchestrator when the actor is deactivated.
2354
- Stop all running timers.
2355
-
2356
- ### Returns
2357
-
2358
- `Promise`\<`void`\>
2359
-
2360
- ### Inherited from
2361
-
2362
- [`Actor`](#Actor).[`stop`](Actor.md#stop)
2363
-
2364
- ### functions
2365
-
2366
- ### <a id="canUseEvmProvider"></a>canUseEvmProvider
2367
-
2368
- [**@xyo-network/xl1-cli-lib**](#../README)
2369
-
2370
- ***
2371
-
2372
- ```ts
2373
- function canUseEvmProvider(__namedParameters): boolean;
2374
- ```
2375
-
2376
- ## Parameters
2377
-
2378
- ### \_\_namedParameters
2379
-
2380
- ### config
2381
-
2382
- `Pick`\<`Config`, `"evm"`\>
2383
-
2384
- ## Returns
2385
-
2386
- `boolean`
2387
-
2388
- ### <a id="initEvmProvider"></a>initEvmProvider
2389
-
2390
- [**@xyo-network/xl1-cli-lib**](#../README)
2391
-
2392
- ***
2393
-
2394
- ```ts
2395
- function initEvmProvider(__namedParameters): Promise<Provider>;
2396
- ```
2397
-
2398
- ## Parameters
2399
-
2400
- ### \_\_namedParameters
2401
-
2402
- ### config
2403
-
2404
- `Pick`\<`Config`, `"evm"`\>
2405
-
2406
- ### logger?
2407
-
2408
- `Logger`
2409
-
2410
- ## Returns
2411
-
2412
- `Promise`\<`Provider`\>
2413
-
2414
- ### <a id="initServices"></a>initServices
2415
-
2416
- [**@xyo-network/xl1-cli-lib**](#../README)
2417
-
2418
- ***
2419
-
2420
- ```ts
2421
- function initServices(context): Promise<ChainServiceCollectionV2>;
2422
- ```
2423
-
2424
- ## Parameters
2425
-
2426
- ### context
2427
-
2428
- `InitServicesContext`
2429
-
2430
- ## Returns
2431
-
2432
- `Promise`\<`ChainServiceCollectionV2`\>
2433
-
2434
- ### <a id="runCLI"></a>runCLI
2435
-
2436
- [**@xyo-network/xl1-cli-lib**](#../README)
2437
-
2438
- ***
2439
-
2440
- ```ts
2441
- function runCLI(): Promise<void>;
2442
- ```
2443
-
2444
- ## Returns
2445
-
2446
- `Promise`\<`void`\>
2447
-
2448
- ### <a id="start"></a>start
2449
-
2450
- [**@xyo-network/xl1-cli-lib**](#../README)
2451
-
2452
- ***
2453
-
2454
- ```ts
2455
- function start(): Promise<void>;
2456
- ```
2457
-
2458
- ## Returns
2459
-
2460
- `Promise`\<`void`\>
2461
-
2462
- ### interfaces
2463
-
2464
- ### <a id="IActor"></a>IActor
2465
-
2466
- [**@xyo-network/xl1-cli-lib**](#../README)
2467
-
2468
- ***
2469
-
2470
- ## Methods
2471
-
2472
- ### start()
2473
-
2474
- ```ts
2475
- start(): Promise<void>;
2476
- ```
2477
-
2478
- ### Returns
2479
-
2480
- `Promise`\<`void`\>
2481
-
2482
- ***
2483
-
2484
- ### stop()
2485
-
2486
- ```ts
2487
- stop(): Promise<void>;
2488
- ```
2489
-
2490
- ### Returns
2491
-
2492
- `Promise`\<`void`\>
2493
-
2494
- ### <a id="IOrchestrator"></a>IOrchestrator
2495
-
2496
- [**@xyo-network/xl1-cli-lib**](#../README)
2497
-
2498
- ***
2499
-
2500
- ## Methods
2501
-
2502
- ### start()
2503
-
2504
- ```ts
2505
- start(): Promise<void>;
2506
- ```
2507
-
2508
- ### Returns
2509
-
2510
- `Promise`\<`void`\>
2511
-
2512
- ***
2513
-
2514
- ### stop()
2515
-
2516
- ```ts
2517
- stop(): Promise<void>;
2518
- ```
2519
-
2520
- ### Returns
2521
-
2522
- `Promise`\<`void`\>
2523
-
2524
- ### type-aliases
2525
-
2526
- ### <a id="ActorParams"></a>ActorParams
2527
-
2528
- [**@xyo-network/xl1-cli-lib**](#../README)
2529
-
2530
- ***
2531
-
2532
- ```ts
2533
- type ActorParams<T> = BaseParams<object & T extends void ? EmptyObject : T>;
2534
- ```
2535
-
2536
- ## Type Parameters
2537
-
2538
- ### T
2539
-
2540
- `T` *extends* `EmptyObject` \| `void` = `void`
2541
-
2542
- ### <a id="BalanceActorParams"></a>BalanceActorParams
2543
-
2544
- [**@xyo-network/xl1-cli-lib**](#../README)
2545
-
2546
- ***
2547
-
2548
- ```ts
2549
- type BalanceActorParams = ActorParams<Pick<ChainServiceCollectionV2, "balance" | "chainIterator"> & object>;
2550
- ```
2551
-
2552
- ### <a id="ChainHeadUpdateActorParams"></a>ChainHeadUpdateActorParams
2553
-
2554
- [**@xyo-network/xl1-cli-lib**](#../README)
2555
-
2556
- ***
2557
-
2558
- ```ts
2559
- type ChainHeadUpdateActorParams = ActorParams<Pick<ChainServiceCollectionV2, "chainIterator" | "chainArchivist"> & object>;
2560
- ```
2561
-
2562
- ### <a id="GlobalTransitionHandler"></a>GlobalTransitionHandler
2563
-
2564
- [**@xyo-network/xl1-cli-lib**](#../README)
2565
-
2566
- ***
2567
-
2568
- ```ts
2569
- type GlobalTransitionHandler = object;
2570
- ```
2571
-
2572
- ## Properties
2573
-
2574
- ### from?
2575
-
2576
- ```ts
2577
- optional from: CreatableStatus;
2578
- ```
2579
-
2580
- ***
2581
-
2582
- ### handler()
2583
-
2584
- ```ts
2585
- handler: (from, to) => void;
2586
- ```
2587
-
2588
- ### Parameters
2589
-
2590
- #### from
2591
-
2592
- `CreatableStatus`
2593
-
2594
- #### to
2595
-
2596
- `CreatableStatus`
2597
-
2598
- ### Returns
2599
-
2600
- `void`
2601
-
2602
- ***
2603
-
2604
- ### to?
2605
-
2606
- ```ts
2607
- optional to: CreatableStatus;
2608
- ```
2609
-
2610
- ### <a id="ProducerActorParams"></a>ProducerActorParams
2611
-
2612
- [**@xyo-network/xl1-cli-lib**](#../README)
2613
-
2614
- ***
2615
-
2616
- ```ts
2617
- type ProducerActorParams = ActorParams<Pick<ChainServiceCollectionV2,
2618
- | "account"
2619
- | "balance"
2620
- | "chainIterator"
2621
- | "chainStakeViewer"
2622
- | "chainSubmissionsArchivistWrite"
2623
- | "pendingBundledTransactionsArchivistWrite"
2624
- | "producer"
2625
- | "stakeIntent"> & object>;
2626
- ```
2627
-
2628
- ### <a id="TransitionHandler"></a>TransitionHandler
2629
-
2630
- [**@xyo-network/xl1-cli-lib**](#../README)
2631
-
2632
- ***
2633
-
2634
- ```ts
2635
- type TransitionHandler = GlobalTransitionHandler & object;
2636
- ```
2637
-
2638
- ## Type Declaration
2639
-
2640
- ### name?
2641
-
2642
- ```ts
2643
- optional name: string;
2644
- ```
2645
-
2646
- ### <a id="ValidatorActorParams"></a>ValidatorActorParams
2647
-
2648
- [**@xyo-network/xl1-cli-lib**](#../README)
2649
-
2650
- ***
2651
-
2652
- ```ts
2653
- type ValidatorActorParams = ActorParams<Pick<ChainServiceCollectionV2,
2654
- | "account"
2655
- | "balance"
2656
- | "chainIterator"
2657
- | "chainStakeViewer"
2658
- | "chainSubmissionsArchivistWrite"
2659
- | "pendingBundledTransactionsArchivistWrite"
2660
- | "stakeIntent"> & object>;
2661
- ```
2662
-
2663
- ### variables
2664
-
2665
- ### <a id="initAccount"></a>initAccount
2666
-
2667
- [**@xyo-network/xl1-cli-lib**](#../README)
2668
-
2669
- ***
2670
-
2671
- ```ts
2672
- const initAccount: Initializable<InitializableParams<{
2673
- config: Config;
2674
- }>, WalletInstance>;
2675
- ```
2676
-
2677
- ### <a id="initBalanceService"></a>initBalanceService
2678
-
2679
- [**@xyo-network/xl1-cli-lib**](#../README)
2680
-
2681
- ***
2682
-
2683
- ```ts
2684
- const initBalanceService: Initializable<BaseAccountBalanceServiceParams, AccountBalanceService>;
2685
- ```
2686
-
2687
- ### <a id="initBlockProducer"></a>initBlockProducer
2688
-
2689
- [**@xyo-network/xl1-cli-lib**](#../README)
2690
-
2691
- ***
2692
-
2693
- ```ts
2694
- const initBlockProducer: Initializable<BaseBlockProducerServiceParams, BlockProducerService>;
2695
- ```
2696
-
2697
- ### <a id="initBlockRewardService"></a>initBlockRewardService
2698
-
2699
- [**@xyo-network/xl1-cli-lib**](#../README)
2700
-
2701
- ***
2702
-
2703
- ```ts
2704
- const initBlockRewardService: Initializable<
2705
- | BaseBlockRewardServiceParams<Pick<Config, "evm">>
2706
- | EvmBlockRewardServiceParams, BlockRewardService>;
2707
- ```
2708
-
2709
- ### <a id="initChainIterator"></a>initChainIterator
2710
-
2711
- [**@xyo-network/xl1-cli-lib**](#../README)
2712
-
2713
- ***
2714
-
2715
- ```ts
2716
- const initChainIterator: Initializable<XyoChainIteratorParams, EventingChainBlockNumberIteratorService>;
2717
- ```
2718
-
2719
- ### <a id="initChainService"></a>initChainService
2720
-
2721
- [**@xyo-network/xl1-cli-lib**](#../README)
2722
-
2723
- ***
2724
-
2725
- ```ts
2726
- const initChainService: Initializable<BaseAccountableServiceParams<Pick<Config, "chain" | "evm" | "producer">>, ChainService>;
2727
- ```
2728
-
2729
- ### <a id="initElectionService"></a>initElectionService
2730
-
2731
- [**@xyo-network/xl1-cli-lib**](#../README)
2732
-
2733
- ***
2734
-
2735
- ```ts
2736
- const initElectionService: Initializable<BaseElectionServicesParams, ElectionService>;
2737
- ```
2738
-
2739
- ### <a id="initHead"></a>initHead
2740
-
2741
- [**@xyo-network/xl1-cli-lib**](#../README)
2742
-
2743
- ***
2744
-
2745
- ```ts
2746
- const initHead: Initializable<{
2747
- account: WalletInstance;
2748
- chainArchivist: ArchivistInstance;
2749
- chainService: ChainService;
2750
- chainSubmissionsArchivistWrite: ArchivistInstance;
2751
- }, WithStorageMeta<BlockBoundWitness>>;
2752
- ```
2753
-
2754
- ### <a id="initHealthEndpoints"></a>initHealthEndpoints
2755
-
2756
- [**@xyo-network/xl1-cli-lib**](#../README)
2757
-
2758
- ***
2759
-
2760
- ```ts
2761
- const initHealthEndpoints: Initializable<{
2762
- config: Config;
2763
- logger: Logger;
2764
- statusReporter: RuntimeStatusMonitor;
2765
- }, Server | undefined>;
2766
- ```
2767
-
2768
- ### <a id="initPendingTransactions"></a>initPendingTransactions
2769
-
2770
- [**@xyo-network/xl1-cli-lib**](#../README)
2771
-
2772
- ***
2773
-
2774
- ```ts
2775
- const initPendingTransactions: Initializable<BasePendingTransactionsServiceParams, PendingTransactionsService>;
2776
- ```
2777
-
2778
- ### <a id="initStakeIntentService"></a>initStakeIntentService
2779
-
2780
- [**@xyo-network/xl1-cli-lib**](#../README)
2781
-
2782
- ***
2783
-
2784
- ```ts
2785
- const initStakeIntentService: Initializable<XyoStakeIntentServiceParams, StakeIntentService>;
2786
- ```
2787
-
2788
- ### <a id="initTimeService"></a>initTimeService
2789
-
2790
- [**@xyo-network/xl1-cli-lib**](#../README)
2791
-
2792
- ***
2793
-
2794
- ```ts
2795
- const initTimeService: Initializable<BaseTimeServiceParams<Pick<Config, "evm">>, TimeSyncViewer>;
2796
- ```
2797
-
2798
- ### <a id="initTransferService"></a>initTransferService
2799
-
2800
- [**@xyo-network/xl1-cli-lib**](#../README)
2801
-
2802
- ***
2803
-
2804
- ```ts
2805
- const initTransferService: Initializable<BaseAccountTransferServiceParams, AccountTransfersService>;
2806
- ```
2807
-
2808
- ### <a id="initValidator"></a>initValidator
2809
-
2810
- [**@xyo-network/xl1-cli-lib**](#../README)
2811
-
2812
- ***
2813
-
2814
- ```ts
2815
- const initValidator: Initializable<BaseBlockProducerServiceParams, BlockProducerService>;
2816
- ```
2817
-
2818
-
2819
- ## Maintainers
2820
-
2821
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
2822
- - [Matt Jones](https://github.com/jonesmac)
2823
- - [Joel Carter](https://github.com/JoelBCarter)
2824
- - [Jordan Trouw](https://github.com/jordantrouw)
2825
14
 
2826
15
  ## License
2827
16
 
2828
- > See the [LICENSE](LICENSE) file for license details
17
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
2829
18
 
2830
- ## Credits
2831
19
 
2832
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
2833
-
2834
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
2835
20
 
2836
21
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-cli-lib.svg
2837
22
  [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-cli-lib
2838
-
2839
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/xl1-cli-lib
2840
- [npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-cli-lib
2841
-
2842
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/xl1-cli-lib/badge
2843
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/xl1-cli-lib
2844
-
2845
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/xl1-cli-lib
2846
- [socket-link]: https://socket.dev/npm/package/@xyo-network/xl1-cli-lib
23
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-cli-lib.svg
24
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE