@xyo-network/network 5.3.25 → 5.3.27

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 +1379 -10
  2. package/package.json +13 -17
package/README.md CHANGED
@@ -1,23 +1,1392 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/network
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__network)
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
+ ### sdk-utils
46
+
47
+ ### packages
48
+
49
+ ### network
50
+
51
+ ### .temp-typedoc
52
+
53
+ ### classes
54
+
55
+ ### <a id="NetworkNodePayloadWrapper"></a>NetworkNodePayloadWrapper
56
+
57
+ [**@xyo-network/network**](#../README)
58
+
59
+ ***
60
+
61
+ ## Extends
62
+
63
+ - `PayloadWrapper`\<`T`\>
64
+
65
+ ## Type Parameters
66
+
67
+ ### T
68
+
69
+ `T` *extends* [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload) = [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)
70
+
71
+ ## Constructors
72
+
73
+ ### Constructor
74
+
75
+ ```ts
76
+ protected new NetworkNodePayloadWrapper<T>(payload): NetworkNodePayloadWrapper<T>;
77
+ ```
78
+
79
+ ### Parameters
80
+
81
+ #### payload
82
+
83
+ `T`
84
+
85
+ ### Returns
86
+
87
+ `NetworkNodePayloadWrapper`\<`T`\>
88
+
89
+ ### Inherited from
90
+
91
+ ```ts
92
+ PayloadWrapper<T>.constructor
93
+ ```
94
+
95
+ ## Properties
96
+
97
+ ### loaderFactory
98
+
99
+ ```ts
100
+ protected static loaderFactory: PayloadLoaderFactory | null;
101
+ ```
102
+
103
+ ### Inherited from
104
+
105
+ ```ts
106
+ PayloadWrapper.loaderFactory
107
+ ```
108
+
109
+ ***
110
+
111
+ ### payload
112
+
113
+ ```ts
114
+ payload: T;
115
+ ```
116
+
117
+ ### Inherited from
118
+
119
+ ```ts
120
+ PayloadWrapper.payload
121
+ ```
122
+
123
+ ## Methods
124
+
125
+ ### known()
126
+
127
+ ```ts
128
+ static known(hash): Promise<NetworkNodePayloadWrapper<NetworkNodePayload>>;
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ #### hash
134
+
135
+ `BrandedHash`
136
+
137
+ ### Returns
138
+
139
+ `Promise`\<`NetworkNodePayloadWrapper`\<[`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)\>\>
140
+
141
+ ***
142
+
143
+ ### as()
144
+
145
+ ```ts
146
+ static as<T>(value): PayloadDataWrapper<T> | null;
147
+ ```
148
+
149
+ ### Type Parameters
150
+
151
+ #### T
152
+
153
+ `T` *extends* `Payload` = `Payload`
154
+
155
+ ### Parameters
156
+
157
+ #### value
158
+
159
+ `unknown`
160
+
161
+ ### Returns
162
+
163
+ `PayloadDataWrapper`\<`T`\> \| `null`
164
+
165
+ ### Inherited from
166
+
167
+ ```ts
168
+ PayloadWrapper.as
169
+ ```
170
+
171
+ ***
172
+
173
+ ### load()
174
+
175
+ ```ts
176
+ static load(address): Promise<PayloadDataWrapper<Payload> | null>;
177
+ ```
178
+
179
+ ### Parameters
180
+
181
+ #### address
182
+
183
+ `BrandedAddress`
184
+
185
+ ### Returns
186
+
187
+ `Promise`\<`PayloadDataWrapper`\<`Payload`\> \| `null`\>
188
+
189
+ ### Inherited from
190
+
191
+ ```ts
192
+ PayloadWrapper.load
193
+ ```
194
+
195
+ ***
196
+
197
+ ### parse()
198
+
199
+ ```ts
200
+ static parse<T>(payload?): PayloadDataWrapper<T> | undefined;
201
+ ```
202
+
203
+ ### Type Parameters
204
+
205
+ #### T
206
+
207
+ `T` *extends* `Payload`
208
+
209
+ ### Parameters
210
+
211
+ #### payload?
212
+
213
+ `unknown`
214
+
215
+ ### Returns
216
+
217
+ `PayloadDataWrapper`\<`T`\> \| `undefined`
218
+
219
+ ### Inherited from
220
+
221
+ ```ts
222
+ PayloadWrapper.parse
223
+ ```
224
+
225
+ ***
226
+
227
+ ### setLoaderFactory()
228
+
229
+ ```ts
230
+ static setLoaderFactory(factory): void;
231
+ ```
232
+
233
+ ### Parameters
234
+
235
+ #### factory
236
+
237
+ `PayloadLoaderFactory` \| `null`
238
+
239
+ ### Returns
240
+
241
+ `void`
242
+
243
+ ### Inherited from
244
+
245
+ ```ts
246
+ PayloadWrapper.setLoaderFactory
247
+ ```
248
+
249
+ ***
250
+
251
+ ### tryParse()
252
+
253
+ ```ts
254
+ static tryParse<T>(obj): PayloadDataWrapper<T> | undefined;
255
+ ```
256
+
257
+ ### Type Parameters
258
+
259
+ #### T
260
+
261
+ `T` *extends* `Payload`
262
+
263
+ ### Parameters
264
+
265
+ #### obj
266
+
267
+ `unknown`
268
+
269
+ ### Returns
270
+
271
+ `PayloadDataWrapper`\<`T`\> \| `undefined`
272
+
273
+ ### Inherited from
274
+
275
+ ```ts
276
+ PayloadWrapper.tryParse
277
+ ```
278
+
279
+ ***
280
+
281
+ ### wrap()
282
+
283
+ ```ts
284
+ static wrap<T>(payload?): PayloadDataWrapper<T>;
285
+ ```
286
+
287
+ ### Type Parameters
288
+
289
+ #### T
290
+
291
+ `T` *extends* `Payload`
292
+
293
+ ### Parameters
294
+
295
+ #### payload?
296
+
297
+ `T` \| `PayloadDataWrapper`\<`T`\>
298
+
299
+ ### Returns
300
+
301
+ `PayloadDataWrapper`\<`T`\>
302
+
303
+ ### Inherited from
304
+
305
+ ```ts
306
+ PayloadWrapper.wrap
307
+ ```
308
+
309
+ ***
310
+
311
+ ### wrappedMap()
312
+
313
+ ```ts
314
+ static wrappedMap<T>(payloads): Promise<Record<string, PayloadDataWrapper<T>>>;
315
+ ```
316
+
317
+ ### Type Parameters
318
+
319
+ #### T
320
+
321
+ `T` *extends* `Payload`
322
+
323
+ ### Parameters
324
+
325
+ #### payloads
326
+
327
+ (`T` \| `PayloadDataWrapper`\<`T`\>)[]
328
+
329
+ ### Returns
330
+
331
+ `Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
332
+
333
+ ### Inherited from
334
+
335
+ ```ts
336
+ PayloadWrapper.wrappedMap
337
+ ```
338
+
339
+ ***
340
+
341
+ ### validate()
342
+
343
+ ```ts
344
+ validate(): Promise<Error[]>;
345
+ ```
346
+
347
+ ### Returns
348
+
349
+ `Promise`\<`Error`[]\>
350
+
351
+ ### Inherited from
352
+
353
+ ```ts
354
+ PayloadWrapper.validate
355
+ ```
356
+
357
+ ***
358
+
359
+ ### unwrap()
360
+
361
+ ### Call Signature
362
+
363
+ ```ts
364
+ static unwrap<TPayload>(payload?): TPayload | undefined;
365
+ ```
366
+
367
+ #### Type Parameters
368
+
369
+ ##### TPayload
370
+
371
+ `TPayload` *extends* `Payload` = `Payload`
372
+
373
+ #### Parameters
374
+
375
+ ##### payload?
376
+
377
+ `TPayload`
378
+
379
+ #### Returns
380
+
381
+ `TPayload` \| `undefined`
382
+
383
+ #### Inherited from
384
+
385
+ ```ts
386
+ PayloadWrapper.unwrap
387
+ ```
388
+
389
+ ### Call Signature
390
+
391
+ ```ts
392
+ static unwrap<TPayload, TWrapper>(payload): TPayload;
393
+ ```
394
+
395
+ #### Type Parameters
396
+
397
+ ##### TPayload
398
+
399
+ `TPayload` *extends* `Payload` = `Payload`
400
+
401
+ ##### TWrapper
402
+
403
+ `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
404
+
405
+ #### Parameters
406
+
407
+ ##### payload
408
+
409
+ `TPayload` \| `TWrapper`
410
+
411
+ #### Returns
412
+
413
+ `TPayload`
414
+
415
+ #### Inherited from
416
+
417
+ ```ts
418
+ PayloadWrapper.unwrap
419
+ ```
420
+
421
+ ### Call Signature
422
+
423
+ ```ts
424
+ static unwrap<TPayload, TWrapper>(payload): TPayload[];
425
+ ```
426
+
427
+ #### Type Parameters
428
+
429
+ ##### TPayload
430
+
431
+ `TPayload` *extends* `Payload` = `Payload`
432
+
433
+ ##### TWrapper
434
+
435
+ `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
436
+
437
+ #### Parameters
438
+
439
+ ##### payload
440
+
441
+ (`TPayload` \| `TWrapper`)[]
442
+
443
+ #### Returns
444
+
445
+ `TPayload`[]
446
+
447
+ #### Inherited from
448
+
449
+ ```ts
450
+ PayloadWrapper.unwrap
451
+ ```
452
+
453
+ ***
454
+
455
+ ### unwrapSinglePayload()
456
+
457
+ ### Call Signature
458
+
459
+ ```ts
460
+ static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
461
+ ```
462
+
463
+ #### Type Parameters
464
+
465
+ ##### TPayload
466
+
467
+ `TPayload` *extends* `Payload` = `Payload`
468
+
469
+ #### Parameters
470
+
471
+ ##### payload?
472
+
473
+ `TPayload`
474
+
475
+ #### Returns
476
+
477
+ `TPayload` \| `undefined`
478
+
479
+ #### Inherited from
480
+
481
+ ```ts
482
+ PayloadWrapper.unwrapSinglePayload
483
+ ```
484
+
485
+ ### Call Signature
486
+
487
+ ```ts
488
+ static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
489
+ ```
490
+
491
+ #### Type Parameters
492
+
493
+ ##### TPayload
494
+
495
+ `TPayload` *extends* `Payload` = `Payload`
496
+
497
+ ##### TWrapper
498
+
499
+ `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
500
+
501
+ #### Parameters
502
+
503
+ ##### payload
504
+
505
+ `TPayload` \| `TWrapper`
506
+
507
+ #### Returns
508
+
509
+ `TPayload`
510
+
511
+ #### Inherited from
512
+
513
+ ```ts
514
+ PayloadWrapper.unwrapSinglePayload
515
+ ```
516
+
517
+ ***
518
+
519
+ ### dataHash()
520
+
521
+ ```ts
522
+ dataHash(): Promise<BrandedHash>;
523
+ ```
524
+
525
+ ### Returns
526
+
527
+ `Promise`\<`BrandedHash`\>
528
+
529
+ ### Inherited from
530
+
531
+ ```ts
532
+ PayloadWrapper.dataHash
533
+ ```
534
+
535
+ ***
536
+
537
+ ### getErrors()
538
+
539
+ ```ts
540
+ getErrors(): Promise<Error[]>;
541
+ ```
542
+
543
+ ### Returns
544
+
545
+ `Promise`\<`Error`[]\>
546
+
547
+ ### Inherited from
548
+
549
+ ```ts
550
+ PayloadWrapper.getErrors
551
+ ```
552
+
553
+ ***
554
+
555
+ ### getValid()
556
+
557
+ ```ts
558
+ getValid(): Promise<boolean>;
559
+ ```
560
+
561
+ ### Returns
562
+
563
+ `Promise`\<`boolean`\>
564
+
565
+ ### Inherited from
566
+
567
+ ```ts
568
+ PayloadWrapper.getValid
569
+ ```
570
+
571
+ ***
572
+
573
+ ### hash()
574
+
575
+ ```ts
576
+ hash(): Promise<BrandedHash>;
577
+ ```
578
+
579
+ ### Returns
580
+
581
+ `Promise`\<`BrandedHash`\>
582
+
583
+ ### Inherited from
584
+
585
+ ```ts
586
+ PayloadWrapper.hash
587
+ ```
588
+
589
+ ***
590
+
591
+ ### schema()
592
+
593
+ ```ts
594
+ schema(): string;
595
+ ```
596
+
597
+ ### Returns
598
+
599
+ `string`
600
+
601
+ ### Inherited from
602
+
603
+ ```ts
604
+ PayloadWrapper.schema
605
+ ```
606
+
607
+ ### <a id="NetworkPayloadWrapper"></a>NetworkPayloadWrapper
608
+
609
+ [**@xyo-network/network**](#../README)
610
+
611
+ ***
612
+
613
+ ## Extends
614
+
615
+ - `PayloadWrapper`\<[`NetworkPayload`](#../type-aliases/NetworkPayload)\>
616
+
617
+ ## Constructors
618
+
619
+ ### Constructor
620
+
621
+ ```ts
622
+ protected new NetworkPayloadWrapper(payload): NetworkPayloadWrapper;
623
+ ```
624
+
625
+ ### Parameters
626
+
627
+ #### payload
628
+
629
+ [`NetworkPayload`](#../type-aliases/NetworkPayload)
630
+
631
+ ### Returns
632
+
633
+ `NetworkPayloadWrapper`
634
+
635
+ ### Inherited from
636
+
637
+ ```ts
638
+ PayloadWrapper<NetworkPayload>.constructor
639
+ ```
640
+
641
+ ## Properties
642
+
643
+ ### loaderFactory
644
+
645
+ ```ts
646
+ protected static loaderFactory: PayloadLoaderFactory | null;
647
+ ```
648
+
649
+ ### Inherited from
650
+
651
+ ```ts
652
+ PayloadWrapper.loaderFactory
653
+ ```
654
+
655
+ ***
656
+
657
+ ### payload
658
+
659
+ ```ts
660
+ payload: NetworkPayload;
661
+ ```
662
+
663
+ ### Inherited from
664
+
665
+ ```ts
666
+ PayloadWrapper.payload
667
+ ```
668
+
669
+ ## Accessors
670
+
671
+ ### archivists
672
+
673
+ ### Get Signature
674
+
675
+ ```ts
676
+ get archivists():
677
+ | NetworkNodePayload[]
678
+ | undefined;
679
+ ```
680
+
681
+ #### Returns
682
+
683
+ \| [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
684
+ \| `undefined`
685
+
686
+ ***
687
+
688
+ ### bridges
689
+
690
+ ### Get Signature
691
+
692
+ ```ts
693
+ get bridges():
694
+ | NetworkNodePayload[]
695
+ | undefined;
696
+ ```
697
+
698
+ #### Returns
699
+
700
+ \| [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
701
+ \| `undefined`
702
+
703
+ ***
704
+
705
+ ### diviners
706
+
707
+ ### Get Signature
708
+
709
+ ```ts
710
+ get diviners():
711
+ | NetworkNodePayload[]
712
+ | undefined;
713
+ ```
714
+
715
+ #### Returns
716
+
717
+ \| [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
718
+ \| `undefined`
719
+
720
+ ***
721
+
722
+ ### sentinels
723
+
724
+ ### Get Signature
725
+
726
+ ```ts
727
+ get sentinels():
728
+ | NetworkNodePayload[]
729
+ | undefined;
730
+ ```
731
+
732
+ #### Returns
733
+
734
+ \| [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
735
+ \| `undefined`
736
+
737
+ ## Methods
738
+
739
+ ### known()
740
+
741
+ ```ts
742
+ static known(hash): Promise<NetworkPayload | undefined>;
743
+ ```
744
+
745
+ ### Parameters
746
+
747
+ #### hash
748
+
749
+ `BrandedHash`
750
+
751
+ ### Returns
752
+
753
+ `Promise`\<[`NetworkPayload`](#../type-aliases/NetworkPayload) \| `undefined`\>
754
+
755
+ ***
756
+
757
+ ### filterNodesByType()
758
+
759
+ ```ts
760
+ filterNodesByType(type):
761
+ | NetworkNodePayload[]
762
+ | undefined;
763
+ ```
764
+
765
+ ### Parameters
766
+
767
+ #### type
768
+
769
+ [`NetworkNodeType`](#../type-aliases/NetworkNodeType)
770
+
771
+ ### Returns
772
+
773
+ \| [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
774
+ \| `undefined`
775
+
776
+ ***
777
+
778
+ ### as()
779
+
780
+ ```ts
781
+ static as<T>(value): PayloadDataWrapper<T> | null;
782
+ ```
783
+
784
+ ### Type Parameters
785
+
786
+ #### T
787
+
788
+ `T` *extends* `Payload` = `Payload`
789
+
790
+ ### Parameters
791
+
792
+ #### value
793
+
794
+ `unknown`
795
+
796
+ ### Returns
797
+
798
+ `PayloadDataWrapper`\<`T`\> \| `null`
799
+
800
+ ### Inherited from
801
+
802
+ ```ts
803
+ PayloadWrapper.as
804
+ ```
805
+
806
+ ***
807
+
808
+ ### load()
809
+
810
+ ```ts
811
+ static load(address): Promise<PayloadDataWrapper<Payload> | null>;
812
+ ```
813
+
814
+ ### Parameters
815
+
816
+ #### address
817
+
818
+ `BrandedAddress`
819
+
820
+ ### Returns
821
+
822
+ `Promise`\<`PayloadDataWrapper`\<`Payload`\> \| `null`\>
823
+
824
+ ### Inherited from
825
+
826
+ ```ts
827
+ PayloadWrapper.load
828
+ ```
829
+
830
+ ***
831
+
832
+ ### parse()
833
+
834
+ ```ts
835
+ static parse<T>(payload?): PayloadDataWrapper<T> | undefined;
836
+ ```
837
+
838
+ ### Type Parameters
839
+
840
+ #### T
841
+
842
+ `T` *extends* `Payload`
843
+
844
+ ### Parameters
845
+
846
+ #### payload?
847
+
848
+ `unknown`
849
+
850
+ ### Returns
851
+
852
+ `PayloadDataWrapper`\<`T`\> \| `undefined`
853
+
854
+ ### Inherited from
855
+
856
+ ```ts
857
+ PayloadWrapper.parse
858
+ ```
859
+
860
+ ***
861
+
862
+ ### setLoaderFactory()
863
+
864
+ ```ts
865
+ static setLoaderFactory(factory): void;
866
+ ```
867
+
868
+ ### Parameters
869
+
870
+ #### factory
871
+
872
+ `PayloadLoaderFactory` \| `null`
873
+
874
+ ### Returns
875
+
876
+ `void`
877
+
878
+ ### Inherited from
879
+
880
+ ```ts
881
+ PayloadWrapper.setLoaderFactory
882
+ ```
883
+
884
+ ***
885
+
886
+ ### tryParse()
887
+
888
+ ```ts
889
+ static tryParse<T>(obj): PayloadDataWrapper<T> | undefined;
890
+ ```
891
+
892
+ ### Type Parameters
893
+
894
+ #### T
895
+
896
+ `T` *extends* `Payload`
897
+
898
+ ### Parameters
899
+
900
+ #### obj
901
+
902
+ `unknown`
903
+
904
+ ### Returns
905
+
906
+ `PayloadDataWrapper`\<`T`\> \| `undefined`
907
+
908
+ ### Inherited from
909
+
910
+ ```ts
911
+ PayloadWrapper.tryParse
912
+ ```
913
+
914
+ ***
915
+
916
+ ### wrap()
917
+
918
+ ```ts
919
+ static wrap<T>(payload?): PayloadDataWrapper<T>;
920
+ ```
921
+
922
+ ### Type Parameters
923
+
924
+ #### T
925
+
926
+ `T` *extends* `Payload`
927
+
928
+ ### Parameters
929
+
930
+ #### payload?
931
+
932
+ `T` \| `PayloadDataWrapper`\<`T`\>
933
+
934
+ ### Returns
935
+
936
+ `PayloadDataWrapper`\<`T`\>
937
+
938
+ ### Inherited from
939
+
940
+ ```ts
941
+ PayloadWrapper.wrap
942
+ ```
943
+
944
+ ***
945
+
946
+ ### wrappedMap()
947
+
948
+ ```ts
949
+ static wrappedMap<T>(payloads): Promise<Record<string, PayloadDataWrapper<T>>>;
950
+ ```
951
+
952
+ ### Type Parameters
953
+
954
+ #### T
955
+
956
+ `T` *extends* `Payload`
957
+
958
+ ### Parameters
959
+
960
+ #### payloads
961
+
962
+ (`T` \| `PayloadDataWrapper`\<`T`\>)[]
963
+
964
+ ### Returns
965
+
966
+ `Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
967
+
968
+ ### Inherited from
969
+
970
+ ```ts
971
+ PayloadWrapper.wrappedMap
972
+ ```
973
+
974
+ ***
975
+
976
+ ### validate()
977
+
978
+ ```ts
979
+ validate(): Promise<Error[]>;
980
+ ```
981
+
982
+ ### Returns
983
+
984
+ `Promise`\<`Error`[]\>
985
+
986
+ ### Inherited from
987
+
988
+ ```ts
989
+ PayloadWrapper.validate
990
+ ```
991
+
992
+ ***
993
+
994
+ ### unwrap()
995
+
996
+ ### Call Signature
997
+
998
+ ```ts
999
+ static unwrap<TPayload>(payload?): TPayload | undefined;
1000
+ ```
1001
+
1002
+ #### Type Parameters
1003
+
1004
+ ##### TPayload
1005
+
1006
+ `TPayload` *extends* `Payload` = `Payload`
1007
+
1008
+ #### Parameters
1009
+
1010
+ ##### payload?
1011
+
1012
+ `TPayload`
1013
+
1014
+ #### Returns
1015
+
1016
+ `TPayload` \| `undefined`
1017
+
1018
+ #### Inherited from
1019
+
1020
+ ```ts
1021
+ PayloadWrapper.unwrap
1022
+ ```
1023
+
1024
+ ### Call Signature
1025
+
1026
+ ```ts
1027
+ static unwrap<TPayload, TWrapper>(payload): TPayload;
1028
+ ```
1029
+
1030
+ #### Type Parameters
1031
+
1032
+ ##### TPayload
1033
+
1034
+ `TPayload` *extends* `Payload` = `Payload`
1035
+
1036
+ ##### TWrapper
1037
+
1038
+ `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
1039
+
1040
+ #### Parameters
1041
+
1042
+ ##### payload
1043
+
1044
+ `TPayload` \| `TWrapper`
1045
+
1046
+ #### Returns
1047
+
1048
+ `TPayload`
1049
+
1050
+ #### Inherited from
1051
+
1052
+ ```ts
1053
+ PayloadWrapper.unwrap
1054
+ ```
1055
+
1056
+ ### Call Signature
1057
+
1058
+ ```ts
1059
+ static unwrap<TPayload, TWrapper>(payload): TPayload[];
1060
+ ```
1061
+
1062
+ #### Type Parameters
1063
+
1064
+ ##### TPayload
1065
+
1066
+ `TPayload` *extends* `Payload` = `Payload`
1067
+
1068
+ ##### TWrapper
1069
+
1070
+ `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
1071
+
1072
+ #### Parameters
1073
+
1074
+ ##### payload
1075
+
1076
+ (`TPayload` \| `TWrapper`)[]
1077
+
1078
+ #### Returns
1079
+
1080
+ `TPayload`[]
1081
+
1082
+ #### Inherited from
1083
+
1084
+ ```ts
1085
+ PayloadWrapper.unwrap
1086
+ ```
1087
+
1088
+ ***
1089
+
1090
+ ### unwrapSinglePayload()
1091
+
1092
+ ### Call Signature
1093
+
1094
+ ```ts
1095
+ static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
1096
+ ```
1097
+
1098
+ #### Type Parameters
1099
+
1100
+ ##### TPayload
1101
+
1102
+ `TPayload` *extends* `Payload` = `Payload`
1103
+
1104
+ #### Parameters
1105
+
1106
+ ##### payload?
1107
+
1108
+ `TPayload`
1109
+
1110
+ #### Returns
1111
+
1112
+ `TPayload` \| `undefined`
1113
+
1114
+ #### Inherited from
1115
+
1116
+ ```ts
1117
+ PayloadWrapper.unwrapSinglePayload
1118
+ ```
1119
+
1120
+ ### Call Signature
1121
+
1122
+ ```ts
1123
+ static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
1124
+ ```
1125
+
1126
+ #### Type Parameters
1127
+
1128
+ ##### TPayload
1129
+
1130
+ `TPayload` *extends* `Payload` = `Payload`
1131
+
1132
+ ##### TWrapper
1133
+
1134
+ `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
1135
+
1136
+ #### Parameters
1137
+
1138
+ ##### payload
1139
+
1140
+ `TPayload` \| `TWrapper`
1141
+
1142
+ #### Returns
1143
+
1144
+ `TPayload`
1145
+
1146
+ #### Inherited from
1147
+
1148
+ ```ts
1149
+ PayloadWrapper.unwrapSinglePayload
1150
+ ```
1151
+
1152
+ ***
1153
+
1154
+ ### dataHash()
1155
+
1156
+ ```ts
1157
+ dataHash(): Promise<BrandedHash>;
1158
+ ```
1159
+
1160
+ ### Returns
1161
+
1162
+ `Promise`\<`BrandedHash`\>
1163
+
1164
+ ### Inherited from
1165
+
1166
+ ```ts
1167
+ PayloadWrapper.dataHash
1168
+ ```
1169
+
1170
+ ***
1171
+
1172
+ ### getErrors()
1173
+
1174
+ ```ts
1175
+ getErrors(): Promise<Error[]>;
1176
+ ```
1177
+
1178
+ ### Returns
1179
+
1180
+ `Promise`\<`Error`[]\>
1181
+
1182
+ ### Inherited from
1183
+
1184
+ ```ts
1185
+ PayloadWrapper.getErrors
1186
+ ```
1187
+
1188
+ ***
1189
+
1190
+ ### getValid()
1191
+
1192
+ ```ts
1193
+ getValid(): Promise<boolean>;
1194
+ ```
1195
+
1196
+ ### Returns
1197
+
1198
+ `Promise`\<`boolean`\>
1199
+
1200
+ ### Inherited from
1201
+
1202
+ ```ts
1203
+ PayloadWrapper.getValid
1204
+ ```
1205
+
1206
+ ***
1207
+
1208
+ ### hash()
1209
+
1210
+ ```ts
1211
+ hash(): Promise<BrandedHash>;
1212
+ ```
1213
+
1214
+ ### Returns
1215
+
1216
+ `Promise`\<`BrandedHash`\>
1217
+
1218
+ ### Inherited from
1219
+
1220
+ ```ts
1221
+ PayloadWrapper.hash
1222
+ ```
1223
+
1224
+ ***
1225
+
1226
+ ### schema()
1227
+
1228
+ ```ts
1229
+ schema(): string;
1230
+ ```
1231
+
1232
+ ### Returns
1233
+
1234
+ `string`
1235
+
1236
+ ### Inherited from
1237
+
1238
+ ```ts
1239
+ PayloadWrapper.schema
1240
+ ```
1241
+
1242
+ ### functions
1243
+
1244
+ ### <a id="knownArchivists"></a>knownArchivists
1245
+
1246
+ [**@xyo-network/network**](#../README)
1247
+
1248
+ ***
1249
+
1250
+ ```ts
1251
+ function knownArchivists(): NetworkNodePayload[];
1252
+ ```
1253
+
1254
+ ## Returns
1255
+
1256
+ [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
1257
+
1258
+ ### <a id="knownDiviners"></a>knownDiviners
1259
+
1260
+ [**@xyo-network/network**](#../README)
1261
+
1262
+ ***
1263
+
1264
+ ```ts
1265
+ function knownDiviners(): NetworkNodePayload[];
1266
+ ```
1267
+
1268
+ ## Returns
1269
+
1270
+ [`NetworkNodePayload`](#../type-aliases/NetworkNodePayload)[]
1271
+
1272
+ ### <a id="knownNetworks"></a>knownNetworks
1273
+
1274
+ [**@xyo-network/network**](#../README)
1275
+
1276
+ ***
1277
+
1278
+ ```ts
1279
+ function knownNetworks(): Promise<NetworkPayload[]>;
1280
+ ```
1281
+
1282
+ ## Returns
1283
+
1284
+ `Promise`\<[`NetworkPayload`](#../type-aliases/NetworkPayload)[]\>
1285
+
1286
+ ### type-aliases
1287
+
1288
+ ### <a id="NetworkNodePayload"></a>NetworkNodePayload
1289
+
1290
+ [**@xyo-network/network**](#../README)
1291
+
1292
+ ***
1293
+
1294
+ ```ts
1295
+ type NetworkNodePayload = Payload<{
1296
+ docs?: string;
1297
+ name?: string;
1298
+ slug: string;
1299
+ type: NetworkNodeType;
1300
+ uri: string;
1301
+ web?: string;
1302
+ }, NetworkNodeSchema>;
1303
+ ```
1304
+
1305
+ ### <a id="NetworkNodeSchema"></a>NetworkNodeSchema
1306
+
1307
+ [**@xyo-network/network**](#../README)
1308
+
1309
+ ***
1310
+
1311
+ ```ts
1312
+ type NetworkNodeSchema = typeof NetworkNodeSchema;
1313
+ ```
1314
+
1315
+ ### <a id="NetworkNodeType"></a>NetworkNodeType
1316
+
1317
+ [**@xyo-network/network**](#../README)
1318
+
1319
+ ***
1320
+
1321
+ ```ts
1322
+ type NetworkNodeType = "archivist" | "diviner" | "bridge" | "sentinel";
1323
+ ```
1324
+
1325
+ ### <a id="NetworkPayload"></a>NetworkPayload
1326
+
1327
+ [**@xyo-network/network**](#../README)
1328
+
1329
+ ***
1330
+
1331
+ ```ts
1332
+ type NetworkPayload = Payload<{
1333
+ name?: string;
1334
+ nodes?: NetworkNodePayload[];
1335
+ slug: string;
1336
+ }, NetworkSchema>;
1337
+ ```
1338
+
1339
+ ### <a id="NetworkSchema"></a>NetworkSchema
1340
+
1341
+ [**@xyo-network/network**](#../README)
1342
+
1343
+ ***
1344
+
1345
+ ```ts
1346
+ type NetworkSchema = typeof NetworkSchema;
1347
+ ```
1348
+
1349
+ ### variables
1350
+
1351
+ ### <a id="NetworkNodeSchema"></a>NetworkNodeSchema
1352
+
1353
+ [**@xyo-network/network**](#../README)
1354
+
1355
+ ***
1356
+
1357
+ ```ts
1358
+ const NetworkNodeSchema: "network.xyo.network.node" & object;
1359
+ ```
1360
+
1361
+ ## Type Declaration
1362
+
1363
+ ### \_\_schema
1364
+
1365
+ ```ts
1366
+ readonly __schema: true;
1367
+ ```
1368
+
1369
+ ### <a id="NetworkSchema"></a>NetworkSchema
1370
+
1371
+ [**@xyo-network/network**](#../README)
1372
+
1373
+ ***
1374
+
1375
+ ```ts
1376
+ const NetworkSchema: "network.xyo.network" & object;
1377
+ ```
1378
+
1379
+ ## Type Declaration
1380
+
1381
+ ### \_\_schema
18
1382
 
19
- ## Credits
1383
+ ```ts
1384
+ readonly __schema: true;
1385
+ ```
20
1386
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
1387
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
1388
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
1389
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/network.svg
1390
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/network
1391
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/network.svg
1392
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/network",
3
- "version": "5.3.25",
3
+ "version": "5.3.27",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -36,29 +36,25 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/payload-model": "~5.3.25",
40
- "@xyo-network/payload-wrapper": "~5.3.25",
41
- "@xyo-network/payload-builder": "~5.3.25"
39
+ "@xyo-network/payload-builder": "~5.3.27",
40
+ "@xyo-network/payload-model": "~5.3.27",
41
+ "@xyo-network/payload-wrapper": "~5.3.27"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@opentelemetry/api": "^1.9.1",
45
- "@types/node": "^25.5.0",
46
- "@xylabs/sdk-js": "^5.0.93",
47
- "@xylabs/ts-scripts-common": "~7.6.16",
48
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
49
- "@xylabs/tsconfig": "~7.6.16",
50
- "acorn": "^8.16.0",
45
+ "@xylabs/sdk-js": "^5.0.94",
46
+ "@xylabs/ts-scripts-common": "~7.7.15",
47
+ "@xylabs/ts-scripts-pnpm": "~7.7.15",
48
+ "@xylabs/tsconfig": "~7.7.15",
51
49
  "axios": "^1.14.0",
52
- "esbuild": "^0.28.0",
53
50
  "typescript": "~5.9.3",
54
51
  "zod": "^4.3.6",
55
- "@xyo-network/payload-wrapper": "~5.3.25",
56
- "@xyo-network/payload-model": "~5.3.25",
57
- "@xyo-network/payload-builder": "~5.3.25"
52
+ "@xyo-network/payload-builder": "~5.3.27",
53
+ "@xyo-network/payload-model": "~5.3.27",
54
+ "@xyo-network/payload-wrapper": "~5.3.27"
58
55
  },
59
56
  "peerDependencies": {
60
- "@xylabs/sdk-js": "^5",
61
- "zod": "^4"
57
+ "@xylabs/sdk-js": "^5"
62
58
  },
63
59
  "publishConfig": {
64
60
  "access": "public"