@xyo-network/diviner-boundwitness-stats 5.3.25 → 5.3.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5176 -10
  2. package/package.json +19 -19
package/README.md CHANGED
@@ -1,23 +1,5189 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/diviner-boundwitness-stats
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
13
+
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
17
+
18
+ Using yarn:
4
19
 
5
- Version: 5.0.2
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
6
23
 
7
- Primary SDK for using XYO Protocol 2.0
24
+ Using pnpm:
8
25
 
9
- ## Documentation
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
10
29
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-boundwitness-stats)
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### modules
46
+
47
+ ### packages
48
+
49
+ ### diviner
50
+
51
+ ### packages
52
+
53
+ ### boundwitnessstats
54
+
55
+ ### .temp-typedoc
56
+
57
+ ### classes
58
+
59
+ ### <a id="BoundWitnessStatsDiviner"></a>BoundWitnessStatsDiviner
60
+
61
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
62
+
63
+ ***
64
+
65
+ ## Extends
66
+
67
+ - `AbstractDiviner`\<`TParams`, `TIn`, `TOut`, `TEventData`\>
68
+
69
+ ## Extended by
70
+
71
+ - [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner)
72
+
73
+ ## Type Parameters
74
+
75
+ ### TParams
76
+
77
+ `TParams` *extends* [`BoundWitnessStatsDivinerParams`](#../type-aliases/BoundWitnessStatsDivinerParams) = [`BoundWitnessStatsDivinerParams`](#../type-aliases/BoundWitnessStatsDivinerParams)
78
+
79
+ ### TIn
80
+
81
+ `TIn` *extends* `Payload` = `Payload`
82
+
83
+ ### TOut
84
+
85
+ `TOut` *extends* `Payload` = `Payload`
86
+
87
+ ### TEventData
88
+
89
+ `TEventData` *extends* `DivinerModuleEventData`\<`DivinerInstance`\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\> = `DivinerModuleEventData`\<`DivinerInstance`\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\>
90
+
91
+ ## Constructors
92
+
93
+ ### Constructor
94
+
95
+ ```ts
96
+ new BoundWitnessStatsDiviner<TParams, TIn, TOut, TEventData>(key, params): BoundWitnessStatsDiviner<TParams, TIn, TOut, TEventData>;
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ #### key
102
+
103
+ `unknown`
104
+
105
+ #### params
106
+
107
+ `Partial`\<`TParams` & `RequiredCreatableParams`\>
108
+
109
+ ### Returns
110
+
111
+ `BoundWitnessStatsDiviner`\<`TParams`, `TIn`, `TOut`, `TEventData`\>
112
+
113
+ ### Inherited from
114
+
115
+ ```ts
116
+ AbstractDiviner<TParams, TIn, TOut, TEventData>.constructor
117
+ ```
118
+
119
+ ## Properties
120
+
121
+ ### configSchemas
122
+
123
+ ```ts
124
+ readonly static configSchemas: Schema[];
125
+ ```
126
+
127
+ ### Inherited from
128
+
129
+ ```ts
130
+ AbstractDiviner.configSchemas
131
+ ```
132
+
133
+ ***
134
+
135
+ ### defaultConfigSchema
136
+
137
+ ```ts
138
+ readonly static defaultConfigSchema: Schema;
139
+ ```
140
+
141
+ ### Inherited from
142
+
143
+ ```ts
144
+ AbstractDiviner.defaultConfigSchema
145
+ ```
146
+
147
+ ***
148
+
149
+ ### targetSchema
150
+
151
+ ```ts
152
+ readonly static targetSchema: Schema;
153
+ ```
154
+
155
+ ### Inherited from
156
+
157
+ ```ts
158
+ AbstractDiviner.targetSchema
159
+ ```
160
+
161
+ ***
162
+
163
+ ### uniqueName
164
+
165
+ ```ts
166
+ readonly static uniqueName: string;
167
+ ```
168
+
169
+ ### Inherited from
170
+
171
+ ```ts
172
+ AbstractDiviner.uniqueName
173
+ ```
174
+
175
+ ***
176
+
177
+ ### allowRandomAccount
178
+
179
+ ```ts
180
+ readonly static allowRandomAccount: boolean;
181
+ ```
182
+
183
+ ### Inherited from
184
+
185
+ ```ts
186
+ AbstractDiviner.allowRandomAccount
187
+ ```
188
+
189
+ ***
190
+
191
+ ### defaultLogger
192
+
193
+ ```ts
194
+ static defaultLogger: Logger;
195
+ ```
196
+
197
+ ### Inherited from
198
+
199
+ ```ts
200
+ AbstractDiviner.defaultLogger
201
+ ```
202
+
203
+ ***
204
+
205
+ ### enableLazyLoad
206
+
207
+ ```ts
208
+ static enableLazyLoad: boolean;
209
+ ```
210
+
211
+ ### Inherited from
212
+
213
+ ```ts
214
+ AbstractDiviner.enableLazyLoad
215
+ ```
216
+
217
+ ***
218
+
219
+ ### labels
220
+
221
+ ```ts
222
+ readonly static labels: Labels;
223
+ ```
224
+
225
+ ### Inherited from
226
+
227
+ ```ts
228
+ AbstractDiviner.labels
229
+ ```
230
+
231
+ ***
232
+
233
+ ### privateConstructorKey
234
+
235
+ ```ts
236
+ protected static privateConstructorKey: string;
237
+ ```
238
+
239
+ ### Inherited from
240
+
241
+ ```ts
242
+ AbstractDiviner.privateConstructorKey
243
+ ```
244
+
245
+ ***
246
+
247
+ ### \_account
248
+
249
+ ```ts
250
+ protected _account: AccountInstance | undefined;
251
+ ```
252
+
253
+ ### Inherited from
254
+
255
+ [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner).[`_account`](MemoryBoundWitnessStatsDiviner.md#_account)
256
+
257
+ ***
258
+
259
+ ### \_cachedManifests
260
+
261
+ ```ts
262
+ protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
263
+ ```
264
+
265
+ ### Inherited from
266
+
267
+ [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner).[`_cachedManifests`](MemoryBoundWitnessStatsDiviner.md#_cachedmanifests)
268
+
269
+ ***
270
+
271
+ ### \_globalReentrancyMutex
272
+
273
+ ```ts
274
+ protected _globalReentrancyMutex: Mutex | undefined;
275
+ ```
276
+
277
+ ### Inherited from
278
+
279
+ [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner).[`_globalReentrancyMutex`](MemoryBoundWitnessStatsDiviner.md#_globalreentrancymutex)
280
+
281
+ ***
282
+
283
+ ### \_lastError?
284
+
285
+ ```ts
286
+ protected optional _lastError?: ModuleDetailsError;
287
+ ```
288
+
289
+ ### Inherited from
290
+
291
+ [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner).[`_lastError`](MemoryBoundWitnessStatsDiviner.md#_lasterror)
292
+
293
+ ***
294
+
295
+ ### \_moduleConfigQueryValidator
296
+
297
+ ```ts
298
+ protected _moduleConfigQueryValidator: Queryable | undefined;
299
+ ```
300
+
301
+ ### Inherited from
302
+
303
+ [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner).[`_moduleConfigQueryValidator`](MemoryBoundWitnessStatsDiviner.md#_moduleconfigqueryvalidator)
304
+
305
+ ***
306
+
307
+ ### \_supportedQueryValidator
308
+
309
+ ```ts
310
+ protected _supportedQueryValidator: Queryable | undefined;
311
+ ```
312
+
313
+ ### Inherited from
314
+
315
+ [`MemoryBoundWitnessStatsDiviner`](#MemoryBoundWitnessStatsDiviner).[`_supportedQueryValidator`](MemoryBoundWitnessStatsDiviner.md#_supportedqueryvalidator)
316
+
317
+ ***
318
+
319
+ ### useNewResolver
320
+
321
+ ```ts
322
+ readonly static useNewResolver: false = false;
323
+ ```
324
+
325
+ ### Inherited from
326
+
327
+ ```ts
328
+ AbstractDiviner.useNewResolver
329
+ ```
330
+
331
+ ## Accessors
332
+
333
+ ### queries
334
+
335
+ ### Get Signature
336
+
337
+ ```ts
338
+ get queries(): Schema[];
339
+ ```
340
+
341
+ #### Returns
342
+
343
+ `Schema`[]
344
+
345
+ ### Inherited from
346
+
347
+ ```ts
348
+ AbstractDiviner.queries
349
+ ```
350
+
351
+ ***
352
+
353
+ ### account
354
+
355
+ ### Get Signature
356
+
357
+ ```ts
358
+ get account(): AccountInstance;
359
+ ```
360
+
361
+ #### Returns
362
+
363
+ `AccountInstance`
364
+
365
+ ### Inherited from
366
+
367
+ ```ts
368
+ AbstractDiviner.account
369
+ ```
370
+
371
+ ***
372
+
373
+ ### additionalSigners
374
+
375
+ ### Get Signature
376
+
377
+ ```ts
378
+ get additionalSigners(): AccountInstance[];
379
+ ```
380
+
381
+ #### Returns
382
+
383
+ `AccountInstance`[]
384
+
385
+ ### Inherited from
386
+
387
+ ```ts
388
+ AbstractDiviner.additionalSigners
389
+ ```
390
+
391
+ ***
392
+
393
+ ### address
394
+
395
+ ### Get Signature
396
+
397
+ ```ts
398
+ get address(): Lowercase<string> & object & object;
399
+ ```
400
+
401
+ #### Returns
402
+
403
+ `Lowercase`\<`string`\> & `object` & `object`
404
+
405
+ ### Inherited from
406
+
407
+ ```ts
408
+ AbstractDiviner.address
409
+ ```
410
+
411
+ ***
412
+
413
+ ### allowAnonymous
414
+
415
+ ### Get Signature
416
+
417
+ ```ts
418
+ get allowAnonymous(): boolean;
419
+ ```
420
+
421
+ #### Returns
422
+
423
+ `boolean`
424
+
425
+ ### Inherited from
426
+
427
+ ```ts
428
+ AbstractDiviner.allowAnonymous
429
+ ```
430
+
431
+ ***
432
+
433
+ ### allowNameResolution
434
+
435
+ ### Get Signature
436
+
437
+ ```ts
438
+ get allowNameResolution(): boolean;
439
+ ```
440
+
441
+ #### Returns
442
+
443
+ `boolean`
444
+
445
+ ### Inherited from
446
+
447
+ ```ts
448
+ AbstractDiviner.allowNameResolution
449
+ ```
450
+
451
+ ***
452
+
453
+ ### archiving
454
+
455
+ ### Get Signature
456
+
457
+ ```ts
458
+ get archiving():
459
+ | {
460
+ archivists?: ModuleIdentifier[];
461
+ queries?: Schema[];
462
+ }
463
+ | undefined;
464
+ ```
465
+
466
+ #### Returns
467
+
468
+ \| \{
469
+ `archivists?`: `ModuleIdentifier`[];
470
+ `queries?`: `Schema`[];
471
+ \}
472
+ \| `undefined`
473
+
474
+ ### Inherited from
475
+
476
+ ```ts
477
+ AbstractDiviner.archiving
478
+ ```
479
+
480
+ ***
481
+
482
+ ### archivist
483
+
484
+ ### Get Signature
485
+
486
+ ```ts
487
+ get archivist(): ModuleIdentifier | undefined;
488
+ ```
489
+
490
+ #### Returns
491
+
492
+ `ModuleIdentifier` \| `undefined`
493
+
494
+ ### Inherited from
495
+
496
+ ```ts
497
+ AbstractDiviner.archivist
498
+ ```
499
+
500
+ ***
501
+
502
+ ### config
503
+
504
+ ### Get Signature
505
+
506
+ ```ts
507
+ get config(): TParams["config"] & object;
508
+ ```
509
+
510
+ #### Returns
511
+
512
+ `TParams`\[`"config"`\] & `object`
513
+
514
+ ### Inherited from
515
+
516
+ ```ts
517
+ AbstractDiviner.config
518
+ ```
519
+
520
+ ***
521
+
522
+ ### dead
523
+
524
+ ### Get Signature
525
+
526
+ ```ts
527
+ get dead(): boolean;
528
+ ```
529
+
530
+ #### Returns
531
+
532
+ `boolean`
533
+
534
+ ### Inherited from
535
+
536
+ ```ts
537
+ AbstractDiviner.dead
538
+ ```
539
+
540
+ ***
541
+
542
+ ### ephemeralQueryAccountEnabled
543
+
544
+ ### Get Signature
545
+
546
+ ```ts
547
+ get ephemeralQueryAccountEnabled(): boolean;
548
+ ```
549
+
550
+ #### Returns
551
+
552
+ `boolean`
553
+
554
+ ### Inherited from
555
+
556
+ ```ts
557
+ AbstractDiviner.ephemeralQueryAccountEnabled
558
+ ```
559
+
560
+ ***
561
+
562
+ ### globalReentrancyMutex
563
+
564
+ ### Get Signature
565
+
566
+ ```ts
567
+ get globalReentrancyMutex(): Mutex | undefined;
568
+ ```
569
+
570
+ #### Returns
571
+
572
+ `Mutex` \| `undefined`
573
+
574
+ ### Inherited from
575
+
576
+ ```ts
577
+ AbstractDiviner.globalReentrancyMutex
578
+ ```
579
+
580
+ ***
581
+
582
+ ### id
583
+
584
+ ### Get Signature
585
+
586
+ ```ts
587
+ get id(): string;
588
+ ```
589
+
590
+ The name (if specified) or address of the module
591
+
592
+ #### Returns
593
+
594
+ `string`
595
+
596
+ ### Inherited from
597
+
598
+ ```ts
599
+ AbstractDiviner.id
600
+ ```
601
+
602
+ ***
603
+
604
+ ### logger
605
+
606
+ ### Get Signature
607
+
608
+ ```ts
609
+ get logger(): Logger | undefined;
610
+ ```
611
+
612
+ #### Returns
613
+
614
+ `Logger` \| `undefined`
615
+
616
+ ### Inherited from
617
+
618
+ ```ts
619
+ AbstractDiviner.logger
620
+ ```
621
+
622
+ ***
623
+
624
+ ### priority
625
+
626
+ ### Get Signature
627
+
628
+ ```ts
629
+ get priority(): 2;
630
+ ```
631
+
632
+ #### Returns
633
+
634
+ `2`
635
+
636
+ ### Inherited from
637
+
638
+ ```ts
639
+ AbstractDiviner.priority
640
+ ```
641
+
642
+ ***
643
+
644
+ ### reentrancy
645
+
646
+ ### Get Signature
647
+
648
+ ```ts
649
+ get reentrancy():
650
+ | {
651
+ action: "skip" | "wait";
652
+ scope: "global";
653
+ }
654
+ | undefined;
655
+ ```
656
+
657
+ #### Returns
658
+
659
+ \| \{
660
+ `action`: `"skip"` \| `"wait"`;
661
+ `scope`: `"global"`;
662
+ \}
663
+ \| `undefined`
664
+
665
+ ### Inherited from
666
+
667
+ ```ts
668
+ AbstractDiviner.reentrancy
669
+ ```
670
+
671
+ ***
672
+
673
+ ### statusReporter
674
+
675
+ ### Get Signature
676
+
677
+ ```ts
678
+ get statusReporter():
679
+ | ModuleStatusReporter & CreatableStatusReporter<void>
680
+ | undefined;
681
+ ```
682
+
683
+ The status reporter used to broadcast lifecycle changes.
684
+
685
+ #### Returns
686
+
687
+ \| `ModuleStatusReporter` & `CreatableStatusReporter`\<`void`\>
688
+ \| `undefined`
689
+
690
+ ### Inherited from
691
+
692
+ ```ts
693
+ AbstractDiviner.statusReporter
694
+ ```
695
+
696
+ ***
697
+
698
+ ### timestamp
699
+
700
+ ### Get Signature
701
+
702
+ ```ts
703
+ get timestamp(): boolean;
704
+ ```
705
+
706
+ #### Returns
707
+
708
+ `boolean`
709
+
710
+ ### Inherited from
711
+
712
+ ```ts
713
+ AbstractDiviner.timestamp
714
+ ```
715
+
716
+ ***
717
+
718
+ ### moduleConfigQueryValidator
719
+
720
+ ### Get Signature
721
+
722
+ ```ts
723
+ get protected moduleConfigQueryValidator(): Queryable;
724
+ ```
725
+
726
+ #### Returns
727
+
728
+ `Queryable`
729
+
730
+ ### Inherited from
731
+
732
+ ```ts
733
+ AbstractDiviner.moduleConfigQueryValidator
734
+ ```
735
+
736
+ ***
737
+
738
+ ### supportedQueryValidator
739
+
740
+ ### Get Signature
741
+
742
+ ```ts
743
+ get protected supportedQueryValidator(): Queryable;
744
+ ```
745
+
746
+ #### Returns
747
+
748
+ `Queryable`
749
+
750
+ ### Inherited from
751
+
752
+ ```ts
753
+ AbstractDiviner.supportedQueryValidator
754
+ ```
755
+
756
+ ***
757
+
758
+ ### downResolver
759
+
760
+ ### Get Signature
761
+
762
+ ```ts
763
+ get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
764
+ ```
765
+
766
+ #### Returns
767
+
768
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
769
+
770
+ ### Inherited from
771
+
772
+ ```ts
773
+ AbstractDiviner.downResolver
774
+ ```
775
+
776
+ ***
777
+
778
+ ### modName
779
+
780
+ ### Get Signature
781
+
782
+ ```ts
783
+ get modName(): string | undefined;
784
+ ```
785
+
786
+ #### Returns
787
+
788
+ `string` \| `undefined`
789
+
790
+ ### Inherited from
791
+
792
+ ```ts
793
+ AbstractDiviner.modName
794
+ ```
795
+
796
+ ***
797
+
798
+ ### moduleIdentifierTransformers
799
+
800
+ ### Get Signature
801
+
802
+ ```ts
803
+ get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
804
+ ```
805
+
806
+ #### Returns
807
+
808
+ `ModuleIdentifierTransformer`[]
809
+
810
+ ### Inherited from
811
+
812
+ ```ts
813
+ AbstractDiviner.moduleIdentifierTransformers
814
+ ```
815
+
816
+ ***
817
+
818
+ ### privateResolver
819
+
820
+ ### Get Signature
821
+
822
+ ```ts
823
+ get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
824
+ ```
825
+
826
+ #### Returns
827
+
828
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
829
+
830
+ ### Inherited from
831
+
832
+ ```ts
833
+ AbstractDiviner.privateResolver
834
+ ```
835
+
836
+ ***
837
+
838
+ ### root
839
+
840
+ ### Get Signature
841
+
842
+ ```ts
843
+ get root(): this;
844
+ ```
845
+
846
+ #### Returns
847
+
848
+ `this`
849
+
850
+ ### Inherited from
851
+
852
+ ```ts
853
+ AbstractDiviner.root
854
+ ```
855
+
856
+ ***
857
+
858
+ ### timeBudget
859
+
860
+ ### Get Signature
861
+
862
+ ```ts
863
+ get timeBudget(): number | undefined;
864
+ ```
865
+
866
+ #### Returns
867
+
868
+ `number` \| `undefined`
869
+
870
+ ### Inherited from
871
+
872
+ ```ts
873
+ AbstractDiviner.timeBudget
874
+ ```
875
+
876
+ ***
877
+
878
+ ### upResolver
879
+
880
+ ### Get Signature
881
+
882
+ ```ts
883
+ get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
884
+ ```
885
+
886
+ #### Returns
887
+
888
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
889
+
890
+ ### Inherited from
891
+
892
+ ```ts
893
+ AbstractDiviner.upResolver
894
+ ```
895
+
896
+ ## Methods
897
+
898
+ ### divine()
899
+
900
+ ```ts
901
+ divine(payloads?, retryConfigIn?): Promise<DivinerDivineResult<TOut>[]>;
902
+ ```
903
+
904
+ **`Function`**
905
+
906
+ divine The main entry point for a diviner. Do not override this function. Implement/override divineHandler for custom functionality
907
+
908
+ ### Parameters
909
+
910
+ #### payloads?
911
+
912
+ `TIn`[]
913
+
914
+ #### retryConfigIn?
915
+
916
+ `RetryConfigWithComplete`\<`unknown`\>
917
+
918
+ ### Returns
919
+
920
+ `Promise`\<`DivinerDivineResult`\<`TOut`\>[]\>
921
+
922
+ ### Inherited from
923
+
924
+ ```ts
925
+ AbstractDiviner.divine
926
+ ```
927
+
928
+ ***
929
+
930
+ ### divineQuery()
931
+
932
+ ```ts
933
+ divineQuery(
934
+ payloads?,
935
+ account?,
936
+ _retry?): Promise<ModuleQueryResult<TOut>>;
937
+ ```
938
+
939
+ ### Parameters
940
+
941
+ #### payloads?
942
+
943
+ `TIn`[]
944
+
945
+ #### account?
946
+
947
+ `AccountInstance`
948
+
949
+ #### \_retry?
950
+
951
+ `RetryConfig`
952
+
953
+ ### Returns
954
+
955
+ `Promise`\<`ModuleQueryResult`\<`TOut`\>\>
956
+
957
+ ### Inherited from
958
+
959
+ ```ts
960
+ AbstractDiviner.divineQuery
961
+ ```
962
+
963
+ ***
964
+
965
+ ### queryHandler()
966
+
967
+ ```ts
968
+ protected queryHandler<T, TConfig>(
969
+ query,
970
+ payloads?,
971
+ queryConfig?): Promise<ModuleQueryHandlerResult>;
972
+ ```
973
+
974
+ **`Function`**
975
+
976
+ queryHandler Calls divine for a divine query. Override to support additional queries.
977
+
978
+ ### Type Parameters
979
+
980
+ #### T
981
+
982
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
983
+
984
+ #### TConfig
985
+
986
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
987
+
988
+ ### Parameters
989
+
990
+ #### query
991
+
992
+ `T`
993
+
994
+ #### payloads?
995
+
996
+ `Payload`[]
997
+
998
+ #### queryConfig?
999
+
1000
+ `TConfig`
1001
+
1002
+ ### Returns
1003
+
1004
+ `Promise`\<`ModuleQueryHandlerResult`\>
1005
+
1006
+ ### Inherited from
1007
+
1008
+ ```ts
1009
+ AbstractDiviner.queryHandler
1010
+ ```
1011
+
1012
+ ***
1013
+
1014
+ ### startHandler()
1015
+
1016
+ ```ts
1017
+ protected startHandler(): Promise<void>;
1018
+ ```
1019
+
1020
+ ### Returns
1021
+
1022
+ `Promise`\<`void`\>
1023
+
1024
+ ### Inherited from
1025
+
1026
+ ```ts
1027
+ AbstractDiviner.startHandler
1028
+ ```
1029
+
1030
+ ***
1031
+
1032
+ ### stopHandler()
1033
+
1034
+ ```ts
1035
+ protected stopHandler(): Promise<void>;
1036
+ ```
1037
+
1038
+ ### Returns
1039
+
1040
+ `Promise`\<`void`\>
1041
+
1042
+ ### Inherited from
1043
+
1044
+ ```ts
1045
+ AbstractDiviner.stopHandler
1046
+ ```
1047
+
1048
+ ***
1049
+
1050
+ ### divineHandler()
1051
+
1052
+ ```ts
1053
+ abstract protected divineHandler(payloads?): Promisable<TOut[]>;
1054
+ ```
1055
+
1056
+ **`Function`**
1057
+
1058
+ divineHandler Implement or override to add custom functionality to a diviner
1059
+
1060
+ ### Parameters
1061
+
1062
+ #### payloads?
1063
+
1064
+ `TIn`[]
1065
+
1066
+ ### Returns
1067
+
1068
+ `Promisable`\<`TOut`[]\>
1069
+
1070
+ ### Inherited from
1071
+
1072
+ ```ts
1073
+ AbstractDiviner.divineHandler
1074
+ ```
1075
+
1076
+ ***
1077
+
1078
+ ### \_getRootFunction()
1079
+
1080
+ ```ts
1081
+ static _getRootFunction(funcName): any;
1082
+ ```
1083
+
1084
+ ### Parameters
1085
+
1086
+ #### funcName
1087
+
1088
+ `string`
1089
+
1090
+ ### Returns
1091
+
1092
+ `any`
1093
+
1094
+ ### Inherited from
1095
+
1096
+ ```ts
1097
+ AbstractDiviner._getRootFunction
1098
+ ```
1099
+
1100
+ ***
1101
+
1102
+ ### \_noOverride()
1103
+
1104
+ ```ts
1105
+ static _noOverride(functionName): void;
1106
+ ```
1107
+
1108
+ ### Parameters
1109
+
1110
+ #### functionName
1111
+
1112
+ `string`
1113
+
1114
+ ### Returns
1115
+
1116
+ `void`
1117
+
1118
+ ### Inherited from
1119
+
1120
+ ```ts
1121
+ AbstractDiviner._noOverride
1122
+ ```
1123
+
1124
+ ***
1125
+
1126
+ ### createHandler()
1127
+
1128
+ ```ts
1129
+ static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;
1130
+ ```
1131
+
1132
+ Static hook called during creation to perform additional initialization.
1133
+ Override in subclasses to customize post-construction setup.
1134
+
1135
+ ### Type Parameters
1136
+
1137
+ #### T
1138
+
1139
+ `T` *extends* `CreatableInstance`\<`CreatableParams`, `EventData`\>
1140
+
1141
+ ### Parameters
1142
+
1143
+ #### inInstance
1144
+
1145
+ `T`
1146
+
1147
+ ### Returns
1148
+
1149
+ `Promise`\<`T` & `AbstractModule`\<`any`, `any`\>\>
1150
+
1151
+ The instance, potentially modified
1152
+
1153
+ ### Inherited from
1154
+
1155
+ ```ts
1156
+ AbstractDiviner.createHandler
1157
+ ```
1158
+
1159
+ ***
1160
+
1161
+ ### determineAccount()
1162
+
1163
+ ```ts
1164
+ static determineAccount(params): Promise<AccountInstance>;
1165
+ ```
1166
+
1167
+ ### Parameters
1168
+
1169
+ #### params
1170
+
1171
+ ##### account?
1172
+
1173
+ `AccountInstance` \| `"random"`
1174
+
1175
+ ##### accountPath?
1176
+
1177
+ `string`
1178
+
1179
+ ##### wallet?
1180
+
1181
+ `WalletInstance`
1182
+
1183
+ ### Returns
1184
+
1185
+ `Promise`\<`AccountInstance`\>
1186
+
1187
+ ### Inherited from
1188
+
1189
+ ```ts
1190
+ AbstractDiviner.determineAccount
1191
+ ```
1192
+
1193
+ ***
1194
+
1195
+ ### factory()
1196
+
1197
+ ```ts
1198
+ static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;
1199
+ ```
1200
+
1201
+ ### Type Parameters
1202
+
1203
+ #### TModule
1204
+
1205
+ `TModule` *extends* `CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1206
+
1207
+ ### Parameters
1208
+
1209
+ #### this
1210
+
1211
+ `CreatableModule`\<`TModule`\>
1212
+
1213
+ #### params?
1214
+
1215
+ `Partial`\<`TModule`\[`"params"`\]\>
1216
+
1217
+ ### Returns
1218
+
1219
+ `CreatableModuleFactory`\<`TModule`\>
1220
+
1221
+ ### Inherited from
1222
+
1223
+ ```ts
1224
+ AbstractDiviner.factory
1225
+ ```
1226
+
1227
+ ***
1228
+
1229
+ ### isAllowedSchema()
1230
+
1231
+ ```ts
1232
+ static isAllowedSchema(schema): boolean;
1233
+ ```
1234
+
1235
+ ### Parameters
1236
+
1237
+ #### schema
1238
+
1239
+ `Schema`
1240
+
1241
+ ### Returns
1242
+
1243
+ `boolean`
1244
+
1245
+ ### Inherited from
1246
+
1247
+ ```ts
1248
+ AbstractDiviner.isAllowedSchema
1249
+ ```
1250
+
1251
+ ***
1252
+
1253
+ ### paramsHandler()
1254
+
1255
+ ```ts
1256
+ static paramsHandler<T>(inParams?): Promise<T["params"]>;
1257
+ ```
1258
+
1259
+ Static hook called during creation to validate and transform params.
1260
+ Override in subclasses to add default values or validation.
1261
+
1262
+ ### Type Parameters
1263
+
1264
+ #### T
1265
+
1266
+ `T` *extends* `AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1267
+
1268
+ ### Parameters
1269
+
1270
+ #### inParams?
1271
+
1272
+ `Partial`\<`T`\[`"params"`\]\>
1273
+
1274
+ ### Returns
1275
+
1276
+ `Promise`\<`T`\[`"params"`\]\>
1277
+
1278
+ The processed params ready for construction
1279
+
1280
+ ### Inherited from
1281
+
1282
+ ```ts
1283
+ AbstractDiviner.paramsHandler
1284
+ ```
1285
+
1286
+ ***
1287
+
1288
+ ### \_getRootFunction()
1289
+
1290
+ ```ts
1291
+ _getRootFunction(funcName): any;
1292
+ ```
1293
+
1294
+ ### Parameters
1295
+
1296
+ #### funcName
1297
+
1298
+ `string`
1299
+
1300
+ ### Returns
1301
+
1302
+ `any`
1303
+
1304
+ ### Inherited from
1305
+
1306
+ ```ts
1307
+ AbstractDiviner._getRootFunction
1308
+ ```
1309
+
1310
+ ***
1311
+
1312
+ ### busy()
1313
+
1314
+ ```ts
1315
+ busy<R>(closure): Promise<R>;
1316
+ ```
1317
+
1318
+ ### Type Parameters
1319
+
1320
+ #### R
1321
+
1322
+ `R`
1323
+
1324
+ ### Parameters
1325
+
1326
+ #### closure
1327
+
1328
+ () => `Promise`\<`R`\>
1329
+
1330
+ ### Returns
1331
+
1332
+ `Promise`\<`R`\>
1333
+
1334
+ ### Inherited from
1335
+
1336
+ ```ts
1337
+ AbstractDiviner.busy
1338
+ ```
1339
+
1340
+ ***
1341
+
1342
+ ### emit()
1343
+
1344
+ ```ts
1345
+ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
1346
+ ```
1347
+
1348
+ Emits an event, invoking all registered listeners concurrently.
1349
+
1350
+ ### Type Parameters
1351
+
1352
+ #### TEventName
1353
+
1354
+ `TEventName` *extends* `string` \| `number` \| `symbol` = keyof `TEventData`
1355
+
1356
+ #### TEventArgs
1357
+
1358
+ `TEventArgs` *extends* `EventArgs` = `TEventData`\[`TEventName`\]
1359
+
1360
+ ### Parameters
1361
+
1362
+ #### eventName
1363
+
1364
+ `TEventName`
1365
+
1366
+ The event to emit.
1367
+
1368
+ #### eventArgs
1369
+
1370
+ `TEventArgs`
1371
+
1372
+ The data to pass to listeners.
1373
+
1374
+ ### Returns
1375
+
1376
+ `Promise`\<`void`\>
1377
+
1378
+ ### Inherited from
1379
+
1380
+ ```ts
1381
+ AbstractDiviner.emit
1382
+ ```
1383
+
1384
+ ***
1385
+
1386
+ ### isSupportedQuery()
1387
+
1388
+ ```ts
1389
+ isSupportedQuery(query, assert?): boolean;
1390
+ ```
1391
+
1392
+ ### Parameters
1393
+
1394
+ #### query
1395
+
1396
+ `Schema`
1397
+
1398
+ #### assert?
1399
+
1400
+ `string` \| `boolean`
1401
+
1402
+ ### Returns
1403
+
1404
+ `boolean`
1405
+
1406
+ ### Inherited from
1407
+
1408
+ ```ts
1409
+ AbstractDiviner.isSupportedQuery
1410
+ ```
1411
+
1412
+ ***
1413
+
1414
+ ### previousHash()
1415
+
1416
+ ```ts
1417
+ previousHash(): Promisable<string | undefined>;
1418
+ ```
1419
+
1420
+ ### Returns
1421
+
1422
+ `Promisable`\<`string` \| `undefined`\>
1423
+
1424
+ ### Inherited from
1425
+
1426
+ ```ts
1427
+ AbstractDiviner.previousHash
1428
+ ```
1429
+
1430
+ ***
1431
+
1432
+ ### query()
1433
+
1434
+ ```ts
1435
+ query<T, TConfig>(
1436
+ query,
1437
+ payloads?,
1438
+ queryConfig?): Promise<ModuleQueryResult>;
1439
+ ```
1440
+
1441
+ ### Type Parameters
1442
+
1443
+ #### T
1444
+
1445
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
1446
+
1447
+ #### TConfig
1448
+
1449
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
1450
+
1451
+ ### Parameters
1452
+
1453
+ #### query
1454
+
1455
+ `T`
1456
+
1457
+ #### payloads?
1458
+
1459
+ `Payload`[]
1460
+
1461
+ #### queryConfig?
1462
+
1463
+ `TConfig`
1464
+
1465
+ ### Returns
1466
+
1467
+ `Promise`\<`ModuleQueryResult`\>
1468
+
1469
+ ### Inherited from
1470
+
1471
+ ```ts
1472
+ AbstractDiviner.query
1473
+ ```
1474
+
1475
+ ***
1476
+
1477
+ ### queryable()
1478
+
1479
+ ```ts
1480
+ queryable<T, TConfig>(
1481
+ query,
1482
+ payloads?,
1483
+ queryConfig?): Promise<boolean>;
1484
+ ```
1485
+
1486
+ ### Type Parameters
1487
+
1488
+ #### T
1489
+
1490
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
1491
+
1492
+ #### TConfig
1493
+
1494
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
1495
+
1496
+ ### Parameters
1497
+
1498
+ #### query
1499
+
1500
+ `T`
1501
+
1502
+ #### payloads?
1503
+
1504
+ `Payload`[]
1505
+
1506
+ #### queryConfig?
1507
+
1508
+ `TConfig`
1509
+
1510
+ ### Returns
1511
+
1512
+ `Promise`\<`boolean`\>
1513
+
1514
+ ### Inherited from
1515
+
1516
+ ```ts
1517
+ AbstractDiviner.queryable
1518
+ ```
1519
+
1520
+ ***
1521
+
1522
+ ### \_checkDead()
1523
+
1524
+ ```ts
1525
+ protected _checkDead(): void;
1526
+ ```
1527
+
1528
+ ### Returns
1529
+
1530
+ `void`
1531
+
1532
+ ### Inherited from
1533
+
1534
+ ```ts
1535
+ AbstractDiviner._checkDead
1536
+ ```
1537
+
1538
+ ***
1539
+
1540
+ ### archivistInstance()
1541
+
1542
+ ### Call Signature
1543
+
1544
+ ```ts
1545
+ protected archivistInstance(): Promise<
1546
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
1547
+ | undefined>;
1548
+ ```
1549
+
1550
+ #### Returns
1551
+
1552
+ `Promise`\<
1553
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
1554
+ \| `undefined`\>
1555
+
1556
+ #### Inherited from
1557
+
1558
+ ```ts
1559
+ AbstractDiviner.archivistInstance
1560
+ ```
1561
+
1562
+ ### Call Signature
1563
+
1564
+ ```ts
1565
+ protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
1566
+ ```
1567
+
1568
+ #### Parameters
1569
+
1570
+ ##### required
1571
+
1572
+ `true`
1573
+
1574
+ #### Returns
1575
+
1576
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
1577
+
1578
+ #### Inherited from
1579
+
1580
+ ```ts
1581
+ AbstractDiviner.archivistInstance
1582
+ ```
1583
+
1584
+ ***
1585
+
1586
+ ### bindHashes()
1587
+
1588
+ ```ts
1589
+ protected bindHashes(
1590
+ hashes,
1591
+ schema,
1592
+ account?): PromiseEx<unknown, AccountInstance>;
1593
+ ```
1594
+
1595
+ ### Parameters
1596
+
1597
+ #### hashes
1598
+
1599
+ `BrandedHash`[]
1600
+
1601
+ #### schema
1602
+
1603
+ `Schema`[]
1604
+
1605
+ #### account?
1606
+
1607
+ `AccountInstance`
1608
+
1609
+ ### Returns
1610
+
1611
+ `PromiseEx`\<`unknown`, `AccountInstance`\>
1612
+
1613
+ ### Inherited from
1614
+
1615
+ ```ts
1616
+ AbstractDiviner.bindHashes
1617
+ ```
1618
+
1619
+ ***
1620
+
1621
+ ### bindHashesInternal()
1622
+
1623
+ ```ts
1624
+ protected bindHashesInternal(
1625
+ hashes,
1626
+ schema,
1627
+ account?): Promise<{
1628
+ schema: "network.xyo.boundwitness" & object;
1629
+ addresses: Lowercase<string> & object & object[];
1630
+ payload_hashes: BrandedHash[];
1631
+ payload_schemas: BrandedSchema<string>[];
1632
+ previous_hashes: (BrandedHash | null)[];
1633
+ $destination?: Lowercase<string> & object & object;
1634
+ $sourceQuery?: BrandedHash;
1635
+ $signatures: (BrandedHex | null)[];
1636
+ }>;
1637
+ ```
1638
+
1639
+ ### Parameters
1640
+
1641
+ #### hashes
1642
+
1643
+ `BrandedHash`[]
1644
+
1645
+ #### schema
1646
+
1647
+ `Schema`[]
1648
+
1649
+ #### account?
1650
+
1651
+ `AccountInstance`
1652
+
1653
+ ### Returns
1654
+
1655
+ `Promise`\<\{
1656
+ `schema`: `"network.xyo.boundwitness"` & `object`;
1657
+ `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
1658
+ `payload_hashes`: `BrandedHash`[];
1659
+ `payload_schemas`: `BrandedSchema`\<`string`\>[];
1660
+ `previous_hashes`: (`BrandedHash` \| `null`)[];
1661
+ `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
1662
+ `$sourceQuery?`: `BrandedHash`;
1663
+ `$signatures`: (`BrandedHex` \| `null`)[];
1664
+ \}\>
1665
+
1666
+ ### Inherited from
1667
+
1668
+ ```ts
1669
+ AbstractDiviner.bindHashesInternal
1670
+ ```
1671
+
1672
+ ***
1673
+
1674
+ ### bindQuery()
1675
+
1676
+ ```ts
1677
+ protected bindQuery<T>(
1678
+ query,
1679
+ payloads?,
1680
+ account?,
1681
+ additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;
1682
+ ```
1683
+
1684
+ ### Type Parameters
1685
+
1686
+ #### T
1687
+
1688
+ `T` *extends* `Query`
1689
+
1690
+ ### Parameters
1691
+
1692
+ #### query
1693
+
1694
+ `T`
1695
+
1696
+ #### payloads?
1697
+
1698
+ `Payload`[]
1699
+
1700
+ #### account?
1701
+
1702
+ `AccountInstance`
1703
+
1704
+ #### additionalSigners?
1705
+
1706
+ `AccountInstance`[]
1707
+
1708
+ ### Returns
1709
+
1710
+ `PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\], `AccountInstance`\>
1711
+
1712
+ ### Inherited from
1713
+
1714
+ ```ts
1715
+ AbstractDiviner.bindQuery
1716
+ ```
1717
+
1718
+ ***
1719
+
1720
+ ### bindQueryInternal()
1721
+
1722
+ ```ts
1723
+ protected bindQueryInternal<T>(
1724
+ query,
1725
+ payloads?,
1726
+ account?,
1727
+ additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;
1728
+ ```
1729
+
1730
+ ### Type Parameters
1731
+
1732
+ #### T
1733
+
1734
+ `T` *extends* `Query`
1735
+
1736
+ ### Parameters
1737
+
1738
+ #### query
1739
+
1740
+ `T`
1741
+
1742
+ #### payloads?
1743
+
1744
+ `Payload`[]
1745
+
1746
+ #### account?
1747
+
1748
+ `AccountInstance`
1749
+
1750
+ #### additionalSigners?
1751
+
1752
+ `AccountInstance`[]
1753
+
1754
+ ### Returns
1755
+
1756
+ `Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\]\>
1757
+
1758
+ ### Inherited from
1759
+
1760
+ ```ts
1761
+ AbstractDiviner.bindQueryInternal
1762
+ ```
1763
+
1764
+ ***
1765
+
1766
+ ### bindQueryResult()
1767
+
1768
+ ```ts
1769
+ protected bindQueryResult<T>(
1770
+ query,
1771
+ payloads,
1772
+ additionalWitnesses?,
1773
+ errors?): Promise<ModuleQueryResult>;
1774
+ ```
1775
+
1776
+ ### Type Parameters
1777
+
1778
+ #### T
1779
+
1780
+ `T` *extends* `Query`
1781
+
1782
+ ### Parameters
1783
+
1784
+ #### query
1785
+
1786
+ `T`
1787
+
1788
+ #### payloads
1789
+
1790
+ `Payload`[]
1791
+
1792
+ #### additionalWitnesses?
1793
+
1794
+ `AccountInstance`[]
1795
+
1796
+ #### errors?
1797
+
1798
+ `ModuleError`[]
1799
+
1800
+ ### Returns
1801
+
1802
+ `Promise`\<`ModuleQueryResult`\>
1803
+
1804
+ ### Inherited from
1805
+
1806
+ ```ts
1807
+ AbstractDiviner.bindQueryResult
1808
+ ```
1809
+
1810
+ ***
1811
+
1812
+ ### generateConfigAndAddress()
1813
+
1814
+ ```ts
1815
+ protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
1816
+ ```
1817
+
1818
+ ### Parameters
1819
+
1820
+ #### \_maxDepth?
1821
+
1822
+ `number`
1823
+
1824
+ ### Returns
1825
+
1826
+ `Promisable`\<`Payload`[]\>
1827
+
1828
+ ### Inherited from
1829
+
1830
+ ```ts
1831
+ AbstractDiviner.generateConfigAndAddress
1832
+ ```
1833
+
1834
+ ***
1835
+
1836
+ ### generateDescribe()
1837
+
1838
+ ```ts
1839
+ protected generateDescribe(): Promise<ModuleDescriptionPayload>;
1840
+ ```
1841
+
1842
+ ### Returns
1843
+
1844
+ `Promise`\<`ModuleDescriptionPayload`\>
1845
+
1846
+ ### Inherited from
1847
+
1848
+ ```ts
1849
+ AbstractDiviner.generateDescribe
1850
+ ```
1851
+
1852
+ ***
1853
+
1854
+ ### ~~getArchivist()~~
1855
+
1856
+ ```ts
1857
+ protected getArchivist(): Promise<
1858
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
1859
+ | undefined>;
1860
+ ```
1861
+
1862
+ ### Returns
1863
+
1864
+ `Promise`\<
1865
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
1866
+ \| `undefined`\>
1867
+
1868
+ ### Deprecated
1869
+
1870
+ use archivistInstance() instead
1871
+
1872
+ ### Inherited from
1873
+
1874
+ ```ts
1875
+ AbstractDiviner.getArchivist
1876
+ ```
1877
+
1878
+ ***
1879
+
1880
+ ### isAllowedArchivingQuery()
1881
+
1882
+ ```ts
1883
+ protected isAllowedArchivingQuery(schema): boolean;
1884
+ ```
1885
+
1886
+ ### Parameters
1887
+
1888
+ #### schema
1889
+
1890
+ `Schema`
1891
+
1892
+ ### Returns
1893
+
1894
+ `boolean`
1895
+
1896
+ ### Inherited from
1897
+
1898
+ ```ts
1899
+ AbstractDiviner.isAllowedArchivingQuery
1900
+ ```
1901
+
1902
+ ***
1903
+
1904
+ ### moduleAddressHandler()
1905
+
1906
+ ```ts
1907
+ protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
1908
+ ```
1909
+
1910
+ ### Returns
1911
+
1912
+ `Promisable`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
1913
+
1914
+ ### Inherited from
1915
+
1916
+ ```ts
1917
+ AbstractDiviner.moduleAddressHandler
1918
+ ```
1919
+
1920
+ ***
1921
+
1922
+ ### stateHandler()
1923
+
1924
+ ```ts
1925
+ protected stateHandler(): Promise<Payload[]>;
1926
+ ```
1927
+
1928
+ ### Returns
1929
+
1930
+ `Promise`\<`Payload`[]\>
1931
+
1932
+ ### Inherited from
1933
+
1934
+ ```ts
1935
+ AbstractDiviner.stateHandler
1936
+ ```
1937
+
1938
+ ***
1939
+
1940
+ ### subscribeHandler()
1941
+
1942
+ ```ts
1943
+ protected subscribeHandler(): void;
1944
+ ```
1945
+
1946
+ ### Returns
1947
+
1948
+ `void`
1949
+
1950
+ ### Inherited from
1951
+
1952
+ ```ts
1953
+ AbstractDiviner.subscribeHandler
1954
+ ```
1955
+
1956
+ ***
1957
+
1958
+ ### validateConfig()
1959
+
1960
+ ```ts
1961
+ protected validateConfig(config?, parents?): boolean;
1962
+ ```
1963
+
1964
+ ### Parameters
1965
+
1966
+ #### config?
1967
+
1968
+ `unknown`
1969
+
1970
+ #### parents?
1971
+
1972
+ `string`[]
1973
+
1974
+ ### Returns
1975
+
1976
+ `boolean`
1977
+
1978
+ ### Inherited from
1979
+
1980
+ ```ts
1981
+ AbstractDiviner.validateConfig
1982
+ ```
1983
+
1984
+ ***
1985
+
1986
+ ### addParent()
1987
+
1988
+ ```ts
1989
+ addParent(mod): void;
1990
+ ```
1991
+
1992
+ ### Parameters
1993
+
1994
+ #### mod
1995
+
1996
+ `ModuleInstance`
1997
+
1998
+ ### Returns
1999
+
2000
+ `void`
2001
+
2002
+ ### Inherited from
2003
+
2004
+ ```ts
2005
+ AbstractDiviner.addParent
2006
+ ```
2007
+
2008
+ ***
2009
+
2010
+ ### certifyParents()
2011
+
2012
+ ```ts
2013
+ certifyParents(): Promise<Payload[]>;
2014
+ ```
2015
+
2016
+ ### Returns
2017
+
2018
+ `Promise`\<`Payload`[]\>
2019
+
2020
+ ### Inherited from
2021
+
2022
+ ```ts
2023
+ AbstractDiviner.certifyParents
2024
+ ```
2025
+
2026
+ ***
2027
+
2028
+ ### createHandler()
2029
+
2030
+ ```ts
2031
+ createHandler(): Promise<void>;
2032
+ ```
2033
+
2034
+ ### Returns
2035
+
2036
+ `Promise`\<`void`\>
2037
+
2038
+ ### Inherited from
2039
+
2040
+ ```ts
2041
+ AbstractDiviner.createHandler
2042
+ ```
2043
+
2044
+ ***
2045
+
2046
+ ### manifest()
2047
+
2048
+ ```ts
2049
+ manifest(maxDepth?): Promise<ModuleManifestPayload>;
2050
+ ```
2051
+
2052
+ ### Parameters
2053
+
2054
+ #### maxDepth?
2055
+
2056
+ `number`
2057
+
2058
+ ### Returns
2059
+
2060
+ `Promise`\<`ModuleManifestPayload`\>
2061
+
2062
+ ### Inherited from
2063
+
2064
+ ```ts
2065
+ AbstractDiviner.manifest
2066
+ ```
2067
+
2068
+ ***
2069
+
2070
+ ### manifestQuery()
2071
+
2072
+ ```ts
2073
+ manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
2074
+ ```
2075
+
2076
+ ### Parameters
2077
+
2078
+ #### account
2079
+
2080
+ `AccountInstance`
2081
+
2082
+ #### maxDepth?
2083
+
2084
+ `number`
2085
+
2086
+ ### Returns
2087
+
2088
+ `Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
2089
+
2090
+ ### Inherited from
2091
+
2092
+ ```ts
2093
+ AbstractDiviner.manifestQuery
2094
+ ```
2095
+
2096
+ ***
2097
+
2098
+ ### moduleAddress()
2099
+
2100
+ ```ts
2101
+ moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
2102
+ ```
2103
+
2104
+ ### Returns
2105
+
2106
+ `Promise`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
2107
+
2108
+ ### Inherited from
2109
+
2110
+ ```ts
2111
+ AbstractDiviner.moduleAddress
2112
+ ```
2113
+
2114
+ ***
2115
+
2116
+ ### parents()
2117
+
2118
+ ```ts
2119
+ parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
2120
+ ```
2121
+
2122
+ ### Returns
2123
+
2124
+ `Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
2125
+
2126
+ ### Inherited from
2127
+
2128
+ ```ts
2129
+ AbstractDiviner.parents
2130
+ ```
2131
+
2132
+ ***
2133
+
2134
+ ### privateChildren()
2135
+
2136
+ ```ts
2137
+ privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2138
+ ```
2139
+
2140
+ ### Returns
2141
+
2142
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2143
+
2144
+ ### Inherited from
2145
+
2146
+ ```ts
2147
+ AbstractDiviner.privateChildren
2148
+ ```
2149
+
2150
+ ***
2151
+
2152
+ ### publicChildren()
2153
+
2154
+ ```ts
2155
+ publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2156
+ ```
2157
+
2158
+ ### Returns
2159
+
2160
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2161
+
2162
+ ### Inherited from
2163
+
2164
+ ```ts
2165
+ AbstractDiviner.publicChildren
2166
+ ```
2167
+
2168
+ ***
2169
+
2170
+ ### removeParent()
2171
+
2172
+ ```ts
2173
+ removeParent(address): void;
2174
+ ```
2175
+
2176
+ ### Parameters
2177
+
2178
+ #### address
2179
+
2180
+ `BrandedAddress`
2181
+
2182
+ ### Returns
2183
+
2184
+ `void`
2185
+
2186
+ ### Inherited from
2187
+
2188
+ ```ts
2189
+ AbstractDiviner.removeParent
2190
+ ```
2191
+
2192
+ ***
2193
+
2194
+ ### resolve()
2195
+
2196
+ ### Call Signature
2197
+
2198
+ ```ts
2199
+ resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2200
+ ```
2201
+
2202
+ #### Returns
2203
+
2204
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2205
+
2206
+ #### Inherited from
2207
+
2208
+ ```ts
2209
+ AbstractDiviner.resolve
2210
+ ```
2211
+
2212
+ ### Call Signature
2213
+
2214
+ ```ts
2215
+ resolve<T>(all, options?): Promise<T[]>;
2216
+ ```
2217
+
2218
+ #### Type Parameters
2219
+
2220
+ ##### T
2221
+
2222
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2223
+
2224
+ #### Parameters
2225
+
2226
+ ##### all
2227
+
2228
+ `"*"`
2229
+
2230
+ ##### options?
2231
+
2232
+ `ModuleFilterOptions`\<`T`\>
2233
+
2234
+ #### Returns
2235
+
2236
+ `Promise`\<`T`[]\>
2237
+
2238
+ #### Inherited from
2239
+
2240
+ ```ts
2241
+ AbstractDiviner.resolve
2242
+ ```
2243
+
2244
+ ### Call Signature
2245
+
2246
+ ```ts
2247
+ resolve<T>(id, options?): Promise<T | undefined>;
2248
+ ```
2249
+
2250
+ #### Type Parameters
2251
+
2252
+ ##### T
2253
+
2254
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2255
+
2256
+ #### Parameters
2257
+
2258
+ ##### id
2259
+
2260
+ `ModuleIdentifier`
2261
+
2262
+ ##### options?
2263
+
2264
+ `ModuleFilterOptions`\<`T`\>
2265
+
2266
+ #### Returns
2267
+
2268
+ `Promise`\<`T` \| `undefined`\>
2269
+
2270
+ #### Inherited from
2271
+
2272
+ ```ts
2273
+ AbstractDiviner.resolve
2274
+ ```
2275
+
2276
+ ***
2277
+
2278
+ ### resolveIdentifier()
2279
+
2280
+ ```ts
2281
+ resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
2282
+ ```
2283
+
2284
+ ### Parameters
2285
+
2286
+ #### id
2287
+
2288
+ `ModuleIdentifier`
2289
+
2290
+ #### options?
2291
+
2292
+ `ObjectFilterOptions`\<`AnyObject`\>
2293
+
2294
+ ### Returns
2295
+
2296
+ `Promise`\<`BrandedAddress` \| `undefined`\>
2297
+
2298
+ ### Inherited from
2299
+
2300
+ ```ts
2301
+ AbstractDiviner.resolveIdentifier
2302
+ ```
2303
+
2304
+ ***
2305
+
2306
+ ### resolvePrivate()
2307
+
2308
+ ### Call Signature
2309
+
2310
+ ```ts
2311
+ resolvePrivate<T>(all, options?): Promise<T[]>;
2312
+ ```
2313
+
2314
+ #### Type Parameters
2315
+
2316
+ ##### T
2317
+
2318
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2319
+
2320
+ #### Parameters
2321
+
2322
+ ##### all
2323
+
2324
+ `"*"`
2325
+
2326
+ ##### options?
2327
+
2328
+ `ModuleFilterOptions`\<`T`\>
2329
+
2330
+ #### Returns
2331
+
2332
+ `Promise`\<`T`[]\>
2333
+
2334
+ #### Inherited from
2335
+
2336
+ ```ts
2337
+ AbstractDiviner.resolvePrivate
2338
+ ```
2339
+
2340
+ ### Call Signature
2341
+
2342
+ ```ts
2343
+ resolvePrivate<T>(id, options?): Promise<T | undefined>;
2344
+ ```
2345
+
2346
+ #### Type Parameters
2347
+
2348
+ ##### T
2349
+
2350
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2351
+
2352
+ #### Parameters
2353
+
2354
+ ##### id
2355
+
2356
+ `ModuleIdentifier`
2357
+
2358
+ ##### options?
2359
+
2360
+ `ModuleFilterOptions`\<`T`\>
2361
+
2362
+ #### Returns
2363
+
2364
+ `Promise`\<`T` \| `undefined`\>
2365
+
2366
+ #### Inherited from
2367
+
2368
+ ```ts
2369
+ AbstractDiviner.resolvePrivate
2370
+ ```
2371
+
2372
+ ***
2373
+
2374
+ ### siblings()
2375
+
2376
+ ```ts
2377
+ siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2378
+ ```
2379
+
2380
+ ### Returns
2381
+
2382
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2383
+
2384
+ ### Inherited from
2385
+
2386
+ ```ts
2387
+ AbstractDiviner.siblings
2388
+ ```
2389
+
2390
+ ***
2391
+
2392
+ ### state()
2393
+
2394
+ ```ts
2395
+ state(): Promise<Payload[]>;
2396
+ ```
2397
+
2398
+ ### Returns
2399
+
2400
+ `Promise`\<`Payload`[]\>
2401
+
2402
+ ### Inherited from
2403
+
2404
+ ```ts
2405
+ AbstractDiviner.state
2406
+ ```
2407
+
2408
+ ***
2409
+
2410
+ ### stateQuery()
2411
+
2412
+ ```ts
2413
+ stateQuery(account): Promise<ModuleQueryResult>;
2414
+ ```
2415
+
2416
+ ### Parameters
2417
+
2418
+ #### account
2419
+
2420
+ `AccountInstance`
2421
+
2422
+ ### Returns
2423
+
2424
+ `Promise`\<`ModuleQueryResult`\>
2425
+
2426
+ ### Inherited from
2427
+
2428
+ ```ts
2429
+ AbstractDiviner.stateQuery
2430
+ ```
2431
+
2432
+ ***
2433
+
2434
+ ### subscribe()
2435
+
2436
+ ```ts
2437
+ subscribe(_queryAccount?): void;
2438
+ ```
2439
+
2440
+ ### Parameters
2441
+
2442
+ #### \_queryAccount?
2443
+
2444
+ `AccountInstance`
2445
+
2446
+ ### Returns
2447
+
2448
+ `void`
2449
+
2450
+ ### Inherited from
2451
+
2452
+ ```ts
2453
+ AbstractDiviner.subscribe
2454
+ ```
2455
+
2456
+ ***
2457
+
2458
+ ### manifestHandler()
2459
+
2460
+ ```ts
2461
+ protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
2462
+ ```
2463
+
2464
+ ### Parameters
2465
+
2466
+ #### maxDepth?
2467
+
2468
+ `number`
2469
+
2470
+ #### \_ignoreAddresses?
2471
+
2472
+ `BrandedAddress`[]
2473
+
2474
+ ### Returns
2475
+
2476
+ `Promise`\<`ModuleManifestPayload`\>
2477
+
2478
+ ### Inherited from
2479
+
2480
+ ```ts
2481
+ AbstractDiviner.manifestHandler
2482
+ ```
2483
+
2484
+ ***
2485
+
2486
+ ### resolveArchivingArchivists()
2487
+
2488
+ ```ts
2489
+ protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
2490
+ ```
2491
+
2492
+ ### Returns
2493
+
2494
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
2495
+
2496
+ ### Inherited from
2497
+
2498
+ ```ts
2499
+ AbstractDiviner.resolveArchivingArchivists
2500
+ ```
2501
+
2502
+ ***
2503
+
2504
+ ### sendQuery()
2505
+
2506
+ ```ts
2507
+ protected sendQuery<T, P, R>(
2508
+ queryPayload,
2509
+ payloads?,
2510
+ account?): Promise<R[]>;
2511
+ ```
2512
+
2513
+ ### Type Parameters
2514
+
2515
+ #### T
2516
+
2517
+ `T` *extends* `Query`
2518
+
2519
+ #### P
2520
+
2521
+ `P` *extends* `Payload` = `Payload`
2522
+
2523
+ #### R
2524
+
2525
+ `R` *extends* `Payload` = `Payload`
2526
+
2527
+ ### Parameters
2528
+
2529
+ #### queryPayload
2530
+
2531
+ `T`
2532
+
2533
+ #### payloads?
2534
+
2535
+ `P`[]
2536
+
2537
+ #### account?
2538
+
2539
+ `AccountInstance`
2540
+
2541
+ ### Returns
2542
+
2543
+ `Promise`\<`R`[]\>
2544
+
2545
+ ### Inherited from
2546
+
2547
+ ```ts
2548
+ AbstractDiviner.sendQuery
2549
+ ```
2550
+
2551
+ ***
2552
+
2553
+ ### sendQueryRaw()
2554
+
2555
+ ```ts
2556
+ protected sendQueryRaw<T, P, R>(
2557
+ queryPayload,
2558
+ payloads?,
2559
+ account?): Promise<ModuleQueryResult<R>>;
2560
+ ```
2561
+
2562
+ ### Type Parameters
2563
+
2564
+ #### T
2565
+
2566
+ `T` *extends* `Query`
2567
+
2568
+ #### P
2569
+
2570
+ `P` *extends* `Payload` = `Payload`
2571
+
2572
+ #### R
2573
+
2574
+ `R` *extends* `Payload` = `Payload`
2575
+
2576
+ ### Parameters
2577
+
2578
+ #### queryPayload
2579
+
2580
+ `T`
2581
+
2582
+ #### payloads?
2583
+
2584
+ `P`[]
2585
+
2586
+ #### account?
2587
+
2588
+ `AccountInstance`
2589
+
2590
+ ### Returns
2591
+
2592
+ `Promise`\<`ModuleQueryResult`\<`R`\>\>
2593
+
2594
+ ### Inherited from
2595
+
2596
+ ```ts
2597
+ AbstractDiviner.sendQueryRaw
2598
+ ```
2599
+
2600
+ ***
2601
+
2602
+ ### storeToArchivists()
2603
+
2604
+ ```ts
2605
+ protected storeToArchivists(payloads): Promise<Payload[]>;
2606
+ ```
2607
+
2608
+ ### Parameters
2609
+
2610
+ #### payloads
2611
+
2612
+ `Payload`[]
2613
+
2614
+ ### Returns
2615
+
2616
+ `Promise`\<`Payload`[]\>
2617
+
2618
+ ### Inherited from
2619
+
2620
+ ```ts
2621
+ AbstractDiviner.storeToArchivists
2622
+ ```
2623
+
2624
+ ### <a id="MemoryBoundWitnessStatsDiviner"></a>MemoryBoundWitnessStatsDiviner
2625
+
2626
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
2627
+
2628
+ ***
2629
+
2630
+ ## Extends
2631
+
2632
+ - [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner)\<`TParams`\>
2633
+
2634
+ ## Type Parameters
2635
+
2636
+ ### TParams
2637
+
2638
+ `TParams` *extends* [`BoundWitnessStatsDivinerParams`](#../type-aliases/BoundWitnessStatsDivinerParams) = [`BoundWitnessStatsDivinerParams`](#../type-aliases/BoundWitnessStatsDivinerParams)
2639
+
2640
+ ## Constructors
2641
+
2642
+ ### Constructor
2643
+
2644
+ ```ts
2645
+ new MemoryBoundWitnessStatsDiviner<TParams>(key, params): MemoryBoundWitnessStatsDiviner<TParams>;
2646
+ ```
2647
+
2648
+ ### Parameters
2649
+
2650
+ #### key
2651
+
2652
+ `unknown`
2653
+
2654
+ #### params
2655
+
2656
+ `Partial`\<`TParams` & `RequiredCreatableParams`\>
2657
+
2658
+ ### Returns
2659
+
2660
+ `MemoryBoundWitnessStatsDiviner`\<`TParams`\>
2661
+
2662
+ ### Inherited from
2663
+
2664
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`constructor`](BoundWitnessStatsDiviner.md#constructor)
2665
+
2666
+ ## Properties
2667
+
2668
+ ### targetSchema
2669
+
2670
+ ```ts
2671
+ readonly static targetSchema: Schema;
2672
+ ```
2673
+
2674
+ ### Inherited from
2675
+
2676
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`targetSchema`](BoundWitnessStatsDiviner.md#targetschema)
2677
+
2678
+ ***
2679
+
2680
+ ### uniqueName
2681
+
2682
+ ```ts
2683
+ readonly static uniqueName: string;
2684
+ ```
2685
+
2686
+ ### Inherited from
2687
+
2688
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`uniqueName`](BoundWitnessStatsDiviner.md#uniquename)
2689
+
2690
+ ***
2691
+
2692
+ ### configSchemas
2693
+
2694
+ ```ts
2695
+ readonly static configSchemas: Schema[];
2696
+ ```
2697
+
2698
+ ### Overrides
2699
+
2700
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`configSchemas`](BoundWitnessStatsDiviner.md#configschemas)
2701
+
2702
+ ***
2703
+
2704
+ ### defaultConfigSchema
2705
+
2706
+ ```ts
2707
+ readonly static defaultConfigSchema: Schema;
2708
+ ```
2709
+
2710
+ ### Overrides
2711
+
2712
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`defaultConfigSchema`](BoundWitnessStatsDiviner.md#defaultconfigschema)
2713
+
2714
+ ***
2715
+
2716
+ ### allowRandomAccount
2717
+
2718
+ ```ts
2719
+ readonly static allowRandomAccount: boolean;
2720
+ ```
2721
+
2722
+ ### Inherited from
2723
+
2724
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`allowRandomAccount`](BoundWitnessStatsDiviner.md#allowrandomaccount)
2725
+
2726
+ ***
2727
+
2728
+ ### defaultLogger
2729
+
2730
+ ```ts
2731
+ static defaultLogger: Logger;
2732
+ ```
2733
+
2734
+ ### Inherited from
2735
+
2736
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`defaultLogger`](BoundWitnessStatsDiviner.md#defaultlogger)
2737
+
2738
+ ***
2739
+
2740
+ ### enableLazyLoad
2741
+
2742
+ ```ts
2743
+ static enableLazyLoad: boolean;
2744
+ ```
2745
+
2746
+ ### Inherited from
2747
+
2748
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`enableLazyLoad`](BoundWitnessStatsDiviner.md#enablelazyload)
2749
+
2750
+ ***
2751
+
2752
+ ### labels
2753
+
2754
+ ```ts
2755
+ readonly static labels: Labels;
2756
+ ```
2757
+
2758
+ ### Inherited from
2759
+
2760
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`labels`](BoundWitnessStatsDiviner.md#labels)
2761
+
2762
+ ***
2763
+
2764
+ ### privateConstructorKey
2765
+
2766
+ ```ts
2767
+ protected static privateConstructorKey: string;
2768
+ ```
2769
+
2770
+ ### Inherited from
2771
+
2772
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`privateConstructorKey`](BoundWitnessStatsDiviner.md#privateconstructorkey)
2773
+
2774
+ ***
2775
+
2776
+ ### \_account
2777
+
2778
+ ```ts
2779
+ protected _account: AccountInstance | undefined;
2780
+ ```
2781
+
2782
+ ### Inherited from
2783
+
2784
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_account`](BoundWitnessStatsDiviner.md#_account)
2785
+
2786
+ ***
2787
+
2788
+ ### \_cachedManifests
2789
+
2790
+ ```ts
2791
+ protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
2792
+ ```
2793
+
2794
+ ### Inherited from
2795
+
2796
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_cachedManifests`](BoundWitnessStatsDiviner.md#_cachedmanifests)
2797
+
2798
+ ***
2799
+
2800
+ ### \_globalReentrancyMutex
2801
+
2802
+ ```ts
2803
+ protected _globalReentrancyMutex: Mutex | undefined;
2804
+ ```
2805
+
2806
+ ### Inherited from
2807
+
2808
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_globalReentrancyMutex`](BoundWitnessStatsDiviner.md#_globalreentrancymutex)
2809
+
2810
+ ***
2811
+
2812
+ ### \_lastError?
2813
+
2814
+ ```ts
2815
+ protected optional _lastError?: ModuleDetailsError;
2816
+ ```
2817
+
2818
+ ### Inherited from
2819
+
2820
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_lastError`](BoundWitnessStatsDiviner.md#_lasterror)
2821
+
2822
+ ***
2823
+
2824
+ ### \_moduleConfigQueryValidator
2825
+
2826
+ ```ts
2827
+ protected _moduleConfigQueryValidator: Queryable | undefined;
2828
+ ```
2829
+
2830
+ ### Inherited from
2831
+
2832
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_moduleConfigQueryValidator`](BoundWitnessStatsDiviner.md#_moduleconfigqueryvalidator)
2833
+
2834
+ ***
2835
+
2836
+ ### \_supportedQueryValidator
2837
+
2838
+ ```ts
2839
+ protected _supportedQueryValidator: Queryable | undefined;
2840
+ ```
2841
+
2842
+ ### Inherited from
2843
+
2844
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_supportedQueryValidator`](BoundWitnessStatsDiviner.md#_supportedqueryvalidator)
2845
+
2846
+ ***
2847
+
2848
+ ### useNewResolver
2849
+
2850
+ ```ts
2851
+ readonly static useNewResolver: false = false;
2852
+ ```
2853
+
2854
+ ### Inherited from
2855
+
2856
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`useNewResolver`](BoundWitnessStatsDiviner.md#usenewresolver)
2857
+
2858
+ ## Accessors
2859
+
2860
+ ### queries
2861
+
2862
+ ### Get Signature
2863
+
2864
+ ```ts
2865
+ get queries(): Schema[];
2866
+ ```
2867
+
2868
+ #### Returns
2869
+
2870
+ `Schema`[]
2871
+
2872
+ ### Inherited from
2873
+
2874
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`queries`](BoundWitnessStatsDiviner.md#queries)
2875
+
2876
+ ***
2877
+
2878
+ ### account
2879
+
2880
+ ### Get Signature
2881
+
2882
+ ```ts
2883
+ get account(): AccountInstance;
2884
+ ```
2885
+
2886
+ #### Returns
2887
+
2888
+ `AccountInstance`
2889
+
2890
+ ### Inherited from
2891
+
2892
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`account`](BoundWitnessStatsDiviner.md#account)
2893
+
2894
+ ***
2895
+
2896
+ ### additionalSigners
2897
+
2898
+ ### Get Signature
2899
+
2900
+ ```ts
2901
+ get additionalSigners(): AccountInstance[];
2902
+ ```
2903
+
2904
+ #### Returns
2905
+
2906
+ `AccountInstance`[]
2907
+
2908
+ ### Inherited from
2909
+
2910
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`additionalSigners`](BoundWitnessStatsDiviner.md#additionalsigners)
2911
+
2912
+ ***
2913
+
2914
+ ### address
2915
+
2916
+ ### Get Signature
2917
+
2918
+ ```ts
2919
+ get address(): Lowercase<string> & object & object;
2920
+ ```
2921
+
2922
+ #### Returns
2923
+
2924
+ `Lowercase`\<`string`\> & `object` & `object`
2925
+
2926
+ ### Inherited from
2927
+
2928
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`address`](BoundWitnessStatsDiviner.md#address)
2929
+
2930
+ ***
2931
+
2932
+ ### allowAnonymous
2933
+
2934
+ ### Get Signature
2935
+
2936
+ ```ts
2937
+ get allowAnonymous(): boolean;
2938
+ ```
2939
+
2940
+ #### Returns
2941
+
2942
+ `boolean`
2943
+
2944
+ ### Inherited from
2945
+
2946
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`allowAnonymous`](BoundWitnessStatsDiviner.md#allowanonymous)
2947
+
2948
+ ***
2949
+
2950
+ ### allowNameResolution
2951
+
2952
+ ### Get Signature
2953
+
2954
+ ```ts
2955
+ get allowNameResolution(): boolean;
2956
+ ```
2957
+
2958
+ #### Returns
2959
+
2960
+ `boolean`
2961
+
2962
+ ### Inherited from
2963
+
2964
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`allowNameResolution`](BoundWitnessStatsDiviner.md#allownameresolution)
2965
+
2966
+ ***
2967
+
2968
+ ### archiving
2969
+
2970
+ ### Get Signature
2971
+
2972
+ ```ts
2973
+ get archiving():
2974
+ | {
2975
+ archivists?: ModuleIdentifier[];
2976
+ queries?: Schema[];
2977
+ }
2978
+ | undefined;
2979
+ ```
2980
+
2981
+ #### Returns
2982
+
2983
+ \| \{
2984
+ `archivists?`: `ModuleIdentifier`[];
2985
+ `queries?`: `Schema`[];
2986
+ \}
2987
+ \| `undefined`
2988
+
2989
+ ### Inherited from
2990
+
2991
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`archiving`](BoundWitnessStatsDiviner.md#archiving)
2992
+
2993
+ ***
2994
+
2995
+ ### archivist
2996
+
2997
+ ### Get Signature
2998
+
2999
+ ```ts
3000
+ get archivist(): ModuleIdentifier | undefined;
3001
+ ```
3002
+
3003
+ #### Returns
3004
+
3005
+ `ModuleIdentifier` \| `undefined`
3006
+
3007
+ ### Inherited from
3008
+
3009
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`archivist`](BoundWitnessStatsDiviner.md#archivist)
3010
+
3011
+ ***
3012
+
3013
+ ### config
3014
+
3015
+ ### Get Signature
3016
+
3017
+ ```ts
3018
+ get config(): TParams["config"] & object;
3019
+ ```
3020
+
3021
+ #### Returns
3022
+
3023
+ `TParams`\[`"config"`\] & `object`
3024
+
3025
+ ### Inherited from
3026
+
3027
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`config`](BoundWitnessStatsDiviner.md#config)
3028
+
3029
+ ***
3030
+
3031
+ ### dead
3032
+
3033
+ ### Get Signature
3034
+
3035
+ ```ts
3036
+ get dead(): boolean;
3037
+ ```
3038
+
3039
+ #### Returns
3040
+
3041
+ `boolean`
3042
+
3043
+ ### Inherited from
3044
+
3045
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`dead`](BoundWitnessStatsDiviner.md#dead)
3046
+
3047
+ ***
3048
+
3049
+ ### ephemeralQueryAccountEnabled
3050
+
3051
+ ### Get Signature
3052
+
3053
+ ```ts
3054
+ get ephemeralQueryAccountEnabled(): boolean;
3055
+ ```
3056
+
3057
+ #### Returns
3058
+
3059
+ `boolean`
3060
+
3061
+ ### Inherited from
3062
+
3063
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`ephemeralQueryAccountEnabled`](BoundWitnessStatsDiviner.md#ephemeralqueryaccountenabled)
3064
+
3065
+ ***
3066
+
3067
+ ### globalReentrancyMutex
3068
+
3069
+ ### Get Signature
3070
+
3071
+ ```ts
3072
+ get globalReentrancyMutex(): Mutex | undefined;
3073
+ ```
3074
+
3075
+ #### Returns
3076
+
3077
+ `Mutex` \| `undefined`
3078
+
3079
+ ### Inherited from
3080
+
3081
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`globalReentrancyMutex`](BoundWitnessStatsDiviner.md#globalreentrancymutex)
3082
+
3083
+ ***
3084
+
3085
+ ### id
3086
+
3087
+ ### Get Signature
3088
+
3089
+ ```ts
3090
+ get id(): string;
3091
+ ```
3092
+
3093
+ The name (if specified) or address of the module
3094
+
3095
+ #### Returns
3096
+
3097
+ `string`
3098
+
3099
+ ### Inherited from
3100
+
3101
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`id`](BoundWitnessStatsDiviner.md#id)
3102
+
3103
+ ***
3104
+
3105
+ ### logger
3106
+
3107
+ ### Get Signature
3108
+
3109
+ ```ts
3110
+ get logger(): Logger | undefined;
3111
+ ```
3112
+
3113
+ #### Returns
3114
+
3115
+ `Logger` \| `undefined`
3116
+
3117
+ ### Inherited from
3118
+
3119
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`logger`](BoundWitnessStatsDiviner.md#logger)
3120
+
3121
+ ***
3122
+
3123
+ ### priority
3124
+
3125
+ ### Get Signature
3126
+
3127
+ ```ts
3128
+ get priority(): 2;
3129
+ ```
3130
+
3131
+ #### Returns
3132
+
3133
+ `2`
3134
+
3135
+ ### Inherited from
3136
+
3137
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`priority`](BoundWitnessStatsDiviner.md#priority)
3138
+
3139
+ ***
3140
+
3141
+ ### reentrancy
3142
+
3143
+ ### Get Signature
3144
+
3145
+ ```ts
3146
+ get reentrancy():
3147
+ | {
3148
+ action: "skip" | "wait";
3149
+ scope: "global";
3150
+ }
3151
+ | undefined;
3152
+ ```
3153
+
3154
+ #### Returns
3155
+
3156
+ \| \{
3157
+ `action`: `"skip"` \| `"wait"`;
3158
+ `scope`: `"global"`;
3159
+ \}
3160
+ \| `undefined`
3161
+
3162
+ ### Inherited from
3163
+
3164
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`reentrancy`](BoundWitnessStatsDiviner.md#reentrancy)
3165
+
3166
+ ***
3167
+
3168
+ ### statusReporter
3169
+
3170
+ ### Get Signature
3171
+
3172
+ ```ts
3173
+ get statusReporter():
3174
+ | ModuleStatusReporter & CreatableStatusReporter<void>
3175
+ | undefined;
3176
+ ```
3177
+
3178
+ The status reporter used to broadcast lifecycle changes.
3179
+
3180
+ #### Returns
3181
+
3182
+ \| `ModuleStatusReporter` & `CreatableStatusReporter`\<`void`\>
3183
+ \| `undefined`
3184
+
3185
+ ### Inherited from
3186
+
3187
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`statusReporter`](BoundWitnessStatsDiviner.md#statusreporter)
3188
+
3189
+ ***
3190
+
3191
+ ### timestamp
3192
+
3193
+ ### Get Signature
3194
+
3195
+ ```ts
3196
+ get timestamp(): boolean;
3197
+ ```
3198
+
3199
+ #### Returns
3200
+
3201
+ `boolean`
3202
+
3203
+ ### Inherited from
3204
+
3205
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`timestamp`](BoundWitnessStatsDiviner.md#timestamp)
3206
+
3207
+ ***
3208
+
3209
+ ### moduleConfigQueryValidator
3210
+
3211
+ ### Get Signature
3212
+
3213
+ ```ts
3214
+ get protected moduleConfigQueryValidator(): Queryable;
3215
+ ```
3216
+
3217
+ #### Returns
3218
+
3219
+ `Queryable`
3220
+
3221
+ ### Inherited from
3222
+
3223
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`moduleConfigQueryValidator`](BoundWitnessStatsDiviner.md#moduleconfigqueryvalidator)
3224
+
3225
+ ***
3226
+
3227
+ ### supportedQueryValidator
3228
+
3229
+ ### Get Signature
3230
+
3231
+ ```ts
3232
+ get protected supportedQueryValidator(): Queryable;
3233
+ ```
3234
+
3235
+ #### Returns
3236
+
3237
+ `Queryable`
3238
+
3239
+ ### Inherited from
3240
+
3241
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`supportedQueryValidator`](BoundWitnessStatsDiviner.md#supportedqueryvalidator)
3242
+
3243
+ ***
3244
+
3245
+ ### downResolver
3246
+
3247
+ ### Get Signature
3248
+
3249
+ ```ts
3250
+ get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
3251
+ ```
3252
+
3253
+ #### Returns
3254
+
3255
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
3256
+
3257
+ ### Inherited from
3258
+
3259
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`downResolver`](BoundWitnessStatsDiviner.md#downresolver)
3260
+
3261
+ ***
3262
+
3263
+ ### modName
3264
+
3265
+ ### Get Signature
3266
+
3267
+ ```ts
3268
+ get modName(): string | undefined;
3269
+ ```
3270
+
3271
+ #### Returns
3272
+
3273
+ `string` \| `undefined`
3274
+
3275
+ ### Inherited from
3276
+
3277
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`modName`](BoundWitnessStatsDiviner.md#modname)
3278
+
3279
+ ***
3280
+
3281
+ ### moduleIdentifierTransformers
3282
+
3283
+ ### Get Signature
3284
+
3285
+ ```ts
3286
+ get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
3287
+ ```
3288
+
3289
+ #### Returns
3290
+
3291
+ `ModuleIdentifierTransformer`[]
3292
+
3293
+ ### Inherited from
3294
+
3295
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`moduleIdentifierTransformers`](BoundWitnessStatsDiviner.md#moduleidentifiertransformers)
3296
+
3297
+ ***
3298
+
3299
+ ### privateResolver
3300
+
3301
+ ### Get Signature
3302
+
3303
+ ```ts
3304
+ get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
3305
+ ```
3306
+
3307
+ #### Returns
3308
+
3309
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
3310
+
3311
+ ### Inherited from
3312
+
3313
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`privateResolver`](BoundWitnessStatsDiviner.md#privateresolver)
3314
+
3315
+ ***
3316
+
3317
+ ### root
3318
+
3319
+ ### Get Signature
3320
+
3321
+ ```ts
3322
+ get root(): this;
3323
+ ```
3324
+
3325
+ #### Returns
3326
+
3327
+ `this`
3328
+
3329
+ ### Inherited from
3330
+
3331
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`root`](BoundWitnessStatsDiviner.md#root)
3332
+
3333
+ ***
3334
+
3335
+ ### timeBudget
3336
+
3337
+ ### Get Signature
3338
+
3339
+ ```ts
3340
+ get timeBudget(): number | undefined;
3341
+ ```
3342
+
3343
+ #### Returns
3344
+
3345
+ `number` \| `undefined`
3346
+
3347
+ ### Inherited from
3348
+
3349
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`timeBudget`](BoundWitnessStatsDiviner.md#timebudget)
3350
+
3351
+ ***
3352
+
3353
+ ### upResolver
3354
+
3355
+ ### Get Signature
3356
+
3357
+ ```ts
3358
+ get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
3359
+ ```
3360
+
3361
+ #### Returns
3362
+
3363
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
3364
+
3365
+ ### Inherited from
3366
+
3367
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`upResolver`](BoundWitnessStatsDiviner.md#upresolver)
3368
+
3369
+ ## Methods
3370
+
3371
+ ### divine()
3372
+
3373
+ ```ts
3374
+ divine(payloads?, retryConfigIn?): Promise<DivinerDivineResult<Payload>[]>;
3375
+ ```
3376
+
3377
+ **`Function`**
3378
+
3379
+ divine The main entry point for a diviner. Do not override this function. Implement/override divineHandler for custom functionality
3380
+
3381
+ ### Parameters
3382
+
3383
+ #### payloads?
3384
+
3385
+ `Payload`[]
3386
+
3387
+ #### retryConfigIn?
3388
+
3389
+ `RetryConfigWithComplete`\<`unknown`\>
3390
+
3391
+ ### Returns
3392
+
3393
+ `Promise`\<`DivinerDivineResult`\<`Payload`\>[]\>
3394
+
3395
+ ### Inherited from
3396
+
3397
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`divine`](BoundWitnessStatsDiviner.md#divine)
3398
+
3399
+ ***
3400
+
3401
+ ### divineQuery()
3402
+
3403
+ ```ts
3404
+ divineQuery(
3405
+ payloads?,
3406
+ account?,
3407
+ _retry?): Promise<ModuleQueryResult<Payload>>;
3408
+ ```
3409
+
3410
+ ### Parameters
3411
+
3412
+ #### payloads?
3413
+
3414
+ `Payload`[]
3415
+
3416
+ #### account?
3417
+
3418
+ `AccountInstance`
3419
+
3420
+ #### \_retry?
3421
+
3422
+ `RetryConfig`
3423
+
3424
+ ### Returns
3425
+
3426
+ `Promise`\<`ModuleQueryResult`\<`Payload`\>\>
3427
+
3428
+ ### Inherited from
3429
+
3430
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`divineQuery`](BoundWitnessStatsDiviner.md#divinequery)
3431
+
3432
+ ***
3433
+
3434
+ ### queryHandler()
3435
+
3436
+ ```ts
3437
+ protected queryHandler<T, TConfig>(
3438
+ query,
3439
+ payloads?,
3440
+ queryConfig?): Promise<ModuleQueryHandlerResult>;
3441
+ ```
3442
+
3443
+ **`Function`**
3444
+
3445
+ queryHandler Calls divine for a divine query. Override to support additional queries.
3446
+
3447
+ ### Type Parameters
3448
+
3449
+ #### T
3450
+
3451
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
3452
+
3453
+ #### TConfig
3454
+
3455
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
3456
+
3457
+ ### Parameters
3458
+
3459
+ #### query
3460
+
3461
+ `T`
3462
+
3463
+ #### payloads?
3464
+
3465
+ `Payload`[]
3466
+
3467
+ #### queryConfig?
3468
+
3469
+ `TConfig`
3470
+
3471
+ ### Returns
3472
+
3473
+ `Promise`\<`ModuleQueryHandlerResult`\>
3474
+
3475
+ ### Inherited from
3476
+
3477
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`queryHandler`](BoundWitnessStatsDiviner.md#queryhandler)
3478
+
3479
+ ***
3480
+
3481
+ ### startHandler()
3482
+
3483
+ ```ts
3484
+ protected startHandler(): Promise<void>;
3485
+ ```
3486
+
3487
+ ### Returns
3488
+
3489
+ `Promise`\<`void`\>
3490
+
3491
+ ### Inherited from
3492
+
3493
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`startHandler`](BoundWitnessStatsDiviner.md#starthandler)
3494
+
3495
+ ***
3496
+
3497
+ ### stopHandler()
3498
+
3499
+ ```ts
3500
+ protected stopHandler(): Promise<void>;
3501
+ ```
3502
+
3503
+ ### Returns
3504
+
3505
+ `Promise`\<`void`\>
3506
+
3507
+ ### Inherited from
3508
+
3509
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`stopHandler`](BoundWitnessStatsDiviner.md#stophandler)
3510
+
3511
+ ***
3512
+
3513
+ ### divineAddress()
3514
+
3515
+ ```ts
3516
+ protected divineAddress(address): Promise<number>;
3517
+ ```
3518
+
3519
+ ### Parameters
3520
+
3521
+ #### address
3522
+
3523
+ `BrandedAddress`
3524
+
3525
+ ### Returns
3526
+
3527
+ `Promise`\<`number`\>
3528
+
3529
+ ***
3530
+
3531
+ ### divineAllAddresses()
3532
+
3533
+ ```ts
3534
+ protected divineAllAddresses(): Promise<number>;
3535
+ ```
3536
+
3537
+ ### Returns
3538
+
3539
+ `Promise`\<`number`\>
3540
+
3541
+ ***
3542
+
3543
+ ### divineHandler()
3544
+
3545
+ ```ts
3546
+ protected divineHandler(payloads?): Promise<Payload[]>;
3547
+ ```
3548
+
3549
+ **`Function`**
3550
+
3551
+ divineHandler Implement or override to add custom functionality to a diviner
3552
+
3553
+ ### Parameters
3554
+
3555
+ #### payloads?
3556
+
3557
+ `Payload`[]
3558
+
3559
+ ### Returns
3560
+
3561
+ `Promise`\<`Payload`[]\>
3562
+
3563
+ ### Overrides
3564
+
3565
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`divineHandler`](BoundWitnessStatsDiviner.md#divinehandler)
3566
+
3567
+ ***
3568
+
3569
+ ### \_getRootFunction()
3570
+
3571
+ ```ts
3572
+ static _getRootFunction(funcName): any;
3573
+ ```
3574
+
3575
+ ### Parameters
3576
+
3577
+ #### funcName
3578
+
3579
+ `string`
3580
+
3581
+ ### Returns
3582
+
3583
+ `any`
3584
+
3585
+ ### Inherited from
3586
+
3587
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_getRootFunction`](BoundWitnessStatsDiviner.md#_getrootfunction)
3588
+
3589
+ ***
3590
+
3591
+ ### \_noOverride()
3592
+
3593
+ ```ts
3594
+ static _noOverride(functionName): void;
3595
+ ```
3596
+
3597
+ ### Parameters
3598
+
3599
+ #### functionName
3600
+
3601
+ `string`
3602
+
3603
+ ### Returns
3604
+
3605
+ `void`
3606
+
3607
+ ### Inherited from
3608
+
3609
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_noOverride`](BoundWitnessStatsDiviner.md#_nooverride)
3610
+
3611
+ ***
3612
+
3613
+ ### createHandler()
3614
+
3615
+ ```ts
3616
+ static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;
3617
+ ```
3618
+
3619
+ Static hook called during creation to perform additional initialization.
3620
+ Override in subclasses to customize post-construction setup.
3621
+
3622
+ ### Type Parameters
3623
+
3624
+ #### T
3625
+
3626
+ `T` *extends* `CreatableInstance`\<`CreatableParams`, `EventData`\>
3627
+
3628
+ ### Parameters
3629
+
3630
+ #### inInstance
3631
+
3632
+ `T`
3633
+
3634
+ ### Returns
3635
+
3636
+ `Promise`\<`T` & `AbstractModule`\<`any`, `any`\>\>
3637
+
3638
+ The instance, potentially modified
3639
+
3640
+ ### Inherited from
3641
+
3642
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`createHandler`](BoundWitnessStatsDiviner.md#createhandler)
3643
+
3644
+ ***
3645
+
3646
+ ### determineAccount()
3647
+
3648
+ ```ts
3649
+ static determineAccount(params): Promise<AccountInstance>;
3650
+ ```
3651
+
3652
+ ### Parameters
3653
+
3654
+ #### params
3655
+
3656
+ ##### account?
3657
+
3658
+ `AccountInstance` \| `"random"`
3659
+
3660
+ ##### accountPath?
3661
+
3662
+ `string`
3663
+
3664
+ ##### wallet?
3665
+
3666
+ `WalletInstance`
3667
+
3668
+ ### Returns
3669
+
3670
+ `Promise`\<`AccountInstance`\>
3671
+
3672
+ ### Inherited from
3673
+
3674
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`determineAccount`](BoundWitnessStatsDiviner.md#determineaccount)
3675
+
3676
+ ***
3677
+
3678
+ ### factory()
3679
+
3680
+ ```ts
3681
+ static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;
3682
+ ```
3683
+
3684
+ ### Type Parameters
3685
+
3686
+ #### TModule
3687
+
3688
+ `TModule` *extends* `CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
3689
+
3690
+ ### Parameters
3691
+
3692
+ #### this
3693
+
3694
+ `CreatableModule`\<`TModule`\>
3695
+
3696
+ #### params?
3697
+
3698
+ `Partial`\<`TModule`\[`"params"`\]\>
3699
+
3700
+ ### Returns
3701
+
3702
+ `CreatableModuleFactory`\<`TModule`\>
3703
+
3704
+ ### Inherited from
3705
+
3706
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`factory`](BoundWitnessStatsDiviner.md#factory)
3707
+
3708
+ ***
3709
+
3710
+ ### isAllowedSchema()
3711
+
3712
+ ```ts
3713
+ static isAllowedSchema(schema): boolean;
3714
+ ```
3715
+
3716
+ ### Parameters
3717
+
3718
+ #### schema
3719
+
3720
+ `Schema`
3721
+
3722
+ ### Returns
3723
+
3724
+ `boolean`
3725
+
3726
+ ### Inherited from
3727
+
3728
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`isAllowedSchema`](BoundWitnessStatsDiviner.md#isallowedschema)
3729
+
3730
+ ***
3731
+
3732
+ ### paramsHandler()
3733
+
3734
+ ```ts
3735
+ static paramsHandler<T>(inParams?): Promise<T["params"]>;
3736
+ ```
3737
+
3738
+ Static hook called during creation to validate and transform params.
3739
+ Override in subclasses to add default values or validation.
3740
+
3741
+ ### Type Parameters
3742
+
3743
+ #### T
3744
+
3745
+ `T` *extends* `AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
3746
+
3747
+ ### Parameters
3748
+
3749
+ #### inParams?
3750
+
3751
+ `Partial`\<`T`\[`"params"`\]\>
3752
+
3753
+ ### Returns
3754
+
3755
+ `Promise`\<`T`\[`"params"`\]\>
3756
+
3757
+ The processed params ready for construction
3758
+
3759
+ ### Inherited from
3760
+
3761
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`paramsHandler`](BoundWitnessStatsDiviner.md#paramshandler)
3762
+
3763
+ ***
3764
+
3765
+ ### \_getRootFunction()
3766
+
3767
+ ```ts
3768
+ _getRootFunction(funcName): any;
3769
+ ```
3770
+
3771
+ ### Parameters
3772
+
3773
+ #### funcName
3774
+
3775
+ `string`
3776
+
3777
+ ### Returns
3778
+
3779
+ `any`
3780
+
3781
+ ### Inherited from
3782
+
3783
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_getRootFunction`](BoundWitnessStatsDiviner.md#_getrootfunction-1)
3784
+
3785
+ ***
3786
+
3787
+ ### busy()
3788
+
3789
+ ```ts
3790
+ busy<R>(closure): Promise<R>;
3791
+ ```
3792
+
3793
+ ### Type Parameters
3794
+
3795
+ #### R
3796
+
3797
+ `R`
3798
+
3799
+ ### Parameters
3800
+
3801
+ #### closure
3802
+
3803
+ () => `Promise`\<`R`\>
3804
+
3805
+ ### Returns
3806
+
3807
+ `Promise`\<`R`\>
3808
+
3809
+ ### Inherited from
3810
+
3811
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`busy`](BoundWitnessStatsDiviner.md#busy)
3812
+
3813
+ ***
3814
+
3815
+ ### emit()
3816
+
3817
+ ```ts
3818
+ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
3819
+ ```
3820
+
3821
+ Emits an event, invoking all registered listeners concurrently.
3822
+
3823
+ ### Type Parameters
3824
+
3825
+ #### TEventName
3826
+
3827
+ `TEventName` *extends* `string` \| `number` \| `symbol` = `string` \| `number` \| `symbol`
3828
+
3829
+ #### TEventArgs
3830
+
3831
+ `TEventArgs` *extends* `EventArgs` = `DivinerModuleEventData`\<`DivinerInstance`\<`TParams`, `Payload`, `Payload`, `DivinerModuleEventData`\>, `Payload`, `Payload`\>\[`TEventName`\]
3832
+
3833
+ ### Parameters
3834
+
3835
+ #### eventName
3836
+
3837
+ `TEventName`
3838
+
3839
+ The event to emit.
3840
+
3841
+ #### eventArgs
3842
+
3843
+ `TEventArgs`
3844
+
3845
+ The data to pass to listeners.
3846
+
3847
+ ### Returns
3848
+
3849
+ `Promise`\<`void`\>
3850
+
3851
+ ### Inherited from
3852
+
3853
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`emit`](BoundWitnessStatsDiviner.md#emit)
3854
+
3855
+ ***
3856
+
3857
+ ### isSupportedQuery()
3858
+
3859
+ ```ts
3860
+ isSupportedQuery(query, assert?): boolean;
3861
+ ```
3862
+
3863
+ ### Parameters
3864
+
3865
+ #### query
3866
+
3867
+ `Schema`
3868
+
3869
+ #### assert?
3870
+
3871
+ `string` \| `boolean`
3872
+
3873
+ ### Returns
3874
+
3875
+ `boolean`
3876
+
3877
+ ### Inherited from
3878
+
3879
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`isSupportedQuery`](BoundWitnessStatsDiviner.md#issupportedquery)
3880
+
3881
+ ***
3882
+
3883
+ ### previousHash()
3884
+
3885
+ ```ts
3886
+ previousHash(): Promisable<string | undefined>;
3887
+ ```
3888
+
3889
+ ### Returns
3890
+
3891
+ `Promisable`\<`string` \| `undefined`\>
3892
+
3893
+ ### Inherited from
3894
+
3895
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`previousHash`](BoundWitnessStatsDiviner.md#previoushash)
3896
+
3897
+ ***
3898
+
3899
+ ### query()
3900
+
3901
+ ```ts
3902
+ query<T, TConfig>(
3903
+ query,
3904
+ payloads?,
3905
+ queryConfig?): Promise<ModuleQueryResult>;
3906
+ ```
3907
+
3908
+ ### Type Parameters
3909
+
3910
+ #### T
3911
+
3912
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
3913
+
3914
+ #### TConfig
3915
+
3916
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
3917
+
3918
+ ### Parameters
3919
+
3920
+ #### query
3921
+
3922
+ `T`
3923
+
3924
+ #### payloads?
3925
+
3926
+ `Payload`[]
3927
+
3928
+ #### queryConfig?
3929
+
3930
+ `TConfig`
3931
+
3932
+ ### Returns
3933
+
3934
+ `Promise`\<`ModuleQueryResult`\>
3935
+
3936
+ ### Inherited from
3937
+
3938
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`query`](BoundWitnessStatsDiviner.md#query)
3939
+
3940
+ ***
3941
+
3942
+ ### queryable()
3943
+
3944
+ ```ts
3945
+ queryable<T, TConfig>(
3946
+ query,
3947
+ payloads?,
3948
+ queryConfig?): Promise<boolean>;
3949
+ ```
3950
+
3951
+ ### Type Parameters
3952
+
3953
+ #### T
3954
+
3955
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
3956
+
3957
+ #### TConfig
3958
+
3959
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
3960
+
3961
+ ### Parameters
3962
+
3963
+ #### query
3964
+
3965
+ `T`
3966
+
3967
+ #### payloads?
3968
+
3969
+ `Payload`[]
3970
+
3971
+ #### queryConfig?
3972
+
3973
+ `TConfig`
3974
+
3975
+ ### Returns
3976
+
3977
+ `Promise`\<`boolean`\>
3978
+
3979
+ ### Inherited from
3980
+
3981
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`queryable`](BoundWitnessStatsDiviner.md#queryable)
3982
+
3983
+ ***
3984
+
3985
+ ### \_checkDead()
3986
+
3987
+ ```ts
3988
+ protected _checkDead(): void;
3989
+ ```
3990
+
3991
+ ### Returns
3992
+
3993
+ `void`
3994
+
3995
+ ### Inherited from
3996
+
3997
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`_checkDead`](BoundWitnessStatsDiviner.md#_checkdead)
3998
+
3999
+ ***
4000
+
4001
+ ### archivistInstance()
4002
+
4003
+ ### Call Signature
4004
+
4005
+ ```ts
4006
+ protected archivistInstance(): Promise<
4007
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
4008
+ | undefined>;
4009
+ ```
4010
+
4011
+ #### Returns
4012
+
4013
+ `Promise`\<
4014
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
4015
+ \| `undefined`\>
4016
+
4017
+ #### Inherited from
4018
+
4019
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`archivistInstance`](BoundWitnessStatsDiviner.md#archivistinstance)
4020
+
4021
+ ### Call Signature
4022
+
4023
+ ```ts
4024
+ protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
4025
+ ```
4026
+
4027
+ #### Parameters
4028
+
4029
+ ##### required
4030
+
4031
+ `true`
4032
+
4033
+ #### Returns
4034
+
4035
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
4036
+
4037
+ #### Inherited from
4038
+
4039
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`archivistInstance`](BoundWitnessStatsDiviner.md#archivistinstance)
4040
+
4041
+ ***
4042
+
4043
+ ### bindHashes()
4044
+
4045
+ ```ts
4046
+ protected bindHashes(
4047
+ hashes,
4048
+ schema,
4049
+ account?): PromiseEx<unknown, AccountInstance>;
4050
+ ```
4051
+
4052
+ ### Parameters
4053
+
4054
+ #### hashes
4055
+
4056
+ `BrandedHash`[]
4057
+
4058
+ #### schema
4059
+
4060
+ `Schema`[]
4061
+
4062
+ #### account?
4063
+
4064
+ `AccountInstance`
4065
+
4066
+ ### Returns
4067
+
4068
+ `PromiseEx`\<`unknown`, `AccountInstance`\>
4069
+
4070
+ ### Inherited from
4071
+
4072
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`bindHashes`](BoundWitnessStatsDiviner.md#bindhashes)
4073
+
4074
+ ***
4075
+
4076
+ ### bindHashesInternal()
4077
+
4078
+ ```ts
4079
+ protected bindHashesInternal(
4080
+ hashes,
4081
+ schema,
4082
+ account?): Promise<{
4083
+ schema: "network.xyo.boundwitness" & object;
4084
+ addresses: Lowercase<string> & object & object[];
4085
+ payload_hashes: BrandedHash[];
4086
+ payload_schemas: BrandedSchema<string>[];
4087
+ previous_hashes: (BrandedHash | null)[];
4088
+ $destination?: Lowercase<string> & object & object;
4089
+ $sourceQuery?: BrandedHash;
4090
+ $signatures: (BrandedHex | null)[];
4091
+ }>;
4092
+ ```
4093
+
4094
+ ### Parameters
4095
+
4096
+ #### hashes
4097
+
4098
+ `BrandedHash`[]
4099
+
4100
+ #### schema
4101
+
4102
+ `Schema`[]
4103
+
4104
+ #### account?
4105
+
4106
+ `AccountInstance`
4107
+
4108
+ ### Returns
4109
+
4110
+ `Promise`\<\{
4111
+ `schema`: `"network.xyo.boundwitness"` & `object`;
4112
+ `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
4113
+ `payload_hashes`: `BrandedHash`[];
4114
+ `payload_schemas`: `BrandedSchema`\<`string`\>[];
4115
+ `previous_hashes`: (`BrandedHash` \| `null`)[];
4116
+ `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
4117
+ `$sourceQuery?`: `BrandedHash`;
4118
+ `$signatures`: (`BrandedHex` \| `null`)[];
4119
+ \}\>
4120
+
4121
+ ### Inherited from
4122
+
4123
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`bindHashesInternal`](BoundWitnessStatsDiviner.md#bindhashesinternal)
4124
+
4125
+ ***
4126
+
4127
+ ### bindQuery()
4128
+
4129
+ ```ts
4130
+ protected bindQuery<T>(
4131
+ query,
4132
+ payloads?,
4133
+ account?,
4134
+ additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;
4135
+ ```
4136
+
4137
+ ### Type Parameters
4138
+
4139
+ #### T
4140
+
4141
+ `T` *extends* `Query`
4142
+
4143
+ ### Parameters
4144
+
4145
+ #### query
4146
+
4147
+ `T`
4148
+
4149
+ #### payloads?
4150
+
4151
+ `Payload`[]
4152
+
4153
+ #### account?
4154
+
4155
+ `AccountInstance`
4156
+
4157
+ #### additionalSigners?
4158
+
4159
+ `AccountInstance`[]
4160
+
4161
+ ### Returns
4162
+
4163
+ `PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\], `AccountInstance`\>
4164
+
4165
+ ### Inherited from
4166
+
4167
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`bindQuery`](BoundWitnessStatsDiviner.md#bindquery)
4168
+
4169
+ ***
4170
+
4171
+ ### bindQueryInternal()
4172
+
4173
+ ```ts
4174
+ protected bindQueryInternal<T>(
4175
+ query,
4176
+ payloads?,
4177
+ account?,
4178
+ additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;
4179
+ ```
4180
+
4181
+ ### Type Parameters
4182
+
4183
+ #### T
4184
+
4185
+ `T` *extends* `Query`
4186
+
4187
+ ### Parameters
4188
+
4189
+ #### query
4190
+
4191
+ `T`
4192
+
4193
+ #### payloads?
4194
+
4195
+ `Payload`[]
4196
+
4197
+ #### account?
4198
+
4199
+ `AccountInstance`
4200
+
4201
+ #### additionalSigners?
4202
+
4203
+ `AccountInstance`[]
4204
+
4205
+ ### Returns
4206
+
4207
+ `Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\]\>
4208
+
4209
+ ### Inherited from
4210
+
4211
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`bindQueryInternal`](BoundWitnessStatsDiviner.md#bindqueryinternal)
4212
+
4213
+ ***
4214
+
4215
+ ### bindQueryResult()
4216
+
4217
+ ```ts
4218
+ protected bindQueryResult<T>(
4219
+ query,
4220
+ payloads,
4221
+ additionalWitnesses?,
4222
+ errors?): Promise<ModuleQueryResult>;
4223
+ ```
4224
+
4225
+ ### Type Parameters
4226
+
4227
+ #### T
4228
+
4229
+ `T` *extends* `Query`
4230
+
4231
+ ### Parameters
4232
+
4233
+ #### query
4234
+
4235
+ `T`
4236
+
4237
+ #### payloads
4238
+
4239
+ `Payload`[]
4240
+
4241
+ #### additionalWitnesses?
4242
+
4243
+ `AccountInstance`[]
4244
+
4245
+ #### errors?
4246
+
4247
+ `ModuleError`[]
4248
+
4249
+ ### Returns
4250
+
4251
+ `Promise`\<`ModuleQueryResult`\>
4252
+
4253
+ ### Inherited from
4254
+
4255
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`bindQueryResult`](BoundWitnessStatsDiviner.md#bindqueryresult)
4256
+
4257
+ ***
4258
+
4259
+ ### generateConfigAndAddress()
4260
+
4261
+ ```ts
4262
+ protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
4263
+ ```
4264
+
4265
+ ### Parameters
4266
+
4267
+ #### \_maxDepth?
4268
+
4269
+ `number`
4270
+
4271
+ ### Returns
4272
+
4273
+ `Promisable`\<`Payload`[]\>
4274
+
4275
+ ### Inherited from
4276
+
4277
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`generateConfigAndAddress`](BoundWitnessStatsDiviner.md#generateconfigandaddress)
4278
+
4279
+ ***
4280
+
4281
+ ### generateDescribe()
4282
+
4283
+ ```ts
4284
+ protected generateDescribe(): Promise<ModuleDescriptionPayload>;
4285
+ ```
4286
+
4287
+ ### Returns
4288
+
4289
+ `Promise`\<`ModuleDescriptionPayload`\>
4290
+
4291
+ ### Inherited from
4292
+
4293
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`generateDescribe`](BoundWitnessStatsDiviner.md#generatedescribe)
4294
+
4295
+ ***
4296
+
4297
+ ### ~~getArchivist()~~
4298
+
4299
+ ```ts
4300
+ protected getArchivist(): Promise<
4301
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
4302
+ | undefined>;
4303
+ ```
4304
+
4305
+ ### Returns
4306
+
4307
+ `Promise`\<
4308
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
4309
+ \| `undefined`\>
4310
+
4311
+ ### Deprecated
4312
+
4313
+ use archivistInstance() instead
4314
+
4315
+ ### Inherited from
4316
+
4317
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`getArchivist`](BoundWitnessStatsDiviner.md#getarchivist)
4318
+
4319
+ ***
4320
+
4321
+ ### isAllowedArchivingQuery()
4322
+
4323
+ ```ts
4324
+ protected isAllowedArchivingQuery(schema): boolean;
4325
+ ```
4326
+
4327
+ ### Parameters
4328
+
4329
+ #### schema
4330
+
4331
+ `Schema`
4332
+
4333
+ ### Returns
4334
+
4335
+ `boolean`
4336
+
4337
+ ### Inherited from
4338
+
4339
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`isAllowedArchivingQuery`](BoundWitnessStatsDiviner.md#isallowedarchivingquery)
4340
+
4341
+ ***
4342
+
4343
+ ### moduleAddressHandler()
4344
+
4345
+ ```ts
4346
+ protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
4347
+ ```
4348
+
4349
+ ### Returns
4350
+
4351
+ `Promisable`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
4352
+
4353
+ ### Inherited from
4354
+
4355
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`moduleAddressHandler`](BoundWitnessStatsDiviner.md#moduleaddresshandler)
4356
+
4357
+ ***
4358
+
4359
+ ### stateHandler()
4360
+
4361
+ ```ts
4362
+ protected stateHandler(): Promise<Payload[]>;
4363
+ ```
4364
+
4365
+ ### Returns
4366
+
4367
+ `Promise`\<`Payload`[]\>
4368
+
4369
+ ### Inherited from
4370
+
4371
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`stateHandler`](BoundWitnessStatsDiviner.md#statehandler)
4372
+
4373
+ ***
4374
+
4375
+ ### subscribeHandler()
4376
+
4377
+ ```ts
4378
+ protected subscribeHandler(): void;
4379
+ ```
4380
+
4381
+ ### Returns
4382
+
4383
+ `void`
4384
+
4385
+ ### Inherited from
4386
+
4387
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`subscribeHandler`](BoundWitnessStatsDiviner.md#subscribehandler)
4388
+
4389
+ ***
4390
+
4391
+ ### validateConfig()
4392
+
4393
+ ```ts
4394
+ protected validateConfig(config?, parents?): boolean;
4395
+ ```
4396
+
4397
+ ### Parameters
4398
+
4399
+ #### config?
4400
+
4401
+ `unknown`
4402
+
4403
+ #### parents?
4404
+
4405
+ `string`[]
4406
+
4407
+ ### Returns
4408
+
4409
+ `boolean`
4410
+
4411
+ ### Inherited from
4412
+
4413
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`validateConfig`](BoundWitnessStatsDiviner.md#validateconfig)
4414
+
4415
+ ***
4416
+
4417
+ ### addParent()
4418
+
4419
+ ```ts
4420
+ addParent(mod): void;
4421
+ ```
4422
+
4423
+ ### Parameters
4424
+
4425
+ #### mod
4426
+
4427
+ `ModuleInstance`
4428
+
4429
+ ### Returns
4430
+
4431
+ `void`
4432
+
4433
+ ### Inherited from
4434
+
4435
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`addParent`](BoundWitnessStatsDiviner.md#addparent)
4436
+
4437
+ ***
4438
+
4439
+ ### certifyParents()
4440
+
4441
+ ```ts
4442
+ certifyParents(): Promise<Payload[]>;
4443
+ ```
4444
+
4445
+ ### Returns
4446
+
4447
+ `Promise`\<`Payload`[]\>
4448
+
4449
+ ### Inherited from
4450
+
4451
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`certifyParents`](BoundWitnessStatsDiviner.md#certifyparents)
4452
+
4453
+ ***
4454
+
4455
+ ### createHandler()
4456
+
4457
+ ```ts
4458
+ createHandler(): Promise<void>;
4459
+ ```
4460
+
4461
+ ### Returns
4462
+
4463
+ `Promise`\<`void`\>
4464
+
4465
+ ### Inherited from
4466
+
4467
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`createHandler`](BoundWitnessStatsDiviner.md#createhandler-1)
4468
+
4469
+ ***
4470
+
4471
+ ### manifest()
4472
+
4473
+ ```ts
4474
+ manifest(maxDepth?): Promise<ModuleManifestPayload>;
4475
+ ```
4476
+
4477
+ ### Parameters
4478
+
4479
+ #### maxDepth?
4480
+
4481
+ `number`
4482
+
4483
+ ### Returns
4484
+
4485
+ `Promise`\<`ModuleManifestPayload`\>
4486
+
4487
+ ### Inherited from
4488
+
4489
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`manifest`](BoundWitnessStatsDiviner.md#manifest)
4490
+
4491
+ ***
4492
+
4493
+ ### manifestQuery()
4494
+
4495
+ ```ts
4496
+ manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
4497
+ ```
4498
+
4499
+ ### Parameters
4500
+
4501
+ #### account
4502
+
4503
+ `AccountInstance`
4504
+
4505
+ #### maxDepth?
4506
+
4507
+ `number`
4508
+
4509
+ ### Returns
4510
+
4511
+ `Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
4512
+
4513
+ ### Inherited from
4514
+
4515
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`manifestQuery`](BoundWitnessStatsDiviner.md#manifestquery)
4516
+
4517
+ ***
4518
+
4519
+ ### moduleAddress()
4520
+
4521
+ ```ts
4522
+ moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
4523
+ ```
4524
+
4525
+ ### Returns
4526
+
4527
+ `Promise`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
4528
+
4529
+ ### Inherited from
4530
+
4531
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`moduleAddress`](BoundWitnessStatsDiviner.md#moduleaddress)
4532
+
4533
+ ***
4534
+
4535
+ ### parents()
4536
+
4537
+ ```ts
4538
+ parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
4539
+ ```
4540
+
4541
+ ### Returns
4542
+
4543
+ `Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
4544
+
4545
+ ### Inherited from
4546
+
4547
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`parents`](BoundWitnessStatsDiviner.md#parents)
4548
+
4549
+ ***
4550
+
4551
+ ### privateChildren()
4552
+
4553
+ ```ts
4554
+ privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
4555
+ ```
4556
+
4557
+ ### Returns
4558
+
4559
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
4560
+
4561
+ ### Inherited from
4562
+
4563
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`privateChildren`](BoundWitnessStatsDiviner.md#privatechildren)
4564
+
4565
+ ***
4566
+
4567
+ ### publicChildren()
4568
+
4569
+ ```ts
4570
+ publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
4571
+ ```
4572
+
4573
+ ### Returns
4574
+
4575
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
4576
+
4577
+ ### Inherited from
4578
+
4579
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`publicChildren`](BoundWitnessStatsDiviner.md#publicchildren)
4580
+
4581
+ ***
4582
+
4583
+ ### removeParent()
4584
+
4585
+ ```ts
4586
+ removeParent(address): void;
4587
+ ```
4588
+
4589
+ ### Parameters
4590
+
4591
+ #### address
4592
+
4593
+ `BrandedAddress`
4594
+
4595
+ ### Returns
4596
+
4597
+ `void`
4598
+
4599
+ ### Inherited from
4600
+
4601
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`removeParent`](BoundWitnessStatsDiviner.md#removeparent)
4602
+
4603
+ ***
4604
+
4605
+ ### resolve()
4606
+
4607
+ ### Call Signature
4608
+
4609
+ ```ts
4610
+ resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
4611
+ ```
4612
+
4613
+ #### Returns
4614
+
4615
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
4616
+
4617
+ #### Inherited from
4618
+
4619
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolve`](BoundWitnessStatsDiviner.md#resolve)
4620
+
4621
+ ### Call Signature
4622
+
4623
+ ```ts
4624
+ resolve<T>(all, options?): Promise<T[]>;
4625
+ ```
4626
+
4627
+ #### Type Parameters
4628
+
4629
+ ##### T
4630
+
4631
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
4632
+
4633
+ #### Parameters
4634
+
4635
+ ##### all
4636
+
4637
+ `"*"`
4638
+
4639
+ ##### options?
4640
+
4641
+ `ModuleFilterOptions`\<`T`\>
4642
+
4643
+ #### Returns
4644
+
4645
+ `Promise`\<`T`[]\>
4646
+
4647
+ #### Inherited from
4648
+
4649
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolve`](BoundWitnessStatsDiviner.md#resolve)
4650
+
4651
+ ### Call Signature
4652
+
4653
+ ```ts
4654
+ resolve<T>(id, options?): Promise<T | undefined>;
4655
+ ```
4656
+
4657
+ #### Type Parameters
4658
+
4659
+ ##### T
4660
+
4661
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
4662
+
4663
+ #### Parameters
4664
+
4665
+ ##### id
4666
+
4667
+ `ModuleIdentifier`
4668
+
4669
+ ##### options?
4670
+
4671
+ `ModuleFilterOptions`\<`T`\>
4672
+
4673
+ #### Returns
4674
+
4675
+ `Promise`\<`T` \| `undefined`\>
4676
+
4677
+ #### Inherited from
4678
+
4679
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolve`](BoundWitnessStatsDiviner.md#resolve)
4680
+
4681
+ ***
4682
+
4683
+ ### resolveIdentifier()
4684
+
4685
+ ```ts
4686
+ resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
4687
+ ```
4688
+
4689
+ ### Parameters
4690
+
4691
+ #### id
4692
+
4693
+ `ModuleIdentifier`
4694
+
4695
+ #### options?
4696
+
4697
+ `ObjectFilterOptions`\<`AnyObject`\>
4698
+
4699
+ ### Returns
4700
+
4701
+ `Promise`\<`BrandedAddress` \| `undefined`\>
4702
+
4703
+ ### Inherited from
4704
+
4705
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolveIdentifier`](BoundWitnessStatsDiviner.md#resolveidentifier)
4706
+
4707
+ ***
4708
+
4709
+ ### resolvePrivate()
4710
+
4711
+ ### Call Signature
4712
+
4713
+ ```ts
4714
+ resolvePrivate<T>(all, options?): Promise<T[]>;
4715
+ ```
4716
+
4717
+ #### Type Parameters
4718
+
4719
+ ##### T
4720
+
4721
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
4722
+
4723
+ #### Parameters
4724
+
4725
+ ##### all
4726
+
4727
+ `"*"`
4728
+
4729
+ ##### options?
4730
+
4731
+ `ModuleFilterOptions`\<`T`\>
4732
+
4733
+ #### Returns
4734
+
4735
+ `Promise`\<`T`[]\>
4736
+
4737
+ #### Inherited from
4738
+
4739
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolvePrivate`](BoundWitnessStatsDiviner.md#resolveprivate)
4740
+
4741
+ ### Call Signature
4742
+
4743
+ ```ts
4744
+ resolvePrivate<T>(id, options?): Promise<T | undefined>;
4745
+ ```
4746
+
4747
+ #### Type Parameters
4748
+
4749
+ ##### T
4750
+
4751
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
4752
+
4753
+ #### Parameters
4754
+
4755
+ ##### id
4756
+
4757
+ `ModuleIdentifier`
4758
+
4759
+ ##### options?
4760
+
4761
+ `ModuleFilterOptions`\<`T`\>
4762
+
4763
+ #### Returns
4764
+
4765
+ `Promise`\<`T` \| `undefined`\>
4766
+
4767
+ #### Inherited from
4768
+
4769
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolvePrivate`](BoundWitnessStatsDiviner.md#resolveprivate)
4770
+
4771
+ ***
4772
+
4773
+ ### siblings()
4774
+
4775
+ ```ts
4776
+ siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
4777
+ ```
4778
+
4779
+ ### Returns
4780
+
4781
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
4782
+
4783
+ ### Inherited from
4784
+
4785
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`siblings`](BoundWitnessStatsDiviner.md#siblings)
4786
+
4787
+ ***
4788
+
4789
+ ### state()
4790
+
4791
+ ```ts
4792
+ state(): Promise<Payload[]>;
4793
+ ```
4794
+
4795
+ ### Returns
4796
+
4797
+ `Promise`\<`Payload`[]\>
4798
+
4799
+ ### Inherited from
4800
+
4801
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`state`](BoundWitnessStatsDiviner.md#state)
4802
+
4803
+ ***
4804
+
4805
+ ### stateQuery()
4806
+
4807
+ ```ts
4808
+ stateQuery(account): Promise<ModuleQueryResult>;
4809
+ ```
4810
+
4811
+ ### Parameters
4812
+
4813
+ #### account
4814
+
4815
+ `AccountInstance`
4816
+
4817
+ ### Returns
4818
+
4819
+ `Promise`\<`ModuleQueryResult`\>
4820
+
4821
+ ### Inherited from
4822
+
4823
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`stateQuery`](BoundWitnessStatsDiviner.md#statequery)
4824
+
4825
+ ***
4826
+
4827
+ ### subscribe()
4828
+
4829
+ ```ts
4830
+ subscribe(_queryAccount?): void;
4831
+ ```
4832
+
4833
+ ### Parameters
4834
+
4835
+ #### \_queryAccount?
4836
+
4837
+ `AccountInstance`
4838
+
4839
+ ### Returns
4840
+
4841
+ `void`
4842
+
4843
+ ### Inherited from
4844
+
4845
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`subscribe`](BoundWitnessStatsDiviner.md#subscribe)
4846
+
4847
+ ***
4848
+
4849
+ ### manifestHandler()
4850
+
4851
+ ```ts
4852
+ protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
4853
+ ```
4854
+
4855
+ ### Parameters
4856
+
4857
+ #### maxDepth?
4858
+
4859
+ `number`
4860
+
4861
+ #### \_ignoreAddresses?
4862
+
4863
+ `BrandedAddress`[]
4864
+
4865
+ ### Returns
4866
+
4867
+ `Promise`\<`ModuleManifestPayload`\>
4868
+
4869
+ ### Inherited from
4870
+
4871
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`manifestHandler`](BoundWitnessStatsDiviner.md#manifesthandler)
4872
+
4873
+ ***
4874
+
4875
+ ### resolveArchivingArchivists()
4876
+
4877
+ ```ts
4878
+ protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
4879
+ ```
4880
+
4881
+ ### Returns
4882
+
4883
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
4884
+
4885
+ ### Inherited from
4886
+
4887
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`resolveArchivingArchivists`](BoundWitnessStatsDiviner.md#resolvearchivingarchivists)
4888
+
4889
+ ***
4890
+
4891
+ ### sendQuery()
4892
+
4893
+ ```ts
4894
+ protected sendQuery<T, P, R>(
4895
+ queryPayload,
4896
+ payloads?,
4897
+ account?): Promise<R[]>;
4898
+ ```
4899
+
4900
+ ### Type Parameters
4901
+
4902
+ #### T
4903
+
4904
+ `T` *extends* `Query`
4905
+
4906
+ #### P
4907
+
4908
+ `P` *extends* `Payload` = `Payload`
4909
+
4910
+ #### R
4911
+
4912
+ `R` *extends* `Payload` = `Payload`
4913
+
4914
+ ### Parameters
4915
+
4916
+ #### queryPayload
4917
+
4918
+ `T`
4919
+
4920
+ #### payloads?
4921
+
4922
+ `P`[]
4923
+
4924
+ #### account?
4925
+
4926
+ `AccountInstance`
4927
+
4928
+ ### Returns
4929
+
4930
+ `Promise`\<`R`[]\>
4931
+
4932
+ ### Inherited from
4933
+
4934
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`sendQuery`](BoundWitnessStatsDiviner.md#sendquery)
4935
+
4936
+ ***
4937
+
4938
+ ### sendQueryRaw()
4939
+
4940
+ ```ts
4941
+ protected sendQueryRaw<T, P, R>(
4942
+ queryPayload,
4943
+ payloads?,
4944
+ account?): Promise<ModuleQueryResult<R>>;
4945
+ ```
4946
+
4947
+ ### Type Parameters
4948
+
4949
+ #### T
4950
+
4951
+ `T` *extends* `Query`
4952
+
4953
+ #### P
4954
+
4955
+ `P` *extends* `Payload` = `Payload`
4956
+
4957
+ #### R
4958
+
4959
+ `R` *extends* `Payload` = `Payload`
4960
+
4961
+ ### Parameters
4962
+
4963
+ #### queryPayload
4964
+
4965
+ `T`
4966
+
4967
+ #### payloads?
4968
+
4969
+ `P`[]
4970
+
4971
+ #### account?
4972
+
4973
+ `AccountInstance`
4974
+
4975
+ ### Returns
4976
+
4977
+ `Promise`\<`ModuleQueryResult`\<`R`\>\>
4978
+
4979
+ ### Inherited from
4980
+
4981
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`sendQueryRaw`](BoundWitnessStatsDiviner.md#sendqueryraw)
4982
+
4983
+ ***
4984
+
4985
+ ### storeToArchivists()
4986
+
4987
+ ```ts
4988
+ protected storeToArchivists(payloads): Promise<Payload[]>;
4989
+ ```
4990
+
4991
+ ### Parameters
4992
+
4993
+ #### payloads
4994
+
4995
+ `Payload`[]
4996
+
4997
+ ### Returns
4998
+
4999
+ `Promise`\<`Payload`[]\>
5000
+
5001
+ ### Inherited from
5002
+
5003
+ [`BoundWitnessStatsDiviner`](#BoundWitnessStatsDiviner).[`storeToArchivists`](BoundWitnessStatsDiviner.md#storetoarchivists)
5004
+
5005
+ ### type-aliases
5006
+
5007
+ ### <a id="BoundWitnessStatsDivinerConfig"></a>BoundWitnessStatsDivinerConfig
5008
+
5009
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5010
+
5011
+ ***
5012
+
5013
+ ```ts
5014
+ type BoundWitnessStatsDivinerConfig<T> = DivinerConfig<T & object>;
5015
+ ```
5016
+
5017
+ ## Type Parameters
5018
+
5019
+ ### T
5020
+
5021
+ `T` *extends* `Payload` = `Payload`
5022
+
5023
+ ### <a id="BoundWitnessStatsDivinerConfigSchema"></a>BoundWitnessStatsDivinerConfigSchema
5024
+
5025
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5026
+
5027
+ ***
5028
+
5029
+ ```ts
5030
+ type BoundWitnessStatsDivinerConfigSchema = typeof BoundWitnessStatsDivinerConfigSchema;
5031
+ ```
5032
+
5033
+ ### <a id="BoundWitnessStatsDivinerParams"></a>BoundWitnessStatsDivinerParams
5034
+
5035
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5036
+
5037
+ ***
5038
+
5039
+ ```ts
5040
+ type BoundWitnessStatsDivinerParams = DivinerParams<AnyConfigSchema<BoundWitnessStatsDivinerConfig>>;
5041
+ ```
5042
+
5043
+ ### <a id="BoundWitnessStatsDivinerSchema"></a>BoundWitnessStatsDivinerSchema
5044
+
5045
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5046
+
5047
+ ***
5048
+
5049
+ ```ts
5050
+ type BoundWitnessStatsDivinerSchema = typeof BoundWitnessStatsDivinerSchema;
5051
+ ```
5052
+
5053
+ ### <a id="BoundWitnessStatsPayload"></a>BoundWitnessStatsPayload
5054
+
5055
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5056
+
5057
+ ***
5058
+
5059
+ ```ts
5060
+ type BoundWitnessStatsPayload = Payload<{
5061
+ count: number;
5062
+ schema: BoundWitnessStatsDivinerSchema;
5063
+ }>;
5064
+ ```
5065
+
5066
+ ### <a id="BoundWitnessStatsQueryPayload"></a>BoundWitnessStatsQueryPayload
5067
+
5068
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5069
+
5070
+ ***
5071
+
5072
+ ```ts
5073
+ type BoundWitnessStatsQueryPayload = Query<{
5074
+ schema: BoundWitnessStatsQuerySchema;
5075
+ }>;
5076
+ ```
5077
+
5078
+ ### <a id="BoundWitnessStatsQuerySchema"></a>BoundWitnessStatsQuerySchema
5079
+
5080
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5081
+
5082
+ ***
5083
+
5084
+ ```ts
5085
+ type BoundWitnessStatsQuerySchema = typeof BoundWitnessStatsQuerySchema;
5086
+ ```
5087
+
5088
+ ### variables
5089
+
5090
+ ### <a id="BoundWitnessStatsDivinerConfigSchema"></a>BoundWitnessStatsDivinerConfigSchema
5091
+
5092
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5093
+
5094
+ ***
5095
+
5096
+ ```ts
5097
+ const BoundWitnessStatsDivinerConfigSchema: string & object;
5098
+ ```
5099
+
5100
+ ## Type Declaration
5101
+
5102
+ ### \_\_schema
5103
+
5104
+ ```ts
5105
+ readonly __schema: true;
5106
+ ```
5107
+
5108
+ ### <a id="BoundWitnessStatsDivinerSchema"></a>BoundWitnessStatsDivinerSchema
5109
+
5110
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5111
+
5112
+ ***
5113
+
5114
+ ```ts
5115
+ const BoundWitnessStatsDivinerSchema: "network.xyo.diviner.boundwitness.stats" & object;
5116
+ ```
5117
+
5118
+ ## Type Declaration
5119
+
5120
+ ### \_\_schema
5121
+
5122
+ ```ts
5123
+ readonly __schema: true;
5124
+ ```
5125
+
5126
+ ### <a id="BoundWitnessStatsQuerySchema"></a>BoundWitnessStatsQuerySchema
5127
+
5128
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5129
+
5130
+ ***
5131
+
5132
+ ```ts
5133
+ const BoundWitnessStatsQuerySchema: string & object;
5134
+ ```
5135
+
5136
+ ## Type Declaration
5137
+
5138
+ ### \_\_schema
5139
+
5140
+ ```ts
5141
+ readonly __schema: true;
5142
+ ```
5143
+
5144
+ ### <a id="isBoundWitnessStatsPayload"></a>isBoundWitnessStatsPayload
5145
+
5146
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5147
+
5148
+ ***
5149
+
5150
+ ```ts
5151
+ const isBoundWitnessStatsPayload: (x?) => x is BoundWitnessStatsPayload;
5152
+ ```
5153
+
5154
+ ## Parameters
5155
+
5156
+ ### x?
5157
+
5158
+ `Payload` \| `null`
5159
+
5160
+ ## Returns
5161
+
5162
+ `x is BoundWitnessStatsPayload`
5163
+
5164
+ ### <a id="isBoundWitnessStatsQueryPayload"></a>isBoundWitnessStatsQueryPayload
5165
+
5166
+ [**@xyo-network/diviner-boundwitness-stats**](#../README)
5167
+
5168
+ ***
5169
+
5170
+ ```ts
5171
+ const isBoundWitnessStatsQueryPayload: (x?) => x is BoundWitnessStatsQueryPayload;
5172
+ ```
5173
+
5174
+ ## Parameters
5175
+
5176
+ ### x?
5177
+
5178
+ `Payload` \| `null`
5179
+
5180
+ ## Returns
18
5181
 
19
- ## Credits
5182
+ `x is BoundWitnessStatsQueryPayload`
20
5183
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
5184
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
5185
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
5186
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-boundwitness-stats.svg
5187
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-boundwitness-stats
5188
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-boundwitness-stats.svg
5189
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE