@xyo-network/sdk-js 3.15.10 → 3.16.0

package/docs/classes/ModuleWrapper.md

@@ -0,0 +1,1559 @@
+[@xyo-network/sdk-js](../README.md) / ModuleWrapper
+
+# Class: ModuleWrapper\<TWrappedModule\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:25
+
+## Extends
+
+- `Base`\<`Exclude`\<`Omit`\<`TWrappedModule`\[`"params"`\], `"config"`\> & `object`, `undefined`\>\>
+
+## Extended by
+
+- [`ArchivistWrapper`](ArchivistWrapper.md)
+- [`BridgeWrapper`](BridgeWrapper.md)
+- [`DivinerWrapper`](DivinerWrapper.md)
+- [`NodeWrapper`](NodeWrapper.md)
+- [`WitnessWrapper`](WitnessWrapper.md)
+
+## Type Parameters
+
+### TWrappedModule
+
+`TWrappedModule` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)
+
+## Implements
+
+- [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)\<`TWrappedModule`\[`"params"`\], `TWrappedModule`\[`"eventData"`\]\>
+
+## Constructors
+
+### Constructor
+
+> **new ModuleWrapper**\<`TWrappedModule`\>(`params`): `ModuleWrapper`\<`TWrappedModule`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:36
+
+#### Parameters
+
+##### params
+
+[`ModuleWrapperParams`](../type-aliases/ModuleWrapperParams.md)\<`TWrappedModule`\>
+
+#### Returns
+
+`ModuleWrapper`\<`TWrappedModule`\>
+
+#### Overrides
+
+`Base<Exclude<Omit<TWrappedModule['params'], 'config'> & { config: Exclude<TWrappedModule['params']['config'], undefined>; }, undefined>>.constructor`
+
+## Properties
+
+### eventData
+
+> **eventData**: `TWrappedModule`\[`"eventData"`\]
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:31
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`eventData`](../interfaces/AttachableModuleInstance.md#eventdata)
+
+***
+
+### defaultLogger?
+
+> `static` `optional` **defaultLogger**: `Logger`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:9
+
+#### Inherited from
+
+`Base.defaultLogger`
+
+***
+
+### globalInstances
+
+> `readonly` `static` **globalInstances**: `Record`\<`string`, `WeakRef`\<`Base`\<`undefined` \| `BaseParamsFields`\>\>[]\>
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:10
+
+#### Inherited from
+
+`Base.globalInstances`
+
+***
+
+### globalInstancesCountHistory
+
+> `readonly` `static` **globalInstancesCountHistory**: `Record`\<`string`, `number`[]\>
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:11
+
+#### Inherited from
+
+`Base.globalInstancesCountHistory`
+
+***
+
+### instanceIdentityCheck
+
+> `readonly` `static` **instanceIdentityCheck**: [`InstanceTypeCheck`](../type-aliases/InstanceTypeCheck.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:28
+
+***
+
+### moduleIdentityCheck
+
+> `readonly` `static` **moduleIdentityCheck**: [`ModuleTypeCheck`](../type-aliases/ModuleTypeCheck.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:29
+
+***
+
+### requiredQueries
+
+> `readonly` `static` **requiredQueries**: `string`[]
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:30
+
+***
+
+### uniqueName
+
+> `readonly` `static` **uniqueName**: `string`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:12
+
+#### Inherited from
+
+`Base.uniqueName`
+
+## Accessors
+
+### account
+
+#### Get Signature
+
+> **get** **account**(): `AccountInstance`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:37
+
+##### Returns
+
+`AccountInstance`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`account`](../interfaces/AttachableModuleInstance.md#account)
+
+***
+
+### additionalSigners
+
+#### Get Signature
+
+> **get** **additionalSigners**(): `AccountInstance`[]
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:38
+
+##### Returns
+
+`AccountInstance`[]
+
+***
+
+### address
+
+#### Get Signature
+
+> **get** **address**(): `Lowercase`\<`string`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:39
+
+##### Returns
+
+`Lowercase`\<`string`\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`address`](../interfaces/AttachableModuleInstance.md#address)
+
+***
+
+### config
+
+#### Get Signature
+
+> **get** **config**(): `Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:40
+
+##### Returns
+
+`Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`config`](../interfaces/AttachableModuleInstance.md#config)
+
+***
+
+### downResolver
+
+#### Get Signature
+
+> **get** **downResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:41
+
+##### Returns
+
+[`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`downResolver`](../interfaces/AttachableModuleInstance.md#downresolver)
+
+***
+
+### id
+
+#### Get Signature
+
+> **get** **id**(): `string`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:42
+
+The name (if specified) or address of the module
+
+##### Returns
+
+`string`
+
+The name (if specified) or address of the module
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`id`](../interfaces/AttachableModuleInstance.md#id)
+
+***
+
+### logger
+
+#### Get Signature
+
+> **get** **logger**(): `undefined` \| `Logger`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:27
+
+##### Returns
+
+`undefined` \| `Logger`
+
+#### Inherited from
+
+`Base.logger`
+
+***
+
+### mod
+
+#### Get Signature
+
+> **get** **mod**(): `TWrappedModule`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:43
+
+##### Returns
+
+`TWrappedModule`
+
+***
+
+### modName
+
+#### Get Signature
+
+> **get** **modName**(): `undefined` \| `string`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:44
+
+##### Returns
+
+`undefined` \| `string`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`modName`](../interfaces/AttachableModuleInstance.md#modname)
+
+***
+
+### params
+
+#### Get Signature
+
+> **get** **params**(): `TParams`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:28
+
+##### Returns
+
+`TParams`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`params`](../interfaces/AttachableModuleInstance.md#params)
+
+#### Inherited from
+
+`Base.params`
+
+***
+
+### priority
+
+#### Get Signature
+
+> **get** **priority**(): `1`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:45
+
+##### Returns
+
+`1`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`priority`](../interfaces/AttachableModuleInstance.md#priority)
+
+***
+
+### privateResolver
+
+#### Get Signature
+
+> **get** **privateResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:46
+
+##### Returns
+
+[`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`privateResolver`](../interfaces/AttachableModuleInstance.md#privateresolver)
+
+***
+
+### queries
+
+#### Get Signature
+
+> **get** **queries**(): `string`[]
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:47
+
+##### Returns
+
+`string`[]
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`queries`](../interfaces/AttachableModuleInstance.md#queries)
+
+***
+
+### status
+
+#### Get Signature
+
+> **get** **status**(): [`ModuleStatus`](../type-aliases/ModuleStatus.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:48
+
+##### Returns
+
+[`ModuleStatus`](../type-aliases/ModuleStatus.md)
+
+#### Set Signature
+
+> **set** **status**(`value`): `void`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:50
+
+##### Parameters
+
+###### value
+
+[`ModuleStatus`](../type-aliases/ModuleStatus.md)
+
+##### Returns
+
+`void`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`status`](../interfaces/AttachableModuleInstance.md#status)
+
+***
+
+### upResolver
+
+#### Get Signature
+
+> **get** **upResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:49
+
+##### Returns
+
+[`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`upResolver`](../interfaces/AttachableModuleInstance.md#upresolver)
+
+***
+
+### historyInterval
+
+#### Get Signature
+
+> **get** `static` **historyInterval**(): `number`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:20
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** `static` **historyInterval**(`value`): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:21
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+`Base.historyInterval`
+
+***
+
+### historyTime
+
+#### Get Signature
+
+> **get** `static` **historyTime**(): `number`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:22
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** `static` **historyTime**(`value`): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:23
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+`Base.historyTime`
+
+***
+
+### maxGcFrequency
+
+#### Get Signature
+
+> **get** `static` **maxGcFrequency**(): `number`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:24
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** `static` **maxGcFrequency**(`value`): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:25
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+`Base.maxGcFrequency`
+
+***
+
+### maxHistoryDepth
+
+#### Get Signature
+
+> **get** `static` **maxHistoryDepth**(): `number`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:26
+
+##### Returns
+
+`number`
+
+#### Inherited from
+
+`Base.maxHistoryDepth`
+
+## Methods
+
+### addParent()
+
+> **addParent**(`mod`): `void`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:68
+
+#### Parameters
+
+##### mod
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`addParent`](../interfaces/AttachableModuleInstance.md#addparent)
+
+***
+
+### addressPreviousHash()
+
+> **addressPreviousHash**(): `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:69
+
+#### Returns
+
+`Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>
+
+***
+
+### clearListeners()
+
+> **clearListeners**(`eventNames`): `void`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:70
+
+#### Parameters
+
+##### eventNames
+
+`Parameters`\<`TWrappedModule`\[`"clearListeners"`\]\>\[`0`\]
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`clearListeners`](../interfaces/AttachableModuleInstance.md#clearlisteners)
+
+***
+
+### emit()
+
+> **emit**(`eventName`, `eventArgs`): `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:71
+
+#### Parameters
+
+##### eventName
+
+`Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`0`\]
+
+##### eventArgs
+
+`Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`1`\]
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`emit`](../interfaces/AttachableModuleInstance.md#emit)
+
+***
+
+### emitSerial()
+
+> **emitSerial**(`eventName`, `eventArgs`): `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:72
+
+#### Parameters
+
+##### eventName
+
+`Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`0`\]
+
+##### eventArgs
+
+`Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`1`\]
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`emitSerial`](../interfaces/AttachableModuleInstance.md#emitserial)
+
+***
+
+### listenerCount()
+
+> **listenerCount**(`eventNames`): `number`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:73
+
+#### Parameters
+
+##### eventNames
+
+`Parameters`\<`TWrappedModule`\[`"listenerCount"`\]\>\[`0`\]
+
+#### Returns
+
+`number`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`listenerCount`](../interfaces/AttachableModuleInstance.md#listenercount)
+
+***
+
+### manifest()
+
+> **manifest**(`maxDepth?`): `Promise`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:74
+
+#### Parameters
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`Promise`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`manifest`](../interfaces/AttachableModuleInstance.md#manifest)
+
+***
+
+### manifestQuery()
+
+> **manifestQuery**(`account`, `maxDepth?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:75
+
+#### Parameters
+
+##### account
+
+`AccountInstance`
+
+##### maxDepth?
+
+`number`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`manifestQuery`](../interfaces/AttachableModuleInstance.md#manifestquery)
+
+***
+
+### moduleAddress()
+
+> **moduleAddress**(): `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:76
+
+#### Returns
+
+`Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)[]\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`moduleAddress`](../interfaces/AttachableModuleInstance.md#moduleaddress)
+
+***
+
+### off()
+
+> **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:77
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventNames
+
+`TEventName`
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`off`](../interfaces/AttachableModuleInstance.md#off)
+
+***
+
+### offAny()
+
+> **offAny**(`listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:78
+
+#### Parameters
+
+##### listener
+
+[`EventAnyListener`](../type-aliases/EventAnyListener.md)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`offAny`](../interfaces/AttachableModuleInstance.md#offany)
+
+***
+
+### on()
+
+> **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:79
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventNames
+
+`TEventName`
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`on`](../interfaces/AttachableModuleInstance.md#on)
+
+***
+
+### onAny()
+
+> **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:80
+
+#### Parameters
+
+##### listener
+
+[`EventAnyListener`](../type-aliases/EventAnyListener.md)
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`onAny`](../interfaces/AttachableModuleInstance.md#onany)
+
+***
+
+### once()
+
+> **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:81
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`once`](../interfaces/AttachableModuleInstance.md#once)
+
+***
+
+### parents()
+
+> **parents**(): `Promisable`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:82
+
+#### Returns
+
+`Promisable`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`parents`](../interfaces/AttachableModuleInstance.md#parents)
+
+***
+
+### previousHash()
+
+> **previousHash**(): `Promise`\<`undefined` \| `string`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:83
+
+#### Returns
+
+`Promise`\<`undefined` \| `string`\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`previousHash`](../interfaces/AttachableModuleInstance.md#previoushash)
+
+***
+
+### previousHashQuery()
+
+> **previousHashQuery**(`account?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:84
+
+#### Parameters
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>\>
+
+***
+
+### privateChildren()
+
+> **privateChildren**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:85
+
+#### Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`privateChildren`](../interfaces/AttachableModuleInstance.md#privatechildren)
+
+***
+
+### publicChildren()
+
+> **publicChildren**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:86
+
+#### Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`publicChildren`](../interfaces/AttachableModuleInstance.md#publicchildren)
+
+***
+
+### query()
+
+> **query**\<`T`\>(`query`, `payloads?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:87
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
+
+#### Parameters
+
+##### query
+
+`T`
+
+##### payloads?
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`query`](../interfaces/AttachableModuleInstance.md#query)
+
+***
+
+### queryable()
+
+> **queryable**\<`T`\>(`query`, `payloads?`): `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:88
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
+
+#### Parameters
+
+##### query
+
+`T`
+
+##### payloads?
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`queryable`](../interfaces/AttachableModuleInstance.md#queryable)
+
+***
+
+### removeParent()
+
+> **removeParent**(`address`): `void`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:89
+
+#### Parameters
+
+##### address
+
+`Lowercase`\<`string`\>
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`removeParent`](../interfaces/AttachableModuleInstance.md#removeparent)
+
+***
+
+### ~~resolve()~~
+
+#### Call Signature
+
+> **resolve**\<`T`\>(): `Promise`\<`T`[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:91
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Returns
+
+`Promise`\<`T`[]\>
+
+##### Deprecated
+
+do not pass undefined.  If trying to get all, pass '*'
+
+##### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolve`](../interfaces/AttachableModuleInstance.md#resolve)
+
+#### Call Signature
+
+> **resolve**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:92
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### all
+
+`"*"`
+
+###### options?
+
+[`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`T`[]\>
+
+##### Deprecated
+
+do not pass undefined.  If trying to get all, pass '*'
+
+##### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolve`](../interfaces/AttachableModuleInstance.md#resolve)
+
+#### Call Signature
+
+> **resolve**\<`T`\>(`id`, `options?`): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:93
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### id
+
+`string`
+
+###### options?
+
+[`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
+
+##### Deprecated
+
+do not pass undefined.  If trying to get all, pass '*'
+
+##### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolve`](../interfaces/AttachableModuleInstance.md#resolve)
+
+***
+
+### resolvePrivate()
+
+#### Call Signature
+
+> **resolvePrivate**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:94
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### all
+
+`"*"`
+
+###### options?
+
+[`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`T`[]\>
+
+##### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolvePrivate`](../interfaces/AttachableModuleInstance.md#resolveprivate)
+
+#### Call Signature
+
+> **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T`\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:95
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### id
+
+`string`
+
+###### options?
+
+[`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+##### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`resolvePrivate`](../interfaces/AttachableModuleInstance.md#resolveprivate)
+
+***
+
+### siblings()
+
+> **siblings**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:96
+
+#### Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`siblings`](../interfaces/AttachableModuleInstance.md#siblings)
+
+***
+
+### state()
+
+> **state**(): `Promise`\<[`Payload`](../type-aliases/Payload.md)[]\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:97
+
+#### Returns
+
+`Promise`\<[`Payload`](../type-aliases/Payload.md)[]\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`state`](../interfaces/AttachableModuleInstance.md#state)
+
+***
+
+### stateQuery()
+
+> **stateQuery**(`_account`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:98
+
+#### Parameters
+
+##### \_account
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Implementation of
+
+[`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md).[`stateQuery`](../interfaces/AttachableModuleInstance.md#statequery)
+
+***
+
+### canWrap()
+
+> `static` **canWrap**(`mod?`): mod is Module\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\<void, void\>\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\]; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\] \}, ModuleEventData\<object\>\>
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:51
+
+#### Parameters
+
+##### mod?
+
+[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+#### Returns
+
+mod is Module\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\<void, void\>\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\]; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\] \}, ModuleEventData\<object\>\>
+
+***
+
+### gc()
+
+#### Call Signature
+
+> `static` **gc**(`force?`): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:29
+
+##### Parameters
+
+###### force?
+
+`boolean`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Base.gc`
+
+#### Call Signature
+
+> `static` **gc**(`className`): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:30
+
+##### Parameters
+
+###### className
+
+`string`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Base.gc`
+
+***
+
+### hasRequiredQueries()
+
+> `static` **hasRequiredQueries**(`mod`): `boolean`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:62
+
+#### Parameters
+
+##### mod
+
+[`Module`](../interfaces/Module.md)
+
+#### Returns
+
+`boolean`
+
+***
+
+### instanceCount()
+
+> `static` **instanceCount**(`className`): `number`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:31
+
+#### Parameters
+
+##### className
+
+`string`
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+`Base.instanceCount`
+
+***
+
+### instanceCounts()
+
+> `static` **instanceCounts**(): `Record`\<`string`, `number`\>
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:32
+
+#### Returns
+
+`Record`\<`string`, `number`\>
+
+#### Inherited from
+
+`Base.instanceCounts`
+
+***
+
+### is()
+
+> `static` **is**\<`TModuleWrapper`\>(`this`, `wrapper`): `wrapper is TModuleWrapper`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:63
+
+#### Type Parameters
+
+##### TModuleWrapper
+
+`TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
+
+#### Parameters
+
+##### this
+
+[`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
+
+##### wrapper
+
+`any`
+
+#### Returns
+
+`wrapper is TModuleWrapper`
+
+***
+
+### missingRequiredQueries()
+
+> `static` **missingRequiredQueries**(`mod`): `string`[]
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:64
+
+#### Parameters
+
+##### mod
+
+[`Module`](../interfaces/Module.md)
+
+#### Returns
+
+`string`[]
+
+***
+
+### startHistory()
+
+> `static` **startHistory**(): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:33
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Base.startHistory`
+
+***
+
+### stopHistory()
+
+> `static` **stopHistory**(): `void`
+
+Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:34
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Base.stopHistory`
+
+***
+
+### tryWrap()
+
+> `static` **tryWrap**\<`TModuleWrapper`\>(`this`, `mod`, `account`, `checkIdentity?`): `undefined` \| `TModuleWrapper`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:65
+
+#### Type Parameters
+
+##### TModuleWrapper
+
+`TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
+
+#### Parameters
+
+##### this
+
+[`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
+
+##### mod
+
+`undefined` | [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### account
+
+`AccountInstance`
+
+##### checkIdentity?
+
+`boolean`
+
+#### Returns
+
+`undefined` \| `TModuleWrapper`
+
+***
+
+### with()
+
+> `static` **with**\<`TModuleWrapper`, `R`\>(`this`, `mod`, `closure`): `undefined` \| `R`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:66
+
+#### Type Parameters
+
+##### TModuleWrapper
+
+`TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
+
+##### R
+
+`R` *extends* `Promisable`\<`void`\> = `void`
+
+#### Parameters
+
+##### this
+
+[`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
+
+##### mod
+
+`any`
+
+##### closure
+
+(`mod`) => `R`
+
+#### Returns
+
+`undefined` \| `R`
+
+***
+
+### wrap()
+
+> `static` **wrap**\<`TModuleWrapper`\>(`this`, `mod`, `account`, `checkIdentity?`): `TModuleWrapper`
+
+Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:67
+
+#### Type Parameters
+
+##### TModuleWrapper
+
+`TModuleWrapper` *extends* `ModuleWrapper`\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
+
+#### Parameters
+
+##### this
+
+[`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
+
+##### mod
+
+`undefined` | [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### account
+
+`AccountInstance`
+
+##### checkIdentity?
+
+`boolean`
+
+#### Returns
+
+`TModuleWrapper`