npm - @xyo-network/diviner-stateful - Versions diffs - 5.3.30 → 5.5.0 - Mend

@xyo-network/diviner-stateful 5.3.30 → 5.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +0 -2825
package/package.json +91 -73

package/README.md CHANGED Viewed

@@ -38,2831 +38,6 @@ bun add {{name}}
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-## Reference
-### packages
-  ### modules
-    ### packages
-      ### diviner
-        ### packages
-          ### stateful
-            ### .temp-typedoc
-              ### classes
-                ### <a id="StatefulDiviner"></a>StatefulDiviner
-[**@xyo-network/diviner-stateful**](#../README)
-***
-A Diviner that maintains state
-## Extends
-- `AbstractDiviner`\<`TParams`, `TIn`, `TOut`, `TEventData`\>
-## Type Parameters
-### TParams
-`TParams` *extends* [`StatefulDivinerParams`](#../type-aliases/StatefulDivinerParams) = [`StatefulDivinerParams`](#../type-aliases/StatefulDivinerParams)
-### TIn
-`TIn` *extends* `Payload` = `Payload`
-### TOut
-`TOut` *extends* `Payload` = `Payload`
-### TEventData
-`TEventData` *extends* `DivinerModuleEventData`\<`DivinerInstance`\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\> = `DivinerModuleEventData`\<`DivinerInstance`\<`TParams`, `TIn`, `TOut`\>, `TIn`, `TOut`\>
-### TState
-`TState` *extends* `StateDictionary` = `StateDictionary`
-## Constructors
-### Constructor
-```ts
-new StatefulDiviner<TParams, TIn, TOut, TEventData, TState>(key, params): StatefulDiviner<TParams, TIn, TOut, TEventData, TState>;
-```
-### Parameters
-#### key
-`unknown`
-#### params
-`Partial`\<`TParams` & `RequiredCreatableParams`\>
-### Returns
-`StatefulDiviner`\<`TParams`, `TIn`, `TOut`, `TEventData`, `TState`\>
-### Inherited from
-```ts
-AbstractDiviner<TParams, TIn, TOut, TEventData>.constructor
-```
-## Properties
-### targetSchema
-```ts
-readonly static targetSchema: Schema;
-```
-### Inherited from
-```ts
-AbstractDiviner.targetSchema
-```
-***
-### uniqueName
-```ts
-readonly static uniqueName: string;
-```
-### Inherited from
-```ts
-AbstractDiviner.uniqueName
-```
-***
-### configSchemas
-```ts
-readonly static configSchemas: Schema[];
-```
-### Overrides
-```ts
-AbstractDiviner.configSchemas
-```
-***
-### defaultConfigSchema
-```ts
-readonly static defaultConfigSchema: Schema = StatefulDivinerConfigSchema;
-```
-### Overrides
-```ts
-AbstractDiviner.defaultConfigSchema
-```
-***
-### \_lastState?
-```ts
-protected optional _lastState?: ModuleState<TState>;
-```
-The last state
-***
-### allowRandomAccount
-```ts
-readonly static allowRandomAccount: boolean;
-```
-### Inherited from
-```ts
-AbstractDiviner.allowRandomAccount
-```
-***
-### defaultLogger
-```ts
-static defaultLogger: Logger;
-```
-### Inherited from
-```ts
-AbstractDiviner.defaultLogger
-```
-***
-### enableLazyLoad
-```ts
-static enableLazyLoad: boolean;
-```
-### Inherited from
-```ts
-AbstractDiviner.enableLazyLoad
-```
-***
-### labels
-```ts
-readonly static labels: Labels;
-```
-### Inherited from
-```ts
-AbstractDiviner.labels
-```
-***
-### privateConstructorKey
-```ts
-protected static privateConstructorKey: string;
-```
-### Inherited from
-```ts
-AbstractDiviner.privateConstructorKey
-```
-***
-### \_account
-```ts
-protected _account: AccountInstance | undefined;
-```
-### Inherited from
-```ts
-AbstractDiviner._account
-```
-***
-### \_cachedManifests
-```ts
-protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
-```
-### Inherited from
-```ts
-AbstractDiviner._cachedManifests
-```
-***
-### \_globalReentrancyMutex
-```ts
-protected _globalReentrancyMutex: Mutex | undefined;
-```
-### Inherited from
-```ts
-AbstractDiviner._globalReentrancyMutex
-```
-***
-### \_lastError?
-```ts
-protected optional _lastError?: ModuleDetailsError;
-```
-### Inherited from
-```ts
-AbstractDiviner._lastError
-```
-***
-### \_moduleConfigQueryValidator
-```ts
-protected _moduleConfigQueryValidator: Queryable | undefined;
-```
-### Inherited from
-```ts
-AbstractDiviner._moduleConfigQueryValidator
-```
-***
-### \_supportedQueryValidator
-```ts
-protected _supportedQueryValidator: Queryable | undefined;
-```
-### Inherited from
-```ts
-AbstractDiviner._supportedQueryValidator
-```
-***
-### useNewResolver
-```ts
-readonly static useNewResolver: false = false;
-```
-### Inherited from
-```ts
-AbstractDiviner.useNewResolver
-```
-## Accessors
-### queries
-### Get Signature
-```ts
-get queries(): Schema[];
-```
-#### Returns
-`Schema`[]
-### Inherited from
-```ts
-AbstractDiviner.queries
-```
-***
-### account
-### Get Signature
-```ts
-get account(): AccountInstance;
-```
-#### Returns
-`AccountInstance`
-### Inherited from
-```ts
-AbstractDiviner.account
-```
-***
-### additionalSigners
-### Get Signature
-```ts
-get additionalSigners(): AccountInstance[];
-```
-#### Returns
-`AccountInstance`[]
-### Inherited from
-```ts
-AbstractDiviner.additionalSigners
-```
-***
-### address
-### Get Signature
-```ts
-get address(): Lowercase<string> & object & object;
-```
-#### Returns
-`Lowercase`\<`string`\> & `object` & `object`
-### Inherited from
-```ts
-AbstractDiviner.address
-```
-***
-### allowAnonymous
-### Get Signature
-```ts
-get allowAnonymous(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.allowAnonymous
-```
-***
-### allowNameResolution
-### Get Signature
-```ts
-get allowNameResolution(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.allowNameResolution
-```
-***
-### archiving
-### Get Signature
-```ts
-get archiving():
-  | {
-  archivists?: ModuleIdentifier[];
-  queries?: Schema[];
-}
-  | undefined;
-```
-#### Returns
-  \| \{
-  `archivists?`: `ModuleIdentifier`[];
-  `queries?`: `Schema`[];
-\}
-  \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.archiving
-```
-***
-### archivist
-### Get Signature
-```ts
-get archivist(): ModuleIdentifier | undefined;
-```
-#### Returns
-`ModuleIdentifier` \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.archivist
-```
-***
-### config
-### Get Signature
-```ts
-get config(): TParams["config"] & object;
-```
-#### Returns
-`TParams`\[`"config"`\] & `object`
-### Inherited from
-```ts
-AbstractDiviner.config
-```
-***
-### dead
-### Get Signature
-```ts
-get dead(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.dead
-```
-***
-### ephemeralQueryAccountEnabled
-### Get Signature
-```ts
-get ephemeralQueryAccountEnabled(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.ephemeralQueryAccountEnabled
-```
-***
-### globalReentrancyMutex
-### Get Signature
-```ts
-get globalReentrancyMutex(): Mutex | undefined;
-```
-#### Returns
-`Mutex` \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.globalReentrancyMutex
-```
-***
-### id
-### Get Signature
-```ts
-get id(): string;
-```
-The name (if specified) or address of the module
-#### Returns
-`string`
-### Inherited from
-```ts
-AbstractDiviner.id
-```
-***
-### logger
-### Get Signature
-```ts
-get logger(): Logger | undefined;
-```
-#### Returns
-`Logger` \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.logger
-```
-***
-### priority
-### Get Signature
-```ts
-get priority(): 2;
-```
-#### Returns
-`2`
-### Inherited from
-```ts
-AbstractDiviner.priority
-```
-***
-### reentrancy
-### Get Signature
-```ts
-get reentrancy():
-  | {
-  action: "skip" | "wait";
-  scope: "global";
-}
-  | undefined;
-```
-#### Returns
-  \| \{
-  `action`: `"skip"` \| `"wait"`;
-  `scope`: `"global"`;
-\}
-  \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.reentrancy
-```
-***
-### statusReporter
-### Get Signature
-```ts
-get statusReporter():
-  | ModuleStatusReporter & CreatableStatusReporter<void>
-  | undefined;
-```
-The status reporter used to broadcast lifecycle changes.
-#### Returns
-  \| `ModuleStatusReporter` & `CreatableStatusReporter`\<`void`\>
-  \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.statusReporter
-```
-***
-### timestamp
-### Get Signature
-```ts
-get timestamp(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.timestamp
-```
-***
-### moduleConfigQueryValidator
-### Get Signature
-```ts
-get protected moduleConfigQueryValidator(): Queryable;
-```
-#### Returns
-`Queryable`
-### Inherited from
-```ts
-AbstractDiviner.moduleConfigQueryValidator
-```
-***
-### supportedQueryValidator
-### Get Signature
-```ts
-get protected supportedQueryValidator(): Queryable;
-```
-#### Returns
-`Queryable`
-### Inherited from
-```ts
-AbstractDiviner.supportedQueryValidator
-```
-***
-### downResolver
-### Get Signature
-```ts
-get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-#### Returns
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-### Inherited from
-```ts
-AbstractDiviner.downResolver
-```
-***
-### modName
-### Get Signature
-```ts
-get modName(): string | undefined;
-```
-#### Returns
-`string` \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.modName
-```
-***
-### moduleIdentifierTransformers
-### Get Signature
-```ts
-get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
-```
-#### Returns
-`ModuleIdentifierTransformer`[]
-### Inherited from
-```ts
-AbstractDiviner.moduleIdentifierTransformers
-```
-***
-### privateResolver
-### Get Signature
-```ts
-get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-#### Returns
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-### Inherited from
-```ts
-AbstractDiviner.privateResolver
-```
-***
-### root
-### Get Signature
-```ts
-get root(): this;
-```
-#### Returns
-`this`
-### Inherited from
-```ts
-AbstractDiviner.root
-```
-***
-### timeBudget
-### Get Signature
-```ts
-get timeBudget(): number | undefined;
-```
-#### Returns
-`number` \| `undefined`
-### Inherited from
-```ts
-AbstractDiviner.timeBudget
-```
-***
-### upResolver
-### Get Signature
-```ts
-get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-#### Returns
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-### Inherited from
-```ts
-AbstractDiviner.upResolver
-```
-## Methods
-### divine()
-```ts
-divine(payloads?, retryConfigIn?): Promise<DivinerDivineResult<TOut>[]>;
-```
-**`Function`**
-divine The main entry point for a diviner.  Do not override this function.  Implement/override divineHandler for custom functionality
-### Parameters
-#### payloads?
-`TIn`[]
-#### retryConfigIn?
-`RetryConfigWithComplete`\<`unknown`\>
-### Returns
-`Promise`\<`DivinerDivineResult`\<`TOut`\>[]\>
-### Inherited from
-```ts
-AbstractDiviner.divine
-```
-***
-### divineQuery()
-```ts
-divineQuery(
-   payloads?,
-   account?,
-_retry?): Promise<ModuleQueryResult<TOut>>;
-```
-### Parameters
-#### payloads?
-`TIn`[]
-#### account?
-`AccountInstance`
-#### \_retry?
-`RetryConfig`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
-### Inherited from
-```ts
-AbstractDiviner.divineQuery
-```
-***
-### queryHandler()
-```ts
-protected queryHandler<T, TConfig>(
-   query,
-   payloads?,
-queryConfig?): Promise<ModuleQueryHandlerResult>;
-```
-**`Function`**
-queryHandler Calls divine for a divine query.  Override to support additional queries.
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConfig
-`TConfig` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConfig`
-### Returns
-`Promise`\<`ModuleQueryHandlerResult`\>
-### Inherited from
-```ts
-AbstractDiviner.queryHandler
-```
-***
-### startHandler()
-```ts
-protected startHandler(): Promise<void>;
-```
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractDiviner.startHandler
-```
-***
-### stopHandler()
-```ts
-protected stopHandler(): Promise<void>;
-```
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractDiviner.stopHandler
-```
-***
-### divineHandler()
-```ts
-abstract protected divineHandler(payloads?): Promisable<TOut[]>;
-```
-**`Function`**
-divineHandler Implement or override to add custom functionality to a diviner
-### Parameters
-#### payloads?
-`TIn`[]
-### Returns
-`Promisable`\<`TOut`[]\>
-### Inherited from
-```ts
-AbstractDiviner.divineHandler
-```
-***
-### commitState()
-```ts
-protected commitState(nextState): Promise<void>;
-```
-Commit the internal state of the Diviner process. This is similar
-to a transaction completion in a database and should only be called
-when results have been successfully persisted to the appropriate
-external stores.
-### Parameters
-#### nextState
-`ModuleState`\<`TState`\>
-The state to commit
-### Returns
-`Promise`\<`void`\>
-***
-### getArchivistForStateStore()
-```ts
-protected getArchivistForStateStore(): Promise<ArchivistWrapper<ArchivistModuleInstance<QueryableModuleParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData>>>;
-```
-Retrieves the archivist for the specified store
-### Returns
-`Promise`\<`ArchivistWrapper`\<`ArchivistModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`\>\>\>
-The archivist for the specified store
-***
-### getBoundWitnessDivinerForStateStore()
-```ts
-protected getBoundWitnessDivinerForStateStore(): Promise<DivinerWrapper<DivinerModule<DivinerParams<AnyConfigSchema<DivinerConfig>>, DivinerModuleEventData>, Payload, Payload>>;
-```
-Retrieves the BoundWitness Diviner for the specified store
-### Returns
-`Promise`\<`DivinerWrapper`\<`DivinerModule`\<`DivinerParams`\<`AnyConfigSchema`\<`DivinerConfig`\>\>, `DivinerModuleEventData`\>, `Payload`, `Payload`\>\>
-The BoundWitness Diviner for the specified store
-***
-### getPayloadDivinerForStateStore()
-```ts
-protected getPayloadDivinerForStateStore(): Promise<DivinerWrapper<DivinerModule<DivinerParams<AnyConfigSchema<DivinerConfig>>, DivinerModuleEventData>, Payload, Payload>>;
-```
-Retrieves the Payload Diviner for the specified store
-### Returns
-`Promise`\<`DivinerWrapper`\<`DivinerModule`\<`DivinerParams`\<`AnyConfigSchema`\<`DivinerConfig`\>\>, `DivinerModuleEventData`\>, `Payload`, `Payload`\>\>
-The Payload Diviner for the specified store
-***
-### retrieveState()
-```ts
-protected retrieveState(): Promise<ModuleState<TState> | undefined>;
-```
-Retrieves the last state of the Diviner process. Used to recover state after
-preemptions, reboots, etc.
-### Returns
-`Promise`\<`ModuleState`\<`TState`\> \| `undefined`\>
-***
-### \_getRootFunction()
-```ts
-static _getRootFunction(funcName): any;
-```
-### Parameters
-#### funcName
-`string`
-### Returns
-`any`
-### Inherited from
-```ts
-AbstractDiviner._getRootFunction
-```
-***
-### \_noOverride()
-```ts
-static _noOverride(functionName): void;
-```
-### Parameters
-#### functionName
-`string`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractDiviner._noOverride
-```
-***
-### createHandler()
-```ts
-static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;
-```
-Static hook called during creation to perform additional initialization.
-Override in subclasses to customize post-construction setup.
-### Type Parameters
-#### T
-`T` *extends* `CreatableInstance`\<`CreatableParams`, `EventData`\>
-### Parameters
-#### inInstance
-`T`
-### Returns
-`Promise`\<`T` & `AbstractModule`\<`any`, `any`\>\>
-The instance, potentially modified
-### Inherited from
-```ts
-AbstractDiviner.createHandler
-```
-***
-### determineAccount()
-```ts
-static determineAccount(params): Promise<AccountInstance>;
-```
-### Parameters
-#### params
-##### account?
-`AccountInstance` \| `"random"`
-##### accountPath?
-`string`
-##### wallet?
-`WalletInstance`
-### Returns
-`Promise`\<`AccountInstance`\>
-### Inherited from
-```ts
-AbstractDiviner.determineAccount
-```
-***
-### factory()
-```ts
-static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;
-```
-### Type Parameters
-#### TModule
-`TModule` *extends* `CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-### Parameters
-#### this
-`CreatableModule`\<`TModule`\>
-#### params?
-`Partial`\<`TModule`\[`"params"`\]\>
-### Returns
-`CreatableModuleFactory`\<`TModule`\>
-### Inherited from
-```ts
-AbstractDiviner.factory
-```
-***
-### isAllowedSchema()
-```ts
-static isAllowedSchema(schema): boolean;
-```
-### Parameters
-#### schema
-`Schema`
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.isAllowedSchema
-```
-***
-### paramsHandler()
-```ts
-static paramsHandler<T>(inParams?): Promise<T["params"]>;
-```
-Static hook called during creation to validate and transform params.
-Override in subclasses to add default values or validation.
-### Type Parameters
-#### T
-`T` *extends* `AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-### Parameters
-#### inParams?
-`Partial`\<`T`\[`"params"`\]\>
-### Returns
-`Promise`\<`T`\[`"params"`\]\>
-The processed params ready for construction
-### Inherited from
-```ts
-AbstractDiviner.paramsHandler
-```
-***
-### \_getRootFunction()
-```ts
-_getRootFunction(funcName): any;
-```
-### Parameters
-#### funcName
-`string`
-### Returns
-`any`
-### Inherited from
-```ts
-AbstractDiviner._getRootFunction
-```
-***
-### busy()
-```ts
-busy<R>(closure): Promise<R>;
-```
-### Type Parameters
-#### R
-`R`
-### Parameters
-#### closure
-() => `Promise`\<`R`\>
-### Returns
-`Promise`\<`R`\>
-### Inherited from
-```ts
-AbstractDiviner.busy
-```
-***
-### emit()
-```ts
-emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
-```
-Emits an event, invoking all registered listeners concurrently.
-### Type Parameters
-#### TEventName
-`TEventName` *extends* `string` \| `number` \| `symbol` = keyof `TEventData`
-#### TEventArgs
-`TEventArgs` *extends* `EventArgs` = `TEventData`\[`TEventName`\]
-### Parameters
-#### eventName
-`TEventName`
-The event to emit.
-#### eventArgs
-`TEventArgs`
-The data to pass to listeners.
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractDiviner.emit
-```
-***
-### isSupportedQuery()
-```ts
-isSupportedQuery(query, assert?): boolean;
-```
-### Parameters
-#### query
-`Schema`
-#### assert?
-`string` \| `boolean`
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.isSupportedQuery
-```
-***
-### previousHash()
-```ts
-previousHash(): Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-```ts
-AbstractDiviner.previousHash
-```
-***
-### query()
-```ts
-query<T, TConfig>(
-   query,
-   payloads?,
-queryConfig?): Promise<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConfig
-`TConfig` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConfig`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractDiviner.query
-```
-***
-### queryable()
-```ts
-queryable<T, TConfig>(
-   query,
-   payloads?,
-queryConfig?): Promise<boolean>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConfig
-`TConfig` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConfig`
-### Returns
-`Promise`\<`boolean`\>
-### Inherited from
-```ts
-AbstractDiviner.queryable
-```
-***
-### \_checkDead()
-```ts
-protected _checkDead(): void;
-```
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractDiviner._checkDead
-```
-***
-### archivistInstance()
-### Call Signature
-```ts
-protected archivistInstance(): Promise<
-  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
-| undefined>;
-```
-#### Returns
-`Promise`\<
-  \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
-  \| `undefined`\>
-#### Inherited from
-```ts
-AbstractDiviner.archivistInstance
-```
-### Call Signature
-```ts
-protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
-```
-#### Parameters
-##### required
-`true`
-#### Returns
-`Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
-#### Inherited from
-```ts
-AbstractDiviner.archivistInstance
-```
-***
-### bindHashes()
-```ts
-protected bindHashes(
-   hashes,
-   schema,
-account?): PromiseEx<unknown, AccountInstance>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### schema
-`Schema`[]
-#### account?
-`AccountInstance`
-### Returns
-`PromiseEx`\<`unknown`, `AccountInstance`\>
-### Inherited from
-```ts
-AbstractDiviner.bindHashes
-```
-***
-### bindHashesInternal()
-```ts
-protected bindHashesInternal(
-   hashes,
-   schema,
-   account?): Promise<{
-  schema: "network.xyo.boundwitness" & object;
-  addresses: Lowercase<string> & object & object[];
-  payload_hashes: BrandedHash[];
-  payload_schemas: BrandedSchema<string>[];
-  previous_hashes: (BrandedHash | null)[];
-  $destination?: Lowercase<string> & object & object;
-  $sourceQuery?: BrandedHash;
-  $signatures: (BrandedHex | null)[];
-}>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### schema
-`Schema`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<\{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}\>
-### Inherited from
-```ts
-AbstractDiviner.bindHashesInternal
-```
-***
-### bindQuery()
-```ts
-protected bindQuery<T>(
-   query,
-   payloads?,
-   account?,
-additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-#### additionalSigners?
-`AccountInstance`[]
-### Returns
-`PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\], `AccountInstance`\>
-### Inherited from
-```ts
-AbstractDiviner.bindQuery
-```
-***
-### bindQueryInternal()
-```ts
-protected bindQueryInternal<T>(
-   query,
-   payloads?,
-   account?,
-additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-#### additionalSigners?
-`AccountInstance`[]
-### Returns
-`Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\]\>
-### Inherited from
-```ts
-AbstractDiviner.bindQueryInternal
-```
-***
-### bindQueryResult()
-```ts
-protected bindQueryResult<T>(
-   query,
-   payloads,
-   additionalWitnesses?,
-errors?): Promise<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads
-`Payload`[]
-#### additionalWitnesses?
-`AccountInstance`[]
-#### errors?
-`ModuleError`[]
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractDiviner.bindQueryResult
-```
-***
-### generateConfigAndAddress()
-```ts
-protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
-```
-### Parameters
-#### \_maxDepth?
-`number`
-### Returns
-`Promisable`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractDiviner.generateConfigAndAddress
-```
-***
-### generateDescribe()
-```ts
-protected generateDescribe(): Promise<ModuleDescriptionPayload>;
-```
-### Returns
-`Promise`\<`ModuleDescriptionPayload`\>
-### Inherited from
-```ts
-AbstractDiviner.generateDescribe
-```
-***
-### ~~getArchivist()~~
-```ts
-protected getArchivist(): Promise<
-  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
-| undefined>;
-```
-### Returns
-`Promise`\<
-  \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
-  \| `undefined`\>
-### Deprecated
-use archivistInstance() instead
-### Inherited from
-```ts
-AbstractDiviner.getArchivist
-```
-***
-### isAllowedArchivingQuery()
-```ts
-protected isAllowedArchivingQuery(schema): boolean;
-```
-### Parameters
-#### schema
-`Schema`
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.isAllowedArchivingQuery
-```
-***
-### moduleAddressHandler()
-```ts
-protected moduleAddressHandler(): Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
-```
-### Returns
-`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
-### Inherited from
-```ts
-AbstractDiviner.moduleAddressHandler
-```
-***
-### stateHandler()
-```ts
-protected stateHandler(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractDiviner.stateHandler
-```
-***
-### subscribeHandler()
-```ts
-protected subscribeHandler(): void;
-```
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractDiviner.subscribeHandler
-```
-***
-### validateConfig()
-```ts
-protected validateConfig(config?, parents?): boolean;
-```
-### Parameters
-#### config?
-`unknown`
-#### parents?
-`string`[]
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractDiviner.validateConfig
-```
-***
-### addParent()
-```ts
-addParent(mod): void;
-```
-### Parameters
-#### mod
-`ModuleInstance`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractDiviner.addParent
-```
-***
-### certifyParents()
-```ts
-certifyParents(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractDiviner.certifyParents
-```
-***
-### createHandler()
-```ts
-createHandler(): Promise<void>;
-```
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractDiviner.createHandler
-```
-***
-### manifest()
-```ts
-manifest(maxDepth?): Promise<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-### Returns
-`Promise`\<`ModuleManifestPayload`\>
-### Inherited from
-```ts
-AbstractDiviner.manifest
-```
-***
-### manifestQuery()
-```ts
-manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
-```
-### Parameters
-#### account
-`AccountInstance`
-#### maxDepth?
-`number`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-### Inherited from
-```ts
-AbstractDiviner.manifestQuery
-```
-***
-### moduleAddress()
-```ts
-moduleAddress(): Promise<(AddressPreviousHashPayload | AddressPayload)[]>;
-```
-### Returns
-`Promise`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
-### Inherited from
-```ts
-AbstractDiviner.moduleAddress
-```
-***
-### parents()
-```ts
-parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
-```
-### Returns
-`Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
-### Inherited from
-```ts
-AbstractDiviner.parents
-```
-***
-### privateChildren()
-```ts
-privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-AbstractDiviner.privateChildren
-```
-***
-### publicChildren()
-```ts
-publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-AbstractDiviner.publicChildren
-```
-***
-### removeParent()
-```ts
-removeParent(address): void;
-```
-### Parameters
-#### address
-`BrandedAddress`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractDiviner.removeParent
-```
-***
-### resolve()
-### Call Signature
-```ts
-resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-#### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-#### Inherited from
-```ts
-AbstractDiviner.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`[]\>
-#### Inherited from
-```ts
-AbstractDiviner.resolve
-```
-### Call Signature
-```ts
-resolve<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`\>
-#### Inherited from
-```ts
-AbstractDiviner.resolve
-```
-***
-### resolveIdentifier()
-```ts
-resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
-```
-### Parameters
-#### id
-`ModuleIdentifier`
-#### options?
-`ObjectFilterOptions`\<`AnyObject`\>
-### Returns
-`Promise`\<`BrandedAddress` \| `undefined`\>
-### Inherited from
-```ts
-AbstractDiviner.resolveIdentifier
-```
-***
-### 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`[]\>
-#### Inherited from
-```ts
-AbstractDiviner.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`\>
-#### Inherited from
-```ts
-AbstractDiviner.resolvePrivate
-```
-***
-### siblings()
-```ts
-siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-AbstractDiviner.siblings
-```
-***
-### state()
-```ts
-state(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractDiviner.state
-```
-***
-### stateQuery()
-```ts
-stateQuery(account): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractDiviner.stateQuery
-```
-***
-### subscribe()
-```ts
-subscribe(_queryAccount?): void;
-```
-### Parameters
-#### \_queryAccount?
-`AccountInstance`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractDiviner.subscribe
-```
-***
-### manifestHandler()
-```ts
-protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-#### \_ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promise`\<`ModuleManifestPayload`\>
-### Inherited from
-```ts
-AbstractDiviner.manifestHandler
-```
-***
-### resolveArchivingArchivists()
-```ts
-protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
-```
-### Returns
-`Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
-### Inherited from
-```ts
-AbstractDiviner.resolveArchivingArchivists
-```
-***
-### sendQuery()
-```ts
-protected sendQuery<T, P, R>(
-   queryPayload,
-   payloads?,
-account?): Promise<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`\<`R`[]\>
-### Inherited from
-```ts
-AbstractDiviner.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
-AbstractDiviner.sendQueryRaw
-```
-***
-### storeToArchivists()
-```ts
-protected storeToArchivists(payloads): Promise<Payload[]>;
-```
-### Parameters
-#### payloads
-`Payload`[]
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractDiviner.storeToArchivists
-```
-              ### type-aliases
-                ### <a id="AnyModule"></a>AnyModule
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-type AnyModule<TParams> = (...args) => ModuleInstance<TParams>;
-```
-## Type Parameters
-### TParams
-`TParams` *extends* [`StatefulModuleParams`](#StatefulModuleParams) = [`StatefulModuleParams`](#StatefulModuleParams)
-## Parameters
-### args
-...`any`[]
-## Returns
-`ModuleInstance`\<`TParams`\>
-                ### <a id="StatefulDivinerConfig"></a>StatefulDivinerConfig
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-type StatefulDivinerConfig = DivinerConfig<{
-  schema: StatefulDivinerConfigSchema;
-  stateStore: {
-     archivist: ModuleIdentifier;
-     boundWitnessDiviner: ModuleIdentifier;
-     payloadDiviner: ModuleIdentifier;
-  };
-}>;
-```
-The config for a Stateful Diviner
-                ### <a id="StatefulDivinerConfigSchema"></a>StatefulDivinerConfigSchema
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-type StatefulDivinerConfigSchema = typeof StatefulDivinerConfigSchema;
-```
-The schema for a Stateful Diviner config
-                ### <a id="StatefulDivinerParams"></a>StatefulDivinerParams
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-type StatefulDivinerParams = DivinerParams<AnyConfigSchema<StatefulDivinerConfig>>;
-```
-The parameters for a Stateful Diviner
-                ### <a id="StatefulDivinerSchema"></a>StatefulDivinerSchema
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-type StatefulDivinerSchema = typeof StatefulDivinerSchema;
-```
-                ### <a id="StatefulModuleParams"></a>StatefulModuleParams
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-type StatefulModuleParams = QueryableModuleParams<AnyConfigSchema<StatefulDivinerConfig>>;
-```
-              ### variables
-                ### <a id="StatefulDivinerConfigSchema"></a>StatefulDivinerConfigSchema
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-const StatefulDivinerConfigSchema: string & object;
-```
-The schema for a Stateful Diviner config
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="StatefulDivinerSchema"></a>StatefulDivinerSchema
-[**@xyo-network/diviner-stateful**](#../README)
-***
-```ts
-const StatefulDivinerSchema: "network.xyo.diviner.stateful" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png