@xyo-network/manifest 5.3.29 → 5.4.1

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 +0 -2124
  2. package/package.json +62 -66
package/README.md CHANGED
@@ -38,2130 +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
- ### manifest
46
-
47
- ### .temp-typedoc
48
-
49
- ### classes
50
-
51
- ### <a id="ManifestWrapper"></a>ManifestWrapper
52
-
53
- [**@xyo-network/manifest**](#../README)
54
-
55
- ***
56
-
57
- Provides functionality that can be performed on a PackageManifest
58
-
59
- ## Extends
60
-
61
- - `PayloadWrapper`\<`TManifest` *extends* `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\> ? `TManifest` : `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\>\>
62
-
63
- ## Type Parameters
64
-
65
- ### TManifest
66
-
67
- `TManifest` *extends*
68
- \| `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\>
69
- \| `void` = `void`
70
-
71
- ## Constructors
72
-
73
- ### Constructor
74
-
75
- ```ts
76
- new ManifestWrapper<TManifest>(
77
- payload,
78
- wallet,
79
- locator,
80
- publicChildren?,
81
- privateChildren?,
82
- moduleIdentifierTransformers?,
83
- logger?): ManifestWrapper<TManifest>;
84
- ```
85
-
86
- ### Parameters
87
-
88
- #### payload
89
-
90
- `TManifest` *extends* `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\> ? `TManifest` : `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\>
91
-
92
- #### wallet
93
-
94
- `WalletInstance`
95
-
96
- #### locator
97
-
98
- `ModuleFactoryLocatorInstance`
99
-
100
- #### publicChildren?
101
-
102
- [`ModuleManifest`](#../interfaces/ModuleManifest)[]
103
-
104
- #### privateChildren?
105
-
106
- [`ModuleManifest`](#../interfaces/ModuleManifest)[]
107
-
108
- #### moduleIdentifierTransformers?
109
-
110
- `ModuleIdentifierTransformer`[]
111
-
112
- #### logger?
113
-
114
- `Logger`
115
-
116
- ### Returns
117
-
118
- `ManifestWrapper`\<`TManifest`\>
119
-
120
- ### Overrides
121
-
122
- ```ts
123
- PayloadWrapper<TManifest extends WithAnySchema<PackageManifestPayload> ? TManifest : WithAnySchema<PackageManifestPayload>>.constructor
124
- ```
125
-
126
- ## Properties
127
-
128
- ### locator
129
-
130
- ```ts
131
- protected readonly locator: ModuleFactoryLocatorInstance;
132
- ```
133
-
134
- ***
135
-
136
- ### logger
137
-
138
- ```ts
139
- protected readonly logger: Logger | undefined;
140
- ```
141
-
142
- ***
143
-
144
- ### moduleIdentifierTransformers
145
-
146
- ```ts
147
- protected readonly moduleIdentifierTransformers: ModuleIdentifierTransformer[] | undefined;
148
- ```
149
-
150
- ***
151
-
152
- ### privateChildren
153
-
154
- ```ts
155
- protected readonly privateChildren: ModuleManifest[];
156
- ```
157
-
158
- ***
159
-
160
- ### publicChildren
161
-
162
- ```ts
163
- protected readonly publicChildren: ModuleManifest[];
164
- ```
165
-
166
- ***
167
-
168
- ### wallet
169
-
170
- ```ts
171
- protected readonly wallet: WalletInstance;
172
- ```
173
-
174
- ***
175
-
176
- ### loaderFactory
177
-
178
- ```ts
179
- protected static loaderFactory: PayloadLoaderFactory | null;
180
- ```
181
-
182
- ### Inherited from
183
-
184
- ```ts
185
- PayloadWrapper.loaderFactory
186
- ```
187
-
188
- ***
189
-
190
- ### payload
191
-
192
- ```ts
193
- payload: TManifest extends WithAnySchema<PackageManifestPayload> ? TManifest : WithAnySchema<PackageManifestPayload>;
194
- ```
195
-
196
- ### Inherited from
197
-
198
- ```ts
199
- PayloadWrapper.payload
200
- ```
201
-
202
- ## Methods
203
-
204
- ### loadModule()
205
-
206
- ```ts
207
- loadModule(
208
- wallet,
209
- node,
210
- manifest,
211
- external?): Promise<void>;
212
- ```
213
-
214
- ### Parameters
215
-
216
- #### wallet
217
-
218
- `WalletInstance`
219
-
220
- #### node
221
-
222
- `MemoryNode`
223
-
224
- #### manifest
225
-
226
- [`ModuleManifest`](#../interfaces/ModuleManifest)
227
-
228
- #### external?
229
-
230
- `boolean`
231
-
232
- ### Returns
233
-
234
- `Promise`\<`void`\>
235
-
236
- ***
237
-
238
- ### loadNodeFromIndex()
239
-
240
- ```ts
241
- loadNodeFromIndex(index): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
242
- ```
243
-
244
- ### Parameters
245
-
246
- #### index
247
-
248
- `number`
249
-
250
- ### Returns
251
-
252
- `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
253
-
254
- ***
255
-
256
- ### loadNodeFromManifest()
257
-
258
- ```ts
259
- loadNodeFromManifest(
260
- wallet,
261
- manifest,
262
- path?,
263
- loadConfigChildren?): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
264
- ```
265
-
266
- ### Parameters
267
-
268
- #### wallet
269
-
270
- `WalletInstance`
271
-
272
- #### manifest
273
-
274
- [`NodeManifest`](#../interfaces/NodeManifest)
275
-
276
- #### path?
277
-
278
- `string`
279
-
280
- #### loadConfigChildren?
281
-
282
- `boolean`
283
-
284
- ### Returns
285
-
286
- `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
287
-
288
- ***
289
-
290
- ### loadNodes()
291
-
292
- ```ts
293
- loadNodes(node?): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>[]>;
294
- ```
295
-
296
- Load the nodes that are defined in the wrapped manifest and optionally attach them to a node
297
-
298
- ### Parameters
299
-
300
- #### node?
301
-
302
- `MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>
303
-
304
- ### Returns
305
-
306
- `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>[]\>
307
-
308
- ***
309
-
310
- ### nodeManifest()
311
-
312
- ```ts
313
- nodeManifest(index): NodeManifest | undefined;
314
- ```
315
-
316
- ### Parameters
317
-
318
- #### index
319
-
320
- `number`
321
-
322
- ### Returns
323
-
324
- [`NodeManifest`](#../interfaces/NodeManifest) \| `undefined`
325
-
326
- ***
327
-
328
- ### as()
329
-
330
- ```ts
331
- static as<T>(value): PayloadDataWrapper<T> | null;
332
- ```
333
-
334
- ### Type Parameters
335
-
336
- #### T
337
-
338
- `T` *extends* `Payload` = `Payload`
339
-
340
- ### Parameters
341
-
342
- #### value
343
-
344
- `unknown`
345
-
346
- ### Returns
347
-
348
- `PayloadDataWrapper`\<`T`\> \| `null`
349
-
350
- ### Inherited from
351
-
352
- ```ts
353
- PayloadWrapper.as
354
- ```
355
-
356
- ***
357
-
358
- ### load()
359
-
360
- ```ts
361
- static load(address): Promise<PayloadDataWrapper<Payload> | null>;
362
- ```
363
-
364
- ### Parameters
365
-
366
- #### address
367
-
368
- `BrandedAddress`
369
-
370
- ### Returns
371
-
372
- `Promise`\<`PayloadDataWrapper`\<`Payload`\> \| `null`\>
373
-
374
- ### Inherited from
375
-
376
- ```ts
377
- PayloadWrapper.load
378
- ```
379
-
380
- ***
381
-
382
- ### parse()
383
-
384
- ```ts
385
- static parse<T>(payload?): PayloadDataWrapper<T> | undefined;
386
- ```
387
-
388
- ### Type Parameters
389
-
390
- #### T
391
-
392
- `T` *extends* `Payload`
393
-
394
- ### Parameters
395
-
396
- #### payload?
397
-
398
- `unknown`
399
-
400
- ### Returns
401
-
402
- `PayloadDataWrapper`\<`T`\> \| `undefined`
403
-
404
- ### Inherited from
405
-
406
- ```ts
407
- PayloadWrapper.parse
408
- ```
409
-
410
- ***
411
-
412
- ### setLoaderFactory()
413
-
414
- ```ts
415
- static setLoaderFactory(factory): void;
416
- ```
417
-
418
- ### Parameters
419
-
420
- #### factory
421
-
422
- `PayloadLoaderFactory` \| `null`
423
-
424
- ### Returns
425
-
426
- `void`
427
-
428
- ### Inherited from
429
-
430
- ```ts
431
- PayloadWrapper.setLoaderFactory
432
- ```
433
-
434
- ***
435
-
436
- ### tryParse()
437
-
438
- ```ts
439
- static tryParse<T>(obj): PayloadDataWrapper<T> | undefined;
440
- ```
441
-
442
- ### Type Parameters
443
-
444
- #### T
445
-
446
- `T` *extends* `Payload`
447
-
448
- ### Parameters
449
-
450
- #### obj
451
-
452
- `unknown`
453
-
454
- ### Returns
455
-
456
- `PayloadDataWrapper`\<`T`\> \| `undefined`
457
-
458
- ### Inherited from
459
-
460
- ```ts
461
- PayloadWrapper.tryParse
462
- ```
463
-
464
- ***
465
-
466
- ### wrap()
467
-
468
- ```ts
469
- static wrap<T>(payload?): PayloadDataWrapper<T>;
470
- ```
471
-
472
- ### Type Parameters
473
-
474
- #### T
475
-
476
- `T` *extends* `Payload`
477
-
478
- ### Parameters
479
-
480
- #### payload?
481
-
482
- `T` \| `PayloadDataWrapper`\<`T`\>
483
-
484
- ### Returns
485
-
486
- `PayloadDataWrapper`\<`T`\>
487
-
488
- ### Inherited from
489
-
490
- ```ts
491
- PayloadWrapper.wrap
492
- ```
493
-
494
- ***
495
-
496
- ### wrappedMap()
497
-
498
- ```ts
499
- static wrappedMap<T>(payloads): Promise<Record<string, PayloadDataWrapper<T>>>;
500
- ```
501
-
502
- ### Type Parameters
503
-
504
- #### T
505
-
506
- `T` *extends* `Payload`
507
-
508
- ### Parameters
509
-
510
- #### payloads
511
-
512
- (`T` \| `PayloadDataWrapper`\<`T`\>)[]
513
-
514
- ### Returns
515
-
516
- `Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
517
-
518
- ### Inherited from
519
-
520
- ```ts
521
- PayloadWrapper.wrappedMap
522
- ```
523
-
524
- ***
525
-
526
- ### validate()
527
-
528
- ```ts
529
- validate(): Promise<Error[]>;
530
- ```
531
-
532
- ### Returns
533
-
534
- `Promise`\<`Error`[]\>
535
-
536
- ### Inherited from
537
-
538
- ```ts
539
- PayloadWrapper.validate
540
- ```
541
-
542
- ***
543
-
544
- ### unwrap()
545
-
546
- ### Call Signature
547
-
548
- ```ts
549
- static unwrap<TPayload>(payload?): TPayload | undefined;
550
- ```
551
-
552
- #### Type Parameters
553
-
554
- ##### TPayload
555
-
556
- `TPayload` *extends* `Payload` = `Payload`
557
-
558
- #### Parameters
559
-
560
- ##### payload?
561
-
562
- `TPayload`
563
-
564
- #### Returns
565
-
566
- `TPayload` \| `undefined`
567
-
568
- #### Inherited from
569
-
570
- ```ts
571
- PayloadWrapper.unwrap
572
- ```
573
-
574
- ### Call Signature
575
-
576
- ```ts
577
- static unwrap<TPayload, TWrapper>(payload): TPayload;
578
- ```
579
-
580
- #### Type Parameters
581
-
582
- ##### TPayload
583
-
584
- `TPayload` *extends* `Payload` = `Payload`
585
-
586
- ##### TWrapper
587
-
588
- `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
589
-
590
- #### Parameters
591
-
592
- ##### payload
593
-
594
- `TPayload` \| `TWrapper`
595
-
596
- #### Returns
597
-
598
- `TPayload`
599
-
600
- #### Inherited from
601
-
602
- ```ts
603
- PayloadWrapper.unwrap
604
- ```
605
-
606
- ### Call Signature
607
-
608
- ```ts
609
- static unwrap<TPayload, TWrapper>(payload): TPayload[];
610
- ```
611
-
612
- #### Type Parameters
613
-
614
- ##### TPayload
615
-
616
- `TPayload` *extends* `Payload` = `Payload`
617
-
618
- ##### TWrapper
619
-
620
- `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
621
-
622
- #### Parameters
623
-
624
- ##### payload
625
-
626
- (`TPayload` \| `TWrapper`)[]
627
-
628
- #### Returns
629
-
630
- `TPayload`[]
631
-
632
- #### Inherited from
633
-
634
- ```ts
635
- PayloadWrapper.unwrap
636
- ```
637
-
638
- ***
639
-
640
- ### unwrapSinglePayload()
641
-
642
- ### Call Signature
643
-
644
- ```ts
645
- static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
646
- ```
647
-
648
- #### Type Parameters
649
-
650
- ##### TPayload
651
-
652
- `TPayload` *extends* `Payload` = `Payload`
653
-
654
- #### Parameters
655
-
656
- ##### payload?
657
-
658
- `TPayload`
659
-
660
- #### Returns
661
-
662
- `TPayload` \| `undefined`
663
-
664
- #### Inherited from
665
-
666
- ```ts
667
- PayloadWrapper.unwrapSinglePayload
668
- ```
669
-
670
- ### Call Signature
671
-
672
- ```ts
673
- static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
674
- ```
675
-
676
- #### Type Parameters
677
-
678
- ##### TPayload
679
-
680
- `TPayload` *extends* `Payload` = `Payload`
681
-
682
- ##### TWrapper
683
-
684
- `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
685
-
686
- #### Parameters
687
-
688
- ##### payload
689
-
690
- `TPayload` \| `TWrapper`
691
-
692
- #### Returns
693
-
694
- `TPayload`
695
-
696
- #### Inherited from
697
-
698
- ```ts
699
- PayloadWrapper.unwrapSinglePayload
700
- ```
701
-
702
- ***
703
-
704
- ### dataHash()
705
-
706
- ```ts
707
- dataHash(): Promise<BrandedHash>;
708
- ```
709
-
710
- ### Returns
711
-
712
- `Promise`\<`BrandedHash`\>
713
-
714
- ### Inherited from
715
-
716
- ```ts
717
- PayloadWrapper.dataHash
718
- ```
719
-
720
- ***
721
-
722
- ### getErrors()
723
-
724
- ```ts
725
- getErrors(): Promise<Error[]>;
726
- ```
727
-
728
- ### Returns
729
-
730
- `Promise`\<`Error`[]\>
731
-
732
- ### Inherited from
733
-
734
- ```ts
735
- PayloadWrapper.getErrors
736
- ```
737
-
738
- ***
739
-
740
- ### getValid()
741
-
742
- ```ts
743
- getValid(): Promise<boolean>;
744
- ```
745
-
746
- ### Returns
747
-
748
- `Promise`\<`boolean`\>
749
-
750
- ### Inherited from
751
-
752
- ```ts
753
- PayloadWrapper.getValid
754
- ```
755
-
756
- ***
757
-
758
- ### hash()
759
-
760
- ```ts
761
- hash(): Promise<BrandedHash>;
762
- ```
763
-
764
- ### Returns
765
-
766
- `Promise`\<`BrandedHash`\>
767
-
768
- ### Inherited from
769
-
770
- ```ts
771
- PayloadWrapper.hash
772
- ```
773
-
774
- ***
775
-
776
- ### schema()
777
-
778
- ```ts
779
- schema(): string;
780
- ```
781
-
782
- ### Returns
783
-
784
- `string`
785
-
786
- ### Inherited from
787
-
788
- ```ts
789
- PayloadWrapper.schema
790
- ```
791
-
792
- ### <a id="ManifestWrapperEx"></a>ManifestWrapperEx
793
-
794
- [**@xyo-network/manifest**](#../README)
795
-
796
- ***
797
-
798
- Provides functionality that can be performed on a PackageManifest
799
-
800
- ## Extends
801
-
802
- - `PayloadWrapper`\<`TManifest` *extends* `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\> ? `TManifest` : `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\>\>
803
-
804
- ## Type Parameters
805
-
806
- ### TManifest
807
-
808
- `TManifest` *extends*
809
- \| `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\>
810
- \| `void`
811
-
812
- ### TParams
813
-
814
- `TParams` *extends* [`ManifestWrapperExParams`](#../interfaces/ManifestWrapperExParams) = [`ManifestWrapperExParams`](#../interfaces/ManifestWrapperExParams)
815
-
816
- ## Constructors
817
-
818
- ### Constructor
819
-
820
- ```ts
821
- new ManifestWrapperEx<TManifest, TParams>(payload, params): ManifestWrapperEx<TManifest, TParams>;
822
- ```
823
-
824
- ### Parameters
825
-
826
- #### payload
827
-
828
- `TManifest` *extends* `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\> ? `TManifest` : `WithAnySchema`\<[`PackageManifestPayload`](#../type-aliases/PackageManifestPayload)\>
829
-
830
- #### params
831
-
832
- `TParams`
833
-
834
- ### Returns
835
-
836
- `ManifestWrapperEx`\<`TManifest`, `TParams`\>
837
-
838
- ### Overrides
839
-
840
- ```ts
841
- PayloadWrapper<TManifest extends WithAnySchema<PackageManifestPayload> ? TManifest : WithAnySchema<PackageManifestPayload>>.constructor
842
- ```
843
-
844
- ## Properties
845
-
846
- ### params
847
-
848
- ```ts
849
- protected params: TParams;
850
- ```
851
-
852
- ***
853
-
854
- ### loaderFactory
855
-
856
- ```ts
857
- protected static loaderFactory: PayloadLoaderFactory | null;
858
- ```
859
-
860
- ### Inherited from
861
-
862
- ```ts
863
- PayloadWrapper.loaderFactory
864
- ```
865
-
866
- ***
867
-
868
- ### payload
869
-
870
- ```ts
871
- payload: TManifest extends WithAnySchema<PackageManifestPayload> ? TManifest : WithAnySchema<PackageManifestPayload>;
872
- ```
873
-
874
- ### Inherited from
875
-
876
- ```ts
877
- PayloadWrapper.payload
878
- ```
879
-
880
- ## Accessors
881
-
882
- ### locator
883
-
884
- ### Get Signature
885
-
886
- ```ts
887
- get locator(): ModuleFactoryLocatorInstance;
888
- ```
889
-
890
- #### Returns
891
-
892
- `ModuleFactoryLocatorInstance`
893
-
894
- ***
895
-
896
- ### moduleIdentifierTransformers
897
-
898
- ### Get Signature
899
-
900
- ```ts
901
- get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
902
- ```
903
-
904
- #### Returns
905
-
906
- `ModuleIdentifierTransformer`[]
907
-
908
- ***
909
-
910
- ### privateChildren
911
-
912
- ### Get Signature
913
-
914
- ```ts
915
- get privateChildren(): ModuleManifest[];
916
- ```
917
-
918
- #### Returns
919
-
920
- [`ModuleManifest`](#../interfaces/ModuleManifest)[]
921
-
922
- ***
923
-
924
- ### publicChildren
925
-
926
- ### Get Signature
927
-
928
- ```ts
929
- get publicChildren(): ModuleManifest[];
930
- ```
931
-
932
- #### Returns
933
-
934
- [`ModuleManifest`](#../interfaces/ModuleManifest)[]
935
-
936
- ***
937
-
938
- ### wallet
939
-
940
- ### Get Signature
941
-
942
- ```ts
943
- get wallet(): WalletInstance;
944
- ```
945
-
946
- #### Returns
947
-
948
- `WalletInstance`
949
-
950
- ## Methods
951
-
952
- ### loadModule()
953
-
954
- ```ts
955
- loadModule(
956
- wallet,
957
- node,
958
- manifest,
959
- external?): Promise<void>;
960
- ```
961
-
962
- ### Parameters
963
-
964
- #### wallet
965
-
966
- `WalletInstance`
967
-
968
- #### node
969
-
970
- `MemoryNode`
971
-
972
- #### manifest
973
-
974
- [`ModuleManifest`](#../interfaces/ModuleManifest)
975
-
976
- #### external?
977
-
978
- `boolean`
979
-
980
- ### Returns
981
-
982
- `Promise`\<`void`\>
983
-
984
- ***
985
-
986
- ### loadNodeFromIndex()
987
-
988
- ```ts
989
- loadNodeFromIndex(index): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
990
- ```
991
-
992
- ### Parameters
993
-
994
- #### index
995
-
996
- `number`
997
-
998
- ### Returns
999
-
1000
- `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
1001
-
1002
- ***
1003
-
1004
- ### loadNodeFromManifest()
1005
-
1006
- ```ts
1007
- loadNodeFromManifest(
1008
- wallet,
1009
- manifest,
1010
- path?): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
1011
- ```
1012
-
1013
- ### Parameters
1014
-
1015
- #### wallet
1016
-
1017
- `WalletInstance`
1018
-
1019
- #### manifest
1020
-
1021
- [`NodeManifest`](#../interfaces/NodeManifest)
1022
-
1023
- #### path?
1024
-
1025
- `string`
1026
-
1027
- ### Returns
1028
-
1029
- `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
1030
-
1031
- ***
1032
-
1033
- ### loadNodes()
1034
-
1035
- ```ts
1036
- loadNodes(node?): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>[]>;
1037
- ```
1038
-
1039
- Load the nodes that are defined in the wrapped manifest and optionally attach them to a node
1040
-
1041
- ### Parameters
1042
-
1043
- #### node?
1044
-
1045
- `MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>
1046
-
1047
- ### Returns
1048
-
1049
- `Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>[]\>
1050
-
1051
- ***
1052
-
1053
- ### nodeManifest()
1054
-
1055
- ```ts
1056
- nodeManifest(index): NodeManifest | undefined;
1057
- ```
1058
-
1059
- ### Parameters
1060
-
1061
- #### index
1062
-
1063
- `number`
1064
-
1065
- ### Returns
1066
-
1067
- [`NodeManifest`](#../interfaces/NodeManifest) \| `undefined`
1068
-
1069
- ***
1070
-
1071
- ### as()
1072
-
1073
- ```ts
1074
- static as<T>(value): PayloadDataWrapper<T> | null;
1075
- ```
1076
-
1077
- ### Type Parameters
1078
-
1079
- #### T
1080
-
1081
- `T` *extends* `Payload` = `Payload`
1082
-
1083
- ### Parameters
1084
-
1085
- #### value
1086
-
1087
- `unknown`
1088
-
1089
- ### Returns
1090
-
1091
- `PayloadDataWrapper`\<`T`\> \| `null`
1092
-
1093
- ### Inherited from
1094
-
1095
- ```ts
1096
- PayloadWrapper.as
1097
- ```
1098
-
1099
- ***
1100
-
1101
- ### load()
1102
-
1103
- ```ts
1104
- static load(address): Promise<PayloadDataWrapper<Payload> | null>;
1105
- ```
1106
-
1107
- ### Parameters
1108
-
1109
- #### address
1110
-
1111
- `BrandedAddress`
1112
-
1113
- ### Returns
1114
-
1115
- `Promise`\<`PayloadDataWrapper`\<`Payload`\> \| `null`\>
1116
-
1117
- ### Inherited from
1118
-
1119
- ```ts
1120
- PayloadWrapper.load
1121
- ```
1122
-
1123
- ***
1124
-
1125
- ### parse()
1126
-
1127
- ```ts
1128
- static parse<T>(payload?): PayloadDataWrapper<T> | undefined;
1129
- ```
1130
-
1131
- ### Type Parameters
1132
-
1133
- #### T
1134
-
1135
- `T` *extends* `Payload`
1136
-
1137
- ### Parameters
1138
-
1139
- #### payload?
1140
-
1141
- `unknown`
1142
-
1143
- ### Returns
1144
-
1145
- `PayloadDataWrapper`\<`T`\> \| `undefined`
1146
-
1147
- ### Inherited from
1148
-
1149
- ```ts
1150
- PayloadWrapper.parse
1151
- ```
1152
-
1153
- ***
1154
-
1155
- ### setLoaderFactory()
1156
-
1157
- ```ts
1158
- static setLoaderFactory(factory): void;
1159
- ```
1160
-
1161
- ### Parameters
1162
-
1163
- #### factory
1164
-
1165
- `PayloadLoaderFactory` \| `null`
1166
-
1167
- ### Returns
1168
-
1169
- `void`
1170
-
1171
- ### Inherited from
1172
-
1173
- ```ts
1174
- PayloadWrapper.setLoaderFactory
1175
- ```
1176
-
1177
- ***
1178
-
1179
- ### tryParse()
1180
-
1181
- ```ts
1182
- static tryParse<T>(obj): PayloadDataWrapper<T> | undefined;
1183
- ```
1184
-
1185
- ### Type Parameters
1186
-
1187
- #### T
1188
-
1189
- `T` *extends* `Payload`
1190
-
1191
- ### Parameters
1192
-
1193
- #### obj
1194
-
1195
- `unknown`
1196
-
1197
- ### Returns
1198
-
1199
- `PayloadDataWrapper`\<`T`\> \| `undefined`
1200
-
1201
- ### Inherited from
1202
-
1203
- ```ts
1204
- PayloadWrapper.tryParse
1205
- ```
1206
-
1207
- ***
1208
-
1209
- ### wrap()
1210
-
1211
- ```ts
1212
- static wrap<T>(payload?): PayloadDataWrapper<T>;
1213
- ```
1214
-
1215
- ### Type Parameters
1216
-
1217
- #### T
1218
-
1219
- `T` *extends* `Payload`
1220
-
1221
- ### Parameters
1222
-
1223
- #### payload?
1224
-
1225
- `T` \| `PayloadDataWrapper`\<`T`\>
1226
-
1227
- ### Returns
1228
-
1229
- `PayloadDataWrapper`\<`T`\>
1230
-
1231
- ### Inherited from
1232
-
1233
- ```ts
1234
- PayloadWrapper.wrap
1235
- ```
1236
-
1237
- ***
1238
-
1239
- ### wrappedMap()
1240
-
1241
- ```ts
1242
- static wrappedMap<T>(payloads): Promise<Record<string, PayloadDataWrapper<T>>>;
1243
- ```
1244
-
1245
- ### Type Parameters
1246
-
1247
- #### T
1248
-
1249
- `T` *extends* `Payload`
1250
-
1251
- ### Parameters
1252
-
1253
- #### payloads
1254
-
1255
- (`T` \| `PayloadDataWrapper`\<`T`\>)[]
1256
-
1257
- ### Returns
1258
-
1259
- `Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
1260
-
1261
- ### Inherited from
1262
-
1263
- ```ts
1264
- PayloadWrapper.wrappedMap
1265
- ```
1266
-
1267
- ***
1268
-
1269
- ### validate()
1270
-
1271
- ```ts
1272
- validate(): Promise<Error[]>;
1273
- ```
1274
-
1275
- ### Returns
1276
-
1277
- `Promise`\<`Error`[]\>
1278
-
1279
- ### Inherited from
1280
-
1281
- ```ts
1282
- PayloadWrapper.validate
1283
- ```
1284
-
1285
- ***
1286
-
1287
- ### unwrap()
1288
-
1289
- ### Call Signature
1290
-
1291
- ```ts
1292
- static unwrap<TPayload>(payload?): TPayload | undefined;
1293
- ```
1294
-
1295
- #### Type Parameters
1296
-
1297
- ##### TPayload
1298
-
1299
- `TPayload` *extends* `Payload` = `Payload`
1300
-
1301
- #### Parameters
1302
-
1303
- ##### payload?
1304
-
1305
- `TPayload`
1306
-
1307
- #### Returns
1308
-
1309
- `TPayload` \| `undefined`
1310
-
1311
- #### Inherited from
1312
-
1313
- ```ts
1314
- PayloadWrapper.unwrap
1315
- ```
1316
-
1317
- ### Call Signature
1318
-
1319
- ```ts
1320
- static unwrap<TPayload, TWrapper>(payload): TPayload;
1321
- ```
1322
-
1323
- #### Type Parameters
1324
-
1325
- ##### TPayload
1326
-
1327
- `TPayload` *extends* `Payload` = `Payload`
1328
-
1329
- ##### TWrapper
1330
-
1331
- `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
1332
-
1333
- #### Parameters
1334
-
1335
- ##### payload
1336
-
1337
- `TPayload` \| `TWrapper`
1338
-
1339
- #### Returns
1340
-
1341
- `TPayload`
1342
-
1343
- #### Inherited from
1344
-
1345
- ```ts
1346
- PayloadWrapper.unwrap
1347
- ```
1348
-
1349
- ### Call Signature
1350
-
1351
- ```ts
1352
- static unwrap<TPayload, TWrapper>(payload): TPayload[];
1353
- ```
1354
-
1355
- #### Type Parameters
1356
-
1357
- ##### TPayload
1358
-
1359
- `TPayload` *extends* `Payload` = `Payload`
1360
-
1361
- ##### TWrapper
1362
-
1363
- `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
1364
-
1365
- #### Parameters
1366
-
1367
- ##### payload
1368
-
1369
- (`TPayload` \| `TWrapper`)[]
1370
-
1371
- #### Returns
1372
-
1373
- `TPayload`[]
1374
-
1375
- #### Inherited from
1376
-
1377
- ```ts
1378
- PayloadWrapper.unwrap
1379
- ```
1380
-
1381
- ***
1382
-
1383
- ### unwrapSinglePayload()
1384
-
1385
- ### Call Signature
1386
-
1387
- ```ts
1388
- static unwrapSinglePayload<TPayload>(payload?): TPayload | undefined;
1389
- ```
1390
-
1391
- #### Type Parameters
1392
-
1393
- ##### TPayload
1394
-
1395
- `TPayload` *extends* `Payload` = `Payload`
1396
-
1397
- #### Parameters
1398
-
1399
- ##### payload?
1400
-
1401
- `TPayload`
1402
-
1403
- #### Returns
1404
-
1405
- `TPayload` \| `undefined`
1406
-
1407
- #### Inherited from
1408
-
1409
- ```ts
1410
- PayloadWrapper.unwrapSinglePayload
1411
- ```
1412
-
1413
- ### Call Signature
1414
-
1415
- ```ts
1416
- static unwrapSinglePayload<TPayload, TWrapper>(payload): TPayload;
1417
- ```
1418
-
1419
- #### Type Parameters
1420
-
1421
- ##### TPayload
1422
-
1423
- `TPayload` *extends* `Payload` = `Payload`
1424
-
1425
- ##### TWrapper
1426
-
1427
- `TWrapper` *extends* `PayloadWrapperBase`\<`TPayload`\> = `PayloadWrapperBase`\<`TPayload`\>
1428
-
1429
- #### Parameters
1430
-
1431
- ##### payload
1432
-
1433
- `TPayload` \| `TWrapper`
1434
-
1435
- #### Returns
1436
-
1437
- `TPayload`
1438
-
1439
- #### Inherited from
1440
-
1441
- ```ts
1442
- PayloadWrapper.unwrapSinglePayload
1443
- ```
1444
-
1445
- ***
1446
-
1447
- ### dataHash()
1448
-
1449
- ```ts
1450
- dataHash(): Promise<BrandedHash>;
1451
- ```
1452
-
1453
- ### Returns
1454
-
1455
- `Promise`\<`BrandedHash`\>
1456
-
1457
- ### Inherited from
1458
-
1459
- ```ts
1460
- PayloadWrapper.dataHash
1461
- ```
1462
-
1463
- ***
1464
-
1465
- ### getErrors()
1466
-
1467
- ```ts
1468
- getErrors(): Promise<Error[]>;
1469
- ```
1470
-
1471
- ### Returns
1472
-
1473
- `Promise`\<`Error`[]\>
1474
-
1475
- ### Inherited from
1476
-
1477
- ```ts
1478
- PayloadWrapper.getErrors
1479
- ```
1480
-
1481
- ***
1482
-
1483
- ### getValid()
1484
-
1485
- ```ts
1486
- getValid(): Promise<boolean>;
1487
- ```
1488
-
1489
- ### Returns
1490
-
1491
- `Promise`\<`boolean`\>
1492
-
1493
- ### Inherited from
1494
-
1495
- ```ts
1496
- PayloadWrapper.getValid
1497
- ```
1498
-
1499
- ***
1500
-
1501
- ### hash()
1502
-
1503
- ```ts
1504
- hash(): Promise<BrandedHash>;
1505
- ```
1506
-
1507
- ### Returns
1508
-
1509
- `Promise`\<`BrandedHash`\>
1510
-
1511
- ### Inherited from
1512
-
1513
- ```ts
1514
- PayloadWrapper.hash
1515
- ```
1516
-
1517
- ***
1518
-
1519
- ### schema()
1520
-
1521
- ```ts
1522
- schema(): string;
1523
- ```
1524
-
1525
- ### Returns
1526
-
1527
- `string`
1528
-
1529
- ### Inherited from
1530
-
1531
- ```ts
1532
- PayloadWrapper.schema
1533
- ```
1534
-
1535
- ### interfaces
1536
-
1537
- ### <a id="ConfigManifest"></a>ConfigManifest
1538
-
1539
- [**@xyo-network/manifest**](#../README)
1540
-
1541
- ***
1542
-
1543
- ## Properties
1544
-
1545
- ### accountPath?
1546
-
1547
- ```ts
1548
- optional accountPath?: string;
1549
- ```
1550
-
1551
- ***
1552
-
1553
- ### features?
1554
-
1555
- ```ts
1556
- optional features?: string[];
1557
- ```
1558
-
1559
- ***
1560
-
1561
- ### labels?
1562
-
1563
- ```ts
1564
- optional labels?: Record<string, string | undefined>;
1565
- ```
1566
-
1567
- ***
1568
-
1569
- ### language?
1570
-
1571
- ```ts
1572
- optional language?: string;
1573
- ```
1574
-
1575
- ***
1576
-
1577
- ### name
1578
-
1579
- ```ts
1580
- name: string;
1581
- ```
1582
-
1583
- ***
1584
-
1585
- ### os?
1586
-
1587
- ```ts
1588
- optional os?: string;
1589
- ```
1590
-
1591
- ***
1592
-
1593
- ### schema
1594
-
1595
- ```ts
1596
- schema: Schema;
1597
- ```
1598
-
1599
- ### <a id="Manifest"></a>Manifest
1600
-
1601
- [**@xyo-network/manifest**](#../README)
1602
-
1603
- ***
1604
-
1605
- ## Extended by
1606
-
1607
- - [`ModuleManifest`](#ModuleManifest)
1608
- - [`PackageManifest`](#PackageManifest)
1609
-
1610
- ## Properties
1611
-
1612
- ### description?
1613
-
1614
- ```ts
1615
- optional description?: string;
1616
- ```
1617
-
1618
- ### <a id="ManifestWrapperExParams"></a>ManifestWrapperExParams
1619
-
1620
- [**@xyo-network/manifest**](#../README)
1621
-
1622
- ***
1623
-
1624
- ## Properties
1625
-
1626
- ### locator
1627
-
1628
- ```ts
1629
- locator: ModuleFactoryLocatorInstance;
1630
- ```
1631
-
1632
- ***
1633
-
1634
- ### moduleIdentifierTransformers?
1635
-
1636
- ```ts
1637
- optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
1638
- ```
1639
-
1640
- ***
1641
-
1642
- ### privateChildren?
1643
-
1644
- ```ts
1645
- optional privateChildren?: ModuleManifest[];
1646
- ```
1647
-
1648
- ***
1649
-
1650
- ### publicChildren?
1651
-
1652
- ```ts
1653
- optional publicChildren?: ModuleManifest[];
1654
- ```
1655
-
1656
- ***
1657
-
1658
- ### wallet
1659
-
1660
- ```ts
1661
- wallet: WalletInstance;
1662
- ```
1663
-
1664
- ### <a id="ModuleManifest"></a>ModuleManifest
1665
-
1666
- [**@xyo-network/manifest**](#../README)
1667
-
1668
- ***
1669
-
1670
- ## Extends
1671
-
1672
- - [`Manifest`](#Manifest)
1673
-
1674
- ## Extended by
1675
-
1676
- - [`NodeManifest`](#NodeManifest)
1677
-
1678
- ## Properties
1679
-
1680
- ### description?
1681
-
1682
- ```ts
1683
- optional description?: string;
1684
- ```
1685
-
1686
- ### Inherited from
1687
-
1688
- [`Manifest`](#Manifest).[`description`](Manifest.md#description)
1689
-
1690
- ***
1691
-
1692
- ### config
1693
-
1694
- ```ts
1695
- config: ConfigManifest;
1696
- ```
1697
-
1698
- ***
1699
-
1700
- ### lazyStart?
1701
-
1702
- ```ts
1703
- optional lazyStart?: boolean;
1704
- ```
1705
-
1706
- ***
1707
-
1708
- ### status?
1709
-
1710
- ```ts
1711
- optional status?: object;
1712
- ```
1713
-
1714
- ### address
1715
-
1716
- ```ts
1717
- address: BrandedAddress;
1718
- ```
1719
-
1720
- ### children?
1721
-
1722
- ```ts
1723
- optional children?: Record<BrandedAddress, string | null>;
1724
- ```
1725
-
1726
- ### <a id="NodeManifest"></a>NodeManifest
1727
-
1728
- [**@xyo-network/manifest**](#../README)
1729
-
1730
- ***
1731
-
1732
- ## Extends
1733
-
1734
- - [`ModuleManifest`](#ModuleManifest)
1735
-
1736
- ## Extended by
1737
-
1738
- - [`NodeManifestPayload`](#NodeManifestPayload)
1739
-
1740
- ## Properties
1741
-
1742
- ### description?
1743
-
1744
- ```ts
1745
- optional description?: string;
1746
- ```
1747
-
1748
- ### Inherited from
1749
-
1750
- [`ModuleManifest`](#ModuleManifest).[`description`](ModuleManifest.md#description)
1751
-
1752
- ***
1753
-
1754
- ### modules?
1755
-
1756
- ```ts
1757
- optional modules?: object;
1758
- ```
1759
-
1760
- ### private?
1761
-
1762
- ```ts
1763
- optional private?: (
1764
- | ModuleManifest
1765
- | ModuleAlias)[];
1766
- ```
1767
-
1768
- ### public?
1769
-
1770
- ```ts
1771
- optional public?: (
1772
- | ModuleManifest
1773
- | ModuleAlias)[];
1774
- ```
1775
-
1776
- ***
1777
-
1778
- ### config
1779
-
1780
- ```ts
1781
- config: ConfigManifest;
1782
- ```
1783
-
1784
- ### Inherited from
1785
-
1786
- [`ModuleManifest`](#ModuleManifest).[`config`](ModuleManifest.md#config)
1787
-
1788
- ***
1789
-
1790
- ### lazyStart?
1791
-
1792
- ```ts
1793
- optional lazyStart?: boolean;
1794
- ```
1795
-
1796
- ### Inherited from
1797
-
1798
- [`ModuleManifest`](#ModuleManifest).[`lazyStart`](ModuleManifest.md#lazystart)
1799
-
1800
- ***
1801
-
1802
- ### status?
1803
-
1804
- ```ts
1805
- optional status?: object;
1806
- ```
1807
-
1808
- ### address
1809
-
1810
- ```ts
1811
- address: BrandedAddress;
1812
- ```
1813
-
1814
- ### children?
1815
-
1816
- ```ts
1817
- optional children?: Record<BrandedAddress, string | null>;
1818
- ```
1819
-
1820
- ### Inherited from
1821
-
1822
- [`ModuleManifest`](#ModuleManifest).[`status`](ModuleManifest.md#status)
1823
-
1824
- ### <a id="NodeManifestPayload"></a>NodeManifestPayload
1825
-
1826
- [**@xyo-network/manifest**](#../README)
1827
-
1828
- ***
1829
-
1830
- ## Extends
1831
-
1832
- - [`NodeManifest`](#NodeManifest)
1833
-
1834
- ## Properties
1835
-
1836
- ### description?
1837
-
1838
- ```ts
1839
- optional description?: string;
1840
- ```
1841
-
1842
- ### Inherited from
1843
-
1844
- [`NodeManifest`](#NodeManifest).[`description`](NodeManifest.md#description)
1845
-
1846
- ***
1847
-
1848
- ### modules?
1849
-
1850
- ```ts
1851
- optional modules?: object;
1852
- ```
1853
-
1854
- ### private?
1855
-
1856
- ```ts
1857
- optional private?: (
1858
- | ModuleManifest
1859
- | ModuleAlias)[];
1860
- ```
1861
-
1862
- ### public?
1863
-
1864
- ```ts
1865
- optional public?: (
1866
- | ModuleManifest
1867
- | ModuleAlias)[];
1868
- ```
1869
-
1870
- ### Inherited from
1871
-
1872
- [`NodeManifest`](#NodeManifest).[`modules`](NodeManifest.md#modules)
1873
-
1874
- ***
1875
-
1876
- ### config
1877
-
1878
- ```ts
1879
- config: ConfigManifest;
1880
- ```
1881
-
1882
- ### Inherited from
1883
-
1884
- [`NodeManifest`](#NodeManifest).[`config`](NodeManifest.md#config)
1885
-
1886
- ***
1887
-
1888
- ### lazyStart?
1889
-
1890
- ```ts
1891
- optional lazyStart?: boolean;
1892
- ```
1893
-
1894
- ### Inherited from
1895
-
1896
- [`NodeManifest`](#NodeManifest).[`lazyStart`](NodeManifest.md#lazystart)
1897
-
1898
- ***
1899
-
1900
- ### status?
1901
-
1902
- ```ts
1903
- optional status?: object;
1904
- ```
1905
-
1906
- ### address
1907
-
1908
- ```ts
1909
- address: BrandedAddress;
1910
- ```
1911
-
1912
- ### children?
1913
-
1914
- ```ts
1915
- optional children?: Record<BrandedAddress, string | null>;
1916
- ```
1917
-
1918
- ### Inherited from
1919
-
1920
- [`NodeManifest`](#NodeManifest).[`status`](NodeManifest.md#status)
1921
-
1922
- ***
1923
-
1924
- ### schema
1925
-
1926
- ```ts
1927
- schema: "network.xyo.node.manifest" & object;
1928
- ```
1929
-
1930
- ### Type Declaration
1931
-
1932
- #### \_\_schema
1933
-
1934
- ```ts
1935
- readonly __schema: true;
1936
- ```
1937
-
1938
- ### <a id="PackageManifest"></a>PackageManifest
1939
-
1940
- [**@xyo-network/manifest**](#../README)
1941
-
1942
- ***
1943
-
1944
- ## Extends
1945
-
1946
- - [`Manifest`](#Manifest)
1947
-
1948
- ## Properties
1949
-
1950
- ### description?
1951
-
1952
- ```ts
1953
- optional description?: string;
1954
- ```
1955
-
1956
- ### Inherited from
1957
-
1958
- [`Manifest`](#Manifest).[`description`](Manifest.md#description)
1959
-
1960
- ***
1961
-
1962
- ### modules?
1963
-
1964
- ```ts
1965
- optional modules?: Record<ModuleAlias, ModuleManifest>;
1966
- ```
1967
-
1968
- ***
1969
-
1970
- ### nodes
1971
-
1972
- ```ts
1973
- nodes: NodeManifest[];
1974
- ```
1975
-
1976
- ### type-aliases
1977
-
1978
- ### <a id="DappPackageManifestPayloadSchema"></a>DappPackageManifestPayloadSchema
1979
-
1980
- [**@xyo-network/manifest**](#../README)
1981
-
1982
- ***
1983
-
1984
- ```ts
1985
- type DappPackageManifestPayloadSchema = typeof DappPackageManifestPayloadSchema;
1986
- ```
1987
-
1988
- ### <a id="ModuleAlias"></a>ModuleAlias
1989
-
1990
- [**@xyo-network/manifest**](#../README)
1991
-
1992
- ***
1993
-
1994
- ```ts
1995
- type ModuleAlias = Brand<string, {
1996
- __moduleAlias: true;
1997
- }>;
1998
- ```
1999
-
2000
- ### <a id="ModuleManifestPayload"></a>ModuleManifestPayload
2001
-
2002
- [**@xyo-network/manifest**](#../README)
2003
-
2004
- ***
2005
-
2006
- ```ts
2007
- type ModuleManifestPayload = Payload<ModuleManifest,
2008
- | ModuleManifestPayloadSchema
2009
- | NodeManifestPayloadSchema>;
2010
- ```
2011
-
2012
- ### <a id="ModuleManifestPayloadSchema"></a>ModuleManifestPayloadSchema
2013
-
2014
- [**@xyo-network/manifest**](#../README)
2015
-
2016
- ***
2017
-
2018
- ```ts
2019
- type ModuleManifestPayloadSchema = typeof ModuleManifestPayloadSchema;
2020
- ```
2021
-
2022
- ### <a id="NodeManifestPayloadSchema"></a>NodeManifestPayloadSchema
2023
-
2024
- [**@xyo-network/manifest**](#../README)
2025
-
2026
- ***
2027
-
2028
- ```ts
2029
- type NodeManifestPayloadSchema = typeof NodeManifestPayloadSchema;
2030
- ```
2031
-
2032
- ### <a id="PackageManifestPayload"></a>PackageManifestPayload
2033
-
2034
- [**@xyo-network/manifest**](#../README)
2035
-
2036
- ***
2037
-
2038
- ```ts
2039
- type PackageManifestPayload = Payload<PackageManifest, PackageManifestPayloadSchema>;
2040
- ```
2041
-
2042
- ### <a id="PackageManifestPayloadSchema"></a>PackageManifestPayloadSchema
2043
-
2044
- [**@xyo-network/manifest**](#../README)
2045
-
2046
- ***
2047
-
2048
- ```ts
2049
- type PackageManifestPayloadSchema = typeof PackageManifestPayloadSchema;
2050
- ```
2051
-
2052
- ### variables
2053
-
2054
- ### <a id="DappPackageManifestPayloadSchema"></a>DappPackageManifestPayloadSchema
2055
-
2056
- [**@xyo-network/manifest**](#../README)
2057
-
2058
- ***
2059
-
2060
- ```ts
2061
- const DappPackageManifestPayloadSchema: "network.xyo.manifest.package.dapp" & object;
2062
- ```
2063
-
2064
- ## Type Declaration
2065
-
2066
- ### \_\_schema
2067
-
2068
- ```ts
2069
- readonly __schema: true;
2070
- ```
2071
-
2072
- ### <a id="ModuleManifestPayloadSchema"></a>ModuleManifestPayloadSchema
2073
-
2074
- [**@xyo-network/manifest**](#../README)
2075
-
2076
- ***
2077
-
2078
- ```ts
2079
- const ModuleManifestPayloadSchema: "network.xyo.module.manifest" & object;
2080
- ```
2081
-
2082
- ## Type Declaration
2083
-
2084
- ### \_\_schema
2085
-
2086
- ```ts
2087
- readonly __schema: true;
2088
- ```
2089
-
2090
- ### <a id="NodeManifestPayloadSchema"></a>NodeManifestPayloadSchema
2091
-
2092
- [**@xyo-network/manifest**](#../README)
2093
-
2094
- ***
2095
-
2096
- ```ts
2097
- const NodeManifestPayloadSchema: "network.xyo.node.manifest" & object;
2098
- ```
2099
-
2100
- ## Type Declaration
2101
-
2102
- ### \_\_schema
2103
-
2104
- ```ts
2105
- readonly __schema: true;
2106
- ```
2107
-
2108
- ### <a id="PackageManifestPayloadSchema"></a>PackageManifestPayloadSchema
2109
-
2110
- [**@xyo-network/manifest**](#../README)
2111
-
2112
- ***
2113
-
2114
- ```ts
2115
- const PackageManifestPayloadSchema: "network.xyo.manifest.package" & object;
2116
- ```
2117
-
2118
- ## Type Declaration
2119
-
2120
- ### \_\_schema
2121
-
2122
- ```ts
2123
- readonly __schema: true;
2124
- ```
2125
-
2126
- ### <a id="isManifest"></a>isManifest
2127
-
2128
- [**@xyo-network/manifest**](#../README)
2129
-
2130
- ***
2131
-
2132
- ```ts
2133
- const isManifest: (value) => value is Manifest;
2134
- ```
2135
-
2136
- ## Parameters
2137
-
2138
- ### value
2139
-
2140
- `unknown`
2141
-
2142
- ## Returns
2143
-
2144
- `value is Manifest`
2145
-
2146
- ### <a id="isPackageManifestPayload"></a>isPackageManifestPayload
2147
-
2148
- [**@xyo-network/manifest**](#../README)
2149
-
2150
- ***
2151
-
2152
- ```ts
2153
- const isPackageManifestPayload: (x?) => x is PackageManifestPayload;
2154
- ```
2155
-
2156
- ## Parameters
2157
-
2158
- ### x?
2159
-
2160
- `unknown` \| `null`
2161
-
2162
- ## Returns
2163
-
2164
- `x is PackageManifestPayload`
2165
41
 
2166
42
 
2167
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png