@xyo-network/sdk-js 3.14.16 → 3.14.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -84
- package/docs/README.md +748 -0
- package/docs/classes/AbstractData.md +127 -0
- package/docs/classes/AbstractModuleResolver.md +666 -0
- package/docs/classes/Account.md +431 -0
- package/docs/classes/AddressValue.md +251 -0
- package/docs/classes/ArchivistWrapper.md +2073 -0
- package/docs/classes/BaseEmitter.md +643 -0
- package/docs/classes/BoundWitnessBuilder.md +1387 -0
- package/docs/classes/BoundWitnessValidator.md +243 -0
- package/docs/classes/BoundWitnessWrapper.md +697 -0
- package/docs/classes/BridgeWrapper.md +1807 -0
- package/docs/classes/CompositeModuleResolver.md +824 -0
- package/docs/classes/Data.md +173 -0
- package/docs/classes/DeadModuleError.md +191 -0
- package/docs/classes/DivinerWrapper.md +1819 -0
- package/docs/classes/EllipticKey.md +180 -0
- package/docs/classes/Events.md +743 -0
- package/docs/classes/Huri.md +161 -0
- package/docs/classes/IsAttachableArchivistInstanceFactory.md +55 -0
- package/docs/classes/IsAttachableBridgeInstanceFactory.md +55 -0
- package/docs/classes/IsAttachableDivinerInstanceFactory.md +55 -0
- package/docs/classes/IsAttachableModuleInstanceFactory.md +55 -0
- package/docs/classes/IsAttachableNodeInstanceFactory.md +55 -0
- package/docs/classes/IsAttachableSentinelInstanceFactory.md +55 -0
- package/docs/classes/IsAttachableWitnessInstanceFactory.md +55 -0
- package/docs/classes/IsInstanceFactory.md +55 -0
- package/docs/classes/IsModuleFactory.md +43 -0
- package/docs/classes/ManifestWrapper.md +689 -0
- package/docs/classes/ManifestWrapperEx.md +743 -0
- package/docs/classes/ModuleDetailsError.md +179 -0
- package/docs/classes/ModuleFactory.md +243 -0
- package/docs/classes/ModuleWrapper.md +1559 -0
- package/docs/classes/NameRegistrarTransformer.md +53 -0
- package/docs/classes/NodeWrapper.md +1983 -0
- package/docs/classes/ObjectHasher.md +657 -0
- package/docs/classes/PayloadBuilder.md +967 -0
- package/docs/classes/PayloadHasher.md +657 -0
- package/docs/classes/PayloadValidator.md +121 -0
- package/docs/classes/PayloadWrapper.md +462 -0
- package/docs/classes/PayloadWrapperBase.md +225 -0
- package/docs/classes/PrivateKey.md +265 -0
- package/docs/classes/PublicKey.md +261 -0
- package/docs/classes/QueryBoundWitnessBuilder.md +1459 -0
- package/docs/classes/QueryBoundWitnessWrapper.md +861 -0
- package/docs/classes/ResolveHelper.md +217 -0
- package/docs/classes/SequenceParser.md +469 -0
- package/docs/classes/SimpleModuleResolver.md +779 -0
- package/docs/classes/WasmSupport.md +231 -0
- package/docs/classes/WitnessWrapper.md +1803 -0
- package/docs/functions/constructableModuleWrapper.md +33 -0
- package/docs/functions/creatableModule.md +39 -0
- package/docs/functions/creatableModuleFactory.md +39 -0
- package/docs/functions/isPayloadOfSchemaType.md +33 -0
- package/docs/functions/labeledCreatableModuleFactory.md +39 -0
- package/docs/interfaces/AddressChildFields.md +41 -0
- package/docs/interfaces/AddressFields.md +17 -0
- package/docs/interfaces/AddressObjectFilter.md +95 -0
- package/docs/interfaces/AddressToWeakInstanceCache.md +45 -0
- package/docs/interfaces/AllArchivist.md +35 -0
- package/docs/interfaces/AllArchivistFunctions.md +27 -0
- package/docs/interfaces/ArchivingModuleConfig.md +21 -0
- package/docs/interfaces/ArchivingReentrancyConfig.md +21 -0
- package/docs/interfaces/Archivist.md +163 -0
- package/docs/interfaces/ArchivistInstance.md +1299 -0
- package/docs/interfaces/ArchivistLabels.md +23 -0
- package/docs/interfaces/ArchivistModuleEventData.md +157 -0
- package/docs/interfaces/ArchivistModuleInstance.md +486 -0
- package/docs/interfaces/ArchivistNextOptions.md +57 -0
- package/docs/interfaces/ArchivistParamFields.md +13 -0
- package/docs/interfaces/ArchivistParentInstances.md +29 -0
- package/docs/interfaces/ArchivistParents.md +29 -0
- package/docs/interfaces/ArchivistRawQueryFunctions.md +151 -0
- package/docs/interfaces/ArchivistStorage.md +15 -0
- package/docs/interfaces/AttachableArchivistInstance.md +1331 -0
- package/docs/interfaces/AttachableBridgeInstance.md +1141 -0
- package/docs/interfaces/AttachableDivinerInstance.md +1085 -0
- package/docs/interfaces/AttachableModuleInstance.md +1018 -0
- package/docs/interfaces/AttachableNodeInstance.md +1309 -0
- package/docs/interfaces/AttachableSentinelInstance.md +1069 -0
- package/docs/interfaces/AttachableWitnessInstance.md +1077 -0
- package/docs/interfaces/BoundWitnessBlockField.md +17 -0
- package/docs/interfaces/BoundWitnessChainField.md +17 -0
- package/docs/interfaces/BoundWitnessFields.md +105 -0
- package/docs/interfaces/BoundWitnessMeta.md +29 -0
- package/docs/interfaces/BoundWitnessOptionalFields.md +49 -0
- package/docs/interfaces/BoundWitnessRequiredFields.md +45 -0
- package/docs/interfaces/BridgeExposeOptions.md +25 -0
- package/docs/interfaces/BridgeInstance.md +1105 -0
- package/docs/interfaces/BridgeModule.md +486 -0
- package/docs/interfaces/BridgeModuleEventData.md +269 -0
- package/docs/interfaces/BridgeParams.md +143 -0
- package/docs/interfaces/BridgeQueryFunctions.md +97 -0
- package/docs/interfaces/BridgeRawQueryFunctions.md +93 -0
- package/docs/interfaces/BridgeUnexposeOptions.md +33 -0
- package/docs/interfaces/CacheConfig.md +29 -0
- package/docs/interfaces/ChildCertificationFields.md +21 -0
- package/docs/interfaces/CompositeModuleResolverParams.md +69 -0
- package/docs/interfaces/ConfigManifest.md +61 -0
- package/docs/interfaces/CreatableModule.md +139 -0
- package/docs/interfaces/CreatableModuleRegistry.md +9 -0
- package/docs/interfaces/CustomSentinelInstance.md +1033 -0
- package/docs/interfaces/CustomSentinelModule.md +485 -0
- package/docs/interfaces/DataHashStorageMeta.md +17 -0
- package/docs/interfaces/DataInstance.md +37 -0
- package/docs/interfaces/DivineEndEventData.md +55 -0
- package/docs/interfaces/DivineStartEventData.md +43 -0
- package/docs/interfaces/DivinerInstance.md +1053 -0
- package/docs/interfaces/DivinerModule.md +485 -0
- package/docs/interfaces/DivinerQueryFunctions.md +67 -0
- package/docs/interfaces/EventFunctions.md +235 -0
- package/docs/interfaces/ExposedEventData.md +43 -0
- package/docs/interfaces/FetchedPayload.md +27 -0
- package/docs/interfaces/FullArchivist.md +147 -0
- package/docs/interfaces/HashStorageMeta.md +33 -0
- package/docs/interfaces/HuriOptions.md +21 -0
- package/docs/interfaces/JobEndEventData.md +47 -0
- package/docs/interfaces/JobStartEventData.md +43 -0
- package/docs/interfaces/Labels.md +15 -0
- package/docs/interfaces/Manifest.md +18 -0
- package/docs/interfaces/ManifestWrapperExParams.md +45 -0
- package/docs/interfaces/Module.md +492 -0
- package/docs/interfaces/ModuleAttachedEventData.md +29 -0
- package/docs/interfaces/ModuleBusyEventData.md +43 -0
- package/docs/interfaces/ModuleConfigFields.md +130 -0
- package/docs/interfaces/ModuleDescription.md +37 -0
- package/docs/interfaces/ModuleDetachedEventData.md +29 -0
- package/docs/interfaces/ModuleErrorEventData.md +43 -0
- package/docs/interfaces/ModuleEventData.md +106 -0
- package/docs/interfaces/ModuleFactoryLocatorInstance.md +159 -0
- package/docs/interfaces/ModuleFamilyFunctions.md +131 -0
- package/docs/interfaces/ModuleFields.md +173 -0
- package/docs/interfaces/ModuleFilterOptions.md +87 -0
- package/docs/interfaces/ModuleIdentifierTransformer.md +13 -0
- package/docs/interfaces/ModuleInstance.md +987 -0
- package/docs/interfaces/ModuleManifest.md +57 -0
- package/docs/interfaces/ModuleNameResolver.md +39 -0
- package/docs/interfaces/ModuleQueriedEventData.md +51 -0
- package/docs/interfaces/ModuleQueryFunctions.md +99 -0
- package/docs/interfaces/ModuleRegisteredEventData.md +29 -0
- package/docs/interfaces/ModuleRepository.md +391 -0
- package/docs/interfaces/ModuleResolvedEventArgs.md +21 -0
- package/docs/interfaces/ModuleResolver.md +243 -0
- package/docs/interfaces/ModuleResolverInstance.md +317 -0
- package/docs/interfaces/ModuleResolverParams.md +41 -0
- package/docs/interfaces/ModuleSecurityConfig.md +41 -0
- package/docs/interfaces/ModuleSubscribeFilter.md +17 -0
- package/docs/interfaces/ModuleTask.md +55 -0
- package/docs/interfaces/ModuleUnregisteredEventData.md +29 -0
- package/docs/interfaces/NameObjectFilter.md +95 -0
- package/docs/interfaces/NextOptions.md +47 -0
- package/docs/interfaces/NodeInstance.md +1277 -0
- package/docs/interfaces/NodeManifest.md +85 -0
- package/docs/interfaces/NodeManifestPayload.md +93 -0
- package/docs/interfaces/NodeModule.md +486 -0
- package/docs/interfaces/NodeModuleEventData.md +157 -0
- package/docs/interfaces/NodeQueryFunctions.md +197 -0
- package/docs/interfaces/NodeRegistrationFunctions.md +57 -0
- package/docs/interfaces/ObjectFilterOptions.md +86 -0
- package/docs/interfaces/ObjectResolver.md +209 -0
- package/docs/interfaces/ObjectResolverInstance.md +275 -0
- package/docs/interfaces/ObserveEndEventData.md +55 -0
- package/docs/interfaces/ObserveStartEventData.md +43 -0
- package/docs/interfaces/PackageManifest.md +37 -0
- package/docs/interfaces/PayloadBuilderOptions.md +21 -0
- package/docs/interfaces/PayloadFields.md +23 -0
- package/docs/interfaces/PayloadFindFilter.md +29 -0
- package/docs/interfaces/PayloadMetaFields.md +21 -0
- package/docs/interfaces/PayloadSet.md +21 -0
- package/docs/interfaces/QueryFields.md +53 -0
- package/docs/interfaces/QueryFulfillFinishedEventData.md +55 -0
- package/docs/interfaces/QueryFulfillStartedEventData.md +47 -0
- package/docs/interfaces/QueryObjectFilter.md +95 -0
- package/docs/interfaces/QuerySendFinishedEventData.md +55 -0
- package/docs/interfaces/QuerySendStartedEventData.md +47 -0
- package/docs/interfaces/ReadArchivist.md +68 -0
- package/docs/interfaces/ReadArchivistFunctions.md +55 -0
- package/docs/interfaces/ReadWriteArchivist.md +135 -0
- package/docs/interfaces/ReportEndEventData.md +51 -0
- package/docs/interfaces/ReportStartEventData.md +43 -0
- package/docs/interfaces/ResolveHelperConfig.md +69 -0
- package/docs/interfaces/ResolveStrategy.md +41 -0
- package/docs/interfaces/ResolverEventEmitter.md +27 -0
- package/docs/interfaces/SchemaField.md +23 -0
- package/docs/interfaces/SchemaFields.md +21 -0
- package/docs/interfaces/SearchableStorage.md +37 -0
- package/docs/interfaces/Sentinel.md +60 -0
- package/docs/interfaces/SentinelInstance.md +1038 -0
- package/docs/interfaces/SentinelJob.md +13 -0
- package/docs/interfaces/SentinelModule.md +486 -0
- package/docs/interfaces/SentinelModuleEventData.md +275 -0
- package/docs/interfaces/SequenceStorageMeta.md +17 -0
- package/docs/interfaces/SourcesMetaField.md +17 -0
- package/docs/interfaces/StashArchivist.md +35 -0
- package/docs/interfaces/StashArchivistFunctions.md +28 -0
- package/docs/interfaces/State.md +19 -0
- package/docs/interfaces/StateDictionary.md +9 -0
- package/docs/interfaces/StorageMeta.md +45 -0
- package/docs/interfaces/TaskEndEventData.md +55 -0
- package/docs/interfaces/TaskStartEventData.md +51 -0
- package/docs/interfaces/Timestamp.md +15 -0
- package/docs/interfaces/UnexposedEventData.md +43 -0
- package/docs/interfaces/WithLabels.md +21 -0
- package/docs/interfaces/WithOptionalLabels.md +21 -0
- package/docs/interfaces/WitnessInstance.md +1045 -0
- package/docs/interfaces/WitnessModule.md +485 -0
- package/docs/interfaces/WitnessQueryFunctions.md +59 -0
- package/docs/interfaces/WriteArchivist.md +92 -0
- package/docs/interfaces/WriteArchivistFunctions.md +75 -0
- package/docs/type-aliases/AddressChildPayload.md +7 -0
- package/docs/type-aliases/AddressChildSchema.md +7 -0
- package/docs/type-aliases/AddressModuleFilter.md +13 -0
- package/docs/type-aliases/AddressPayload.md +7 -0
- package/docs/type-aliases/AddressPreviousHashPayload.md +7 -0
- package/docs/type-aliases/AddressPreviousHashSchema.md +7 -0
- package/docs/type-aliases/AddressSchema.md +7 -0
- package/docs/type-aliases/AllValidator.md +19 -0
- package/docs/type-aliases/AllValidatorFactory.md +17 -0
- package/docs/type-aliases/AnyBoundWitness.md +7 -0
- package/docs/type-aliases/AnyConfigSchema.md +13 -0
- package/docs/type-aliases/AnyModuleConfig.md +7 -0
- package/docs/type-aliases/AnyModuleFilter.md +13 -0
- package/docs/type-aliases/AnyObjectFilter.md +13 -0
- package/docs/type-aliases/AnyPayload.md +7 -0
- package/docs/type-aliases/ArchivistAllQuery.md +7 -0
- package/docs/type-aliases/ArchivistAllQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistClearQuery.md +7 -0
- package/docs/type-aliases/ArchivistClearQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistCommitQuery.md +7 -0
- package/docs/type-aliases/ArchivistCommitQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistConfig.md +17 -0
- package/docs/type-aliases/ArchivistConfigSchema.md +7 -0
- package/docs/type-aliases/ArchivistDeleteQuery.md +7 -0
- package/docs/type-aliases/ArchivistDeleteQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistGetQuery.md +7 -0
- package/docs/type-aliases/ArchivistGetQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistInsertQuery.md +7 -0
- package/docs/type-aliases/ArchivistInsertQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistModuleQueries.md +7 -0
- package/docs/type-aliases/ArchivistNextQuery.md +7 -0
- package/docs/type-aliases/ArchivistNextQuerySchema.md +7 -0
- package/docs/type-aliases/ArchivistParams.md +17 -0
- package/docs/type-aliases/ArchivistQueries.md +7 -0
- package/docs/type-aliases/ArchivistTask.md +7 -0
- package/docs/type-aliases/AsyncPayloadValidationFunction.md +25 -0
- package/docs/type-aliases/AttachableArchivistInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/AttachableBridgeInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/AttachableDivinerInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/AttachableModuleInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/AttachableNodeInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/AttachableSentinelInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/AttachableWitnessInstanceTypeCheck.md +13 -0
- package/docs/type-aliases/BoundWitness.md +13 -0
- package/docs/type-aliases/BoundWitnessSchema.md +7 -0
- package/docs/type-aliases/BridgeClientConfig.md +31 -0
- package/docs/type-aliases/BridgeConfig.md +25 -0
- package/docs/type-aliases/BridgeConfigSchema.md +7 -0
- package/docs/type-aliases/BridgeConnectQuery.md +7 -0
- package/docs/type-aliases/BridgeConnectQuerySchema.md +7 -0
- package/docs/type-aliases/BridgeDisconnectQuery.md +7 -0
- package/docs/type-aliases/BridgeDisconnectQuerySchema.md +7 -0
- package/docs/type-aliases/BridgeExposeQuery.md +7 -0
- package/docs/type-aliases/BridgeExposeQuerySchema.md +7 -0
- package/docs/type-aliases/BridgeHostConfig.md +23 -0
- package/docs/type-aliases/BridgeModuleQueries.md +7 -0
- package/docs/type-aliases/BridgeQueries.md +7 -0
- package/docs/type-aliases/BridgeUnexposeQuery.md +7 -0
- package/docs/type-aliases/BridgeUnexposeQuerySchema.md +7 -0
- package/docs/type-aliases/ChildCertification.md +7 -0
- package/docs/type-aliases/ChildCertificationSchema.md +7 -0
- package/docs/type-aliases/ColonPair.md +13 -0
- package/docs/type-aliases/ConstructableModuleWrapper.md +177 -0
- package/docs/type-aliases/CosigningAddressSet.md +7 -0
- package/docs/type-aliases/CreatableModuleFactory.md +39 -0
- package/docs/type-aliases/CustomWitnessInstance.md +25 -0
- package/docs/type-aliases/CustomWitnessModule.md +25 -0
- package/docs/type-aliases/DappPackageManifestPayloadSchema.md +7 -0
- package/docs/type-aliases/DebugLogger.md +36 -0
- package/docs/type-aliases/DebugOptions.md +33 -0
- package/docs/type-aliases/Direction.md +7 -0
- package/docs/type-aliases/DivineEndEventArgs.md +21 -0
- package/docs/type-aliases/DivineStartEventArgs.md +17 -0
- package/docs/type-aliases/DivinedPayload.md +17 -0
- package/docs/type-aliases/DivinerConfig.md +17 -0
- package/docs/type-aliases/DivinerConfigSchema.md +7 -0
- package/docs/type-aliases/DivinerDivineQuery.md +7 -0
- package/docs/type-aliases/DivinerDivineQuerySchema.md +7 -0
- package/docs/type-aliases/DivinerDivineResult.md +13 -0
- package/docs/type-aliases/DivinerModuleEventData.md +21 -0
- package/docs/type-aliases/DivinerModuleQueries.md +7 -0
- package/docs/type-aliases/DivinerParams.md +17 -0
- package/docs/type-aliases/DivinerQueries.md +7 -0
- package/docs/type-aliases/DivinerTask.md +7 -0
- package/docs/type-aliases/Epoch.md +7 -0
- package/docs/type-aliases/EventAnyListener.md +27 -0
- package/docs/type-aliases/EventArgs.md +7 -0
- package/docs/type-aliases/EventData.md +11 -0
- package/docs/type-aliases/EventListener.md +23 -0
- package/docs/type-aliases/EventListenerInfo.md +29 -0
- package/docs/type-aliases/EventName.md +7 -0
- package/docs/type-aliases/EventUnsubscribeFunction.md +11 -0
- package/docs/type-aliases/EventsParams.md +7 -0
- package/docs/type-aliases/ExposedEventArgs.md +13 -0
- package/docs/type-aliases/GeneratedBoundWitnessFields.md +7 -0
- package/docs/type-aliases/HuriFetchFunction.md +17 -0
- package/docs/type-aliases/HydratedBoundWitness.md +17 -0
- package/docs/type-aliases/HydratedBoundWitnessWithStorageMeta.md +17 -0
- package/docs/type-aliases/IdentityFunction.md +23 -0
- package/docs/type-aliases/IndexDescription.md +49 -0
- package/docs/type-aliases/IndexDirection.md +9 -0
- package/docs/type-aliases/InstanceTypeCheck.md +13 -0
- package/docs/type-aliases/JobEndEventArgs.md +13 -0
- package/docs/type-aliases/JobStartEventArgs.md +13 -0
- package/docs/type-aliases/LabeledCreatableModuleFactory.md +13 -0
- package/docs/type-aliases/LocalSequence.md +7 -0
- package/docs/type-aliases/MetaEventData.md +45 -0
- package/docs/type-aliases/ModuleAddressQuery.md +7 -0
- package/docs/type-aliases/ModuleAddressQuerySchema.md +7 -0
- package/docs/type-aliases/ModuleAlias.md +7 -0
- package/docs/type-aliases/ModuleAttachedEventArgs.md +13 -0
- package/docs/type-aliases/ModuleBusyEventArgs.md +13 -0
- package/docs/type-aliases/ModuleConfig.md +17 -0
- package/docs/type-aliases/ModuleConfigSchema.md +7 -0
- package/docs/type-aliases/ModuleDescriptionPayload.md +7 -0
- package/docs/type-aliases/ModuleDescriptionSchema.md +7 -0
- package/docs/type-aliases/ModuleDetachedEventArgs.md +13 -0
- package/docs/type-aliases/ModuleError.md +7 -0
- package/docs/type-aliases/ModuleErrorEventArgs.md +13 -0
- package/docs/type-aliases/ModuleErrorSchema.md +7 -0
- package/docs/type-aliases/ModuleEventArgs.md +17 -0
- package/docs/type-aliases/ModuleFilter.md +17 -0
- package/docs/type-aliases/ModuleFilterPayload.md +7 -0
- package/docs/type-aliases/ModuleFilterPayloadSchema.md +7 -0
- package/docs/type-aliases/ModuleIdentifier.md +7 -0
- package/docs/type-aliases/ModuleIdentifierPart.md +7 -0
- package/docs/type-aliases/ModuleIdentifierTransformerFunc.md +17 -0
- package/docs/type-aliases/ModuleLimitationLabelName.md +7 -0
- package/docs/type-aliases/ModuleManifestPayload.md +7 -0
- package/docs/type-aliases/ModuleManifestPayloadSchema.md +7 -0
- package/docs/type-aliases/ModuleManifestQuery.md +7 -0
- package/docs/type-aliases/ModuleManifestQuerySchema.md +7 -0
- package/docs/type-aliases/ModuleName.md +7 -0
- package/docs/type-aliases/ModuleParams.md +17 -0
- package/docs/type-aliases/ModulePipeLine.md +7 -0
- package/docs/type-aliases/ModuleQueriedEventArgs.md +13 -0
- package/docs/type-aliases/ModuleQueries.md +7 -0
- package/docs/type-aliases/ModuleQueryHandlerResult.md +7 -0
- package/docs/type-aliases/ModuleQueryResult.md +21 -0
- package/docs/type-aliases/ModuleRegisteredEventArgs.md +13 -0
- package/docs/type-aliases/ModuleResolveDirection.md +7 -0
- package/docs/type-aliases/ModuleState.md +13 -0
- package/docs/type-aliases/ModuleStateQuery.md +7 -0
- package/docs/type-aliases/ModuleStateQuerySchema.md +7 -0
- package/docs/type-aliases/ModuleStateSchema.md +7 -0
- package/docs/type-aliases/ModuleStatus.md +7 -0
- package/docs/type-aliases/ModuleSubscribeQuery.md +7 -0
- package/docs/type-aliases/ModuleSubscribeQuerySchema.md +7 -0
- package/docs/type-aliases/ModuleTypeCheck.md +13 -0
- package/docs/type-aliases/ModuleUnregisteredEventArgs.md +13 -0
- package/docs/type-aliases/ModuleWrapperParams.md +13 -0
- package/docs/type-aliases/NameModuleFilter.md +13 -0
- package/docs/type-aliases/NodeAttachQuery.md +7 -0
- package/docs/type-aliases/NodeAttachQuerySchema.md +7 -0
- package/docs/type-aliases/NodeAttachedQuery.md +7 -0
- package/docs/type-aliases/NodeAttachedQuerySchema.md +7 -0
- package/docs/type-aliases/NodeCertifyQuery.md +7 -0
- package/docs/type-aliases/NodeCertifyQuerySchema.md +7 -0
- package/docs/type-aliases/NodeConfig.md +17 -0
- package/docs/type-aliases/NodeConfigSchema.md +7 -0
- package/docs/type-aliases/NodeDetachQuery.md +7 -0
- package/docs/type-aliases/NodeDetachQuerySchema.md +7 -0
- package/docs/type-aliases/NodeManifestPayloadSchema.md +7 -0
- package/docs/type-aliases/NodeModuleQueries.md +7 -0
- package/docs/type-aliases/NodeParams.md +17 -0
- package/docs/type-aliases/NodeQueries.md +7 -0
- package/docs/type-aliases/NodeRegisteredQuery.md +7 -0
- package/docs/type-aliases/NodeRegisteredQuerySchema.md +7 -0
- package/docs/type-aliases/Nonce.md +7 -0
- package/docs/type-aliases/ObjectCategory.md +7 -0
- package/docs/type-aliases/ObjectFilter.md +13 -0
- package/docs/type-aliases/ObjectResolverPriority.md +7 -0
- package/docs/type-aliases/ObserveEndEventArgs.md +21 -0
- package/docs/type-aliases/ObserveStartEventArgs.md +17 -0
- package/docs/type-aliases/OptionalConfigSchema.md +19 -0
- package/docs/type-aliases/OverridablePayload.md +13 -0
- package/docs/type-aliases/PackageManifestPayload.md +7 -0
- package/docs/type-aliases/PackageManifestPayloadSchema.md +7 -0
- package/docs/type-aliases/Payload.md +19 -0
- package/docs/type-aliases/PayloadLoader.md +17 -0
- package/docs/type-aliases/PayloadLoaderFactory.md +11 -0
- package/docs/type-aliases/PayloadProperty.md +15 -0
- package/docs/type-aliases/PayloadSchema.md +7 -0
- package/docs/type-aliases/PayloadSetPayload.md +7 -0
- package/docs/type-aliases/PayloadSetSchema.md +7 -0
- package/docs/type-aliases/PayloadValidationFunction.md +15 -0
- package/docs/type-aliases/PayloadValue.md +19 -0
- package/docs/type-aliases/PayloadValueExpression.md +33 -0
- package/docs/type-aliases/PayloadWithOptionalSources.md +21 -0
- package/docs/type-aliases/PayloadWithSources.md +17 -0
- package/docs/type-aliases/QualifiedSequence.md +7 -0
- package/docs/type-aliases/Query.md +17 -0
- package/docs/type-aliases/QueryBoundWitness.md +7 -0
- package/docs/type-aliases/QueryBoundWitnessFields.md +23 -0
- package/docs/type-aliases/QueryFulfillFinishedEventArgs.md +13 -0
- package/docs/type-aliases/QueryFulfillStartedEventArgs.md +13 -0
- package/docs/type-aliases/QueryModuleFilter.md +13 -0
- package/docs/type-aliases/QuerySendFinishedEventArgs.md +13 -0
- package/docs/type-aliases/QuerySendStartedEventArgs.md +13 -0
- package/docs/type-aliases/ReportEndEventArgs.md +13 -0
- package/docs/type-aliases/ReportStartEventArgs.md +13 -0
- package/docs/type-aliases/ReservedModuleIdentifierCharacter.md +7 -0
- package/docs/type-aliases/ResolvedArchivistTask.md +7 -0
- package/docs/type-aliases/ResolvedDivinerTask.md +7 -0
- package/docs/type-aliases/ResolvedModuleTask.md +27 -0
- package/docs/type-aliases/ResolvedTask.md +7 -0
- package/docs/type-aliases/ResolvedWitnessTask.md +7 -0
- package/docs/type-aliases/Schema.md +9 -0
- package/docs/type-aliases/SentinelAutomationPayload.md +9 -0
- package/docs/type-aliases/SentinelAutomationSchema.md +7 -0
- package/docs/type-aliases/SentinelBaseAutomationPayload.md +13 -0
- package/docs/type-aliases/SentinelConfig.md +17 -0
- package/docs/type-aliases/SentinelConfigSchema.md +7 -0
- package/docs/type-aliases/SentinelEventAutomationPayload.md +9 -0
- package/docs/type-aliases/SentinelEventAutomationSchema.md +7 -0
- package/docs/type-aliases/SentinelIntervalAutomationPayload.md +9 -0
- package/docs/type-aliases/SentinelIntervalAutomationSchema.md +7 -0
- package/docs/type-aliases/SentinelModuleQueries.md +7 -0
- package/docs/type-aliases/SentinelParams.md +17 -0
- package/docs/type-aliases/SentinelQueries.md +7 -0
- package/docs/type-aliases/SentinelReportQuery.md +7 -0
- package/docs/type-aliases/SentinelReportQuerySchema.md +7 -0
- package/docs/type-aliases/Sequence.md +7 -0
- package/docs/type-aliases/Signed.md +19 -0
- package/docs/type-aliases/SignedBoundWitness.md +7 -0
- package/docs/type-aliases/SignedHydratedBoundWitness.md +17 -0
- package/docs/type-aliases/SignedHydratedBoundWitnessWithStorageMeta.md +17 -0
- package/docs/type-aliases/SimpleModuleResolverParams.md +13 -0
- package/docs/type-aliases/SyncPayloadValidationFunction.md +25 -0
- package/docs/type-aliases/Task.md +7 -0
- package/docs/type-aliases/TaskEndEventArgs.md +13 -0
- package/docs/type-aliases/TaskStartEventArgs.md +13 -0
- package/docs/type-aliases/UnexposedEventArgs.md +13 -0
- package/docs/type-aliases/UnsignedBoundWitness.md +13 -0
- package/docs/type-aliases/UnsignedQueryBoundWitness.md +7 -0
- package/docs/type-aliases/Visibility.md +7 -0
- package/docs/type-aliases/WasmFeature.md +7 -0
- package/docs/type-aliases/WithAnySchema.md +13 -0
- package/docs/type-aliases/WithBlock.md +7 -0
- package/docs/type-aliases/WithDataHashStorageMeta.md +13 -0
- package/docs/type-aliases/WithHashStorageMeta.md +13 -0
- package/docs/type-aliases/WithOnlyClientMeta.md +13 -0
- package/docs/type-aliases/WithOptionalSchema.md +13 -0
- package/docs/type-aliases/WithOptionalSources.md +17 -0
- package/docs/type-aliases/WithPartialDataHashStorageMeta.md +13 -0
- package/docs/type-aliases/WithPartialHashStorageMeta.md +13 -0
- package/docs/type-aliases/WithPartialSequenceStorageMeta.md +13 -0
- package/docs/type-aliases/WithPartialStorageMeta.md +13 -0
- package/docs/type-aliases/WithPayload.md +13 -0
- package/docs/type-aliases/WithSchema.md +15 -0
- package/docs/type-aliases/WithSequenceStorageMeta.md +13 -0
- package/docs/type-aliases/WithSources.md +13 -0
- package/docs/type-aliases/WithStorageMeta.md +13 -0
- package/docs/type-aliases/WithTimestamp.md +15 -0
- package/docs/type-aliases/WithoutClientMeta.md +13 -0
- package/docs/type-aliases/WithoutMeta.md +13 -0
- package/docs/type-aliases/WithoutPrivateStorageMeta.md +13 -0
- package/docs/type-aliases/WithoutSchema.md +13 -0
- package/docs/type-aliases/WithoutStorageMeta.md +13 -0
- package/docs/type-aliases/WitnessConfig.md +17 -0
- package/docs/type-aliases/WitnessConfigSchema.md +7 -0
- package/docs/type-aliases/WitnessModuleEventData.md +21 -0
- package/docs/type-aliases/WitnessModuleQueries.md +7 -0
- package/docs/type-aliases/WitnessObserveQuery.md +7 -0
- package/docs/type-aliases/WitnessObserveQuerySchema.md +7 -0
- package/docs/type-aliases/WitnessParams.md +17 -0
- package/docs/type-aliases/WitnessQueries.md +7 -0
- package/docs/type-aliases/WitnessTask.md +7 -0
- package/docs/variables/AddressChildSchema.md +7 -0
- package/docs/variables/AddressPreviousHashSchema.md +7 -0
- package/docs/variables/AddressRegEx.md +7 -0
- package/docs/variables/AddressSchema.md +7 -0
- package/docs/variables/ArchivistAllQuerySchema.md +7 -0
- package/docs/variables/ArchivistClearQuerySchema.md +7 -0
- package/docs/variables/ArchivistCommitQuerySchema.md +7 -0
- package/docs/variables/ArchivistConfigSchema.md +7 -0
- package/docs/variables/ArchivistDeleteQuerySchema.md +7 -0
- package/docs/variables/ArchivistGetQuerySchema.md +7 -0
- package/docs/variables/ArchivistInsertQuerySchema.md +7 -0
- package/docs/variables/ArchivistNextQuerySchema.md +7 -0
- package/docs/variables/BoundWitnessJsonSchema-1.md +107 -0
- package/docs/variables/BoundWitnessSchema.md +7 -0
- package/docs/variables/BridgeConfigSchema.md +7 -0
- package/docs/variables/BridgeConnectQuerySchema.md +7 -0
- package/docs/variables/BridgeDisconnectQuerySchema.md +7 -0
- package/docs/variables/BridgeExposeQuerySchema.md +7 -0
- package/docs/variables/BridgeUnexposeQuerySchema.md +7 -0
- package/docs/variables/ChildCertificationSchema.md +7 -0
- package/docs/variables/DappPackageManifestPayloadSchema.md +7 -0
- package/docs/variables/DisallowedModuleIdentifierCharacters.md +125 -0
- package/docs/variables/DivinerConfigSchema.md +7 -0
- package/docs/variables/DivinerDivineQuerySchema.md +7 -0
- package/docs/variables/GeneratedBoundWitnessFields.md +7 -0
- package/docs/variables/HashRegEx.md +7 -0
- package/docs/variables/HexRegEx.md +7 -0
- package/docs/variables/HexRegExMinMax.md +21 -0
- package/docs/variables/IndexSeparator.md +7 -0
- package/docs/variables/LocalSequenceConstants.md +65 -0
- package/docs/variables/MODULE_PATH_SEPARATOR.md +7 -0
- package/docs/variables/ModuleAddressQuerySchema.md +7 -0
- package/docs/variables/ModuleConfigSchema.md +7 -0
- package/docs/variables/ModuleDescriptionSchema.md +7 -0
- package/docs/variables/ModuleErrorSchema.md +7 -0
- package/docs/variables/ModuleFilterPayloadSchema.md +7 -0
- package/docs/variables/ModuleLimitationLabelName.md +7 -0
- package/docs/variables/ModuleLimitationViewLabel.md +13 -0
- package/docs/variables/ModuleManifestPayloadSchema.md +7 -0
- package/docs/variables/ModuleManifestQuerySchema.md +7 -0
- package/docs/variables/ModuleStateQuerySchema.md +7 -0
- package/docs/variables/ModuleStateSchema.md +7 -0
- package/docs/variables/ModuleSubscribeQuerySchema.md +7 -0
- package/docs/variables/NodeAttachQuerySchema.md +7 -0
- package/docs/variables/NodeAttachedQuerySchema.md +7 -0
- package/docs/variables/NodeCertifyQuerySchema.md +7 -0
- package/docs/variables/NodeConfigSchema.md +7 -0
- package/docs/variables/NodeDetachQuerySchema.md +7 -0
- package/docs/variables/NodeManifestPayloadSchema.md +7 -0
- package/docs/variables/NodeRegisteredQuerySchema.md +7 -0
- package/docs/variables/ObjectResolverPriority.md +33 -0
- package/docs/variables/PackageManifestPayloadSchema.md +7 -0
- package/docs/variables/PayloadSchema.md +7 -0
- package/docs/variables/PayloadSetSchema.md +7 -0
- package/docs/variables/QualifiedSequenceConstants.md +21 -0
- package/docs/variables/ReservedModuleIdentifierCharacters.md +7 -0
- package/docs/variables/SchemaRegEx.md +7 -0
- package/docs/variables/SentinelAutomationSchema.md +7 -0
- package/docs/variables/SentinelConfigSchema.md +7 -0
- package/docs/variables/SentinelEventAutomationSchema.md +7 -0
- package/docs/variables/SentinelIntervalAutomationSchema.md +7 -0
- package/docs/variables/SentinelReportQuerySchema.md +7 -0
- package/docs/variables/SequenceComparer.md +17 -0
- package/docs/variables/SequenceComponentLengths.md +29 -0
- package/docs/variables/SequenceComponentMinMax.md +33 -0
- package/docs/variables/SequenceConstants.md +77 -0
- package/docs/variables/SequenceNonceComponentLengths.md +17 -0
- package/docs/variables/SignatureRegEx.md +7 -0
- package/docs/variables/Uint256RegEx.md +7 -0
- package/docs/variables/WasmFeatureDetectors.md +435 -0
- package/docs/variables/WithFactory.md +49 -0
- package/docs/variables/WitnessConfigSchema.md +7 -0
- package/docs/variables/WitnessObserveQuerySchema.md +7 -0
- package/docs/variables/addressesContains.md +27 -0
- package/docs/variables/addressesContainsAll.md +29 -0
- package/docs/variables/addressesContainsAny.md +31 -0
- package/docs/variables/asAddressPayload.md +59 -0
- package/docs/variables/asAnyPayload.md +59 -0
- package/docs/variables/asArchivistInstance.md +59 -0
- package/docs/variables/asArchivistModule.md +59 -0
- package/docs/variables/asAttachableArchivistInstance.md +59 -0
- package/docs/variables/asAttachableBridgeInstance.md +59 -0
- package/docs/variables/asAttachableDivinerInstance.md +59 -0
- package/docs/variables/asAttachableModuleInstance.md +59 -0
- package/docs/variables/asAttachableNodeInstance.md +59 -0
- package/docs/variables/asAttachableSentinelInstance.md +59 -0
- package/docs/variables/asAttachableWitnessInstance.md +59 -0
- package/docs/variables/asBlock.md +17 -0
- package/docs/variables/asBoundWitness.md +23 -0
- package/docs/variables/asBoundWitnessWithStorageMeta.md +23 -0
- package/docs/variables/asBridgeInstance.md +59 -0
- package/docs/variables/asBridgeModule.md +59 -0
- package/docs/variables/asDataHashStorageMeta.md +59 -0
- package/docs/variables/asDivinerInstance.md +59 -0
- package/docs/variables/asDivinerModule.md +59 -0
- package/docs/variables/asHashStorageMeta.md +59 -0
- package/docs/variables/asModule.md +59 -0
- package/docs/variables/asModuleInstance.md +59 -0
- package/docs/variables/asModuleObject.md +59 -0
- package/docs/variables/asModuleState.md +59 -0
- package/docs/variables/asNodeInstance.md +59 -0
- package/docs/variables/asNodeModule.md +59 -0
- package/docs/variables/asOptionalAddressPayload.md +23 -0
- package/docs/variables/asOptionalBoundWitness.md +23 -0
- package/docs/variables/asOptionalBoundWitnessWithStorageMeta.md +23 -0
- package/docs/variables/asOptionalDataHashStorageMeta.md +23 -0
- package/docs/variables/asOptionalHashStorageMeta.md +23 -0
- package/docs/variables/asOptionalSequenceStorageMeta.md +23 -0
- package/docs/variables/asOptionalStorageMeta.md +23 -0
- package/docs/variables/asPayload.md +69 -0
- package/docs/variables/asSchema.md +59 -0
- package/docs/variables/asSentinelInstance.md +59 -0
- package/docs/variables/asSentinelModule.md +59 -0
- package/docs/variables/asSequenceStorageMeta.md +59 -0
- package/docs/variables/asStorageMeta.md +59 -0
- package/docs/variables/asWitnessInstance.md +59 -0
- package/docs/variables/asWitnessModule.md +59 -0
- package/docs/variables/assignCreatableModuleRegistry.md +25 -0
- package/docs/variables/boundWitnessJsonSchema.md +7 -0
- package/docs/variables/boundWitnessProperties.md +7 -0
- package/docs/variables/buildStandardIndexName.md +24 -0
- package/docs/variables/combineWalletPaths.md +21 -0
- package/docs/variables/duplicateModules.md +37 -0
- package/docs/variables/formatWalletPath.md +17 -0
- package/docs/variables/getBoundWitness.md +21 -0
- package/docs/variables/getTypedBoundWitness.md +31 -0
- package/docs/variables/hasAllLabels.md +29 -0
- package/docs/variables/hasBlock.md +17 -0
- package/docs/variables/hasEmptyFields.md +23 -0
- package/docs/variables/hasLabels.md +17 -0
- package/docs/variables/hydrateBoundWitness.md +21 -0
- package/docs/variables/hydrateTypedBoundWitness.md +31 -0
- package/docs/variables/includesReservedModuleIdentifierCharacter.md +17 -0
- package/docs/variables/isAddressModuleFilter.md +17 -0
- package/docs/variables/isAddressObjectFilter.md +23 -0
- package/docs/variables/isAddressPayload.md +19 -0
- package/docs/variables/isAnyPayload.md +17 -0
- package/docs/variables/isArchivistInstance.md +7 -0
- package/docs/variables/isArchivistModule.md +7 -0
- package/docs/variables/isAttachableArchivistInstance.md +7 -0
- package/docs/variables/isAttachableBridgeInstance.md +7 -0
- package/docs/variables/isAttachableDivinerInstance.md +7 -0
- package/docs/variables/isAttachableModuleInstance.md +7 -0
- package/docs/variables/isAttachableNodeInstance.md +7 -0
- package/docs/variables/isAttachableSentinelInstance.md +7 -0
- package/docs/variables/isAttachableWitnessInstance.md +7 -0
- package/docs/variables/isBoundWitness.md +17 -0
- package/docs/variables/isBoundWitnessWithStorageMeta.md +17 -0
- package/docs/variables/isBoundWitnessWrapper.md +27 -0
- package/docs/variables/isBridgeInstance.md +7 -0
- package/docs/variables/isBridgeModule.md +7 -0
- package/docs/variables/isDataHashStorageMeta.md +17 -0
- package/docs/variables/isDivinerInstance.md +7 -0
- package/docs/variables/isDivinerModule.md +7 -0
- package/docs/variables/isEpoch.md +17 -0
- package/docs/variables/isHashStorageMeta.md +17 -0
- package/docs/variables/isLocalSequence.md +17 -0
- package/docs/variables/isModule.md +7 -0
- package/docs/variables/isModuleError.md +17 -0
- package/docs/variables/isModuleIdentifierPart.md +17 -0
- package/docs/variables/isModuleInstance.md +7 -0
- package/docs/variables/isModuleName.md +17 -0
- package/docs/variables/isModuleObject.md +7 -0
- package/docs/variables/isModuleResolver.md +17 -0
- package/docs/variables/isModuleState.md +23 -0
- package/docs/variables/isModuleStateWithSources.md +23 -0
- package/docs/variables/isNameModuleFilter.md +17 -0
- package/docs/variables/isNameObjectFilter.md +23 -0
- package/docs/variables/isNodeInstance.md +7 -0
- package/docs/variables/isNodeModule.md +7 -0
- package/docs/variables/isNonce.md +17 -0
- package/docs/variables/isObjectResolver.md +23 -0
- package/docs/variables/isPackageManifestPayload.md +17 -0
- package/docs/variables/isPayload.md +33 -0
- package/docs/variables/isPayloadOfSchemaTypeWithSources.md +33 -0
- package/docs/variables/isPayloadWrapper.md +17 -0
- package/docs/variables/isPayloadWrapperBase.md +17 -0
- package/docs/variables/isQualifiedSequence.md +17 -0
- package/docs/variables/isQueryBoundWitness.md +17 -0
- package/docs/variables/isQueryBoundWitnessWithStorageMeta.md +17 -0
- package/docs/variables/isQueryModuleFilter.md +17 -0
- package/docs/variables/isQueryObjectFilter.md +23 -0
- package/docs/variables/isSchema.md +17 -0
- package/docs/variables/isSentinelInstance.md +7 -0
- package/docs/variables/isSentinelIntervalAutomation.md +17 -0
- package/docs/variables/isSentinelModule.md +7 -0
- package/docs/variables/isSequence.md +17 -0
- package/docs/variables/isSequenceStorageMeta.md +17 -0
- package/docs/variables/isSerializable.md +21 -0
- package/docs/variables/isSigned.md +17 -0
- package/docs/variables/isStorageMeta.md +17 -0
- package/docs/variables/isUnsigned.md +17 -0
- package/docs/variables/isValidAbsoluteWalletPath.md +17 -0
- package/docs/variables/isValidRelativeWalletPath.md +17 -0
- package/docs/variables/isWitnessInstance.md +7 -0
- package/docs/variables/isWitnessModule.md +7 -0
- package/docs/variables/mixinResolverEventEmitter.md +23 -0
- package/docs/variables/notBoundWitness.md +17 -0
- package/docs/variables/notPayloadOfSchemaType.md +33 -0
- package/docs/variables/omitSchema.md +23 -0
- package/docs/variables/payloadHashesContains.md +29 -0
- package/docs/variables/payloadHashesContainsAll.md +29 -0
- package/docs/variables/payloadHashesContainsAny.md +31 -0
- package/docs/variables/payloadJsonSchema.md +7 -0
- package/docs/variables/payloadPropertiesJsonSchema.md +7 -0
- package/docs/variables/payloadSchemasContains.md +29 -0
- package/docs/variables/payloadSchemasContainsAll.md +29 -0
- package/docs/variables/payloadSchemasContainsAny.md +31 -0
- package/docs/variables/registerCreatableModuleFactories.md +25 -0
- package/docs/variables/registerCreatableModuleFactory.md +35 -0
- package/docs/variables/removeEmptyFields.md +23 -0
- package/docs/variables/requiredAttachableArchivistInstanceFunctions.md +7 -0
- package/docs/variables/requiredAttachableBridgeInstanceFunctions.md +7 -0
- package/docs/variables/requiredAttachableDivinerInstanceFunctions.md +7 -0
- package/docs/variables/requiredAttachableModuleInstanceFunctions.md +7 -0
- package/docs/variables/requiredAttachableNodeInstanceFunctions.md +7 -0
- package/docs/variables/requiredAttachableSentinelInstanceFunctions.md +7 -0
- package/docs/variables/requiredAttachableWitnessInstanceFunctions.md +7 -0
- package/docs/variables/requiredModuleInstanceFunctions.md +7 -0
- package/docs/variables/requiredModuleQueries.md +7 -0
- package/docs/variables/requiredModuleShape.md +7 -0
- package/docs/variables/resolveAddressToInstance.md +33 -0
- package/docs/variables/resolveAddressToInstanceAll.md +29 -0
- package/docs/variables/resolveAddressToInstanceDown.md +29 -0
- package/docs/variables/resolveAddressToInstanceSiblings.md +29 -0
- package/docs/variables/resolveAddressToInstanceUp.md +29 -0
- package/docs/variables/resolveAll.md +25 -0
- package/docs/variables/resolveAllDown.md +29 -0
- package/docs/variables/resolveAllUp.md +25 -0
- package/docs/variables/resolveLocalNameToAddress.md +29 -0
- package/docs/variables/resolveLocalNameToAddressAll.md +25 -0
- package/docs/variables/resolveLocalNameToAddressDown.md +25 -0
- package/docs/variables/resolveLocalNameToAddressUp.md +21 -0
- package/docs/variables/resolveLocalNameToInstance.md +29 -0
- package/docs/variables/resolveLocalNameToInstanceAll.md +25 -0
- package/docs/variables/resolveLocalNameToInstanceDown.md +25 -0
- package/docs/variables/resolveLocalNameToInstanceUp.md +21 -0
- package/docs/variables/resolvePathToAddress.md +29 -0
- package/docs/variables/resolvePathToInstance.md +29 -0
- package/docs/variables/sortFields.md +23 -0
- package/docs/variables/transformModuleIdentifier.md +21 -0
- package/docs/variables/tryGetTypedBoundWitness.md +31 -0
- package/docs/variables/tryHydrateTypedBoundWitness.md +31 -0
- package/docs/variables/withArchivistInstance.md +27 -0
- package/docs/variables/withArchivistModule.md +27 -0
- package/docs/variables/withBridgeInstance.md +27 -0
- package/docs/variables/withBridgeModule.md +27 -0
- package/docs/variables/withDivinerInstance.md +27 -0
- package/docs/variables/withDivinerModule.md +27 -0
- package/docs/variables/withModule.md +27 -0
- package/docs/variables/withModuleInstance.md +27 -0
- package/docs/variables/withNodeInstance.md +27 -0
- package/docs/variables/withNodeModule.md +27 -0
- package/docs/variables/withSentinelInstance.md +27 -0
- package/docs/variables/withSentinelModule.md +27 -0
- package/docs/variables/withWitnessInstance.md +27 -0
- package/docs/variables/withWitnessModule.md +27 -0
- package/package.json +19 -18
- package/scripts/README.template.md +23 -0
- package/scripts/generate-docs-for-package.mjs +71 -0
- package/scripts/readme-gen.mjs +37 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / SignedHydratedBoundWitness
|
|
2
|
+
|
|
3
|
+
# Type Alias: SignedHydratedBoundWitness\<T, P\>
|
|
4
|
+
|
|
5
|
+
> **SignedHydratedBoundWitness**\<`T`, `P`\> = \[`T`, `P`[]\]
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/archivist/packages/model/dist/types/lib/HydratedBoundWitness.d.ts:5
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`SignedBoundWitness`](SignedBoundWitness.md) = [`SignedBoundWitness`](SignedBoundWitness.md)
|
|
14
|
+
|
|
15
|
+
### P
|
|
16
|
+
|
|
17
|
+
`P` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / SignedHydratedBoundWitnessWithStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: SignedHydratedBoundWitnessWithStorageMeta\<T, P\>
|
|
4
|
+
|
|
5
|
+
> **SignedHydratedBoundWitnessWithStorageMeta**\<`T`, `P`\> = \[[`WithStorageMeta`](WithStorageMeta.md)\<`T`\>, [`WithStorageMeta`](WithStorageMeta.md)\<`P`\>[]\]
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/archivist/packages/model/dist/types/lib/HydratedBoundWitness.d.ts:6
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`SignedBoundWitness`](SignedBoundWitness.md) = [`SignedBoundWitness`](SignedBoundWitness.md)
|
|
14
|
+
|
|
15
|
+
### P
|
|
16
|
+
|
|
17
|
+
`P` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / SimpleModuleResolverParams
|
|
2
|
+
|
|
3
|
+
# Type Alias: SimpleModuleResolverParams
|
|
4
|
+
|
|
5
|
+
> **SimpleModuleResolverParams** = [`ModuleResolverParams`](../interfaces/ModuleResolverParams.md) & `object`
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/module/packages/resolver/dist/types/SimpleModuleResolver.d.ts:6
|
|
8
|
+
|
|
9
|
+
## Type declaration
|
|
10
|
+
|
|
11
|
+
### allowNameResolution?
|
|
12
|
+
|
|
13
|
+
> `optional` **allowNameResolution**: `boolean`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / SyncPayloadValidationFunction
|
|
2
|
+
|
|
3
|
+
# Type Alias: SyncPayloadValidationFunction()\<T\>
|
|
4
|
+
|
|
5
|
+
> **SyncPayloadValidationFunction**\<`T`\> = (`payload`) => `boolean`
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadValidationFunction.d.ts:5
|
|
8
|
+
|
|
9
|
+
A function that validates the supplied payload synchronously
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
### T
|
|
14
|
+
|
|
15
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
### payload
|
|
20
|
+
|
|
21
|
+
`T`
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`boolean`
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / Task
|
|
2
|
+
|
|
3
|
+
# Type Alias: Task
|
|
4
|
+
|
|
5
|
+
> **Task** = [`WitnessTask`](WitnessTask.md) \| [`DivinerTask`](DivinerTask.md) \| [`ArchivistTask`](ArchivistTask.md) \| [`ModuleTask`](../interfaces/ModuleTask.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Task.d.ts:14
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / TaskEndEventArgs
|
|
2
|
+
|
|
3
|
+
# Type Alias: TaskEndEventArgs\<T\>
|
|
4
|
+
|
|
5
|
+
> **TaskEndEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `address`: `Address`; `inPayloads?`: [`Payload`](Payload.md)[]; `name?`: `string`; `outPayloads?`: [`Payload`](Payload.md)[]; \}\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/TaskEnd.d.ts:5
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / TaskStartEventArgs
|
|
2
|
+
|
|
3
|
+
# Type Alias: TaskStartEventArgs\<T\>
|
|
4
|
+
|
|
5
|
+
> **TaskStartEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `address`: `Address`; `inPayloads?`: [`Payload`](Payload.md)[]; `name?`: `string`; \}\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/TaskStart.d.ts:5
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / UnexposedEventArgs
|
|
2
|
+
|
|
3
|
+
# Type Alias: UnexposedEventArgs\<T\>
|
|
4
|
+
|
|
5
|
+
> **UnexposedEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `modules`: [`ModuleInstance`](../interfaces/ModuleInstance.md)[]; \}\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/Unexposed.d.ts:3
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / UnsignedBoundWitness
|
|
2
|
+
|
|
3
|
+
# Type Alias: UnsignedBoundWitness\<T\>
|
|
4
|
+
|
|
5
|
+
> **UnsignedBoundWitness**\<`T`\> = [`Payload`](Payload.md)\<`T` *extends* `void` ? [`BoundWitnessFields`](../interfaces/BoundWitnessFields.md) : [`BoundWitnessFields`](../interfaces/BoundWitnessFields.md) & `T`, [`BoundWitnessSchema`](BoundWitnessSchema.md)\> & [`BoundWitnessMeta`](../interfaces/BoundWitnessMeta.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/BoundWitness/BoundWitness.d.ts:35
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject` \| `void` = `void`
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / UnsignedQueryBoundWitness
|
|
2
|
+
|
|
3
|
+
# Type Alias: UnsignedQueryBoundWitness
|
|
4
|
+
|
|
5
|
+
> **UnsignedQueryBoundWitness** = [`BoundWitness`](BoundWitness.md)\<[`QueryBoundWitnessFields`](QueryBoundWitnessFields.md)\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/QueryBoundWitness.d.ts:8
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WasmFeature
|
|
2
|
+
|
|
3
|
+
# Type Alias: WasmFeature
|
|
4
|
+
|
|
5
|
+
> **WasmFeature** = keyof *typeof* [`WasmFeatureDetectors`](../variables/WasmFeatureDetectors.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/core/packages/wasm/dist/types/WasmSupport.d.ts:43
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithAnySchema
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithAnySchema\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithAnySchema**\<`T`\> = [`OverridablePayload`](OverridablePayload.md)\<`T`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:31
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md)
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithBlock
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithBlock
|
|
4
|
+
|
|
5
|
+
> **WithBlock** = [`BoundWitness`](BoundWitness.md) & [`BoundWitnessBlockField`](../interfaces/BoundWitnessBlockField.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/BoundWitness/BoundWitness.d.ts:40
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithDataHashStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithDataHashStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithDataHashStorageMeta**\<`T`\> = `T` & [`DataHashStorageMeta`](../interfaces/DataHashStorageMeta.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/DataHash.d.ts:6
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithHashStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithHashStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithHashStorageMeta**\<`T`\> = `T` & [`HashStorageMeta`](../interfaces/HashStorageMeta.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/Hash.d.ts:7
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithOnlyClientMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithOnlyClientMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithOnlyClientMeta**\<`T`\> = `DeepPickStartsWith`\<`T`, `"$"`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:38
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithOptionalSchema
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithOptionalSchema\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithOptionalSchema**\<`T`\> = [`WithoutSchema`](WithoutSchema.md)\<`T`\> & `Partial`\<`T` & [`SchemaField`](../interfaces/SchemaField.md)\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:37
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject` = `EmptyObject`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithOptionalSources
|
|
2
|
+
|
|
3
|
+
# Type Alias: ~~WithOptionalSources\<T\>~~
|
|
4
|
+
|
|
5
|
+
> **WithOptionalSources**\<`T`\> = `T` & [`SourcesMetaField`](../interfaces/SourcesMetaField.md) \| `T`
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:27
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
14
|
+
|
|
15
|
+
## Deprecated
|
|
16
|
+
|
|
17
|
+
optional $sources are now optional in all Payloads
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithPartialDataHashStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithPartialDataHashStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithPartialDataHashStorageMeta**\<`T`\> = `Partial`\<[`WithDataHashStorageMeta`](WithDataHashStorageMeta.md)\<`T`\>\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/DataHash.d.ts:7
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithPartialHashStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithPartialHashStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithPartialHashStorageMeta**\<`T`\> = `Partial`\<[`WithHashStorageMeta`](WithHashStorageMeta.md)\<`T`\>\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/Hash.d.ts:8
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithPartialSequenceStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithPartialSequenceStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithPartialSequenceStorageMeta**\<`T`\> = `Partial`\<[`WithSequenceStorageMeta`](WithSequenceStorageMeta.md)\<`T`\>\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/Sequence.d.ts:7
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithPartialStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithPartialStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithPartialStorageMeta**\<`T`\> = `T` & `Partial`\<[`StorageMeta`](../interfaces/StorageMeta.md)\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/StorageMeta.d.ts:7
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithPayload
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithPayload\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithPayload**\<`T`\> = `DeepRestrictToStringKeys`\<[`WithSchema`](WithSchema.md)\<`T` *extends* `EmptyObject` ? [`PayloadFields`](../interfaces/PayloadFields.md) & `T` : [`PayloadFields`](../interfaces/PayloadFields.md)\>\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:15
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject` \| `void` = `void`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithSchema
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithSchema\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithSchema**\<`T`\> = `T` *extends* `EmptyObject` ? [`SchemaFields`](../interfaces/SchemaFields.md) & `T` : [`SchemaFields`](../interfaces/SchemaFields.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Schema.d.ts:18
|
|
8
|
+
|
|
9
|
+
Add the Schema Fields to an object
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
### T
|
|
14
|
+
|
|
15
|
+
`T` *extends* `EmptyObject` \| `void` = `void`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithSequenceStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithSequenceStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithSequenceStorageMeta**\<`T`\> = `T` & [`SequenceStorageMeta`](../interfaces/SequenceStorageMeta.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/Sequence.d.ts:6
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithSources
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithSources\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithSources**\<`T`\> = `T` & [`SourcesMetaField`](../interfaces/SourcesMetaField.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:25
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithStorageMeta**\<`T`\> = `T` & [`StorageMeta`](../interfaces/StorageMeta.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/StorageMeta.d.ts:6
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithTimestamp
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithTimestamp\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithTimestamp**\<`T`\> = `T` & [`Timestamp`](../interfaces/Timestamp.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Timestamp.d.ts:7
|
|
8
|
+
|
|
9
|
+
Add a timestamp field to any object
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
### T
|
|
14
|
+
|
|
15
|
+
`T` *extends* `EmptyObject` = `EmptyObject`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithoutClientMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithoutClientMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithoutClientMeta**\<`T`\> = `DeepOmitStartsWith`\<`T`, `"$"`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:32
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithoutMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithoutMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithoutMeta**\<`T`\> = [`WithoutClientMeta`](WithoutClientMeta.md)\<[`WithoutStorageMeta`](WithoutStorageMeta.md)\<`T`\>\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:35
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithoutPrivateStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithoutPrivateStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithoutPrivateStorageMeta**\<`T`\> = `DeepOmitStartsWith`\<`T`, `"__"`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:34
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithoutSchema
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithoutSchema\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithoutSchema**\<`T`\> = `Omit`\<`T`, `"schema"`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:36
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`WithOptionalSchema`](WithOptionalSchema.md)\<[`Payload`](Payload.md)\>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WithoutStorageMeta
|
|
2
|
+
|
|
3
|
+
# Type Alias: WithoutStorageMeta\<T\>
|
|
4
|
+
|
|
5
|
+
> **WithoutStorageMeta**\<`T`\> = `DeepOmitStartsWith`\<`T`, `"_"`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:33
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* `EmptyObject`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessConfig
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessConfig\<TConfig, TSchema\>
|
|
4
|
+
|
|
5
|
+
> **WitnessConfig**\<`TConfig`, `TSchema`\> = [`ModuleConfig`](ModuleConfig.md)\<`WithAdditional`\<\{ `schema`: `TConfig` *extends* [`Payload`](Payload.md) ? `TConfig`\[`"schema"`\] : [`WitnessConfigSchema`](WitnessConfigSchema.md); \}, `TConfig`\>, `TSchema`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/Config.d.ts:6
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### TConfig
|
|
12
|
+
|
|
13
|
+
`TConfig` *extends* `EmptyObject` \| [`Payload`](Payload.md) \| `void` = `void`
|
|
14
|
+
|
|
15
|
+
### TSchema
|
|
16
|
+
|
|
17
|
+
`TSchema` *extends* `string` \| `void` = `void`
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessConfigSchema
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessConfigSchema
|
|
4
|
+
|
|
5
|
+
> **WitnessConfigSchema** = *typeof* [`WitnessConfigSchema`](../variables/WitnessConfigSchema.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/Config.d.ts:4
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessModuleEventData
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessModuleEventData\<T, TIn, TOut\>
|
|
4
|
+
|
|
5
|
+
> **WitnessModuleEventData**\<`T`, `TIn`, `TOut`\> = [`ObserveEndEventData`](../interfaces/ObserveEndEventData.md)\<`T`, `TIn`, `TOut`\> & [`ObserveStartEventData`](../interfaces/ObserveStartEventData.md)\<`T`, `TIn`\> & [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`T`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/EventData.d.ts:4
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### T
|
|
12
|
+
|
|
13
|
+
`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md) = [`ModuleInstance`](../interfaces/ModuleInstance.md)
|
|
14
|
+
|
|
15
|
+
### TIn
|
|
16
|
+
|
|
17
|
+
`TIn` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
18
|
+
|
|
19
|
+
### TOut
|
|
20
|
+
|
|
21
|
+
`TOut` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessModuleQueries
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessModuleQueries
|
|
4
|
+
|
|
5
|
+
> **WitnessModuleQueries** = [`ModuleQueries`](ModuleQueries.md) \| [`WitnessQueries`](WitnessQueries.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/Queries/index.d.ts:5
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessObserveQuery
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessObserveQuery
|
|
4
|
+
|
|
5
|
+
> **WitnessObserveQuery** = [`Query`](Query.md)\<\{ `payloads?`: `string`[]; `schema`: [`WitnessObserveQuerySchema`](WitnessObserveQuerySchema.md); \}\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/Queries/Observe.d.ts:4
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessObserveQuerySchema
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessObserveQuerySchema
|
|
4
|
+
|
|
5
|
+
> **WitnessObserveQuerySchema** = *typeof* [`WitnessObserveQuerySchema`](../variables/WitnessObserveQuerySchema.md)
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/Queries/Observe.d.ts:2
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / WitnessParams
|
|
2
|
+
|
|
3
|
+
# Type Alias: WitnessParams\<TConfig, TAdditionalParams\>
|
|
4
|
+
|
|
5
|
+
> **WitnessParams**\<`TConfig`, `TAdditionalParams`\> = [`ModuleParams`](ModuleParams.md)\<`TConfig`, `TAdditionalParams`\>
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/witness/packages/model/dist/types/Params.d.ts:4
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### TConfig
|
|
12
|
+
|
|
13
|
+
`TConfig` *extends* [`AnyConfigSchema`](AnyConfigSchema.md)\<[`WitnessConfig`](WitnessConfig.md)\> = [`AnyConfigSchema`](AnyConfigSchema.md)\<[`WitnessConfig`](WitnessConfig.md)\>
|
|
14
|
+
|
|
15
|
+
### TAdditionalParams
|
|
16
|
+
|
|
17
|
+
`TAdditionalParams` *extends* `EmptyObject` \| `void` = `void`
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[@xyo-network/sdk-js](../README.md) / AddressPreviousHashSchema
|
|
2
|
+
|
|
3
|
+
# Variable: AddressPreviousHashSchema
|
|
4
|
+
|
|
5
|
+
> `const` **AddressPreviousHashSchema**: `"network.xyo.address.hash.previous"`
|
|
6
|
+
|
|
7
|
+
Defined in: packages/modules/packages/module/packages/model/dist/types/Payload/AddressPreviousHash.d.ts:3
|