@xyo-network/bridge-http-express 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 +3754 -10
  2. package/package.json +30 -30
package/README.md CHANGED
@@ -1,23 +1,3767 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/bridge-http-express
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__bridge-http-express)
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
+ ### bridge
50
+
51
+ ### packages
52
+
53
+ ### http-express
54
+
55
+ ### .temp-typedoc
56
+
57
+ ### classes
58
+
59
+ ### <a id="HttpBridgeExpress"></a>HttpBridgeExpress
60
+
61
+ [**@xyo-network/bridge-http-express**](#../README)
62
+
63
+ ***
64
+
65
+ ## Extends
66
+
67
+ - `HttpBridge`\<`TParams`\>
68
+
69
+ ## Type Parameters
70
+
71
+ ### TParams
72
+
73
+ `TParams` *extends* [`HttpBridgeExpressParams`](#../interfaces/HttpBridgeExpressParams)
74
+
75
+ ## Constructors
76
+
77
+ ### Constructor
78
+
79
+ ```ts
80
+ new HttpBridgeExpress<TParams>(key, params): HttpBridgeExpress<TParams>;
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ #### key
86
+
87
+ `unknown`
88
+
89
+ #### params
90
+
91
+ `Partial`\<`TParams` & `RequiredCreatableParams`\>
92
+
93
+ ### Returns
94
+
95
+ `HttpBridgeExpress`\<`TParams`\>
96
+
97
+ ### Inherited from
98
+
99
+ ```ts
100
+ HttpBridge<TParams>.constructor
101
+ ```
102
+
103
+ ## Properties
104
+
105
+ ### uniqueName
106
+
107
+ ```ts
108
+ readonly static uniqueName: string;
109
+ ```
110
+
111
+ ### Inherited from
112
+
113
+ ```ts
114
+ HttpBridge.uniqueName
115
+ ```
116
+
117
+ ***
118
+
119
+ ### \_roots?
120
+
121
+ ```ts
122
+ protected optional _roots?: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
123
+ ```
124
+
125
+ ### Inherited from
126
+
127
+ ```ts
128
+ HttpBridge._roots
129
+ ```
130
+
131
+ ***
132
+
133
+ ### axios
134
+
135
+ ```ts
136
+ readonly static axios: Axios;
137
+ ```
138
+
139
+ ### Inherited from
140
+
141
+ ```ts
142
+ HttpBridge.axios
143
+ ```
144
+
145
+ ***
146
+
147
+ ### defaultConfigSchema
148
+
149
+ ```ts
150
+ readonly static defaultConfigSchema: Schema;
151
+ ```
152
+
153
+ ### Inherited from
154
+
155
+ ```ts
156
+ HttpBridge.defaultConfigSchema
157
+ ```
158
+
159
+ ***
160
+
161
+ ### defaultFailureRetryTime
162
+
163
+ ```ts
164
+ readonly static defaultFailureRetryTime: number;
165
+ ```
166
+
167
+ ### Inherited from
168
+
169
+ ```ts
170
+ HttpBridge.defaultFailureRetryTime
171
+ ```
172
+
173
+ ***
174
+
175
+ ### defaultMaxConnections
176
+
177
+ ```ts
178
+ readonly static defaultMaxConnections: 4 = 4;
179
+ ```
180
+
181
+ ### Inherited from
182
+
183
+ ```ts
184
+ HttpBridge.defaultMaxConnections
185
+ ```
186
+
187
+ ***
188
+
189
+ ### defaultMaxPayloadSizeWarning
190
+
191
+ ```ts
192
+ readonly static defaultMaxPayloadSizeWarning: number;
193
+ ```
194
+
195
+ ### Inherited from
196
+
197
+ ```ts
198
+ HttpBridge.defaultMaxPayloadSizeWarning
199
+ ```
200
+
201
+ ***
202
+
203
+ ### maxFailureCacheSize
204
+
205
+ ```ts
206
+ readonly static maxFailureCacheSize: 1000 = 1000;
207
+ ```
208
+
209
+ ### Inherited from
210
+
211
+ ```ts
212
+ HttpBridge.maxFailureCacheSize
213
+ ```
214
+
215
+ ***
216
+
217
+ ### configSchemas
218
+
219
+ ```ts
220
+ readonly static configSchemas: Schema[];
221
+ ```
222
+
223
+ ### Overrides
224
+
225
+ ```ts
226
+ HttpBridge.configSchemas
227
+ ```
228
+
229
+ ***
230
+
231
+ ### \_app?
232
+
233
+ ```ts
234
+ protected optional _app?: Application;
235
+ ```
236
+
237
+ ***
238
+
239
+ ### \_exposedModules
240
+
241
+ ```ts
242
+ protected _exposedModules: WeakRef<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>[] = [];
243
+ ```
244
+
245
+ ***
246
+
247
+ ### \_server?
248
+
249
+ ```ts
250
+ protected optional _server?: Server<typeof IncomingMessage, typeof ServerResponse>;
251
+ ```
252
+
253
+ ***
254
+
255
+ ### allowRandomAccount
256
+
257
+ ```ts
258
+ readonly static allowRandomAccount: boolean;
259
+ ```
260
+
261
+ ### Inherited from
262
+
263
+ ```ts
264
+ HttpBridge.allowRandomAccount
265
+ ```
266
+
267
+ ***
268
+
269
+ ### defaultLogger
270
+
271
+ ```ts
272
+ static defaultLogger: Logger;
273
+ ```
274
+
275
+ ### Inherited from
276
+
277
+ ```ts
278
+ HttpBridge.defaultLogger
279
+ ```
280
+
281
+ ***
282
+
283
+ ### enableLazyLoad
284
+
285
+ ```ts
286
+ static enableLazyLoad: boolean;
287
+ ```
288
+
289
+ ### Inherited from
290
+
291
+ ```ts
292
+ HttpBridge.enableLazyLoad
293
+ ```
294
+
295
+ ***
296
+
297
+ ### labels
298
+
299
+ ```ts
300
+ readonly static labels: Labels;
301
+ ```
302
+
303
+ ### Inherited from
304
+
305
+ ```ts
306
+ HttpBridge.labels
307
+ ```
308
+
309
+ ***
310
+
311
+ ### privateConstructorKey
312
+
313
+ ```ts
314
+ protected static privateConstructorKey: string;
315
+ ```
316
+
317
+ ### Inherited from
318
+
319
+ ```ts
320
+ HttpBridge.privateConstructorKey
321
+ ```
322
+
323
+ ***
324
+
325
+ ### \_account
326
+
327
+ ```ts
328
+ protected _account: AccountInstance | undefined;
329
+ ```
330
+
331
+ ### Inherited from
332
+
333
+ ```ts
334
+ HttpBridge._account
335
+ ```
336
+
337
+ ***
338
+
339
+ ### \_cachedManifests
340
+
341
+ ```ts
342
+ protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
343
+ ```
344
+
345
+ ### Inherited from
346
+
347
+ ```ts
348
+ HttpBridge._cachedManifests
349
+ ```
350
+
351
+ ***
352
+
353
+ ### \_globalReentrancyMutex
354
+
355
+ ```ts
356
+ protected _globalReentrancyMutex: Mutex | undefined;
357
+ ```
358
+
359
+ ### Inherited from
360
+
361
+ ```ts
362
+ HttpBridge._globalReentrancyMutex
363
+ ```
364
+
365
+ ***
366
+
367
+ ### \_lastError?
368
+
369
+ ```ts
370
+ protected optional _lastError?: ModuleDetailsError;
371
+ ```
372
+
373
+ ### Inherited from
374
+
375
+ ```ts
376
+ HttpBridge._lastError
377
+ ```
378
+
379
+ ***
380
+
381
+ ### \_moduleConfigQueryValidator
382
+
383
+ ```ts
384
+ protected _moduleConfigQueryValidator: Queryable | undefined;
385
+ ```
386
+
387
+ ### Inherited from
388
+
389
+ ```ts
390
+ HttpBridge._moduleConfigQueryValidator
391
+ ```
392
+
393
+ ***
394
+
395
+ ### \_supportedQueryValidator
396
+
397
+ ```ts
398
+ protected _supportedQueryValidator: Queryable | undefined;
399
+ ```
400
+
401
+ ### Inherited from
402
+
403
+ ```ts
404
+ HttpBridge._supportedQueryValidator
405
+ ```
406
+
407
+ ***
408
+
409
+ ### useNewResolver
410
+
411
+ ```ts
412
+ readonly static useNewResolver: false = false;
413
+ ```
414
+
415
+ ### Inherited from
416
+
417
+ ```ts
418
+ HttpBridge.useNewResolver
419
+ ```
420
+
421
+ ## Accessors
422
+
423
+ ### allowNameResolution
424
+
425
+ ### Get Signature
426
+
427
+ ```ts
428
+ get allowNameResolution(): boolean;
429
+ ```
430
+
431
+ #### Returns
432
+
433
+ `boolean`
434
+
435
+ ### Inherited from
436
+
437
+ ```ts
438
+ HttpBridge.allowNameResolution
439
+ ```
440
+
441
+ ***
442
+
443
+ ### discoverRoots
444
+
445
+ ### Get Signature
446
+
447
+ ```ts
448
+ get discoverRoots(): false | "start" | "lazy";
449
+ ```
450
+
451
+ #### Returns
452
+
453
+ `false` \| `"start"` \| `"lazy"`
454
+
455
+ ### Inherited from
456
+
457
+ ```ts
458
+ HttpBridge.discoverRoots
459
+ ```
460
+
461
+ ***
462
+
463
+ ### queries
464
+
465
+ ### Get Signature
466
+
467
+ ```ts
468
+ get queries(): Schema[];
469
+ ```
470
+
471
+ #### Returns
472
+
473
+ `Schema`[]
474
+
475
+ ### Inherited from
476
+
477
+ ```ts
478
+ HttpBridge.queries
479
+ ```
480
+
481
+ ***
482
+
483
+ ### axios
484
+
485
+ ### Get Signature
486
+
487
+ ```ts
488
+ get axios(): Axios;
489
+ ```
490
+
491
+ #### Returns
492
+
493
+ `Axios`
494
+
495
+ ### Inherited from
496
+
497
+ ```ts
498
+ HttpBridge.axios
499
+ ```
500
+
501
+ ***
502
+
503
+ ### clientUrl
504
+
505
+ ### Get Signature
506
+
507
+ ```ts
508
+ get clientUrl(): string;
509
+ ```
510
+
511
+ #### Returns
512
+
513
+ `string`
514
+
515
+ ### Inherited from
516
+
517
+ ```ts
518
+ HttpBridge.clientUrl
519
+ ```
520
+
521
+ ***
522
+
523
+ ### failureRetryTime
524
+
525
+ ### Get Signature
526
+
527
+ ```ts
528
+ get failureRetryTime(): number;
529
+ ```
530
+
531
+ #### Returns
532
+
533
+ `number`
534
+
535
+ ### Inherited from
536
+
537
+ ```ts
538
+ HttpBridge.failureRetryTime
539
+ ```
540
+
541
+ ***
542
+
543
+ ### maxConnections
544
+
545
+ ### Get Signature
546
+
547
+ ```ts
548
+ get maxConnections(): number;
549
+ ```
550
+
551
+ #### Returns
552
+
553
+ `number`
554
+
555
+ ### Inherited from
556
+
557
+ ```ts
558
+ HttpBridge.maxConnections
559
+ ```
560
+
561
+ ***
562
+
563
+ ### maxPayloadSizeWarning
564
+
565
+ ### Get Signature
566
+
567
+ ```ts
568
+ get maxPayloadSizeWarning(): number;
569
+ ```
570
+
571
+ #### Returns
572
+
573
+ `number`
574
+
575
+ ### Inherited from
576
+
577
+ ```ts
578
+ HttpBridge.maxPayloadSizeWarning
579
+ ```
580
+
581
+ ***
582
+
583
+ ### querySemaphore
584
+
585
+ ### Get Signature
586
+
587
+ ```ts
588
+ get querySemaphore(): Semaphore;
589
+ ```
590
+
591
+ #### Returns
592
+
593
+ `Semaphore`
594
+
595
+ ### Inherited from
596
+
597
+ ```ts
598
+ HttpBridge.querySemaphore
599
+ ```
600
+
601
+ ***
602
+
603
+ ### resolver
604
+
605
+ ### Get Signature
606
+
607
+ ```ts
608
+ get resolver(): HttpBridgeModuleResolver<HttpBridgeModuleResolverParams>;
609
+ ```
610
+
611
+ #### Returns
612
+
613
+ `HttpBridgeModuleResolver`\<`HttpBridgeModuleResolverParams`\>
614
+
615
+ ### Inherited from
616
+
617
+ ```ts
618
+ HttpBridge.resolver
619
+ ```
620
+
621
+ ***
622
+
623
+ ### app
624
+
625
+ ### Get Signature
626
+
627
+ ```ts
628
+ get protected app(): Application;
629
+ ```
630
+
631
+ #### Returns
632
+
633
+ `Application`
634
+
635
+ ***
636
+
637
+ ### account
638
+
639
+ ### Get Signature
640
+
641
+ ```ts
642
+ get account(): AccountInstance;
643
+ ```
644
+
645
+ #### Returns
646
+
647
+ `AccountInstance`
648
+
649
+ ### Inherited from
650
+
651
+ ```ts
652
+ HttpBridge.account
653
+ ```
654
+
655
+ ***
656
+
657
+ ### additionalSigners
658
+
659
+ ### Get Signature
660
+
661
+ ```ts
662
+ get additionalSigners(): AccountInstance[];
663
+ ```
664
+
665
+ #### Returns
666
+
667
+ `AccountInstance`[]
668
+
669
+ ### Inherited from
670
+
671
+ ```ts
672
+ HttpBridge.additionalSigners
673
+ ```
674
+
675
+ ***
676
+
677
+ ### address
678
+
679
+ ### Get Signature
680
+
681
+ ```ts
682
+ get address(): Lowercase<string> & object & object;
683
+ ```
684
+
685
+ #### Returns
686
+
687
+ `Lowercase`\<`string`\> & `object` & `object`
688
+
689
+ ### Inherited from
690
+
691
+ ```ts
692
+ HttpBridge.address
693
+ ```
694
+
695
+ ***
696
+
697
+ ### allowAnonymous
698
+
699
+ ### Get Signature
700
+
701
+ ```ts
702
+ get allowAnonymous(): boolean;
703
+ ```
704
+
705
+ #### Returns
706
+
707
+ `boolean`
708
+
709
+ ### Inherited from
710
+
711
+ ```ts
712
+ HttpBridge.allowAnonymous
713
+ ```
714
+
715
+ ***
716
+
717
+ ### archiving
718
+
719
+ ### Get Signature
720
+
721
+ ```ts
722
+ get archiving():
723
+ | {
724
+ archivists?: ModuleIdentifier[];
725
+ queries?: Schema[];
726
+ }
727
+ | undefined;
728
+ ```
729
+
730
+ #### Returns
731
+
732
+ \| \{
733
+ `archivists?`: `ModuleIdentifier`[];
734
+ `queries?`: `Schema`[];
735
+ \}
736
+ \| `undefined`
737
+
738
+ ### Inherited from
739
+
740
+ ```ts
741
+ HttpBridge.archiving
742
+ ```
743
+
744
+ ***
745
+
746
+ ### archivist
747
+
748
+ ### Get Signature
749
+
750
+ ```ts
751
+ get archivist(): ModuleIdentifier | undefined;
752
+ ```
753
+
754
+ #### Returns
755
+
756
+ `ModuleIdentifier` \| `undefined`
757
+
758
+ ### Inherited from
759
+
760
+ ```ts
761
+ HttpBridge.archivist
762
+ ```
763
+
764
+ ***
765
+
766
+ ### config
767
+
768
+ ### Get Signature
769
+
770
+ ```ts
771
+ get config(): TParams["config"] & object;
772
+ ```
773
+
774
+ #### Returns
775
+
776
+ `TParams`\[`"config"`\] & `object`
777
+
778
+ ### Inherited from
779
+
780
+ ```ts
781
+ HttpBridge.config
782
+ ```
783
+
784
+ ***
785
+
786
+ ### dead
787
+
788
+ ### Get Signature
789
+
790
+ ```ts
791
+ get dead(): boolean;
792
+ ```
793
+
794
+ #### Returns
795
+
796
+ `boolean`
797
+
798
+ ### Inherited from
799
+
800
+ ```ts
801
+ HttpBridge.dead
802
+ ```
803
+
804
+ ***
805
+
806
+ ### ephemeralQueryAccountEnabled
807
+
808
+ ### Get Signature
809
+
810
+ ```ts
811
+ get ephemeralQueryAccountEnabled(): boolean;
812
+ ```
813
+
814
+ #### Returns
815
+
816
+ `boolean`
817
+
818
+ ### Inherited from
819
+
820
+ ```ts
821
+ HttpBridge.ephemeralQueryAccountEnabled
822
+ ```
823
+
824
+ ***
825
+
826
+ ### globalReentrancyMutex
827
+
828
+ ### Get Signature
829
+
830
+ ```ts
831
+ get globalReentrancyMutex(): Mutex | undefined;
832
+ ```
833
+
834
+ #### Returns
835
+
836
+ `Mutex` \| `undefined`
837
+
838
+ ### Inherited from
839
+
840
+ ```ts
841
+ HttpBridge.globalReentrancyMutex
842
+ ```
843
+
844
+ ***
845
+
846
+ ### id
847
+
848
+ ### Get Signature
849
+
850
+ ```ts
851
+ get id(): string;
852
+ ```
853
+
854
+ The name (if specified) or address of the module
855
+
856
+ #### Returns
857
+
858
+ `string`
859
+
860
+ ### Inherited from
861
+
862
+ ```ts
863
+ HttpBridge.id
864
+ ```
865
+
866
+ ***
867
+
868
+ ### logger
869
+
870
+ ### Get Signature
871
+
872
+ ```ts
873
+ get logger(): Logger | undefined;
874
+ ```
875
+
876
+ #### Returns
877
+
878
+ `Logger` \| `undefined`
879
+
880
+ ### Inherited from
881
+
882
+ ```ts
883
+ HttpBridge.logger
884
+ ```
885
+
886
+ ***
887
+
888
+ ### priority
889
+
890
+ ### Get Signature
891
+
892
+ ```ts
893
+ get priority(): 2;
894
+ ```
895
+
896
+ #### Returns
897
+
898
+ `2`
899
+
900
+ ### Inherited from
901
+
902
+ ```ts
903
+ HttpBridge.priority
904
+ ```
905
+
906
+ ***
907
+
908
+ ### reentrancy
909
+
910
+ ### Get Signature
911
+
912
+ ```ts
913
+ get reentrancy():
914
+ | {
915
+ action: "skip" | "wait";
916
+ scope: "global";
917
+ }
918
+ | undefined;
919
+ ```
920
+
921
+ #### Returns
922
+
923
+ \| \{
924
+ `action`: `"skip"` \| `"wait"`;
925
+ `scope`: `"global"`;
926
+ \}
927
+ \| `undefined`
928
+
929
+ ### Inherited from
930
+
931
+ ```ts
932
+ HttpBridge.reentrancy
933
+ ```
934
+
935
+ ***
936
+
937
+ ### statusReporter
938
+
939
+ ### Get Signature
940
+
941
+ ```ts
942
+ get statusReporter():
943
+ | ModuleStatusReporter & CreatableStatusReporter<void>
944
+ | undefined;
945
+ ```
946
+
947
+ The status reporter used to broadcast lifecycle changes.
948
+
949
+ #### Returns
950
+
951
+ \| `ModuleStatusReporter` & `CreatableStatusReporter`\<`void`\>
952
+ \| `undefined`
953
+
954
+ ### Inherited from
955
+
956
+ ```ts
957
+ HttpBridge.statusReporter
958
+ ```
959
+
960
+ ***
961
+
962
+ ### timestamp
963
+
964
+ ### Get Signature
965
+
966
+ ```ts
967
+ get timestamp(): boolean;
968
+ ```
969
+
970
+ #### Returns
971
+
972
+ `boolean`
973
+
974
+ ### Inherited from
975
+
976
+ ```ts
977
+ HttpBridge.timestamp
978
+ ```
979
+
980
+ ***
981
+
982
+ ### moduleConfigQueryValidator
983
+
984
+ ### Get Signature
985
+
986
+ ```ts
987
+ get protected moduleConfigQueryValidator(): Queryable;
988
+ ```
989
+
990
+ #### Returns
991
+
992
+ `Queryable`
993
+
994
+ ### Inherited from
995
+
996
+ ```ts
997
+ HttpBridge.moduleConfigQueryValidator
998
+ ```
999
+
1000
+ ***
1001
+
1002
+ ### supportedQueryValidator
1003
+
1004
+ ### Get Signature
1005
+
1006
+ ```ts
1007
+ get protected supportedQueryValidator(): Queryable;
1008
+ ```
1009
+
1010
+ #### Returns
1011
+
1012
+ `Queryable`
1013
+
1014
+ ### Inherited from
1015
+
1016
+ ```ts
1017
+ HttpBridge.supportedQueryValidator
1018
+ ```
1019
+
1020
+ ***
1021
+
1022
+ ### downResolver
1023
+
1024
+ ### Get Signature
1025
+
1026
+ ```ts
1027
+ get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
1028
+ ```
1029
+
1030
+ #### Returns
1031
+
1032
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
1033
+
1034
+ ### Inherited from
1035
+
1036
+ ```ts
1037
+ HttpBridge.downResolver
1038
+ ```
1039
+
1040
+ ***
1041
+
1042
+ ### modName
1043
+
1044
+ ### Get Signature
1045
+
1046
+ ```ts
1047
+ get modName(): string | undefined;
1048
+ ```
1049
+
1050
+ #### Returns
1051
+
1052
+ `string` \| `undefined`
1053
+
1054
+ ### Inherited from
1055
+
1056
+ ```ts
1057
+ HttpBridge.modName
1058
+ ```
1059
+
1060
+ ***
1061
+
1062
+ ### moduleIdentifierTransformers
1063
+
1064
+ ### Get Signature
1065
+
1066
+ ```ts
1067
+ get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
1068
+ ```
1069
+
1070
+ #### Returns
1071
+
1072
+ `ModuleIdentifierTransformer`[]
1073
+
1074
+ ### Inherited from
1075
+
1076
+ ```ts
1077
+ HttpBridge.moduleIdentifierTransformers
1078
+ ```
1079
+
1080
+ ***
1081
+
1082
+ ### privateResolver
1083
+
1084
+ ### Get Signature
1085
+
1086
+ ```ts
1087
+ get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
1088
+ ```
1089
+
1090
+ #### Returns
1091
+
1092
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
1093
+
1094
+ ### Inherited from
1095
+
1096
+ ```ts
1097
+ HttpBridge.privateResolver
1098
+ ```
1099
+
1100
+ ***
1101
+
1102
+ ### root
1103
+
1104
+ ### Get Signature
1105
+
1106
+ ```ts
1107
+ get root(): this;
1108
+ ```
1109
+
1110
+ #### Returns
1111
+
1112
+ `this`
1113
+
1114
+ ### Inherited from
1115
+
1116
+ ```ts
1117
+ HttpBridge.root
1118
+ ```
1119
+
1120
+ ***
1121
+
1122
+ ### timeBudget
1123
+
1124
+ ### Get Signature
1125
+
1126
+ ```ts
1127
+ get timeBudget(): number | undefined;
1128
+ ```
1129
+
1130
+ #### Returns
1131
+
1132
+ `number` \| `undefined`
1133
+
1134
+ ### Inherited from
1135
+
1136
+ ```ts
1137
+ HttpBridge.timeBudget
1138
+ ```
1139
+
1140
+ ***
1141
+
1142
+ ### upResolver
1143
+
1144
+ ### Get Signature
1145
+
1146
+ ```ts
1147
+ get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
1148
+ ```
1149
+
1150
+ #### Returns
1151
+
1152
+ `CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
1153
+
1154
+ ### Inherited from
1155
+
1156
+ ```ts
1157
+ HttpBridge.upResolver
1158
+ ```
1159
+
1160
+ ## Methods
1161
+
1162
+ ### expose()
1163
+
1164
+ ```ts
1165
+ expose(id, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
1166
+ ```
1167
+
1168
+ ### Parameters
1169
+
1170
+ #### id
1171
+
1172
+ `ModuleIdentifier`
1173
+
1174
+ #### options?
1175
+
1176
+ `BridgeExposeOptions`
1177
+
1178
+ ### Returns
1179
+
1180
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
1181
+
1182
+ ### Inherited from
1183
+
1184
+ ```ts
1185
+ HttpBridge.expose
1186
+ ```
1187
+
1188
+ ***
1189
+
1190
+ ### exposed()
1191
+
1192
+ ```ts
1193
+ exposed(): Promise<BrandedAddress[]>;
1194
+ ```
1195
+
1196
+ ### Returns
1197
+
1198
+ `Promise`\<`BrandedAddress`[]\>
1199
+
1200
+ ### Inherited from
1201
+
1202
+ ```ts
1203
+ HttpBridge.exposed
1204
+ ```
1205
+
1206
+ ***
1207
+
1208
+ ### ~~resolve()~~
1209
+
1210
+ ### Call Signature
1211
+
1212
+ ```ts
1213
+ resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
1214
+ ```
1215
+
1216
+ #### Returns
1217
+
1218
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
1219
+
1220
+ #### Deprecated
1221
+
1222
+ do not pass undefined. If trying to get all, pass '*'
1223
+
1224
+ #### Inherited from
1225
+
1226
+ ```ts
1227
+ HttpBridge.resolve
1228
+ ```
1229
+
1230
+ ### Call Signature
1231
+
1232
+ ```ts
1233
+ resolve<T>(all, options?): Promise<T[]>;
1234
+ ```
1235
+
1236
+ #### Type Parameters
1237
+
1238
+ ##### T
1239
+
1240
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1241
+
1242
+ #### Parameters
1243
+
1244
+ ##### all
1245
+
1246
+ `"*"`
1247
+
1248
+ ##### options?
1249
+
1250
+ `ModuleFilterOptions`\<`T`\>
1251
+
1252
+ #### Returns
1253
+
1254
+ `Promise`\<`T`[]\>
1255
+
1256
+ #### Deprecated
1257
+
1258
+ do not pass undefined. If trying to get all, pass '*'
1259
+
1260
+ #### Inherited from
1261
+
1262
+ ```ts
1263
+ HttpBridge.resolve
1264
+ ```
1265
+
1266
+ ### Call Signature
1267
+
1268
+ ```ts
1269
+ resolve<T>(id, options?): Promise<T | undefined>;
1270
+ ```
1271
+
1272
+ #### Type Parameters
1273
+
1274
+ ##### T
1275
+
1276
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1277
+
1278
+ #### Parameters
1279
+
1280
+ ##### id
1281
+
1282
+ `ModuleIdentifier`
1283
+
1284
+ ##### options?
1285
+
1286
+ `ModuleFilterOptions`\<`T`\>
1287
+
1288
+ #### Returns
1289
+
1290
+ `Promise`\<`T` \| `undefined`\>
1291
+
1292
+ #### Deprecated
1293
+
1294
+ do not pass undefined. If trying to get all, pass '*'
1295
+
1296
+ #### Inherited from
1297
+
1298
+ ```ts
1299
+ HttpBridge.resolve
1300
+ ```
1301
+
1302
+ ***
1303
+
1304
+ ### unexpose()
1305
+
1306
+ ```ts
1307
+ unexpose(id, options?): Promise<BrandedAddress[]>;
1308
+ ```
1309
+
1310
+ ### Parameters
1311
+
1312
+ #### id
1313
+
1314
+ `ModuleIdentifier`
1315
+
1316
+ #### options?
1317
+
1318
+ `BridgeUnexposeOptions`
1319
+
1320
+ ### Returns
1321
+
1322
+ `Promise`\<`BrandedAddress`[]\>
1323
+
1324
+ ### Inherited from
1325
+
1326
+ ```ts
1327
+ HttpBridge.unexpose
1328
+ ```
1329
+
1330
+ ***
1331
+
1332
+ ### queryHandler()
1333
+
1334
+ ```ts
1335
+ protected queryHandler<T>(query, payloads?): Promise<ModuleQueryHandlerResult>;
1336
+ ```
1337
+
1338
+ ### Type Parameters
1339
+
1340
+ #### T
1341
+
1342
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
1343
+
1344
+ ### Parameters
1345
+
1346
+ #### query
1347
+
1348
+ `T`
1349
+
1350
+ #### payloads?
1351
+
1352
+ `Payload`[]
1353
+
1354
+ ### Returns
1355
+
1356
+ `Promise`\<`ModuleQueryHandlerResult`\>
1357
+
1358
+ ### Inherited from
1359
+
1360
+ ```ts
1361
+ HttpBridge.queryHandler
1362
+ ```
1363
+
1364
+ ***
1365
+
1366
+ ### resolveArchivingArchivists()
1367
+
1368
+ ```ts
1369
+ protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
1370
+ ```
1371
+
1372
+ ### Returns
1373
+
1374
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
1375
+
1376
+ ### Inherited from
1377
+
1378
+ ```ts
1379
+ HttpBridge.resolveArchivingArchivists
1380
+ ```
1381
+
1382
+ ***
1383
+
1384
+ ### getRoots()
1385
+
1386
+ ```ts
1387
+ getRoots(force?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
1388
+ ```
1389
+
1390
+ ### Parameters
1391
+
1392
+ #### force?
1393
+
1394
+ `boolean`
1395
+
1396
+ ### Returns
1397
+
1398
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
1399
+
1400
+ ### Inherited from
1401
+
1402
+ ```ts
1403
+ HttpBridge.getRoots
1404
+ ```
1405
+
1406
+ ***
1407
+
1408
+ ### moduleUrl()
1409
+
1410
+ ```ts
1411
+ moduleUrl(address): URL;
1412
+ ```
1413
+
1414
+ ### Parameters
1415
+
1416
+ #### address
1417
+
1418
+ `BrandedAddress`
1419
+
1420
+ ### Returns
1421
+
1422
+ `URL`
1423
+
1424
+ ### Inherited from
1425
+
1426
+ ```ts
1427
+ HttpBridge.moduleUrl
1428
+ ```
1429
+
1430
+ ***
1431
+
1432
+ ### sendBridgeQuery()
1433
+
1434
+ ```ts
1435
+ sendBridgeQuery<TOut, TQuery, TIn>(
1436
+ targetAddress,
1437
+ query,
1438
+ payloads?): Promise<ModuleQueryResult<TOut>>;
1439
+ ```
1440
+
1441
+ ### Type Parameters
1442
+
1443
+ #### TOut
1444
+
1445
+ `TOut` *extends* `Payload` = `Payload`
1446
+
1447
+ #### TQuery
1448
+
1449
+ `TQuery` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
1450
+
1451
+ #### TIn
1452
+
1453
+ `TIn` *extends* `Payload` = `Payload`
1454
+
1455
+ ### Parameters
1456
+
1457
+ #### targetAddress
1458
+
1459
+ `BrandedAddress`
1460
+
1461
+ #### query
1462
+
1463
+ `TQuery`
1464
+
1465
+ #### payloads?
1466
+
1467
+ `TIn`[]
1468
+
1469
+ ### Returns
1470
+
1471
+ `Promise`\<`ModuleQueryResult`\<`TOut`\>\>
1472
+
1473
+ ### Inherited from
1474
+
1475
+ ```ts
1476
+ HttpBridge.sendBridgeQuery
1477
+ ```
1478
+
1479
+ ***
1480
+
1481
+ ### exposeChild()
1482
+
1483
+ ```ts
1484
+ exposeChild(mod, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
1485
+ ```
1486
+
1487
+ ### Parameters
1488
+
1489
+ #### mod
1490
+
1491
+ `ModuleInstance`
1492
+
1493
+ #### options?
1494
+
1495
+ `BridgeExposeOptions`
1496
+
1497
+ ### Returns
1498
+
1499
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
1500
+
1501
+ ***
1502
+
1503
+ ### exposeHandler()
1504
+
1505
+ ```ts
1506
+ exposeHandler(address, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
1507
+ ```
1508
+
1509
+ ### Parameters
1510
+
1511
+ #### address
1512
+
1513
+ `BrandedAddress`
1514
+
1515
+ #### options?
1516
+
1517
+ `BridgeExposeOptions`
1518
+
1519
+ ### Returns
1520
+
1521
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
1522
+
1523
+ ### Overrides
1524
+
1525
+ ```ts
1526
+ HttpBridge.exposeHandler
1527
+ ```
1528
+
1529
+ ***
1530
+
1531
+ ### exposedHandler()
1532
+
1533
+ ```ts
1534
+ exposedHandler(): BrandedAddress[];
1535
+ ```
1536
+
1537
+ ### Returns
1538
+
1539
+ `BrandedAddress`[]
1540
+
1541
+ ### Overrides
1542
+
1543
+ ```ts
1544
+ HttpBridge.exposedHandler
1545
+ ```
1546
+
1547
+ ***
1548
+
1549
+ ### startHandler()
1550
+
1551
+ ```ts
1552
+ startHandler(): Promise<void>;
1553
+ ```
1554
+
1555
+ ### Returns
1556
+
1557
+ `Promise`\<`void`\>
1558
+
1559
+ ### Overrides
1560
+
1561
+ ```ts
1562
+ HttpBridge.startHandler
1563
+ ```
1564
+
1565
+ ***
1566
+
1567
+ ### stopHandler()
1568
+
1569
+ ```ts
1570
+ stopHandler(_timeout?): Promise<void>;
1571
+ ```
1572
+
1573
+ ### Parameters
1574
+
1575
+ #### \_timeout?
1576
+
1577
+ `number`
1578
+
1579
+ ### Returns
1580
+
1581
+ `Promise`\<`void`\>
1582
+
1583
+ ### Overrides
1584
+
1585
+ ```ts
1586
+ HttpBridge.stopHandler
1587
+ ```
1588
+
1589
+ ***
1590
+
1591
+ ### unexposeHandler()
1592
+
1593
+ ```ts
1594
+ unexposeHandler(address, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
1595
+ ```
1596
+
1597
+ ### Parameters
1598
+
1599
+ #### address
1600
+
1601
+ `BrandedAddress`
1602
+
1603
+ #### options?
1604
+
1605
+ `BridgeUnexposeOptions`
1606
+
1607
+ ### Returns
1608
+
1609
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
1610
+
1611
+ ### Overrides
1612
+
1613
+ ```ts
1614
+ HttpBridge.unexposeHandler
1615
+ ```
1616
+
1617
+ ***
1618
+
1619
+ ### callLocalModule()
1620
+
1621
+ ```ts
1622
+ protected callLocalModule(
1623
+ address,
1624
+ query,
1625
+ payloads): Promise<ModuleQueryResult | null>;
1626
+ ```
1627
+
1628
+ ### Parameters
1629
+
1630
+ #### address
1631
+
1632
+ `BrandedAddress`
1633
+
1634
+ #### query
1635
+
1636
+ `UnsignedQueryBoundWitness`
1637
+
1638
+ #### payloads
1639
+
1640
+ `Payload`[]
1641
+
1642
+ ### Returns
1643
+
1644
+ `Promise`\<`ModuleQueryResult` \| `null`\>
1645
+
1646
+ ***
1647
+
1648
+ ### handleGet()
1649
+
1650
+ ```ts
1651
+ protected handleGet(req, res): Promise<void>;
1652
+ ```
1653
+
1654
+ ### Parameters
1655
+
1656
+ #### req
1657
+
1658
+ `Request`\<`AddressPathParams`, `ModuleQueryResult`, `PostAddressRequestBody`\>
1659
+
1660
+ #### res
1661
+
1662
+ `Response`
1663
+
1664
+ ### Returns
1665
+
1666
+ `Promise`\<`void`\>
1667
+
1668
+ ***
1669
+
1670
+ ### handlePost()
1671
+
1672
+ ```ts
1673
+ protected handlePost(req, res): Promise<Response<any, Record<string, any>> | undefined>;
1674
+ ```
1675
+
1676
+ ### Parameters
1677
+
1678
+ #### req
1679
+
1680
+ `Request`\<`AddressPathParams`, `ModuleQueryResult`, `PostAddressRequestBody`\>
1681
+
1682
+ #### res
1683
+
1684
+ `Response`
1685
+
1686
+ ### Returns
1687
+
1688
+ `Promise`\<`Response`\<`any`, `Record`\<`string`, `any`\>\> \| `undefined`\>
1689
+
1690
+ ***
1691
+
1692
+ ### initializeApp()
1693
+
1694
+ ```ts
1695
+ protected initializeApp(): Application;
1696
+ ```
1697
+
1698
+ ### Returns
1699
+
1700
+ `Application`
1701
+
1702
+ ***
1703
+
1704
+ ### startHttpServer()
1705
+
1706
+ ```ts
1707
+ protected startHttpServer(): Promise<boolean>;
1708
+ ```
1709
+
1710
+ ### Returns
1711
+
1712
+ `Promise`\<`boolean`\>
1713
+
1714
+ ***
1715
+
1716
+ ### stopHttpServer()
1717
+
1718
+ ```ts
1719
+ protected stopHttpServer(): Promise<boolean>;
1720
+ ```
1721
+
1722
+ ### Returns
1723
+
1724
+ `Promise`\<`boolean`\>
1725
+
1726
+ ***
1727
+
1728
+ ### \_getRootFunction()
1729
+
1730
+ ```ts
1731
+ static _getRootFunction(funcName): any;
1732
+ ```
1733
+
1734
+ ### Parameters
1735
+
1736
+ #### funcName
1737
+
1738
+ `string`
1739
+
1740
+ ### Returns
1741
+
1742
+ `any`
1743
+
1744
+ ### Inherited from
1745
+
1746
+ ```ts
1747
+ HttpBridge._getRootFunction
1748
+ ```
1749
+
1750
+ ***
1751
+
1752
+ ### \_noOverride()
1753
+
1754
+ ```ts
1755
+ static _noOverride(functionName): void;
1756
+ ```
1757
+
1758
+ ### Parameters
1759
+
1760
+ #### functionName
1761
+
1762
+ `string`
1763
+
1764
+ ### Returns
1765
+
1766
+ `void`
1767
+
1768
+ ### Inherited from
1769
+
1770
+ ```ts
1771
+ HttpBridge._noOverride
1772
+ ```
1773
+
1774
+ ***
1775
+
1776
+ ### createHandler()
1777
+
1778
+ ```ts
1779
+ static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;
1780
+ ```
1781
+
1782
+ Static hook called during creation to perform additional initialization.
1783
+ Override in subclasses to customize post-construction setup.
1784
+
1785
+ ### Type Parameters
1786
+
1787
+ #### T
1788
+
1789
+ `T` *extends* `CreatableInstance`\<`CreatableParams`, `EventData`\>
1790
+
1791
+ ### Parameters
1792
+
1793
+ #### inInstance
1794
+
1795
+ `T`
1796
+
1797
+ ### Returns
1798
+
1799
+ `Promise`\<`T` & `AbstractModule`\<`any`, `any`\>\>
1800
+
1801
+ The instance, potentially modified
1802
+
1803
+ ### Inherited from
1804
+
1805
+ ```ts
1806
+ HttpBridge.createHandler
1807
+ ```
1808
+
1809
+ ***
1810
+
1811
+ ### determineAccount()
1812
+
1813
+ ```ts
1814
+ static determineAccount(params): Promise<AccountInstance>;
1815
+ ```
1816
+
1817
+ ### Parameters
1818
+
1819
+ #### params
1820
+
1821
+ ##### account?
1822
+
1823
+ `AccountInstance` \| `"random"`
1824
+
1825
+ ##### accountPath?
1826
+
1827
+ `string`
1828
+
1829
+ ##### wallet?
1830
+
1831
+ `WalletInstance`
1832
+
1833
+ ### Returns
1834
+
1835
+ `Promise`\<`AccountInstance`\>
1836
+
1837
+ ### Inherited from
1838
+
1839
+ ```ts
1840
+ HttpBridge.determineAccount
1841
+ ```
1842
+
1843
+ ***
1844
+
1845
+ ### factory()
1846
+
1847
+ ```ts
1848
+ static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;
1849
+ ```
1850
+
1851
+ ### Type Parameters
1852
+
1853
+ #### TModule
1854
+
1855
+ `TModule` *extends* `CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1856
+
1857
+ ### Parameters
1858
+
1859
+ #### this
1860
+
1861
+ `CreatableModule`\<`TModule`\>
1862
+
1863
+ #### params?
1864
+
1865
+ `Partial`\<`TModule`\[`"params"`\]\>
1866
+
1867
+ ### Returns
1868
+
1869
+ `CreatableModuleFactory`\<`TModule`\>
1870
+
1871
+ ### Inherited from
1872
+
1873
+ ```ts
1874
+ HttpBridge.factory
1875
+ ```
1876
+
1877
+ ***
1878
+
1879
+ ### isAllowedSchema()
1880
+
1881
+ ```ts
1882
+ static isAllowedSchema(schema): boolean;
1883
+ ```
1884
+
1885
+ ### Parameters
1886
+
1887
+ #### schema
1888
+
1889
+ `Schema`
1890
+
1891
+ ### Returns
1892
+
1893
+ `boolean`
1894
+
1895
+ ### Inherited from
1896
+
1897
+ ```ts
1898
+ HttpBridge.isAllowedSchema
1899
+ ```
1900
+
1901
+ ***
1902
+
1903
+ ### paramsHandler()
1904
+
1905
+ ```ts
1906
+ static paramsHandler<T>(inParams?): Promise<T["params"]>;
1907
+ ```
1908
+
1909
+ Static hook called during creation to validate and transform params.
1910
+ Override in subclasses to add default values or validation.
1911
+
1912
+ ### Type Parameters
1913
+
1914
+ #### T
1915
+
1916
+ `T` *extends* `AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
1917
+
1918
+ ### Parameters
1919
+
1920
+ #### inParams?
1921
+
1922
+ `Partial`\<`T`\[`"params"`\]\>
1923
+
1924
+ ### Returns
1925
+
1926
+ `Promise`\<`T`\[`"params"`\]\>
1927
+
1928
+ The processed params ready for construction
1929
+
1930
+ ### Inherited from
1931
+
1932
+ ```ts
1933
+ HttpBridge.paramsHandler
1934
+ ```
1935
+
1936
+ ***
1937
+
1938
+ ### \_getRootFunction()
1939
+
1940
+ ```ts
1941
+ _getRootFunction(funcName): any;
1942
+ ```
1943
+
1944
+ ### Parameters
1945
+
1946
+ #### funcName
1947
+
1948
+ `string`
1949
+
1950
+ ### Returns
1951
+
1952
+ `any`
1953
+
1954
+ ### Inherited from
1955
+
1956
+ ```ts
1957
+ HttpBridge._getRootFunction
1958
+ ```
1959
+
1960
+ ***
1961
+
1962
+ ### busy()
1963
+
1964
+ ```ts
1965
+ busy<R>(closure): Promise<R>;
1966
+ ```
1967
+
1968
+ ### Type Parameters
1969
+
1970
+ #### R
1971
+
1972
+ `R`
1973
+
1974
+ ### Parameters
1975
+
1976
+ #### closure
1977
+
1978
+ () => `Promise`\<`R`\>
1979
+
1980
+ ### Returns
1981
+
1982
+ `Promise`\<`R`\>
1983
+
1984
+ ### Inherited from
1985
+
1986
+ ```ts
1987
+ HttpBridge.busy
1988
+ ```
1989
+
1990
+ ***
1991
+
1992
+ ### emit()
1993
+
1994
+ ```ts
1995
+ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
1996
+ ```
1997
+
1998
+ Emits an event, invoking all registered listeners concurrently.
1999
+
2000
+ ### Type Parameters
2001
+
2002
+ #### TEventName
2003
+
2004
+ `TEventName` *extends* keyof `BridgeModuleEventData` = keyof `BridgeModuleEventData`
2005
+
2006
+ #### TEventArgs
2007
+
2008
+ `TEventArgs` *extends* `EventArgs` = `BridgeModuleEventData`\[`TEventName`\]
2009
+
2010
+ ### Parameters
2011
+
2012
+ #### eventName
2013
+
2014
+ `TEventName`
2015
+
2016
+ The event to emit.
2017
+
2018
+ #### eventArgs
2019
+
2020
+ `TEventArgs`
2021
+
2022
+ The data to pass to listeners.
2023
+
2024
+ ### Returns
2025
+
2026
+ `Promise`\<`void`\>
2027
+
2028
+ ### Inherited from
2029
+
2030
+ ```ts
2031
+ HttpBridge.emit
2032
+ ```
2033
+
2034
+ ***
2035
+
2036
+ ### isSupportedQuery()
2037
+
2038
+ ```ts
2039
+ isSupportedQuery(query, assert?): boolean;
2040
+ ```
2041
+
2042
+ ### Parameters
2043
+
2044
+ #### query
2045
+
2046
+ `Schema`
2047
+
2048
+ #### assert?
2049
+
2050
+ `string` \| `boolean`
2051
+
2052
+ ### Returns
2053
+
2054
+ `boolean`
2055
+
2056
+ ### Inherited from
2057
+
2058
+ ```ts
2059
+ HttpBridge.isSupportedQuery
2060
+ ```
2061
+
2062
+ ***
2063
+
2064
+ ### previousHash()
2065
+
2066
+ ```ts
2067
+ previousHash(): Promisable<string | undefined>;
2068
+ ```
2069
+
2070
+ ### Returns
2071
+
2072
+ `Promisable`\<`string` \| `undefined`\>
2073
+
2074
+ ### Inherited from
2075
+
2076
+ ```ts
2077
+ HttpBridge.previousHash
2078
+ ```
2079
+
2080
+ ***
2081
+
2082
+ ### query()
2083
+
2084
+ ```ts
2085
+ query<T, TConfig>(
2086
+ query,
2087
+ payloads?,
2088
+ queryConfig?): Promise<ModuleQueryResult>;
2089
+ ```
2090
+
2091
+ ### Type Parameters
2092
+
2093
+ #### T
2094
+
2095
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
2096
+
2097
+ #### TConfig
2098
+
2099
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
2100
+
2101
+ ### Parameters
2102
+
2103
+ #### query
2104
+
2105
+ `T`
2106
+
2107
+ #### payloads?
2108
+
2109
+ `Payload`[]
2110
+
2111
+ #### queryConfig?
2112
+
2113
+ `TConfig`
2114
+
2115
+ ### Returns
2116
+
2117
+ `Promise`\<`ModuleQueryResult`\>
2118
+
2119
+ ### Inherited from
2120
+
2121
+ ```ts
2122
+ HttpBridge.query
2123
+ ```
2124
+
2125
+ ***
2126
+
2127
+ ### queryable()
2128
+
2129
+ ```ts
2130
+ queryable<T, TConfig>(
2131
+ query,
2132
+ payloads?,
2133
+ queryConfig?): Promise<boolean>;
2134
+ ```
2135
+
2136
+ ### Type Parameters
2137
+
2138
+ #### T
2139
+
2140
+ `T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
2141
+
2142
+ #### TConfig
2143
+
2144
+ `TConfig` *extends* `ModuleConfig` = `ModuleConfig`
2145
+
2146
+ ### Parameters
2147
+
2148
+ #### query
2149
+
2150
+ `T`
2151
+
2152
+ #### payloads?
2153
+
2154
+ `Payload`[]
2155
+
2156
+ #### queryConfig?
2157
+
2158
+ `TConfig`
2159
+
2160
+ ### Returns
2161
+
2162
+ `Promise`\<`boolean`\>
2163
+
2164
+ ### Inherited from
2165
+
2166
+ ```ts
2167
+ HttpBridge.queryable
2168
+ ```
2169
+
2170
+ ***
2171
+
2172
+ ### \_checkDead()
2173
+
2174
+ ```ts
2175
+ protected _checkDead(): void;
2176
+ ```
2177
+
2178
+ ### Returns
2179
+
2180
+ `void`
2181
+
2182
+ ### Inherited from
2183
+
2184
+ ```ts
2185
+ HttpBridge._checkDead
2186
+ ```
2187
+
2188
+ ***
2189
+
2190
+ ### archivistInstance()
2191
+
2192
+ ### Call Signature
2193
+
2194
+ ```ts
2195
+ protected archivistInstance(): Promise<
2196
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
2197
+ | undefined>;
2198
+ ```
2199
+
2200
+ #### Returns
2201
+
2202
+ `Promise`\<
2203
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
2204
+ \| `undefined`\>
2205
+
2206
+ #### Inherited from
2207
+
2208
+ ```ts
2209
+ HttpBridge.archivistInstance
2210
+ ```
2211
+
2212
+ ### Call Signature
2213
+
2214
+ ```ts
2215
+ protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
2216
+ ```
2217
+
2218
+ #### Parameters
2219
+
2220
+ ##### required
2221
+
2222
+ `true`
2223
+
2224
+ #### Returns
2225
+
2226
+ `Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
2227
+
2228
+ #### Inherited from
2229
+
2230
+ ```ts
2231
+ HttpBridge.archivistInstance
2232
+ ```
2233
+
2234
+ ***
2235
+
2236
+ ### bindHashes()
2237
+
2238
+ ```ts
2239
+ protected bindHashes(
2240
+ hashes,
2241
+ schema,
2242
+ account?): PromiseEx<unknown, AccountInstance>;
2243
+ ```
2244
+
2245
+ ### Parameters
2246
+
2247
+ #### hashes
2248
+
2249
+ `BrandedHash`[]
2250
+
2251
+ #### schema
2252
+
2253
+ `Schema`[]
2254
+
2255
+ #### account?
2256
+
2257
+ `AccountInstance`
2258
+
2259
+ ### Returns
2260
+
2261
+ `PromiseEx`\<`unknown`, `AccountInstance`\>
2262
+
2263
+ ### Inherited from
2264
+
2265
+ ```ts
2266
+ HttpBridge.bindHashes
2267
+ ```
2268
+
2269
+ ***
2270
+
2271
+ ### bindHashesInternal()
2272
+
2273
+ ```ts
2274
+ protected bindHashesInternal(
2275
+ hashes,
2276
+ schema,
2277
+ account?): Promise<{
2278
+ schema: "network.xyo.boundwitness" & object;
2279
+ addresses: Lowercase<string> & object & object[];
2280
+ payload_hashes: BrandedHash[];
2281
+ payload_schemas: BrandedSchema<string>[];
2282
+ previous_hashes: (BrandedHash | null)[];
2283
+ $destination?: Lowercase<string> & object & object;
2284
+ $sourceQuery?: BrandedHash;
2285
+ $signatures: (BrandedHex | null)[];
2286
+ }>;
2287
+ ```
2288
+
2289
+ ### Parameters
2290
+
2291
+ #### hashes
2292
+
2293
+ `BrandedHash`[]
2294
+
2295
+ #### schema
2296
+
2297
+ `Schema`[]
2298
+
2299
+ #### account?
2300
+
2301
+ `AccountInstance`
2302
+
2303
+ ### Returns
2304
+
2305
+ `Promise`\<\{
2306
+ `schema`: `"network.xyo.boundwitness"` & `object`;
2307
+ `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
2308
+ `payload_hashes`: `BrandedHash`[];
2309
+ `payload_schemas`: `BrandedSchema`\<`string`\>[];
2310
+ `previous_hashes`: (`BrandedHash` \| `null`)[];
2311
+ `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
2312
+ `$sourceQuery?`: `BrandedHash`;
2313
+ `$signatures`: (`BrandedHex` \| `null`)[];
2314
+ \}\>
2315
+
2316
+ ### Inherited from
2317
+
2318
+ ```ts
2319
+ HttpBridge.bindHashesInternal
2320
+ ```
2321
+
2322
+ ***
2323
+
2324
+ ### bindQuery()
2325
+
2326
+ ```ts
2327
+ protected bindQuery<T>(
2328
+ query,
2329
+ payloads?,
2330
+ account?,
2331
+ additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;
2332
+ ```
2333
+
2334
+ ### Type Parameters
2335
+
2336
+ #### T
2337
+
2338
+ `T` *extends* `Query`
2339
+
2340
+ ### Parameters
2341
+
2342
+ #### query
2343
+
2344
+ `T`
2345
+
2346
+ #### payloads?
2347
+
2348
+ `Payload`[]
2349
+
2350
+ #### account?
2351
+
2352
+ `AccountInstance`
2353
+
2354
+ #### additionalSigners?
2355
+
2356
+ `AccountInstance`[]
2357
+
2358
+ ### Returns
2359
+
2360
+ `PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\], `AccountInstance`\>
2361
+
2362
+ ### Inherited from
2363
+
2364
+ ```ts
2365
+ HttpBridge.bindQuery
2366
+ ```
2367
+
2368
+ ***
2369
+
2370
+ ### bindQueryInternal()
2371
+
2372
+ ```ts
2373
+ protected bindQueryInternal<T>(
2374
+ query,
2375
+ payloads?,
2376
+ account?,
2377
+ additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;
2378
+ ```
2379
+
2380
+ ### Type Parameters
2381
+
2382
+ #### T
2383
+
2384
+ `T` *extends* `Query`
2385
+
2386
+ ### Parameters
2387
+
2388
+ #### query
2389
+
2390
+ `T`
2391
+
2392
+ #### payloads?
2393
+
2394
+ `Payload`[]
2395
+
2396
+ #### account?
2397
+
2398
+ `AccountInstance`
2399
+
2400
+ #### additionalSigners?
2401
+
2402
+ `AccountInstance`[]
2403
+
2404
+ ### Returns
2405
+
2406
+ `Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\]\>
2407
+
2408
+ ### Inherited from
2409
+
2410
+ ```ts
2411
+ HttpBridge.bindQueryInternal
2412
+ ```
2413
+
2414
+ ***
2415
+
2416
+ ### bindQueryResult()
2417
+
2418
+ ```ts
2419
+ protected bindQueryResult<T>(
2420
+ query,
2421
+ payloads,
2422
+ additionalWitnesses?,
2423
+ errors?): Promise<ModuleQueryResult>;
2424
+ ```
2425
+
2426
+ ### Type Parameters
2427
+
2428
+ #### T
2429
+
2430
+ `T` *extends* `Query`
2431
+
2432
+ ### Parameters
2433
+
2434
+ #### query
2435
+
2436
+ `T`
2437
+
2438
+ #### payloads
2439
+
2440
+ `Payload`[]
2441
+
2442
+ #### additionalWitnesses?
2443
+
2444
+ `AccountInstance`[]
2445
+
2446
+ #### errors?
2447
+
2448
+ `ModuleError`[]
2449
+
2450
+ ### Returns
2451
+
2452
+ `Promise`\<`ModuleQueryResult`\>
2453
+
2454
+ ### Inherited from
2455
+
2456
+ ```ts
2457
+ HttpBridge.bindQueryResult
2458
+ ```
2459
+
2460
+ ***
2461
+
2462
+ ### generateConfigAndAddress()
2463
+
2464
+ ```ts
2465
+ protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
2466
+ ```
2467
+
2468
+ ### Parameters
2469
+
2470
+ #### \_maxDepth?
2471
+
2472
+ `number`
2473
+
2474
+ ### Returns
2475
+
2476
+ `Promisable`\<`Payload`[]\>
2477
+
2478
+ ### Inherited from
2479
+
2480
+ ```ts
2481
+ HttpBridge.generateConfigAndAddress
2482
+ ```
2483
+
2484
+ ***
2485
+
2486
+ ### generateDescribe()
2487
+
2488
+ ```ts
2489
+ protected generateDescribe(): Promise<ModuleDescriptionPayload>;
2490
+ ```
2491
+
2492
+ ### Returns
2493
+
2494
+ `Promise`\<`ModuleDescriptionPayload`\>
2495
+
2496
+ ### Inherited from
2497
+
2498
+ ```ts
2499
+ HttpBridge.generateDescribe
2500
+ ```
2501
+
2502
+ ***
2503
+
2504
+ ### ~~getArchivist()~~
2505
+
2506
+ ```ts
2507
+ protected getArchivist(): Promise<
2508
+ | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
2509
+ | undefined>;
2510
+ ```
2511
+
2512
+ ### Returns
2513
+
2514
+ `Promise`\<
2515
+ \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
2516
+ \| `undefined`\>
2517
+
2518
+ ### Deprecated
2519
+
2520
+ use archivistInstance() instead
2521
+
2522
+ ### Inherited from
2523
+
2524
+ ```ts
2525
+ HttpBridge.getArchivist
2526
+ ```
2527
+
2528
+ ***
2529
+
2530
+ ### isAllowedArchivingQuery()
2531
+
2532
+ ```ts
2533
+ protected isAllowedArchivingQuery(schema): boolean;
2534
+ ```
2535
+
2536
+ ### Parameters
2537
+
2538
+ #### schema
2539
+
2540
+ `Schema`
2541
+
2542
+ ### Returns
2543
+
2544
+ `boolean`
2545
+
2546
+ ### Inherited from
2547
+
2548
+ ```ts
2549
+ HttpBridge.isAllowedArchivingQuery
2550
+ ```
2551
+
2552
+ ***
2553
+
2554
+ ### moduleAddressHandler()
2555
+
2556
+ ```ts
2557
+ protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
2558
+ ```
2559
+
2560
+ ### Returns
2561
+
2562
+ `Promisable`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
2563
+
2564
+ ### Inherited from
2565
+
2566
+ ```ts
2567
+ HttpBridge.moduleAddressHandler
2568
+ ```
2569
+
2570
+ ***
2571
+
2572
+ ### stateHandler()
2573
+
2574
+ ```ts
2575
+ protected stateHandler(): Promise<Payload[]>;
2576
+ ```
2577
+
2578
+ ### Returns
2579
+
2580
+ `Promise`\<`Payload`[]\>
2581
+
2582
+ ### Inherited from
2583
+
2584
+ ```ts
2585
+ HttpBridge.stateHandler
2586
+ ```
2587
+
2588
+ ***
2589
+
2590
+ ### subscribeHandler()
2591
+
2592
+ ```ts
2593
+ protected subscribeHandler(): void;
2594
+ ```
2595
+
2596
+ ### Returns
2597
+
2598
+ `void`
2599
+
2600
+ ### Inherited from
2601
+
2602
+ ```ts
2603
+ HttpBridge.subscribeHandler
2604
+ ```
2605
+
2606
+ ***
2607
+
2608
+ ### validateConfig()
2609
+
2610
+ ```ts
2611
+ protected validateConfig(config?, parents?): boolean;
2612
+ ```
2613
+
2614
+ ### Parameters
2615
+
2616
+ #### config?
2617
+
2618
+ `unknown`
2619
+
2620
+ #### parents?
2621
+
2622
+ `string`[]
2623
+
2624
+ ### Returns
2625
+
2626
+ `boolean`
2627
+
2628
+ ### Inherited from
2629
+
2630
+ ```ts
2631
+ HttpBridge.validateConfig
2632
+ ```
2633
+
2634
+ ***
2635
+
2636
+ ### addParent()
2637
+
2638
+ ```ts
2639
+ addParent(mod): void;
2640
+ ```
2641
+
2642
+ ### Parameters
2643
+
2644
+ #### mod
2645
+
2646
+ `ModuleInstance`
2647
+
2648
+ ### Returns
2649
+
2650
+ `void`
2651
+
2652
+ ### Inherited from
2653
+
2654
+ ```ts
2655
+ HttpBridge.addParent
2656
+ ```
2657
+
2658
+ ***
2659
+
2660
+ ### certifyParents()
2661
+
2662
+ ```ts
2663
+ certifyParents(): Promise<Payload[]>;
2664
+ ```
2665
+
2666
+ ### Returns
2667
+
2668
+ `Promise`\<`Payload`[]\>
2669
+
2670
+ ### Inherited from
2671
+
2672
+ ```ts
2673
+ HttpBridge.certifyParents
2674
+ ```
2675
+
2676
+ ***
2677
+
2678
+ ### createHandler()
2679
+
2680
+ ```ts
2681
+ createHandler(): Promise<void>;
2682
+ ```
2683
+
2684
+ ### Returns
2685
+
2686
+ `Promise`\<`void`\>
2687
+
2688
+ ### Inherited from
2689
+
2690
+ ```ts
2691
+ HttpBridge.createHandler
2692
+ ```
2693
+
2694
+ ***
2695
+
2696
+ ### manifest()
2697
+
2698
+ ```ts
2699
+ manifest(maxDepth?): Promise<ModuleManifestPayload>;
2700
+ ```
2701
+
2702
+ ### Parameters
2703
+
2704
+ #### maxDepth?
2705
+
2706
+ `number`
2707
+
2708
+ ### Returns
2709
+
2710
+ `Promise`\<`ModuleManifestPayload`\>
2711
+
2712
+ ### Inherited from
2713
+
2714
+ ```ts
2715
+ HttpBridge.manifest
2716
+ ```
2717
+
2718
+ ***
2719
+
2720
+ ### manifestQuery()
2721
+
2722
+ ```ts
2723
+ manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
2724
+ ```
2725
+
2726
+ ### Parameters
2727
+
2728
+ #### account
2729
+
2730
+ `AccountInstance`
2731
+
2732
+ #### maxDepth?
2733
+
2734
+ `number`
2735
+
2736
+ ### Returns
2737
+
2738
+ `Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
2739
+
2740
+ ### Inherited from
2741
+
2742
+ ```ts
2743
+ HttpBridge.manifestQuery
2744
+ ```
2745
+
2746
+ ***
2747
+
2748
+ ### moduleAddress()
2749
+
2750
+ ```ts
2751
+ moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
2752
+ ```
2753
+
2754
+ ### Returns
2755
+
2756
+ `Promise`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
2757
+
2758
+ ### Inherited from
2759
+
2760
+ ```ts
2761
+ HttpBridge.moduleAddress
2762
+ ```
2763
+
2764
+ ***
2765
+
2766
+ ### parents()
2767
+
2768
+ ```ts
2769
+ parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
2770
+ ```
2771
+
2772
+ ### Returns
2773
+
2774
+ `Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
2775
+
2776
+ ### Inherited from
2777
+
2778
+ ```ts
2779
+ HttpBridge.parents
2780
+ ```
2781
+
2782
+ ***
2783
+
2784
+ ### privateChildren()
2785
+
2786
+ ```ts
2787
+ privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2788
+ ```
2789
+
2790
+ ### Returns
2791
+
2792
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2793
+
2794
+ ### Inherited from
2795
+
2796
+ ```ts
2797
+ HttpBridge.privateChildren
2798
+ ```
2799
+
2800
+ ***
2801
+
2802
+ ### publicChildren()
2803
+
2804
+ ```ts
2805
+ publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2806
+ ```
2807
+
2808
+ ### Returns
2809
+
2810
+ `Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2811
+
2812
+ ### Inherited from
2813
+
2814
+ ```ts
2815
+ HttpBridge.publicChildren
2816
+ ```
2817
+
2818
+ ***
2819
+
2820
+ ### removeParent()
2821
+
2822
+ ```ts
2823
+ removeParent(address): void;
2824
+ ```
2825
+
2826
+ ### Parameters
2827
+
2828
+ #### address
2829
+
2830
+ `BrandedAddress`
2831
+
2832
+ ### Returns
2833
+
2834
+ `void`
2835
+
2836
+ ### Inherited from
2837
+
2838
+ ```ts
2839
+ HttpBridge.removeParent
2840
+ ```
2841
+
2842
+ ***
2843
+
2844
+ ### resolveIdentifier()
2845
+
2846
+ ```ts
2847
+ resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
2848
+ ```
2849
+
2850
+ ### Parameters
2851
+
2852
+ #### id
2853
+
2854
+ `ModuleIdentifier`
2855
+
2856
+ #### options?
2857
+
2858
+ `ObjectFilterOptions`\<`AnyObject`\>
2859
+
2860
+ ### Returns
2861
+
2862
+ `Promise`\<`BrandedAddress` \| `undefined`\>
2863
+
2864
+ ### Inherited from
2865
+
2866
+ ```ts
2867
+ HttpBridge.resolveIdentifier
2868
+ ```
2869
+
2870
+ ***
2871
+
2872
+ ### resolvePrivate()
2873
+
2874
+ ### Call Signature
2875
+
2876
+ ```ts
2877
+ resolvePrivate<T>(all, options?): Promise<T[]>;
2878
+ ```
2879
+
2880
+ #### Type Parameters
2881
+
2882
+ ##### T
2883
+
2884
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2885
+
2886
+ #### Parameters
2887
+
2888
+ ##### all
2889
+
2890
+ `"*"`
2891
+
2892
+ ##### options?
2893
+
2894
+ `ModuleFilterOptions`\<`T`\>
2895
+
2896
+ #### Returns
2897
+
2898
+ `Promise`\<`T`[]\>
2899
+
2900
+ #### Inherited from
2901
+
2902
+ ```ts
2903
+ HttpBridge.resolvePrivate
2904
+ ```
2905
+
2906
+ ### Call Signature
2907
+
2908
+ ```ts
2909
+ resolvePrivate<T>(id, options?): Promise<T | undefined>;
2910
+ ```
2911
+
2912
+ #### Type Parameters
2913
+
2914
+ ##### T
2915
+
2916
+ `T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
2917
+
2918
+ #### Parameters
2919
+
2920
+ ##### id
2921
+
2922
+ `ModuleIdentifier`
2923
+
2924
+ ##### options?
2925
+
2926
+ `ModuleFilterOptions`\<`T`\>
2927
+
2928
+ #### Returns
2929
+
2930
+ `Promise`\<`T` \| `undefined`\>
2931
+
2932
+ #### Inherited from
2933
+
2934
+ ```ts
2935
+ HttpBridge.resolvePrivate
2936
+ ```
2937
+
2938
+ ***
2939
+
2940
+ ### siblings()
2941
+
2942
+ ```ts
2943
+ siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
2944
+ ```
2945
+
2946
+ ### Returns
2947
+
2948
+ `Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
2949
+
2950
+ ### Inherited from
2951
+
2952
+ ```ts
2953
+ HttpBridge.siblings
2954
+ ```
2955
+
2956
+ ***
2957
+
2958
+ ### state()
2959
+
2960
+ ```ts
2961
+ state(): Promise<Payload[]>;
2962
+ ```
2963
+
2964
+ ### Returns
2965
+
2966
+ `Promise`\<`Payload`[]\>
2967
+
2968
+ ### Inherited from
2969
+
2970
+ ```ts
2971
+ HttpBridge.state
2972
+ ```
2973
+
2974
+ ***
2975
+
2976
+ ### stateQuery()
2977
+
2978
+ ```ts
2979
+ stateQuery(account): Promise<ModuleQueryResult>;
2980
+ ```
2981
+
2982
+ ### Parameters
2983
+
2984
+ #### account
2985
+
2986
+ `AccountInstance`
2987
+
2988
+ ### Returns
2989
+
2990
+ `Promise`\<`ModuleQueryResult`\>
2991
+
2992
+ ### Inherited from
2993
+
2994
+ ```ts
2995
+ HttpBridge.stateQuery
2996
+ ```
2997
+
2998
+ ***
2999
+
3000
+ ### subscribe()
3001
+
3002
+ ```ts
3003
+ subscribe(_queryAccount?): void;
3004
+ ```
3005
+
3006
+ ### Parameters
3007
+
3008
+ #### \_queryAccount?
3009
+
3010
+ `AccountInstance`
3011
+
3012
+ ### Returns
3013
+
3014
+ `void`
3015
+
3016
+ ### Inherited from
3017
+
3018
+ ```ts
3019
+ HttpBridge.subscribe
3020
+ ```
3021
+
3022
+ ***
3023
+
3024
+ ### manifestHandler()
3025
+
3026
+ ```ts
3027
+ protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
3028
+ ```
3029
+
3030
+ ### Parameters
3031
+
3032
+ #### maxDepth?
3033
+
3034
+ `number`
3035
+
3036
+ #### \_ignoreAddresses?
3037
+
3038
+ `BrandedAddress`[]
3039
+
3040
+ ### Returns
3041
+
3042
+ `Promise`\<`ModuleManifestPayload`\>
3043
+
3044
+ ### Inherited from
3045
+
3046
+ ```ts
3047
+ HttpBridge.manifestHandler
3048
+ ```
3049
+
3050
+ ***
3051
+
3052
+ ### sendQuery()
3053
+
3054
+ ```ts
3055
+ protected sendQuery<T, P, R>(
3056
+ queryPayload,
3057
+ payloads?,
3058
+ account?): Promise<R[]>;
3059
+ ```
3060
+
3061
+ ### Type Parameters
3062
+
3063
+ #### T
3064
+
3065
+ `T` *extends* `Query`
3066
+
3067
+ #### P
3068
+
3069
+ `P` *extends* `Payload` = `Payload`
3070
+
3071
+ #### R
3072
+
3073
+ `R` *extends* `Payload` = `Payload`
3074
+
3075
+ ### Parameters
3076
+
3077
+ #### queryPayload
3078
+
3079
+ `T`
3080
+
3081
+ #### payloads?
3082
+
3083
+ `P`[]
3084
+
3085
+ #### account?
3086
+
3087
+ `AccountInstance`
3088
+
3089
+ ### Returns
3090
+
3091
+ `Promise`\<`R`[]\>
3092
+
3093
+ ### Inherited from
3094
+
3095
+ ```ts
3096
+ HttpBridge.sendQuery
3097
+ ```
3098
+
3099
+ ***
3100
+
3101
+ ### sendQueryRaw()
3102
+
3103
+ ```ts
3104
+ protected sendQueryRaw<T, P, R>(
3105
+ queryPayload,
3106
+ payloads?,
3107
+ account?): Promise<ModuleQueryResult<R>>;
3108
+ ```
3109
+
3110
+ ### Type Parameters
3111
+
3112
+ #### T
3113
+
3114
+ `T` *extends* `Query`
3115
+
3116
+ #### P
3117
+
3118
+ `P` *extends* `Payload` = `Payload`
3119
+
3120
+ #### R
3121
+
3122
+ `R` *extends* `Payload` = `Payload`
3123
+
3124
+ ### Parameters
3125
+
3126
+ #### queryPayload
3127
+
3128
+ `T`
3129
+
3130
+ #### payloads?
3131
+
3132
+ `P`[]
3133
+
3134
+ #### account?
3135
+
3136
+ `AccountInstance`
3137
+
3138
+ ### Returns
3139
+
3140
+ `Promise`\<`ModuleQueryResult`\<`R`\>\>
3141
+
3142
+ ### Inherited from
3143
+
3144
+ ```ts
3145
+ HttpBridge.sendQueryRaw
3146
+ ```
3147
+
3148
+ ***
3149
+
3150
+ ### storeToArchivists()
3151
+
3152
+ ```ts
3153
+ protected storeToArchivists(payloads): Promise<Payload[]>;
3154
+ ```
3155
+
3156
+ ### Parameters
3157
+
3158
+ #### payloads
3159
+
3160
+ `Payload`[]
3161
+
3162
+ ### Returns
3163
+
3164
+ `Promise`\<`Payload`[]\>
3165
+
3166
+ ### Inherited from
3167
+
3168
+ ```ts
3169
+ HttpBridge.storeToArchivists
3170
+ ```
3171
+
3172
+ ### interfaces
3173
+
3174
+ ### <a id="HttpBridgeExpressConfig"></a>HttpBridgeExpressConfig
3175
+
3176
+ [**@xyo-network/bridge-http-express**](#../README)
3177
+
3178
+ ***
3179
+
3180
+ ## Extends
3181
+
3182
+ - `HttpBridgeConfig`\<\{
3183
+ \}, [`HttpBridgeExpressConfigSchema`](#../type-aliases/HttpBridgeExpressConfigSchema)\>
3184
+
3185
+ ## Properties
3186
+
3187
+ ### failureRetryTime?
3188
+
3189
+ ```ts
3190
+ optional failureRetryTime?: number;
3191
+ ```
3192
+
3193
+ ### Inherited from
3194
+
3195
+ ```ts
3196
+ HttpBridgeConfig.failureRetryTime
3197
+ ```
3198
+
3199
+ ***
3200
+
3201
+ ### failureTimeCacheMax?
3202
+
3203
+ ```ts
3204
+ optional failureTimeCacheMax?: number;
3205
+ ```
3206
+
3207
+ ### Inherited from
3208
+
3209
+ ```ts
3210
+ HttpBridgeConfig.failureTimeCacheMax
3211
+ ```
3212
+
3213
+ ***
3214
+
3215
+ ### maxConnections?
3216
+
3217
+ ```ts
3218
+ optional maxConnections?: number;
3219
+ ```
3220
+
3221
+ ### Inherited from
3222
+
3223
+ ```ts
3224
+ HttpBridgeConfig.maxConnections
3225
+ ```
3226
+
3227
+ ***
3228
+
3229
+ ### maxPayloadSizeWarning?
3230
+
3231
+ ```ts
3232
+ optional maxPayloadSizeWarning?: number;
3233
+ ```
3234
+
3235
+ ### Inherited from
3236
+
3237
+ ```ts
3238
+ HttpBridgeConfig.maxPayloadSizeWarning
3239
+ ```
3240
+
3241
+ ***
3242
+
3243
+ ### client?
3244
+
3245
+ ```ts
3246
+ optional client?: BridgeClientConfig & object;
3247
+ ```
3248
+
3249
+ ### Type Declaration
3250
+
3251
+ #### url
3252
+
3253
+ ```ts
3254
+ url: string;
3255
+ ```
3256
+
3257
+ ### Inherited from
3258
+
3259
+ ```ts
3260
+ HttpBridgeConfig.client
3261
+ ```
3262
+
3263
+ ***
3264
+
3265
+ ### host?
3266
+
3267
+ ```ts
3268
+ optional host?: BridgeHostConfig & object;
3269
+ ```
3270
+
3271
+ ### Type Declaration
3272
+
3273
+ #### port
3274
+
3275
+ ```ts
3276
+ port: number;
3277
+ ```
3278
+
3279
+ ### Inherited from
3280
+
3281
+ ```ts
3282
+ HttpBridgeConfig.host
3283
+ ```
3284
+
3285
+ ***
3286
+
3287
+ ### archiving?
3288
+
3289
+ ```ts
3290
+ readonly optional archiving?: object;
3291
+ ```
3292
+
3293
+ ### archivists?
3294
+
3295
+ ```ts
3296
+ readonly optional archivists?: ModuleIdentifier[];
3297
+ ```
3298
+
3299
+ ### queries?
3300
+
3301
+ ```ts
3302
+ readonly optional queries?: Schema[];
3303
+ ```
3304
+
3305
+ ### Inherited from
3306
+
3307
+ ```ts
3308
+ HttpBridgeConfig.archiving
3309
+ ```
3310
+
3311
+ ***
3312
+
3313
+ ### allowedQueries?
3314
+
3315
+ ```ts
3316
+ readonly optional allowedQueries?: Schema[];
3317
+ ```
3318
+
3319
+ Limit to only these allowed queries
3320
+
3321
+ ### Inherited from
3322
+
3323
+ ```ts
3324
+ HttpBridgeConfig.allowedQueries
3325
+ ```
3326
+
3327
+ ***
3328
+
3329
+ ### archivist?
3330
+
3331
+ ```ts
3332
+ readonly optional archivist?: ModuleIdentifier;
3333
+ ```
3334
+
3335
+ ### Field
3336
+
3337
+ The name/address of the Archivist to use for this module
3338
+
3339
+ ### Inherited from
3340
+
3341
+ ```ts
3342
+ HttpBridgeConfig.archivist
3343
+ ```
3344
+
3345
+ ***
3346
+
3347
+ ### labels?
3348
+
3349
+ ```ts
3350
+ readonly optional labels?: Labels;
3351
+ ```
3352
+
3353
+ ### Field
3354
+
3355
+ The labels used for this module. If a label is specified, then the
3356
+ ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
3357
+ labels to construct this module.
3358
+
3359
+ ### Inherited from
3360
+
3361
+ ```ts
3362
+ HttpBridgeConfig.labels
3363
+ ```
3364
+
3365
+ ***
3366
+
3367
+ ### logLevel?
3368
+
3369
+ ```ts
3370
+ readonly optional logLevel?: LogLevelValue;
3371
+ ```
3372
+
3373
+ ### Inherited from
3374
+
3375
+ ```ts
3376
+ HttpBridgeConfig.logLevel
3377
+ ```
3378
+
3379
+ ***
3380
+
3381
+ ### name?
3382
+
3383
+ ```ts
3384
+ readonly optional name?: string;
3385
+ ```
3386
+
3387
+ ### Field
3388
+
3389
+ Friendly name of module (not collision resistant). Can be used to resolve module when registered/attached to Node.
3390
+
3391
+ ### Inherited from
3392
+
3393
+ ```ts
3394
+ HttpBridgeConfig.name
3395
+ ```
3396
+
3397
+ ***
3398
+
3399
+ ### paging?
3400
+
3401
+ ```ts
3402
+ readonly optional paging?: Record<string, {
3403
+ size?: number;
3404
+ }>;
3405
+ ```
3406
+
3407
+ ### Field
3408
+
3409
+ paging settings for queries
3410
+
3411
+ ### Inherited from
3412
+
3413
+ ```ts
3414
+ HttpBridgeConfig.paging
3415
+ ```
3416
+
3417
+ ***
3418
+
3419
+ ### retry?
3420
+
3421
+ ```ts
3422
+ readonly optional retry?: RetryConfig;
3423
+ ```
3424
+
3425
+ ### Inherited from
3426
+
3427
+ ```ts
3428
+ HttpBridgeConfig.retry
3429
+ ```
3430
+
3431
+ ***
3432
+
3433
+ ### security?
3434
+
3435
+ ```ts
3436
+ readonly optional security?: ModuleSecurityConfig;
3437
+ ```
3438
+
3439
+ ### Field
3440
+
3441
+ The query schemas and allowed/disallowed addresses which are allowed to issue them against the module.
3442
+ If both allowed and disallowed is specified, then disallowed takes priority.
3443
+
3444
+ ### Inherited from
3445
+
3446
+ ```ts
3447
+ HttpBridgeConfig.security
3448
+ ```
3449
+
3450
+ ***
3451
+
3452
+ ### sign?
3453
+
3454
+ ```ts
3455
+ readonly optional sign?: boolean;
3456
+ ```
3457
+
3458
+ ### Field
3459
+
3460
+ sign every query
3461
+
3462
+ ### Inherited from
3463
+
3464
+ ```ts
3465
+ HttpBridgeConfig.sign
3466
+ ```
3467
+
3468
+ ***
3469
+
3470
+ ### storeQueries?
3471
+
3472
+ ```ts
3473
+ readonly optional storeQueries?: boolean;
3474
+ ```
3475
+
3476
+ ### Field
3477
+
3478
+ Store the queries made to the module in an archivist if possible
3479
+
3480
+ ### Inherited from
3481
+
3482
+ ```ts
3483
+ HttpBridgeConfig.storeQueries
3484
+ ```
3485
+
3486
+ ***
3487
+
3488
+ ### timeBudget?
3489
+
3490
+ ```ts
3491
+ readonly optional timeBudget?: number;
3492
+ ```
3493
+
3494
+ ### Field
3495
+
3496
+ Time Budget setting for spans
3497
+
3498
+ ### Inherited from
3499
+
3500
+ ```ts
3501
+ HttpBridgeConfig.timeBudget
3502
+ ```
3503
+
3504
+ ***
3505
+
3506
+ ### timestamp?
3507
+
3508
+ ```ts
3509
+ readonly optional timestamp?: boolean;
3510
+ ```
3511
+
3512
+ ### Field
3513
+
3514
+ add a timestamp payload to every query
3515
+
3516
+ ### Inherited from
3517
+
3518
+ ```ts
3519
+ HttpBridgeConfig.timestamp
3520
+ ```
3521
+
3522
+ ***
3523
+
3524
+ ### reentrancy?
3525
+
3526
+ ```ts
3527
+ readonly optional reentrancy?: object;
3528
+ ```
3529
+
3530
+ ### action
3531
+
3532
+ ```ts
3533
+ action: "skip" | "wait";
3534
+ ```
3535
+
3536
+ ### scope
3537
+
3538
+ ```ts
3539
+ scope: "global";
3540
+ ```
3541
+
3542
+ ### Inherited from
3543
+
3544
+ ```ts
3545
+ HttpBridgeConfig.reentrancy
3546
+ ```
3547
+
3548
+ ***
3549
+
3550
+ ### schema
3551
+
3552
+ ```ts
3553
+ schema: object & "network.xyo.bridge.http.express.config" & object;
3554
+ ```
3555
+
3556
+ ### Type Declaration
3557
+
3558
+ #### \_\_schema
3559
+
3560
+ ```ts
3561
+ readonly __schema: true;
3562
+ ```
3563
+
3564
+ ### Type Declaration
3565
+
3566
+ #### \_\_schema
3567
+
3568
+ ```ts
3569
+ readonly __schema: true;
3570
+ ```
3571
+
3572
+ ### Inherited from
3573
+
3574
+ ```ts
3575
+ HttpBridgeConfig.schema
3576
+ ```
3577
+
3578
+ ***
3579
+
3580
+ ### $sources?
3581
+
3582
+ ```ts
3583
+ optional $sources?: BrandedHash[];
3584
+ ```
3585
+
3586
+ ### Inherited from
3587
+
3588
+ ```ts
3589
+ HttpBridgeConfig.$sources
3590
+ ```
3591
+
3592
+ ### <a id="HttpBridgeExpressParams"></a>HttpBridgeExpressParams
3593
+
3594
+ [**@xyo-network/bridge-http-express**](#../README)
3595
+
3596
+ ***
3597
+
3598
+ ## Extends
3599
+
3600
+ - `BridgeParams`\<`AnyConfigSchema`\<[`HttpBridgeExpressConfig`](#HttpBridgeExpressConfig)\>\>
3601
+
3602
+ ## Properties
3603
+
3604
+ ### resolver?
3605
+
3606
+ ```ts
3607
+ optional resolver?: ModuleResolverInstance<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
3608
+ ```
3609
+
3610
+ ### Inherited from
3611
+
3612
+ ```ts
3613
+ BridgeParams.resolver
3614
+ ```
3615
+
3616
+ ***
3617
+
3618
+ ### account?
3619
+
3620
+ ```ts
3621
+ optional account?: AccountInstance | "random";
3622
+ ```
3623
+
3624
+ ### Inherited from
3625
+
3626
+ ```ts
3627
+ BridgeParams.account
3628
+ ```
3629
+
3630
+ ***
3631
+
3632
+ ### addToResolvers?
3633
+
3634
+ ```ts
3635
+ optional addToResolvers?: boolean;
3636
+ ```
3637
+
3638
+ ### Inherited from
3639
+
3640
+ ```ts
3641
+ BridgeParams.addToResolvers
3642
+ ```
3643
+
3644
+ ***
3645
+
3646
+ ### additionalSigners?
3647
+
3648
+ ```ts
3649
+ optional additionalSigners?: AccountInstance[];
3650
+ ```
3651
+
3652
+ ### Inherited from
3653
+
3654
+ ```ts
3655
+ BridgeParams.additionalSigners
3656
+ ```
3657
+
3658
+ ***
3659
+
3660
+ ### allowNameResolution?
3661
+
3662
+ ```ts
3663
+ optional allowNameResolution?: boolean;
3664
+ ```
3665
+
3666
+ ### Inherited from
3667
+
3668
+ ```ts
3669
+ BridgeParams.allowNameResolution
3670
+ ```
3671
+
3672
+ ***
3673
+
3674
+ ### config
3675
+
3676
+ ```ts
3677
+ config: Partial<TConfig>;
3678
+ ```
3679
+
3680
+ ### Inherited from
3681
+
3682
+ ```ts
3683
+ BridgeParams.config
3684
+ ```
3685
+
3686
+ ***
3687
+
3688
+ ### ephemeralQueryAccountEnabled?
3689
+
3690
+ ```ts
3691
+ optional ephemeralQueryAccountEnabled?: boolean;
3692
+ ```
3693
+
3694
+ ### Inherited from
3695
+
3696
+ ```ts
3697
+ BridgeParams.ephemeralQueryAccountEnabled
3698
+ ```
3699
+
3700
+ ***
3701
+
3702
+ ### moduleIdentifierTransformers?
3703
+
3704
+ ```ts
3705
+ optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
3706
+ ```
3707
+
3708
+ ### Inherited from
3709
+
3710
+ ```ts
3711
+ BridgeParams.moduleIdentifierTransformers
3712
+ ```
3713
+
3714
+ ***
3715
+
3716
+ ### statusReporter?
3717
+
3718
+ ```ts
3719
+ optional statusReporter?: ModuleStatusReporter;
3720
+ ```
3721
+
3722
+ Optional reporter for broadcasting status changes.
3723
+
3724
+ ### Inherited from
3725
+
3726
+ ```ts
3727
+ BridgeParams.statusReporter
3728
+ ```
3729
+
3730
+ ### type-aliases
3731
+
3732
+ ### <a id="HttpBridgeExpressConfigSchema"></a>HttpBridgeExpressConfigSchema
3733
+
3734
+ [**@xyo-network/bridge-http-express**](#../README)
3735
+
3736
+ ***
3737
+
3738
+ ```ts
3739
+ type HttpBridgeExpressConfigSchema = typeof HttpBridgeExpressConfigSchema;
3740
+ ```
3741
+
3742
+ ### variables
3743
+
3744
+ ### <a id="HttpBridgeExpressConfigSchema"></a>HttpBridgeExpressConfigSchema
3745
+
3746
+ [**@xyo-network/bridge-http-express**](#../README)
3747
+
3748
+ ***
3749
+
3750
+ ```ts
3751
+ const HttpBridgeExpressConfigSchema: "network.xyo.bridge.http.express.config" & object;
3752
+ ```
3753
+
3754
+ ## Type Declaration
3755
+
3756
+ ### \_\_schema
18
3757
 
19
- ## Credits
3758
+ ```ts
3759
+ readonly __schema: true;
3760
+ ```
20
3761
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
3762
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
3763
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
3764
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/bridge-http-express.svg
3765
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/bridge-http-express
3766
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/bridge-http-express.svg
3767
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE