@xyo-network/sdk-js 4.3.0 → 5.0.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.
Files changed (758) hide show
  1. package/package.json +16 -12
  2. package/src/spec/loading.spec.ts +12 -0
  3. package/BUILD_STATUS.md +0 -27
  4. package/build/neutral/index.d.ts +0 -4
  5. package/build/neutral/index.d.ts.map +0 -1
  6. package/docker/grafana/provisioning/dashboards/NodeJS Application Dashboard-11159.json +0 -951
  7. package/docker/grafana/provisioning/dashboards/Nodejs Metrics-11956.json +0 -1759
  8. package/docker/grafana/provisioning/dashboards/dashboard.yml +0 -12
  9. package/docker/grafana/provisioning/datasources/datasource.yml +0 -11
  10. package/docker/prometheus/prometheus.yml +0 -14
  11. package/docker-compose.metrics.yml +0 -33
  12. package/docker-compose.yml +0 -62
  13. package/docs/README.md +0 -748
  14. package/docs/classes/AbstractData.md +0 -127
  15. package/docs/classes/AbstractModuleResolver.md +0 -666
  16. package/docs/classes/Account.md +0 -431
  17. package/docs/classes/AddressValue.md +0 -251
  18. package/docs/classes/ArchivistWrapper.md +0 -2073
  19. package/docs/classes/BaseEmitter.md +0 -643
  20. package/docs/classes/BoundWitnessBuilder.md +0 -1387
  21. package/docs/classes/BoundWitnessValidator.md +0 -243
  22. package/docs/classes/BoundWitnessWrapper.md +0 -697
  23. package/docs/classes/BridgeWrapper.md +0 -1807
  24. package/docs/classes/CompositeModuleResolver.md +0 -824
  25. package/docs/classes/Data.md +0 -173
  26. package/docs/classes/DeadModuleError.md +0 -191
  27. package/docs/classes/DivinerWrapper.md +0 -1819
  28. package/docs/classes/EllipticKey.md +0 -180
  29. package/docs/classes/Events.md +0 -743
  30. package/docs/classes/Huri.md +0 -161
  31. package/docs/classes/IsAttachableArchivistInstanceFactory.md +0 -55
  32. package/docs/classes/IsAttachableBridgeInstanceFactory.md +0 -55
  33. package/docs/classes/IsAttachableDivinerInstanceFactory.md +0 -55
  34. package/docs/classes/IsAttachableModuleInstanceFactory.md +0 -55
  35. package/docs/classes/IsAttachableNodeInstanceFactory.md +0 -55
  36. package/docs/classes/IsAttachableSentinelInstanceFactory.md +0 -55
  37. package/docs/classes/IsAttachableWitnessInstanceFactory.md +0 -55
  38. package/docs/classes/IsInstanceFactory.md +0 -55
  39. package/docs/classes/IsModuleFactory.md +0 -43
  40. package/docs/classes/ManifestWrapper.md +0 -689
  41. package/docs/classes/ManifestWrapperEx.md +0 -743
  42. package/docs/classes/ModuleDetailsError.md +0 -179
  43. package/docs/classes/ModuleFactory.md +0 -243
  44. package/docs/classes/ModuleWrapper.md +0 -1559
  45. package/docs/classes/NameRegistrarTransformer.md +0 -53
  46. package/docs/classes/NodeWrapper.md +0 -1983
  47. package/docs/classes/ObjectHasher.md +0 -657
  48. package/docs/classes/PayloadBuilder.md +0 -967
  49. package/docs/classes/PayloadHasher.md +0 -657
  50. package/docs/classes/PayloadValidator.md +0 -121
  51. package/docs/classes/PayloadWrapper.md +0 -462
  52. package/docs/classes/PayloadWrapperBase.md +0 -225
  53. package/docs/classes/PrivateKey.md +0 -265
  54. package/docs/classes/PublicKey.md +0 -261
  55. package/docs/classes/QueryBoundWitnessBuilder.md +0 -1459
  56. package/docs/classes/QueryBoundWitnessWrapper.md +0 -861
  57. package/docs/classes/ResolveHelper.md +0 -217
  58. package/docs/classes/SequenceParser.md +0 -469
  59. package/docs/classes/SimpleModuleResolver.md +0 -779
  60. package/docs/classes/WasmSupport.md +0 -231
  61. package/docs/classes/WitnessWrapper.md +0 -1803
  62. package/docs/functions/constructableModuleWrapper.md +0 -33
  63. package/docs/functions/creatableModule.md +0 -39
  64. package/docs/functions/creatableModuleFactory.md +0 -39
  65. package/docs/functions/isPayloadOfSchemaType.md +0 -33
  66. package/docs/functions/labeledCreatableModuleFactory.md +0 -39
  67. package/docs/interfaces/AddressChildFields.md +0 -41
  68. package/docs/interfaces/AddressFields.md +0 -17
  69. package/docs/interfaces/AddressObjectFilter.md +0 -95
  70. package/docs/interfaces/AddressToWeakInstanceCache.md +0 -45
  71. package/docs/interfaces/AllArchivist.md +0 -35
  72. package/docs/interfaces/AllArchivistFunctions.md +0 -27
  73. package/docs/interfaces/ArchivingModuleConfig.md +0 -21
  74. package/docs/interfaces/ArchivingReentrancyConfig.md +0 -21
  75. package/docs/interfaces/Archivist.md +0 -163
  76. package/docs/interfaces/ArchivistInstance.md +0 -1299
  77. package/docs/interfaces/ArchivistLabels.md +0 -23
  78. package/docs/interfaces/ArchivistModuleEventData.md +0 -157
  79. package/docs/interfaces/ArchivistModuleInstance.md +0 -486
  80. package/docs/interfaces/ArchivistNextOptions.md +0 -57
  81. package/docs/interfaces/ArchivistParamFields.md +0 -13
  82. package/docs/interfaces/ArchivistParentInstances.md +0 -29
  83. package/docs/interfaces/ArchivistParents.md +0 -29
  84. package/docs/interfaces/ArchivistRawQueryFunctions.md +0 -151
  85. package/docs/interfaces/ArchivistStorage.md +0 -15
  86. package/docs/interfaces/AttachableArchivistInstance.md +0 -1331
  87. package/docs/interfaces/AttachableBridgeInstance.md +0 -1141
  88. package/docs/interfaces/AttachableDivinerInstance.md +0 -1085
  89. package/docs/interfaces/AttachableModuleInstance.md +0 -1018
  90. package/docs/interfaces/AttachableNodeInstance.md +0 -1309
  91. package/docs/interfaces/AttachableSentinelInstance.md +0 -1069
  92. package/docs/interfaces/AttachableWitnessInstance.md +0 -1077
  93. package/docs/interfaces/BoundWitnessBlockField.md +0 -17
  94. package/docs/interfaces/BoundWitnessChainField.md +0 -17
  95. package/docs/interfaces/BoundWitnessFields.md +0 -105
  96. package/docs/interfaces/BoundWitnessMeta.md +0 -29
  97. package/docs/interfaces/BoundWitnessOptionalFields.md +0 -49
  98. package/docs/interfaces/BoundWitnessRequiredFields.md +0 -45
  99. package/docs/interfaces/BridgeExposeOptions.md +0 -25
  100. package/docs/interfaces/BridgeInstance.md +0 -1105
  101. package/docs/interfaces/BridgeModule.md +0 -486
  102. package/docs/interfaces/BridgeModuleEventData.md +0 -269
  103. package/docs/interfaces/BridgeParams.md +0 -143
  104. package/docs/interfaces/BridgeQueryFunctions.md +0 -97
  105. package/docs/interfaces/BridgeRawQueryFunctions.md +0 -93
  106. package/docs/interfaces/BridgeUnexposeOptions.md +0 -33
  107. package/docs/interfaces/CacheConfig.md +0 -29
  108. package/docs/interfaces/ChildCertificationFields.md +0 -21
  109. package/docs/interfaces/CompositeModuleResolverParams.md +0 -69
  110. package/docs/interfaces/ConfigManifest.md +0 -61
  111. package/docs/interfaces/CreatableModule.md +0 -139
  112. package/docs/interfaces/CreatableModuleRegistry.md +0 -9
  113. package/docs/interfaces/CustomSentinelInstance.md +0 -1033
  114. package/docs/interfaces/CustomSentinelModule.md +0 -485
  115. package/docs/interfaces/DataHashStorageMeta.md +0 -17
  116. package/docs/interfaces/DataInstance.md +0 -37
  117. package/docs/interfaces/DivineEndEventData.md +0 -55
  118. package/docs/interfaces/DivineStartEventData.md +0 -43
  119. package/docs/interfaces/DivinerInstance.md +0 -1053
  120. package/docs/interfaces/DivinerModule.md +0 -485
  121. package/docs/interfaces/DivinerQueryFunctions.md +0 -67
  122. package/docs/interfaces/EventFunctions.md +0 -235
  123. package/docs/interfaces/ExposedEventData.md +0 -43
  124. package/docs/interfaces/FetchedPayload.md +0 -27
  125. package/docs/interfaces/FullArchivist.md +0 -147
  126. package/docs/interfaces/HashStorageMeta.md +0 -33
  127. package/docs/interfaces/HuriOptions.md +0 -21
  128. package/docs/interfaces/JobEndEventData.md +0 -47
  129. package/docs/interfaces/JobStartEventData.md +0 -43
  130. package/docs/interfaces/Labels.md +0 -15
  131. package/docs/interfaces/Manifest.md +0 -18
  132. package/docs/interfaces/ManifestWrapperExParams.md +0 -45
  133. package/docs/interfaces/Module.md +0 -492
  134. package/docs/interfaces/ModuleAttachedEventData.md +0 -29
  135. package/docs/interfaces/ModuleBusyEventData.md +0 -43
  136. package/docs/interfaces/ModuleConfigFields.md +0 -130
  137. package/docs/interfaces/ModuleDescription.md +0 -37
  138. package/docs/interfaces/ModuleDetachedEventData.md +0 -29
  139. package/docs/interfaces/ModuleErrorEventData.md +0 -43
  140. package/docs/interfaces/ModuleEventData.md +0 -106
  141. package/docs/interfaces/ModuleFactoryLocatorInstance.md +0 -159
  142. package/docs/interfaces/ModuleFamilyFunctions.md +0 -131
  143. package/docs/interfaces/ModuleFields.md +0 -173
  144. package/docs/interfaces/ModuleFilterOptions.md +0 -87
  145. package/docs/interfaces/ModuleIdentifierTransformer.md +0 -13
  146. package/docs/interfaces/ModuleInstance.md +0 -987
  147. package/docs/interfaces/ModuleManifest.md +0 -57
  148. package/docs/interfaces/ModuleNameResolver.md +0 -39
  149. package/docs/interfaces/ModuleQueriedEventData.md +0 -51
  150. package/docs/interfaces/ModuleQueryFunctions.md +0 -99
  151. package/docs/interfaces/ModuleRegisteredEventData.md +0 -29
  152. package/docs/interfaces/ModuleRepository.md +0 -391
  153. package/docs/interfaces/ModuleResolvedEventArgs.md +0 -21
  154. package/docs/interfaces/ModuleResolver.md +0 -243
  155. package/docs/interfaces/ModuleResolverInstance.md +0 -317
  156. package/docs/interfaces/ModuleResolverParams.md +0 -41
  157. package/docs/interfaces/ModuleSecurityConfig.md +0 -41
  158. package/docs/interfaces/ModuleSubscribeFilter.md +0 -17
  159. package/docs/interfaces/ModuleTask.md +0 -55
  160. package/docs/interfaces/ModuleUnregisteredEventData.md +0 -29
  161. package/docs/interfaces/NameObjectFilter.md +0 -95
  162. package/docs/interfaces/NextOptions.md +0 -47
  163. package/docs/interfaces/NodeInstance.md +0 -1277
  164. package/docs/interfaces/NodeManifest.md +0 -85
  165. package/docs/interfaces/NodeManifestPayload.md +0 -93
  166. package/docs/interfaces/NodeModule.md +0 -486
  167. package/docs/interfaces/NodeModuleEventData.md +0 -157
  168. package/docs/interfaces/NodeQueryFunctions.md +0 -197
  169. package/docs/interfaces/NodeRegistrationFunctions.md +0 -57
  170. package/docs/interfaces/ObjectFilterOptions.md +0 -86
  171. package/docs/interfaces/ObjectResolver.md +0 -209
  172. package/docs/interfaces/ObjectResolverInstance.md +0 -275
  173. package/docs/interfaces/ObserveEndEventData.md +0 -55
  174. package/docs/interfaces/ObserveStartEventData.md +0 -43
  175. package/docs/interfaces/PackageManifest.md +0 -37
  176. package/docs/interfaces/PayloadBuilderOptions.md +0 -21
  177. package/docs/interfaces/PayloadFields.md +0 -23
  178. package/docs/interfaces/PayloadFindFilter.md +0 -29
  179. package/docs/interfaces/PayloadMetaFields.md +0 -21
  180. package/docs/interfaces/PayloadSet.md +0 -21
  181. package/docs/interfaces/QueryFields.md +0 -53
  182. package/docs/interfaces/QueryFulfillFinishedEventData.md +0 -55
  183. package/docs/interfaces/QueryFulfillStartedEventData.md +0 -47
  184. package/docs/interfaces/QueryObjectFilter.md +0 -95
  185. package/docs/interfaces/QuerySendFinishedEventData.md +0 -55
  186. package/docs/interfaces/QuerySendStartedEventData.md +0 -47
  187. package/docs/interfaces/ReadArchivist.md +0 -68
  188. package/docs/interfaces/ReadArchivistFunctions.md +0 -55
  189. package/docs/interfaces/ReadWriteArchivist.md +0 -135
  190. package/docs/interfaces/ReportEndEventData.md +0 -51
  191. package/docs/interfaces/ReportStartEventData.md +0 -43
  192. package/docs/interfaces/ResolveHelperConfig.md +0 -69
  193. package/docs/interfaces/ResolveStrategy.md +0 -41
  194. package/docs/interfaces/ResolverEventEmitter.md +0 -27
  195. package/docs/interfaces/SchemaField.md +0 -23
  196. package/docs/interfaces/SchemaFields.md +0 -21
  197. package/docs/interfaces/SearchableStorage.md +0 -37
  198. package/docs/interfaces/Sentinel.md +0 -60
  199. package/docs/interfaces/SentinelInstance.md +0 -1038
  200. package/docs/interfaces/SentinelJob.md +0 -13
  201. package/docs/interfaces/SentinelModule.md +0 -486
  202. package/docs/interfaces/SentinelModuleEventData.md +0 -275
  203. package/docs/interfaces/SequenceStorageMeta.md +0 -17
  204. package/docs/interfaces/SourcesMetaField.md +0 -17
  205. package/docs/interfaces/StashArchivist.md +0 -35
  206. package/docs/interfaces/StashArchivistFunctions.md +0 -28
  207. package/docs/interfaces/State.md +0 -19
  208. package/docs/interfaces/StateDictionary.md +0 -9
  209. package/docs/interfaces/StorageMeta.md +0 -45
  210. package/docs/interfaces/TaskEndEventData.md +0 -55
  211. package/docs/interfaces/TaskStartEventData.md +0 -51
  212. package/docs/interfaces/Timestamp.md +0 -15
  213. package/docs/interfaces/UnexposedEventData.md +0 -43
  214. package/docs/interfaces/WithLabels.md +0 -21
  215. package/docs/interfaces/WithOptionalLabels.md +0 -21
  216. package/docs/interfaces/WitnessInstance.md +0 -1045
  217. package/docs/interfaces/WitnessModule.md +0 -485
  218. package/docs/interfaces/WitnessQueryFunctions.md +0 -59
  219. package/docs/interfaces/WriteArchivist.md +0 -92
  220. package/docs/interfaces/WriteArchivistFunctions.md +0 -75
  221. package/docs/type-aliases/AddressChildPayload.md +0 -7
  222. package/docs/type-aliases/AddressChildSchema.md +0 -7
  223. package/docs/type-aliases/AddressModuleFilter.md +0 -13
  224. package/docs/type-aliases/AddressPayload.md +0 -7
  225. package/docs/type-aliases/AddressPreviousHashPayload.md +0 -7
  226. package/docs/type-aliases/AddressPreviousHashSchema.md +0 -7
  227. package/docs/type-aliases/AddressSchema.md +0 -7
  228. package/docs/type-aliases/AllValidator.md +0 -19
  229. package/docs/type-aliases/AllValidatorFactory.md +0 -17
  230. package/docs/type-aliases/AnyBoundWitness.md +0 -7
  231. package/docs/type-aliases/AnyConfigSchema.md +0 -13
  232. package/docs/type-aliases/AnyModuleConfig.md +0 -7
  233. package/docs/type-aliases/AnyModuleFilter.md +0 -13
  234. package/docs/type-aliases/AnyObjectFilter.md +0 -13
  235. package/docs/type-aliases/AnyPayload.md +0 -7
  236. package/docs/type-aliases/ArchivistAllQuery.md +0 -7
  237. package/docs/type-aliases/ArchivistAllQuerySchema.md +0 -7
  238. package/docs/type-aliases/ArchivistClearQuery.md +0 -7
  239. package/docs/type-aliases/ArchivistClearQuerySchema.md +0 -7
  240. package/docs/type-aliases/ArchivistCommitQuery.md +0 -7
  241. package/docs/type-aliases/ArchivistCommitQuerySchema.md +0 -7
  242. package/docs/type-aliases/ArchivistConfig.md +0 -17
  243. package/docs/type-aliases/ArchivistConfigSchema.md +0 -7
  244. package/docs/type-aliases/ArchivistDeleteQuery.md +0 -7
  245. package/docs/type-aliases/ArchivistDeleteQuerySchema.md +0 -7
  246. package/docs/type-aliases/ArchivistGetQuery.md +0 -7
  247. package/docs/type-aliases/ArchivistGetQuerySchema.md +0 -7
  248. package/docs/type-aliases/ArchivistInsertQuery.md +0 -7
  249. package/docs/type-aliases/ArchivistInsertQuerySchema.md +0 -7
  250. package/docs/type-aliases/ArchivistModuleQueries.md +0 -7
  251. package/docs/type-aliases/ArchivistNextQuery.md +0 -7
  252. package/docs/type-aliases/ArchivistNextQuerySchema.md +0 -7
  253. package/docs/type-aliases/ArchivistParams.md +0 -17
  254. package/docs/type-aliases/ArchivistQueries.md +0 -7
  255. package/docs/type-aliases/ArchivistTask.md +0 -7
  256. package/docs/type-aliases/AsyncPayloadValidationFunction.md +0 -25
  257. package/docs/type-aliases/AttachableArchivistInstanceTypeCheck.md +0 -13
  258. package/docs/type-aliases/AttachableBridgeInstanceTypeCheck.md +0 -13
  259. package/docs/type-aliases/AttachableDivinerInstanceTypeCheck.md +0 -13
  260. package/docs/type-aliases/AttachableModuleInstanceTypeCheck.md +0 -13
  261. package/docs/type-aliases/AttachableNodeInstanceTypeCheck.md +0 -13
  262. package/docs/type-aliases/AttachableSentinelInstanceTypeCheck.md +0 -13
  263. package/docs/type-aliases/AttachableWitnessInstanceTypeCheck.md +0 -13
  264. package/docs/type-aliases/BoundWitness.md +0 -13
  265. package/docs/type-aliases/BoundWitnessSchema.md +0 -7
  266. package/docs/type-aliases/BridgeClientConfig.md +0 -31
  267. package/docs/type-aliases/BridgeConfig.md +0 -25
  268. package/docs/type-aliases/BridgeConfigSchema.md +0 -7
  269. package/docs/type-aliases/BridgeConnectQuery.md +0 -7
  270. package/docs/type-aliases/BridgeConnectQuerySchema.md +0 -7
  271. package/docs/type-aliases/BridgeDisconnectQuery.md +0 -7
  272. package/docs/type-aliases/BridgeDisconnectQuerySchema.md +0 -7
  273. package/docs/type-aliases/BridgeExposeQuery.md +0 -7
  274. package/docs/type-aliases/BridgeExposeQuerySchema.md +0 -7
  275. package/docs/type-aliases/BridgeHostConfig.md +0 -23
  276. package/docs/type-aliases/BridgeModuleQueries.md +0 -7
  277. package/docs/type-aliases/BridgeQueries.md +0 -7
  278. package/docs/type-aliases/BridgeUnexposeQuery.md +0 -7
  279. package/docs/type-aliases/BridgeUnexposeQuerySchema.md +0 -7
  280. package/docs/type-aliases/ChildCertification.md +0 -7
  281. package/docs/type-aliases/ChildCertificationSchema.md +0 -7
  282. package/docs/type-aliases/ColonPair.md +0 -13
  283. package/docs/type-aliases/ConstructableModuleWrapper.md +0 -177
  284. package/docs/type-aliases/CosigningAddressSet.md +0 -7
  285. package/docs/type-aliases/CreatableModuleFactory.md +0 -39
  286. package/docs/type-aliases/CustomWitnessInstance.md +0 -25
  287. package/docs/type-aliases/CustomWitnessModule.md +0 -25
  288. package/docs/type-aliases/DappPackageManifestPayloadSchema.md +0 -7
  289. package/docs/type-aliases/DebugLogger.md +0 -36
  290. package/docs/type-aliases/DebugOptions.md +0 -33
  291. package/docs/type-aliases/Direction.md +0 -7
  292. package/docs/type-aliases/DivineEndEventArgs.md +0 -21
  293. package/docs/type-aliases/DivineStartEventArgs.md +0 -17
  294. package/docs/type-aliases/DivinedPayload.md +0 -17
  295. package/docs/type-aliases/DivinerConfig.md +0 -17
  296. package/docs/type-aliases/DivinerConfigSchema.md +0 -7
  297. package/docs/type-aliases/DivinerDivineQuery.md +0 -7
  298. package/docs/type-aliases/DivinerDivineQuerySchema.md +0 -7
  299. package/docs/type-aliases/DivinerDivineResult.md +0 -13
  300. package/docs/type-aliases/DivinerModuleEventData.md +0 -21
  301. package/docs/type-aliases/DivinerModuleQueries.md +0 -7
  302. package/docs/type-aliases/DivinerParams.md +0 -17
  303. package/docs/type-aliases/DivinerQueries.md +0 -7
  304. package/docs/type-aliases/DivinerTask.md +0 -7
  305. package/docs/type-aliases/Epoch.md +0 -7
  306. package/docs/type-aliases/EventAnyListener.md +0 -27
  307. package/docs/type-aliases/EventArgs.md +0 -7
  308. package/docs/type-aliases/EventData.md +0 -11
  309. package/docs/type-aliases/EventListener.md +0 -23
  310. package/docs/type-aliases/EventListenerInfo.md +0 -29
  311. package/docs/type-aliases/EventName.md +0 -7
  312. package/docs/type-aliases/EventUnsubscribeFunction.md +0 -11
  313. package/docs/type-aliases/EventsParams.md +0 -7
  314. package/docs/type-aliases/ExposedEventArgs.md +0 -13
  315. package/docs/type-aliases/GeneratedBoundWitnessFields.md +0 -7
  316. package/docs/type-aliases/HuriFetchFunction.md +0 -17
  317. package/docs/type-aliases/HydratedBoundWitness.md +0 -17
  318. package/docs/type-aliases/HydratedBoundWitnessWithStorageMeta.md +0 -17
  319. package/docs/type-aliases/IdentityFunction.md +0 -23
  320. package/docs/type-aliases/IndexDescription.md +0 -49
  321. package/docs/type-aliases/IndexDirection.md +0 -9
  322. package/docs/type-aliases/InstanceTypeCheck.md +0 -13
  323. package/docs/type-aliases/JobEndEventArgs.md +0 -13
  324. package/docs/type-aliases/JobStartEventArgs.md +0 -13
  325. package/docs/type-aliases/LabeledCreatableModuleFactory.md +0 -13
  326. package/docs/type-aliases/LocalSequence.md +0 -7
  327. package/docs/type-aliases/MetaEventData.md +0 -45
  328. package/docs/type-aliases/ModuleAddressQuery.md +0 -7
  329. package/docs/type-aliases/ModuleAddressQuerySchema.md +0 -7
  330. package/docs/type-aliases/ModuleAlias.md +0 -7
  331. package/docs/type-aliases/ModuleAttachedEventArgs.md +0 -13
  332. package/docs/type-aliases/ModuleBusyEventArgs.md +0 -13
  333. package/docs/type-aliases/ModuleConfig.md +0 -17
  334. package/docs/type-aliases/ModuleConfigSchema.md +0 -7
  335. package/docs/type-aliases/ModuleDescriptionPayload.md +0 -7
  336. package/docs/type-aliases/ModuleDescriptionSchema.md +0 -7
  337. package/docs/type-aliases/ModuleDetachedEventArgs.md +0 -13
  338. package/docs/type-aliases/ModuleError.md +0 -7
  339. package/docs/type-aliases/ModuleErrorEventArgs.md +0 -13
  340. package/docs/type-aliases/ModuleErrorSchema.md +0 -7
  341. package/docs/type-aliases/ModuleEventArgs.md +0 -17
  342. package/docs/type-aliases/ModuleFilter.md +0 -17
  343. package/docs/type-aliases/ModuleFilterPayload.md +0 -7
  344. package/docs/type-aliases/ModuleFilterPayloadSchema.md +0 -7
  345. package/docs/type-aliases/ModuleIdentifier.md +0 -7
  346. package/docs/type-aliases/ModuleIdentifierPart.md +0 -7
  347. package/docs/type-aliases/ModuleIdentifierTransformerFunc.md +0 -17
  348. package/docs/type-aliases/ModuleLimitationLabelName.md +0 -7
  349. package/docs/type-aliases/ModuleManifestPayload.md +0 -7
  350. package/docs/type-aliases/ModuleManifestPayloadSchema.md +0 -7
  351. package/docs/type-aliases/ModuleManifestQuery.md +0 -7
  352. package/docs/type-aliases/ModuleManifestQuerySchema.md +0 -7
  353. package/docs/type-aliases/ModuleName.md +0 -7
  354. package/docs/type-aliases/ModuleParams.md +0 -17
  355. package/docs/type-aliases/ModulePipeLine.md +0 -7
  356. package/docs/type-aliases/ModuleQueriedEventArgs.md +0 -13
  357. package/docs/type-aliases/ModuleQueries.md +0 -7
  358. package/docs/type-aliases/ModuleQueryHandlerResult.md +0 -7
  359. package/docs/type-aliases/ModuleQueryResult.md +0 -21
  360. package/docs/type-aliases/ModuleRegisteredEventArgs.md +0 -13
  361. package/docs/type-aliases/ModuleResolveDirection.md +0 -7
  362. package/docs/type-aliases/ModuleState.md +0 -13
  363. package/docs/type-aliases/ModuleStateQuery.md +0 -7
  364. package/docs/type-aliases/ModuleStateQuerySchema.md +0 -7
  365. package/docs/type-aliases/ModuleStateSchema.md +0 -7
  366. package/docs/type-aliases/ModuleStatus.md +0 -7
  367. package/docs/type-aliases/ModuleSubscribeQuery.md +0 -7
  368. package/docs/type-aliases/ModuleSubscribeQuerySchema.md +0 -7
  369. package/docs/type-aliases/ModuleTypeCheck.md +0 -13
  370. package/docs/type-aliases/ModuleUnregisteredEventArgs.md +0 -13
  371. package/docs/type-aliases/ModuleWrapperParams.md +0 -13
  372. package/docs/type-aliases/NameModuleFilter.md +0 -13
  373. package/docs/type-aliases/NodeAttachQuery.md +0 -7
  374. package/docs/type-aliases/NodeAttachQuerySchema.md +0 -7
  375. package/docs/type-aliases/NodeAttachedQuery.md +0 -7
  376. package/docs/type-aliases/NodeAttachedQuerySchema.md +0 -7
  377. package/docs/type-aliases/NodeCertifyQuery.md +0 -7
  378. package/docs/type-aliases/NodeCertifyQuerySchema.md +0 -7
  379. package/docs/type-aliases/NodeConfig.md +0 -17
  380. package/docs/type-aliases/NodeConfigSchema.md +0 -7
  381. package/docs/type-aliases/NodeDetachQuery.md +0 -7
  382. package/docs/type-aliases/NodeDetachQuerySchema.md +0 -7
  383. package/docs/type-aliases/NodeManifestPayloadSchema.md +0 -7
  384. package/docs/type-aliases/NodeModuleQueries.md +0 -7
  385. package/docs/type-aliases/NodeParams.md +0 -17
  386. package/docs/type-aliases/NodeQueries.md +0 -7
  387. package/docs/type-aliases/NodeRegisteredQuery.md +0 -7
  388. package/docs/type-aliases/NodeRegisteredQuerySchema.md +0 -7
  389. package/docs/type-aliases/Nonce.md +0 -7
  390. package/docs/type-aliases/ObjectCategory.md +0 -7
  391. package/docs/type-aliases/ObjectFilter.md +0 -13
  392. package/docs/type-aliases/ObjectResolverPriority.md +0 -7
  393. package/docs/type-aliases/ObserveEndEventArgs.md +0 -21
  394. package/docs/type-aliases/ObserveStartEventArgs.md +0 -17
  395. package/docs/type-aliases/OptionalConfigSchema.md +0 -19
  396. package/docs/type-aliases/OverridablePayload.md +0 -13
  397. package/docs/type-aliases/PackageManifestPayload.md +0 -7
  398. package/docs/type-aliases/PackageManifestPayloadSchema.md +0 -7
  399. package/docs/type-aliases/Payload.md +0 -19
  400. package/docs/type-aliases/PayloadLoader.md +0 -17
  401. package/docs/type-aliases/PayloadLoaderFactory.md +0 -11
  402. package/docs/type-aliases/PayloadProperty.md +0 -15
  403. package/docs/type-aliases/PayloadSchema.md +0 -7
  404. package/docs/type-aliases/PayloadSetPayload.md +0 -7
  405. package/docs/type-aliases/PayloadSetSchema.md +0 -7
  406. package/docs/type-aliases/PayloadValidationFunction.md +0 -15
  407. package/docs/type-aliases/PayloadValue.md +0 -19
  408. package/docs/type-aliases/PayloadValueExpression.md +0 -33
  409. package/docs/type-aliases/PayloadWithOptionalSources.md +0 -21
  410. package/docs/type-aliases/PayloadWithSources.md +0 -17
  411. package/docs/type-aliases/QualifiedSequence.md +0 -7
  412. package/docs/type-aliases/Query.md +0 -17
  413. package/docs/type-aliases/QueryBoundWitness.md +0 -7
  414. package/docs/type-aliases/QueryBoundWitnessFields.md +0 -23
  415. package/docs/type-aliases/QueryFulfillFinishedEventArgs.md +0 -13
  416. package/docs/type-aliases/QueryFulfillStartedEventArgs.md +0 -13
  417. package/docs/type-aliases/QueryModuleFilter.md +0 -13
  418. package/docs/type-aliases/QuerySendFinishedEventArgs.md +0 -13
  419. package/docs/type-aliases/QuerySendStartedEventArgs.md +0 -13
  420. package/docs/type-aliases/ReportEndEventArgs.md +0 -13
  421. package/docs/type-aliases/ReportStartEventArgs.md +0 -13
  422. package/docs/type-aliases/ReservedModuleIdentifierCharacter.md +0 -7
  423. package/docs/type-aliases/ResolvedArchivistTask.md +0 -7
  424. package/docs/type-aliases/ResolvedDivinerTask.md +0 -7
  425. package/docs/type-aliases/ResolvedModuleTask.md +0 -27
  426. package/docs/type-aliases/ResolvedTask.md +0 -7
  427. package/docs/type-aliases/ResolvedWitnessTask.md +0 -7
  428. package/docs/type-aliases/Schema.md +0 -9
  429. package/docs/type-aliases/SentinelAutomationPayload.md +0 -9
  430. package/docs/type-aliases/SentinelAutomationSchema.md +0 -7
  431. package/docs/type-aliases/SentinelBaseAutomationPayload.md +0 -13
  432. package/docs/type-aliases/SentinelConfig.md +0 -17
  433. package/docs/type-aliases/SentinelConfigSchema.md +0 -7
  434. package/docs/type-aliases/SentinelEventAutomationPayload.md +0 -9
  435. package/docs/type-aliases/SentinelEventAutomationSchema.md +0 -7
  436. package/docs/type-aliases/SentinelIntervalAutomationPayload.md +0 -9
  437. package/docs/type-aliases/SentinelIntervalAutomationSchema.md +0 -7
  438. package/docs/type-aliases/SentinelModuleQueries.md +0 -7
  439. package/docs/type-aliases/SentinelParams.md +0 -17
  440. package/docs/type-aliases/SentinelQueries.md +0 -7
  441. package/docs/type-aliases/SentinelReportQuery.md +0 -7
  442. package/docs/type-aliases/SentinelReportQuerySchema.md +0 -7
  443. package/docs/type-aliases/Sequence.md +0 -7
  444. package/docs/type-aliases/Signed.md +0 -19
  445. package/docs/type-aliases/SignedBoundWitness.md +0 -7
  446. package/docs/type-aliases/SignedHydratedBoundWitness.md +0 -17
  447. package/docs/type-aliases/SignedHydratedBoundWitnessWithStorageMeta.md +0 -17
  448. package/docs/type-aliases/SimpleModuleResolverParams.md +0 -13
  449. package/docs/type-aliases/SyncPayloadValidationFunction.md +0 -25
  450. package/docs/type-aliases/Task.md +0 -7
  451. package/docs/type-aliases/TaskEndEventArgs.md +0 -13
  452. package/docs/type-aliases/TaskStartEventArgs.md +0 -13
  453. package/docs/type-aliases/UnexposedEventArgs.md +0 -13
  454. package/docs/type-aliases/UnsignedBoundWitness.md +0 -13
  455. package/docs/type-aliases/UnsignedQueryBoundWitness.md +0 -7
  456. package/docs/type-aliases/Visibility.md +0 -7
  457. package/docs/type-aliases/WasmFeature.md +0 -7
  458. package/docs/type-aliases/WithAnySchema.md +0 -13
  459. package/docs/type-aliases/WithBlock.md +0 -7
  460. package/docs/type-aliases/WithDataHashStorageMeta.md +0 -13
  461. package/docs/type-aliases/WithHashStorageMeta.md +0 -13
  462. package/docs/type-aliases/WithOnlyClientMeta.md +0 -13
  463. package/docs/type-aliases/WithOptionalSchema.md +0 -13
  464. package/docs/type-aliases/WithOptionalSources.md +0 -17
  465. package/docs/type-aliases/WithPartialDataHashStorageMeta.md +0 -13
  466. package/docs/type-aliases/WithPartialHashStorageMeta.md +0 -13
  467. package/docs/type-aliases/WithPartialSequenceStorageMeta.md +0 -13
  468. package/docs/type-aliases/WithPartialStorageMeta.md +0 -13
  469. package/docs/type-aliases/WithPayload.md +0 -13
  470. package/docs/type-aliases/WithSchema.md +0 -15
  471. package/docs/type-aliases/WithSequenceStorageMeta.md +0 -13
  472. package/docs/type-aliases/WithSources.md +0 -13
  473. package/docs/type-aliases/WithStorageMeta.md +0 -13
  474. package/docs/type-aliases/WithTimestamp.md +0 -15
  475. package/docs/type-aliases/WithoutClientMeta.md +0 -13
  476. package/docs/type-aliases/WithoutMeta.md +0 -13
  477. package/docs/type-aliases/WithoutPrivateStorageMeta.md +0 -13
  478. package/docs/type-aliases/WithoutSchema.md +0 -13
  479. package/docs/type-aliases/WithoutStorageMeta.md +0 -13
  480. package/docs/type-aliases/WitnessConfig.md +0 -17
  481. package/docs/type-aliases/WitnessConfigSchema.md +0 -7
  482. package/docs/type-aliases/WitnessModuleEventData.md +0 -21
  483. package/docs/type-aliases/WitnessModuleQueries.md +0 -7
  484. package/docs/type-aliases/WitnessObserveQuery.md +0 -7
  485. package/docs/type-aliases/WitnessObserveQuerySchema.md +0 -7
  486. package/docs/type-aliases/WitnessParams.md +0 -17
  487. package/docs/type-aliases/WitnessQueries.md +0 -7
  488. package/docs/type-aliases/WitnessTask.md +0 -7
  489. package/docs/variables/AddressChildSchema.md +0 -7
  490. package/docs/variables/AddressPreviousHashSchema.md +0 -7
  491. package/docs/variables/AddressRegEx.md +0 -7
  492. package/docs/variables/AddressSchema.md +0 -7
  493. package/docs/variables/ArchivistAllQuerySchema.md +0 -7
  494. package/docs/variables/ArchivistClearQuerySchema.md +0 -7
  495. package/docs/variables/ArchivistCommitQuerySchema.md +0 -7
  496. package/docs/variables/ArchivistConfigSchema.md +0 -7
  497. package/docs/variables/ArchivistDeleteQuerySchema.md +0 -7
  498. package/docs/variables/ArchivistGetQuerySchema.md +0 -7
  499. package/docs/variables/ArchivistInsertQuerySchema.md +0 -7
  500. package/docs/variables/ArchivistNextQuerySchema.md +0 -7
  501. package/docs/variables/BoundWitnessJsonSchema-1.md +0 -107
  502. package/docs/variables/BoundWitnessSchema.md +0 -7
  503. package/docs/variables/BridgeConfigSchema.md +0 -7
  504. package/docs/variables/BridgeConnectQuerySchema.md +0 -7
  505. package/docs/variables/BridgeDisconnectQuerySchema.md +0 -7
  506. package/docs/variables/BridgeExposeQuerySchema.md +0 -7
  507. package/docs/variables/BridgeUnexposeQuerySchema.md +0 -7
  508. package/docs/variables/ChildCertificationSchema.md +0 -7
  509. package/docs/variables/DappPackageManifestPayloadSchema.md +0 -7
  510. package/docs/variables/DisallowedModuleIdentifierCharacters.md +0 -125
  511. package/docs/variables/DivinerConfigSchema.md +0 -7
  512. package/docs/variables/DivinerDivineQuerySchema.md +0 -7
  513. package/docs/variables/GeneratedBoundWitnessFields.md +0 -7
  514. package/docs/variables/HashRegEx.md +0 -7
  515. package/docs/variables/HexRegEx.md +0 -7
  516. package/docs/variables/HexRegExMinMax.md +0 -21
  517. package/docs/variables/IndexSeparator.md +0 -7
  518. package/docs/variables/LocalSequenceConstants.md +0 -65
  519. package/docs/variables/MODULE_PATH_SEPARATOR.md +0 -7
  520. package/docs/variables/ModuleAddressQuerySchema.md +0 -7
  521. package/docs/variables/ModuleConfigSchema.md +0 -7
  522. package/docs/variables/ModuleDescriptionSchema.md +0 -7
  523. package/docs/variables/ModuleErrorSchema.md +0 -7
  524. package/docs/variables/ModuleFilterPayloadSchema.md +0 -7
  525. package/docs/variables/ModuleLimitationLabelName.md +0 -7
  526. package/docs/variables/ModuleLimitationViewLabel.md +0 -13
  527. package/docs/variables/ModuleManifestPayloadSchema.md +0 -7
  528. package/docs/variables/ModuleManifestQuerySchema.md +0 -7
  529. package/docs/variables/ModuleStateQuerySchema.md +0 -7
  530. package/docs/variables/ModuleStateSchema.md +0 -7
  531. package/docs/variables/ModuleSubscribeQuerySchema.md +0 -7
  532. package/docs/variables/NodeAttachQuerySchema.md +0 -7
  533. package/docs/variables/NodeAttachedQuerySchema.md +0 -7
  534. package/docs/variables/NodeCertifyQuerySchema.md +0 -7
  535. package/docs/variables/NodeConfigSchema.md +0 -7
  536. package/docs/variables/NodeDetachQuerySchema.md +0 -7
  537. package/docs/variables/NodeManifestPayloadSchema.md +0 -7
  538. package/docs/variables/NodeRegisteredQuerySchema.md +0 -7
  539. package/docs/variables/ObjectResolverPriority.md +0 -33
  540. package/docs/variables/PackageManifestPayloadSchema.md +0 -7
  541. package/docs/variables/PayloadSchema.md +0 -7
  542. package/docs/variables/PayloadSetSchema.md +0 -7
  543. package/docs/variables/QualifiedSequenceConstants.md +0 -21
  544. package/docs/variables/ReservedModuleIdentifierCharacters.md +0 -7
  545. package/docs/variables/SchemaRegEx.md +0 -7
  546. package/docs/variables/SentinelAutomationSchema.md +0 -7
  547. package/docs/variables/SentinelConfigSchema.md +0 -7
  548. package/docs/variables/SentinelEventAutomationSchema.md +0 -7
  549. package/docs/variables/SentinelIntervalAutomationSchema.md +0 -7
  550. package/docs/variables/SentinelReportQuerySchema.md +0 -7
  551. package/docs/variables/SequenceComparer.md +0 -17
  552. package/docs/variables/SequenceComponentLengths.md +0 -29
  553. package/docs/variables/SequenceComponentMinMax.md +0 -33
  554. package/docs/variables/SequenceConstants.md +0 -77
  555. package/docs/variables/SequenceNonceComponentLengths.md +0 -17
  556. package/docs/variables/SignatureRegEx.md +0 -7
  557. package/docs/variables/Uint256RegEx.md +0 -7
  558. package/docs/variables/WasmFeatureDetectors.md +0 -435
  559. package/docs/variables/WithFactory.md +0 -49
  560. package/docs/variables/WitnessConfigSchema.md +0 -7
  561. package/docs/variables/WitnessObserveQuerySchema.md +0 -7
  562. package/docs/variables/addressesContains.md +0 -27
  563. package/docs/variables/addressesContainsAll.md +0 -29
  564. package/docs/variables/addressesContainsAny.md +0 -31
  565. package/docs/variables/asAddressPayload.md +0 -59
  566. package/docs/variables/asAnyPayload.md +0 -59
  567. package/docs/variables/asArchivistInstance.md +0 -59
  568. package/docs/variables/asArchivistModule.md +0 -59
  569. package/docs/variables/asAttachableArchivistInstance.md +0 -59
  570. package/docs/variables/asAttachableBridgeInstance.md +0 -59
  571. package/docs/variables/asAttachableDivinerInstance.md +0 -59
  572. package/docs/variables/asAttachableModuleInstance.md +0 -59
  573. package/docs/variables/asAttachableNodeInstance.md +0 -59
  574. package/docs/variables/asAttachableSentinelInstance.md +0 -59
  575. package/docs/variables/asAttachableWitnessInstance.md +0 -59
  576. package/docs/variables/asBlock.md +0 -17
  577. package/docs/variables/asBoundWitness.md +0 -23
  578. package/docs/variables/asBoundWitnessWithStorageMeta.md +0 -23
  579. package/docs/variables/asBridgeInstance.md +0 -59
  580. package/docs/variables/asBridgeModule.md +0 -59
  581. package/docs/variables/asDataHashStorageMeta.md +0 -59
  582. package/docs/variables/asDivinerInstance.md +0 -59
  583. package/docs/variables/asDivinerModule.md +0 -59
  584. package/docs/variables/asHashStorageMeta.md +0 -59
  585. package/docs/variables/asModule.md +0 -59
  586. package/docs/variables/asModuleInstance.md +0 -59
  587. package/docs/variables/asModuleObject.md +0 -59
  588. package/docs/variables/asModuleState.md +0 -59
  589. package/docs/variables/asNodeInstance.md +0 -59
  590. package/docs/variables/asNodeModule.md +0 -59
  591. package/docs/variables/asOptionalAddressPayload.md +0 -23
  592. package/docs/variables/asOptionalBoundWitness.md +0 -23
  593. package/docs/variables/asOptionalBoundWitnessWithStorageMeta.md +0 -23
  594. package/docs/variables/asOptionalDataHashStorageMeta.md +0 -23
  595. package/docs/variables/asOptionalHashStorageMeta.md +0 -23
  596. package/docs/variables/asOptionalSequenceStorageMeta.md +0 -23
  597. package/docs/variables/asOptionalStorageMeta.md +0 -23
  598. package/docs/variables/asPayload.md +0 -69
  599. package/docs/variables/asSchema.md +0 -59
  600. package/docs/variables/asSentinelInstance.md +0 -59
  601. package/docs/variables/asSentinelModule.md +0 -59
  602. package/docs/variables/asSequenceStorageMeta.md +0 -59
  603. package/docs/variables/asStorageMeta.md +0 -59
  604. package/docs/variables/asWitnessInstance.md +0 -59
  605. package/docs/variables/asWitnessModule.md +0 -59
  606. package/docs/variables/assignCreatableModuleRegistry.md +0 -25
  607. package/docs/variables/boundWitnessJsonSchema.md +0 -7
  608. package/docs/variables/boundWitnessProperties.md +0 -7
  609. package/docs/variables/buildStandardIndexName.md +0 -24
  610. package/docs/variables/combineWalletPaths.md +0 -21
  611. package/docs/variables/duplicateModules.md +0 -37
  612. package/docs/variables/formatWalletPath.md +0 -17
  613. package/docs/variables/getBoundWitness.md +0 -21
  614. package/docs/variables/getTypedBoundWitness.md +0 -31
  615. package/docs/variables/hasAllLabels.md +0 -29
  616. package/docs/variables/hasBlock.md +0 -17
  617. package/docs/variables/hasEmptyFields.md +0 -23
  618. package/docs/variables/hasLabels.md +0 -17
  619. package/docs/variables/hydrateBoundWitness.md +0 -21
  620. package/docs/variables/hydrateTypedBoundWitness.md +0 -31
  621. package/docs/variables/includesReservedModuleIdentifierCharacter.md +0 -17
  622. package/docs/variables/isAddressModuleFilter.md +0 -17
  623. package/docs/variables/isAddressObjectFilter.md +0 -23
  624. package/docs/variables/isAddressPayload.md +0 -19
  625. package/docs/variables/isAnyPayload.md +0 -17
  626. package/docs/variables/isArchivistInstance.md +0 -7
  627. package/docs/variables/isArchivistModule.md +0 -7
  628. package/docs/variables/isAttachableArchivistInstance.md +0 -7
  629. package/docs/variables/isAttachableBridgeInstance.md +0 -7
  630. package/docs/variables/isAttachableDivinerInstance.md +0 -7
  631. package/docs/variables/isAttachableModuleInstance.md +0 -7
  632. package/docs/variables/isAttachableNodeInstance.md +0 -7
  633. package/docs/variables/isAttachableSentinelInstance.md +0 -7
  634. package/docs/variables/isAttachableWitnessInstance.md +0 -7
  635. package/docs/variables/isBoundWitness.md +0 -17
  636. package/docs/variables/isBoundWitnessWithStorageMeta.md +0 -17
  637. package/docs/variables/isBoundWitnessWrapper.md +0 -27
  638. package/docs/variables/isBridgeInstance.md +0 -7
  639. package/docs/variables/isBridgeModule.md +0 -7
  640. package/docs/variables/isDataHashStorageMeta.md +0 -17
  641. package/docs/variables/isDivinerInstance.md +0 -7
  642. package/docs/variables/isDivinerModule.md +0 -7
  643. package/docs/variables/isEpoch.md +0 -17
  644. package/docs/variables/isHashStorageMeta.md +0 -17
  645. package/docs/variables/isLocalSequence.md +0 -17
  646. package/docs/variables/isModule.md +0 -7
  647. package/docs/variables/isModuleError.md +0 -17
  648. package/docs/variables/isModuleIdentifierPart.md +0 -17
  649. package/docs/variables/isModuleInstance.md +0 -7
  650. package/docs/variables/isModuleName.md +0 -17
  651. package/docs/variables/isModuleObject.md +0 -7
  652. package/docs/variables/isModuleResolver.md +0 -17
  653. package/docs/variables/isModuleState.md +0 -23
  654. package/docs/variables/isModuleStateWithSources.md +0 -23
  655. package/docs/variables/isNameModuleFilter.md +0 -17
  656. package/docs/variables/isNameObjectFilter.md +0 -23
  657. package/docs/variables/isNodeInstance.md +0 -7
  658. package/docs/variables/isNodeModule.md +0 -7
  659. package/docs/variables/isNonce.md +0 -17
  660. package/docs/variables/isObjectResolver.md +0 -23
  661. package/docs/variables/isPackageManifestPayload.md +0 -17
  662. package/docs/variables/isPayload.md +0 -33
  663. package/docs/variables/isPayloadOfSchemaTypeWithSources.md +0 -33
  664. package/docs/variables/isPayloadWrapper.md +0 -17
  665. package/docs/variables/isPayloadWrapperBase.md +0 -17
  666. package/docs/variables/isQualifiedSequence.md +0 -17
  667. package/docs/variables/isQueryBoundWitness.md +0 -17
  668. package/docs/variables/isQueryBoundWitnessWithStorageMeta.md +0 -17
  669. package/docs/variables/isQueryModuleFilter.md +0 -17
  670. package/docs/variables/isQueryObjectFilter.md +0 -23
  671. package/docs/variables/isSchema.md +0 -17
  672. package/docs/variables/isSentinelInstance.md +0 -7
  673. package/docs/variables/isSentinelIntervalAutomation.md +0 -17
  674. package/docs/variables/isSentinelModule.md +0 -7
  675. package/docs/variables/isSequence.md +0 -17
  676. package/docs/variables/isSequenceStorageMeta.md +0 -17
  677. package/docs/variables/isSerializable.md +0 -21
  678. package/docs/variables/isSigned.md +0 -17
  679. package/docs/variables/isStorageMeta.md +0 -17
  680. package/docs/variables/isUnsigned.md +0 -17
  681. package/docs/variables/isValidAbsoluteWalletPath.md +0 -17
  682. package/docs/variables/isValidRelativeWalletPath.md +0 -17
  683. package/docs/variables/isWitnessInstance.md +0 -7
  684. package/docs/variables/isWitnessModule.md +0 -7
  685. package/docs/variables/mixinResolverEventEmitter.md +0 -23
  686. package/docs/variables/notBoundWitness.md +0 -17
  687. package/docs/variables/notPayloadOfSchemaType.md +0 -33
  688. package/docs/variables/omitSchema.md +0 -23
  689. package/docs/variables/payloadHashesContains.md +0 -29
  690. package/docs/variables/payloadHashesContainsAll.md +0 -29
  691. package/docs/variables/payloadHashesContainsAny.md +0 -31
  692. package/docs/variables/payloadJsonSchema.md +0 -7
  693. package/docs/variables/payloadPropertiesJsonSchema.md +0 -7
  694. package/docs/variables/payloadSchemasContains.md +0 -29
  695. package/docs/variables/payloadSchemasContainsAll.md +0 -29
  696. package/docs/variables/payloadSchemasContainsAny.md +0 -31
  697. package/docs/variables/registerCreatableModuleFactories.md +0 -25
  698. package/docs/variables/registerCreatableModuleFactory.md +0 -35
  699. package/docs/variables/removeEmptyFields.md +0 -23
  700. package/docs/variables/requiredAttachableArchivistInstanceFunctions.md +0 -7
  701. package/docs/variables/requiredAttachableBridgeInstanceFunctions.md +0 -7
  702. package/docs/variables/requiredAttachableDivinerInstanceFunctions.md +0 -7
  703. package/docs/variables/requiredAttachableModuleInstanceFunctions.md +0 -7
  704. package/docs/variables/requiredAttachableNodeInstanceFunctions.md +0 -7
  705. package/docs/variables/requiredAttachableSentinelInstanceFunctions.md +0 -7
  706. package/docs/variables/requiredAttachableWitnessInstanceFunctions.md +0 -7
  707. package/docs/variables/requiredModuleInstanceFunctions.md +0 -7
  708. package/docs/variables/requiredModuleQueries.md +0 -7
  709. package/docs/variables/requiredModuleShape.md +0 -7
  710. package/docs/variables/resolveAddressToInstance.md +0 -33
  711. package/docs/variables/resolveAddressToInstanceAll.md +0 -29
  712. package/docs/variables/resolveAddressToInstanceDown.md +0 -29
  713. package/docs/variables/resolveAddressToInstanceSiblings.md +0 -29
  714. package/docs/variables/resolveAddressToInstanceUp.md +0 -29
  715. package/docs/variables/resolveAll.md +0 -25
  716. package/docs/variables/resolveAllDown.md +0 -29
  717. package/docs/variables/resolveAllUp.md +0 -25
  718. package/docs/variables/resolveLocalNameToAddress.md +0 -29
  719. package/docs/variables/resolveLocalNameToAddressAll.md +0 -25
  720. package/docs/variables/resolveLocalNameToAddressDown.md +0 -25
  721. package/docs/variables/resolveLocalNameToAddressUp.md +0 -21
  722. package/docs/variables/resolveLocalNameToInstance.md +0 -29
  723. package/docs/variables/resolveLocalNameToInstanceAll.md +0 -25
  724. package/docs/variables/resolveLocalNameToInstanceDown.md +0 -25
  725. package/docs/variables/resolveLocalNameToInstanceUp.md +0 -21
  726. package/docs/variables/resolvePathToAddress.md +0 -29
  727. package/docs/variables/resolvePathToInstance.md +0 -29
  728. package/docs/variables/sortFields.md +0 -23
  729. package/docs/variables/transformModuleIdentifier.md +0 -21
  730. package/docs/variables/tryGetTypedBoundWitness.md +0 -31
  731. package/docs/variables/tryHydrateTypedBoundWitness.md +0 -31
  732. package/docs/variables/withArchivistInstance.md +0 -27
  733. package/docs/variables/withArchivistModule.md +0 -27
  734. package/docs/variables/withBridgeInstance.md +0 -27
  735. package/docs/variables/withBridgeModule.md +0 -27
  736. package/docs/variables/withDivinerInstance.md +0 -27
  737. package/docs/variables/withDivinerModule.md +0 -27
  738. package/docs/variables/withModule.md +0 -27
  739. package/docs/variables/withModuleInstance.md +0 -27
  740. package/docs/variables/withNodeInstance.md +0 -27
  741. package/docs/variables/withNodeModule.md +0 -27
  742. package/docs/variables/withSentinelInstance.md +0 -27
  743. package/docs/variables/withSentinelModule.md +0 -27
  744. package/docs/variables/withWitnessInstance.md +0 -27
  745. package/docs/variables/withWitnessModule.md +0 -27
  746. package/eslint.config.mjs +0 -33
  747. package/knip.config.ts +0 -68
  748. package/scripts/README.template.md +0 -23
  749. package/scripts/clear-scrollback-buffer.sh +0 -3
  750. package/scripts/generate-typedoc.mjs +0 -168
  751. package/scripts/mongo/README.md +0 -33
  752. package/scripts/mongo/docker-entrypoint-initdb.d/00-create-key.sh +0 -5
  753. package/scripts/mongo/opt/mongo/joinReplicaSet.js +0 -13
  754. package/scripts/readme-gen.mjs +0 -50
  755. package/scripts/run-cycle.mjs +0 -71
  756. package/vitest.config.ts +0 -19
  757. package/vitest.workspace.ts +0 -5
  758. package/xy.config.ts +0 -10
@@ -1,1559 +0,0 @@
1
- [@xyo-network/sdk-js](../README.md) / ModuleWrapper
2
-
3
- # Class: ModuleWrapper\<TWrappedModule\>
4
-
5
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:25
6
-
7
- ## Extends
8
-
9
- - `Base`\<`Exclude`\<`Omit`\<`TWrappedModule`\[`"params"`\], `"config"`\> & `object`, `undefined`\>\>
10
-
11
- ## Extended by
12
-
13
- - [`ArchivistWrapper`](ArchivistWrapper.md)
14
- - [`BridgeWrapper`](BridgeWrapper.md)
15
- - [`DivinerWrapper`](DivinerWrapper.md)
16
- - [`NodeWrapper`](NodeWrapper.md)
17
- - [`WitnessWrapper`](WitnessWrapper.md)
18
-
19
- ## Type Parameters
20
-
21
- ### TWrappedModule
22
-
23
- `TWrappedModule` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
24
-
25
- ## Implements
26
-
27
- - [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)\<`TWrappedModule`\[`"params"`\], `TWrappedModule`\[`"eventData"`\]\>
28
-
29
- ## Constructors
30
-
31
- ### Constructor
32
-
33
- > **new ModuleWrapper**\<`TWrappedModule`\>(`params`): `ModuleWrapper`\<`TWrappedModule`\>
34
-
35
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:36
36
-
37
- #### Parameters
38
-
39
- ##### params
40
-
41
- [`ModuleWrapperParams`](../type-aliases/ModuleWrapperParams.md)\<`TWrappedModule`\>
42
-
43
- #### Returns
44
-
45
- `ModuleWrapper`\<`TWrappedModule`\>
46
-
47
- #### Overrides
48
-
49
- `Base<Exclude<Omit<TWrappedModule['params'], 'config'> & { config: Exclude<TWrappedModule['params']['config'], undefined>; }, undefined>>.constructor`
50
-
51
- ## Properties
52
-
53
- ### eventData
54
-
55
- > **eventData**: `TWrappedModule`\[`"eventData"`\]
56
-
57
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:31
58
-
59
- #### Implementation of
60
-
61
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`eventData`](../interfaces/AttachableModuleInstance.md#eventdata)
62
-
63
- ***
64
-
65
- ### defaultLogger?
66
-
67
- > `static` `optional` **defaultLogger**: `Logger`
68
-
69
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:9
70
-
71
- #### Inherited from
72
-
73
- `Base.defaultLogger`
74
-
75
- ***
76
-
77
- ### globalInstances
78
-
79
- > `readonly` `static` **globalInstances**: `Record`\<`string`, `WeakRef`\<`Base`\<`undefined` \| `BaseParamsFields`\>\>[]\>
80
-
81
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:10
82
-
83
- #### Inherited from
84
-
85
- `Base.globalInstances`
86
-
87
- ***
88
-
89
- ### globalInstancesCountHistory
90
-
91
- > `readonly` `static` **globalInstancesCountHistory**: `Record`\<`string`, `number`[]\>
92
-
93
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:11
94
-
95
- #### Inherited from
96
-
97
- `Base.globalInstancesCountHistory`
98
-
99
- ***
100
-
101
- ### instanceIdentityCheck
102
-
103
- > `readonly` `static` **instanceIdentityCheck**: [`InstanceTypeCheck`](../type-aliases/InstanceTypeCheck.md)
104
-
105
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:28
106
-
107
- ***
108
-
109
- ### moduleIdentityCheck
110
-
111
- > `readonly` `static` **moduleIdentityCheck**: [`ModuleTypeCheck`](../type-aliases/ModuleTypeCheck.md)
112
-
113
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:29
114
-
115
- ***
116
-
117
- ### requiredQueries
118
-
119
- > `readonly` `static` **requiredQueries**: `string`[]
120
-
121
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:30
122
-
123
- ***
124
-
125
- ### uniqueName
126
-
127
- > `readonly` `static` **uniqueName**: `string`
128
-
129
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:12
130
-
131
- #### Inherited from
132
-
133
- `Base.uniqueName`
134
-
135
- ## Accessors
136
-
137
- ### account
138
-
139
- #### Get Signature
140
-
141
- > **get** **account**(): `AccountInstance`
142
-
143
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:37
144
-
145
- ##### Returns
146
-
147
- `AccountInstance`
148
-
149
- #### Implementation of
150
-
151
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`account`](../interfaces/AttachableModuleInstance.md#account)
152
-
153
- ***
154
-
155
- ### additionalSigners
156
-
157
- #### Get Signature
158
-
159
- > **get** **additionalSigners**(): `AccountInstance`[]
160
-
161
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:38
162
-
163
- ##### Returns
164
-
165
- `AccountInstance`[]
166
-
167
- ***
168
-
169
- ### address
170
-
171
- #### Get Signature
172
-
173
- > **get** **address**(): `Lowercase`\<`string`\>
174
-
175
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:39
176
-
177
- ##### Returns
178
-
179
- `Lowercase`\<`string`\>
180
-
181
- #### Implementation of
182
-
183
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`address`](../interfaces/AttachableModuleInstance.md#address)
184
-
185
- ***
186
-
187
- ### config
188
-
189
- #### Get Signature
190
-
191
- > **get** **config**(): `Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
192
-
193
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:40
194
-
195
- ##### Returns
196
-
197
- `Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
198
-
199
- #### Implementation of
200
-
201
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`config`](../interfaces/AttachableModuleInstance.md#config)
202
-
203
- ***
204
-
205
- ### downResolver
206
-
207
- #### Get Signature
208
-
209
- > **get** **downResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
210
-
211
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:41
212
-
213
- ##### Returns
214
-
215
- [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
216
-
217
- #### Implementation of
218
-
219
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`downResolver`](../interfaces/AttachableModuleInstance.md#downresolver)
220
-
221
- ***
222
-
223
- ### id
224
-
225
- #### Get Signature
226
-
227
- > **get** **id**(): `string`
228
-
229
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:42
230
-
231
- The name (if specified) or address of the module
232
-
233
- ##### Returns
234
-
235
- `string`
236
-
237
- The name (if specified) or address of the module
238
-
239
- #### Implementation of
240
-
241
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`id`](../interfaces/AttachableModuleInstance.md#id)
242
-
243
- ***
244
-
245
- ### logger
246
-
247
- #### Get Signature
248
-
249
- > **get** **logger**(): `undefined` \| `Logger`
250
-
251
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:27
252
-
253
- ##### Returns
254
-
255
- `undefined` \| `Logger`
256
-
257
- #### Inherited from
258
-
259
- `Base.logger`
260
-
261
- ***
262
-
263
- ### mod
264
-
265
- #### Get Signature
266
-
267
- > **get** **mod**(): `TWrappedModule`
268
-
269
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:43
270
-
271
- ##### Returns
272
-
273
- `TWrappedModule`
274
-
275
- ***
276
-
277
- ### modName
278
-
279
- #### Get Signature
280
-
281
- > **get** **modName**(): `undefined` \| `string`
282
-
283
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:44
284
-
285
- ##### Returns
286
-
287
- `undefined` \| `string`
288
-
289
- #### Implementation of
290
-
291
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`modName`](../interfaces/AttachableModuleInstance.md#modname)
292
-
293
- ***
294
-
295
- ### params
296
-
297
- #### Get Signature
298
-
299
- > **get** **params**(): `TParams`
300
-
301
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:28
302
-
303
- ##### Returns
304
-
305
- `TParams`
306
-
307
- #### Implementation of
308
-
309
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`params`](../interfaces/AttachableModuleInstance.md#params)
310
-
311
- #### Inherited from
312
-
313
- `Base.params`
314
-
315
- ***
316
-
317
- ### priority
318
-
319
- #### Get Signature
320
-
321
- > **get** **priority**(): `1`
322
-
323
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:45
324
-
325
- ##### Returns
326
-
327
- `1`
328
-
329
- #### Implementation of
330
-
331
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`priority`](../interfaces/AttachableModuleInstance.md#priority)
332
-
333
- ***
334
-
335
- ### privateResolver
336
-
337
- #### Get Signature
338
-
339
- > **get** **privateResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
340
-
341
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:46
342
-
343
- ##### Returns
344
-
345
- [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
346
-
347
- #### Implementation of
348
-
349
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`privateResolver`](../interfaces/AttachableModuleInstance.md#privateresolver)
350
-
351
- ***
352
-
353
- ### queries
354
-
355
- #### Get Signature
356
-
357
- > **get** **queries**(): `string`[]
358
-
359
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:47
360
-
361
- ##### Returns
362
-
363
- `string`[]
364
-
365
- #### Implementation of
366
-
367
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`queries`](../interfaces/AttachableModuleInstance.md#queries)
368
-
369
- ***
370
-
371
- ### status
372
-
373
- #### Get Signature
374
-
375
- > **get** **status**(): [`ModuleStatus`](../type-aliases/ModuleStatus.md)
376
-
377
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:48
378
-
379
- ##### Returns
380
-
381
- [`ModuleStatus`](../type-aliases/ModuleStatus.md)
382
-
383
- #### Set Signature
384
-
385
- > **set** **status**(`value`): `void`
386
-
387
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:50
388
-
389
- ##### Parameters
390
-
391
- ###### value
392
-
393
- [`ModuleStatus`](../type-aliases/ModuleStatus.md)
394
-
395
- ##### Returns
396
-
397
- `void`
398
-
399
- #### Implementation of
400
-
401
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`status`](../interfaces/AttachableModuleInstance.md#status)
402
-
403
- ***
404
-
405
- ### upResolver
406
-
407
- #### Get Signature
408
-
409
- > **get** **upResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
410
-
411
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:49
412
-
413
- ##### Returns
414
-
415
- [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
416
-
417
- #### Implementation of
418
-
419
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`upResolver`](../interfaces/AttachableModuleInstance.md#upresolver)
420
-
421
- ***
422
-
423
- ### historyInterval
424
-
425
- #### Get Signature
426
-
427
- > **get** `static` **historyInterval**(): `number`
428
-
429
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:20
430
-
431
- ##### Returns
432
-
433
- `number`
434
-
435
- #### Set Signature
436
-
437
- > **set** `static` **historyInterval**(`value`): `void`
438
-
439
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:21
440
-
441
- ##### Parameters
442
-
443
- ###### value
444
-
445
- `number`
446
-
447
- ##### Returns
448
-
449
- `void`
450
-
451
- #### Inherited from
452
-
453
- `Base.historyInterval`
454
-
455
- ***
456
-
457
- ### historyTime
458
-
459
- #### Get Signature
460
-
461
- > **get** `static` **historyTime**(): `number`
462
-
463
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:22
464
-
465
- ##### Returns
466
-
467
- `number`
468
-
469
- #### Set Signature
470
-
471
- > **set** `static` **historyTime**(`value`): `void`
472
-
473
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:23
474
-
475
- ##### Parameters
476
-
477
- ###### value
478
-
479
- `number`
480
-
481
- ##### Returns
482
-
483
- `void`
484
-
485
- #### Inherited from
486
-
487
- `Base.historyTime`
488
-
489
- ***
490
-
491
- ### maxGcFrequency
492
-
493
- #### Get Signature
494
-
495
- > **get** `static` **maxGcFrequency**(): `number`
496
-
497
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:24
498
-
499
- ##### Returns
500
-
501
- `number`
502
-
503
- #### Set Signature
504
-
505
- > **set** `static` **maxGcFrequency**(`value`): `void`
506
-
507
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:25
508
-
509
- ##### Parameters
510
-
511
- ###### value
512
-
513
- `number`
514
-
515
- ##### Returns
516
-
517
- `void`
518
-
519
- #### Inherited from
520
-
521
- `Base.maxGcFrequency`
522
-
523
- ***
524
-
525
- ### maxHistoryDepth
526
-
527
- #### Get Signature
528
-
529
- > **get** `static` **maxHistoryDepth**(): `number`
530
-
531
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:26
532
-
533
- ##### Returns
534
-
535
- `number`
536
-
537
- #### Inherited from
538
-
539
- `Base.maxHistoryDepth`
540
-
541
- ## Methods
542
-
543
- ### addParent()
544
-
545
- > **addParent**(`mod`): `void`
546
-
547
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:68
548
-
549
- #### Parameters
550
-
551
- ##### mod
552
-
553
- [`ModuleInstance`](../interfaces/ModuleInstance.md)
554
-
555
- #### Returns
556
-
557
- `void`
558
-
559
- #### Implementation of
560
-
561
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`addParent`](../interfaces/AttachableModuleInstance.md#addparent)
562
-
563
- ***
564
-
565
- ### addressPreviousHash()
566
-
567
- > **addressPreviousHash**(): `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>
568
-
569
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:69
570
-
571
- #### Returns
572
-
573
- `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>
574
-
575
- ***
576
-
577
- ### clearListeners()
578
-
579
- > **clearListeners**(`eventNames`): `void`
580
-
581
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:70
582
-
583
- #### Parameters
584
-
585
- ##### eventNames
586
-
587
- `Parameters`\<`TWrappedModule`\[`"clearListeners"`\]\>\[`0`\]
588
-
589
- #### Returns
590
-
591
- `void`
592
-
593
- #### Implementation of
594
-
595
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`clearListeners`](../interfaces/AttachableModuleInstance.md#clearlisteners)
596
-
597
- ***
598
-
599
- ### emit()
600
-
601
- > **emit**(`eventName`, `eventArgs`): `Promise`\<`void`\>
602
-
603
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:71
604
-
605
- #### Parameters
606
-
607
- ##### eventName
608
-
609
- `Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`0`\]
610
-
611
- ##### eventArgs
612
-
613
- `Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`1`\]
614
-
615
- #### Returns
616
-
617
- `Promise`\<`void`\>
618
-
619
- #### Implementation of
620
-
621
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`emit`](../interfaces/AttachableModuleInstance.md#emit)
622
-
623
- ***
624
-
625
- ### emitSerial()
626
-
627
- > **emitSerial**(`eventName`, `eventArgs`): `Promise`\<`void`\>
628
-
629
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:72
630
-
631
- #### Parameters
632
-
633
- ##### eventName
634
-
635
- `Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`0`\]
636
-
637
- ##### eventArgs
638
-
639
- `Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`1`\]
640
-
641
- #### Returns
642
-
643
- `Promise`\<`void`\>
644
-
645
- #### Implementation of
646
-
647
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`emitSerial`](../interfaces/AttachableModuleInstance.md#emitserial)
648
-
649
- ***
650
-
651
- ### listenerCount()
652
-
653
- > **listenerCount**(`eventNames`): `number`
654
-
655
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:73
656
-
657
- #### Parameters
658
-
659
- ##### eventNames
660
-
661
- `Parameters`\<`TWrappedModule`\[`"listenerCount"`\]\>\[`0`\]
662
-
663
- #### Returns
664
-
665
- `number`
666
-
667
- #### Implementation of
668
-
669
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`listenerCount`](../interfaces/AttachableModuleInstance.md#listenercount)
670
-
671
- ***
672
-
673
- ### manifest()
674
-
675
- > **manifest**(`maxDepth?`): `Promise`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
676
-
677
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:74
678
-
679
- #### Parameters
680
-
681
- ##### maxDepth?
682
-
683
- `number`
684
-
685
- #### Returns
686
-
687
- `Promise`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
688
-
689
- #### Implementation of
690
-
691
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`manifest`](../interfaces/AttachableModuleInstance.md#manifest)
692
-
693
- ***
694
-
695
- ### manifestQuery()
696
-
697
- > **manifestQuery**(`account`, `maxDepth?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
698
-
699
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:75
700
-
701
- #### Parameters
702
-
703
- ##### account
704
-
705
- `AccountInstance`
706
-
707
- ##### maxDepth?
708
-
709
- `number`
710
-
711
- #### Returns
712
-
713
- `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
714
-
715
- #### Implementation of
716
-
717
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`manifestQuery`](../interfaces/AttachableModuleInstance.md#manifestquery)
718
-
719
- ***
720
-
721
- ### moduleAddress()
722
-
723
- > **moduleAddress**(): `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)[]\>
724
-
725
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:76
726
-
727
- #### Returns
728
-
729
- `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)[]\>
730
-
731
- #### Implementation of
732
-
733
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`moduleAddress`](../interfaces/AttachableModuleInstance.md#moduleaddress)
734
-
735
- ***
736
-
737
- ### off()
738
-
739
- > **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
740
-
741
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:77
742
-
743
- #### Type Parameters
744
-
745
- ##### TEventName
746
-
747
- `TEventName` *extends* `string` \| `number` \| `symbol`
748
-
749
- #### Parameters
750
-
751
- ##### eventNames
752
-
753
- `TEventName`
754
-
755
- ##### listener
756
-
757
- [`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
758
-
759
- #### Returns
760
-
761
- `void`
762
-
763
- #### Implementation of
764
-
765
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`off`](../interfaces/AttachableModuleInstance.md#off)
766
-
767
- ***
768
-
769
- ### offAny()
770
-
771
- > **offAny**(`listener`): `void`
772
-
773
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:78
774
-
775
- #### Parameters
776
-
777
- ##### listener
778
-
779
- [`EventAnyListener`](../type-aliases/EventAnyListener.md)
780
-
781
- #### Returns
782
-
783
- `void`
784
-
785
- #### Implementation of
786
-
787
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`offAny`](../interfaces/AttachableModuleInstance.md#offany)
788
-
789
- ***
790
-
791
- ### on()
792
-
793
- > **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
794
-
795
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:79
796
-
797
- #### Type Parameters
798
-
799
- ##### TEventName
800
-
801
- `TEventName` *extends* `string` \| `number` \| `symbol`
802
-
803
- #### Parameters
804
-
805
- ##### eventNames
806
-
807
- `TEventName`
808
-
809
- ##### listener
810
-
811
- [`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
812
-
813
- #### Returns
814
-
815
- [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
816
-
817
- #### Implementation of
818
-
819
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`on`](../interfaces/AttachableModuleInstance.md#on)
820
-
821
- ***
822
-
823
- ### onAny()
824
-
825
- > **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
826
-
827
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:80
828
-
829
- #### Parameters
830
-
831
- ##### listener
832
-
833
- [`EventAnyListener`](../type-aliases/EventAnyListener.md)
834
-
835
- #### Returns
836
-
837
- [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
838
-
839
- #### Implementation of
840
-
841
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`onAny`](../interfaces/AttachableModuleInstance.md#onany)
842
-
843
- ***
844
-
845
- ### once()
846
-
847
- > **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
848
-
849
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:81
850
-
851
- #### Type Parameters
852
-
853
- ##### TEventName
854
-
855
- `TEventName` *extends* `string` \| `number` \| `symbol`
856
-
857
- #### Parameters
858
-
859
- ##### eventName
860
-
861
- `TEventName`
862
-
863
- ##### listener
864
-
865
- [`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
866
-
867
- #### Returns
868
-
869
- [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
870
-
871
- #### Implementation of
872
-
873
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`once`](../interfaces/AttachableModuleInstance.md#once)
874
-
875
- ***
876
-
877
- ### parents()
878
-
879
- > **parents**(): `Promisable`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
880
-
881
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:82
882
-
883
- #### Returns
884
-
885
- `Promisable`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
886
-
887
- #### Implementation of
888
-
889
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`parents`](../interfaces/AttachableModuleInstance.md#parents)
890
-
891
- ***
892
-
893
- ### previousHash()
894
-
895
- > **previousHash**(): `Promise`\<`undefined` \| `string`\>
896
-
897
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:83
898
-
899
- #### Returns
900
-
901
- `Promise`\<`undefined` \| `string`\>
902
-
903
- #### Implementation of
904
-
905
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`previousHash`](../interfaces/AttachableModuleInstance.md#previoushash)
906
-
907
- ***
908
-
909
- ### previousHashQuery()
910
-
911
- > **previousHashQuery**(`account?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>\>
912
-
913
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:84
914
-
915
- #### Parameters
916
-
917
- ##### account?
918
-
919
- `AccountInstance`
920
-
921
- #### Returns
922
-
923
- `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>\>
924
-
925
- ***
926
-
927
- ### privateChildren()
928
-
929
- > **privateChildren**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
930
-
931
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:85
932
-
933
- #### Returns
934
-
935
- `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
936
-
937
- #### Implementation of
938
-
939
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`privateChildren`](../interfaces/AttachableModuleInstance.md#privatechildren)
940
-
941
- ***
942
-
943
- ### publicChildren()
944
-
945
- > **publicChildren**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
946
-
947
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:86
948
-
949
- #### Returns
950
-
951
- `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
952
-
953
- #### Implementation of
954
-
955
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`publicChildren`](../interfaces/AttachableModuleInstance.md#publicchildren)
956
-
957
- ***
958
-
959
- ### query()
960
-
961
- > **query**\<`T`\>(`query`, `payloads?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
962
-
963
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:87
964
-
965
- #### Type Parameters
966
-
967
- ##### T
968
-
969
- `T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
970
-
971
- #### Parameters
972
-
973
- ##### query
974
-
975
- `T`
976
-
977
- ##### payloads?
978
-
979
- [`Payload`](../type-aliases/Payload.md)[]
980
-
981
- #### Returns
982
-
983
- `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
984
-
985
- #### Implementation of
986
-
987
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`query`](../interfaces/AttachableModuleInstance.md#query)
988
-
989
- ***
990
-
991
- ### queryable()
992
-
993
- > **queryable**\<`T`\>(`query`, `payloads?`): `Promisable`\<`boolean`\>
994
-
995
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:88
996
-
997
- #### Type Parameters
998
-
999
- ##### T
1000
-
1001
- `T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
1002
-
1003
- #### Parameters
1004
-
1005
- ##### query
1006
-
1007
- `T`
1008
-
1009
- ##### payloads?
1010
-
1011
- [`Payload`](../type-aliases/Payload.md)[]
1012
-
1013
- #### Returns
1014
-
1015
- `Promisable`\<`boolean`\>
1016
-
1017
- #### Implementation of
1018
-
1019
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`queryable`](../interfaces/AttachableModuleInstance.md#queryable)
1020
-
1021
- ***
1022
-
1023
- ### removeParent()
1024
-
1025
- > **removeParent**(`address`): `void`
1026
-
1027
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:89
1028
-
1029
- #### Parameters
1030
-
1031
- ##### address
1032
-
1033
- `Lowercase`\<`string`\>
1034
-
1035
- #### Returns
1036
-
1037
- `void`
1038
-
1039
- #### Implementation of
1040
-
1041
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`removeParent`](../interfaces/AttachableModuleInstance.md#removeparent)
1042
-
1043
- ***
1044
-
1045
- ### ~~resolve()~~
1046
-
1047
- #### Call Signature
1048
-
1049
- > **resolve**\<`T`\>(): `Promise`\<`T`[]\>
1050
-
1051
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:91
1052
-
1053
- ##### Type Parameters
1054
-
1055
- ###### T
1056
-
1057
- `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1058
-
1059
- ##### Returns
1060
-
1061
- `Promise`\<`T`[]\>
1062
-
1063
- ##### Deprecated
1064
-
1065
- do not pass undefined. If trying to get all, pass '*'
1066
-
1067
- ##### Implementation of
1068
-
1069
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolve`](../interfaces/AttachableModuleInstance.md#resolve)
1070
-
1071
- #### Call Signature
1072
-
1073
- > **resolve**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
1074
-
1075
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:92
1076
-
1077
- ##### Type Parameters
1078
-
1079
- ###### T
1080
-
1081
- `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1082
-
1083
- ##### Parameters
1084
-
1085
- ###### all
1086
-
1087
- `"*"`
1088
-
1089
- ###### options?
1090
-
1091
- [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1092
-
1093
- ##### Returns
1094
-
1095
- `Promise`\<`T`[]\>
1096
-
1097
- ##### Deprecated
1098
-
1099
- do not pass undefined. If trying to get all, pass '*'
1100
-
1101
- ##### Implementation of
1102
-
1103
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolve`](../interfaces/AttachableModuleInstance.md#resolve)
1104
-
1105
- #### Call Signature
1106
-
1107
- > **resolve**\<`T`\>(`id`, `options?`): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1108
-
1109
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:93
1110
-
1111
- ##### Type Parameters
1112
-
1113
- ###### T
1114
-
1115
- `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1116
-
1117
- ##### Parameters
1118
-
1119
- ###### id
1120
-
1121
- `string`
1122
-
1123
- ###### options?
1124
-
1125
- [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1126
-
1127
- ##### Returns
1128
-
1129
- `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1130
-
1131
- ##### Deprecated
1132
-
1133
- do not pass undefined. If trying to get all, pass '*'
1134
-
1135
- ##### Implementation of
1136
-
1137
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolve`](../interfaces/AttachableModuleInstance.md#resolve)
1138
-
1139
- ***
1140
-
1141
- ### resolvePrivate()
1142
-
1143
- #### Call Signature
1144
-
1145
- > **resolvePrivate**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
1146
-
1147
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:94
1148
-
1149
- ##### Type Parameters
1150
-
1151
- ###### T
1152
-
1153
- `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1154
-
1155
- ##### Parameters
1156
-
1157
- ###### all
1158
-
1159
- `"*"`
1160
-
1161
- ###### options?
1162
-
1163
- [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1164
-
1165
- ##### Returns
1166
-
1167
- `Promise`\<`T`[]\>
1168
-
1169
- ##### Implementation of
1170
-
1171
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolvePrivate`](../interfaces/AttachableModuleInstance.md#resolveprivate)
1172
-
1173
- #### Call Signature
1174
-
1175
- > **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T`\>
1176
-
1177
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:95
1178
-
1179
- ##### Type Parameters
1180
-
1181
- ###### T
1182
-
1183
- `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1184
-
1185
- ##### Parameters
1186
-
1187
- ###### id
1188
-
1189
- `string`
1190
-
1191
- ###### options?
1192
-
1193
- [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1194
-
1195
- ##### Returns
1196
-
1197
- `Promise`\<`undefined` \| `T`\>
1198
-
1199
- ##### Implementation of
1200
-
1201
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolvePrivate`](../interfaces/AttachableModuleInstance.md#resolveprivate)
1202
-
1203
- ***
1204
-
1205
- ### siblings()
1206
-
1207
- > **siblings**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1208
-
1209
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:96
1210
-
1211
- #### Returns
1212
-
1213
- `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1214
-
1215
- #### Implementation of
1216
-
1217
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`siblings`](../interfaces/AttachableModuleInstance.md#siblings)
1218
-
1219
- ***
1220
-
1221
- ### state()
1222
-
1223
- > **state**(): `Promise`\<[`Payload`](../type-aliases/Payload.md)[]\>
1224
-
1225
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:97
1226
-
1227
- #### Returns
1228
-
1229
- `Promise`\<[`Payload`](../type-aliases/Payload.md)[]\>
1230
-
1231
- #### Implementation of
1232
-
1233
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`state`](../interfaces/AttachableModuleInstance.md#state)
1234
-
1235
- ***
1236
-
1237
- ### stateQuery()
1238
-
1239
- > **stateQuery**(`_account`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
1240
-
1241
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:98
1242
-
1243
- #### Parameters
1244
-
1245
- ##### \_account
1246
-
1247
- `AccountInstance`
1248
-
1249
- #### Returns
1250
-
1251
- `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
1252
-
1253
- #### Implementation of
1254
-
1255
- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`stateQuery`](../interfaces/AttachableModuleInstance.md#statequery)
1256
-
1257
- ***
1258
-
1259
- ### canWrap()
1260
-
1261
- > `static` **canWrap**(`mod?`): mod is Module\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\<void, void\>\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\]; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\] \}, ModuleEventData\<object\>\>
1262
-
1263
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:51
1264
-
1265
- #### Parameters
1266
-
1267
- ##### mod?
1268
-
1269
- [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1270
-
1271
- #### Returns
1272
-
1273
- mod is Module\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\<void, void\>\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\]; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\] \}, ModuleEventData\<object\>\>
1274
-
1275
- ***
1276
-
1277
- ### gc()
1278
-
1279
- #### Call Signature
1280
-
1281
- > `static` **gc**(`force?`): `void`
1282
-
1283
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:29
1284
-
1285
- ##### Parameters
1286
-
1287
- ###### force?
1288
-
1289
- `boolean`
1290
-
1291
- ##### Returns
1292
-
1293
- `void`
1294
-
1295
- ##### Inherited from
1296
-
1297
- `Base.gc`
1298
-
1299
- #### Call Signature
1300
-
1301
- > `static` **gc**(`className`): `void`
1302
-
1303
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:30
1304
-
1305
- ##### Parameters
1306
-
1307
- ###### className
1308
-
1309
- `string`
1310
-
1311
- ##### Returns
1312
-
1313
- `void`
1314
-
1315
- ##### Inherited from
1316
-
1317
- `Base.gc`
1318
-
1319
- ***
1320
-
1321
- ### hasRequiredQueries()
1322
-
1323
- > `static` **hasRequiredQueries**(`mod`): `boolean`
1324
-
1325
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:62
1326
-
1327
- #### Parameters
1328
-
1329
- ##### mod
1330
-
1331
- [`Module`](../interfaces/Module.md)
1332
-
1333
- #### Returns
1334
-
1335
- `boolean`
1336
-
1337
- ***
1338
-
1339
- ### instanceCount()
1340
-
1341
- > `static` **instanceCount**(`className`): `number`
1342
-
1343
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:31
1344
-
1345
- #### Parameters
1346
-
1347
- ##### className
1348
-
1349
- `string`
1350
-
1351
- #### Returns
1352
-
1353
- `number`
1354
-
1355
- #### Inherited from
1356
-
1357
- `Base.instanceCount`
1358
-
1359
- ***
1360
-
1361
- ### instanceCounts()
1362
-
1363
- > `static` **instanceCounts**(): `Record`\<`string`, `number`\>
1364
-
1365
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:32
1366
-
1367
- #### Returns
1368
-
1369
- `Record`\<`string`, `number`\>
1370
-
1371
- #### Inherited from
1372
-
1373
- `Base.instanceCounts`
1374
-
1375
- ***
1376
-
1377
- ### is()
1378
-
1379
- > `static` **is**\<`TModuleWrapper`\>(`this`, `wrapper`): `wrapper is TModuleWrapper`
1380
-
1381
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:63
1382
-
1383
- #### Type Parameters
1384
-
1385
- ##### TModuleWrapper
1386
-
1387
- `TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1388
-
1389
- #### Parameters
1390
-
1391
- ##### this
1392
-
1393
- [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1394
-
1395
- ##### wrapper
1396
-
1397
- `any`
1398
-
1399
- #### Returns
1400
-
1401
- `wrapper is TModuleWrapper`
1402
-
1403
- ***
1404
-
1405
- ### missingRequiredQueries()
1406
-
1407
- > `static` **missingRequiredQueries**(`mod`): `string`[]
1408
-
1409
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:64
1410
-
1411
- #### Parameters
1412
-
1413
- ##### mod
1414
-
1415
- [`Module`](../interfaces/Module.md)
1416
-
1417
- #### Returns
1418
-
1419
- `string`[]
1420
-
1421
- ***
1422
-
1423
- ### startHistory()
1424
-
1425
- > `static` **startHistory**(): `void`
1426
-
1427
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:33
1428
-
1429
- #### Returns
1430
-
1431
- `void`
1432
-
1433
- #### Inherited from
1434
-
1435
- `Base.startHistory`
1436
-
1437
- ***
1438
-
1439
- ### stopHistory()
1440
-
1441
- > `static` **stopHistory**(): `void`
1442
-
1443
- Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:34
1444
-
1445
- #### Returns
1446
-
1447
- `void`
1448
-
1449
- #### Inherited from
1450
-
1451
- `Base.stopHistory`
1452
-
1453
- ***
1454
-
1455
- ### tryWrap()
1456
-
1457
- > `static` **tryWrap**\<`TModuleWrapper`\>(`this`, `mod`, `account`, `checkIdentity?`): `undefined` \| `TModuleWrapper`
1458
-
1459
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:65
1460
-
1461
- #### Type Parameters
1462
-
1463
- ##### TModuleWrapper
1464
-
1465
- `TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1466
-
1467
- #### Parameters
1468
-
1469
- ##### this
1470
-
1471
- [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1472
-
1473
- ##### mod
1474
-
1475
- `undefined` | [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1476
-
1477
- ##### account
1478
-
1479
- `AccountInstance`
1480
-
1481
- ##### checkIdentity?
1482
-
1483
- `boolean`
1484
-
1485
- #### Returns
1486
-
1487
- `undefined` \| `TModuleWrapper`
1488
-
1489
- ***
1490
-
1491
- ### with()
1492
-
1493
- > `static` **with**\<`TModuleWrapper`, `R`\>(`this`, `mod`, `closure`): `undefined` \| `R`
1494
-
1495
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:66
1496
-
1497
- #### Type Parameters
1498
-
1499
- ##### TModuleWrapper
1500
-
1501
- `TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1502
-
1503
- ##### R
1504
-
1505
- `R` *extends* `Promisable`\<`void`\> = `void`
1506
-
1507
- #### Parameters
1508
-
1509
- ##### this
1510
-
1511
- [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1512
-
1513
- ##### mod
1514
-
1515
- `any`
1516
-
1517
- ##### closure
1518
-
1519
- (`mod`) => `R`
1520
-
1521
- #### Returns
1522
-
1523
- `undefined` \| `R`
1524
-
1525
- ***
1526
-
1527
- ### wrap()
1528
-
1529
- > `static` **wrap**\<`TModuleWrapper`\>(`this`, `mod`, `account`, `checkIdentity?`): `TModuleWrapper`
1530
-
1531
- Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:67
1532
-
1533
- #### Type Parameters
1534
-
1535
- ##### TModuleWrapper
1536
-
1537
- `TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1538
-
1539
- #### Parameters
1540
-
1541
- ##### this
1542
-
1543
- [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1544
-
1545
- ##### mod
1546
-
1547
- `undefined` | [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1548
-
1549
- ##### account
1550
-
1551
- `AccountInstance`
1552
-
1553
- ##### checkIdentity?
1554
-
1555
- `boolean`
1556
-
1557
- #### Returns
1558
-
1559
- `TModuleWrapper`