@xyo-network/module-wrapper 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,1897 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/module-wrapper
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-wrapper)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### module
+
+        ### packages
+
+          ### wrapper
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="ModuleWrapper"></a>ModuleWrapper
+
+[**@xyo-network/module-wrapper**](#../README)
+
+***
+
+## Extends
+
+- `Base`\<`Exclude`\<`Omit`\<`TWrappedModule`\[`"params"`\], `"config"`\> & `object`, `undefined`\>\>
+
+## Type Parameters
+
+### TWrappedModule
+
+`TWrappedModule` *extends* `QueryableModule` = `QueryableModule`
+
+## Implements
+
+- `AttachableModuleInstance`\<`TWrappedModule`\[`"params"`\], `TWrappedModule`\[`"eventData"`\]\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new ModuleWrapper<TWrappedModule>(params): ModuleWrapper<TWrappedModule>;
+```
+
+### Parameters
+
+#### params
+
+[`ModuleWrapperParams`](#../type-aliases/ModuleWrapperParams)\<`TWrappedModule`\>
+
+### Returns
+
+`ModuleWrapper`\<`TWrappedModule`\>
+
+### Overrides
+
+```ts
+Base<Exclude<Omit<TWrappedModule['params'], 'config'> & { config: Exclude<TWrappedModule['params']['config'], undefined> }, undefined>>.constructor
+```
+
+## Properties
+
+### instanceIdentityCheck
+
+```ts
+readonly static instanceIdentityCheck: InstanceTypeCheck = isModuleInstance;
+```
+
+***
+
+### moduleIdentityCheck
+
+```ts
+readonly static moduleIdentityCheck: QueryableModuleTypeCheck = isQueryableModule;
+```
+
+***
+
+### requiredQueries
+
+```ts
+readonly static requiredQueries: string[];
+```
+
+***
+
+### eventData
+
+```ts
+eventData: TWrappedModule["eventData"];
+```
+
+The event data type associated with this instance.
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.eventData
+```
+
+***
+
+### cachedCalls
+
+```ts
+protected readonly cachedCalls: LRUCache<string, Payload[], unknown>;
+```
+
+***
+
+### wrapperParams
+
+```ts
+protected readonly wrapperParams: ModuleWrapperParams<TWrappedModule>;
+```
+
+## Accessors
+
+### account
+
+### Get Signature
+
+```ts
+get account(): AccountInstance;
+```
+
+#### Returns
+
+`AccountInstance`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.account
+```
+
+***
+
+### additionalSigners
+
+### Get Signature
+
+```ts
+get additionalSigners(): AccountInstance[];
+```
+
+#### Returns
+
+`AccountInstance`[]
+
+***
+
+### address
+
+### Get Signature
+
+```ts
+get address(): BrandedAddress;
+```
+
+#### Returns
+
+`BrandedAddress`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.address
+```
+
+***
+
+### config
+
+### Get Signature
+
+```ts
+get config(): Exclude<TWrappedModule["params"]["config"], undefined>;
+```
+
+#### Returns
+
+`Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.config
+```
+
+***
+
+### downResolver
+
+### Get Signature
+
+```ts
+get downResolver(): ModuleResolverInstance;
+```
+
+#### Returns
+
+`ModuleResolverInstance`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.downResolver
+```
+
+***
+
+### id
+
+### Get Signature
+
+```ts
+get id(): string;
+```
+
+The name (if specified) or address of the module
+
+#### Returns
+
+`string`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.id
+```
+
+***
+
+### mod
+
+### Get Signature
+
+```ts
+get mod(): TWrappedModule;
+```
+
+#### Returns
+
+`TWrappedModule`
+
+***
+
+### modName
+
+### Get Signature
+
+```ts
+get modName(): string | undefined;
+```
+
+#### Returns
+
+`string` \| `undefined`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.modName
+```
+
+***
+
+### name
+
+### Get Signature
+
+```ts
+get name(): CreatableName;
+```
+
+The name identifier for this instance.
+
+#### Returns
+
+`CreatableName`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.name
+```
+
+***
+
+### priority
+
+### Get Signature
+
+```ts
+get priority(): 1;
+```
+
+#### Returns
+
+`1`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.priority
+```
+
+***
+
+### privateResolver
+
+### Get Signature
+
+```ts
+get privateResolver(): ModuleResolverInstance;
+```
+
+#### Returns
+
+`ModuleResolverInstance`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.privateResolver
+```
+
+***
+
+### queries
+
+### Get Signature
+
+```ts
+get queries(): string[];
+```
+
+#### Returns
+
+`string`[]
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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
+AttachableModuleInstance.status
+```
+
+***
+
+### upResolver
+
+### Get Signature
+
+```ts
+get upResolver(): ModuleResolverInstance;
+```
+
+#### Returns
+
+`ModuleResolverInstance`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.upResolver
+```
+
+## Methods
+
+### canWrap()
+
+```ts
+static canWrap(mod?): mod is QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>;
+```
+
+### Parameters
+
+#### mod?
+
+`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Returns
+
+`mod is QueryableModule<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>`
+
+***
+
+### hasRequiredQueries()
+
+```ts
+static hasRequiredQueries(mod): boolean;
+```
+
+### Parameters
+
+#### mod
+
+`QueryableModule`
+
+### Returns
+
+`boolean`
+
+***
+
+### 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`](#../type-aliases/ConstructableModuleWrapper)\<`TModuleWrapper`\>
+
+#### wrapper
+
+`any`
+
+### Returns
+
+`wrapper is TModuleWrapper`
+
+***
+
+### missingRequiredQueries()
+
+```ts
+static missingRequiredQueries(mod): string[];
+```
+
+### Parameters
+
+#### mod
+
+`QueryableModule`
+
+### Returns
+
+`string`[]
+
+***
+
+### 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`](#../type-aliases/ConstructableModuleWrapper)\<`TModuleWrapper`\>
+
+#### mod
+
+  \| `QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+  \| `undefined`
+
+#### account
+
+`AccountInstance`
+
+#### checkIdentity?
+
+`boolean` = `true`
+
+### Returns
+
+`TModuleWrapper` \| `undefined`
+
+***
+
+### 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`](#../type-aliases/ConstructableModuleWrapper)\<`TModuleWrapper`\>
+
+#### mod
+
+`any`
+
+#### closure
+
+(`mod`) => `R`
+
+### Returns
+
+`R` \| `undefined`
+
+***
+
+### 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`](#../type-aliases/ConstructableModuleWrapper)\<`TModuleWrapper`\>
+
+#### mod
+
+  \| `QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+  \| `undefined`
+
+#### account
+
+`AccountInstance`
+
+#### checkIdentity?
+
+`boolean` = `true`
+
+### Returns
+
+`TModuleWrapper`
+
+***
+
+### addParent()
+
+```ts
+addParent(mod): void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.addParent
+```
+
+***
+
+### addressPreviousHash()
+
+```ts
+addressPreviousHash(): Promise<AddressPreviousHashPayload>;
+```
+
+### Returns
+
+`Promise`\<`AddressPreviousHashPayload`\>
+
+***
+
+### clearListeners()
+
+```ts
+clearListeners(eventNames): void;
+```
+
+Removes all listeners for the specified event name(s).
+
+### Parameters
+
+#### eventNames
+
+`Parameters`\<`TWrappedModule`\[`"clearListeners"`\]\>\[`0`\]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.clearListeners
+```
+
+***
+
+### emit()
+
+```ts
+emit(eventName, eventArgs): Promise<void>;
+```
+
+Emits an event, invoking all registered listeners concurrently.
+
+### Parameters
+
+#### eventName
+
+`Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`0`\]
+
+#### eventArgs
+
+`Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`1`\]
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.emit
+```
+
+***
+
+### emitSerial()
+
+```ts
+emitSerial(eventName, eventArgs): Promise<void>;
+```
+
+Emits an event, invoking all registered listeners sequentially in order.
+
+### Parameters
+
+#### eventName
+
+`Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`0`\]
+
+#### eventArgs
+
+`Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`1`\]
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.emitSerial
+```
+
+***
+
+### listenerCount()
+
+```ts
+listenerCount(eventNames): number;
+```
+
+Returns the total number of listeners registered for the specified event name(s).
+
+### Parameters
+
+#### eventNames
+
+`Parameters`\<`TWrappedModule`\[`"listenerCount"`\]\>\[`0`\]
+
+### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.listenerCount
+```
+
+***
+
+### manifest()
+
+```ts
+manifest(maxDepth?): Promise<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promise`\<`ModuleManifestPayload`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.manifest
+```
+
+***
+
+### manifestQuery()
+
+```ts
+manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.manifestQuery
+```
+
+***
+
+### moduleAddress()
+
+```ts
+moduleAddress(): Promise<AddressPreviousHashPayload[]>;
+```
+
+### Returns
+
+`Promise`\<`AddressPreviousHashPayload`[]\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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`\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.off
+```
+
+***
+
+### offAny()
+
+```ts
+offAny(listener): void;
+```
+
+Removes a wildcard listener that was receiving all events.
+
+### Parameters
+
+#### listener
+
+`EventAnyListener`
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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`\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
+
+### Returns
+
+`EventUnsubscribeFunction`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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
+AttachableModuleInstance.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`\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
+
+### Returns
+
+`EventUnsubscribeFunction`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.once
+```
+
+***
+
+### parents()
+
+```ts
+parents(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.parents
+```
+
+***
+
+### previousHash()
+
+```ts
+previousHash(): Promise<string | undefined>;
+```
+
+### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.previousHash
+```
+
+***
+
+### previousHashQuery()
+
+```ts
+previousHashQuery(account?): Promise<ModuleQueryResult<AddressPreviousHashPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPreviousHashPayload`\>\>
+
+***
+
+### privateChildren()
+
+```ts
+privateChildren(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.privateChildren
+```
+
+***
+
+### publicChildren()
+
+```ts
+publicChildren(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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
+AttachableModuleInstance.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
+AttachableModuleInstance.queryable
+```
+
+***
+
+### removeParent()
+
+```ts
+removeParent(address): void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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
+AttachableModuleInstance.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
+AttachableModuleInstance.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
+AttachableModuleInstance.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
+AttachableModuleInstance.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
+AttachableModuleInstance.resolvePrivate
+```
+
+***
+
+### siblings()
+
+```ts
+siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.siblings
+```
+
+***
+
+### start()
+
+```ts
+start(): Promise<boolean>;
+```
+
+Starts the instance. Resolves to true if started successfully.
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.start
+```
+
+***
+
+### state()
+
+```ts
+state(): Promise<Payload[]>;
+```
+
+### Returns
+
+`Promise`\<`Payload`[]\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.state
+```
+
+***
+
+### stateQuery()
+
+```ts
+stateQuery(_account): Promise<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### \_account
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.stateQuery
+```
+
+***
+
+### stop()
+
+```ts
+stop(): Promise<boolean>;
+```
+
+Stops the instance. Resolves to true if stopped successfully.
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### Implementation of
+
+```ts
+AttachableModuleInstance.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`\>
+
+***
+
+### 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`[]\]\>
+
+***
+
+### filterErrors()
+
+```ts
+protected filterErrors(__namedParameters): ModuleError[];
+```
+
+### Parameters
+
+#### \_\_namedParameters
+
+`ModuleQueryResult`
+
+### Returns
+
+`ModuleError`[]
+
+***
+
+### 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`[]\>
+
+***
+
+### 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`\>\>
+
+              ### functions
+
+                ### <a id="constructableModuleWrapper"></a>constructableModuleWrapper
+
+[**@xyo-network/module-wrapper**](#../README)
+
+***
+
+```ts
+function constructableModuleWrapper<TWrapper>(): <U>(constructor) => void;
+```
+
+## Type Parameters
+
+### TWrapper
+
+`TWrapper` *extends* [`ModuleWrapper`](#../classes/ModuleWrapper)\<`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+
+## Returns
+
+\<`U`\>(`constructor`) => `void`
+
+              ### type-aliases
+
+                ### <a id="ConstructableModuleWrapper"></a>ConstructableModuleWrapper
+
+[**@xyo-network/module-wrapper**](#../README)
+
+***
+
+```ts
+type ConstructableModuleWrapper<TWrapper> = TWrapper;
+```
+
+## Type Parameters
+
+### TWrapper
+
+`TWrapper` *extends* [`ModuleWrapper`](#../classes/ModuleWrapper)
+
+```ts
+type new ConstructableModuleWrapper(params): TWrapper;
+```
+
+## Parameters
+
+### params
+
+[`ModuleWrapperParams`](#ModuleWrapperParams)\<`TWrapper`\[`"mod"`\]\>
+
+## Returns
+
+`TWrapper`
+
+## Properties
+
+### defaultLogger?
+
+```ts
+optional defaultLogger?: Logger;
+```
+
+***
+
+### instanceIdentityCheck
+
+```ts
+instanceIdentityCheck: InstanceTypeCheck;
+```
+
+***
+
+### moduleIdentityCheck
+
+```ts
+moduleIdentityCheck: QueryableModuleTypeCheck;
+```
+
+***
+
+### requiredQueries
+
+```ts
+requiredQueries: string[];
+```
+
+## Methods
+
+### canWrap()
+
+```ts
+canWrap(mod): boolean;
+```
+
+### Parameters
+
+#### mod
+
+  \| `QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+  \| `undefined`
+
+### Returns
+
+`boolean`
+
+***
+
+### is()
+
+```ts
+is<TModuleWrapper>(this, wrapper?): wrapper is TModuleWrapper;
+```
+
+### Type Parameters
+
+#### TModuleWrapper
+
+`TModuleWrapper` *extends* [`ModuleWrapper`](#../classes/ModuleWrapper)\<`QueryableModule`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+
+### Parameters
+
+#### this
+
+`ConstructableModuleWrapper`\<`TModuleWrapper`\>
+
+#### wrapper?
+
+`any`
+
+### Returns
+
+`wrapper is TModuleWrapper`
+
+***
+
+### tryWrap()
+
+```ts
+tryWrap<TModuleWrapper>(
+   this, 
+   mod, 
+   account, 
+   checkIdentity?): TModuleWrapper | undefined;
+```
+
+### Type Parameters
+
+#### TModuleWrapper
+
+`TModuleWrapper` *extends* [`ModuleWrapper`](#../classes/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`
+
+***
+
+### wrap()
+
+```ts
+wrap<TModuleWrapper>(
+   this, 
+   mod, 
+   account, 
+   checkIdentity?): TModuleWrapper;
+```
+
+### Type Parameters
+
+#### TModuleWrapper
+
+`TModuleWrapper` *extends* [`ModuleWrapper`](#../classes/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`
+
+                ### <a id="ModuleWrapperParams"></a>ModuleWrapperParams
+
+[**@xyo-network/module-wrapper**](#../README)
+
+***
+
+```ts
+type ModuleWrapperParams<TWrappedModule> = BaseParams<{
+  account: AccountInstance;
+  additionalSigners?: AccountInstance[];
+  mod: TWrappedModule;
+}>;
+```
+
+## Type Parameters
+
+### TWrappedModule
 
-## Credits
+`TWrappedModule` *extends* `QueryableModule` = `QueryableModule`
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/module-wrapper.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/module-wrapper
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/module-wrapper.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE