@xyo-network/xl1-cli-lib 1.7.4 → 1.7.6

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