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