@xyo-network/sentinel-model 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,4545 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/sentinel-model
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__sentinel-model)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### sentinel
+
+        ### packages
+
+          ### model
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="IsAttachableSentinelInstanceFactory"></a>IsAttachableSentinelInstanceFactory
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `IsObjectFactory`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableSentinelInstance`](#../interfaces/AttachableSentinelInstance) = [`AttachableSentinelInstance`](#../interfaces/AttachableSentinelInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IsAttachableSentinelInstanceFactory<T>(): IsAttachableSentinelInstanceFactory<T>;
+```
+
+### Returns
+
+`IsAttachableSentinelInstanceFactory`\<`T`\>
+
+### Inherited from
+
+```ts
+IsObjectFactory<T>.constructor
+```
+
+              ### interfaces
+
+                ### <a id="AttachableSentinelInstance"></a>AttachableSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- [`SentinelModule`](#SentinelModule)\<`TParams`, `TEventData`\>.`AttachableModuleInstance`\<`TParams`, `TEventData`\>.[`SentinelInstance`](#SentinelInstance)\<`TParams`, `TEventData`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`SentinelParams`](#SentinelParams) = [`SentinelParams`](#SentinelParams)
+
+### TEventData
+
+`TEventData` *extends* [`SentinelModuleEventData`](#SentinelModuleEventData) = [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`address`](SentinelModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`config`](SentinelModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`id`](SentinelInstance.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`modName`](SentinelInstance.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`params`](SentinelModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`previousHash`](SentinelModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`queries`](SentinelInstance.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
+
+[`SentinelModule`](#SentinelModule).[`query`](SentinelModule.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
+
+[`SentinelModule`](#SentinelModule).[`queryable`](SentinelModule.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`manifest`](SentinelInstance.md#manifest)
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`manifestQuery`](SentinelInstance.md#manifestquery)
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`moduleAddress`](SentinelInstance.md#moduleaddress)
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`state`](SentinelInstance.md#state)
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`stateQuery`](SentinelInstance.md#statequery)
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`account`](SentinelInstance.md#account)
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`addParent`](SentinelInstance.md#addparent)
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`addressCache`](SentinelInstance.md#addresscache)
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`parents`](SentinelInstance.md#parents)
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`privateChildren`](SentinelInstance.md#privatechildren)
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`publicChildren`](SentinelInstance.md#publicchildren)
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`removeParent`](SentinelInstance.md#removeparent)
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`siblings`](SentinelInstance.md#siblings)
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`pipeline`](SentinelInstance.md#pipeline)
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`status`](SentinelInstance.md#status)
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`priority`](SentinelInstance.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
+```
+
+***
+
+### report
+
+```ts
+report: (payloads?) => Promisable<Payload[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`Payload`[]
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`report`](SentinelInstance.md#report)
+
+***
+
+### reportQuery
+
+```ts
+reportQuery: (payloads?, account?) => Promisable<ModuleQueryResult<Payload>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`Payload`[]
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`Payload`\>\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`reportQuery`](SentinelInstance.md#reportquery)
+
+## 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
+
+[`SentinelInstance`](#SentinelInstance).[`resolve`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolve`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolve`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolvePrivate`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolvePrivate`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolvePrivate`](SentinelInstance.md#resolveprivate)
+
+                ### <a id="CustomSentinelInstance"></a>CustomSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- [`CustomSentinelModule`](#CustomSentinelModule)\<`TParams`, `TEvents`\>.[`Sentinel`](#Sentinel).[`SentinelInstance`](#SentinelInstance)\<`TParams`, `TEvents`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`SentinelParams`](#SentinelParams) = [`SentinelParams`](#SentinelParams)
+
+### TEvents
+
+`TEvents` *extends* [`SentinelModuleEventData`](#SentinelModuleEventData)\<[`SentinelInstance`](#SentinelInstance)\<`TParams`\>\> = [`SentinelModuleEventData`](#SentinelModuleEventData)\<[`SentinelInstance`](#SentinelInstance)\<`TParams`\>\>
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`address`](CustomSentinelModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`config`](CustomSentinelModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`id`](CustomSentinelModule.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`modName`](CustomSentinelModule.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`params`](CustomSentinelModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`previousHash`](CustomSentinelModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`queries`](CustomSentinelModule.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
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`query`](CustomSentinelModule.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
+
+[`CustomSentinelModule`](#CustomSentinelModule).[`queryable`](CustomSentinelModule.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`manifest`](SentinelInstance.md#manifest)
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`manifestQuery`](SentinelInstance.md#manifestquery)
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`moduleAddress`](SentinelInstance.md#moduleaddress)
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`state`](SentinelInstance.md#state)
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`stateQuery`](SentinelInstance.md#statequery)
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`account`](SentinelInstance.md#account)
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`addParent`](SentinelInstance.md#addparent)
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`addressCache`](SentinelInstance.md#addresscache)
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`parents`](SentinelInstance.md#parents)
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`privateChildren`](SentinelInstance.md#privatechildren)
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`publicChildren`](SentinelInstance.md#publicchildren)
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`removeParent`](SentinelInstance.md#removeparent)
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`siblings`](SentinelInstance.md#siblings)
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`pipeline`](SentinelInstance.md#pipeline)
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`status`](SentinelInstance.md#status)
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+[`SentinelInstance`](#SentinelInstance).[`priority`](SentinelInstance.md#priority)
+
+***
+
+### report
+
+```ts
+report: (payloads?) => Promisable<Payload[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`Payload`[]
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`Sentinel`](#Sentinel).[`report`](Sentinel.md#report)
+
+***
+
+### reportQuery
+
+```ts
+reportQuery: (payloads?, account?) => Promisable<ModuleQueryResult<Payload>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`Payload`[]
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`Payload`\>\>
+
+### Inherited from
+
+[`Sentinel`](#Sentinel).[`reportQuery`](Sentinel.md#reportquery)
+
+## 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
+
+[`SentinelInstance`](#SentinelInstance).[`resolve`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolve`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolve`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolvePrivate`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolvePrivate`](SentinelInstance.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
+
+[`SentinelInstance`](#SentinelInstance).[`resolvePrivate`](SentinelInstance.md#resolveprivate)
+
+                ### <a id="CustomSentinelModule"></a>CustomSentinelModule
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModule`\<`TParams`, `TEvents`\>
+
+## Extended by
+
+- [`CustomSentinelInstance`](#CustomSentinelInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`SentinelParams`](#SentinelParams) = [`SentinelParams`](#SentinelParams)
+
+### TEvents
+
+`TEvents` *extends* [`SentinelModuleEventData`](#SentinelModuleEventData)\<[`SentinelModule`](#SentinelModule)\<`TParams`\>\> = [`SentinelModuleEventData`](#SentinelModuleEventData)\<[`SentinelModule`](#SentinelModule)\<`TParams`\>\>
+
+## 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="JobEndEventData"></a>JobEndEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### jobEnd
+
+```ts
+jobEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### finalResult?
+
+```ts
+optional finalResult?: Record<BrandedAddress, Payload[]>;
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+                ### <a id="JobStartEventData"></a>JobStartEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### jobStart
+
+```ts
+jobStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+                ### <a id="ModuleTask"></a>ModuleTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Type Parameters
+
+### TEndpoints
+
+`TEndpoints` *extends* `string` = `string`
+
+## Properties
+
+### endPoint?
+
+```ts
+optional endPoint?: TEndpoints;
+```
+
+### Field
+
+the name of the endPoint that is being called.  If not specified, the default endPoint is used
+
+***
+
+### input?
+
+```ts
+optional input?: boolean | ModuleIdentifier | ModuleIdentifier[];
+```
+
+### Field
+
+determines what inputs are sent to each module - if string, that is the output from other module (name/address)
+
+***
+
+### mod
+
+```ts
+mod: ModuleIdentifier;
+```
+
+### Field
+
+the modules that performs the task
+
+***
+
+### required?
+
+```ts
+optional required?: boolean;
+```
+
+                ### <a id="ReportEndEventData"></a>ReportEndEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### reportEnd
+
+```ts
+reportEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### boundwitness?
+
+```ts
+optional boundwitness?: object;
+```
+
+##### boundwitness.schema
+
+```ts
+schema: "network.xyo.boundwitness" & object;
+```
+
+##### Type Declaration
+
+##### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+##### boundwitness.addresses
+
+```ts
+addresses: Lowercase<string> & object & object[];
+```
+
+##### boundwitness.payload\_hashes
+
+```ts
+payload_hashes: BrandedHash[];
+```
+
+##### boundwitness.payload\_schemas
+
+```ts
+payload_schemas: BrandedSchema<string>[];
+```
+
+##### boundwitness.previous\_hashes
+
+```ts
+previous_hashes: (BrandedHash | null)[];
+```
+
+##### boundwitness.$destination?
+
+```ts
+optional $destination?: Lowercase<string> & object & object;
+```
+
+##### Type Declaration
+
+##### \_\_hex
+
+```ts
+readonly __hex: true;
+```
+
+##### Type Declaration
+
+##### \_\_address
+
+```ts
+readonly __address: true;
+```
+
+##### boundwitness.$sourceQuery?
+
+```ts
+optional $sourceQuery?: BrandedHash;
+```
+
+##### boundwitness.$signatures
+
+```ts
+$signatures: (BrandedHex | null)[];
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+#### outPayloads?
+
+```ts
+optional outPayloads?: Payload[];
+```
+
+                ### <a id="ReportStartEventData"></a>ReportStartEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### reportStart
+
+```ts
+reportStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+                ### <a id="Sentinel"></a>Sentinel
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extended by
+
+- [`SentinelInstance`](#SentinelInstance)
+- [`CustomSentinelInstance`](#CustomSentinelInstance)
+
+## Type Parameters
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+## Properties
+
+### report
+
+```ts
+report: (payloads?) => Promisable<TOut[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+### Returns
+
+`Promisable`\<`TOut`[]\>
+
+***
+
+### reportQuery
+
+```ts
+reportQuery: (payloads?, account?) => Promisable<ModuleQueryResult<TOut>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`TOut`\>\>
+
+                ### <a id="SentinelInstance"></a>SentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- [`SentinelModule`](#SentinelModule)\<`TParams`, `TEventData`\>.[`Sentinel`](#Sentinel).`ModuleInstance`\<`TParams`, `TEventData`\>
+
+## Extended by
+
+- [`AttachableSentinelInstance`](#AttachableSentinelInstance)
+- [`CustomSentinelInstance`](#CustomSentinelInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`SentinelParams`](#SentinelParams) = [`SentinelParams`](#SentinelParams)
+
+### TEventData
+
+`TEventData` *extends* [`SentinelModuleEventData`](#SentinelModuleEventData) = [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`address`](SentinelModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`config`](SentinelModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`id`](SentinelModule.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`modName`](SentinelModule.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`params`](SentinelModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`previousHash`](SentinelModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`SentinelModule`](#SentinelModule).[`queries`](SentinelModule.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
+
+[`SentinelModule`](#SentinelModule).[`query`](SentinelModule.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
+
+[`SentinelModule`](#SentinelModule).[`queryable`](SentinelModule.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
+```
+
+***
+
+### report
+
+```ts
+report: (payloads?) => Promisable<Payload[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`Payload`[]
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`Sentinel`](#Sentinel).[`report`](Sentinel.md#report)
+
+***
+
+### reportQuery
+
+```ts
+reportQuery: (payloads?, account?) => Promisable<ModuleQueryResult<Payload>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`Payload`[]
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`Payload`\>\>
+
+### Inherited from
+
+[`Sentinel`](#Sentinel).[`reportQuery`](Sentinel.md#reportquery)
+
+## 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="SentinelJob"></a>SentinelJob
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Properties
+
+### tasks
+
+```ts
+tasks: ResolvedTask[][];
+```
+
+                ### <a id="SentinelModule"></a>SentinelModule
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModule`\<`TParams`, `TEventData`\>
+
+## Extended by
+
+- [`AttachableSentinelInstance`](#AttachableSentinelInstance)
+- [`SentinelInstance`](#SentinelInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`SentinelParams`](#SentinelParams) = [`SentinelParams`](#SentinelParams)
+
+### TEventData
+
+`TEventData` *extends* [`SentinelModuleEventData`](#SentinelModuleEventData) = [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## 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="SentinelModuleEventData"></a>SentinelModuleEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- [`TaskEndEventData`](#TaskEndEventData)\<`T`\>.[`TaskStartEventData`](#TaskStartEventData)\<`T`\>.[`JobEndEventData`](#JobEndEventData)\<`T`\>.[`JobStartEventData`](#JobStartEventData)\<`T`\>.[`ReportEndEventData`](#ReportEndEventData)\<`T`\>.[`ReportStartEventData`](#ReportStartEventData)\<`T`\>.`ModuleEventData`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### moduleBusy
+
+```ts
+moduleBusy: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### busy
+
+```ts
+busy: boolean;
+```
+
+### Inherited from
+
+```ts
+ModuleEventData.moduleBusy
+```
+
+***
+
+### moduleError
+
+```ts
+moduleError: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### error
+
+```ts
+error: Error;
+```
+
+### Inherited from
+
+```ts
+ModuleEventData.moduleError
+```
+
+***
+
+### moduleQueried
+
+```ts
+moduleQueried: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+#### result
+
+```ts
+result: ModuleQueryResult;
+```
+
+### Inherited from
+
+```ts
+ModuleEventData.moduleQueried
+```
+
+***
+
+### jobEnd
+
+```ts
+jobEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### finalResult?
+
+```ts
+optional finalResult?: Record<BrandedAddress, Payload[]>;
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+### Inherited from
+
+[`JobEndEventData`](#JobEndEventData).[`jobEnd`](JobEndEventData.md#jobend)
+
+***
+
+### jobStart
+
+```ts
+jobStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+### Inherited from
+
+[`JobStartEventData`](#JobStartEventData).[`jobStart`](JobStartEventData.md#jobstart)
+
+***
+
+### reportEnd
+
+```ts
+reportEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### boundwitness?
+
+```ts
+optional boundwitness?: object;
+```
+
+##### boundwitness.schema
+
+```ts
+schema: "network.xyo.boundwitness" & object;
+```
+
+##### Type Declaration
+
+##### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+##### boundwitness.addresses
+
+```ts
+addresses: Lowercase<string> & object & object[];
+```
+
+##### boundwitness.payload\_hashes
+
+```ts
+payload_hashes: BrandedHash[];
+```
+
+##### boundwitness.payload\_schemas
+
+```ts
+payload_schemas: BrandedSchema<string>[];
+```
+
+##### boundwitness.previous\_hashes
+
+```ts
+previous_hashes: (BrandedHash | null)[];
+```
+
+##### boundwitness.$destination?
+
+```ts
+optional $destination?: Lowercase<string> & object & object;
+```
+
+##### Type Declaration
+
+##### \_\_hex
+
+```ts
+readonly __hex: true;
+```
+
+##### Type Declaration
+
+##### \_\_address
+
+```ts
+readonly __address: true;
+```
+
+##### boundwitness.$sourceQuery?
+
+```ts
+optional $sourceQuery?: BrandedHash;
+```
+
+##### boundwitness.$signatures
+
+```ts
+$signatures: (BrandedHex | null)[];
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+#### outPayloads?
+
+```ts
+optional outPayloads?: Payload[];
+```
+
+### Inherited from
+
+[`ReportEndEventData`](#ReportEndEventData).[`reportEnd`](ReportEndEventData.md#reportend)
+
+***
+
+### reportStart
+
+```ts
+reportStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+### Inherited from
+
+[`ReportStartEventData`](#ReportStartEventData).[`reportStart`](ReportStartEventData.md#reportstart)
+
+***
+
+### taskEnd
+
+```ts
+taskEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### address
+
+```ts
+address: BrandedAddress;
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+#### name?
+
+```ts
+optional name?: string;
+```
+
+#### outPayloads?
+
+```ts
+optional outPayloads?: Payload[];
+```
+
+### Inherited from
+
+[`TaskEndEventData`](#TaskEndEventData).[`taskEnd`](TaskEndEventData.md#taskend)
+
+***
+
+### taskStart
+
+```ts
+taskStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### address
+
+```ts
+address: BrandedAddress;
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+#### name?
+
+```ts
+optional name?: string;
+```
+
+### Inherited from
+
+[`TaskStartEventData`](#TaskStartEventData).[`taskStart`](TaskStartEventData.md#taskstart)
+
+                ### <a id="SentinelParams"></a>SentinelParams
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModuleParams`\<`TConfig`\>
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `AnyConfigSchema`\<[`SentinelConfig`](#../type-aliases/SentinelConfig)\> = `AnyConfigSchema`\<[`SentinelConfig`](#../type-aliases/SentinelConfig)\>
+
+## 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="TaskEndEventData"></a>TaskEndEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### taskEnd
+
+```ts
+taskEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### address
+
+```ts
+address: BrandedAddress;
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+#### name?
+
+```ts
+optional name?: string;
+```
+
+#### outPayloads?
+
+```ts
+optional outPayloads?: Payload[];
+```
+
+                ### <a id="TaskStartEventData"></a>TaskStartEventData
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`SentinelModuleEventData`](#SentinelModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### taskStart
+
+```ts
+taskStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### address
+
+```ts
+address: BrandedAddress;
+```
+
+#### inPayloads?
+
+```ts
+optional inPayloads?: Payload[];
+```
+
+#### name?
+
+```ts
+optional name?: string;
+```
+
+              ### type-aliases
+
+                ### <a id="ArchivistTask"></a>ArchivistTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ArchivistTask = ModuleTask<"all" | "clear" | "commit" | "delete" | "get" | "insert">;
+```
+
+                ### <a id="AttachableSentinelInstanceTypeCheck"></a>AttachableSentinelInstanceTypeCheck
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type AttachableSentinelInstanceTypeCheck<T> = TypeCheck<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableSentinelInstance`](#../interfaces/AttachableSentinelInstance) = [`AttachableSentinelInstance`](#../interfaces/AttachableSentinelInstance)
+
+                ### <a id="DivinerTask"></a>DivinerTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type DivinerTask = ModuleTask<"divine">;
+```
+
+                ### <a id="JobEndEventArgs"></a>JobEndEventArgs
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type JobEndEventArgs<T> = ModuleEventArgs<T, {
+  finalResult?: Record<Address, Payload[]>;
+  inPayloads?: Payload[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="JobStartEventArgs"></a>JobStartEventArgs
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type JobStartEventArgs<T> = ModuleEventArgs<T, {
+  inPayloads?: Payload[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ReportEndEventArgs"></a>ReportEndEventArgs
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ReportEndEventArgs<T> = ModuleEventArgs<T, {
+  boundwitness?: BoundWitness;
+  inPayloads?: Payload[];
+  outPayloads?: Payload[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ReportStartEventArgs"></a>ReportStartEventArgs
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ReportStartEventArgs<T> = ModuleEventArgs<T, {
+  inPayloads?: Payload[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ResolvedArchivistTask"></a>ResolvedArchivistTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ResolvedArchivistTask = ResolvedModuleTask<ArchivistTask, ArchivistInstance>;
+```
+
+                ### <a id="ResolvedDivinerTask"></a>ResolvedDivinerTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ResolvedDivinerTask = ResolvedModuleTask<DivinerTask, DivinerInstance>;
+```
+
+                ### <a id="ResolvedModuleTask"></a>ResolvedModuleTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ResolvedModuleTask<TTask, TInstance> = Omit<TTask, "mod"> & object;
+```
+
+## Type Declaration
+
+### mod
+
+```ts
+mod: TInstance;
+```
+
+### Field
+
+the modules that performs the task
+
+## Type Parameters
+
+### TTask
+
+`TTask` *extends* [`ModuleTask`](#../interfaces/ModuleTask) = [`ModuleTask`](#../interfaces/ModuleTask)
+
+### TInstance
+
+`TInstance` *extends* `ModuleInstance` = `ModuleInstance`
+
+                ### <a id="ResolvedTask"></a>ResolvedTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ResolvedTask = 
+  | ResolvedArchivistTask
+  | ResolvedDivinerTask
+  | ResolvedWitnessTask
+  | ResolvedModuleTask;
+```
+
+                ### <a id="ResolvedWitnessTask"></a>ResolvedWitnessTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type ResolvedWitnessTask = ResolvedModuleTask<WitnessTask, WitnessInstance>;
+```
+
+                ### <a id="SentinelAutomationPayload"></a>SentinelAutomationPayload
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelAutomationPayload = Payload<
+  | SentinelIntervalAutomationPayload
+  | SentinelModuleEventAutomationPayload, 
+  | SentinelAutomationSchema
+  | SentinelIntervalAutomationSchema
+| SentinelModuleEventAutomationSchema>;
+```
+
+Settings for an Automation
+
+                ### <a id="SentinelAutomationSchema"></a>SentinelAutomationSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelAutomationSchema = typeof SentinelAutomationSchema;
+```
+
+                ### <a id="SentinelBaseAutomationPayload"></a>SentinelBaseAutomationPayload
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelBaseAutomationPayload<T> = Payload<object & T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload`
+
+                ### <a id="SentinelConfig"></a>SentinelConfig
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelConfig<TConfig, TSchema> = ModuleConfig<WithAdditional<{
+  automations?: SentinelAutomationPayload[];
+  schema: TConfig extends Payload ? TConfig["schema"] : SentinelConfigSchema;
+  synchronous?: boolean;
+  tasks: Task[];
+  throwErrors?: boolean;
+}, TConfig>, TSchema>;
+```
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `Payload` \| `void` = `void`
+
+### TSchema
+
+`TSchema` *extends* `Schema` \| `void` = `void`
+
+                ### <a id="SentinelConfigSchema"></a>SentinelConfigSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelConfigSchema = typeof SentinelConfigSchema;
+```
+
+                ### <a id="SentinelIntervalAutomationPayload"></a>SentinelIntervalAutomationPayload
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelIntervalAutomationPayload = SentinelBaseAutomationPayload<{
+  end?: number;
+  frequency?: number;
+  frequencyUnits?: "second" | "minute" | "hour" | "day" | "millis";
+  remaining?: number;
+  schema: SentinelIntervalAutomationSchema;
+  start: number;
+  type: "interval";
+}>;
+```
+
+Settings for an Interval Automation
+
+                ### <a id="SentinelIntervalAutomationSchema"></a>SentinelIntervalAutomationSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelIntervalAutomationSchema = typeof SentinelIntervalAutomationSchema;
+```
+
+                ### <a id="SentinelModuleEventAutomationPayload"></a>SentinelModuleEventAutomationPayload
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelModuleEventAutomationPayload = SentinelBaseAutomationPayload<{
+  eventName: EventName;
+  schema: SentinelModuleEventAutomationSchema;
+  source: ModuleIdentifier;
+  type: "event";
+}>;
+```
+
+Settings for an Module Event Automation
+
+                ### <a id="SentinelModuleEventAutomationSchema"></a>SentinelModuleEventAutomationSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelModuleEventAutomationSchema = typeof SentinelModuleEventAutomationSchema;
+```
+
+                ### <a id="SentinelModuleQueries"></a>SentinelModuleQueries
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelModuleQueries = ModuleQueries | SentinelQueries;
+```
+
+                ### <a id="SentinelQueries"></a>SentinelQueries
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelQueries = SentinelReportQuery;
+```
+
+                ### <a id="SentinelReportQuery"></a>SentinelReportQuery
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelReportQuery = Query<{
+  schema: SentinelReportQuerySchema;
+}>;
+```
+
+                ### <a id="SentinelReportQuerySchema"></a>SentinelReportQuerySchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type SentinelReportQuerySchema = typeof SentinelReportQuerySchema;
+```
+
+                ### <a id="Task"></a>Task
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type Task = 
+  | WitnessTask
+  | DivinerTask
+  | ArchivistTask
+  | ModuleTask;
+```
+
+                ### <a id="TaskEndEventArgs"></a>TaskEndEventArgs
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type TaskEndEventArgs<T> = ModuleEventArgs<T, {
+  address: Address;
+  inPayloads?: Payload[];
+  name?: string;
+  outPayloads?: Payload[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="TaskStartEventArgs"></a>TaskStartEventArgs
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type TaskStartEventArgs<T> = ModuleEventArgs<T, {
+  address: Address;
+  inPayloads?: Payload[];
+  name?: string;
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="WitnessTask"></a>WitnessTask
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+type WitnessTask = ModuleTask<"observe">;
+```
+
+              ### variables
+
+                ### <a id="SentinelAutomationSchema"></a>SentinelAutomationSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const SentinelAutomationSchema: "network.xyo.automation" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="SentinelConfigSchema"></a>SentinelConfigSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const SentinelConfigSchema: "network.xyo.sentinel.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="SentinelIntervalAutomationSchema"></a>SentinelIntervalAutomationSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const SentinelIntervalAutomationSchema: "network.xyo.automation.interval" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="SentinelModuleEventAutomationSchema"></a>SentinelModuleEventAutomationSchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const SentinelModuleEventAutomationSchema: "network.xyo.automation.event.module" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="SentinelReportQuerySchema"></a>SentinelReportQuerySchema
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const SentinelReportQuerySchema: "network.xyo.query.sentinel.report" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="asAttachableSentinelInstance"></a>asAttachableSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const asAttachableSentinelInstance: AsTypeFunction<AttachableSentinelInstance<SentinelParams<AnyConfigSchema<SentinelConfig>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>>>;
+```
+
+                ### <a id="asSentinelInstance"></a>asSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const asSentinelInstance: AsTypeFunction<SentinelInstance<SentinelParams<AnyConfigSchema<SentinelConfig>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>>>;
+```
+
+                ### <a id="asSentinelModule"></a>asSentinelModule
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const asSentinelModule: AsTypeFunction<SentinelModule<SentinelParams<AnyConfigSchema<SentinelConfig>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>>>;
+```
+
+                ### <a id="isAttachableSentinelInstance"></a>isAttachableSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const isAttachableSentinelInstance: TypeCheck<AttachableSentinelInstance>;
+```
+
+                ### <a id="isSentinelInstance"></a>isSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const isSentinelInstance: TypeCheck<SentinelInstance<SentinelParams<AnyConfigSchema<SentinelConfig>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>>>;
+```
+
+                ### <a id="isSentinelIntervalAutomation"></a>isSentinelIntervalAutomation
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const isSentinelIntervalAutomation: (x?) => x is SentinelIntervalAutomationPayload;
+```
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is SentinelIntervalAutomationPayload`
+
+                ### <a id="isSentinelModule"></a>isSentinelModule
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const isSentinelModule: QueryableModuleTypeCheck<SentinelModule<SentinelParams<AnyConfigSchema<SentinelConfig>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>>>;
+```
+
+                ### <a id="requiredAttachableSentinelInstanceFunctions"></a>requiredAttachableSentinelInstanceFunctions
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const requiredAttachableSentinelInstanceFunctions: ObjectTypeShape = {};
+```
+
+                ### <a id="withSentinelInstance"></a>withSentinelInstance
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const withSentinelInstance: <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="withSentinelModule"></a>withSentinelModule
+
+[**@xyo-network/sentinel-model**](#../README)
+
+***
+
+```ts
+const withSentinelModule: <R>(mod, closure) => R | undefined;
+```
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`
+
+## Deprecated
 
-## Credits
+use narrowing instead [ if(is) ]
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sentinel-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/sentinel-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/sentinel-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE