npm - @xyo-network/sentinel-wrapper - Versions diffs - 5.3.30 → 5.4.1 - Mend

@xyo-network/sentinel-wrapper 5.3.30 → 5.4.1

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 -2057
package/package.json +50 -54

package/README.md CHANGED Viewed

@@ -38,2063 +38,6 @@ bun add {{name}}
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-## Reference
-### packages
-  ### modules
-    ### packages
-      ### sentinel
-        ### packages
-          ### wrapper
-            ### .temp-typedoc
-              ### classes
-                ### <a id="SentinelWrapper"></a>SentinelWrapper
-[**@xyo-network/sentinel-wrapper**](#../README)
-***
-## Extends
-- `ModuleWrapper`\<`TModule`\>
-## Type Parameters
-### TModule
-`TModule` *extends* `SentinelModule` = `SentinelModule`
-## Implements
-- `SentinelInstance`\<`TModule`\[`"params"`\]\>
-## Constructors
-### Constructor
-```ts
-new SentinelWrapper<TModule>(params): SentinelWrapper<TModule>;
-```
-### Parameters
-#### params
-`ModuleWrapperParams`\<`TModule`\>
-### Returns
-`SentinelWrapper`\<`TModule`\>
-### Inherited from
-```ts
-ModuleWrapper<TModule>.constructor
-```
-## Properties
-### eventData
-```ts
-eventData: TModule["eventData"];
-```
-The event data type associated with this instance.
-### Implementation of
-```ts
-SentinelInstance.eventData
-```
-### Inherited from
-```ts
-ModuleWrapper.eventData
-```
-***
-### cachedCalls
-```ts
-protected readonly cachedCalls: LRUCache<string, Payload[], unknown>;
-```
-### Inherited from
-```ts
-ModuleWrapper.cachedCalls
-```
-***
-### wrapperParams
-```ts
-protected readonly wrapperParams: ModuleWrapperParams<TModule>;
-```
-### Inherited from
-```ts
-ModuleWrapper.wrapperParams
-```
-***
-### instanceIdentityCheck
-```ts
-readonly static instanceIdentityCheck: TypeCheck<SentinelInstance<SentinelParams<AnyConfigSchema<SentinelConfig<void, void>>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig<object, void>>>, ModuleEventData<object>>>>> = isSentinelInstance;
-```
-### Overrides
-```ts
-ModuleWrapper.instanceIdentityCheck
-```
-***
-### moduleIdentityCheck
-```ts
-readonly static moduleIdentityCheck: QueryableModuleTypeCheck<SentinelModule<SentinelParams<AnyConfigSchema<SentinelConfig<void, void>>>, SentinelModuleEventData<QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig<object, void>>>, ModuleEventData<object>>>>> = isSentinelModule;
-```
-### Overrides
-```ts
-ModuleWrapper.moduleIdentityCheck
-```
-***
-### requiredQueries
-```ts
-readonly static requiredQueries: string[];
-```
-### Overrides
-```ts
-ModuleWrapper.requiredQueries
-```
-## Accessors
-### account
-### Get Signature
-```ts
-get account(): AccountInstance;
-```
-#### Returns
-`AccountInstance`
-### Implementation of
-```ts
-SentinelInstance.account
-```
-### Inherited from
-```ts
-ModuleWrapper.account
-```
-***
-### additionalSigners
-### Get Signature
-```ts
-get additionalSigners(): AccountInstance[];
-```
-#### Returns
-`AccountInstance`[]
-### Inherited from
-```ts
-ModuleWrapper.additionalSigners
-```
-***
-### address
-### Get Signature
-```ts
-get address(): Lowercase<string> & object & object;
-```
-#### Returns
-`Lowercase`\<`string`\> & `object` & `object`
-### Implementation of
-```ts
-SentinelInstance.address
-```
-### Inherited from
-```ts
-ModuleWrapper.address
-```
-***
-### config
-### Get Signature
-```ts
-get config(): Exclude<TWrappedModule["params"]["config"], undefined>;
-```
-#### Returns
-`Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
-### Implementation of
-```ts
-SentinelInstance.config
-```
-### Inherited from
-```ts
-ModuleWrapper.config
-```
-***
-### downResolver
-### Get Signature
-```ts
-get downResolver(): ModuleResolverInstance;
-```
-#### Returns
-`ModuleResolverInstance`
-### Inherited from
-```ts
-ModuleWrapper.downResolver
-```
-***
-### id
-### Get Signature
-```ts
-get id(): string;
-```
-The name (if specified) or address of the module
-#### Returns
-`string`
-### Implementation of
-```ts
-SentinelInstance.id
-```
-### Inherited from
-```ts
-ModuleWrapper.id
-```
-***
-### mod
-### Get Signature
-```ts
-get mod(): TWrappedModule;
-```
-#### Returns
-`TWrappedModule`
-### Inherited from
-```ts
-ModuleWrapper.mod
-```
-***
-### modName
-### Get Signature
-```ts
-get modName(): string | undefined;
-```
-#### Returns
-`string` \| `undefined`
-### Implementation of
-```ts
-SentinelInstance.modName
-```
-### Inherited from
-```ts
-ModuleWrapper.modName
-```
-***
-### name
-### Get Signature
-```ts
-get name(): CreatableName;
-```
-The name identifier for this instance.
-#### Returns
-`CreatableName`
-### Implementation of
-```ts
-SentinelInstance.name
-```
-### Inherited from
-```ts
-ModuleWrapper.name
-```
-***
-### priority
-### Get Signature
-```ts
-get priority(): 1;
-```
-#### Returns
-`1`
-### Implementation of
-```ts
-SentinelInstance.priority
-```
-### Inherited from
-```ts
-ModuleWrapper.priority
-```
-***
-### privateResolver
-### Get Signature
-```ts
-get privateResolver(): ModuleResolverInstance;
-```
-#### Returns
-`ModuleResolverInstance`
-### Inherited from
-```ts
-ModuleWrapper.privateResolver
-```
-***
-### queries
-### Get Signature
-```ts
-get queries(): string[];
-```
-#### Returns
-`string`[]
-### Implementation of
-```ts
-SentinelInstance.queries
-```
-### Inherited from
-```ts
-ModuleWrapper.queries
-```
-***
-### status
-### Get Signature
-```ts
-get status(): ModuleStatus;
-```
-#### Returns
-`ModuleStatus`
-### Set Signature
-```ts
-set status(value): void;
-```
-#### Parameters
-##### value
-`ModuleStatus`
-#### Returns
-`void`
-### Implementation of
-```ts
-SentinelInstance.status
-```
-### Inherited from
-```ts
-ModuleWrapper.status
-```
-***
-### upResolver
-### Get Signature
-```ts
-get upResolver(): ModuleResolverInstance;
-```
-#### Returns
-`ModuleResolverInstance`
-### Inherited from
-```ts
-ModuleWrapper.upResolver
-```
-## Methods
-### canWrap()
-```ts
-static canWrap(mod?): mod is QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig<object, void>>>, ModuleEventData<object>>;
-```
-### Parameters
-#### mod?
-`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-### Returns
-`mod is QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig<object, void>>>, ModuleEventData<object>>`
-### Inherited from
-```ts
-ModuleWrapper.canWrap
-```
-***
-### hasRequiredQueries()
-```ts
-static hasRequiredQueries(mod): boolean;
-```
-### Parameters
-#### mod
-`QueryableModule`
-### Returns
-`boolean`
-### Inherited from
-```ts
-ModuleWrapper.hasRequiredQueries
-```
-***
-### is()
-```ts
-static is<TModuleWrapper>(this, wrapper): wrapper is TModuleWrapper;
-```
-### Type Parameters
-#### TModuleWrapper
-`TModuleWrapper` *extends* `ModuleWrapper`\<`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
-### Parameters
-#### this
-`ConstructableModuleWrapper`\<`TModuleWrapper`\>
-#### wrapper
-`any`
-### Returns
-`wrapper is TModuleWrapper`
-### Inherited from
-```ts
-ModuleWrapper.is
-```
-***
-### missingRequiredQueries()
-```ts
-static missingRequiredQueries(mod): string[];
-```
-### Parameters
-#### mod
-`QueryableModule`
-### Returns
-`string`[]
-### Inherited from
-```ts
-ModuleWrapper.missingRequiredQueries
-```
-***
-### tryWrap()
-```ts
-static tryWrap<TModuleWrapper>(
-   this,
-   mod,
-   account,
-   checkIdentity?): TModuleWrapper | undefined;
-```
-### Type Parameters
-#### TModuleWrapper
-`TModuleWrapper` *extends* `ModuleWrapper`\<`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
-### Parameters
-#### this
-`ConstructableModuleWrapper`\<`TModuleWrapper`\>
-#### mod
-  \| `QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-  \| `undefined`
-#### account
-`AccountInstance`
-#### checkIdentity?
-`boolean`
-### Returns
-`TModuleWrapper` \| `undefined`
-### Inherited from
-```ts
-ModuleWrapper.tryWrap
-```
-***
-### with()
-```ts
-static with<TModuleWrapper, R>(
-   this,
-   mod,
-   closure): R | undefined;
-```
-### Type Parameters
-#### TModuleWrapper
-`TModuleWrapper` *extends* `ModuleWrapper`\<`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
-#### R
-`R` *extends* `Promisable`\<`void`\> = `void`
-### Parameters
-#### this
-`ConstructableModuleWrapper`\<`TModuleWrapper`\>
-#### mod
-`any`
-#### closure
-(`mod`) => `R`
-### Returns
-`R` \| `undefined`
-### Inherited from
-```ts
-ModuleWrapper.with
-```
-***
-### wrap()
-```ts
-static wrap<TModuleWrapper>(
-   this,
-   mod,
-   account,
-   checkIdentity?): TModuleWrapper;
-```
-### Type Parameters
-#### TModuleWrapper
-`TModuleWrapper` *extends* `ModuleWrapper`\<`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
-### Parameters
-#### this
-`ConstructableModuleWrapper`\<`TModuleWrapper`\>
-#### mod
-  \| `QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-  \| `undefined`
-#### account
-`AccountInstance`
-#### checkIdentity?
-`boolean`
-### Returns
-`TModuleWrapper`
-### Inherited from
-```ts
-ModuleWrapper.wrap
-```
-***
-### addParent()
-```ts
-addParent(mod): void;
-```
-### Parameters
-#### mod
-`ModuleInstance`
-### Returns
-`void`
-### Implementation of
-```ts
-SentinelInstance.addParent
-```
-### Inherited from
-```ts
-ModuleWrapper.addParent
-```
-***
-### addressPreviousHash()
-```ts
-addressPreviousHash(): Promise<AddressPreviousHashPayload>;
-```
-### Returns
-`Promise`\<`AddressPreviousHashPayload`\>
-### Inherited from
-```ts
-ModuleWrapper.addressPreviousHash
-```
-***
-### clearListeners()
-```ts
-clearListeners(eventNames): void;
-```
-Removes all listeners for the specified event name(s).
-### Parameters
-#### eventNames
-`Parameters`\<`TModule`\[`"clearListeners"`\]\>\[`0`\]
-### Returns
-`void`
-### Implementation of
-```ts
-SentinelInstance.clearListeners
-```
-### Inherited from
-```ts
-ModuleWrapper.clearListeners
-```
-***
-### emit()
-```ts
-emit(eventName, eventArgs): Promise<void>;
-```
-Emits an event, invoking all registered listeners concurrently.
-### Parameters
-#### eventName
-`Parameters`\<`TModule`\[`"emit"`\]\>\[`0`\]
-#### eventArgs
-`Parameters`\<`TModule`\[`"emit"`\]\>\[`1`\]
-### Returns
-`Promise`\<`void`\>
-### Implementation of
-```ts
-SentinelInstance.emit
-```
-### Inherited from
-```ts
-ModuleWrapper.emit
-```
-***
-### emitSerial()
-```ts
-emitSerial(eventName, eventArgs): Promise<void>;
-```
-Emits an event, invoking all registered listeners sequentially in order.
-### Parameters
-#### eventName
-`Parameters`\<`TModule`\[`"emitSerial"`\]\>\[`0`\]
-#### eventArgs
-`Parameters`\<`TModule`\[`"emitSerial"`\]\>\[`1`\]
-### Returns
-`Promise`\<`void`\>
-### Implementation of
-```ts
-SentinelInstance.emitSerial
-```
-### Inherited from
-```ts
-ModuleWrapper.emitSerial
-```
-***
-### listenerCount()
-```ts
-listenerCount(eventNames): number;
-```
-Returns the total number of listeners registered for the specified event name(s).
-### Parameters
-#### eventNames
-`Parameters`\<`TModule`\[`"listenerCount"`\]\>\[`0`\]
-### Returns
-`number`
-### Implementation of
-```ts
-SentinelInstance.listenerCount
-```
-### Inherited from
-```ts
-ModuleWrapper.listenerCount
-```
-***
-### manifest()
-```ts
-manifest(maxDepth?): Promise<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-### Returns
-`Promise`\<`ModuleManifestPayload`\>
-### Implementation of
-```ts
-SentinelInstance.manifest
-```
-### Inherited from
-```ts
-ModuleWrapper.manifest
-```
-***
-### manifestQuery()
-```ts
-manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
-```
-### Parameters
-#### account
-`AccountInstance`
-#### maxDepth?
-`number`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-### Implementation of
-```ts
-SentinelInstance.manifestQuery
-```
-### Inherited from
-```ts
-ModuleWrapper.manifestQuery
-```
-***
-### moduleAddress()
-```ts
-moduleAddress(): Promise<AddressPreviousHashPayload[]>;
-```
-### Returns
-`Promise`\<`AddressPreviousHashPayload`[]\>
-### Implementation of
-```ts
-SentinelInstance.moduleAddress
-```
-### Inherited from
-```ts
-ModuleWrapper.moduleAddress
-```
-***
-### off()
-```ts
-off<TEventName>(eventNames, listener): void;
-```
-Removes a specific listener from the specified event name(s).
-### Type Parameters
-#### TEventName
-`TEventName` *extends* `string` \| `number` \| `symbol`
-### Parameters
-#### eventNames
-`TEventName`
-#### listener
-`EventListener`\<`TModule`\[`"eventData"`\]\[`TEventName`\]\>
-### Returns
-`void`
-### Implementation of
-```ts
-SentinelInstance.off
-```
-### Inherited from
-```ts
-ModuleWrapper.off
-```
-***
-### offAny()
-```ts
-offAny(listener): void;
-```
-Removes a wildcard listener that was receiving all events.
-### Parameters
-#### listener
-`EventAnyListener`
-### Returns
-`void`
-### Implementation of
-```ts
-SentinelInstance.offAny
-```
-### Inherited from
-```ts
-ModuleWrapper.offAny
-```
-***
-### on()
-```ts
-on<TEventName>(eventNames, listener): EventUnsubscribeFunction;
-```
-Subscribes a listener to the specified event name(s) and returns an unsubscribe function.
-### Type Parameters
-#### TEventName
-`TEventName` *extends* `string` \| `number` \| `symbol`
-### Parameters
-#### eventNames
-`TEventName`
-#### listener
-`EventListener`\<`TModule`\[`"eventData"`\]\[`TEventName`\]\>
-### Returns
-`EventUnsubscribeFunction`
-### Implementation of
-```ts
-SentinelInstance.on
-```
-### Inherited from
-```ts
-ModuleWrapper.on
-```
-***
-### onAny()
-```ts
-onAny(listener): EventUnsubscribeFunction;
-```
-Subscribes a wildcard listener that receives all events and returns an unsubscribe function.
-### Parameters
-#### listener
-`EventAnyListener`
-### Returns
-`EventUnsubscribeFunction`
-### Implementation of
-```ts
-SentinelInstance.onAny
-```
-### Inherited from
-```ts
-ModuleWrapper.onAny
-```
-***
-### once()
-```ts
-once<TEventName>(eventName, listener): EventUnsubscribeFunction;
-```
-Subscribes a listener that will be invoked only once for the specified event, then automatically removed.
-### Type Parameters
-#### TEventName
-`TEventName` *extends* `string` \| `number` \| `symbol`
-### Parameters
-#### eventName
-`TEventName`
-#### listener
-`EventListener`\<`TModule`\[`"eventData"`\]\[`TEventName`\]\>
-### Returns
-`EventUnsubscribeFunction`
-### Implementation of
-```ts
-SentinelInstance.once
-```
-### Inherited from
-```ts
-ModuleWrapper.once
-```
-***
-### parents()
-```ts
-parents(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Implementation of
-```ts
-SentinelInstance.parents
-```
-### Inherited from
-```ts
-ModuleWrapper.parents
-```
-***
-### previousHash()
-```ts
-previousHash(): Promise<string | undefined>;
-```
-### Returns
-`Promise`\<`string` \| `undefined`\>
-### Implementation of
-```ts
-SentinelInstance.previousHash
-```
-### Inherited from
-```ts
-ModuleWrapper.previousHash
-```
-***
-### previousHashQuery()
-```ts
-previousHashQuery(account?): Promise<ModuleQueryResult<AddressPreviousHashPayload>>;
-```
-### Parameters
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`AddressPreviousHashPayload`\>\>
-### Inherited from
-```ts
-ModuleWrapper.previousHashQuery
-```
-***
-### privateChildren()
-```ts
-privateChildren(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Implementation of
-```ts
-SentinelInstance.privateChildren
-```
-### Inherited from
-```ts
-ModuleWrapper.privateChildren
-```
-***
-### publicChildren()
-```ts
-publicChildren(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Implementation of
-```ts
-SentinelInstance.publicChildren
-```
-### Inherited from
-```ts
-ModuleWrapper.publicChildren
-```
-***
-### query()
-```ts
-query<T>(query, payloads?): Promise<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Implementation of
-```ts
-SentinelInstance.query
-```
-### Inherited from
-```ts
-ModuleWrapper.query
-```
-***
-### queryable()
-```ts
-queryable<T>(query, payloads?): Promisable<boolean>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-### Returns
-`Promisable`\<`boolean`\>
-### Implementation of
-```ts
-SentinelInstance.queryable
-```
-### Inherited from
-```ts
-ModuleWrapper.queryable
-```
-***
-### removeParent()
-```ts
-removeParent(address): void;
-```
-### Parameters
-#### address
-`BrandedAddress`
-### Returns
-`void`
-### Implementation of
-```ts
-SentinelInstance.removeParent
-```
-### Inherited from
-```ts
-ModuleWrapper.removeParent
-```
-***
-### ~~resolve()~~
-### Call Signature
-```ts
-resolve<T>(): Promise<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Deprecated
-do not pass undefined.  If trying to get all, pass '*'
-#### Implementation of
-```ts
-SentinelInstance.resolve
-```
-#### Inherited from
-```ts
-ModuleWrapper.resolve
-```
-### Call Signature
-```ts
-resolve<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?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Deprecated
-do not pass undefined.  If trying to get all, pass '*'
-#### Implementation of
-```ts
-SentinelInstance.resolve
-```
-#### Inherited from
-```ts
-ModuleWrapper.resolve
-```
-### Call Signature
-```ts
-resolve<T>(id, options?): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
-#### Deprecated
-do not pass undefined.  If trying to get all, pass '*'
-#### Implementation of
-```ts
-SentinelInstance.resolve
-```
-#### Inherited from
-```ts
-ModuleWrapper.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?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Implementation of
-```ts
-SentinelInstance.resolvePrivate
-```
-#### Inherited from
-```ts
-ModuleWrapper.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?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `undefined`\>
-#### Implementation of
-```ts
-SentinelInstance.resolvePrivate
-```
-#### Inherited from
-```ts
-ModuleWrapper.resolvePrivate
-```
-***
-### siblings()
-```ts
-siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Implementation of
-```ts
-SentinelInstance.siblings
-```
-### Inherited from
-```ts
-ModuleWrapper.siblings
-```
-***
-### start()
-```ts
-start(): Promise<boolean>;
-```
-Starts the instance. Resolves to true if started successfully.
-### Returns
-`Promise`\<`boolean`\>
-### Implementation of
-```ts
-SentinelInstance.start
-```
-### Inherited from
-```ts
-ModuleWrapper.start
-```
-***
-### state()
-```ts
-state(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Implementation of
-```ts
-SentinelInstance.state
-```
-### Inherited from
-```ts
-ModuleWrapper.state
-```
-***
-### stateQuery()
-```ts
-stateQuery(_account): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### \_account
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Implementation of
-```ts
-SentinelInstance.stateQuery
-```
-### Inherited from
-```ts
-ModuleWrapper.stateQuery
-```
-***
-### stop()
-```ts
-stop(): Promise<boolean>;
-```
-Stops the instance. Resolves to true if stopped successfully.
-### Returns
-`Promise`\<`boolean`\>
-### Implementation of
-```ts
-SentinelInstance.stop
-```
-### Inherited from
-```ts
-ModuleWrapper.stop
-```
-***
-### bindQuery()
-```ts
-protected bindQuery<T>(
-   query,
-   payloads?,
-   account?,
-additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], ModuleError[]], AccountInstance>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-#### additionalSigners?
-`AccountInstance`[]
-### Returns
-`PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `ModuleError`[]\], `AccountInstance`\>
-### Inherited from
-```ts
-ModuleWrapper.bindQuery
-```
-***
-### bindQueryInternal()
-```ts
-protected bindQueryInternal<T>(
-   query,
-   payloads?,
-   account?,
-additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], ModuleError[]]>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-#### additionalSigners?
-`AccountInstance`[]
-### Returns
-`Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `ModuleError`[]\]\>
-### Inherited from
-```ts
-ModuleWrapper.bindQueryInternal
-```
-***
-### filterErrors()
-```ts
-protected filterErrors(__namedParameters): ModuleError[];
-```
-### Parameters
-#### \_\_namedParameters
-`ModuleQueryResult`
-### Returns
-`ModuleError`[]
-### Inherited from
-```ts
-ModuleWrapper.filterErrors
-```
-***
-### sendQuery()
-```ts
-protected sendQuery<T, P, R>(queryPayload, payloads?): Promise<R[]>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-#### P
-`P` *extends* `Payload` = `Payload`
-#### R
-`R` *extends* `Payload` = `Payload`
-### Parameters
-#### queryPayload
-`T`
-#### payloads?
-`P`[]
-### Returns
-`Promise`\<`R`[]\>
-### Inherited from
-```ts
-ModuleWrapper.sendQuery
-```
-***
-### sendQueryRaw()
-```ts
-protected sendQueryRaw<T, P, R>(
-   queryPayload,
-   payloads?,
-account?): Promise<ModuleQueryResult<R>>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-#### P
-`P` *extends* `Payload` = `Payload`
-#### R
-`R` *extends* `Payload` = `Payload`
-### Parameters
-#### queryPayload
-`T`
-#### payloads?
-`P`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`R`\>\>
-### Inherited from
-```ts
-ModuleWrapper.sendQueryRaw
-```
-***
-### archivists()
-```ts
-archivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
-```
-### Returns
-`Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
-***
-### report()
-```ts
-report(payloads?): Promise<Payload[]>;
-```
-### Parameters
-#### payloads?
-`Payload`[]
-### Returns
-`Promise`\<`Payload`[]\>
-### Implementation of
-```ts
-SentinelInstance.report
-```
-***
-### reportQuery()
-```ts
-reportQuery(payloads?, account?): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Implementation of
-```ts
-SentinelInstance.reportQuery
-```
-***
-### witnesses()
-```ts
-witnesses(): Promise<WitnessInstance<WitnessParams<AnyConfigSchema<WitnessConfig>>, Payload, Payload, WitnessModuleEventData>[]>;
-```
-### Returns
-`Promise`\<`WitnessInstance`\<`WitnessParams`\<`AnyConfigSchema`\<`WitnessConfig`\>\>, `Payload`, `Payload`, `WitnessModuleEventData`\>[]\>
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png