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