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