npm - @xyo-network/witness-model - Versions diffs - 5.3.30 → 5.4.0 - Mend

@xyo-network/witness-model 5.3.30 → 5.4.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 (4) hide show

package/README.md +0 -2512
package/dist/neutral/index.mjs.map +1 -1
package/dist/neutral/typeChecks.d.ts.map +1 -1
package/package.json +12 -16

package/README.md CHANGED Viewed

@@ -38,2518 +38,6 @@ bun add {{name}}
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-## Reference
-### packages
-  ### modules
-    ### packages
-      ### witness
-        ### packages
-          ### model
-            ### .temp-typedoc
-              ### classes
-                ### <a id="IsAttachableWitnessInstanceFactory"></a>IsAttachableWitnessInstanceFactory
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- `IsObjectFactory`\<`T`\>
-## Type Parameters
-### T
-`T` *extends* [`AttachableWitnessInstance`](#../interfaces/AttachableWitnessInstance) = [`AttachableWitnessInstance`](#../interfaces/AttachableWitnessInstance)
-## Constructors
-### Constructor
-```ts
-new IsAttachableWitnessInstanceFactory<T>(): IsAttachableWitnessInstanceFactory<T>;
-```
-### Returns
-`IsAttachableWitnessInstanceFactory`\<`T`\>
-### Inherited from
-```ts
-IsObjectFactory<T>.constructor
-```
-              ### interfaces
-                ### <a id="AttachableWitnessInstance"></a>AttachableWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- [`WitnessInstance`](#WitnessInstance)\<`TParams`, `TIn`, `TOut`, `TEventData`\>.`AttachableModuleInstance`\<`TParams`, `TEventData`\>
-## Type Parameters
-### TParams
-`TParams` *extends* [`WitnessParams`](#WitnessParams) = [`WitnessParams`](#WitnessParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEventData
-`TEventData` *extends* [`WitnessModuleEventData`](#../type-aliases/WitnessModuleEventData) = [`WitnessModuleEventData`](#../type-aliases/WitnessModuleEventData)
-## Properties
-### address
-```ts
-address: BrandedAddress;
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`address`](WitnessInstance.md#address)
-***
-### config
-```ts
-config: TParams["config"];
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`config`](WitnessInstance.md#config)
-***
-### id
-```ts
-id: string;
-```
-The name (if specified) or address of the module
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`id`](WitnessInstance.md#id)
-***
-### modName?
-```ts
-optional modName?: string;
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`modName`](WitnessInstance.md#modname)
-***
-### params
-```ts
-params: TParams;
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`params`](WitnessInstance.md#params)
-***
-### previousHash
-```ts
-previousHash: () => Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`previousHash`](WitnessInstance.md#previoushash)
-***
-### queries
-```ts
-queries: string[];
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`queries`](WitnessInstance.md#queries)
-***
-### query
-```ts
-query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConf
-`TConf` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConf`
-### Returns
-`Promisable`\<`ModuleQueryResult`\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`query`](WitnessInstance.md#query)
-***
-### queryable
-```ts
-queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConf
-`TConf` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConf`
-### Returns
-`Promisable`\<`boolean`\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`queryable`](WitnessInstance.md#queryable)
-***
-### manifest
-```ts
-manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-#### ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promisable`\<`ModuleManifestPayload`\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`manifest`](WitnessInstance.md#manifest)
-***
-### manifestQuery
-```ts
-manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
-```
-### Parameters
-#### account
-`AccountInstance`
-#### maxDepth?
-`number`
-#### ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`manifestQuery`](WitnessInstance.md#manifestquery)
-***
-### moduleAddress
-```ts
-moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
-```
-### Returns
-`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`moduleAddress`](WitnessInstance.md#moduleaddress)
-***
-### state
-```ts
-state: () => Promisable<Payload[]>;
-```
-### Returns
-`Promisable`\<`Payload`[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`state`](WitnessInstance.md#state)
-***
-### stateQuery
-```ts
-stateQuery: (account) => Promisable<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promisable`\<`ModuleQueryResult`\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`stateQuery`](WitnessInstance.md#statequery)
-***
-### account?
-```ts
-optional account?: AccountInstance;
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`account`](WitnessInstance.md#account)
-***
-### addParent
-```ts
-addParent: (mod) => void;
-```
-### Parameters
-#### mod
-`ModuleInstance`
-### Returns
-`void`
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`addParent`](WitnessInstance.md#addparent)
-***
-### addressCache?
-```ts
-optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
-```
-### Parameters
-#### direction
-`Direction`
-#### includePrivate
-`boolean`
-### Returns
-`AddressToWeakInstanceCache` \| `undefined`
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`addressCache`](WitnessInstance.md#addresscache)
-***
-### parents
-```ts
-parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`parents`](WitnessInstance.md#parents)
-***
-### privateChildren
-```ts
-privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`privateChildren`](WitnessInstance.md#privatechildren)
-***
-### publicChildren
-```ts
-publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`publicChildren`](WitnessInstance.md#publicchildren)
-***
-### removeParent
-```ts
-removeParent: (address) => void;
-```
-### Parameters
-#### address
-`BrandedAddress`
-### Returns
-`void`
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`removeParent`](WitnessInstance.md#removeparent)
-***
-### siblings
-```ts
-siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`siblings`](WitnessInstance.md#siblings)
-***
-### pipeline?
-```ts
-readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`pipeline`](WitnessInstance.md#pipeline)
-***
-### status
-```ts
-readonly status: ModuleStatus | null;
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`status`](WitnessInstance.md#status)
-***
-### priority
-```ts
-priority: ObjectResolverPriority;
-```
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`priority`](WitnessInstance.md#priority)
-***
-### downResolver
-```ts
-readonly downResolver: ModuleResolverInstance;
-```
-### Inherited from
-```ts
-AttachableModuleInstance.downResolver
-```
-***
-### privateResolver
-```ts
-readonly privateResolver: ModuleResolverInstance;
-```
-### Inherited from
-```ts
-AttachableModuleInstance.privateResolver
-```
-***
-### upResolver
-```ts
-readonly upResolver: ModuleResolverInstance;
-```
-### Inherited from
-```ts
-AttachableModuleInstance.upResolver
-```
-***
-### observe
-```ts
-observe: (payloads?) => Promisable<WithoutPrivateStorageMeta<TOut>[]>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-### Returns
-`Promisable`\<`WithoutPrivateStorageMeta`\<`TOut`\>[]\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`observe`](WitnessInstance.md#observe)
-***
-### observeQuery
-```ts
-observeQuery: (payloads?, account?) => Promisable<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promisable`\<`ModuleQueryResult`\<`TOut`\>\>
-### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`observeQuery`](WitnessInstance.md#observequery)
-## Methods
-### resolve()
-### Call Signature
-```ts
-resolve<T>(all, options?): Promisable<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### all
-`"*"`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promisable`\<`T`[]\>
-#### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`resolve`](WitnessInstance.md#resolve)
-### Call Signature
-```ts
-resolve<T>(id, options?): Promisable<T | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promisable`\<`T` \| `undefined`\>
-#### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`resolve`](WitnessInstance.md#resolve)
-### Call Signature
-```ts
-resolve<T>(id?, options?): Promisable<T | T[] | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id?
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promisable`\<`T` \| `T`[] \| `undefined`\>
-#### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`resolve`](WitnessInstance.md#resolve)
-***
-### resolvePrivate()
-### Call Signature
-```ts
-resolvePrivate<T>(all, options?): Promise<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### all
-`"*"`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`resolvePrivate`](WitnessInstance.md#resolveprivate)
-### Call Signature
-```ts
-resolvePrivate<T>(id, options?): Promise<T | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `undefined`\>
-#### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`resolvePrivate`](WitnessInstance.md#resolveprivate)
-### Call Signature
-```ts
-resolvePrivate<T>(id, options?): Promise<T | T[] | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `T`[] \| `undefined`\>
-#### Inherited from
-[`WitnessInstance`](#WitnessInstance).[`resolvePrivate`](WitnessInstance.md#resolveprivate)
-                ### <a id="ObserveEndEventData"></a>ObserveEndEventData
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- `EventData`
-## Type Parameters
-### T
-`T` *extends* `ModuleInstance` = `ModuleInstance`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-## Indexable
-```ts
-[key: string | number | symbol]: EventArgs
-```
-## Properties
-### observeEnd
-```ts
-observeEnd: object & object;
-```
-### Type Declaration
-#### mod
-```ts
-mod: T;
-```
-### Type Declaration
-#### errors?
-```ts
-optional errors?: Error[];
-```
-#### inPayloads?
-```ts
-optional inPayloads?: TIn[];
-```
-#### outPayloads?
-```ts
-optional outPayloads?: TOut[];
-```
-                ### <a id="ObserveStartEventData"></a>ObserveStartEventData
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- `EventData`
-## Type Parameters
-### T
-`T` *extends* `ModuleInstance` = `ModuleInstance`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-## Indexable
-```ts
-[key: string | number | symbol]: EventArgs
-```
-## Properties
-### observeStart
-```ts
-observeStart: object & object;
-```
-### Type Declaration
-#### mod
-```ts
-mod: T;
-```
-### Type Declaration
-#### inPayloads?
-```ts
-optional inPayloads?: TIn[];
-```
-                ### <a id="WitnessInstance"></a>WitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- [`WitnessModule`](#WitnessModule)\<`TParams`, `TEvents`\>.[`WitnessQueryFunctions`](#WitnessQueryFunctions)\<`TIn`, `TOut`\>.`ModuleInstance`\<`TParams`, `TEvents`\>
-## Extended by
-- [`AttachableWitnessInstance`](#AttachableWitnessInstance)
-## Type Parameters
-### TParams
-`TParams` *extends* [`WitnessParams`](#WitnessParams) = [`WitnessParams`](#WitnessParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEvents
-`TEvents` *extends* [`WitnessModuleEventData`](#../type-aliases/WitnessModuleEventData) = [`WitnessModuleEventData`](#../type-aliases/WitnessModuleEventData)
-## Properties
-### address
-```ts
-address: BrandedAddress;
-```
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`address`](WitnessModule.md#address)
-***
-### config
-```ts
-config: TParams["config"];
-```
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`config`](WitnessModule.md#config)
-***
-### id
-```ts
-id: string;
-```
-The name (if specified) or address of the module
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`id`](WitnessModule.md#id)
-***
-### modName?
-```ts
-optional modName?: string;
-```
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`modName`](WitnessModule.md#modname)
-***
-### params
-```ts
-params: TParams;
-```
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`params`](WitnessModule.md#params)
-***
-### previousHash
-```ts
-previousHash: () => Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`previousHash`](WitnessModule.md#previoushash)
-***
-### queries
-```ts
-queries: string[];
-```
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`queries`](WitnessModule.md#queries)
-***
-### query
-```ts
-query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConf
-`TConf` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConf`
-### Returns
-`Promisable`\<`ModuleQueryResult`\>
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`query`](WitnessModule.md#query)
-***
-### queryable
-```ts
-queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConf
-`TConf` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConf`
-### Returns
-`Promisable`\<`boolean`\>
-### Inherited from
-[`WitnessModule`](#WitnessModule).[`queryable`](WitnessModule.md#queryable)
-***
-### manifest
-```ts
-manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-#### ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promisable`\<`ModuleManifestPayload`\>
-### Inherited from
-```ts
-ModuleInstance.manifest
-```
-***
-### manifestQuery
-```ts
-manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
-```
-### Parameters
-#### account
-`AccountInstance`
-#### maxDepth?
-`number`
-#### ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-### Inherited from
-```ts
-ModuleInstance.manifestQuery
-```
-***
-### moduleAddress
-```ts
-moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
-```
-### Returns
-`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
-### Inherited from
-```ts
-ModuleInstance.moduleAddress
-```
-***
-### state
-```ts
-state: () => Promisable<Payload[]>;
-```
-### Returns
-`Promisable`\<`Payload`[]\>
-### Inherited from
-```ts
-ModuleInstance.state
-```
-***
-### stateQuery
-```ts
-stateQuery: (account) => Promisable<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promisable`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-ModuleInstance.stateQuery
-```
-***
-### account?
-```ts
-optional account?: AccountInstance;
-```
-### Inherited from
-```ts
-ModuleInstance.account
-```
-***
-### addParent
-```ts
-addParent: (mod) => void;
-```
-### Parameters
-#### mod
-`ModuleInstance`
-### Returns
-`void`
-### Inherited from
-```ts
-ModuleInstance.addParent
-```
-***
-### addressCache?
-```ts
-optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
-```
-### Parameters
-#### direction
-`Direction`
-#### includePrivate
-`boolean`
-### Returns
-`AddressToWeakInstanceCache` \| `undefined`
-### Inherited from
-```ts
-ModuleInstance.addressCache
-```
-***
-### parents
-```ts
-parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-ModuleInstance.parents
-```
-***
-### privateChildren
-```ts
-privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-ModuleInstance.privateChildren
-```
-***
-### publicChildren
-```ts
-publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-ModuleInstance.publicChildren
-```
-***
-### removeParent
-```ts
-removeParent: (address) => void;
-```
-### Parameters
-#### address
-`BrandedAddress`
-### Returns
-`void`
-### Inherited from
-```ts
-ModuleInstance.removeParent
-```
-***
-### siblings
-```ts
-siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-ModuleInstance.siblings
-```
-***
-### pipeline?
-```ts
-readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
-```
-### Inherited from
-```ts
-ModuleInstance.pipeline
-```
-***
-### status
-```ts
-readonly status: ModuleStatus | null;
-```
-### Inherited from
-```ts
-ModuleInstance.status
-```
-***
-### priority
-```ts
-priority: ObjectResolverPriority;
-```
-### Inherited from
-```ts
-ModuleInstance.priority
-```
-***
-### observe
-```ts
-observe: (payloads?) => Promisable<WithoutPrivateStorageMeta<TOut>[]>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-### Returns
-`Promisable`\<`WithoutPrivateStorageMeta`\<`TOut`\>[]\>
-### Inherited from
-[`WitnessQueryFunctions`](#WitnessQueryFunctions).[`observe`](WitnessQueryFunctions.md#observe)
-***
-### observeQuery
-```ts
-observeQuery: (payloads?, account?) => Promisable<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promisable`\<`ModuleQueryResult`\<`TOut`\>\>
-### Inherited from
-[`WitnessQueryFunctions`](#WitnessQueryFunctions).[`observeQuery`](WitnessQueryFunctions.md#observequery)
-## Methods
-### resolve()
-### Call Signature
-```ts
-resolve<T>(all, options?): Promisable<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### all
-`"*"`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promisable`\<`T`[]\>
-#### Inherited from
-```ts
-ModuleInstance.resolve
-```
-### Call Signature
-```ts
-resolve<T>(id, options?): Promisable<T | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promisable`\<`T` \| `undefined`\>
-#### Inherited from
-```ts
-ModuleInstance.resolve
-```
-### Call Signature
-```ts
-resolve<T>(id?, options?): Promisable<T | T[] | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id?
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promisable`\<`T` \| `T`[] \| `undefined`\>
-#### Inherited from
-```ts
-ModuleInstance.resolve
-```
-***
-### resolvePrivate()
-### Call Signature
-```ts
-resolvePrivate<T>(all, options?): Promise<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### all
-`"*"`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-```ts
-ModuleInstance.resolvePrivate
-```
-### Call Signature
-```ts
-resolvePrivate<T>(id, options?): Promise<T | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `undefined`\>
-#### Inherited from
-```ts
-ModuleInstance.resolvePrivate
-```
-### Call Signature
-```ts
-resolvePrivate<T>(id, options?): Promise<T | T[] | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ObjectFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `T`[] \| `undefined`\>
-#### Inherited from
-```ts
-ModuleInstance.resolvePrivate
-```
-                ### <a id="WitnessModule"></a>WitnessModule
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- `QueryableModule`\<`TParams`, `TEvents`\>
-## Extended by
-- [`WitnessInstance`](#WitnessInstance)
-## Type Parameters
-### TParams
-`TParams` *extends* [`WitnessParams`](#WitnessParams) = [`WitnessParams`](#WitnessParams)
-### TEvents
-`TEvents` *extends* [`WitnessModuleEventData`](#../type-aliases/WitnessModuleEventData) = [`WitnessModuleEventData`](#../type-aliases/WitnessModuleEventData)
-## Properties
-### address
-```ts
-address: BrandedAddress;
-```
-### Inherited from
-```ts
-QueryableModule.address
-```
-***
-### config
-```ts
-config: TParams["config"];
-```
-### Inherited from
-```ts
-QueryableModule.config
-```
-***
-### id
-```ts
-id: string;
-```
-The name (if specified) or address of the module
-### Inherited from
-```ts
-QueryableModule.id
-```
-***
-### modName?
-```ts
-optional modName?: string;
-```
-### Inherited from
-```ts
-QueryableModule.modName
-```
-***
-### params
-```ts
-params: TParams;
-```
-### Inherited from
-```ts
-QueryableModule.params
-```
-***
-### previousHash
-```ts
-previousHash: () => Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-```ts
-QueryableModule.previousHash
-```
-***
-### queries
-```ts
-queries: string[];
-```
-### Inherited from
-```ts
-QueryableModule.queries
-```
-***
-### query
-```ts
-query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConf
-`TConf` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConf`
-### Returns
-`Promisable`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-QueryableModule.query
-```
-***
-### queryable
-```ts
-queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConf
-`TConf` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConf`
-### Returns
-`Promisable`\<`boolean`\>
-### Inherited from
-```ts
-QueryableModule.queryable
-```
-                ### <a id="WitnessParams"></a>WitnessParams
-[**@xyo-network/witness-model**](#../README)
-***
-## Extends
-- `QueryableModuleParams`\<`TConfig`\>
-## Type Parameters
-### TConfig
-`TConfig` *extends* `AnyConfigSchema`\<[`WitnessConfig`](#../type-aliases/WitnessConfig)\> = `AnyConfigSchema`\<[`WitnessConfig`](#../type-aliases/WitnessConfig)\>
-## Properties
-### account?
-```ts
-optional account?: AccountInstance | "random";
-```
-### Inherited from
-```ts
-QueryableModuleParams.account
-```
-***
-### addToResolvers?
-```ts
-optional addToResolvers?: boolean;
-```
-### Inherited from
-```ts
-QueryableModuleParams.addToResolvers
-```
-***
-### additionalSigners?
-```ts
-optional additionalSigners?: AccountInstance[];
-```
-### Inherited from
-```ts
-QueryableModuleParams.additionalSigners
-```
-***
-### allowNameResolution?
-```ts
-optional allowNameResolution?: boolean;
-```
-### Inherited from
-```ts
-QueryableModuleParams.allowNameResolution
-```
-***
-### config
-```ts
-config: Partial<TConfig>;
-```
-### Inherited from
-```ts
-QueryableModuleParams.config
-```
-***
-### ephemeralQueryAccountEnabled?
-```ts
-optional ephemeralQueryAccountEnabled?: boolean;
-```
-### Inherited from
-```ts
-QueryableModuleParams.ephemeralQueryAccountEnabled
-```
-***
-### moduleIdentifierTransformers?
-```ts
-optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
-```
-### Inherited from
-```ts
-QueryableModuleParams.moduleIdentifierTransformers
-```
-***
-### statusReporter?
-```ts
-optional statusReporter?: ModuleStatusReporter;
-```
-Optional reporter for broadcasting status changes.
-### Inherited from
-```ts
-QueryableModuleParams.statusReporter
-```
-                ### <a id="WitnessQueryFunctions"></a>WitnessQueryFunctions
-[**@xyo-network/witness-model**](#../README)
-***
-## Extended by
-- [`WitnessInstance`](#WitnessInstance)
-## Type Parameters
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-## Properties
-### observe
-```ts
-observe: (payloads?) => Promisable<WithoutPrivateStorageMeta<TOut>[]>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-### Returns
-`Promisable`\<`WithoutPrivateStorageMeta`\<`TOut`\>[]\>
-***
-### observeQuery
-```ts
-observeQuery: (payloads?, account?) => Promisable<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promisable`\<`ModuleQueryResult`\<`TOut`\>\>
-              ### type-aliases
-                ### <a id="AttachableWitnessInstanceTypeCheck"></a>AttachableWitnessInstanceTypeCheck
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type AttachableWitnessInstanceTypeCheck<T> = TypeCheck<T>;
-```
-## Type Parameters
-### T
-`T` *extends* [`AttachableWitnessInstance`](#../interfaces/AttachableWitnessInstance) = [`AttachableWitnessInstance`](#../interfaces/AttachableWitnessInstance)
-                ### <a id="CustomWitnessInstance"></a>CustomWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type CustomWitnessInstance<TParams, TIn, TOut, TEvents> = CustomWitnessModule<TParams, TIn, TOut, TEvents> & WitnessQueryFunctions<TIn, TOut> & ModuleInstance;
-```
-## Type Parameters
-### TParams
-`TParams` *extends* [`WitnessParams`](#../interfaces/WitnessParams) = [`WitnessParams`](#../interfaces/WitnessParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEvents
-`TEvents` *extends* [`WitnessModuleEventData`](#WitnessModuleEventData)\<[`WitnessInstance`](#../interfaces/WitnessInstance)\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\> = [`WitnessModuleEventData`](#WitnessModuleEventData)\<[`WitnessInstance`](#../interfaces/WitnessInstance)\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\>
-                ### <a id="CustomWitnessModule"></a>CustomWitnessModule
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type CustomWitnessModule<TParams, TIn, TOut, TEvents> = QueryableModule<TParams, TEvents>;
-```
-## Type Parameters
-### TParams
-`TParams` *extends* [`WitnessParams`](#../interfaces/WitnessParams) = [`WitnessParams`](#../interfaces/WitnessParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEvents
-`TEvents` *extends* [`WitnessModuleEventData`](#WitnessModuleEventData)\<[`WitnessInstance`](#../interfaces/WitnessInstance)\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\> = [`WitnessModuleEventData`](#WitnessModuleEventData)\<[`WitnessInstance`](#../interfaces/WitnessInstance)\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\>
-                ### <a id="ObserveEndEventArgs"></a>ObserveEndEventArgs
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type ObserveEndEventArgs<T, TIn, TOut> = ModuleEventArgs<T, {
-  errors?: Error[];
-  inPayloads?: TIn[];
-  outPayloads?: TOut[];
-}>;
-```
-## Type Parameters
-### T
-`T` *extends* `ModuleInstance` = `ModuleInstance`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-                ### <a id="ObserveStartEventArgs"></a>ObserveStartEventArgs
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type ObserveStartEventArgs<T, TIn> = ModuleEventArgs<T, {
-  inPayloads?: TIn[];
-}>;
-```
-## Type Parameters
-### T
-`T` *extends* `ModuleInstance` = `ModuleInstance`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-                ### <a id="WitnessConfig"></a>WitnessConfig
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessConfig<TConfig, TSchema> = ModuleConfig<WithAdditional<{
-  schema: TConfig extends Payload ? TConfig["schema"] : WitnessConfigSchema;
-}, TConfig>, TSchema>;
-```
-## Type Parameters
-### TConfig
-`TConfig` *extends* `EmptyObject` \| `Payload` \| `void` = `void`
-### TSchema
-`TSchema` *extends* `Schema` \| `void` = `void`
-                ### <a id="WitnessConfigSchema"></a>WitnessConfigSchema
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessConfigSchema = typeof WitnessConfigSchema;
-```
-                ### <a id="WitnessModuleEventData"></a>WitnessModuleEventData
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessModuleEventData<T, TIn, TOut> = ObserveEndEventData<T, TIn, TOut> & ObserveStartEventData<T, TIn> & ModuleEventData<T>;
-```
-## Type Parameters
-### T
-`T` *extends* `ModuleInstance` = `ModuleInstance`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-                ### <a id="WitnessModuleQueries"></a>WitnessModuleQueries
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessModuleQueries = ModuleQueries | WitnessQueries;
-```
-                ### <a id="WitnessObserveQuery"></a>WitnessObserveQuery
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessObserveQuery = Query<{
-  payloads?: string[];
-  schema: WitnessObserveQuerySchema;
-}>;
-```
-                ### <a id="WitnessObserveQuerySchema"></a>WitnessObserveQuerySchema
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessObserveQuerySchema = typeof WitnessObserveQuerySchema;
-```
-                ### <a id="WitnessQueries"></a>WitnessQueries
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-type WitnessQueries = WitnessObserveQuery;
-```
-              ### variables
-                ### <a id="WitnessConfigSchema"></a>WitnessConfigSchema
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const WitnessConfigSchema: "network.xyo.witness.config" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="WitnessObserveQuerySchema"></a>WitnessObserveQuerySchema
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const WitnessObserveQuerySchema: "network.xyo.query.witness.observe" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="asAttachableWitnessInstance"></a>asAttachableWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const asAttachableWitnessInstance: AsTypeFunction<AttachableWitnessInstance<WitnessParams<AnyConfigSchema<WitnessConfig>>, Payload, Payload, WitnessModuleEventData>>;
-```
-                ### <a id="asWitnessInstance"></a>asWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const asWitnessInstance: AsTypeFunction<WitnessInstance<WitnessParams<AnyConfigSchema<WitnessConfig>>, Payload, Payload, WitnessModuleEventData>>;
-```
-                ### <a id="asWitnessModule"></a>asWitnessModule
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const asWitnessModule: AsTypeFunction<WitnessModule<WitnessParams<AnyConfigSchema<WitnessConfig>>, WitnessModuleEventData>>;
-```
-                ### <a id="isAttachableWitnessInstance"></a>isAttachableWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const isAttachableWitnessInstance: TypeCheck<AttachableWitnessInstance>;
-```
-                ### <a id="isWitnessInstance"></a>isWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const isWitnessInstance: TypeCheck<WitnessInstance>;
-```
-                ### <a id="isWitnessModule"></a>isWitnessModule
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const isWitnessModule: TypeCheck<WitnessModule>;
-```
-                ### <a id="requiredAttachableWitnessInstanceFunctions"></a>requiredAttachableWitnessInstanceFunctions
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const requiredAttachableWitnessInstanceFunctions: ObjectTypeShape = {};
-```
-                ### <a id="withWitnessInstance"></a>withWitnessInstance
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const withWitnessInstance: <R>(mod, closure) => R | undefined;
-```
-## Type Parameters
-### R
-`R`
-## Parameters
-### mod
-`any`
-### closure
-(`mod`) => `R`
-## Returns
-`R` \| `undefined`
-## Deprecated
-use narrowing instead [ if(is) ]
-                ### <a id="withWitnessModule"></a>withWitnessModule
-[**@xyo-network/witness-model**](#../README)
-***
-```ts
-const withWitnessModule: <R>(mod, closure) => R | undefined;
-```
-## Type Parameters
-### R
-`R`
-## Parameters
-### mod
-`any`
-### closure
-(`mod`) => `R`
-## Returns
-`R` \| `undefined`
-## Deprecated
-use narrowing instead [ if(is) ]
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png