@xyo-network/diviner-schema-stats-memory 5.3.24 → 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 +2646 -10
  2. package/package.json +17 -17
package/README.md CHANGED
@@ -1,23 +1,2659 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/diviner-schema-stats-memory
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-schema-stats-memory)
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
+ ### schemastats
54
+
55
+ ### packages
56
+
57
+ ### memory
58
+
59
+ ### .temp-typedoc
60
+
61
+ ### classes
62
+
63
+ ### <a id="MemorySchemaStatsDiviner"></a>MemorySchemaStatsDiviner
64
+
65
+ [**@xyo-network/diviner-schema-stats-memory**](#../README)
66
+
67
+ ***
68
+
69
+ ## Extends
70
+
71
+ - `SchemaStatsDiviner`\<`TParams`\>
72
+
73
+ ## Type Parameters
74
+
75
+ ### TParams
76
+
77
+ `TParams` *extends* `SchemaStatsDivinerParams` = `SchemaStatsDivinerParams`
78
+
79
+ ## Constructors
80
+
81
+ ### Constructor
82
+
83
+ ```ts
84
+ new MemorySchemaStatsDiviner<TParams>(key, params): MemorySchemaStatsDiviner<TParams>;
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ #### key
90
+
91
+ `unknown`
92
+
93
+ #### params
94
+
95
+ `Partial`\<`TParams` & `RequiredCreatableParams`\>
96
+
97
+ ### Returns
98
+
99
+ `MemorySchemaStatsDiviner`\<`TParams`\>
100
+
101
+ ### Inherited from
102
+
103
+ ```ts
104
+ SchemaStatsDiviner<TParams>.constructor
105
+ ```
106
+
107
+ ## Properties
108
+
109
+ ### targetSchema
110
+
111
+ ```ts
112
+ readonly static targetSchema: Schema;
113
+ ```
114
+
115
+ ### Inherited from
116
+
117
+ ```ts
118
+ SchemaStatsDiviner.targetSchema
119
+ ```
120
+
121
+ ***
122
+
123
+ ### uniqueName
124
+
125
+ ```ts
126
+ readonly static uniqueName: string;
127
+ ```
128
+
129
+ ### Inherited from
130
+
131
+ ```ts
132
+ SchemaStatsDiviner.uniqueName
133
+ ```
134
+
135
+ ***
136
+
137
+ ### configSchemas
138
+
139
+ ```ts
140
+ readonly static configSchemas: Schema[];
141
+ ```
142
+
143
+ ### Overrides
144
+
145
+ ```ts
146
+ SchemaStatsDiviner.configSchemas
147
+ ```
148
+
149
+ ***
150
+
151
+ ### defaultConfigSchema
152
+
153
+ ```ts
154
+ readonly static defaultConfigSchema: Schema = SchemaStatsDivinerConfigSchema;
155
+ ```
156
+
157
+ ### Overrides
158
+
159
+ ```ts
160
+ SchemaStatsDiviner.defaultConfigSchema
161
+ ```
162
+
163
+ ***
164
+
165
+ ### allowRandomAccount
166
+
167
+ ```ts
168
+ readonly static allowRandomAccount: boolean;
169
+ ```
170
+
171
+ ### Inherited from
172
+
173
+ ```ts
174
+ SchemaStatsDiviner.allowRandomAccount
175
+ ```
176
+
177
+ ***
178
+
179
+ ### defaultLogger
180
+
181
+ ```ts
182
+ static defaultLogger: Logger;
183
+ ```
184
+
185
+ ### Inherited from
186
+
187
+ ```ts
188
+ SchemaStatsDiviner.defaultLogger
189
+ ```
190
+
191
+ ***
192
+
193
+ ### enableLazyLoad
194
+
195
+ ```ts
196
+ static enableLazyLoad: boolean;
197
+ ```
198
+
199
+ ### Inherited from
200
+
201
+ ```ts
202
+ SchemaStatsDiviner.enableLazyLoad
203
+ ```
204
+
205
+ ***
206
+
207
+ ### labels
208
+
209
+ ```ts
210
+ readonly static labels: Labels;
211
+ ```
212
+
213
+ ### Inherited from
214
+
215
+ ```ts
216
+ SchemaStatsDiviner.labels
217
+ ```
218
+
219
+ ***
220
+
221
+ ### privateConstructorKey
222
+
223
+ ```ts
224
+ protected static privateConstructorKey: string;
225
+ ```
226
+
227
+ ### Inherited from
228
+
229
+ ```ts
230
+ SchemaStatsDiviner.privateConstructorKey
231
+ ```
232
+
233
+ ***
234
+
235
+ ### \_account
236
+
237
+ ```ts
238
+ protected _account: AccountInstance | undefined;
239
+ ```
240
+
241
+ ### Inherited from
242
+
243
+ ```ts
244
+ SchemaStatsDiviner._account
245
+ ```
246
+
247
+ ***
248
+
249
+ ### \_cachedManifests
250
+
251
+ ```ts
252
+ protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
253
+ ```
254
+
255
+ ### Inherited from
256
+
257
+ ```ts
258
+ SchemaStatsDiviner._cachedManifests
259
+ ```
260
+
261
+ ***
262
+
263
+ ### \_globalReentrancyMutex
264
+
265
+ ```ts
266
+ protected _globalReentrancyMutex: Mutex | undefined;
267
+ ```
268
+
269
+ ### Inherited from
270
+
271
+ ```ts
272
+ SchemaStatsDiviner._globalReentrancyMutex
273
+ ```
274
+
275
+ ***
276
+
277
+ ### \_lastError?
278
+
279
+ ```ts
280
+ protected optional _lastError?: ModuleDetailsError;
281
+ ```
282
+
283
+ ### Inherited from
284
+
285
+ ```ts
286
+ SchemaStatsDiviner._lastError
287
+ ```
288
+
289
+ ***
290
+
291
+ ### \_moduleConfigQueryValidator
292
+
293
+ ```ts
294
+ protected _moduleConfigQueryValidator: Queryable | undefined;
295
+ ```
296
+
297
+ ### Inherited from
298
+
299
+ ```ts
300
+ SchemaStatsDiviner._moduleConfigQueryValidator
301
+ ```
302
+
303
+ ***
304
+
305
+ ### \_supportedQueryValidator
306
+
307
+ ```ts
308
+ protected _supportedQueryValidator: Queryable | undefined;
309
+ ```
310
+
311
+ ### Inherited from
312
+
313
+ ```ts
314
+ SchemaStatsDiviner._supportedQueryValidator
315
+ ```
316
+
317
+ ***
318
+
319
+ ### useNewResolver
320
+
321
+ ```ts
322
+ readonly static useNewResolver: false = false;
323
+ ```
324
+
325
+ ### Inherited from
326
+
327
+ ```ts
328
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.upResolver
894
+ ```
895
+
896
+ ## Methods
897
+
898
+ ### divine()
899
+
900
+ ```ts
901
+ divine(payloads?, retryConfigIn?): Promise<DivinerDivineResult<Payload>[]>;
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
+ `Payload`[]
913
+
914
+ #### retryConfigIn?
915
+
916
+ `RetryConfigWithComplete`\<`unknown`\>
917
+
918
+ ### Returns
919
+
920
+ `Promise`\<`DivinerDivineResult`\<`Payload`\>[]\>
921
+
922
+ ### Inherited from
923
+
924
+ ```ts
925
+ SchemaStatsDiviner.divine
926
+ ```
927
+
928
+ ***
929
+
930
+ ### divineQuery()
931
+
932
+ ```ts
933
+ divineQuery(
934
+ payloads?,
935
+ account?,
936
+ _retry?): Promise<ModuleQueryResult<Payload>>;
937
+ ```
938
+
939
+ ### Parameters
940
+
941
+ #### payloads?
942
+
943
+ `Payload`[]
944
+
945
+ #### account?
946
+
947
+ `AccountInstance`
948
+
949
+ #### \_retry?
950
+
951
+ `RetryConfig`
952
+
953
+ ### Returns
954
+
955
+ `Promise`\<`ModuleQueryResult`\<`Payload`\>\>
956
+
957
+ ### Inherited from
958
+
959
+ ```ts
960
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.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
+ SchemaStatsDiviner.stopHandler
1046
+ ```
1047
+
1048
+ ***
1049
+
1050
+ ### divineAddress()
1051
+
1052
+ ```ts
1053
+ protected divineAddress(address): Promise<Record<string, number>>;
1054
+ ```
1055
+
1056
+ ### Parameters
1057
+
1058
+ #### address
1059
+
1060
+ `BrandedAddress`
1061
+
1062
+ ### Returns
1063
+
1064
+ `Promise`\<`Record`\<`string`, `number`\>\>
1065
+
1066
+ ***
1067
+
1068
+ ### divineAllAddresses()
1069
+
1070
+ ```ts
1071
+ protected divineAllAddresses(): Promise<Record<string, number>>;
1072
+ ```
1073
+
1074
+ ### Returns
1075
+
1076
+ `Promise`\<`Record`\<`string`, `number`\>\>
1077
+
1078
+ ***
1079
+
1080
+ ### divineHandler()
1081
+
1082
+ ```ts
1083
+ protected divineHandler(payloads?): Promise<Payload[]>;
1084
+ ```
1085
+
1086
+ **`Function`**
1087
+
1088
+ divineHandler Implement or override to add custom functionality to a diviner
1089
+
1090
+ ### Parameters
1091
+
1092
+ #### payloads?
1093
+
1094
+ `Payload`[]
1095
+
1096
+ ### Returns
1097
+
1098
+ `Promise`\<`Payload`[]\>
1099
+
1100
+ ### Overrides
1101
+
1102
+ ```ts
1103
+ SchemaStatsDiviner.divineHandler
1104
+ ```
1105
+
1106
+ ***
1107
+
1108
+ ### \_getRootFunction()
1109
+
1110
+ ```ts
1111
+ static _getRootFunction(funcName): any;
1112
+ ```
1113
+
1114
+ ### Parameters
1115
+
1116
+ #### funcName
1117
+
1118
+ `string`
1119
+
1120
+ ### Returns
1121
+
1122
+ `any`
1123
+
1124
+ ### Inherited from
1125
+
1126
+ ```ts
1127
+ SchemaStatsDiviner._getRootFunction
1128
+ ```
1129
+
1130
+ ***
1131
+
1132
+ ### \_noOverride()
1133
+
1134
+ ```ts
1135
+ static _noOverride(functionName): void;
1136
+ ```
1137
+
1138
+ ### Parameters
1139
+
1140
+ #### functionName
1141
+
1142
+ `string`
1143
+
1144
+ ### Returns
1145
+
1146
+ `void`
1147
+
1148
+ ### Inherited from
1149
+
1150
+ ```ts
1151
+ SchemaStatsDiviner._noOverride
1152
+ ```
1153
+
1154
+ ***
1155
+
1156
+ ### createHandler()
1157
+
1158
+ ```ts
1159
+ static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;
1160
+ ```
1161
+
1162
+ Static hook called during creation to perform additional initialization.
1163
+ Override in subclasses to customize post-construction setup.
1164
+
1165
+ ### Type Parameters
1166
+
1167
+ #### T
1168
+
1169
+ `T` *extends* `CreatableInstance`\<`CreatableParams`, `EventData`\>
1170
+
1171
+ ### Parameters
1172
+
1173
+ #### inInstance
1174
+
1175
+ `T`
1176
+
1177
+ ### Returns
1178
+
1179
+ `Promise`\<`T` & `AbstractModule`\<`any`, `any`\>\>
1180
+
1181
+ The instance, potentially modified
1182
+
1183
+ ### Inherited from
1184
+
1185
+ ```ts
1186
+ SchemaStatsDiviner.createHandler
1187
+ ```
1188
+
1189
+ ***
1190
+
1191
+ ### determineAccount()
1192
+
1193
+ ```ts
1194
+ static determineAccount(params): Promise<AccountInstance>;
1195
+ ```
1196
+
1197
+ ### Parameters
1198
+
1199
+ #### params
1200
+
1201
+ ##### account?
1202
+
1203
+ `AccountInstance` \| `"random"`
1204
+
1205
+ ##### accountPath?
1206
+
1207
+ `string`
1208
+
1209
+ ##### wallet?
1210
+
1211
+ `WalletInstance`
1212
+
1213
+ ### Returns
1214
+
1215
+ `Promise`\<`AccountInstance`\>
1216
+
1217
+ ### Inherited from
1218
+
1219
+ ```ts
1220
+ SchemaStatsDiviner.determineAccount
1221
+ ```
1222
+
1223
+ ***
1224
+
1225
+ ### factory()
1226
+
1227
+ ```ts
1228
+ static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;
1229
+ ```
1230
+
1231
+ ### Type Parameters
1232
+
1233
+ #### TModule
1234
+
1235
+ `TModule` *extends* `CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1236
+
1237
+ ### Parameters
1238
+
1239
+ #### this
1240
+
1241
+ `CreatableModule`\<`TModule`\>
1242
+
1243
+ #### params?
1244
+
1245
+ `Partial`\<`TModule`\[`"params"`\]\>
1246
+
1247
+ ### Returns
1248
+
1249
+ `CreatableModuleFactory`\<`TModule`\>
1250
+
1251
+ ### Inherited from
1252
+
1253
+ ```ts
1254
+ SchemaStatsDiviner.factory
1255
+ ```
1256
+
1257
+ ***
1258
+
1259
+ ### isAllowedSchema()
1260
+
1261
+ ```ts
1262
+ static isAllowedSchema(schema): boolean;
1263
+ ```
1264
+
1265
+ ### Parameters
1266
+
1267
+ #### schema
1268
+
1269
+ `Schema`
1270
+
1271
+ ### Returns
1272
+
1273
+ `boolean`
1274
+
1275
+ ### Inherited from
1276
+
1277
+ ```ts
1278
+ SchemaStatsDiviner.isAllowedSchema
1279
+ ```
1280
+
1281
+ ***
1282
+
1283
+ ### paramsHandler()
1284
+
1285
+ ```ts
1286
+ static paramsHandler<T>(inParams?): Promise<T["params"]>;
1287
+ ```
1288
+
1289
+ Static hook called during creation to validate and transform params.
1290
+ Override in subclasses to add default values or validation.
1291
+
1292
+ ### Type Parameters
1293
+
1294
+ #### T
1295
+
1296
+ `T` *extends* `AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1297
+
1298
+ ### Parameters
1299
+
1300
+ #### inParams?
1301
+
1302
+ `Partial`\<`T`\[`"params"`\]\>
1303
+
1304
+ ### Returns
1305
+
1306
+ `Promise`\<`T`\[`"params"`\]\>
1307
+
1308
+ The processed params ready for construction
1309
+
1310
+ ### Inherited from
1311
+
1312
+ ```ts
1313
+ SchemaStatsDiviner.paramsHandler
1314
+ ```
1315
+
1316
+ ***
1317
+
1318
+ ### \_getRootFunction()
1319
+
1320
+ ```ts
1321
+ _getRootFunction(funcName): any;
1322
+ ```
1323
+
1324
+ ### Parameters
1325
+
1326
+ #### funcName
1327
+
1328
+ `string`
1329
+
1330
+ ### Returns
1331
+
1332
+ `any`
1333
+
1334
+ ### Inherited from
1335
+
1336
+ ```ts
1337
+ SchemaStatsDiviner._getRootFunction
1338
+ ```
1339
+
1340
+ ***
1341
+
1342
+ ### busy()
1343
+
1344
+ ```ts
1345
+ busy<R>(closure): Promise<R>;
1346
+ ```
1347
+
1348
+ ### Type Parameters
1349
+
1350
+ #### R
1351
+
1352
+ `R`
1353
+
1354
+ ### Parameters
1355
+
1356
+ #### closure
1357
+
1358
+ () => `Promise`\<`R`\>
1359
+
1360
+ ### Returns
1361
+
1362
+ `Promise`\<`R`\>
1363
+
1364
+ ### Inherited from
1365
+
1366
+ ```ts
1367
+ SchemaStatsDiviner.busy
1368
+ ```
1369
+
1370
+ ***
1371
+
1372
+ ### emit()
1373
+
1374
+ ```ts
1375
+ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
1376
+ ```
1377
+
1378
+ Emits an event, invoking all registered listeners concurrently.
1379
+
1380
+ ### Type Parameters
1381
+
1382
+ #### TEventName
1383
+
1384
+ `TEventName` *extends* `string` \| `number` \| `symbol` = `string` \| `number` \| `symbol`
1385
+
1386
+ #### TEventArgs
1387
+
1388
+ `TEventArgs` *extends* `EventArgs` = `DivinerModuleEventData`\<`DivinerInstance`\<`TParams`, `Payload`, `Payload`, `DivinerModuleEventData`\>, `Payload`, `Payload`\>\[`TEventName`\]
1389
+
1390
+ ### Parameters
1391
+
1392
+ #### eventName
1393
+
1394
+ `TEventName`
1395
+
1396
+ The event to emit.
1397
+
1398
+ #### eventArgs
1399
+
1400
+ `TEventArgs`
1401
+
1402
+ The data to pass to listeners.
1403
+
1404
+ ### Returns
1405
+
1406
+ `Promise`\<`void`\>
1407
+
1408
+ ### Inherited from
1409
+
1410
+ ```ts
1411
+ SchemaStatsDiviner.emit
1412
+ ```
1413
+
1414
+ ***
1415
+
1416
+ ### isSupportedQuery()
1417
+
1418
+ ```ts
1419
+ isSupportedQuery(query, assert?): boolean;
1420
+ ```
1421
+
1422
+ ### Parameters
1423
+
1424
+ #### query
1425
+
1426
+ `Schema`
1427
+
1428
+ #### assert?
1429
+
1430
+ `string` \| `boolean`
1431
+
1432
+ ### Returns
1433
+
1434
+ `boolean`
1435
+
1436
+ ### Inherited from
1437
+
1438
+ ```ts
1439
+ SchemaStatsDiviner.isSupportedQuery
1440
+ ```
1441
+
1442
+ ***
1443
+
1444
+ ### previousHash()
1445
+
1446
+ ```ts
1447
+ previousHash(): Promisable<string | undefined>;
1448
+ ```
1449
+
1450
+ ### Returns
1451
+
1452
+ `Promisable`\<`string` \| `undefined`\>
1453
+
1454
+ ### Inherited from
1455
+
1456
+ ```ts
1457
+ SchemaStatsDiviner.previousHash
1458
+ ```
1459
+
1460
+ ***
1461
+
1462
+ ### query()
1463
+
1464
+ ```ts
1465
+ query<T, TConfig>(
1466
+ query,
1467
+ payloads?,
1468
+ queryConfig?): Promise<ModuleQueryResult>;
1469
+ ```
1470
+
1471
+ ### Type Parameters
1472
+
1473
+ #### T
1474
+
1475
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
1476
+
1477
+ #### TConfig
1478
+
1479
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
1480
+
1481
+ ### Parameters
1482
+
1483
+ #### query
1484
+
1485
+ `T`
1486
+
1487
+ #### payloads?
1488
+
1489
+ `Payload`[]
1490
+
1491
+ #### queryConfig?
1492
+
1493
+ `TConfig`
1494
+
1495
+ ### Returns
1496
+
1497
+ `Promise`\<`ModuleQueryResult`\>
1498
+
1499
+ ### Inherited from
1500
+
1501
+ ```ts
1502
+ SchemaStatsDiviner.query
1503
+ ```
1504
+
1505
+ ***
1506
+
1507
+ ### queryable()
1508
+
1509
+ ```ts
1510
+ queryable<T, TConfig>(
1511
+ query,
1512
+ payloads?,
1513
+ queryConfig?): Promise<boolean>;
1514
+ ```
1515
+
1516
+ ### Type Parameters
1517
+
1518
+ #### T
1519
+
1520
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
1521
+
1522
+ #### TConfig
1523
+
1524
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
1525
+
1526
+ ### Parameters
1527
+
1528
+ #### query
1529
+
1530
+ `T`
1531
+
1532
+ #### payloads?
1533
+
1534
+ `Payload`[]
1535
+
1536
+ #### queryConfig?
1537
+
1538
+ `TConfig`
1539
+
1540
+ ### Returns
1541
+
1542
+ `Promise`\<`boolean`\>
1543
+
1544
+ ### Inherited from
1545
+
1546
+ ```ts
1547
+ SchemaStatsDiviner.queryable
1548
+ ```
1549
+
1550
+ ***
1551
+
1552
+ ### \_checkDead()
1553
+
1554
+ ```ts
1555
+ protected _checkDead(): void;
1556
+ ```
1557
+
1558
+ ### Returns
1559
+
1560
+ `void`
1561
+
1562
+ ### Inherited from
1563
+
1564
+ ```ts
1565
+ SchemaStatsDiviner._checkDead
1566
+ ```
1567
+
1568
+ ***
1569
+
1570
+ ### archivistInstance()
1571
+
1572
+ ### Call Signature
1573
+
1574
+ ```ts
1575
+ protected archivistInstance(): Promise<
1576
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
1577
+ | undefined>;
1578
+ ```
1579
+
1580
+ #### Returns
1581
+
1582
+ `Promise`\<
1583
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
1584
+ \| `undefined`\>
1585
+
1586
+ #### Inherited from
1587
+
1588
+ ```ts
1589
+ SchemaStatsDiviner.archivistInstance
1590
+ ```
1591
+
1592
+ ### Call Signature
1593
+
1594
+ ```ts
1595
+ protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
1596
+ ```
1597
+
1598
+ #### Parameters
1599
+
1600
+ ##### required
1601
+
1602
+ `true`
1603
+
1604
+ #### Returns
1605
+
1606
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
1607
+
1608
+ #### Inherited from
1609
+
1610
+ ```ts
1611
+ SchemaStatsDiviner.archivistInstance
1612
+ ```
1613
+
1614
+ ***
1615
+
1616
+ ### bindHashes()
1617
+
1618
+ ```ts
1619
+ protected bindHashes(
1620
+ hashes,
1621
+ schema,
1622
+ account?): PromiseEx<unknown, AccountInstance>;
1623
+ ```
1624
+
1625
+ ### Parameters
1626
+
1627
+ #### hashes
1628
+
1629
+ `BrandedHash`[]
1630
+
1631
+ #### schema
1632
+
1633
+ `Schema`[]
1634
+
1635
+ #### account?
1636
+
1637
+ `AccountInstance`
1638
+
1639
+ ### Returns
1640
+
1641
+ `PromiseEx`\<`unknown`, `AccountInstance`\>
1642
+
1643
+ ### Inherited from
1644
+
1645
+ ```ts
1646
+ SchemaStatsDiviner.bindHashes
1647
+ ```
1648
+
1649
+ ***
1650
+
1651
+ ### bindHashesInternal()
1652
+
1653
+ ```ts
1654
+ protected bindHashesInternal(
1655
+ hashes,
1656
+ schema,
1657
+ account?): Promise<{
1658
+ schema: "network.xyo.boundwitness" & object;
1659
+ addresses: Lowercase<string> & object & object[];
1660
+ payload_hashes: BrandedHash[];
1661
+ payload_schemas: BrandedSchema<string>[];
1662
+ previous_hashes: (BrandedHash | null)[];
1663
+ $destination?: Lowercase<string> & object & object;
1664
+ $sourceQuery?: BrandedHash;
1665
+ $signatures: (BrandedHex | null)[];
1666
+ }>;
1667
+ ```
1668
+
1669
+ ### Parameters
1670
+
1671
+ #### hashes
1672
+
1673
+ `BrandedHash`[]
1674
+
1675
+ #### schema
1676
+
1677
+ `Schema`[]
1678
+
1679
+ #### account?
1680
+
1681
+ `AccountInstance`
1682
+
1683
+ ### Returns
1684
+
1685
+ `Promise`\<\{
1686
+ `schema`: `"network.xyo.boundwitness"` & `object`;
1687
+ `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
1688
+ `payload_hashes`: `BrandedHash`[];
1689
+ `payload_schemas`: `BrandedSchema`\<`string`\>[];
1690
+ `previous_hashes`: (`BrandedHash` \| `null`)[];
1691
+ `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
1692
+ `$sourceQuery?`: `BrandedHash`;
1693
+ `$signatures`: (`BrandedHex` \| `null`)[];
1694
+ \}\>
1695
+
1696
+ ### Inherited from
1697
+
1698
+ ```ts
1699
+ SchemaStatsDiviner.bindHashesInternal
1700
+ ```
1701
+
1702
+ ***
1703
+
1704
+ ### bindQuery()
1705
+
1706
+ ```ts
1707
+ protected bindQuery<T>(
1708
+ query,
1709
+ payloads?,
1710
+ account?,
1711
+ additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;
1712
+ ```
1713
+
1714
+ ### Type Parameters
1715
+
1716
+ #### T
1717
+
1718
+ `T` *extends* `Query`
1719
+
1720
+ ### Parameters
1721
+
1722
+ #### query
1723
+
1724
+ `T`
1725
+
1726
+ #### payloads?
1727
+
1728
+ `Payload`[]
1729
+
1730
+ #### account?
1731
+
1732
+ `AccountInstance`
1733
+
1734
+ #### additionalSigners?
1735
+
1736
+ `AccountInstance`[]
1737
+
1738
+ ### Returns
1739
+
1740
+ `PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\], `AccountInstance`\>
1741
+
1742
+ ### Inherited from
1743
+
1744
+ ```ts
1745
+ SchemaStatsDiviner.bindQuery
1746
+ ```
1747
+
1748
+ ***
1749
+
1750
+ ### bindQueryInternal()
1751
+
1752
+ ```ts
1753
+ protected bindQueryInternal<T>(
1754
+ query,
1755
+ payloads?,
1756
+ account?,
1757
+ additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;
1758
+ ```
1759
+
1760
+ ### Type Parameters
1761
+
1762
+ #### T
1763
+
1764
+ `T` *extends* `Query`
1765
+
1766
+ ### Parameters
1767
+
1768
+ #### query
1769
+
1770
+ `T`
1771
+
1772
+ #### payloads?
1773
+
1774
+ `Payload`[]
1775
+
1776
+ #### account?
1777
+
1778
+ `AccountInstance`
1779
+
1780
+ #### additionalSigners?
1781
+
1782
+ `AccountInstance`[]
1783
+
1784
+ ### Returns
1785
+
1786
+ `Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\]\>
1787
+
1788
+ ### Inherited from
1789
+
1790
+ ```ts
1791
+ SchemaStatsDiviner.bindQueryInternal
1792
+ ```
1793
+
1794
+ ***
1795
+
1796
+ ### bindQueryResult()
1797
+
1798
+ ```ts
1799
+ protected bindQueryResult<T>(
1800
+ query,
1801
+ payloads,
1802
+ additionalWitnesses?,
1803
+ errors?): Promise<ModuleQueryResult>;
1804
+ ```
1805
+
1806
+ ### Type Parameters
1807
+
1808
+ #### T
1809
+
1810
+ `T` *extends* `Query`
1811
+
1812
+ ### Parameters
1813
+
1814
+ #### query
1815
+
1816
+ `T`
1817
+
1818
+ #### payloads
1819
+
1820
+ `Payload`[]
1821
+
1822
+ #### additionalWitnesses?
1823
+
1824
+ `AccountInstance`[]
1825
+
1826
+ #### errors?
1827
+
1828
+ `ModuleError`[]
1829
+
1830
+ ### Returns
1831
+
1832
+ `Promise`\<`ModuleQueryResult`\>
1833
+
1834
+ ### Inherited from
1835
+
1836
+ ```ts
1837
+ SchemaStatsDiviner.bindQueryResult
1838
+ ```
1839
+
1840
+ ***
1841
+
1842
+ ### generateConfigAndAddress()
1843
+
1844
+ ```ts
1845
+ protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
1846
+ ```
1847
+
1848
+ ### Parameters
1849
+
1850
+ #### \_maxDepth?
1851
+
1852
+ `number`
1853
+
1854
+ ### Returns
1855
+
1856
+ `Promisable`\<`Payload`[]\>
1857
+
1858
+ ### Inherited from
1859
+
1860
+ ```ts
1861
+ SchemaStatsDiviner.generateConfigAndAddress
1862
+ ```
1863
+
1864
+ ***
1865
+
1866
+ ### generateDescribe()
1867
+
1868
+ ```ts
1869
+ protected generateDescribe(): Promise<ModuleDescriptionPayload>;
1870
+ ```
1871
+
1872
+ ### Returns
1873
+
1874
+ `Promise`\<`ModuleDescriptionPayload`\>
1875
+
1876
+ ### Inherited from
1877
+
1878
+ ```ts
1879
+ SchemaStatsDiviner.generateDescribe
1880
+ ```
1881
+
1882
+ ***
1883
+
1884
+ ### ~~getArchivist()~~
1885
+
1886
+ ```ts
1887
+ protected getArchivist(): Promise<
1888
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
1889
+ | undefined>;
1890
+ ```
1891
+
1892
+ ### Returns
1893
+
1894
+ `Promise`\<
1895
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
1896
+ \| `undefined`\>
1897
+
1898
+ ### Deprecated
1899
+
1900
+ use archivistInstance() instead
1901
+
1902
+ ### Inherited from
1903
+
1904
+ ```ts
1905
+ SchemaStatsDiviner.getArchivist
1906
+ ```
1907
+
1908
+ ***
1909
+
1910
+ ### isAllowedArchivingQuery()
1911
+
1912
+ ```ts
1913
+ protected isAllowedArchivingQuery(schema): boolean;
1914
+ ```
1915
+
1916
+ ### Parameters
1917
+
1918
+ #### schema
1919
+
1920
+ `Schema`
1921
+
1922
+ ### Returns
1923
+
1924
+ `boolean`
1925
+
1926
+ ### Inherited from
1927
+
1928
+ ```ts
1929
+ SchemaStatsDiviner.isAllowedArchivingQuery
1930
+ ```
1931
+
1932
+ ***
1933
+
1934
+ ### moduleAddressHandler()
1935
+
1936
+ ```ts
1937
+ protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
1938
+ ```
1939
+
1940
+ ### Returns
1941
+
1942
+ `Promisable`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
1943
+
1944
+ ### Inherited from
1945
+
1946
+ ```ts
1947
+ SchemaStatsDiviner.moduleAddressHandler
1948
+ ```
1949
+
1950
+ ***
1951
+
1952
+ ### stateHandler()
1953
+
1954
+ ```ts
1955
+ protected stateHandler(): Promise<Payload[]>;
1956
+ ```
1957
+
1958
+ ### Returns
1959
+
1960
+ `Promise`\<`Payload`[]\>
1961
+
1962
+ ### Inherited from
1963
+
1964
+ ```ts
1965
+ SchemaStatsDiviner.stateHandler
1966
+ ```
1967
+
1968
+ ***
1969
+
1970
+ ### subscribeHandler()
1971
+
1972
+ ```ts
1973
+ protected subscribeHandler(): void;
1974
+ ```
1975
+
1976
+ ### Returns
1977
+
1978
+ `void`
1979
+
1980
+ ### Inherited from
1981
+
1982
+ ```ts
1983
+ SchemaStatsDiviner.subscribeHandler
1984
+ ```
1985
+
1986
+ ***
1987
+
1988
+ ### validateConfig()
1989
+
1990
+ ```ts
1991
+ protected validateConfig(config?, parents?): boolean;
1992
+ ```
1993
+
1994
+ ### Parameters
1995
+
1996
+ #### config?
1997
+
1998
+ `unknown`
1999
+
2000
+ #### parents?
2001
+
2002
+ `string`[]
2003
+
2004
+ ### Returns
2005
+
2006
+ `boolean`
2007
+
2008
+ ### Inherited from
2009
+
2010
+ ```ts
2011
+ SchemaStatsDiviner.validateConfig
2012
+ ```
2013
+
2014
+ ***
2015
+
2016
+ ### addParent()
2017
+
2018
+ ```ts
2019
+ addParent(mod): void;
2020
+ ```
2021
+
2022
+ ### Parameters
2023
+
2024
+ #### mod
2025
+
2026
+ `ModuleInstance`
2027
+
2028
+ ### Returns
2029
+
2030
+ `void`
2031
+
2032
+ ### Inherited from
2033
+
2034
+ ```ts
2035
+ SchemaStatsDiviner.addParent
2036
+ ```
2037
+
2038
+ ***
2039
+
2040
+ ### certifyParents()
2041
+
2042
+ ```ts
2043
+ certifyParents(): Promise<Payload[]>;
2044
+ ```
2045
+
2046
+ ### Returns
2047
+
2048
+ `Promise`\<`Payload`[]\>
2049
+
2050
+ ### Inherited from
2051
+
2052
+ ```ts
2053
+ SchemaStatsDiviner.certifyParents
2054
+ ```
2055
+
2056
+ ***
2057
+
2058
+ ### createHandler()
2059
+
2060
+ ```ts
2061
+ createHandler(): Promise<void>;
2062
+ ```
2063
+
2064
+ ### Returns
2065
+
2066
+ `Promise`\<`void`\>
2067
+
2068
+ ### Inherited from
2069
+
2070
+ ```ts
2071
+ SchemaStatsDiviner.createHandler
2072
+ ```
2073
+
2074
+ ***
2075
+
2076
+ ### manifest()
2077
+
2078
+ ```ts
2079
+ manifest(maxDepth?): Promise<ModuleManifestPayload>;
2080
+ ```
2081
+
2082
+ ### Parameters
2083
+
2084
+ #### maxDepth?
2085
+
2086
+ `number`
2087
+
2088
+ ### Returns
2089
+
2090
+ `Promise`\<`ModuleManifestPayload`\>
2091
+
2092
+ ### Inherited from
2093
+
2094
+ ```ts
2095
+ SchemaStatsDiviner.manifest
2096
+ ```
2097
+
2098
+ ***
2099
+
2100
+ ### manifestQuery()
2101
+
2102
+ ```ts
2103
+ manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
2104
+ ```
2105
+
2106
+ ### Parameters
2107
+
2108
+ #### account
2109
+
2110
+ `AccountInstance`
2111
+
2112
+ #### maxDepth?
2113
+
2114
+ `number`
2115
+
2116
+ ### Returns
2117
+
2118
+ `Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
2119
+
2120
+ ### Inherited from
2121
+
2122
+ ```ts
2123
+ SchemaStatsDiviner.manifestQuery
2124
+ ```
2125
+
2126
+ ***
2127
+
2128
+ ### moduleAddress()
2129
+
2130
+ ```ts
2131
+ moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
2132
+ ```
2133
+
2134
+ ### Returns
2135
+
2136
+ `Promise`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
2137
+
2138
+ ### Inherited from
2139
+
2140
+ ```ts
2141
+ SchemaStatsDiviner.moduleAddress
2142
+ ```
2143
+
2144
+ ***
2145
+
2146
+ ### parents()
2147
+
2148
+ ```ts
2149
+ parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
2150
+ ```
2151
+
2152
+ ### Returns
2153
+
2154
+ `Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
2155
+
2156
+ ### Inherited from
2157
+
2158
+ ```ts
2159
+ SchemaStatsDiviner.parents
2160
+ ```
2161
+
2162
+ ***
2163
+
2164
+ ### privateChildren()
2165
+
2166
+ ```ts
2167
+ privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2168
+ ```
2169
+
2170
+ ### Returns
2171
+
2172
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2173
+
2174
+ ### Inherited from
2175
+
2176
+ ```ts
2177
+ SchemaStatsDiviner.privateChildren
2178
+ ```
2179
+
2180
+ ***
2181
+
2182
+ ### publicChildren()
2183
+
2184
+ ```ts
2185
+ publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2186
+ ```
2187
+
2188
+ ### Returns
2189
+
2190
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2191
+
2192
+ ### Inherited from
2193
+
2194
+ ```ts
2195
+ SchemaStatsDiviner.publicChildren
2196
+ ```
2197
+
2198
+ ***
2199
+
2200
+ ### removeParent()
2201
+
2202
+ ```ts
2203
+ removeParent(address): void;
2204
+ ```
2205
+
2206
+ ### Parameters
2207
+
2208
+ #### address
2209
+
2210
+ `BrandedAddress`
2211
+
2212
+ ### Returns
2213
+
2214
+ `void`
2215
+
2216
+ ### Inherited from
2217
+
2218
+ ```ts
2219
+ SchemaStatsDiviner.removeParent
2220
+ ```
2221
+
2222
+ ***
2223
+
2224
+ ### resolve()
2225
+
2226
+ ### Call Signature
2227
+
2228
+ ```ts
2229
+ resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2230
+ ```
2231
+
2232
+ #### Returns
2233
+
2234
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2235
+
2236
+ #### Inherited from
2237
+
2238
+ ```ts
2239
+ SchemaStatsDiviner.resolve
2240
+ ```
2241
+
2242
+ ### Call Signature
2243
+
2244
+ ```ts
2245
+ resolve<T>(all, options?): Promise<T[]>;
2246
+ ```
2247
+
2248
+ #### Type Parameters
2249
+
2250
+ ##### T
2251
+
2252
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2253
+
2254
+ #### Parameters
2255
+
2256
+ ##### all
2257
+
2258
+ `"*"`
2259
+
2260
+ ##### options?
2261
+
2262
+ `ModuleFilterOptions`\<`T`\>
2263
+
2264
+ #### Returns
2265
+
2266
+ `Promise`\<`T`[]\>
2267
+
2268
+ #### Inherited from
2269
+
2270
+ ```ts
2271
+ SchemaStatsDiviner.resolve
2272
+ ```
2273
+
2274
+ ### Call Signature
2275
+
2276
+ ```ts
2277
+ resolve<T>(id, options?): Promise<T | undefined>;
2278
+ ```
2279
+
2280
+ #### Type Parameters
2281
+
2282
+ ##### T
2283
+
2284
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2285
+
2286
+ #### Parameters
2287
+
2288
+ ##### id
2289
+
2290
+ `ModuleIdentifier`
2291
+
2292
+ ##### options?
2293
+
2294
+ `ModuleFilterOptions`\<`T`\>
2295
+
2296
+ #### Returns
2297
+
2298
+ `Promise`\<`T` \| `undefined`\>
2299
+
2300
+ #### Inherited from
2301
+
2302
+ ```ts
2303
+ SchemaStatsDiviner.resolve
2304
+ ```
2305
+
2306
+ ***
2307
+
2308
+ ### resolveIdentifier()
2309
+
2310
+ ```ts
2311
+ resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
2312
+ ```
2313
+
2314
+ ### Parameters
2315
+
2316
+ #### id
2317
+
2318
+ `ModuleIdentifier`
2319
+
2320
+ #### options?
2321
+
2322
+ `ObjectFilterOptions`\<`AnyObject`\>
2323
+
2324
+ ### Returns
2325
+
2326
+ `Promise`\<`BrandedAddress` \| `undefined`\>
2327
+
2328
+ ### Inherited from
2329
+
2330
+ ```ts
2331
+ SchemaStatsDiviner.resolveIdentifier
2332
+ ```
2333
+
2334
+ ***
2335
+
2336
+ ### resolvePrivate()
2337
+
2338
+ ### Call Signature
2339
+
2340
+ ```ts
2341
+ resolvePrivate<T>(all, options?): Promise<T[]>;
2342
+ ```
2343
+
2344
+ #### Type Parameters
2345
+
2346
+ ##### T
2347
+
2348
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2349
+
2350
+ #### Parameters
2351
+
2352
+ ##### all
2353
+
2354
+ `"*"`
2355
+
2356
+ ##### options?
2357
+
2358
+ `ModuleFilterOptions`\<`T`\>
2359
+
2360
+ #### Returns
2361
+
2362
+ `Promise`\<`T`[]\>
2363
+
2364
+ #### Inherited from
2365
+
2366
+ ```ts
2367
+ SchemaStatsDiviner.resolvePrivate
2368
+ ```
2369
+
2370
+ ### Call Signature
2371
+
2372
+ ```ts
2373
+ resolvePrivate<T>(id, options?): Promise<T | undefined>;
2374
+ ```
2375
+
2376
+ #### Type Parameters
2377
+
2378
+ ##### T
2379
+
2380
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2381
+
2382
+ #### Parameters
2383
+
2384
+ ##### id
2385
+
2386
+ `ModuleIdentifier`
2387
+
2388
+ ##### options?
2389
+
2390
+ `ModuleFilterOptions`\<`T`\>
2391
+
2392
+ #### Returns
2393
+
2394
+ `Promise`\<`T` \| `undefined`\>
2395
+
2396
+ #### Inherited from
2397
+
2398
+ ```ts
2399
+ SchemaStatsDiviner.resolvePrivate
2400
+ ```
2401
+
2402
+ ***
2403
+
2404
+ ### siblings()
2405
+
2406
+ ```ts
2407
+ siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2408
+ ```
2409
+
2410
+ ### Returns
2411
+
2412
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2413
+
2414
+ ### Inherited from
2415
+
2416
+ ```ts
2417
+ SchemaStatsDiviner.siblings
2418
+ ```
2419
+
2420
+ ***
2421
+
2422
+ ### state()
2423
+
2424
+ ```ts
2425
+ state(): Promise<Payload[]>;
2426
+ ```
2427
+
2428
+ ### Returns
2429
+
2430
+ `Promise`\<`Payload`[]\>
2431
+
2432
+ ### Inherited from
2433
+
2434
+ ```ts
2435
+ SchemaStatsDiviner.state
2436
+ ```
2437
+
2438
+ ***
2439
+
2440
+ ### stateQuery()
2441
+
2442
+ ```ts
2443
+ stateQuery(account): Promise<ModuleQueryResult>;
2444
+ ```
2445
+
2446
+ ### Parameters
2447
+
2448
+ #### account
2449
+
2450
+ `AccountInstance`
2451
+
2452
+ ### Returns
2453
+
2454
+ `Promise`\<`ModuleQueryResult`\>
2455
+
2456
+ ### Inherited from
2457
+
2458
+ ```ts
2459
+ SchemaStatsDiviner.stateQuery
2460
+ ```
2461
+
2462
+ ***
2463
+
2464
+ ### subscribe()
2465
+
2466
+ ```ts
2467
+ subscribe(_queryAccount?): void;
2468
+ ```
2469
+
2470
+ ### Parameters
2471
+
2472
+ #### \_queryAccount?
2473
+
2474
+ `AccountInstance`
2475
+
2476
+ ### Returns
2477
+
2478
+ `void`
2479
+
2480
+ ### Inherited from
2481
+
2482
+ ```ts
2483
+ SchemaStatsDiviner.subscribe
2484
+ ```
2485
+
2486
+ ***
2487
+
2488
+ ### manifestHandler()
2489
+
2490
+ ```ts
2491
+ protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
2492
+ ```
2493
+
2494
+ ### Parameters
2495
+
2496
+ #### maxDepth?
2497
+
2498
+ `number`
2499
+
2500
+ #### \_ignoreAddresses?
2501
+
2502
+ `BrandedAddress`[]
2503
+
2504
+ ### Returns
2505
+
2506
+ `Promise`\<`ModuleManifestPayload`\>
2507
+
2508
+ ### Inherited from
2509
+
2510
+ ```ts
2511
+ SchemaStatsDiviner.manifestHandler
2512
+ ```
2513
+
2514
+ ***
2515
+
2516
+ ### resolveArchivingArchivists()
2517
+
2518
+ ```ts
2519
+ protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
2520
+ ```
2521
+
2522
+ ### Returns
2523
+
2524
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
2525
+
2526
+ ### Inherited from
2527
+
2528
+ ```ts
2529
+ SchemaStatsDiviner.resolveArchivingArchivists
2530
+ ```
2531
+
2532
+ ***
2533
+
2534
+ ### sendQuery()
2535
+
2536
+ ```ts
2537
+ protected sendQuery<T, P, R>(
2538
+ queryPayload,
2539
+ payloads?,
2540
+ account?): Promise<R[]>;
2541
+ ```
2542
+
2543
+ ### Type Parameters
2544
+
2545
+ #### T
2546
+
2547
+ `T` *extends* `Query`
2548
+
2549
+ #### P
2550
+
2551
+ `P` *extends* `Payload` = `Payload`
2552
+
2553
+ #### R
2554
+
2555
+ `R` *extends* `Payload` = `Payload`
2556
+
2557
+ ### Parameters
2558
+
2559
+ #### queryPayload
2560
+
2561
+ `T`
2562
+
2563
+ #### payloads?
2564
+
2565
+ `P`[]
2566
+
2567
+ #### account?
2568
+
2569
+ `AccountInstance`
2570
+
2571
+ ### Returns
2572
+
2573
+ `Promise`\<`R`[]\>
2574
+
2575
+ ### Inherited from
2576
+
2577
+ ```ts
2578
+ SchemaStatsDiviner.sendQuery
2579
+ ```
2580
+
2581
+ ***
2582
+
2583
+ ### sendQueryRaw()
2584
+
2585
+ ```ts
2586
+ protected sendQueryRaw<T, P, R>(
2587
+ queryPayload,
2588
+ payloads?,
2589
+ account?): Promise<ModuleQueryResult<R>>;
2590
+ ```
2591
+
2592
+ ### Type Parameters
2593
+
2594
+ #### T
2595
+
2596
+ `T` *extends* `Query`
2597
+
2598
+ #### P
2599
+
2600
+ `P` *extends* `Payload` = `Payload`
2601
+
2602
+ #### R
2603
+
2604
+ `R` *extends* `Payload` = `Payload`
2605
+
2606
+ ### Parameters
2607
+
2608
+ #### queryPayload
2609
+
2610
+ `T`
2611
+
2612
+ #### payloads?
2613
+
2614
+ `P`[]
2615
+
2616
+ #### account?
2617
+
2618
+ `AccountInstance`
2619
+
2620
+ ### Returns
2621
+
2622
+ `Promise`\<`ModuleQueryResult`\<`R`\>\>
2623
+
2624
+ ### Inherited from
2625
+
2626
+ ```ts
2627
+ SchemaStatsDiviner.sendQueryRaw
2628
+ ```
2629
+
2630
+ ***
2631
+
2632
+ ### storeToArchivists()
2633
+
2634
+ ```ts
2635
+ protected storeToArchivists(payloads): Promise<Payload[]>;
2636
+ ```
2637
+
2638
+ ### Parameters
2639
+
2640
+ #### payloads
2641
+
2642
+ `Payload`[]
2643
+
2644
+ ### Returns
2645
+
2646
+ `Promise`\<`Payload`[]\>
2647
+
2648
+ ### Inherited from
18
2649
 
19
- ## Credits
2650
+ ```ts
2651
+ SchemaStatsDiviner.storeToArchivists
2652
+ ```
20
2653
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
2654
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
2655
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
2656
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-schema-stats-memory.svg
2657
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-schema-stats-memory
2658
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-schema-stats-memory.svg
2659
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE