@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,1459 +0,0 @@
1
- [@xyo-network/sdk-js](../README.md) / QueryBoundWitnessBuilder
2
-
3
- # Class: QueryBoundWitnessBuilder\<TBoundWitness, TQuery\>
4
-
5
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Query/QueryBoundWitnessBuilder.d.ts:4
6
-
7
- ## Extends
8
-
9
- - [`BoundWitnessBuilder`](BoundWitnessBuilder.md)\<`TBoundWitness`\>
10
-
11
- ## Type Parameters
12
-
13
- ### TBoundWitness
14
-
15
- `TBoundWitness` *extends* [`QueryBoundWitness`](../type-aliases/QueryBoundWitness.md) = [`QueryBoundWitness`](../type-aliases/QueryBoundWitness.md)
16
-
17
- ### TQuery
18
-
19
- `TQuery` *extends* [`Query`](../type-aliases/Query.md) = [`Query`](../type-aliases/Query.md)
20
-
21
- ## Constructors
22
-
23
- ### Constructor
24
-
25
- > **new QueryBoundWitnessBuilder**\<`TBoundWitness`, `TQuery`\>(`options?`): `QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
26
-
27
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:17
28
-
29
- #### Parameters
30
-
31
- ##### options?
32
-
33
- `Omit`\<[`PayloadBuilderOptions`](../interfaces/PayloadBuilderOptions.md), `"schema"`\>
34
-
35
- #### Returns
36
-
37
- `QueryBoundWitnessBuilder`\<`TBoundWitness`, `TQuery`\>
38
-
39
- #### Inherited from
40
-
41
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`constructor`](BoundWitnessBuilder.md#constructor)
42
-
43
- ## Properties
44
-
45
- ### options
46
-
47
- > `readonly` **options**: [`PayloadBuilderOptions`](../interfaces/PayloadBuilderOptions.md)
48
-
49
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:8
50
-
51
- #### Inherited from
52
-
53
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`options`](BoundWitnessBuilder.md#options)
54
-
55
- ## Methods
56
-
57
- ### build()
58
-
59
- > **build**(): `Promise`\<\[[`Signed`](../type-aliases/Signed.md)\<`TBoundWitness`\>, [`AnyPayload`](../type-aliases/AnyPayload.md)[], [`ModuleError`](../type-aliases/ModuleError.md)[]\]\>
60
-
61
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:28
62
-
63
- #### Returns
64
-
65
- `Promise`\<\[[`Signed`](../type-aliases/Signed.md)\<`TBoundWitness`\>, [`AnyPayload`](../type-aliases/AnyPayload.md)[], [`ModuleError`](../type-aliases/ModuleError.md)[]\]\>
66
-
67
- #### Inherited from
68
-
69
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`build`](BoundWitnessBuilder.md#build)
70
-
71
- ***
72
-
73
- ### dataHash()
74
-
75
- > **dataHash**(): `Promise`\<`Lowercase`\<`string`\>\>
76
-
77
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:29
78
-
79
- #### Returns
80
-
81
- `Promise`\<`Lowercase`\<`string`\>\>
82
-
83
- #### Inherited from
84
-
85
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHash`](BoundWitnessBuilder.md#datahash)
86
-
87
- ***
88
-
89
- ### dataHashableFields()
90
-
91
- > **dataHashableFields**(): `Promise`\<[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`TBoundWitness`\>\>
92
-
93
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Query/QueryBoundWitnessBuilder.d.ts:6
94
-
95
- #### Returns
96
-
97
- `Promise`\<[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`TBoundWitness`\>\>
98
-
99
- #### Overrides
100
-
101
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHashableFields`](BoundWitnessBuilder.md#datahashablefields)
102
-
103
- ***
104
-
105
- ### error()
106
-
107
- > **error**(`payload?`): `this`
108
-
109
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:31
110
-
111
- #### Parameters
112
-
113
- ##### payload?
114
-
115
- [`ModuleError`](../type-aliases/ModuleError.md)
116
-
117
- #### Returns
118
-
119
- `this`
120
-
121
- #### Inherited from
122
-
123
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`error`](BoundWitnessBuilder.md#error)
124
-
125
- ***
126
-
127
- ### errors()
128
-
129
- > **errors**(`errors?`): `this`
130
-
131
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:32
132
-
133
- #### Parameters
134
-
135
- ##### errors?
136
-
137
- (`null` \| [`ModuleError`](../type-aliases/ModuleError.md))[]
138
-
139
- #### Returns
140
-
141
- `this`
142
-
143
- #### Inherited from
144
-
145
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`errors`](BoundWitnessBuilder.md#errors)
146
-
147
- ***
148
-
149
- ### fields()
150
-
151
- > **fields**(`fields`): `this`
152
-
153
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:33
154
-
155
- #### Parameters
156
-
157
- ##### fields
158
-
159
- `DeepOmitStartsWith`\<`DeepOmitStartsWith`\<[`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`Omit`\<`TBoundWitness`, `"addresses"` \| `"payload_hashes"` \| `"payload_schemas"` \| `"previous_hashes"`\>\>, `"$"`\>\>
160
-
161
- #### Returns
162
-
163
- `this`
164
-
165
- #### Inherited from
166
-
167
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`fields`](BoundWitnessBuilder.md#fields)
168
-
169
- ***
170
-
171
- ### hashes()
172
-
173
- > **hashes**(`hashes`, `schema`): `this`
174
-
175
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:34
176
-
177
- #### Parameters
178
-
179
- ##### hashes
180
-
181
- `Lowercase`\<`string`\>[]
182
-
183
- ##### schema
184
-
185
- `string`[]
186
-
187
- #### Returns
188
-
189
- `this`
190
-
191
- #### Inherited from
192
-
193
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`hashes`](BoundWitnessBuilder.md#hashes)
194
-
195
- ***
196
-
197
- ### meta()
198
-
199
- > **meta**(`meta`): `this`
200
-
201
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:60
202
-
203
- #### Parameters
204
-
205
- ##### meta
206
-
207
- `DeepPickStartsWith`\<`TBoundWitness`\>
208
-
209
- #### Returns
210
-
211
- `this`
212
-
213
- #### Inherited from
214
-
215
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`meta`](BoundWitnessBuilder.md#meta)
216
-
217
- ***
218
-
219
- ### payload()
220
-
221
- > **payload**(`payload?`): `this`
222
-
223
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:35
224
-
225
- #### Parameters
226
-
227
- ##### payload?
228
-
229
- [`AnyPayload`](../type-aliases/AnyPayload.md)
230
-
231
- #### Returns
232
-
233
- `this`
234
-
235
- #### Inherited from
236
-
237
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`payload`](BoundWitnessBuilder.md#payload)
238
-
239
- ***
240
-
241
- ### payloads()
242
-
243
- > **payloads**(`payloads?`): `this`
244
-
245
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:36
246
-
247
- #### Parameters
248
-
249
- ##### payloads?
250
-
251
- (`null` \| [`AnyPayload`](../type-aliases/AnyPayload.md))[]
252
-
253
- #### Returns
254
-
255
- `this`
256
-
257
- #### Inherited from
258
-
259
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`payloads`](BoundWitnessBuilder.md#payloads)
260
-
261
- ***
262
-
263
- ### query()
264
-
265
- > **query**\<`T`\>(`query`): `this`
266
-
267
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Query/QueryBoundWitnessBuilder.d.ts:7
268
-
269
- #### Type Parameters
270
-
271
- ##### T
272
-
273
- `T` *extends* [`Query`](../type-aliases/Query.md)
274
-
275
- #### Parameters
276
-
277
- ##### query
278
-
279
- `T`
280
-
281
- #### Returns
282
-
283
- `this`
284
-
285
- ***
286
-
287
- ### schema()
288
-
289
- > **schema**(`value`): `void`
290
-
291
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:61
292
-
293
- #### Parameters
294
-
295
- ##### value
296
-
297
- `string`
298
-
299
- #### Returns
300
-
301
- `void`
302
-
303
- #### Inherited from
304
-
305
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`schema`](BoundWitnessBuilder.md#schema)
306
-
307
- ***
308
-
309
- ### signer()
310
-
311
- > **signer**(`account`): `this`
312
-
313
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:37
314
-
315
- #### Parameters
316
-
317
- ##### account
318
-
319
- `AccountInstance`
320
-
321
- #### Returns
322
-
323
- `this`
324
-
325
- #### Inherited from
326
-
327
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`signer`](BoundWitnessBuilder.md#signer)
328
-
329
- ***
330
-
331
- ### signers()
332
-
333
- > **signers**(`accounts`): `this`
334
-
335
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:38
336
-
337
- #### Parameters
338
-
339
- ##### accounts
340
-
341
- `AccountInstance`[]
342
-
343
- #### Returns
344
-
345
- `this`
346
-
347
- #### Inherited from
348
-
349
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`signers`](BoundWitnessBuilder.md#signers)
350
-
351
- ***
352
-
353
- ### sourceQuery()
354
-
355
- > **sourceQuery**(`sourceQuery`): `this`
356
-
357
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:39
358
-
359
- #### Parameters
360
-
361
- ##### sourceQuery
362
-
363
- `Lowercase`\<`string`\>
364
-
365
- #### Returns
366
-
367
- `this`
368
-
369
- #### Inherited from
370
-
371
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`sourceQuery`](BoundWitnessBuilder.md#sourcequery)
372
-
373
- ***
374
-
375
- ### ~~witness()~~
376
-
377
- > **witness**(`account`): `this`
378
-
379
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:41
380
-
381
- #### Parameters
382
-
383
- ##### account
384
-
385
- `AccountInstance`
386
-
387
- #### Returns
388
-
389
- `this`
390
-
391
- #### Deprecated
392
-
393
- use signer instead
394
-
395
- #### Inherited from
396
-
397
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`witness`](BoundWitnessBuilder.md#witness)
398
-
399
- ***
400
-
401
- ### ~~witnesses()~~
402
-
403
- > **witnesses**(`accounts`): `this`
404
-
405
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:43
406
-
407
- #### Parameters
408
-
409
- ##### accounts
410
-
411
- `AccountInstance`[]
412
-
413
- #### Returns
414
-
415
- `this`
416
-
417
- #### Deprecated
418
-
419
- use signers instead
420
-
421
- #### Inherited from
422
-
423
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`witnesses`](BoundWitnessBuilder.md#witnesses)
424
-
425
- ***
426
-
427
- ### addressIndex()
428
-
429
- > `static` **addressIndex**\<`T`\>(`payload`, `address`): `number`
430
-
431
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:22
432
-
433
- #### Type Parameters
434
-
435
- ##### T
436
-
437
- `T` *extends* [`BoundWitness`](../type-aliases/BoundWitness.md)
438
-
439
- #### Parameters
440
-
441
- ##### payload
442
-
443
- `T`
444
-
445
- ##### address
446
-
447
- `Lowercase`\<`string`\>
448
-
449
- #### Returns
450
-
451
- `number`
452
-
453
- #### Inherited from
454
-
455
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`addressIndex`](BoundWitnessBuilder.md#addressindex)
456
-
457
- ***
458
-
459
- ### addStorageMeta()
460
-
461
- #### Call Signature
462
-
463
- > `static` **addStorageMeta**\<`T`\>(`payload`, `index?`): `Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>\>
464
-
465
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:13
466
-
467
- ##### Type Parameters
468
-
469
- ###### T
470
-
471
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
472
-
473
- ##### Parameters
474
-
475
- ###### payload
476
-
477
- `T`
478
-
479
- ###### index?
480
-
481
- `number`
482
-
483
- ##### Returns
484
-
485
- `Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>\>
486
-
487
- ##### Inherited from
488
-
489
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`addStorageMeta`](BoundWitnessBuilder.md#addstoragemeta)
490
-
491
- #### Call Signature
492
-
493
- > `static` **addStorageMeta**\<`T`\>(`payloads`): `Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]\>
494
-
495
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:14
496
-
497
- ##### Type Parameters
498
-
499
- ###### T
500
-
501
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
502
-
503
- ##### Parameters
504
-
505
- ###### payloads
506
-
507
- `T`[]
508
-
509
- ##### Returns
510
-
511
- `Promise`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]\>
512
-
513
- ##### Inherited from
514
-
515
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`addStorageMeta`](BoundWitnessBuilder.md#addstoragemeta)
516
-
517
- ***
518
-
519
- ### compareStorageMeta()
520
-
521
- > `static` **compareStorageMeta**(`a`, `b`, `comparer?`): `number`
522
-
523
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:15
524
-
525
- #### Parameters
526
-
527
- ##### a
528
-
529
- [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`Payload`](../type-aliases/Payload.md)\>
530
-
531
- ##### b
532
-
533
- [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`Payload`](../type-aliases/Payload.md)\>
534
-
535
- ##### comparer?
536
-
537
- `Compare`\<`Lowercase`\<`string`\>\>
538
-
539
- #### Returns
540
-
541
- `number`
542
-
543
- #### Inherited from
544
-
545
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`compareStorageMeta`](BoundWitnessBuilder.md#comparestoragemeta)
546
-
547
- ***
548
-
549
- ### dataHash()
550
-
551
- > `static` **dataHash**\<`T`\>(`payload`): `Promise`\<`Lowercase`\<`string`\>\>
552
-
553
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:16
554
-
555
- #### Type Parameters
556
-
557
- ##### T
558
-
559
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
560
-
561
- #### Parameters
562
-
563
- ##### payload
564
-
565
- `T`
566
-
567
- #### Returns
568
-
569
- `Promise`\<`Lowercase`\<`string`\>\>
570
-
571
- #### Inherited from
572
-
573
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHash`](BoundWitnessBuilder.md#datahash-2)
574
-
575
- ***
576
-
577
- ### dataHashableFields()
578
-
579
- > `static` **dataHashableFields**\<`T`\>(`schema`, `payload`): `Promisable`\<[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>\>
580
-
581
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:18
582
-
583
- #### Type Parameters
584
-
585
- ##### T
586
-
587
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
588
-
589
- #### Parameters
590
-
591
- ##### schema
592
-
593
- `string`
594
-
595
- ##### payload
596
-
597
- [`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`T`\>
598
-
599
- #### Returns
600
-
601
- `Promisable`\<[`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>\>
602
-
603
- #### Inherited from
604
-
605
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHashableFields`](BoundWitnessBuilder.md#datahashablefields-2)
606
-
607
- ***
608
-
609
- ### dataHashes()
610
-
611
- #### Call Signature
612
-
613
- > `static` **dataHashes**(`payloads`): `Promise`\<`undefined`\>
614
-
615
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:19
616
-
617
- ##### Parameters
618
-
619
- ###### payloads
620
-
621
- `undefined`
622
-
623
- ##### Returns
624
-
625
- `Promise`\<`undefined`\>
626
-
627
- ##### Inherited from
628
-
629
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHashes`](BoundWitnessBuilder.md#datahashes)
630
-
631
- #### Call Signature
632
-
633
- > `static` **dataHashes**\<`T`\>(`payloads`): `Promise`\<`Lowercase`\<`string`\>[]\>
634
-
635
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:20
636
-
637
- ##### Type Parameters
638
-
639
- ###### T
640
-
641
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
642
-
643
- ##### Parameters
644
-
645
- ###### payloads
646
-
647
- `T`[]
648
-
649
- ##### Returns
650
-
651
- `Promise`\<`Lowercase`\<`string`\>[]\>
652
-
653
- ##### Inherited from
654
-
655
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHashes`](BoundWitnessBuilder.md#datahashes)
656
-
657
- ***
658
-
659
- ### dataHashPairs()
660
-
661
- > `static` **dataHashPairs**\<`T`\>(`payloads`): `Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
662
-
663
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:17
664
-
665
- #### Type Parameters
666
-
667
- ##### T
668
-
669
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
670
-
671
- #### Parameters
672
-
673
- ##### payloads
674
-
675
- `T`[]
676
-
677
- #### Returns
678
-
679
- `Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
680
-
681
- #### Inherited from
682
-
683
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`dataHashPairs`](BoundWitnessBuilder.md#datahashpairs)
684
-
685
- ***
686
-
687
- ### filterExclude()
688
-
689
- > `static` **filterExclude**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
690
-
691
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:21
692
-
693
- #### Type Parameters
694
-
695
- ##### T
696
-
697
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
698
-
699
- #### Parameters
700
-
701
- ##### payloads
702
-
703
- `undefined` | `T`[]
704
-
705
- ##### hash
706
-
707
- `Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
708
-
709
- #### Returns
710
-
711
- `Promise`\<`T`[]\>
712
-
713
- #### Inherited from
714
-
715
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`filterExclude`](BoundWitnessBuilder.md#filterexclude)
716
-
717
- ***
718
-
719
- ### filterExcludeByDataHash()
720
-
721
- > `static` **filterExcludeByDataHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
722
-
723
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:22
724
-
725
- #### Type Parameters
726
-
727
- ##### T
728
-
729
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
730
-
731
- #### Parameters
732
-
733
- ##### payloads
734
-
735
- `undefined` | `T`[]
736
-
737
- ##### hash
738
-
739
- `Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
740
-
741
- #### Returns
742
-
743
- `Promise`\<`T`[]\>
744
-
745
- #### Inherited from
746
-
747
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`filterExcludeByDataHash`](BoundWitnessBuilder.md#filterexcludebydatahash)
748
-
749
- ***
750
-
751
- ### filterIncludeByDataHash()
752
-
753
- > `static` **filterIncludeByDataHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
754
-
755
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:23
756
-
757
- #### Type Parameters
758
-
759
- ##### T
760
-
761
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
762
-
763
- #### Parameters
764
-
765
- ##### payloads
766
-
767
- `undefined` | `T`[]
768
-
769
- ##### hash
770
-
771
- `Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
772
-
773
- #### Returns
774
-
775
- `Promise`\<`T`[]\>
776
-
777
- #### Inherited from
778
-
779
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`filterIncludeByDataHash`](BoundWitnessBuilder.md#filterincludebydatahash)
780
-
781
- ***
782
-
783
- ### filterIncludeByEitherHash()
784
-
785
- > `static` **filterIncludeByEitherHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`T`[]\>
786
-
787
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:24
788
-
789
- #### Type Parameters
790
-
791
- ##### T
792
-
793
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
794
-
795
- #### Parameters
796
-
797
- ##### payloads
798
-
799
- `undefined` | `T`[]
800
-
801
- ##### hash
802
-
803
- `Lowercase`\<`string`\> | `Lowercase`\<`string`\>[]
804
-
805
- #### Returns
806
-
807
- `Promise`\<`T`[]\>
808
-
809
- #### Inherited from
810
-
811
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`filterIncludeByEitherHash`](BoundWitnessBuilder.md#filterincludebyeitherhash)
812
-
813
- ***
814
-
815
- ### findByDataHash()
816
-
817
- > `static` **findByDataHash**\<`T`\>(`payloads`, `hash`): `Promise`\<`undefined` \| `T`\>
818
-
819
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:25
820
-
821
- #### Type Parameters
822
-
823
- ##### T
824
-
825
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
826
-
827
- #### Parameters
828
-
829
- ##### payloads
830
-
831
- `undefined` | `T`[]
832
-
833
- ##### hash
834
-
835
- `Lowercase`\<`string`\>
836
-
837
- #### Returns
838
-
839
- `Promise`\<`undefined` \| `T`\>
840
-
841
- #### Inherited from
842
-
843
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`findByDataHash`](BoundWitnessBuilder.md#findbydatahash)
844
-
845
- ***
846
-
847
- ### hash()
848
-
849
- > `static` **hash**\<`T`\>(`payload`): `Promise`\<`Lowercase`\<`string`\>\>
850
-
851
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:26
852
-
853
- #### Type Parameters
854
-
855
- ##### T
856
-
857
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
858
-
859
- #### Parameters
860
-
861
- ##### payload
862
-
863
- `T`
864
-
865
- #### Returns
866
-
867
- `Promise`\<`Lowercase`\<`string`\>\>
868
-
869
- #### Inherited from
870
-
871
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`hash`](BoundWitnessBuilder.md#hash)
872
-
873
- ***
874
-
875
- ### hashableFields()
876
-
877
- > `static` **hashableFields**\<`T`\>(`payload`): [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
878
-
879
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:33
880
-
881
- #### Type Parameters
882
-
883
- ##### T
884
-
885
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
886
-
887
- #### Parameters
888
-
889
- ##### payload
890
-
891
- `T`
892
-
893
- #### Returns
894
-
895
- [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
896
-
897
- #### Inherited from
898
-
899
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`hashableFields`](BoundWitnessBuilder.md#hashablefields)
900
-
901
- ***
902
-
903
- ### hashes()
904
-
905
- #### Call Signature
906
-
907
- > `static` **hashes**(`payloads`): `Promise`\<`undefined`\>
908
-
909
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:34
910
-
911
- ##### Parameters
912
-
913
- ###### payloads
914
-
915
- `undefined`
916
-
917
- ##### Returns
918
-
919
- `Promise`\<`undefined`\>
920
-
921
- ##### Inherited from
922
-
923
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`hashes`](BoundWitnessBuilder.md#hashes-2)
924
-
925
- #### Call Signature
926
-
927
- > `static` **hashes**\<`T`\>(`payloads`): `Promise`\<`Lowercase`\<`string`\>[]\>
928
-
929
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:35
930
-
931
- ##### Type Parameters
932
-
933
- ###### T
934
-
935
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
936
-
937
- ##### Parameters
938
-
939
- ###### payloads
940
-
941
- `T`[]
942
-
943
- ##### Returns
944
-
945
- `Promise`\<`Lowercase`\<`string`\>[]\>
946
-
947
- ##### Inherited from
948
-
949
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`hashes`](BoundWitnessBuilder.md#hashes-2)
950
-
951
- ***
952
-
953
- ### hashPairs()
954
-
955
- > `static` **hashPairs**\<`T`\>(`payloads`): `Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
956
-
957
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:32
958
-
959
- Creates an array of payload/hash tuples based on the payloads passed in
960
-
961
- #### Type Parameters
962
-
963
- ##### T
964
-
965
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
966
-
967
- #### Parameters
968
-
969
- ##### payloads
970
-
971
- `T`[]
972
-
973
- #### Returns
974
-
975
- `Promise`\<\[`T`, `Lowercase`\<`string`\>\][]\>
976
-
977
- An array of payload/hash tuples
978
-
979
- #### Inherited from
980
-
981
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`hashPairs`](BoundWitnessBuilder.md#hashpairs)
982
-
983
- ***
984
-
985
- ### omitClientMeta()
986
-
987
- #### Call Signature
988
-
989
- > `static` **omitClientMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>
990
-
991
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:36
992
-
993
- ##### Type Parameters
994
-
995
- ###### T
996
-
997
- `T` *extends* `object`
998
-
999
- ##### Parameters
1000
-
1001
- ###### payload
1002
-
1003
- `T`
1004
-
1005
- ###### maxDepth?
1006
-
1007
- `number`
1008
-
1009
- ##### Returns
1010
-
1011
- [`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>
1012
-
1013
- ##### Inherited from
1014
-
1015
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitClientMeta`](BoundWitnessBuilder.md#omitclientmeta)
1016
-
1017
- #### Call Signature
1018
-
1019
- > `static` **omitClientMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>[]
1020
-
1021
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:37
1022
-
1023
- ##### Type Parameters
1024
-
1025
- ###### T
1026
-
1027
- `T` *extends* `object`
1028
-
1029
- ##### Parameters
1030
-
1031
- ###### payloads
1032
-
1033
- `T`[]
1034
-
1035
- ###### maxDepth?
1036
-
1037
- `number`
1038
-
1039
- ##### Returns
1040
-
1041
- [`WithoutClientMeta`](../type-aliases/WithoutClientMeta.md)\<`T`\>[]
1042
-
1043
- ##### Inherited from
1044
-
1045
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitClientMeta`](BoundWitnessBuilder.md#omitclientmeta)
1046
-
1047
- ***
1048
-
1049
- ### omitMeta()
1050
-
1051
- #### Call Signature
1052
-
1053
- > `static` **omitMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>
1054
-
1055
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:38
1056
-
1057
- ##### Type Parameters
1058
-
1059
- ###### T
1060
-
1061
- `T` *extends* `object`
1062
-
1063
- ##### Parameters
1064
-
1065
- ###### payload
1066
-
1067
- `T`
1068
-
1069
- ###### maxDepth?
1070
-
1071
- `number`
1072
-
1073
- ##### Returns
1074
-
1075
- [`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>
1076
-
1077
- ##### Inherited from
1078
-
1079
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitMeta`](BoundWitnessBuilder.md#omitmeta)
1080
-
1081
- #### Call Signature
1082
-
1083
- > `static` **omitMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>[]
1084
-
1085
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:39
1086
-
1087
- ##### Type Parameters
1088
-
1089
- ###### T
1090
-
1091
- `T` *extends* `object`
1092
-
1093
- ##### Parameters
1094
-
1095
- ###### payloads
1096
-
1097
- `T`[]
1098
-
1099
- ###### maxDepth?
1100
-
1101
- `number`
1102
-
1103
- ##### Returns
1104
-
1105
- [`WithoutMeta`](../type-aliases/WithoutMeta.md)\<`T`\>[]
1106
-
1107
- ##### Inherited from
1108
-
1109
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitMeta`](BoundWitnessBuilder.md#omitmeta)
1110
-
1111
- ***
1112
-
1113
- ### omitPrivateStorageMeta()
1114
-
1115
- #### Call Signature
1116
-
1117
- > `static` **omitPrivateStorageMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>
1118
-
1119
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:40
1120
-
1121
- ##### Type Parameters
1122
-
1123
- ###### T
1124
-
1125
- `T` *extends* `object`
1126
-
1127
- ##### Parameters
1128
-
1129
- ###### payload
1130
-
1131
- `T`
1132
-
1133
- ###### maxDepth?
1134
-
1135
- `number`
1136
-
1137
- ##### Returns
1138
-
1139
- [`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>
1140
-
1141
- ##### Inherited from
1142
-
1143
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitPrivateStorageMeta`](BoundWitnessBuilder.md#omitprivatestoragemeta)
1144
-
1145
- #### Call Signature
1146
-
1147
- > `static` **omitPrivateStorageMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>[]
1148
-
1149
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:41
1150
-
1151
- ##### Type Parameters
1152
-
1153
- ###### T
1154
-
1155
- `T` *extends* `object`
1156
-
1157
- ##### Parameters
1158
-
1159
- ###### payloads
1160
-
1161
- `T`[]
1162
-
1163
- ###### maxDepth?
1164
-
1165
- `number`
1166
-
1167
- ##### Returns
1168
-
1169
- [`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`T`\>[]
1170
-
1171
- ##### Inherited from
1172
-
1173
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitPrivateStorageMeta`](BoundWitnessBuilder.md#omitprivatestoragemeta)
1174
-
1175
- ***
1176
-
1177
- ### omitStorageMeta()
1178
-
1179
- #### Call Signature
1180
-
1181
- > `static` **omitStorageMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
1182
-
1183
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:42
1184
-
1185
- ##### Type Parameters
1186
-
1187
- ###### T
1188
-
1189
- `T` *extends* `object`
1190
-
1191
- ##### Parameters
1192
-
1193
- ###### payload
1194
-
1195
- `T`
1196
-
1197
- ###### maxDepth?
1198
-
1199
- `number`
1200
-
1201
- ##### Returns
1202
-
1203
- [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>
1204
-
1205
- ##### Inherited from
1206
-
1207
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitStorageMeta`](BoundWitnessBuilder.md#omitstoragemeta)
1208
-
1209
- #### Call Signature
1210
-
1211
- > `static` **omitStorageMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>[]
1212
-
1213
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:43
1214
-
1215
- ##### Type Parameters
1216
-
1217
- ###### T
1218
-
1219
- `T` *extends* `object`
1220
-
1221
- ##### Parameters
1222
-
1223
- ###### payloads
1224
-
1225
- `T`[]
1226
-
1227
- ###### maxDepth?
1228
-
1229
- `number`
1230
-
1231
- ##### Returns
1232
-
1233
- [`WithoutStorageMeta`](../type-aliases/WithoutStorageMeta.md)\<`T`\>[]
1234
-
1235
- ##### Inherited from
1236
-
1237
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`omitStorageMeta`](BoundWitnessBuilder.md#omitstoragemeta)
1238
-
1239
- ***
1240
-
1241
- ### pickClientMeta()
1242
-
1243
- #### Call Signature
1244
-
1245
- > `static` **pickClientMeta**\<`T`\>(`payload`, `maxDepth?`): [`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>
1246
-
1247
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:44
1248
-
1249
- ##### Type Parameters
1250
-
1251
- ###### T
1252
-
1253
- `T` *extends* `object`
1254
-
1255
- ##### Parameters
1256
-
1257
- ###### payload
1258
-
1259
- `T`
1260
-
1261
- ###### maxDepth?
1262
-
1263
- `number`
1264
-
1265
- ##### Returns
1266
-
1267
- [`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>
1268
-
1269
- ##### Inherited from
1270
-
1271
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`pickClientMeta`](BoundWitnessBuilder.md#pickclientmeta)
1272
-
1273
- #### Call Signature
1274
-
1275
- > `static` **pickClientMeta**\<`T`\>(`payloads`, `maxDepth?`): [`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>[]
1276
-
1277
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:45
1278
-
1279
- ##### Type Parameters
1280
-
1281
- ###### T
1282
-
1283
- `T` *extends* `object`
1284
-
1285
- ##### Parameters
1286
-
1287
- ###### payloads
1288
-
1289
- `T`[]
1290
-
1291
- ###### maxDepth?
1292
-
1293
- `number`
1294
-
1295
- ##### Returns
1296
-
1297
- [`WithOnlyClientMeta`](../type-aliases/WithOnlyClientMeta.md)\<`T`\>[]
1298
-
1299
- ##### Inherited from
1300
-
1301
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`pickClientMeta`](BoundWitnessBuilder.md#pickclientmeta)
1302
-
1303
- ***
1304
-
1305
- ### previousHash()
1306
-
1307
- > `static` **previousHash**\<`T`\>(`boundWitness`, `address`): `undefined` \| `string`
1308
-
1309
- Defined in: packages/protocol/packages/boundwitness/packages/builder/dist/types/Builder.d.ts:23
1310
-
1311
- #### Type Parameters
1312
-
1313
- ##### T
1314
-
1315
- `T` *extends* [`BoundWitness`](../type-aliases/BoundWitness.md)
1316
-
1317
- #### Parameters
1318
-
1319
- ##### boundWitness
1320
-
1321
- `T`
1322
-
1323
- ##### address
1324
-
1325
- `Lowercase`\<`string`\>
1326
-
1327
- #### Returns
1328
-
1329
- `undefined` \| `string`
1330
-
1331
- #### Inherited from
1332
-
1333
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`previousHash`](BoundWitnessBuilder.md#previoushash)
1334
-
1335
- ***
1336
-
1337
- ### sortByStorageMeta()
1338
-
1339
- > `static` **sortByStorageMeta**\<`T`\>(`payloads`, `direction?`, `comparer?`): [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]
1340
-
1341
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:46
1342
-
1343
- #### Type Parameters
1344
-
1345
- ##### T
1346
-
1347
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
1348
-
1349
- #### Parameters
1350
-
1351
- ##### payloads
1352
-
1353
- [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]
1354
-
1355
- ##### direction?
1356
-
1357
- `1` | `-1`
1358
-
1359
- ##### comparer?
1360
-
1361
- `Compare`\<`Lowercase`\<`string`\>\>
1362
-
1363
- #### Returns
1364
-
1365
- [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`T`\>[]
1366
-
1367
- #### Inherited from
1368
-
1369
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`sortByStorageMeta`](BoundWitnessBuilder.md#sortbystoragemeta)
1370
-
1371
- ***
1372
-
1373
- ### toAllHashMap()
1374
-
1375
- > `static` **toAllHashMap**\<`T`\>(`payloads`): `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
1376
-
1377
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:47
1378
-
1379
- #### Type Parameters
1380
-
1381
- ##### T
1382
-
1383
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
1384
-
1385
- #### Parameters
1386
-
1387
- ##### payloads
1388
-
1389
- `T`[]
1390
-
1391
- #### Returns
1392
-
1393
- `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
1394
-
1395
- #### Inherited from
1396
-
1397
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`toAllHashMap`](BoundWitnessBuilder.md#toallhashmap)
1398
-
1399
- ***
1400
-
1401
- ### toDataHashMap()
1402
-
1403
- > `static` **toDataHashMap**\<`T`\>(`objs`): `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
1404
-
1405
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:48
1406
-
1407
- #### Type Parameters
1408
-
1409
- ##### T
1410
-
1411
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
1412
-
1413
- #### Parameters
1414
-
1415
- ##### objs
1416
-
1417
- `T`[]
1418
-
1419
- #### Returns
1420
-
1421
- `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
1422
-
1423
- #### Inherited from
1424
-
1425
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`toDataHashMap`](BoundWitnessBuilder.md#todatahashmap)
1426
-
1427
- ***
1428
-
1429
- ### toHashMap()
1430
-
1431
- > `static` **toHashMap**\<`T`\>(`objs`): `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
1432
-
1433
- Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:54
1434
-
1435
- Creates an object map of payload hashes to payloads based on the payloads passed in
1436
-
1437
- #### Type Parameters
1438
-
1439
- ##### T
1440
-
1441
- `T` *extends* [`Payload`](../type-aliases/Payload.md)
1442
-
1443
- #### Parameters
1444
-
1445
- ##### objs
1446
-
1447
- `T`[]
1448
-
1449
- Any array of payloads
1450
-
1451
- #### Returns
1452
-
1453
- `Promise`\<`Record`\<`Lowercase`\<`string`\>, `T`\>\>
1454
-
1455
- A map of hashes to payloads
1456
-
1457
- #### Inherited from
1458
-
1459
- [`BoundWitnessBuilder`](BoundWitnessBuilder.md).[`toHashMap`](BoundWitnessBuilder.md#tohashmap)