@xyo-network/witness-adhoc 5.3.30 → 5.4.0

package/README.md

@@ -38,2710 +38,6 @@ bun add {{name}}
 
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Reference
-
-### packages
-
-  ### modules
-
-    ### packages
-
-      ### witness
-
-        ### packages
-
-          ### adhoc
-
-            ### .temp-typedoc
-
-              ### classes
-
-                ### <a id="AdhocWitness"></a>AdhocWitness
-
-[**@xyo-network/witness-adhoc**](#../README)
-
-***
-
-## Extends
-
-- `AbstractWitness`\<`TParams`\>
-
-## Type Parameters
-
-### TParams
-
-`TParams` *extends* [`AdhocWitnessParams`](#../type-aliases/AdhocWitnessParams) = [`AdhocWitnessParams`](#../type-aliases/AdhocWitnessParams)
-
-## Implements
-
-- `WitnessModule`
-
-## Constructors
-
-### Constructor
-
-```ts
-new AdhocWitness<TParams>(key, params): AdhocWitness<TParams>;
-```
-
-### Parameters
-
-#### key
-
-`unknown`
-
-#### params
-
-`Partial`\<`TParams` & `RequiredCreatableParams`\>
-
-### Returns
-
-`AdhocWitness`\<`TParams`\>
-
-### Inherited from
-
-```ts
-AbstractWitness<TParams>.constructor
-```
-
-## Properties
-
-### uniqueName
-
-```ts
-readonly static uniqueName: string;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.uniqueName
-```
-
-***
-
-### allowRandomAccount
-
-```ts
-readonly static allowRandomAccount: boolean;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.allowRandomAccount
-```
-
-***
-
-### defaultLogger
-
-```ts
-static defaultLogger: Logger;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.defaultLogger
-```
-
-***
-
-### enableLazyLoad
-
-```ts
-static enableLazyLoad: boolean;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.enableLazyLoad
-```
-
-***
-
-### labels
-
-```ts
-readonly static labels: Labels;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.labels
-```
-
-***
-
-### privateConstructorKey
-
-```ts
-protected static privateConstructorKey: string;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.privateConstructorKey
-```
-
-***
-
-### \_account
-
-```ts
-protected _account: AccountInstance | undefined;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness._account
-```
-
-***
-
-### \_cachedManifests
-
-```ts
-protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness._cachedManifests
-```
-
-***
-
-### \_globalReentrancyMutex
-
-```ts
-protected _globalReentrancyMutex: Mutex | undefined;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness._globalReentrancyMutex
-```
-
-***
-
-### \_lastError?
-
-```ts
-protected optional _lastError?: ModuleDetailsError;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness._lastError
-```
-
-***
-
-### \_moduleConfigQueryValidator
-
-```ts
-protected _moduleConfigQueryValidator: Queryable | undefined;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness._moduleConfigQueryValidator
-```
-
-***
-
-### \_supportedQueryValidator
-
-```ts
-protected _supportedQueryValidator: Queryable | undefined;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness._supportedQueryValidator
-```
-
-***
-
-### useNewResolver
-
-```ts
-readonly static useNewResolver: false = false;
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.useNewResolver
-```
-
-***
-
-### configSchemas
-
-```ts
-readonly static configSchemas: Schema[];
-```
-
-### Overrides
-
-```ts
-AbstractWitness.configSchemas
-```
-
-***
-
-### defaultConfigSchema
-
-```ts
-readonly static defaultConfigSchema: Schema = AdhocWitnessConfigSchema;
-```
-
-### Overrides
-
-```ts
-AbstractWitness.defaultConfigSchema
-```
-
-## Accessors
-
-### queries
-
-### Get Signature
-
-```ts
-get queries(): Schema[];
-```
-
-#### Returns
-
-`Schema`[]
-
-### Implementation of
-
-```ts
-WitnessModule.queries
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.queries
-```
-
-***
-
-### account
-
-### Get Signature
-
-```ts
-get account(): AccountInstance;
-```
-
-#### Returns
-
-`AccountInstance`
-
-### Inherited from
-
-```ts
-AbstractWitness.account
-```
-
-***
-
-### additionalSigners
-
-### Get Signature
-
-```ts
-get additionalSigners(): AccountInstance[];
-```
-
-#### Returns
-
-`AccountInstance`[]
-
-### Inherited from
-
-```ts
-AbstractWitness.additionalSigners
-```
-
-***
-
-### address
-
-### Get Signature
-
-```ts
-get address(): Lowercase<string> & object & object;
-```
-
-#### Returns
-
-`Lowercase`\<`string`\> & `object` & `object`
-
-### Implementation of
-
-```ts
-WitnessModule.address
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.address
-```
-
-***
-
-### allowAnonymous
-
-### Get Signature
-
-```ts
-get allowAnonymous(): boolean;
-```
-
-#### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.allowAnonymous
-```
-
-***
-
-### allowNameResolution
-
-### Get Signature
-
-```ts
-get allowNameResolution(): boolean;
-```
-
-#### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.allowNameResolution
-```
-
-***
-
-### archiving
-
-### Get Signature
-
-```ts
-get archiving(): 
-  | {
-  archivists?: ModuleIdentifier[];
-  queries?: Schema[];
-}
-  | undefined;
-```
-
-#### Returns
-
-  \| \{
-  `archivists?`: `ModuleIdentifier`[];
-  `queries?`: `Schema`[];
-\}
-  \| `undefined`
-
-### Inherited from
-
-```ts
-AbstractWitness.archiving
-```
-
-***
-
-### archivist
-
-### Get Signature
-
-```ts
-get archivist(): ModuleIdentifier | undefined;
-```
-
-#### Returns
-
-`ModuleIdentifier` \| `undefined`
-
-### Inherited from
-
-```ts
-AbstractWitness.archivist
-```
-
-***
-
-### config
-
-### Get Signature
-
-```ts
-get config(): TParams["config"] & object;
-```
-
-#### Returns
-
-`TParams`\[`"config"`\] & `object`
-
-### Implementation of
-
-```ts
-WitnessModule.config
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.config
-```
-
-***
-
-### dead
-
-### Get Signature
-
-```ts
-get dead(): boolean;
-```
-
-#### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.dead
-```
-
-***
-
-### ephemeralQueryAccountEnabled
-
-### Get Signature
-
-```ts
-get ephemeralQueryAccountEnabled(): boolean;
-```
-
-#### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.ephemeralQueryAccountEnabled
-```
-
-***
-
-### globalReentrancyMutex
-
-### Get Signature
-
-```ts
-get globalReentrancyMutex(): Mutex | undefined;
-```
-
-#### Returns
-
-`Mutex` \| `undefined`
-
-### Inherited from
-
-```ts
-AbstractWitness.globalReentrancyMutex
-```
-
-***
-
-### id
-
-### Get Signature
-
-```ts
-get id(): string;
-```
-
-The name (if specified) or address of the module
-
-#### Returns
-
-`string`
-
-### Implementation of
-
-```ts
-WitnessModule.id
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.id
-```
-
-***
-
-### logger
-
-### Get Signature
-
-```ts
-get logger(): Logger | undefined;
-```
-
-#### Returns
-
-`Logger` \| `undefined`
-
-### Inherited from
-
-```ts
-AbstractWitness.logger
-```
-
-***
-
-### priority
-
-### Get Signature
-
-```ts
-get priority(): 2;
-```
-
-#### Returns
-
-`2`
-
-### Inherited from
-
-```ts
-AbstractWitness.priority
-```
-
-***
-
-### reentrancy
-
-### Get Signature
-
-```ts
-get reentrancy(): 
-  | {
-  action: "skip" | "wait";
-  scope: "global";
-}
-  | undefined;
-```
-
-#### Returns
-
-  \| \{
-  `action`: `"skip"` \| `"wait"`;
-  `scope`: `"global"`;
-\}
-  \| `undefined`
-
-### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.statusReporter
-```
-
-***
-
-### timestamp
-
-### Get Signature
-
-```ts
-get timestamp(): boolean;
-```
-
-#### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.timestamp
-```
-
-***
-
-### moduleConfigQueryValidator
-
-### Get Signature
-
-```ts
-get protected moduleConfigQueryValidator(): Queryable;
-```
-
-#### Returns
-
-`Queryable`
-
-### Inherited from
-
-```ts
-AbstractWitness.moduleConfigQueryValidator
-```
-
-***
-
-### supportedQueryValidator
-
-### Get Signature
-
-```ts
-get protected supportedQueryValidator(): Queryable;
-```
-
-#### Returns
-
-`Queryable`
-
-### Inherited from
-
-```ts
-AbstractWitness.supportedQueryValidator
-```
-
-***
-
-### downResolver
-
-### Get Signature
-
-```ts
-get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-
-#### Returns
-
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.downResolver
-```
-
-***
-
-### modName
-
-### Get Signature
-
-```ts
-get modName(): string | undefined;
-```
-
-#### Returns
-
-`string` \| `undefined`
-
-### Implementation of
-
-```ts
-WitnessModule.modName
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.modName
-```
-
-***
-
-### moduleIdentifierTransformers
-
-### Get Signature
-
-```ts
-get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
-```
-
-#### Returns
-
-`ModuleIdentifierTransformer`[]
-
-### Inherited from
-
-```ts
-AbstractWitness.moduleIdentifierTransformers
-```
-
-***
-
-### privateResolver
-
-### Get Signature
-
-```ts
-get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-
-#### Returns
-
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.privateResolver
-```
-
-***
-
-### root
-
-### Get Signature
-
-```ts
-get root(): this;
-```
-
-#### Returns
-
-`this`
-
-### Inherited from
-
-```ts
-AbstractWitness.root
-```
-
-***
-
-### timeBudget
-
-### Get Signature
-
-```ts
-get timeBudget(): number | undefined;
-```
-
-#### Returns
-
-`number` \| `undefined`
-
-### Inherited from
-
-```ts
-AbstractWitness.timeBudget
-```
-
-***
-
-### upResolver
-
-### Get Signature
-
-```ts
-get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-
-#### Returns
-
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.upResolver
-```
-
-***
-
-### payload
-
-### Get Signature
-
-```ts
-get payload(): Payload | undefined;
-```
-
-#### Returns
-
-`Payload` \| `undefined`
-
-## Methods
-
-### getArchivistInstance()
-
-```ts
-getArchivistInstance(): Promise<
-  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig<void, void>>>, ArchivistModuleEventData, Payload>
-| undefined>;
-```
-
-### Returns
-
-`Promise`\<
-  \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\<`void`, `void`\>\>\>, `ArchivistModuleEventData`, `Payload`\>
-  \| `undefined`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.getArchivistInstance
-```
-
-***
-
-### observe()
-
-```ts
-observe(inPayloads?): Promise<WithoutPrivateStorageMeta<Payload>[]>;
-```
-
-**`Function`**
-
-observe The main entry point for a witness.  Do not override this function.  Implement/override observeHandler for custom functionality
-
-### Parameters
-
-#### inPayloads?
-
-`Payload`[]
-
-### Returns
-
-`Promise`\<`WithoutPrivateStorageMeta`\<`Payload`\>[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.observe
-```
-
-***
-
-### observeQuery()
-
-```ts
-observeQuery(payloads?, account?): Promise<ModuleQueryResult<Payload>>;
-```
-
-### Parameters
-
-#### payloads?
-
-`Payload`[]
-
-#### account?
-
-`AccountInstance`
-
-### Returns
-
-`Promise`\<`ModuleQueryResult`\<`Payload`\>\>
-
-### Inherited from
-
-```ts
-AbstractWitness.observeQuery
-```
-
-***
-
-### queryHandler()
-
-```ts
-protected queryHandler<T, TConfig>(
-   query, 
-   payloads?, 
-queryConfig?): Promise<ModuleQueryHandlerResult>;
-```
-
-**`Function`**
-
-queryHandler Calls observe for an observe 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
-AbstractWitness.queryHandler
-```
-
-***
-
-### \_getRootFunction()
-
-```ts
-static _getRootFunction(funcName): any;
-```
-
-### Parameters
-
-#### funcName
-
-`string`
-
-### Returns
-
-`any`
-
-### Inherited from
-
-```ts
-AbstractWitness._getRootFunction
-```
-
-***
-
-### \_noOverride()
-
-```ts
-static _noOverride(functionName): void;
-```
-
-### Parameters
-
-#### functionName
-
-`string`
-
-### Returns
-
-`void`
-
-### Inherited from
-
-```ts
-AbstractWitness._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
-AbstractWitness.createHandler
-```
-
-***
-
-### determineAccount()
-
-```ts
-static determineAccount(params): Promise<AccountInstance>;
-```
-
-### Parameters
-
-#### params
-
-##### account?
-
-`AccountInstance` \| `"random"`
-
-##### accountPath?
-
-`string`
-
-##### wallet?
-
-`WalletInstance`
-
-### Returns
-
-`Promise`\<`AccountInstance`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.factory
-```
-
-***
-
-### isAllowedSchema()
-
-```ts
-static isAllowedSchema(schema): boolean;
-```
-
-### Parameters
-
-#### schema
-
-`Schema`
-
-### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.paramsHandler
-```
-
-***
-
-### \_getRootFunction()
-
-```ts
-_getRootFunction(funcName): any;
-```
-
-### Parameters
-
-#### funcName
-
-`string`
-
-### Returns
-
-`any`
-
-### Inherited from
-
-```ts
-AbstractWitness._getRootFunction
-```
-
-***
-
-### busy()
-
-```ts
-busy<R>(closure): Promise<R>;
-```
-
-### Type Parameters
-
-#### R
-
-`R`
-
-### Parameters
-
-#### closure
-
-() => `Promise`\<`R`\>
-
-### Returns
-
-`Promise`\<`R`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.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` = `string` \| `number` \| `symbol`
-
-#### TEventArgs
-
-`TEventArgs` *extends* `EventArgs` = `WitnessModuleEventData`\<`WitnessInstance`\<`TParams`, `Payload`, `Payload`, `WitnessModuleEventData`\>, `Payload`, `Payload`\>\[`TEventName`\]
-
-### Parameters
-
-#### eventName
-
-`TEventName`
-
-The event to emit.
-
-#### eventArgs
-
-`TEventArgs`
-
-The data to pass to listeners.
-
-### Returns
-
-`Promise`\<`void`\>
-
-### Implementation of
-
-```ts
-WitnessModule.emit
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.emit
-```
-
-***
-
-### isSupportedQuery()
-
-```ts
-isSupportedQuery(query, assert?): boolean;
-```
-
-### Parameters
-
-#### query
-
-`Schema`
-
-#### assert?
-
-`string` \| `boolean`
-
-### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.isSupportedQuery
-```
-
-***
-
-### previousHash()
-
-```ts
-previousHash(): Promisable<string | undefined>;
-```
-
-### Returns
-
-`Promisable`\<`string` \| `undefined`\>
-
-### Implementation of
-
-```ts
-WitnessModule.previousHash
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.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`\>
-
-### Implementation of
-
-```ts
-WitnessModule.query
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.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`\>
-
-### Implementation of
-
-```ts
-WitnessModule.queryable
-```
-
-### Inherited from
-
-```ts
-AbstractWitness.queryable
-```
-
-***
-
-### \_checkDead()
-
-```ts
-protected _checkDead(): void;
-```
-
-### Returns
-
-`void`
-
-### Inherited from
-
-```ts
-AbstractWitness._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
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.bindQueryResult
-```
-
-***
-
-### generateConfigAndAddress()
-
-```ts
-protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
-```
-
-### Parameters
-
-#### \_maxDepth?
-
-`number`
-
-### Returns
-
-`Promisable`\<`Payload`[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.generateConfigAndAddress
-```
-
-***
-
-### generateDescribe()
-
-```ts
-protected generateDescribe(): Promise<ModuleDescriptionPayload>;
-```
-
-### Returns
-
-`Promise`\<`ModuleDescriptionPayload`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.getArchivist
-```
-
-***
-
-### isAllowedArchivingQuery()
-
-```ts
-protected isAllowedArchivingQuery(schema): boolean;
-```
-
-### Parameters
-
-#### schema
-
-`Schema`
-
-### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.isAllowedArchivingQuery
-```
-
-***
-
-### moduleAddressHandler()
-
-```ts
-protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
-```
-
-### Returns
-
-`Promisable`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.moduleAddressHandler
-```
-
-***
-
-### stateHandler()
-
-```ts
-protected stateHandler(): Promise<Payload[]>;
-```
-
-### Returns
-
-`Promise`\<`Payload`[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.stateHandler
-```
-
-***
-
-### stopHandler()
-
-```ts
-protected stopHandler(): Promise<void>;
-```
-
-Override in subclasses to define stop behavior. Throw an error on failure.
-
-### Returns
-
-`Promise`\<`void`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.stopHandler
-```
-
-***
-
-### subscribeHandler()
-
-```ts
-protected subscribeHandler(): void;
-```
-
-### Returns
-
-`void`
-
-### Inherited from
-
-```ts
-AbstractWitness.subscribeHandler
-```
-
-***
-
-### validateConfig()
-
-```ts
-protected validateConfig(config?, parents?): boolean;
-```
-
-### Parameters
-
-#### config?
-
-`unknown`
-
-#### parents?
-
-`string`[]
-
-### Returns
-
-`boolean`
-
-### Inherited from
-
-```ts
-AbstractWitness.validateConfig
-```
-
-***
-
-### addParent()
-
-```ts
-addParent(mod): void;
-```
-
-### Parameters
-
-#### mod
-
-`ModuleInstance`
-
-### Returns
-
-`void`
-
-### Inherited from
-
-```ts
-AbstractWitness.addParent
-```
-
-***
-
-### certifyParents()
-
-```ts
-certifyParents(): Promise<Payload[]>;
-```
-
-### Returns
-
-`Promise`\<`Payload`[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.certifyParents
-```
-
-***
-
-### createHandler()
-
-```ts
-createHandler(): Promise<void>;
-```
-
-### Returns
-
-`Promise`\<`void`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.createHandler
-```
-
-***
-
-### manifest()
-
-```ts
-manifest(maxDepth?): Promise<ModuleManifestPayload>;
-```
-
-### Parameters
-
-#### maxDepth?
-
-`number`
-
-### Returns
-
-`Promise`\<`ModuleManifestPayload`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.manifest
-```
-
-***
-
-### manifestQuery()
-
-```ts
-manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
-```
-
-### Parameters
-
-#### account
-
-`AccountInstance`
-
-#### maxDepth?
-
-`number`
-
-### Returns
-
-`Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-
-### Inherited from
-
-```ts
-AbstractWitness.manifestQuery
-```
-
-***
-
-### moduleAddress()
-
-```ts
-moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
-```
-
-### Returns
-
-`Promise`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.moduleAddress
-```
-
-***
-
-### parents()
-
-```ts
-parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
-```
-
-### Returns
-
-`Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.parents
-```
-
-***
-
-### privateChildren()
-
-```ts
-privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-
-### Returns
-
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.privateChildren
-```
-
-***
-
-### publicChildren()
-
-```ts
-publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-
-### Returns
-
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.publicChildren
-```
-
-***
-
-### removeParent()
-
-```ts
-removeParent(address): void;
-```
-
-### Parameters
-
-#### address
-
-`BrandedAddress`
-
-### Returns
-
-`void`
-
-### Inherited from
-
-```ts
-AbstractWitness.removeParent
-```
-
-***
-
-### resolve()
-
-### Call Signature
-
-```ts
-resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-
-#### Returns
-
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-
-#### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.resolve
-```
-
-***
-
-### resolveIdentifier()
-
-```ts
-resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
-```
-
-### Parameters
-
-#### id
-
-`ModuleIdentifier`
-
-#### options?
-
-`ObjectFilterOptions`\<`AnyObject`\>
-
-### Returns
-
-`Promise`\<`BrandedAddress` \| `undefined`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.resolvePrivate
-```
-
-***
-
-### siblings()
-
-```ts
-siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-
-### Returns
-
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.siblings
-```
-
-***
-
-### state()
-
-```ts
-state(): Promise<Payload[]>;
-```
-
-### Returns
-
-`Promise`\<`Payload`[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.state
-```
-
-***
-
-### stateQuery()
-
-```ts
-stateQuery(account): Promise<ModuleQueryResult>;
-```
-
-### Parameters
-
-#### account
-
-`AccountInstance`
-
-### Returns
-
-`Promise`\<`ModuleQueryResult`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.stateQuery
-```
-
-***
-
-### subscribe()
-
-```ts
-subscribe(_queryAccount?): void;
-```
-
-### Parameters
-
-#### \_queryAccount?
-
-`AccountInstance`
-
-### Returns
-
-`void`
-
-### Inherited from
-
-```ts
-AbstractWitness.subscribe
-```
-
-***
-
-### manifestHandler()
-
-```ts
-protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
-```
-
-### Parameters
-
-#### maxDepth?
-
-`number`
-
-#### \_ignoreAddresses?
-
-`BrandedAddress`[]
-
-### Returns
-
-`Promise`\<`ModuleManifestPayload`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.manifestHandler
-```
-
-***
-
-### resolveArchivingArchivists()
-
-```ts
-protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
-```
-
-### Returns
-
-`Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.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
-AbstractWitness.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
-AbstractWitness.sendQueryRaw
-```
-
-***
-
-### startHandler()
-
-```ts
-protected startHandler(): Promise<void>;
-```
-
-### Returns
-
-`Promise`\<`void`\>
-
-### Inherited from
-
-```ts
-AbstractWitness.startHandler
-```
-
-***
-
-### storeToArchivists()
-
-```ts
-protected storeToArchivists(payloads): Promise<Payload[]>;
-```
-
-### Parameters
-
-#### payloads
-
-`Payload`[]
-
-### Returns
-
-`Promise`\<`Payload`[]\>
-
-### Inherited from
-
-```ts
-AbstractWitness.storeToArchivists
-```
-
-***
-
-### observeHandler()
-
-```ts
-protected observeHandler(payloads?): Promisable<Payload[]>;
-```
-
-**`Function`**
-
-observeHandler Implement or override to add custom functionality to a witness
-
-### Parameters
-
-#### payloads?
-
-`Payload`[]
-
-### Returns
-
-`Promisable`\<`Payload`[]\>
-
-### Overrides
-
-```ts
-AbstractWitness.observeHandler
-```
-
-              ### type-aliases
-
-                ### <a id="AdhocWitnessConfig"></a>AdhocWitnessConfig
-
-[**@xyo-network/witness-adhoc**](#../README)
-
-***
-
-```ts
-type AdhocWitnessConfig = WitnessConfig<{
-  payload?: Payload;
-  schema: AdhocWitnessConfigSchema;
-}>;
-```
-
-                ### <a id="AdhocWitnessConfigSchema"></a>AdhocWitnessConfigSchema
-
-[**@xyo-network/witness-adhoc**](#../README)
-
-***
-
-```ts
-type AdhocWitnessConfigSchema = typeof AdhocWitnessConfigSchema;
-```
-
-                ### <a id="AdhocWitnessParams"></a>AdhocWitnessParams
-
-[**@xyo-network/witness-adhoc**](#../README)
-
-***
-
-```ts
-type AdhocWitnessParams = WitnessParams<AnyConfigSchema<AdhocWitnessConfig>>;
-```
-
-              ### variables
-
-                ### <a id="AdhocWitnessConfigSchema"></a>AdhocWitnessConfigSchema
-
-[**@xyo-network/witness-adhoc**](#../README)
-
-***
-
-```ts
-const AdhocWitnessConfigSchema: "network.xyo.witness.adhoc.config" & object;
-```
-
-## Type Declaration
-
-### \_\_schema
-
-```ts
-readonly __schema: true;
-```
 
 
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png