npm - @xyo-network/diviner-models - Versions diffs - 5.3.29 → 5.4.0 - Mend

@xyo-network/diviner-models 5.3.29 → 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 (2) hide show

package/README.md +0 -4493
package/package.json +24 -28

package/README.md CHANGED Viewed

@@ -38,4499 +38,6 @@ bun add {{name}}
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-## Reference
-### packages
-  ### modules
-    ### packages
-      ### diviner
-        ### packages
-          ### models
-            ### .temp-typedoc
-              ### classes
-                ### <a id="IsAttachableDivinerInstanceFactory"></a>IsAttachableDivinerInstanceFactory
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- `IsObjectFactory`\<`T`\>
-## Type Parameters
-### T
-`T` *extends* [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance) = [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance)
-## Constructors
-### Constructor
-```ts
-new IsAttachableDivinerInstanceFactory<T>(): IsAttachableDivinerInstanceFactory<T>;
-```
-### Returns
-`IsAttachableDivinerInstanceFactory`\<`T`\>
-### Inherited from
-```ts
-IsObjectFactory<T>.constructor
-```
-              ### interfaces
-                ### <a id="AttachableDivinerInstance"></a>AttachableDivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- [`DivinerInstance`](#DivinerInstance)\<`TParams`, `TIn`, `TOut`, `TEventData`\>.`AttachableModuleInstance`\<`TParams`, `TEventData`\>
-## Type Parameters
-### TParams
-`TParams` *extends* [`DivinerParams`](#DivinerParams) = [`DivinerParams`](#DivinerParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEventData
-`TEventData` *extends* [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData) = [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData)
-## Properties
-### divine
-```ts
-divine: (payloads?, retry?) => Promise<DivinerDivineResult<TOut>[]>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### retry?
-`RetryConfig`
-### Returns
-`Promise`\<[`DivinerDivineResult`](#../type-aliases/DivinerDivineResult)\<`TOut`\>[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`divine`](DivinerInstance.md#divine)
-***
-### divineQuery
-```ts
-divineQuery: (payloads?, account?, retry?) => Promise<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-#### retry?
-`RetryConfig`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`divineQuery`](DivinerInstance.md#divinequery)
-***
-### address
-```ts
-address: BrandedAddress;
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`address`](DivinerInstance.md#address)
-***
-### config
-```ts
-config: TParams["config"];
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`config`](DivinerInstance.md#config)
-***
-### id
-```ts
-id: string;
-```
-The name (if specified) or address of the module
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`id`](DivinerInstance.md#id)
-***
-### modName?
-```ts
-optional modName?: string;
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`modName`](DivinerInstance.md#modname)
-***
-### params
-```ts
-params: TParams;
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`params`](DivinerInstance.md#params)
-***
-### previousHash
-```ts
-previousHash: () => Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`previousHash`](DivinerInstance.md#previoushash)
-***
-### queries
-```ts
-queries: string[];
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`queries`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`query`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`queryable`](DivinerInstance.md#queryable)
-***
-### manifest
-```ts
-manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-#### ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promisable`\<`ModuleManifestPayload`\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`manifest`](DivinerInstance.md#manifest)
-***
-### manifestQuery
-```ts
-manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
-```
-### Parameters
-#### account
-`AccountInstance`
-#### maxDepth?
-`number`
-#### ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`manifestQuery`](DivinerInstance.md#manifestquery)
-***
-### moduleAddress
-```ts
-moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
-```
-### Returns
-`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`moduleAddress`](DivinerInstance.md#moduleaddress)
-***
-### state
-```ts
-state: () => Promisable<Payload[]>;
-```
-### Returns
-`Promisable`\<`Payload`[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`state`](DivinerInstance.md#state)
-***
-### stateQuery
-```ts
-stateQuery: (account) => Promisable<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promisable`\<`ModuleQueryResult`\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`stateQuery`](DivinerInstance.md#statequery)
-***
-### account?
-```ts
-optional account?: AccountInstance;
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`account`](DivinerInstance.md#account)
-***
-### addParent
-```ts
-addParent: (mod) => void;
-```
-### Parameters
-#### mod
-`ModuleInstance`
-### Returns
-`void`
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`addParent`](DivinerInstance.md#addparent)
-***
-### addressCache?
-```ts
-optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
-```
-### Parameters
-#### direction
-`Direction`
-#### includePrivate
-`boolean`
-### Returns
-`AddressToWeakInstanceCache` \| `undefined`
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`addressCache`](DivinerInstance.md#addresscache)
-***
-### parents
-```ts
-parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`parents`](DivinerInstance.md#parents)
-***
-### privateChildren
-```ts
-privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`privateChildren`](DivinerInstance.md#privatechildren)
-***
-### publicChildren
-```ts
-publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`publicChildren`](DivinerInstance.md#publicchildren)
-***
-### removeParent
-```ts
-removeParent: (address) => void;
-```
-### Parameters
-#### address
-`BrandedAddress`
-### Returns
-`void`
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`removeParent`](DivinerInstance.md#removeparent)
-***
-### siblings
-```ts
-siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`siblings`](DivinerInstance.md#siblings)
-***
-### pipeline?
-```ts
-readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`pipeline`](DivinerInstance.md#pipeline)
-***
-### status
-```ts
-readonly status: ModuleStatus | null;
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`status`](DivinerInstance.md#status)
-***
-### priority
-```ts
-priority: ObjectResolverPriority;
-```
-### Inherited from
-[`DivinerInstance`](#DivinerInstance).[`priority`](DivinerInstance.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
-```
-## 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
-[`DivinerInstance`](#DivinerInstance).[`resolve`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`resolve`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`resolve`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`resolvePrivate`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`resolvePrivate`](DivinerInstance.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
-[`DivinerInstance`](#DivinerInstance).[`resolvePrivate`](DivinerInstance.md#resolveprivate)
-                ### <a id="DivineEndEventData"></a>DivineEndEventData
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- `EventData`
-## Type Parameters
-### T
-`T` *extends* `QueryableModule` = `QueryableModule`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-## Indexable
-```ts
-[key: string | number | symbol]: EventArgs
-```
-## Properties
-### divineEnd
-```ts
-divineEnd: object & object;
-```
-### Type Declaration
-#### mod
-```ts
-mod: T;
-```
-### Type Declaration
-#### errors
-```ts
-errors: Error[];
-```
-#### inPayloads
-```ts
-inPayloads: TIn[];
-```
-#### outPayloads
-```ts
-outPayloads: TOut[];
-```
-                ### <a id="DivineStartEventData"></a>DivineStartEventData
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- `EventData`
-## Type Parameters
-### T
-`T` *extends* `QueryableModule` = `QueryableModule`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-## Indexable
-```ts
-[key: string | number | symbol]: EventArgs
-```
-## Properties
-### divineStart
-```ts
-divineStart: object & object;
-```
-### Type Declaration
-#### mod
-```ts
-mod: T;
-```
-### Type Declaration
-#### inPayloads
-```ts
-inPayloads: TIn[];
-```
-                ### <a id="DivinerInstance"></a>DivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- [`DivinerModule`](#DivinerModule)\<`TParams`, `TEvents`\>.[`DivinerQueryFunctions`](#DivinerQueryFunctions)\<`TIn`, `TOut`\>.`ModuleInstance`\<`TParams`, `TEvents`\>
-## Extended by
-- [`AttachableDivinerInstance`](#AttachableDivinerInstance)
-## Type Parameters
-### TParams
-`TParams` *extends* [`DivinerParams`](#DivinerParams) = [`DivinerParams`](#DivinerParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEvents
-`TEvents` *extends* [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData) = [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData)
-## Properties
-### divine
-```ts
-divine: (payloads?, retry?) => Promise<DivinerDivineResult<TOut>[]>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### retry?
-`RetryConfig`
-### Returns
-`Promise`\<[`DivinerDivineResult`](#../type-aliases/DivinerDivineResult)\<`TOut`\>[]\>
-### Inherited from
-[`DivinerQueryFunctions`](#DivinerQueryFunctions).[`divine`](DivinerQueryFunctions.md#divine)
-***
-### divineQuery
-```ts
-divineQuery: (payloads?, account?, retry?) => Promise<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-#### retry?
-`RetryConfig`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
-### Inherited from
-[`DivinerQueryFunctions`](#DivinerQueryFunctions).[`divineQuery`](DivinerQueryFunctions.md#divinequery)
-***
-### address
-```ts
-address: BrandedAddress;
-```
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`address`](DivinerModule.md#address)
-***
-### config
-```ts
-config: TParams["config"];
-```
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`config`](DivinerModule.md#config)
-***
-### id
-```ts
-id: string;
-```
-The name (if specified) or address of the module
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`id`](DivinerModule.md#id)
-***
-### modName?
-```ts
-optional modName?: string;
-```
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`modName`](DivinerModule.md#modname)
-***
-### params
-```ts
-params: TParams;
-```
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`params`](DivinerModule.md#params)
-***
-### previousHash
-```ts
-previousHash: () => Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`previousHash`](DivinerModule.md#previoushash)
-***
-### queries
-```ts
-queries: string[];
-```
-### Inherited from
-[`DivinerModule`](#DivinerModule).[`queries`](DivinerModule.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
-[`DivinerModule`](#DivinerModule).[`query`](DivinerModule.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
-[`DivinerModule`](#DivinerModule).[`queryable`](DivinerModule.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
-```
-## 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="DivinerModule"></a>DivinerModule
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- `QueryableModule`\<`TParams`, `TEvents`\>
-## Extended by
-- [`DivinerInstance`](#DivinerInstance)
-## Type Parameters
-### TParams
-`TParams` *extends* [`DivinerParams`](#DivinerParams) = [`DivinerParams`](#DivinerParams)
-### TEvents
-`TEvents` *extends* [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData) = [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData)
-## 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="DivinerParams"></a>DivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extends
-- `QueryableModuleParams`\<`TConfig`\>
-## Type Parameters
-### TConfig
-`TConfig` *extends* `AnyConfigSchema`\<[`DivinerConfig`](#../type-aliases/DivinerConfig)\> = `AnyConfigSchema`\<[`DivinerConfig`](#../type-aliases/DivinerConfig)\>
-## 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="DivinerQueryFunctions"></a>DivinerQueryFunctions
-[**@xyo-network/diviner-models**](#../README)
-***
-## Extended by
-- [`DivinerInstance`](#DivinerInstance)
-## Type Parameters
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-## Properties
-### divine
-```ts
-divine: (payloads?, retry?) => Promise<DivinerDivineResult<TOut>[]>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### retry?
-`RetryConfig`
-### Returns
-`Promise`\<[`DivinerDivineResult`](#../type-aliases/DivinerDivineResult)\<`TOut`\>[]\>
-***
-### divineQuery
-```ts
-divineQuery: (payloads?, account?, retry?) => Promise<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-#### retry?
-`RetryConfig`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
-                ### <a id="Forecast"></a>Forecast
-[**@xyo-network/diviner-models**](#../README)
-***
-## Properties
-### error?
-```ts
-optional error?: number;
-```
-***
-### timestamp?
-```ts
-optional timestamp?: number;
-```
-***
-### value
-```ts
-value: number;
-```
-                ### <a id="ForecastingSettings"></a>ForecastingSettings
-[**@xyo-network/diviner-models**](#../README)
-***
-## Properties
-### batchLimit?
-```ts
-optional batchLimit?: number;
-```
-***
-### forecastingMethod?
-```ts
-optional forecastingMethod?: string;
-```
-***
-### forecastingSteps?
-```ts
-optional forecastingSteps?: number;
-```
-***
-### maxTrainingLength?
-```ts
-optional maxTrainingLength?: number;
-```
-***
-### timestamp?
-```ts
-optional timestamp?: number;
-```
-***
-### windowSize?
-```ts
-optional windowSize?: number;
-```
-***
-### witnessAddresses?
-```ts
-optional witnessAddresses?: BrandedAddress[];
-```
-***
-### witnessSchema?
-```ts
-optional witnessSchema?: Schema;
-```
-                ### <a id="ModuleEventSubscription"></a>ModuleEventSubscription
-[**@xyo-network/diviner-models**](#../README)
-***
-## Properties
-### sourceEvent
-```ts
-sourceEvent: string;
-```
-***
-### sourceModule
-```ts
-sourceModule: ModuleIdentifier;
-```
-***
-### targetModuleFunction?
-```ts
-optional targetModuleFunction?: string;
-```
-                ### <a id="SearchableStorage"></a>SearchableStorage
-[**@xyo-network/diviner-models**](#../README)
-***
-Configuration for searchable storage of local state
-## Properties
-### archivist
-```ts
-archivist: ModuleIdentifier;
-```
-Name/Address of the archivist where intermediate communications are stored
-***
-### boundWitnessDiviner?
-```ts
-optional boundWitnessDiviner?: ModuleIdentifier;
-```
-Name/Address of the diviner where intermediate communications are filtered
-***
-### payloadDiviner?
-```ts
-optional payloadDiviner?: ModuleIdentifier;
-```
-Name/Address of the diviner where intermediate communications are filtered
-                ### <a id="TransformerSettings"></a>TransformerSettings
-[**@xyo-network/diviner-models**](#../README)
-***
-## Properties
-### jsonPathExpression?
-```ts
-optional jsonPathExpression?: string;
-```
-              ### type-aliases
-                ### <a id="AddressChainDivinerConfig"></a>AddressChainDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainDivinerConfig = DivinerConfig<{
-  address?: Address;
-  maxResults?: number;
-  schema: AddressChainDivinerConfigSchema;
-  startHash?: Hash;
-}>;
-```
-                ### <a id="AddressChainDivinerConfigSchema"></a>AddressChainDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainDivinerConfigSchema = typeof AddressChainDivinerConfigSchema;
-```
-                ### <a id="AddressChainDivinerParams"></a>AddressChainDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainDivinerParams = DivinerParams<AnyConfigSchema<AddressChainDivinerConfig>>;
-```
-                ### <a id="AddressChainPayload"></a>AddressChainPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainPayload = Payload<{
-  schema: AddressChainSchema;
-}>;
-```
-                ### <a id="AddressChainQueryPayload"></a>AddressChainQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainQueryPayload = Query<object & Omit<PayloadFindFilter, "schema">>;
-```
-                ### <a id="AddressChainQuerySchema"></a>AddressChainQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainQuerySchema = typeof AddressChainQuerySchema;
-```
-                ### <a id="AddressChainSchema"></a>AddressChainSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressChainSchema = typeof AddressChainSchema;
-```
-                ### <a id="AddressHistoryDivinerConfig"></a>AddressHistoryDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistoryDivinerConfig = DivinerConfig<{
-  address?: Address;
-  schema: AddressHistoryDivinerConfigSchema;
-}>;
-```
-                ### <a id="AddressHistoryDivinerConfigSchema"></a>AddressHistoryDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistoryDivinerConfigSchema = typeof AddressHistoryDivinerConfigSchema;
-```
-                ### <a id="AddressHistoryDivinerParams"></a>AddressHistoryDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistoryDivinerParams = DivinerParams<AnyConfigSchema<AddressHistoryDivinerConfig>>;
-```
-                ### <a id="AddressHistoryPayload"></a>AddressHistoryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistoryPayload = Payload<{
-  schema: AddressHistorySchema;
-}>;
-```
-                ### <a id="AddressHistoryQueryPayload"></a>AddressHistoryQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistoryQueryPayload = Query<object & Omit<PayloadFindFilter, "schema">>;
-```
-                ### <a id="AddressHistoryQuerySchema"></a>AddressHistoryQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistoryQuerySchema = typeof AddressHistoryQuerySchema;
-```
-                ### <a id="AddressHistorySchema"></a>AddressHistorySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressHistorySchema = typeof AddressHistorySchema;
-```
-                ### <a id="AddressSpaceBatchDivinerConfig"></a>AddressSpaceBatchDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressSpaceBatchDivinerConfig = DivinerConfig<{
-  address?: string;
-  schema: AddressSpaceBatchDivinerConfigSchema;
-}>;
-```
-                ### <a id="AddressSpaceBatchDivinerConfigSchema"></a>AddressSpaceBatchDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressSpaceBatchDivinerConfigSchema = typeof AddressSpaceBatchDivinerConfigSchema;
-```
-                ### <a id="AddressSpaceDivinerConfig"></a>AddressSpaceDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressSpaceDivinerConfig = DivinerConfig<{
-  address?: string;
-  schema: AddressSpaceDivinerConfigSchema;
-}>;
-```
-                ### <a id="AddressSpaceDivinerConfigSchema"></a>AddressSpaceDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressSpaceDivinerConfigSchema = typeof AddressSpaceDivinerConfigSchema;
-```
-                ### <a id="AddressSpaceDivinerParams"></a>AddressSpaceDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressSpaceDivinerParams = DivinerParams<AnyConfigSchema<AddressSpaceDivinerConfig>>;
-```
-                ### <a id="AddressSpaceSchema"></a>AddressSpaceSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AddressSpaceSchema = typeof AddressSpaceSchema;
-```
-                ### <a id="AttachableDivinerInstanceTypeCheck"></a>AttachableDivinerInstanceTypeCheck
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type AttachableDivinerInstanceTypeCheck<T> = TypeCheck<T>;
-```
-## Type Parameters
-### T
-`T` *extends* [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance) = [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance)
-                ### <a id="BoundWitnessDivinerConfig"></a>BoundWitnessDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerConfig<T> = DivinerConfig<T & object>;
-```
-## Type Parameters
-### T
-`T` *extends* `Payload` = `Payload`
-                ### <a id="BoundWitnessDivinerConfigSchema"></a>BoundWitnessDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerConfigSchema = typeof BoundWitnessDivinerConfigSchema;
-```
-                ### <a id="BoundWitnessDivinerParams"></a>BoundWitnessDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerParams = DivinerParams<AnyConfigSchema<BoundWitnessDivinerConfig>>;
-```
-                ### <a id="BoundWitnessDivinerPredicate"></a>BoundWitnessDivinerPredicate
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerPredicate = WithoutSchemas<PayloadDivinerPredicate & Partial<BoundWitness & BoundWitnessDivinerPredicateFields>>;
-```
-                ### <a id="BoundWitnessDivinerPredicateFields"></a>BoundWitnessDivinerPredicateFields
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerPredicateFields = object;
-```
-## Properties
-### destination
-```ts
-destination: string[];
-```
-***
-### sourceQuery
-```ts
-sourceQuery: string;
-```
-                ### <a id="BoundWitnessDivinerQueryPayload"></a>BoundWitnessDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerQueryPayload = Query<object & BoundWitnessDivinerPredicate>;
-```
-                ### <a id="BoundWitnessDivinerQuerySchema"></a>BoundWitnessDivinerQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerQuerySchema = typeof BoundWitnessDivinerQuerySchema;
-```
-                ### <a id="BoundWitnessDivinerSchema"></a>BoundWitnessDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessDivinerSchema = typeof BoundWitnessDivinerSchema;
-```
-                ### <a id="BoundWitnessStatsDivinerConfig"></a>BoundWitnessStatsDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsDivinerConfig<T> = DivinerConfig<T & object>;
-```
-## Type Parameters
-### T
-`T` *extends* `Payload` = `Payload`
-                ### <a id="BoundWitnessStatsDivinerConfigSchema"></a>BoundWitnessStatsDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsDivinerConfigSchema = typeof BoundWitnessStatsDivinerConfigSchema;
-```
-                ### <a id="BoundWitnessStatsDivinerParams"></a>BoundWitnessStatsDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsDivinerParams = DivinerParams<AnyConfigSchema<BoundWitnessStatsDivinerConfig>>;
-```
-                ### <a id="BoundWitnessStatsDivinerSchema"></a>BoundWitnessStatsDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsDivinerSchema = typeof BoundWitnessStatsDivinerSchema;
-```
-                ### <a id="BoundWitnessStatsPayload"></a>BoundWitnessStatsPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsPayload = Payload<{
-  count: number;
-  schema: BoundWitnessStatsDivinerSchema;
-}>;
-```
-                ### <a id="BoundWitnessStatsQueryPayload"></a>BoundWitnessStatsQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsQueryPayload = Query<{
-  schema: BoundWitnessStatsQuerySchema;
-}>;
-```
-                ### <a id="BoundWitnessStatsQuerySchema"></a>BoundWitnessStatsQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type BoundWitnessStatsQuerySchema = typeof BoundWitnessStatsQuerySchema;
-```
-                ### <a id="DivineEndEventArgs"></a>DivineEndEventArgs
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivineEndEventArgs<T, TIn, TOut> = ModuleEventArgs<T, {
-  errors: Error[];
-  inPayloads: TIn[];
-  outPayloads: TOut[];
-}>;
-```
-## Type Parameters
-### T
-`T` *extends* `QueryableModule` = `QueryableModule`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-                ### <a id="DivineStartEventArgs"></a>DivineStartEventArgs
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivineStartEventArgs<T, TIn> = ModuleEventArgs<T, {
-  inPayloads: TIn[];
-}>;
-```
-## Type Parameters
-### T
-`T` *extends* `QueryableModule` = `QueryableModule`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-                ### <a id="DivinedPayload"></a>DivinedPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinedPayload<T, S> = Payload<WithAdditional<{
-  sources: Hash[];
-}, T>, S>;
-```
-## Type Parameters
-### T
-`T` *extends* `void` \| `EmptyObject` \| `WithSchema` = `void`
-### S
-`S` *extends* `Schema` \| `void` = `void`
-                ### <a id="DivinerConfig"></a>DivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerConfig<TConfig, TSchema> = ModuleConfig<WithAdditional<{
-  eventSubscriptions?: ModuleEventSubscription[];
-}, Omit<TConfig, "schema">>, TSchema extends Schema ? TSchema : TConfig extends Payload ? TConfig["schema"] : DivinerConfigSchema>;
-```
-## Type Parameters
-### TConfig
-`TConfig` *extends* `Payload` \| `EmptyObject` \| `void` = `void`
-### TSchema
-`TSchema` *extends* `Schema` \| `void` = `void`
-                ### <a id="DivinerConfigSchema"></a>DivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerConfigSchema = typeof DivinerConfigSchema;
-```
-                ### <a id="DivinerDivineQuery"></a>DivinerDivineQuery
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerDivineQuery = Query<{
-  schema: DivinerDivineQuerySchema;
-}>;
-```
-                ### <a id="DivinerDivineQuerySchema"></a>DivinerDivineQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerDivineQuerySchema = typeof DivinerDivineQuerySchema;
-```
-                ### <a id="DivinerDivineResult"></a>DivinerDivineResult
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerDivineResult<T> = WithoutPrivateStorageMeta<T>;
-```
-## Type Parameters
-### T
-`T` *extends* `Payload`
-                ### <a id="DivinerModuleEventData"></a>DivinerModuleEventData
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerModuleEventData<TInstance, TIn, TOut> = DivineEndEventData<TInstance, TIn, TOut> & DivineStartEventData<TInstance, TIn> & ModuleEventData<TInstance>;
-```
-## Type Parameters
-### TInstance
-`TInstance` *extends* `ModuleInstance` = `ModuleInstance`
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-                ### <a id="DivinerModuleQueries"></a>DivinerModuleQueries
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerModuleQueries = ModuleQueries | DivinerQueries;
-```
-                ### <a id="DivinerQueries"></a>DivinerQueries
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type DivinerQueries = DivinerDivineQuery;
-```
-                ### <a id="ForecastPayload"></a>ForecastPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastPayload = Payload<{
-  schema: ForecastPayloadSchema;
-  sources: string[];
-  values: Forecast[];
-}>;
-```
-                ### <a id="ForecastPayloadSchema"></a>ForecastPayloadSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastPayloadSchema = typeof ForecastPayloadSchema;
-```
-                ### <a id="ForecastingDivinerConfig"></a>ForecastingDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastingDivinerConfig = DivinerConfig<object & ForecastingSettings & TransformerSettings>;
-```
-                ### <a id="ForecastingDivinerConfigSchema"></a>ForecastingDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastingDivinerConfigSchema = typeof ForecastingDivinerConfigSchema;
-```
-                ### <a id="ForecastingDivinerQueryPayload"></a>ForecastingDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastingDivinerQueryPayload = Query<object & Partial<ForecastingSettings>>;
-```
-                ### <a id="ForecastingDivinerQuerySchema"></a>ForecastingDivinerQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastingDivinerQuerySchema = typeof ForecastingDivinerQuerySchema;
-```
-                ### <a id="ForecastingDivinerSchema"></a>ForecastingDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastingDivinerSchema = typeof ForecastingDivinerSchema;
-```
-                ### <a id="ForecastingMethod"></a>ForecastingMethod
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type ForecastingMethod = (payloads, transformers) => Promisable<Forecast[]>;
-```
-## Parameters
-### payloads
-`Payload`[]
-### transformers
-[`PayloadValueTransformer`](#PayloadValueTransformer)
-## Returns
-`Promisable`\<[`Forecast`](#../interfaces/Forecast)[]\>
-                ### <a id="Order"></a>Order
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type Order = "asc" | "desc";
-```
-                ### <a id="PayloadDivinerConfig"></a>PayloadDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerConfig<TAdditional, TSchema> = DivinerConfig<WithAdditional<{
-  indexBatchSize?: number;
-  maxIndexSize?: number;
-}, TAdditional>, TSchema extends void ? Schema : TSchema>;
-```
-## Type Parameters
-### TAdditional
-`TAdditional` *extends* `EmptyObject` \| `void` = `void`
-### TSchema
-`TSchema` *extends* `Schema` \| `void` = `void`
-                ### <a id="PayloadDivinerConfigSchema"></a>PayloadDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerConfigSchema = typeof PayloadDivinerConfigSchema;
-```
-                ### <a id="PayloadDivinerParams"></a>PayloadDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerParams<T> = DivinerParams<T extends AnyConfigSchema<PayloadDivinerConfig> ? T : AnyConfigSchema<PayloadDivinerConfig>>;
-```
-## Type Parameters
-### T
-`T` *extends*
-  \| `AnyConfigSchema`\<[`PayloadDivinerConfig`](#PayloadDivinerConfig)\>
-  \| `void` = `void`
-                ### <a id="PayloadDivinerPredicate"></a>PayloadDivinerPredicate
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerPredicate<T> = Partial<object & T>;
-```
-## Type Parameters
-### T
-`T` *extends* `EmptyObject` = `EmptyObject`
-                ### <a id="PayloadDivinerQueryPayload"></a>PayloadDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerQueryPayload<T> = Query<object & PayloadDivinerPredicate<T>>;
-```
-## Type Parameters
-### T
-`T` *extends* `EmptyObject` = `EmptyObject`
-                ### <a id="PayloadDivinerQuerySchema"></a>PayloadDivinerQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerQuerySchema = typeof PayloadDivinerQuerySchema;
-```
-                ### <a id="PayloadDivinerSchema"></a>PayloadDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadDivinerSchema = typeof PayloadDivinerSchema;
-```
-                ### <a id="PayloadStatsDivinerConfig"></a>PayloadStatsDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsDivinerConfig<T> = DivinerConfig<T & object>;
-```
-## Type Parameters
-### T
-`T` *extends* `Payload` = `Payload`
-                ### <a id="PayloadStatsDivinerConfigSchema"></a>PayloadStatsDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsDivinerConfigSchema = typeof PayloadStatsDivinerConfigSchema;
-```
-                ### <a id="PayloadStatsDivinerParams"></a>PayloadStatsDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsDivinerParams = DivinerParams<AnyConfigSchema<PayloadStatsDivinerConfig>>;
-```
-                ### <a id="PayloadStatsDivinerSchema"></a>PayloadStatsDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsDivinerSchema = typeof PayloadStatsDivinerSchema;
-```
-                ### <a id="PayloadStatsPayload"></a>PayloadStatsPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsPayload = Payload<{
-  count: number;
-  schema: PayloadStatsDivinerSchema;
-}>;
-```
-                ### <a id="PayloadStatsQueryPayload"></a>PayloadStatsQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsQueryPayload = Query<{
-  schema: PayloadStatsQuerySchema;
-}>;
-```
-                ### <a id="PayloadStatsQuerySchema"></a>PayloadStatsQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadStatsQuerySchema = typeof PayloadStatsQuerySchema;
-```
-                ### <a id="PayloadValueTransformer"></a>PayloadValueTransformer
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type PayloadValueTransformer = (payload) => number;
-```
-## Parameters
-### payload
-`Payload`
-## Returns
-`number`
-                ### <a id="SchemaListDivinerConfig"></a>SchemaListDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListDivinerConfig<T> = DivinerConfig<T & object>;
-```
-## Type Parameters
-### T
-`T` *extends* `Payload` = `Payload`
-                ### <a id="SchemaListDivinerConfigSchema"></a>SchemaListDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListDivinerConfigSchema = typeof SchemaListDivinerConfigSchema;
-```
-                ### <a id="SchemaListDivinerParams"></a>SchemaListDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListDivinerParams = DivinerParams<AnyConfigSchema<SchemaListDivinerConfig>>;
-```
-                ### <a id="SchemaListDivinerSchema"></a>SchemaListDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListDivinerSchema = typeof SchemaListDivinerSchema;
-```
-                ### <a id="SchemaListPayload"></a>SchemaListPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListPayload = Payload<{
-  schema: SchemaListDivinerSchema;
-  schemas: string[];
-}>;
-```
-                ### <a id="SchemaListQueryPayload"></a>SchemaListQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListQueryPayload = Query<{
-  schema: SchemaListQuerySchema;
-}>;
-```
-                ### <a id="SchemaListQuerySchema"></a>SchemaListQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaListQuerySchema = typeof SchemaListQuerySchema;
-```
-                ### <a id="SchemaStatsDivinerConfig"></a>SchemaStatsDivinerConfig
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsDivinerConfig<T> = DivinerConfig<T & object>;
-```
-## Type Parameters
-### T
-`T` *extends* `Payload` = `Payload`
-                ### <a id="SchemaStatsDivinerConfigSchema"></a>SchemaStatsDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsDivinerConfigSchema = typeof SchemaStatsDivinerConfigSchema;
-```
-                ### <a id="SchemaStatsDivinerParams"></a>SchemaStatsDivinerParams
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsDivinerParams = DivinerParams<AnyConfigSchema<SchemaStatsDivinerConfig>>;
-```
-                ### <a id="SchemaStatsDivinerSchema"></a>SchemaStatsDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsDivinerSchema = typeof SchemaStatsDivinerSchema;
-```
-                ### <a id="SchemaStatsPayload"></a>SchemaStatsPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsPayload = Payload<{
-  count: Record<string, number>;
-  name?: string;
-  schema: SchemaStatsDivinerSchema;
-}>;
-```
-                ### <a id="SchemaStatsQueryPayload"></a>SchemaStatsQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsQueryPayload = Query<{
-  schema: SchemaStatsQuerySchema;
-}>;
-```
-                ### <a id="SchemaStatsQuerySchema"></a>SchemaStatsQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SchemaStatsQuerySchema = typeof SchemaStatsQuerySchema;
-```
-                ### <a id="SortDirection"></a>SortDirection
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type SortDirection = "asc" | "desc";
-```
-## Deprecated
-use Order instead
-                ### <a id="WithoutSchemas"></a>WithoutSchemas
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-type WithoutSchemas<T> = Omit<Omit<T, "schema">, "schemas">;
-```
-## Type Parameters
-### T
-`T`
-              ### variables
-                ### <a id="AddressChainDivinerConfigSchema"></a>AddressChainDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressChainDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressChainQuerySchema"></a>AddressChainQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressChainQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressChainSchema"></a>AddressChainSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressChainSchema: "network.xyo.diviner.address.chain" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressHistoryDivinerConfigSchema"></a>AddressHistoryDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressHistoryDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressHistoryQuerySchema"></a>AddressHistoryQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressHistoryQuerySchema: "network.xyo.diviner.address.history.query" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressHistorySchema"></a>AddressHistorySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressHistorySchema: "network.xyo.diviner.address.history" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressSpaceBatchDivinerConfigSchema"></a>AddressSpaceBatchDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressSpaceBatchDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressSpaceDivinerConfigSchema"></a>AddressSpaceDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressSpaceDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="AddressSpaceSchema"></a>AddressSpaceSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const AddressSpaceSchema: "network.xyo.diviner.address.space" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="BoundWitnessDivinerConfigSchema"></a>BoundWitnessDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const BoundWitnessDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="BoundWitnessDivinerQuerySchema"></a>BoundWitnessDivinerQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const BoundWitnessDivinerQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="BoundWitnessDivinerSchema"></a>BoundWitnessDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const BoundWitnessDivinerSchema: "network.xyo.diviner.boundwitness" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="BoundWitnessStatsDivinerConfigSchema"></a>BoundWitnessStatsDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const BoundWitnessStatsDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="BoundWitnessStatsDivinerSchema"></a>BoundWitnessStatsDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const BoundWitnessStatsDivinerSchema: "network.xyo.diviner.boundwitness.stats" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="BoundWitnessStatsQuerySchema"></a>BoundWitnessStatsQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const BoundWitnessStatsQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="DivinerConfigSchema"></a>DivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const DivinerConfigSchema: "network.xyo.diviner.config" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="DivinerDivineQuerySchema"></a>DivinerDivineQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const DivinerDivineQuerySchema: "network.xyo.query.diviner.divine" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="ForecastPayloadSchema"></a>ForecastPayloadSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const ForecastPayloadSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="ForecastingDivinerConfigSchema"></a>ForecastingDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const ForecastingDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="ForecastingDivinerQuerySchema"></a>ForecastingDivinerQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const ForecastingDivinerQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="ForecastingDivinerSchema"></a>ForecastingDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const ForecastingDivinerSchema: "network.xyo.diviner.forecasting" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="PayloadDivinerConfigSchema"></a>PayloadDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const PayloadDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="PayloadDivinerQuerySchema"></a>PayloadDivinerQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const PayloadDivinerQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="PayloadDivinerSchema"></a>PayloadDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const PayloadDivinerSchema: "network.xyo.diviner.payload" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="PayloadStatsDivinerConfigSchema"></a>PayloadStatsDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const PayloadStatsDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="PayloadStatsDivinerSchema"></a>PayloadStatsDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const PayloadStatsDivinerSchema: "network.xyo.diviner.payload.stats" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="PayloadStatsQuerySchema"></a>PayloadStatsQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const PayloadStatsQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="SchemaListDivinerConfigSchema"></a>SchemaListDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const SchemaListDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="SchemaListDivinerSchema"></a>SchemaListDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const SchemaListDivinerSchema: "network.xyo.diviner.schema.list" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="SchemaListQuerySchema"></a>SchemaListQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const SchemaListQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="SchemaStatsDivinerConfigSchema"></a>SchemaStatsDivinerConfigSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const SchemaStatsDivinerConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="SchemaStatsDivinerSchema"></a>SchemaStatsDivinerSchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const SchemaStatsDivinerSchema: "network.xyo.diviner.schema.stats" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="SchemaStatsQuerySchema"></a>SchemaStatsQuerySchema
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const SchemaStatsQuerySchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="asAttachableDivinerInstance"></a>asAttachableDivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const asAttachableDivinerInstance: AsTypeFunction;
-```
-                ### <a id="asDivinerInstance"></a>asDivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const asDivinerInstance: AsTypeFunction;
-```
-                ### <a id="asDivinerModule"></a>asDivinerModule
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const asDivinerModule: AsTypeFunction;
-```
-                ### <a id="asPayloadDivinerQueryPayload"></a>asPayloadDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const asPayloadDivinerQueryPayload: AsTypeFunction;
-```
-                ### <a id="isAddressChainPayload"></a>isAddressChainPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isAddressChainPayload: (x?) => x is AddressChainPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is AddressChainPayload`
-                ### <a id="isAddressChainQueryPayload"></a>isAddressChainQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isAddressChainQueryPayload: (x?) => x is AddressChainQueryPayload;
-```
-## Parameters
-### x?
-`unknown` \| `null`
-## Returns
-`x is AddressChainQueryPayload`
-                ### <a id="isAddressHistoryPayload"></a>isAddressHistoryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isAddressHistoryPayload: (x?) => x is AddressHistoryPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is AddressHistoryPayload`
-                ### <a id="isAddressHistoryQueryPayload"></a>isAddressHistoryQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isAddressHistoryQueryPayload: (x?) => x is AddressHistoryQueryPayload;
-```
-## Parameters
-### x?
-`unknown` \| `null`
-## Returns
-`x is AddressHistoryQueryPayload`
-                ### <a id="isAttachableDivinerInstance"></a>isAttachableDivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isAttachableDivinerInstance: TypeCheck<AttachableDivinerInstance>;
-```
-                ### <a id="isBoundWitnessDivinerQueryPayload"></a>isBoundWitnessDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isBoundWitnessDivinerQueryPayload: (x?) => x is BoundWitnessDivinerQueryPayload;
-```
-## Parameters
-### x?
-`unknown` \| `null`
-## Returns
-`x is BoundWitnessDivinerQueryPayload`
-                ### <a id="isBoundWitnessStatsPayload"></a>isBoundWitnessStatsPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isBoundWitnessStatsPayload: (x?) => x is BoundWitnessStatsPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is BoundWitnessStatsPayload`
-                ### <a id="isBoundWitnessStatsQueryPayload"></a>isBoundWitnessStatsQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isBoundWitnessStatsQueryPayload: (x?) => x is BoundWitnessStatsQueryPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is BoundWitnessStatsQueryPayload`
-                ### <a id="isDivinerInstance"></a>isDivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isDivinerInstance: TypeCheck<DivinerInstance>;
-```
-                ### <a id="isDivinerModule"></a>isDivinerModule
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isDivinerModule: TypeCheck<DivinerModule>;
-```
-                ### <a id="isForecastPayload"></a>isForecastPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isForecastPayload: (x?) => x is ForecastPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is ForecastPayload`
-                ### <a id="isForecastingDivinerQueryPayload"></a>isForecastingDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isForecastingDivinerQueryPayload: (x?) => x is ForecastingDivinerQueryPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is ForecastingDivinerQueryPayload`
-                ### <a id="isPayloadDivinerQueryPayload"></a>isPayloadDivinerQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isPayloadDivinerQueryPayload: (x?) => x is PayloadDivinerQueryPayload<object>;
-```
-## Parameters
-### x?
-`unknown` \| `null`
-## Returns
-`x is PayloadDivinerQueryPayload<object>`
-                ### <a id="isPayloadStatsPayload"></a>isPayloadStatsPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isPayloadStatsPayload: (x?) => x is PayloadStatsPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is PayloadStatsPayload`
-                ### <a id="isPayloadStatsQueryPayload"></a>isPayloadStatsQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isPayloadStatsQueryPayload: (x?) => x is PayloadStatsQueryPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is PayloadStatsQueryPayload`
-                ### <a id="isSchemaListPayload"></a>isSchemaListPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isSchemaListPayload: (x?) => x is SchemaListPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is SchemaListPayload`
-                ### <a id="isSchemaListQueryPayload"></a>isSchemaListQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isSchemaListQueryPayload: (x?) => x is SchemaListQueryPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is SchemaListQueryPayload`
-                ### <a id="isSchemaStatsPayload"></a>isSchemaStatsPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isSchemaStatsPayload: (x?) => x is SchemaStatsPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is SchemaStatsPayload`
-                ### <a id="isSchemaStatsQueryPayload"></a>isSchemaStatsQueryPayload
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const isSchemaStatsQueryPayload: (x?) => x is SchemaStatsQueryPayload;
-```
-## Parameters
-### x?
-`Payload` \| `null`
-## Returns
-`x is SchemaStatsQueryPayload`
-                ### <a id="requiredAttachableDivinerInstanceFunctions"></a>requiredAttachableDivinerInstanceFunctions
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const requiredAttachableDivinerInstanceFunctions: ObjectTypeShape;
-```
-                ### <a id="withDivinerInstance"></a>withDivinerInstance
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const withDivinerInstance: <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="withDivinerModule"></a>withDivinerModule
-[**@xyo-network/diviner-models**](#../README)
-***
-```ts
-const withDivinerModule: <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