@xyo-network/bridge-worker 5.3.30 → 5.5.0

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